[deb_libcec.git] / src / lib / CECClient.h

#pragma once
/*
 * This file is part of the libCEC(R) library.
 *
 * libCEC(R) is Copyright (C) 2011-2013 Pulse-Eight Limited.  All rights reserved.
 * libCEC(R) is an original work, containing original code.
 *
 * libCEC(R) is a trademark of Pulse-Eight Limited.
 *
 * This program is dual-licensed; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 *
 * Alternatively, you can license this library under a commercial license,
 * please contact Pulse-Eight Licensing for more information.
 *
 * For more information contact:
 * Pulse-Eight Licensing       <license@pulse-eight.com>
 *     http://www.pulse-eight.com/
 *     http://www.pulse-eight.net/
 */

#include <string>
#include "platform/threads/mutex.h"
#include "platform/util/buffer.h"

namespace CEC
{
  class CCECProcessor;
  class CCECBusDevice;
  class CCECPlaybackDevice;

  class CCECClient
  {
    friend class CCECProcessor;

  public:
    CCECClient(CCECProcessor *processor, const libcec_configuration &configuration);
    virtual ~CCECClient(void);

    /*!
     * @return True when initialised and registered, false otherwise.
     */
    virtual bool IsInitialised(void);

    /*!
     * @return True when registered in the processor, false otherwise.
     */
    virtual bool IsRegistered(void);

    /*!
     * @return The primary logical address that this client is controlling.
     */
    virtual cec_logical_address GetPrimaryLogicalAdddress(void);

    /*!
     * @return The primary device that this client is controlling, or NULL if none.
     */
    virtual CCECBusDevice *GetPrimaryDevice(void);

    /*!
     * @return Get the playback device or recording device that this client is controlling, or NULL if none.
     */
    virtual CCECPlaybackDevice *GetPlaybackDevice(void);

    /*!
     * @brief Change one of the device types that this client is controlling into another.
     * @param from The type to change.
     * @param to The new value.
     * @return True when changed, false otherwise.
     */
    virtual bool ChangeDeviceType(const cec_device_type from, const cec_device_type to);

    /*!
     * @brief Get a device that this client is controlling, given it's type.
     * @param type The type of the device to get.
     * @return The requested device, or NULL if not found.
     */
    virtual CCECBusDevice *GetDeviceByType(const cec_device_type type) const;

    /*!
     * @brief Reset the physical address from the configuration.
     */
    virtual void ResetPhysicalAddress(void);

    /*!
     * @return A string that describes this client.
     */
    virtual std::string GetConnectionInfo(void);

    /*!
     * @return The current value of the TV vendor override setting.
     */
    virtual cec_vendor_id GetTVVendorOverride(void);

    /*!
     * @return The current value of the OSD name setting.
     */
    virtual std::string GetOSDName(void);

    /*!
     * @return Get the current value of the wake device setting.
     */
    virtual cec_logical_addresses GetWakeDevices(void);

    /*!
     * @return The version of this client.
     */
    virtual cec_client_version GetClientVersion(void);

    /*!
     * @return The device types that this client is controlling.
     */
    virtual cec_device_type_list GetDeviceTypes(void);

