CoolVLViewer/indra/newview/llvoiceclient.h

/**
*  @file llvoiceclient.h
 * @brief Declaration of LLVoiceClient class.
 *
 * $LicenseInfo:firstyear=2007&license=viewergpl$
 *
 * Copyright (c) 2007-2009, Linden Research, Inc.
 * Copyright (c) 2009-2024, Henri Beauchamp.
 *
 * 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_LLVOICECLIENT_H
#define LL_LLVOICECLIENT_H

#include "boost/signals2.hpp"

#include "lluuid.h"

class LLPumpIO;

constexpr F32 OVERDRIVEN_POWER_LEVEL = 0.7f;

class LLVoiceClientStatusObserver
{
public:
	typedef enum e_voice_status_type
	{
		// NOTE: when updating this enum, please also update the switch in
		// LLVoiceClientStatusObserver::status2string().
		STATUS_LOGIN_RETRY,
		STATUS_LOGGED_IN,
		STATUS_JOINING,
		STATUS_JOINED,
		STATUS_LEFT_CHANNEL,
		STATUS_VOICE_DISABLED,
		STATUS_VOICE_ENABLED,
		BEGIN_ERROR_STATUS,
		ERROR_CHANNEL_FULL,
		ERROR_CHANNEL_LOCKED,
		ERROR_NOT_AVAILABLE,
		ERROR_UNKNOWN
	} EStatusType;

	virtual ~LLVoiceClientStatusObserver() = default;
	virtual void onChange(EStatusType status, const LLSD& channel_info,
						  bool proximal) = 0;

	static std::string status2string(EStatusType inStatus);
};

// Purely virtual class, used *only* for the few methods which are both common
// to all voice modules *and* get called by LLVoiceClient via module pointers:
// this is a *minimal* common API to avoid pointlessly virtual methods and
// their costlier calls. HB
class LLVoiceModule
{
	friend class LLVoiceClient;

public:
	LLVoiceModule() = default;
	virtual ~LLVoiceModule() = default;

	// Module identification
	virtual bool isVivox() const = 0;
	virtual bool isWebRTC() const = 0;
	virtual const std::string& getName() const = 0;

	// Channels related methods
	virtual bool inProximalChannel() const = 0;
	virtual void setSpatialChannel(const LLSD& channel_info) = 0;
	virtual void setNonSpatialChannel(const LLSD& channel_info,
									  bool notify_on_first_join,
									  bool hangup_on_last_leave) = 0;
	virtual void leaveNonSpatialChannel() = 0;
	virtual void leaveAudioSession() = 0;
	virtual void processChannels(bool enabled) = 0;
	virtual std::string sipURIFromID(const LLUUID& id) const = 0;

#if 0	// Not yet used by the Cool VL Viewer. *TODO: implement ?  HB
	virtual void setHidden(bool b) const = 0;

protected:
	bool mHidden = false;
#endif
};

class LLVoiceClient
{
	friend class LLVivoxProtocolParser;
	friend class LLVoiceVivox;

protected:
	LOG_CLASS(LLVoiceClient);

public:
	LLVoiceClient();
	~LLVoiceClient();

	LL_INLINE bool ready() 							{ return mReady; }

	// Call after loading settings and whenever they change
	void updateSettings();

	// Methods used in llfloatervoicedevicesettings.cpp

	void setCaptureDevice(const std::string& device_id, bool webrtc);
	void setRenderDevice(const std::string& device_id, bool webrtc);

	typedef std::map<std::string, std::string> device_map_t;
	const device_map_t& getCaptureDevices(bool webrtc) const;
	const device_map_t& getRenderDevices(bool webrtc) const;

	void tuningStart(bool webrtc);
	void tuningStop(bool webrtc);
	bool inTuningMode(bool webrtc);
	// This method auto-determines which of Vivox or WebRTC is in use. HB
	bool tuningModeActive();

	void tuningSetMicVolume(F32 volume, bool webrtc);
#if 0	// Not used
	void tuningSetSpeakerVolume(F32 volume, bool webrtc);
#endif
	F32 tuningGetEnergy(bool webrtc);

	// This returns true when it is safe to bring up the "device settings"
	// dialog in the prefs. I.e. when the daemon is running and connected, and
	// the device lists are populated.
	bool deviceSettingsAvailable(bool webrtc);

	// Requery the voice engine for the current list of input/output devices.
	// If you pass true for clear_current_list, deviceSettingsAvailable() will
	// be false until the query has completed (use this if you want to know
	// when it is done). If you pass false, you will have no way to know when
	// the query finishes, but the device lists will not appear empty in the
	// interim.
	void refreshDeviceLists(bool clear_current_list, bool webrtc);

	/////////////////////////////
	// Sending updates of current state

	// Use this to mute the local mic (for when the client is minimized, etc),
	// ignoring user PTT state. Used from llvieweraudio.cpp.
	LL_INLINE void setMuteMic(bool muted)			{ mMuteMic = muted; }
	// Used from llvieweraudio.cpp
	void setVoiceVolume(F32 volume);
	void setMicGain(F32 volume);

	// Used from llfloateractivespeakers.cpp and llfloaterim.cpp

	F32 getUserVolume(const LLUUID& id);
	// Sets volume for specified agent, from 0-1 (where .5 is nominal)
	void setUserVolume(const LLUUID& id, F32 volume);

	// Used from llvoiceremotectrl.cpp
	LL_INLINE void setUserPTTState(bool ptt)		{ mUserPTTState = ptt; }
	LL_INLINE bool getUserPTTState() const			{ return mUserPTTState; }
	LL_INLINE void toggleUserPTTState()				{ mUserPTTState = !mUserPTTState; }

	bool isAgentMicOpen() const;
	void setUsePTT(bool use_it);
	void setPTTIsToggle(bool set_as_toggle);
	LL_INLINE bool getPTTIsToggle() const			{ return mPTTIsToggle; }
	bool setPTTKey(const std::string& key);
	void setEarLocation(S32 loc);

	// PTT key triggering. Used from llviewerwindow.cpp
	void keyDown(KEY key, MASK mask);
	void keyUp(KEY key, MASK mask);
	void inputUserControlState(bool down);
	void middleMouseState(bool down);

	/////////////////////////////
	// Accessors for data related to nearby speakers

	// Used from llfloateractivespeakers.cpp and llvoavatar.cpp

	bool getIsSpeaking(const LLUUID& id);
	// true if we have received data for this avatar.
	bool getVoiceEnabled(const LLUUID& id);

	// "power" is related to "amplitude" in a defined way. I'm just not sure
	// what the formula is...
	F32 getCurrentPower(const LLUUID& id);

	// Used from llfloateractivespeakers.cpp
	bool getIsModeratorMuted(const LLUUID& id);
	bool getOnMuteList(const LLUUID& id);

	// This is used by the string-keyed maps below, to avoid storing the string
	// twice. The 'const std::string*' in the key points to a string actually
	// stored in the object referenced by the map. The add & delete operations
	// for each map allocate and delete in the right order to avoid dangling
	// references. The default compare operation would just compare pointers,
	// which is incorrect, so they must use this comparator instead.
	struct stringMapComparator
	{
		LL_INLINE bool operator()(const std::string* a,
								  const std::string* b) const
		{
			return a->compare(*b) < 0;
		}
	};

	struct uuidMapComparator
	{
		LL_INLINE bool operator()(const LLUUID* a, const LLUUID* b) const
		{
			return *a < *b;
		}
	};

	// Used in llfloateractivespeakers.cpp
	struct ParticipantData
	{
		LL_INLINE ParticipantData(const LLUUID& id, const std::string& name,
								  bool avatar)
		:	mId(id),
			mName(name),
			mIsAvatar(avatar)
		{
		}

		LLUUID		mId;
		std::string	mName;
		bool		mIsAvatar;
	};
	typedef std::vector<ParticipantData> participants_vec_t;
	bool getParticipants(participants_vec_t& participants);

	void setVoiceEnabled(bool enabled);

	// Called from llstartup.cpp
	void userAuthorized(const std::string& first_name,
						const std::string& last_name, const LLUUID& agent_id);

	// Used by llvoicechannel.cpp

	void addObserver(LLVoiceClientStatusObserver* observerp);
	void removeObserver(LLVoiceClientStatusObserver* observerp);

	void setNonSpatialChannel(const LLSD& channel_info,
							  bool notify_on_first_join,
							  bool hangup_on_last_leave);
	void leaveNonSpatialChannel();
	void activateSpatialChannel(bool activate);

	bool isCurrentChannel(const LLSD& channel_info);
	bool compareChannels(const LLSD& channel_info1, const LLSD& channel_info2);

	// Starts a voice session with the specified user using the specified type
	// of server.
	void callUser(const LLUUID& id, U32 server_type);
	// End the session using the specified type of server.
	void hangup(U32 server_type);

	std::string sipURIFromID(const LLUUID& id) const;

	// Used by LLViewerParcelVoiceInfo
	void setSpatialChannel(const LLSD& channel_info);

	// Called from llfloaterim.cpp

	// Called from llimmgr.cpp
	void declineInvite(const LLSD& channel_info);
	// Called from llvoicechannel.cpp
	bool answerInvite(const LLSD& channel_info);

	// Called from llfloateractivespeakers.cpp, llvoavatar.cpp and
	// llvoicechannel.cpp
	// Returns true iff the user is currently in a proximal (local spatial)
	// channel. Note that gestures should only fire if this returns true.
	bool inProximalChannel() const;

	// Called once from llappviewer.cpp at application startup (creates
	// the connector)
	void init(LLPumpIO* pumpp);
	// Called from llappviewer.cpp to clean up during shutdown
	void terminate();

	// Called from LLAgent::handleServerFeaturesTransition(). HB
	void handleSimFeaturesReceived(const LLSD& features);

	bool isVoiceWorking();

	// Called from various places in the viewer
	static bool voiceEnabled();

	// Used by llimmgr.cpp and llvoicechannel.cpp, so that we do not need to
	// deal with module pointers there... HB
	enum e_server_type : U32
	{
		UNKNOWN_SERVER,
		VIVOX_SERVER,
		WEBRTC_SERVER,
	};
	// Returns the type of server as defined above. HB
	U32 getVoiceServerType(const LLSD& channel_info);

	LLVoiceModule* getModuleFromType(const std::string& server_type);
	LLVoiceModule* getModuleFromChannelInfo(const LLSD& channel_info);

private:
	static LLVoiceModule* getModuleFromSimFeatures(const LLSD& features,
												   bool save = false);
	void setSpatialVoiceModule(LLVoiceModule* modulep);
	void setNonSpatialVoiceModule(LLVoiceModule* modulep);

	void onParcelChange();

private:
	// Used to store spatial credentials for Vivox so they are available when
	// the region voice server is retrieved.
	LLSD			mSpatialCredentials;

	LLVoiceModule*	mSpatialVoiceModulep;
	LLVoiceModule*	mNonSpatialVoiceModulep;

	typedef boost::signals2::connection connection_t;
	connection_t	mParcelChangedConnection;

	KEY				mPTTKey;
	bool			mUsePTT;
	bool			mPTTIsMiddleMouse;
	bool			mPTTIsToggle;
	bool			mUserPTTState;

	bool			mMuteMic;

	bool			mReady;
};

// Note: since this is a global class instance, all class members are always
// available, from viewer launch to _exit(): no need for static variables to
// track the shutdown (or ready) state !  HB
extern LLVoiceClient gVoiceClient;

#endif //LL_LLVOICECLIENT_H