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