/** 
 * @file llmediaimplgstreamer.h
 * @author Tofu Linden
 * @brief implementation that supports media playback via GStreamer.
 *
 * $LicenseInfo:firstyear=2007&license=viewergpl$
 * 
 * Copyright (c) 2007-2009, Linden Research, Inc.
 * 
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
 * 
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at http://secondlifegrid.net/programs/open_source/licensing/flossexception
 * 
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 * 
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

// header guard
#ifndef llmediaimplgstreamer_h
#define llmediaimplgstreamer_h

#include "llmediaimplcommon.h"
#include "llmediaimplfactory.h"

///#if LL_GSTREAMER_ENABLED

extern "C" {
#include <gst/gst.h>
}

#include <stdio.h>
#include "apr_pools.h"
#include "apr_dso.h"


#include "llmediaimplgstreamervidplug.h"
#include "llgstplaythread.h"

class LLMediaManagerData;
class LLMediaImplMaker;

///////////////////////////////////////////////////////////////////////////
class LLMediaImplGStreamer:
	public LLMediaImplCommon
{
	friend class LLGstPlayThread;

	public:
		LLMediaImplGStreamer ();
		virtual ~LLMediaImplGStreamer ();

		////////////////////////////////////////////////////////
		// implementation of the media public interface

		static bool startup( LLMediaManagerData* init_data );
		static bool closedown();

		// Sets GST_PLUGIN_PATH env var for GStreamer.
		static void set_gst_plugin_path();

		/* virtual */ bool setDebugLevel( LLMediaBase::EDebugLevel level );

		// Function given to GStreamer for handling debug messages
		static void gstreamer_log(GstDebugCategory *category,
		                          GstDebugLevel level,
		                          const gchar *file,
		                          const gchar *function,
		                          gint line,
		                          GObject *object,
		                          GstDebugMessage *message,
		                          gpointer data)
#if __GNUC__
		                          // recommended by the gstreamer docs
		                          G_GNUC_NO_INSTRUMENT
#endif
		                          ;

		/* virtual */ std::string getVersion();
		/* virtual */ bool navigateTo( const std::string url );
		/* virtual */ bool updateMedia();
		/* virtual */ unsigned char* getMediaData();
		/* virtual */ int getTextureFormatPrimary() const;
		/* virtual */ int getTextureFormatType() const;
		/* virtual */ int getTextureFormatInternal() const;
		/* virtual */ bool seek( double time );
		/* virtual */ bool setVolume( float volume );

		LLMediaEmitter< LLMediaObserver > getEventEmitter() const {return mEventEmitter;};

	protected:

		void startPlay();


	private:

		// misc
		bool unload();
		bool pause();
		bool stop();
		bool play();

		static gboolean bus_callback (GstBus     *bus,
		                              GstMessage *message,
		                              gpointer    data);

		unsigned char* mediaData;
		int mMediaRowbytes;
		int mTextureFormatPrimary;
		int mTextureFormatType;

		// GStreamer-specific
		GMainLoop *mPump; // event pump for this media
		GstElement *mPlaybin;
		GstSLVideo *mVideoSink;
		std::string mLastTitle;
		GstState mState;
		GstState getState() const { return mState; }

		LLGstPlayThread *mPlayThread;
};

class LLMediaImplGStreamerMaker : public LLMediaImplMaker
{
	public: 
		LLMediaImplGStreamerMaker();
		LLMediaImplGStreamer* create()
		{
			return new LLMediaImplGStreamer();
		}
};

/////////////////////////////////////////////////////////////////////////
// Debug/Info/Warning macros.
#define STDERRMSG(...) do{\
    fprintf(stderr, "%s:%d: ", __FUNCTION__, __LINE__);\
    fprintf(stderr, __VA_ARGS__);\
    fputc('\n',stderr);\
  }while(0)
#define NULLMSG(...) do{}while(0)

#define DEBUGMSG NULLMSG
#define INFOMSG  STDERRMSG
#define WARNMSG  STDERRMSG
/////////////////////////////////////////////////////////////////////////

///#endif // LL_GSTREAMER_ENABLED

#endif // llmediaimplgstreamer_h