Merge branch 'master' into release
[deb_libcec.git] / include / cec.h
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
34 #ifndef CECEXPORTS_H_
35 #define CECEXPORTS_H_
36
37 #include "cectypes.h"
38
39 #define LIBCEC_VERSION_CURRENT CEC_SERVER_VERSION_1_6_3
40
41 namespace CEC
42 {
43 class ICECAdapter
44 {
45 public:
46 virtual ~ICECAdapter() {};
47 /*! @name Adapter methods */
48 //@{
49
50 /*!
51 * @brief Open a connection to the CEC adapter.
52 * @param strPort The path to the port.
53 * @param iTimeoutMs Connection timeout in ms.
54 * @return True when connected, false otherwise.
55 */
56 virtual bool Open(const char *strPort, uint32_t iTimeoutMs = 10000) = 0;
57
58 /*!
59 * @brief Close the connection to the CEC adapter.
60 */
61 virtual void Close(void) = 0;
62
63 /*!
64 * @brief Set and enable the callback methods. If this method is not called, the GetNext...() methods will have to be used.
65 * @param cbParam Parameter to pass to callback methods.
66 * @param callbacks The callbacks to set.
67 * @return True when enabled, false otherwise.
68 */
69 virtual bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks) = 0;
70
71 /*!
72 * @brief Try to find all connected CEC adapters. Only implemented on Linux and Windows at the moment.
73 * @param deviceList The vector to store device descriptors in.
74 * @param iBufSize The size of the deviceList buffer.
75 * @param strDevicePath Optional device path. Only adds device descriptors that match the given device path.
76 * @return The number of devices that were found, or -1 when an error occured.
77 */
78 virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL) = 0;
79
80 /*!
81 * @brief Ping the CEC adapter.
82 * @return True when the ping was succesful, false otherwise.
83 */
84 virtual bool PingAdapter(void) = 0;
85
86 /*!
87 * @brief Start the bootloader of the CEC adapter.
88 * @return True when the command was sent succesfully, false otherwise.
89 */
90 virtual bool StartBootloader(void) = 0;
91 //@}
92
93 /*!
94 * @deprecated Use libcec_configuration instead
95 * @return Get the minimal version of libcec that this version of libcec can interface with.
96 */
97 virtual int8_t GetMinLibVersion(void) const = 0;
98
99 /*!
100 * @deprecated Use libcec_configuration instead
101 * @return Get the major version of libcec.
102 */
103 virtual int8_t GetLibVersionMajor(void) const = 0;
104
105 /*!
106 * @deprecated Use libcec_configuration instead
107 * @return Get the minor version of libcec.
108 */
109 virtual int8_t GetLibVersionMinor(void) const = 0;
110
111 /*!
112 * @deprecated Use callback methods instead
113 * @brief Get the next log message in the queue, if there is one.
114 * @param message The next message.
115 * @return True if a message was passed, false otherwise.
116 */
117 virtual bool GetNextLogMessage(cec_log_message *message) = 0;
118
119 /*!
120 * @deprecated Use callback methods instead
121 * @brief Get the next keypress in the queue, if there is one.
122 * @param key The next keypress.
123 * @return True if a key was passed, false otherwise.
124 */
125 virtual bool GetNextKeypress(cec_keypress *key) = 0;
126
127 /*!
128 * @deprecated Use callback methods instead
129 * @brief Get the next CEC command that was received by the adapter.
130 * @param command The next command.
131 * @return True when a command was passed, false otherwise.
132 */
133 virtual bool GetNextCommand(cec_command *command) = 0;
134
135 /*!
136 * @brief Transmit a command over the CEC line.
137 * @param data The command to send.
138 * @return True when the data was sent and acked, false otherwise.
139 */
140 virtual bool Transmit(const cec_command &data) = 0;
141
142 /*!
143 * @brief Change the logical address of the CEC adapter.
144 * @param iLogicalAddress The CEC adapter's new logical address.
145 * @return True when the logical address was set successfully, false otherwise.
146 */
147 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1) = 0;
148
149 /*!
150 * @brief Change the physical address (HDMI port) of the CEC adapter.
151 * @param iPhysicalAddress The CEC adapter's new physical address.
152 * @brief True when the physical address was set successfully, false otherwise.
153 */
154 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0;
155
156 /*!
157 * @deprecated Use libcec_configuration instead.
158 * @brief Enable physical address detection (if the connected adapter supports this).
159 * @return True when physical address detection was enabled, false otherwise.
160 */
161 virtual bool EnablePhysicalAddressDetection(void) = 0;
162
163 /*!
164 * @brief Changes the active HDMI port.
165 * @param iBaseDevice The device to which this libcec is connected.
166 * @param iPort The new port number.
167 * @return True when changed, false otherwise.
168 */
169 virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort) = 0;
170
171 /*!
172 * @brief Power on the connected CEC capable devices.
173 * @param address The logical address to power on.
174 * @return True when the command was sent succesfully, false otherwise.
175 */
176 virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0;
177
178 /*!
179 * @brief Put connected CEC capable devices in standby mode.
180 * @brief address The logical address of the device to put in standby.
181 * @return True when the command was sent succesfully, false otherwise.
182 */
183 virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
184
185 /*!
186 * @brief Change the active source.
187 * @param type The new active source. Leave empty to use the primary type
188 * @return True when the command was sent succesfully, false otherwise.
189 */
190 virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED) = 0;
191
192 /*!
193 * @deprecated Use SetActiveSource() instead
194 */
195 virtual bool SetActiveView(void) = 0;
196
197 /*!
198 * @brief Change the deck control mode, if this adapter is registered as playback device.
199 * @param mode The new control mode.
200 * @param bSendUpdate True to send the status over the CEC line.
201 * @return True if set, false otherwise.
202 */
203 virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true) = 0;
204
205 /*!
206 * @brief Change the deck info, if this adapter is a playback device.
207 * @param info The new deck info.
208 * @param bSendUpdate True to send the status over the CEC line.
209 * @return True if set, false otherwise.
210 */
211 virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true) = 0;
212
213 /*!
214 * @brief Broadcast a message that notifies connected CEC capable devices that this device is no longer the active source.
215 * @return True when the command was sent succesfully, false otherwise.
216 */
217 virtual bool SetInactiveView(void) = 0;
218
219 /*!
220 * @brief Change the menu state.
221 * @param state The new true.
222 * @param bSendUpdate True to send the status over the CEC line.
223 * @return True if set, false otherwise.
224 */
225 virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true) = 0;
226
227 /*!
228 * @brief Display a message on the device with the given logical address.
229 * @param iLogicalAddress The device to display the message on.
230 * @param duration The duration of the message
231 * @param strMessage The message to display.
232 * @return True when the command was sent, false otherwise.
233 */
234 virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0;
235
236 /*!
237 * @brief Enable or disable monitoring mode.
238 * @param bEnable True to enable, false to disable.
239 * @return True when switched successfully, false otherwise.
240 */
241 virtual bool SwitchMonitoring(bool bEnable) = 0;
242
243 /*!
244 * @brief Get the CEC version of the device with the given logical address
245 * @param iLogicalAddress The device to get the CEC version for.
246 * @return The version or CEC_VERSION_UNKNOWN when the version couldn't be fetched.
247 */
248 virtual cec_version GetDeviceCecVersion(cec_logical_address iLogicalAddress) = 0;
249
250 /*!
251 * @brief Get the menu language of the device with the given logical address
252 * @param iLogicalAddress The device to get the menu language for.
253 * @param language The requested menu language.
254 * @return True when fetched succesfully, false otherwise.
255 */
256 virtual bool GetDeviceMenuLanguage(cec_logical_address iLogicalAddress, cec_menu_language *language) = 0;
257
258 /*!
259 * @brief Get the vendor ID of the device with the given logical address.
260 * @param iLogicalAddress The device to get the vendor id for.
261 * @return The vendor ID or 0 if it wasn't found.
262 */
263 virtual uint64_t GetDeviceVendorId(cec_logical_address iLogicalAddress) = 0;
264
265 /*!
266 * @brief Get the power status of the device with the given logical address.
267 * @param iLogicalAddress The device to get the power status for.
268 * @return The power status or CEC_POWER_STATUS_UNKNOWN if it wasn't found.
269 */
270 virtual cec_power_status GetDevicePowerStatus(cec_logical_address iLogicalAddress) = 0;
271
272 /*!
273 * @brief Get the physical address of the device with the given logical address.
274 * @param iLogicalAddress The device to get the vendor id for.
275 * @return The physical address or 0 if it wasn't found.
276 */
277 virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iLogicalAddress) = 0;
278
279 /*!
280 * @brief Sends a POLL message to a device.
281 * @param iLogicalAddress The device to send the message to.
282 * @return True if the POLL was acked, false otherwise.
283 */
284 virtual bool PollDevice(cec_logical_address iLogicalAddress) = 0;
285
286 /*!
287 * @return The devices that are active on the bus and not handled by libcec.
288 */
289 virtual cec_logical_addresses GetActiveDevices(void) = 0;
290
291 /*!
292 * @brief Check whether a device is active on the bus.
293 * @param iLogicalAddress The address to check.
294 * @return True when active, false otherwise.
295 */
296 virtual bool IsActiveDevice(cec_logical_address iLogicalAddress) = 0;
297
298 /*!
299 * @brief Check whether a device of the given type is active on the bus.
300 * @param type The type to check.
301 * @return True when active, false otherwise.
302 */
303 virtual bool IsActiveDeviceType(cec_device_type type) = 0;
304
305 /*!
306 * @brief Sends a volume up keypress to an audiosystem if it's present.
307 * @param bSendRelease Send a key release after the keypress.
308 * @return The new audio status.
309 */
310 virtual uint8_t VolumeUp(bool bSendRelease = true) = 0;
311
312 /*!
313 * @brief Sends a volume down keypress to an audiosystem if it's present.
314 * @param bSendRelease Send a key release after the keypress.
315 * @return The new audio status.
316 */
317 virtual uint8_t VolumeDown(bool bSendRelease = true) = 0;
318
319 /*!
320 * @brief Sends a mute keypress to an audiosystem if it's present.
321 * @param bSendRelease Send a key release after the keypress.
322 * @return The new audio status.
323 */
324 virtual uint8_t MuteAudio(bool bSendRelease = true) = 0;
325
326 /*!
327 * @brief Send a keypress to a device on the CEC bus.
328 * @param iDestination The address to send the message to.
329 * @param key The key to send.
330 * @param bWait True to wait for a response, false otherwise.
331 * @return True when the keypress was acked, false otherwise.
332 */
333 virtual bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = false) = 0;
334
335 /*!
336 * @brief Send a key release to a device on the CEC bus.
337 * @param iDestination The address to send the message to.
338 * @param bWait True to wait for a response, false otherwise.
339 * @return True when the keypress was acked, false otherwise.
340 */
341 virtual bool SendKeyRelease(cec_logical_address iDestination, bool bWait = false) = 0;
342
343 /*!
344 * @brief Get the OSD name of a device on the CEC bus.
345 * @param iLogicalAddress The device to get the OSD name for.
346 * @return The OSD name.
347 */
348 virtual cec_osd_name GetDeviceOSDName(cec_logical_address iLogicalAddress) = 0;
349
350 /*!
351 * @brief Get the logical address of the device that is currently the active source on the CEC bus.
352 * @return The active source or CECDEVICE_UNKNOWN when unknown.
353 */
354 virtual cec_logical_address GetActiveSource(void) = 0;
355
356 /*!
357 * @brief Check whether a device is currently the active source on the CEC bus.
358 * @param iLogicalAddress The address to check.
359 * @return True when it is the active source, false otherwise.
360 */
361 virtual bool IsActiveSource(cec_logical_address iLogicalAddress) = 0;
362
363 /*!
364 * @brief Sets the stream path to the device on the given logical address.
365 * @param iLogicalAddress The address to activate.
366 * @return True when the command was sent, false otherwise.
367 */
368 virtual bool SetStreamPath(cec_logical_address iLogicalAddress) = 0;
369
370 /*!
371 * @brief Sets the stream path to the device on the given logical address.
372 * @param iPhysicalAddress The address to activate.
373 * @return True when the command was sent, false otherwise.
374 */
375 virtual bool SetStreamPath(uint16_t iPhysicalAddress) = 0;
376
377 /*!
378 * @return The list of addresses that libCEC is controlling
379 */
380 virtual cec_logical_addresses GetLogicalAddresses(void) = 0;
381
382 virtual const char *ToString(const cec_menu_state state) = 0;
383 virtual const char *ToString(const cec_version version) = 0;
384 virtual const char *ToString(const cec_power_status status) = 0;
385 virtual const char *ToString(const cec_logical_address address) = 0;
386 virtual const char *ToString(const cec_deck_control_mode mode) = 0;
387 virtual const char *ToString(const cec_deck_info status) = 0;
388 virtual const char *ToString(const cec_opcode opcode) = 0;
389 virtual const char *ToString(const cec_system_audio_status mode) = 0;
390 virtual const char *ToString(const cec_audio_status status) = 0;
391 virtual const char *ToString(const cec_vendor_id vendor) = 0;
392 virtual const char *ToString(const cec_client_version version) = 0;
393 virtual const char *ToString(const cec_server_version version) = 0;
394
395 /*!
396 * @brief Get libCEC's current configuration.
397 * @param configuration The configuration.
398 * @return True when the configuration was updated, false otherwise.
399 */
400 virtual bool GetCurrentConfiguration(libcec_configuration *configuration) = 0;
401
402 /*!
403 * @brief Change libCEC's configuration.
404 * @param configuration The new configuration.
405 * @return True when the configuration was changed successfully, false otherwise.
406 */
407 virtual bool SetConfiguration(const libcec_configuration *configuration) = 0;
408
409 /*!
410 * @return True when this device can persist the user configuration, false otherwise.
411 */
412 virtual bool CanPersistConfiguration(void) = 0;
413
414 /*!
415 * @brief Persist the given configuration in adapter (if supported)
416 * @brief The configuration to store.
417 * @return True when the configuration was persisted, false otherwise.
418 */
419 virtual bool PersistConfiguration(libcec_configuration *configuration) = 0;
420
421 /*!
422 * @brief Tell libCEC to poll for active devices on the bus.
423 */
424 virtual void RescanActiveDevices(void) = 0;
425
426 /*!
427 * @return true when libCEC is the active source on the bus, false otherwise.
428 */
429 virtual bool IsLibCECActiveSource(void) = 0;
430
431 /*!
432 * @brief Get information about the given device
433 * @param strPort The port to which the device is connected
434 * @param config The device configuration
435 * @param iTimeoutMs The timeout in milliseconds
436 * @return True when the device was found, false otherwise
437 */
438 virtual bool GetDeviceInformation(const char *strPort, libcec_configuration *config, uint32_t iTimeoutMs = 10000) = 0;
439 };
440 };
441
442 /*!
443 * @brief Load the CEC adapter library.
444 * @param strDeviceName How to present this device to other devices.
445 * @param deviceTypes The device types to use on the CEC bus.
446 * @param iPhysicalAddress The physical address to assume on the bus. If set to 0, libCEC will try to autodetect the address, with the data provided via SetHDMIPort()
447 * @return An instance of ICECAdapter or NULL on error.
448 */
449 extern "C" DECLSPEC void * CECInit(const char *strDeviceName, CEC::cec_device_type_list deviceTypes, uint16_t iPhysicalAddress = 0);
450
451 /*!
452 * @brief Load the CEC adapter library.
453 * @param configuration The configuration to pass to libCEC
454 * @return An instance of ICECAdapter or NULL on error.
455 */
456 extern "C" DECLSPEC void * CECInitialise(CEC::libcec_configuration *configuration);
457
458 /*!
459 * @brief Try to connect to the adapter and send the "start bootloader" command, without initialising libCEC and going through all checks
460 * @return True when the command was send, false otherwise.
461 */
462 extern "C" DECLSPEC bool CECStartBootloader(void);
463
464 /*!
465 * @brief Unload the CEC adapter library.
466 */
467 extern "C" DECLSPEC void CECDestroy(CEC::ICECAdapter *instance);
468
469 #endif /* CECEXPORTS_H_ */