/**
 * @file llviewerparcelmedia.h
 * @brief Handlers for multimedia on a per-parcel basis
 *
 * $LicenseInfo:firstyear=2007&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LLVIEWERPARCELMEDIA_H
#define LLVIEWERPARCELMEDIA_H

#include "llviewermedia.h"
#include "llparcel.h"

class LLMessageSystem;
//class LLParcel;
class LLViewerParcelMediaNavigationObserver;


// This class understands land parcels, network traffic, LSL media
// transport commands, and talks to the LLViewerMedia class to actually
// do playback.  It allows us to remove code from LLViewerParcelMgr.
class LLViewerParcelMedia : public LLViewerMediaObserver, public LLSingleton<LLViewerParcelMedia>
{
	LLSINGLETON(LLViewerParcelMedia);
	~LLViewerParcelMedia();
	LOG_CLASS(LLViewerParcelMedia);
public:
	void update(LLParcel* parcel);
	// called when the agent's parcel has a new URL, or the agent has
	// walked on to a new parcel with media

	void play(LLParcel* parcel);
	// user clicked play button in media transport controls
	void filterMediaUrl(LLParcel* parcel);
	// user has media filter enabled and play requested
	void filterAudioUrl(std::string media_url);
	// user has media filter enabled and play requested
	std::string extractDomain(std::string url);
	// helper function to extract domain from url and conve
	void loadDomainFilterList();
	void saveDomainFilterList();

	void stop();
	// user clicked stop button in media transport controls

	void pause();
	void start();
	// restart after pause - no need for all the setup

	void focus(bool focus);

	void seek(F32 time);
	// jump to timecode time

	LLPluginClassMediaOwner::EMediaStatus getStatus();
	std::string getMimeType();
	std::string getURL();
	std::string getName();
	viewer_media_t getParcelMedia();
	bool hasParcelMedia() { return mMediaImpl.notNull(); }

	static void parcelMediaCommandMessageHandler( LLMessageSystem *msg, void ** );
	static void parcelMediaUpdateHandler( LLMessageSystem *msg, void ** );
	void sendMediaNavigateMessage(const std::string& url);

	// inherited from LLViewerMediaObserver
	virtual void handleMediaEvent(LLPluginClassMedia* self, EMediaEvent event);

private:
	void processParcelMediaCommandMessage(LLMessageSystem *msg);
	void processParcelMediaUpdate(LLMessageSystem *msg);

public:
	S32 mMediaParcelLocalID;
	LLUUID mMediaRegionID;
	// HACK: this will change with Media on a Prim
	viewer_media_t mMediaImpl;
	LLSD mMediaFilterList;
	std::string mMediaLastURL;
	bool mMediaLastActionPlay;
	std::string mAudioLastURL;
	bool mAudioLastActionPlay;
	bool mMediaReFilter;

	bool mMediaFilterAlertActive;

	LLParcel mQueuedMedia;
	std::string mQueuedMusic;
	LLParcel mCurrentMedia;
	LLParcel mCurrentAlertMedia;
	std::string mCurrentMusic;
	bool mMediaQueueEmpty;
	bool mMusicQueueEmpty;
	U32 mMediaCommandQueue;
	F32 mMediaCommandTime;
};


class LLViewerParcelMediaNavigationObserver
{
public:
	std::string mCurrentURL;
	bool mFromMessage;

	// void onNavigateComplete( const EventType& event_in );

};

#endif