    // client-specific part of ICECAdapter
    virtual bool                  EnableCallbacks(void *cbParam, ICECCallbacks *callbacks);
    virtual bool                  PingAdapter(void);
    virtual bool                  Transmit(const cec_command &data, bool bIsReply);
    virtual bool                  SetLogicalAddress(const cec_logical_address iLogicalAddress);
    virtual bool                  SetPhysicalAddress(const uint16_t iPhysicalAddress);
    virtual bool                  SetHDMIPort(const cec_logical_address iBaseDevice, const uint8_t iPort, bool bForce = false);
    virtual bool                  SendPowerOnDevices(const cec_logical_address address = CECDEVICE_TV);
    virtual bool                  SendStandbyDevices(const cec_logical_address address = CECDEVICE_BROADCAST);
    virtual bool                  SendSetActiveSource(const cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
    virtual bool                  SendSetDeckControlMode(const cec_deck_control_mode mode, bool bSendUpdate = true);
    virtual bool                  SendSetDeckInfo(const cec_deck_info info, bool bSendUpdate = true);
    virtual bool                  SendSetInactiveView(void);
    virtual bool                  SendSetMenuState(const cec_menu_state state, bool bSendUpdate = true);
    virtual bool                  SendSetOSDString(const cec_logical_address iLogicalAddress, const cec_display_control duration, const char *strMessage);
    virtual bool                  SwitchMonitoring(bool bEnable);
    virtual cec_version           GetDeviceCecVersion(const cec_logical_address iAddress);
    virtual bool                  GetDeviceMenuLanguage(const cec_logical_address iAddress, cec_menu_language &language);
    virtual uint64_t              GetDeviceVendorId(const cec_logical_address iAddress);
    virtual cec_power_status      GetDevicePowerStatus(const cec_logical_address iAddress);
    virtual uint16_t              GetDevicePhysicalAddress(const cec_logical_address iAddress);
    virtual bool                  PollDevice(const cec_logical_address iAddress);
    virtual cec_logical_addresses GetActiveDevices(void);
    virtual bool                  IsActiveDevice(const cec_logical_address iAddress);
    virtual bool                  IsActiveDeviceType(const cec_device_type type);
    virtual uint8_t               SendVolumeUp(bool bSendRelease = true);
    virtual uint8_t               SendVolumeDown(bool bSendRelease = true);
    virtual uint8_t               SendMuteAudio(void);
    virtual uint8_t               AudioToggleMute(void);
    virtual uint8_t               AudioMute(void);
    virtual uint8_t               AudioUnmute(void);
    virtual uint8_t               AudioStatus(void);
    virtual bool                  SendKeypress(const cec_logical_address iDestination, const cec_user_control_code key, bool bWait = true);
    virtual bool                  SendKeyRelease(const cec_logical_address iDestination, bool bWait = true);
    virtual cec_osd_name          GetDeviceOSDName(const cec_logical_address iAddress);
    virtual cec_logical_address   GetActiveSource(void);
    virtual bool                  IsActiveSource(const cec_logical_address iAddress);
    virtual bool                  SetStreamPath(const cec_logical_address iAddress);
    virtual bool                  SetStreamPath(const uint16_t iPhysicalAddress);
    virtual cec_logical_addresses GetLogicalAddresses(void);
    virtual void                  RescanActiveDevices(void);
    virtual bool                  IsLibCECActiveSource(void);

    // configuration
    virtual bool                  GetCurrentConfiguration(libcec_configuration &configuration);
    virtual bool                  SetConfiguration(const libcec_configuration &configuration);
    virtual bool                  CanPersistConfiguration(void);
    virtual bool                  PersistConfiguration(const libcec_configuration &configuration);
    virtual void                  SetPhysicalAddress(const libcec_configuration &configuration);

    // callbacks
    virtual void                  AddCommand(const cec_command &command);
    virtual int                   MenuStateChanged(const cec_menu_state newState);
    virtual void                  Alert(const libcec_alert type, const libcec_parameter &param) { CallbackAlert(type, param); }
    virtual void                  AddLog(const cec_log_message &message) { CallbackAddLog(message); }
    virtual void                  AddKey(bool bSendComboKey = false);
    virtual void                  AddKey(const cec_keypress &key);
    virtual void                  SetCurrentButton(const cec_user_control_code iButtonCode);
    virtual void                  CheckKeypressTimeout(void);
    virtual void                  SourceActivated(const cec_logical_address logicalAddress);
    virtual void                  SourceDeactivated(const cec_logical_address logicalAddress);

  protected:
    /*!
     * @brief Register this client in the processor
     * @return True when registered, false otherwise.
     */
    virtual bool OnRegister(void);

    /*!
     * @brief Called by the processor when this client is unregistered
     */
    virtual void OnUnregister(void) { SetRegistered(false); SetInitialised(false); }

    /*!
     * @brief Set the registered state of this client.
     * @param bSetTo The new value.
     */
    virtual void SetRegistered(bool bSetTo);

    /*!
     * @brief Set the initialised state of this client.
     * @param bSetTo The new value
     */
    virtual void SetInitialised(bool bSetTo);

    /*!
     * @brief Change the TV vendor id override setting.
     * @param id The new value.
     */
    virtual void SetTVVendorOverride(const cec_vendor_id id);

    /*!
     * @brief Change the OSD name of the primary device that this client is controlling.
     * @param strDeviceName The new value.
     */
    virtual void SetOSDName(const std::string &strDeviceName);

    /*!
     * @brief Change the value of the devices to wake.
     * @param addresses The new value.
     */
    virtual void SetWakeDevices(const cec_logical_addresses &addresses);

    /*!
     * @brief Change the value of the client version setting.
     * @param version The new version setting.
     */
    virtual void SetClientVersion(const cec_client_version version);

    /*!
     * @brief Change the device types that this client is controlling.
     * @param deviceTypes The new types.
     * @return True when the client needs to be re-registered to pick up the new setting, false otherwise.
     */
    virtual bool SetDeviceTypes(const cec_device_type_list &deviceTypes);

    /*!
     * @return A pointer to the current configuration of this client.
     */
    virtual libcec_configuration *GetConfiguration(void) { return &m_configuration; }

    /*!
     * @brief Called by the processor when registering this client to allocate the logical addresses.
     * @return True when the addresses for all types were allocated, false otherwise.
     */
    virtual bool AllocateLogicalAddresses(void);

    /*!
     * @brief Try to allocate a logical address for a recording device controlled by this client.
     * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
     */
    virtual cec_logical_address AllocateLogicalAddressRecordingDevice(void);

    /*!
     * @brief Try to allocate a logical address for a tuner controlled by this client.
     * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
     */
    virtual cec_logical_address AllocateLogicalAddressTuner(void);

    /*!
     * @brief Try to allocate a logical address for a playback device controlled by this client.
     * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
     */
    virtual cec_logical_address AllocateLogicalAddressPlaybackDevice(void);

    /*!
     * @brief Try to allocate a logical address for an audiosystem controlled by this client.
     * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
     */
    virtual cec_logical_address AllocateLogicalAddressAudioSystem(void);

    /*!
     * @brief Change the physical address of the devices controlled by this client.
     * @param iPhysicalAddress The new physical address.
     * @return True when changed, false otherwise.
     */
    virtual bool SetDevicePhysicalAddress(const uint16_t iPhysicalAddress);

    /*!
     * @brief Try to autodetect the physical address.
     * @return True when autodetected (and set in m_configuration), false otherwise.
     */
    virtual bool AutodetectPhysicalAddress(void);

    /*!
     * @brief Replaces all device types in m_configuration by types that are supported by the command handler of the TV
     */
    virtual void SetSupportedDeviceTypes(void);

    virtual void CallbackAddCommand(const cec_command &command);
    virtual void CallbackAddKey(const cec_keypress &key);
    virtual void CallbackAddLog(const cec_log_message &message);
    virtual void CallbackAlert(const libcec_alert type, const libcec_parameter &param);
    virtual void CallbackConfigurationChanged(const libcec_configuration &config);
    virtual int  CallbackMenuStateChanged(const cec_menu_state newState);
    virtual void CallbackSourceActivated(bool bActivated, const cec_logical_address logicalAddress);

    uint32_t DoubleTapTimeoutMS(void);

    CCECProcessor *       m_processor;                         /**< a pointer to the processor */
    libcec_configuration  m_configuration;                     /**< the configuration of this client */
    bool                  m_bInitialised;                      /**< true when initialised, false otherwise */
    bool                  m_bRegistered;                       /**< true when registered in the processor, false otherwise */
    PLATFORM::CMutex      m_mutex;                             /**< mutex for changes to this instance */
    PLATFORM::CMutex      m_cbMutex;                           /**< mutex that is held when doing anything with callbacks */
    cec_user_control_code m_iCurrentButton;                    /**< the control code of the button that's currently held down (if any) */
    int64_t               m_buttontime;                        /**< the timestamp when the button was pressed (in seconds since epoch), or 0 if none was pressed. */
    int64_t               m_iPreventForwardingPowerOffCommand; /**< prevent forwarding standby commands until this time */
    int64_t               m_iLastKeypressTime;                 /**< last time a key press was sent to the client */
    cec_keypress          m_lastKeypress;                      /**< the last key press that was sent to the client */
  };
}
Commit	Line	Data
cbbe90dd JB	1	#pragma once
	2	/*
	3	* This file is part of the libCEC(R) library.
	4	*
	5	* libCEC(R) is Copyright (C) 2011-2013 Pulse-Eight Limited. All rights reserved.
	6	* libCEC(R) is an original work, containing original code.
	7	*
	8	* libCEC(R) is a trademark of Pulse-Eight Limited.
	9	*
	10	* This program is dual-licensed; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	23	*
	24	*
	25	* Alternatively, you can license this library under a commercial license,
	26	* please contact Pulse-Eight Licensing for more information.
	27	*
	28	* For more information contact:
	29	* Pulse-Eight Licensing <license@pulse-eight.com>
	30	* http://www.pulse-eight.com/
	31	* http://www.pulse-eight.net/
	32	*/
	33
	34	#include <string>
	35	#include "platform/threads/mutex.h"
	36	#include "platform/util/buffer.h"
	37
	38	namespace CEC
	39	{
	40	class CCECProcessor;
	41	class CCECBusDevice;
	42	class CCECPlaybackDevice;
	43
	44	class CCECClient
	45	{
	46	friend class CCECProcessor;
	47
	48	public:
	49	CCECClient(CCECProcessor *processor, const libcec_configuration &configuration);
	50	virtual ~CCECClient(void);
	51
	52	/*!
	53	* @return True when initialised and registered, false otherwise.
	54	*/
	55	virtual bool IsInitialised(void);
	56
	57	/*!
	58	* @return True when registered in the processor, false otherwise.
	59	*/
	60	virtual bool IsRegistered(void);
	61
	62	/*!
	63	* @return The primary logical address that this client is controlling.
	64	*/
65	virtual cec_logical_address GetPrimaryLogicalAdddress(void);
66
67	/*!
68	* @return The primary device that this client is controlling, or NULL if none.
69	*/
70	virtual CCECBusDevice *GetPrimaryDevice(void);
71
72	/*!
73	* @return Get the playback device or recording device that this client is controlling, or NULL if none.
74	*/
75	virtual CCECPlaybackDevice *GetPlaybackDevice(void);
76
77	/*!
78	* @brief Change one of the device types that this client is controlling into another.
79	* @param from The type to change.
80	* @param to The new value.
81	* @return True when changed, false otherwise.
82	*/
83	virtual bool ChangeDeviceType(const cec_device_type from, const cec_device_type to);
84
85	/*!
86	* @brief Get a device that this client is controlling, given it's type.
87	* @param type The type of the device to get.
88	* @return The requested device, or NULL if not found.
89	*/
90	virtual CCECBusDevice *GetDeviceByType(const cec_device_type type) const;
91
92	/*!
93	* @brief Reset the physical address from the configuration.
94	*/
95	virtual void ResetPhysicalAddress(void);
96
97	/*!
98	* @return A string that describes this client.
99	*/
100	virtual std::string GetConnectionInfo(void);
101
102	/*!
103	* @return The current value of the TV vendor override setting.
104	*/
105	virtual cec_vendor_id GetTVVendorOverride(void);
106
107	/*!
108	* @return The current value of the OSD name setting.
109	*/
110	virtual std::string GetOSDName(void);
111
112	/*!
113	* @return Get the current value of the wake device setting.
114	*/
115	virtual cec_logical_addresses GetWakeDevices(void);
116
117	/*!
118	* @return The version of this client.
119	*/
120	virtual cec_client_version GetClientVersion(void);
121
122	/*!
123	* @return The device types that this client is controlling.
124	*/
125	virtual cec_device_type_list GetDeviceTypes(void);
126
127	// client-specific part of ICECAdapter
128	virtual bool EnableCallbacks(void cbParam, ICECCallbacks callbacks);
129	virtual bool PingAdapter(void);
130	virtual bool Transmit(const cec_command &data, bool bIsReply);
131	virtual bool SetLogicalAddress(const cec_logical_address iLogicalAddress);
132	virtual bool SetPhysicalAddress(const uint16_t iPhysicalAddress);
133	virtual bool SetHDMIPort(const cec_logical_address iBaseDevice, const uint8_t iPort, bool bForce = false);
134	virtual bool SendPowerOnDevices(const cec_logical_address address = CECDEVICE_TV);
135	virtual bool SendStandbyDevices(const cec_logical_address address = CECDEVICE_BROADCAST);
136	virtual bool SendSetActiveSource(const cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
137	virtual bool SendSetDeckControlMode(const cec_deck_control_mode mode, bool bSendUpdate = true);
138	virtual bool SendSetDeckInfo(const cec_deck_info info, bool bSendUpdate = true);
139	virtual bool SendSetInactiveView(void);
140	virtual bool SendSetMenuState(const cec_menu_state state, bool bSendUpdate = true);
141	virtual bool SendSetOSDString(const cec_logical_address iLogicalAddress, const cec_display_control duration, const char *strMessage);
142	virtual bool SwitchMonitoring(bool bEnable);
143	virtual cec_version GetDeviceCecVersion(const cec_logical_address iAddress);
144	virtual bool GetDeviceMenuLanguage(const cec_logical_address iAddress, cec_menu_language &language);
145	virtual uint64_t GetDeviceVendorId(const cec_logical_address iAddress);
146	virtual cec_power_status GetDevicePowerStatus(const cec_logical_address iAddress);
147	virtual uint16_t GetDevicePhysicalAddress(const cec_logical_address iAddress);
148	virtual bool PollDevice(const cec_logical_address iAddress);
149	virtual cec_logical_addresses GetActiveDevices(void);
150	virtual bool IsActiveDevice(const cec_logical_address iAddress);
151	virtual bool IsActiveDeviceType(const cec_device_type type);
152	virtual uint8_t SendVolumeUp(bool bSendRelease = true);
153	virtual uint8_t SendVolumeDown(bool bSendRelease = true);
154	virtual uint8_t SendMuteAudio(void);
155	virtual uint8_t AudioToggleMute(void);
156	virtual uint8_t AudioMute(void);
157	virtual uint8_t AudioUnmute(void);
158	virtual uint8_t AudioStatus(void);
159	virtual bool SendKeypress(const cec_logical_address iDestination, const cec_user_control_code key, bool bWait = true);
160	virtual bool SendKeyRelease(const cec_logical_address iDestination, bool bWait = true);
161	virtual cec_osd_name GetDeviceOSDName(const cec_logical_address iAddress);
162	virtual cec_logical_address GetActiveSource(void);
163	virtual bool IsActiveSource(const cec_logical_address iAddress);
164	virtual bool SetStreamPath(const cec_logical_address iAddress);
165	virtual bool SetStreamPath(const uint16_t iPhysicalAddress);
166	virtual cec_logical_addresses GetLogicalAddresses(void);
167	virtual void RescanActiveDevices(void);
168	virtual bool IsLibCECActiveSource(void);
169
170	// configuration
171	virtual bool GetCurrentConfiguration(libcec_configuration &configuration);
172	virtual bool SetConfiguration(const libcec_configuration &configuration);
173	virtual bool CanPersistConfiguration(void);
174	virtual bool PersistConfiguration(const libcec_configuration &configuration);
175	virtual void SetPhysicalAddress(const libcec_configuration &configuration);
176
177	// callbacks
178	virtual void AddCommand(const cec_command &command);
179	virtual int MenuStateChanged(const cec_menu_state newState);
180	virtual void Alert(const libcec_alert type, const libcec_parameter &param) { CallbackAlert(type, param); }
181	virtual void AddLog(const cec_log_message &message) { CallbackAddLog(message); }
182	virtual void AddKey(bool bSendComboKey = false);
183	virtual void AddKey(const cec_keypress &key);
184	virtual void SetCurrentButton(const cec_user_control_code iButtonCode);
185	virtual void CheckKeypressTimeout(void);
186	virtual void SourceActivated(const cec_logical_address logicalAddress);
187	virtual void SourceDeactivated(const cec_logical_address logicalAddress);
188
189	protected:
190	/*!
191	* @brief Register this client in the processor
192	* @return True when registered, false otherwise.
193	*/
194	virtual bool OnRegister(void);
195
196	/*!
197	* @brief Called by the processor when this client is unregistered
198	*/
199	virtual void OnUnregister(void) { SetRegistered(false); SetInitialised(false); }
200
201	/*!
202	* @brief Set the registered state of this client.
203	* @param bSetTo The new value.
204	*/
205	virtual void SetRegistered(bool bSetTo);
206
207	/*!
208	* @brief Set the initialised state of this client.
209	* @param bSetTo The new value
210	*/
211	virtual void SetInitialised(bool bSetTo);
212
213	/*!
214	* @brief Change the TV vendor id override setting.
215	* @param id The new value.
216	*/
217	virtual void SetTVVendorOverride(const cec_vendor_id id);
218
219	/*!
220	* @brief Change the OSD name of the primary device that this client is controlling.
221	* @param strDeviceName The new value.
222	*/
223	virtual void SetOSDName(const std::string &strDeviceName);
224
225	/*!
226	* @brief Change the value of the devices to wake.
227	* @param addresses The new value.
228	*/
229	virtual void SetWakeDevices(const cec_logical_addresses &addresses);
230
231	/*!
232	* @brief Change the value of the client version setting.
233	* @param version The new version setting.
234	*/
235	virtual void SetClientVersion(const cec_client_version version);
236
237	/*!
238	* @brief Change the device types that this client is controlling.
239	* @param deviceTypes The new types.
240	* @return True when the client needs to be re-registered to pick up the new setting, false otherwise.
241	*/
242	virtual bool SetDeviceTypes(const cec_device_type_list &deviceTypes);
243
244	/*!
245	* @return A pointer to the current configuration of this client.
246	*/
247	virtual libcec_configuration *GetConfiguration(void) { return &m_configuration; }
248
249	/*!
250	* @brief Called by the processor when registering this client to allocate the logical addresses.
251	* @return True when the addresses for all types were allocated, false otherwise.
252	*/
253	virtual bool AllocateLogicalAddresses(void);
254
255	/*!
256	* @brief Try to allocate a logical address for a recording device controlled by this client.
257	* @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
258	*/
259	virtual cec_logical_address AllocateLogicalAddressRecordingDevice(void);
260
261	/*!
262	* @brief Try to allocate a logical address for a tuner controlled by this client.
263	* @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
264	*/
265	virtual cec_logical_address AllocateLogicalAddressTuner(void);
266
267	/*!
268	* @brief Try to allocate a logical address for a playback device controlled by this client.
269	* @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
270	*/
271	virtual cec_logical_address AllocateLogicalAddressPlaybackDevice(void);
272
273	/*!
274	* @brief Try to allocate a logical address for an audiosystem controlled by this client.
275	* @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
276	*/
277	virtual cec_logical_address AllocateLogicalAddressAudioSystem(void);
278
279	/*!
280	* @brief Change the physical address of the devices controlled by this client.
281	* @param iPhysicalAddress The new physical address.
282	* @return True when changed, false otherwise.
283	*/
284	virtual bool SetDevicePhysicalAddress(const uint16_t iPhysicalAddress);
285
286	/*!
287	* @brief Try to autodetect the physical address.
288	* @return True when autodetected (and set in m_configuration), false otherwise.
289	*/
290	virtual bool AutodetectPhysicalAddress(void);
291
292	/*!
293	* @brief Replaces all device types in m_configuration by types that are supported by the command handler of the TV
294	*/
295	virtual void SetSupportedDeviceTypes(void);
296
297	virtual void CallbackAddCommand(const cec_command &command);
298	virtual void CallbackAddKey(const cec_keypress &key);
299	virtual void CallbackAddLog(const cec_log_message &message);
300	virtual void CallbackAlert(const libcec_alert type, const libcec_parameter &param);
301	virtual void CallbackConfigurationChanged(const libcec_configuration &config);
302	virtual int CallbackMenuStateChanged(const cec_menu_state newState);
303	virtual void CallbackSourceActivated(bool bActivated, const cec_logical_address logicalAddress);
304
305	uint32_t DoubleTapTimeoutMS(void);
306
307	CCECProcessor * m_processor; /*< a pointer to the processor /
308	libcec_configuration m_configuration; /*< the configuration of this client /
309	bool m_bInitialised; /*< true when initialised, false otherwise /
310	bool m_bRegistered; /*< true when registered in the processor, false otherwise /
311	PLATFORM::CMutex m_mutex; /*< mutex for changes to this instance /
312	PLATFORM::CMutex m_cbMutex; /*< mutex that is held when doing anything with callbacks /
313	cec_user_control_code m_iCurrentButton; /*< the control code of the button that's currently held down (if any) /
314	int64_t m_buttontime; /*< the timestamp when the button was pressed (in seconds since epoch), or 0 if none was pressed. /
315	int64_t m_iPreventForwardingPowerOffCommand; /*< prevent forwarding standby commands until this time /
316	int64_t m_iLastKeypressTime; /*< last time a key press was sent to the client /
317	cec_keypress m_lastKeypress; /*< the last key press that was sent to the client /
318	};
319	}