/** 
 * @file lloutputmonitorctrl.h
 * @brief LLOutputMonitorCtrl base class
 *
 * $LicenseInfo:firstyear=2001&license=viewergpl$
 * 
 * Copyright (c) 2001-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$
 */

#ifndef LL_LLOUTPUTMONITORCTRL_H
#define LL_LLOUTPUTMONITORCTRL_H

#include "v4color.h"
#include "llview.h"
#include "llmutelist.h"
#include "llspeakingindicatormanager.h"

class LLTextBox;
class LLUICtrlFactory;

//
// Classes
//

class LLOutputMonitorCtrl
: public LLView, public LLSpeakingIndicator, LLMuteListObserver
{
public:
	struct Params : public LLInitParam::Block<Params, LLView::Params>
	{
		Optional<bool>	draw_border;
		Mandatory<LLUIImage*>	image_mute,
								image_off,
								image_on,
								image_level_1,
								image_level_2,
								image_level_3;
		Optional<bool>		auto_update;
		Optional<LLUUID>	speaker_id;

		Params();
	};
protected:
	bool	mBorder;
	LLOutputMonitorCtrl(const Params&);
	friend class LLUICtrlFactory;

public:
	virtual ~LLOutputMonitorCtrl();

	// llview overrides
	virtual void	draw();

	void			setPower(F32 val);
	F32				getPower(F32 val) const { return mPower; }
	
	bool			getIsMuted() const { return mIsMuted; }
	void			setIsMuted(bool val) { mIsMuted = val; }

	// For the current user, need to know the PTT state to show
	// correct button image.
	void			setIsAgentControl(bool val) { mIsAgentControl = val; }

	void			setIsTalking(bool val) { mIsTalking = val; }

	void			setSpeakerId(const LLUUID& speaker_id);

	//called by mute list
	virtual void onChange();

	/**
	 * Implementation of LLSpeakingIndicator interface.
	 * Behavior is implemented via changing visibility.
	 *
	 * If instance is in visible chain now (all parents are visible) it changes visibility 
	 * and notify parent about this.
	 *
	 * Otherwise it marks an instance as dirty and stores necessary visibility.
	 * It will be applied in next draw and parent will be notified.
	 */
	virtual void	switchIndicator(bool switch_on);

private:

	/**
	 * Notifies parent about changed visibility.
	 *
	 * Passes LLSD with "visibility_changed" => <current visibility> value.
	 * For now it is processed by LLAvatarListItem to update (reshape) its children.
	 * Implemented fo complete EXT-3976
	 */
	void			notifyParentVisibilityChanged();

	//static LLColor4	sColorMuted;
	//static LLColor4	sColorNormal;
	//static LLColor4	sColorOverdriven;
	static LLColor4	sColorBound;
	//static S32		sRectsNumber;
	//static F32		sRectWidthRatio;
	//static F32		sRectHeightRatio;
	
	

	F32				mPower;
	bool			mIsAgentControl;
	bool			mIsMuted;
	bool			mIsTalking;
	LLPointer<LLUIImage> mImageMute;
	LLPointer<LLUIImage> mImageOff;
	LLPointer<LLUIImage> mImageOn;
	LLPointer<LLUIImage> mImageLevel1;
	LLPointer<LLUIImage> mImageLevel2;
	LLPointer<LLUIImage> mImageLevel3;

	/** whether to deal with LLVoiceClient::getInstance() directly */
	bool			mAutoUpdate;

	/** uuid of a speaker being monitored */
	LLUUID			mSpeakerId;

	/** indicates if the instance is dirty and should notify parent */
	bool			mIsSwitchDirty;
	bool			mShouldSwitchOn;
};

#endif