load and save the 2548:1002 config for XBMC too. try to create the profile directory...
[deb_libcec.git] / src / lib / CECClient.h
CommitLineData
004b8382
LOK
1#pragma once
2/*
3 * This file is part of the libCEC(R) library.
4 *
5 * libCEC(R) is Copyright (C) 2011-2012 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
2b44051c 34#include <string>
004b8382
LOK
35#include "platform/threads/mutex.h"
36#include "platform/util/buffer.h"
37
004b8382
LOK
38namespace CEC
39{
40 class CCECProcessor;
2b44051c
LOK
41 class CCECBusDevice;
42 class CCECPlaybackDevice;
004b8382
LOK
43
44 class CCECClient
45 {
679dfa07
LOK
46 friend class CCECProcessor;
47
004b8382 48 public:
c0152c09 49 CCECClient(CCECProcessor *processor, const libcec_configuration &configuration);
004b8382
LOK
50 virtual ~CCECClient(void);
51
679dfa07
LOK
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 */
2b44051c 100 virtual std::string GetConnectionInfo(void);
679dfa07
LOK
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 */
2b44051c 110 virtual std::string GetOSDName(void);
679dfa07
LOK
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);
004b8382
LOK
126
127 // client-specific part of ICECAdapter
679dfa07
LOK
128 virtual bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks);
129 virtual bool PingAdapter(void);
2b44051c 130 virtual bool Transmit(const cec_command &data, bool bIsReply);
679dfa07
LOK
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 bool SendKeypress(const cec_logical_address iDestination, const cec_user_control_code key, bool bWait = true);
156 virtual bool SendKeyRelease(const cec_logical_address iDestination, bool bWait = true);
157 virtual cec_osd_name GetDeviceOSDName(const cec_logical_address iAddress);
158 virtual cec_logical_address GetActiveSource(void);
159 virtual bool IsActiveSource(const cec_logical_address iAddress);
160 virtual bool SetStreamPath(const cec_logical_address iAddress);
161 virtual bool SetStreamPath(const uint16_t iPhysicalAddress);
162 virtual cec_logical_addresses GetLogicalAddresses(void);
163 virtual void RescanActiveDevices(void);
164 virtual bool IsLibCECActiveSource(void);
004b8382
LOK
165
166 // configuration
679dfa07
LOK
167 virtual bool GetCurrentConfiguration(libcec_configuration &configuration);
168 virtual bool SetConfiguration(const libcec_configuration &configuration);
169 virtual bool CanPersistConfiguration(void);
170 virtual bool PersistConfiguration(const libcec_configuration &configuration);
171 virtual void SetPhysicalAddress(const libcec_configuration &configuration);
004b8382
LOK
172
173 // callbacks
679dfa07
LOK
174 virtual void AddCommand(const cec_command &command);
175 virtual int MenuStateChanged(const cec_menu_state newState);
2b44051c
LOK
176 virtual void Alert(const libcec_alert type, const libcec_parameter &param) { CallbackAlert(type, param); }
177 virtual void AddLog(const cec_log_message &message) { CallbackAddLog(message); }
df312c6c 178 virtual void AddKey(bool bSendComboKey = false);
679dfa07
LOK
179 virtual void AddKey(const cec_keypress &key);
180 virtual void SetCurrentButton(const cec_user_control_code iButtonCode);
181 virtual void CheckKeypressTimeout(void);
29d5198c
LOK
182 virtual void SourceActivated(const cec_logical_address logicalAddress);
183 virtual void SourceDeactivated(const cec_logical_address logicalAddress);
004b8382
LOK
184
185 protected:
679dfa07
LOK
186 /*!
187 * @brief Register this client in the processor
188 * @return True when registered, false otherwise.
189 */
190 virtual bool OnRegister(void);
191
192 /*!
193 * @brief Called by the processor when this client is unregistered
194 */
195 virtual void OnUnregister(void) { SetRegistered(false); SetInitialised(false); }
196
197 /*!
198 * @brief Set the registered state of this client.
199 * @param bSetTo The new value.
200 */
201 virtual void SetRegistered(bool bSetTo);
202
203 /*!
204 * @brief Set the initialised state of this client.
205 * @param bSetTo The new value
206 */
207 virtual void SetInitialised(bool bSetTo);
208
209 /*!
210 * @brief Change the TV vendor id override setting.
211 * @param id The new value.
212 */
213 virtual void SetTVVendorOverride(const cec_vendor_id id);
214
215 /*!
216 * @brief Change the OSD name of the primary device that this client is controlling.
217 * @param strDeviceName The new value.
218 */
2b44051c 219 virtual void SetOSDName(const std::string &strDeviceName);
679dfa07
LOK
220
221 /*!
222 * @brief Change the value of the devices to wake.
223 * @param addresses The new value.
224 */
225 virtual void SetWakeDevices(const cec_logical_addresses &addresses);
226
227 /*!
228 * @brief Change the value of the client version setting.
229 * @param version The new version setting.
230 */
231 virtual void SetClientVersion(const cec_client_version version);
232
233 /*!
234 * @brief Change the device types that this client is controlling.
235 * @param deviceTypes The new types.
236 * @return True when the client needs to be re-registered to pick up the new setting, false otherwise.
237 */
238 virtual bool SetDeviceTypes(const cec_device_type_list &deviceTypes);
239
240 /*!
241 * @return A pointer to the current configuration of this client.
242 */
243 virtual libcec_configuration *GetConfiguration(void) { return &m_configuration; }
244
245 /*!
246 * @brief Called by the processor when registering this client to allocate the logical addresses.
247 * @return True when the addresses for all types were allocated, false otherwise.
248 */
249 virtual bool AllocateLogicalAddresses(void);
250
251 /*!
252 * @brief Try to allocate a logical address for a recording device controlled by this client.
253 * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
254 */
255 virtual cec_logical_address AllocateLogicalAddressRecordingDevice(void);
256
257 /*!
258 * @brief Try to allocate a logical address for a tuner controlled by this client.
259 * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
260 */
261 virtual cec_logical_address AllocateLogicalAddressTuner(void);
262
263 /*!
264 * @brief Try to allocate a logical address for a playback device controlled by this client.
265 * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
266 */
267 virtual cec_logical_address AllocateLogicalAddressPlaybackDevice(void);
268
269 /*!
270 * @brief Try to allocate a logical address for an audiosystem controlled by this client.
271 * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
272 */
273 virtual cec_logical_address AllocateLogicalAddressAudioSystem(void);
274
275 /*!
276 * @brief Change the physical address of the devices controlled by this client.
277 * @param iPhysicalAddress The new physical address.
278 * @return True when changed, false otherwise.
279 */
280 virtual bool SetDevicePhysicalAddress(const uint16_t iPhysicalAddress);
281
679dfa07
LOK
282 /*!
283 * @brief Try to autodetect the physical address.
284 * @return True when autodetected (and set in m_configuration), false otherwise.
285 */
286 virtual bool AutodetectPhysicalAddress(void);
287
42d28d15
LOK
288 /*!
289 * @brief Replaces all device types in m_configuration by types that are supported by the command handler of the TV
290 */
291 virtual void SetSupportedDeviceTypes(void);
292
2b44051c
LOK
293 virtual void CallbackAddCommand(const cec_command &command);
294 virtual void CallbackAddKey(const cec_keypress &key);
295 virtual void CallbackAddLog(const cec_log_message &message);
296 virtual void CallbackAlert(const libcec_alert type, const libcec_parameter &param);
297 virtual void CallbackConfigurationChanged(const libcec_configuration &config);
298 virtual int CallbackMenuStateChanged(const cec_menu_state newState);
299 virtual void CallbackSourceActivated(bool bActivated, const cec_logical_address logicalAddress);
300
2d4e263c
LOK
301 CCECProcessor * m_processor; /**< a pointer to the processor */
302 libcec_configuration m_configuration; /**< the configuration of this client */
303 bool m_bInitialised; /**< true when initialised, false otherwise */
304 bool m_bRegistered; /**< true when registered in the processor, false otherwise */
305 PLATFORM::CMutex m_mutex; /**< mutex for changes to this instance */
306 PLATFORM::CMutex m_cbMutex; /**< mutex that is held when doing anything with callbacks */
307 cec_user_control_code m_iCurrentButton; /**< the control code of the button that's currently held down (if any) */
308 int64_t m_buttontime; /**< the timestamp when the button was pressed (in seconds since epoch), or 0 if none was pressed. */
309 int64_t m_iPreventForwardingPowerOffCommand; /**< prevent forwarding standby commands until this time */
004b8382
LOK
310 };
311}