cec-config-gui: added some tooltips
[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 namespace 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 * @return Get the minimal version of libcec that this version of libcec can interface with.
93 */
94 virtual int8_t GetMinLibVersion(void) const = 0;
95
96 /*!
97 * @return Get the major version of libcec.
98 */
99 virtual int8_t GetLibVersionMajor(void) const = 0;
100
101 /*!
102 * @return Get the minor version of libcec.
103 */
104 virtual int8_t GetLibVersionMinor(void) const = 0;
105
106 /*!
107 * @brief Get the next log message in the queue, if there is one.
108 * @param message The next message.
109 * @return True if a message was passed, false otherwise.
110 */
111 virtual bool GetNextLogMessage(cec_log_message *message) = 0;
112
113 /*!
114 * @brief Get the next keypress in the queue, if there is one.
115 * @param key The next keypress.
116 * @return True if a key was passed, false otherwise.
117 */
118 virtual bool GetNextKeypress(cec_keypress *key) = 0;
119
120 /*!
121 * @brief Get the next CEC command that was received by the adapter.
122 * @param action The next command.
123 * @return True when a command was passed, false otherwise.
124 */
125 virtual bool GetNextCommand(cec_command *command) = 0;
126
127 /*!
128 * @brief Transmit a command over the CEC line.
129 * @param data The command to send.
130 * @return True when the data was sent and acked, false otherwise.
131 */
132 virtual bool Transmit(const cec_command &data) = 0;
133
134 /*!
135 * @brief Change the logical address of the CEC adapter.
136 * @param iLogicalAddress The CEC adapter's new logical address.
137 * @return True when the logical address was set successfully, false otherwise.
138 */
139 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1) = 0;
140
141 /*!
142 * @brief Change the physical address (HDMI port) of the CEC adapter.
143 * @param iPhysicalAddress The CEC adapter's new physical address.
144 * @brief True when the physical address was set successfully, false otherwise.
145 */
146 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0;
147
148 /*!
149 * @brief Enable physical address detection (if the connected adapter supports this).
150 * @return True when physical address detection was enabled, false otherwise.
151 */
152 virtual bool EnablePhysicalAddressDetection(void) = 0;
153
154 /*!
155 * @brief Changes the active HDMI port.
156 * @param iBaseDevice The device to which this libcec is connected.
157 * @param iPort The new port number.
158 * @return True when changed, false otherwise.
159 */
160 virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort) = 0;
161
162 /*!
163 * @brief Power on the connected CEC capable devices.
164 * @param address The logical address to power on.
165 * @return True when the command was sent succesfully, false otherwise.
166 */
167 virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0;
168
169 /*!
170 * @brief Put connected CEC capable devices in standby mode.
171 * @brief address The logical address of the device to put in standby.
172 * @return True when the command was sent succesfully, false otherwise.
173 */
174 virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
175
176 /*!
177 * @brief Change the active source.
178 * @param type The new active source. Leave empty to use the primary type
179 * @return True when the command was sent succesfully, false otherwise.
180 */
181 virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED) = 0;
182
183 /*!
184 * @deprecated Use SetActiveSource() instead
185 */
186 virtual bool SetActiveView(void) = 0;
187
188 /*!
189 * @brief Change the deck control mode, if this adapter is registered as playback device.
190 * @param mode The new control mode.
191 * @param bSendUpdate True to send the status over the CEC line.
192 * @return True if set, false otherwise.
193 */
194 virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true) = 0;
195
196 /*!
197 * @brief Change the deck info, if this adapter is a playback device.
198 * @param info The new deck info.
199 * @return True if set, false otherwise.
200 */
201 virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true) = 0;
202
203 /*!
204 * @brief Broadcast a message that notifies connected CEC capable devices that this device is no longer the active source.
205 * @return True when the command was sent succesfully, false otherwise.
206 */
207 virtual bool SetInactiveView(void) = 0;
208
209 /*!
210 * @brief Change the menu state.
211 * @param state The new true.
212 * @param bSendUpdate True to send the status over the CEC line.
213 * @return True if set, false otherwise.
214 */
215 virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true) = 0;
216
217 /*!
218 * @brief Display a message on the device with the given logical address.
219 * @param iLogicalAddres The device to display the message on.
220 * @param duration The duration of the message
221 * @param strMessage The message to display.
222 * @return True when the command was sent, false otherwise.
223 */
224 virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0;
225
226 /*!
227 * @brief Enable or disable monitoring mode.
228 * @param bEnable True to enable, false to disable.
229 * @return True when switched successfully, false otherwise.
230 */
231 virtual bool SwitchMonitoring(bool bEnable) = 0;
232
233 /*!
234 * @brief Get the CEC version of the device with the given logical address
235 * @param iLogicalAddress The device to get the CEC version for.
236 * @return The version or CEC_VERSION_UNKNOWN when the version couldn't be fetched.
237 */
238 virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress) = 0;
239
240 /*!
241 * @brief Get the menu language of the device with the given logical address
242 * @param iLogicalAddress The device to get the menu language for.
243 * @param language The requested menu language.
244 * @return True when fetched succesfully, false otherwise.
245 */
246 virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language) = 0;
247
248 /*!
249 * @brief Get the vendor ID of the device with the given logical address.
250 * @param iLogicalAddress The device to get the vendor id for.
251 * @return The vendor ID or 0 if it wasn't found.
252 */
253 virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress) = 0;
254
255 /*!
256 * @brief Get the power status of the device with the given logical address.
257 * @param iLogicalAddress The device to get the power status for.
258 * @return The power status or CEC_POWER_STATUS_UNKNOWN if it wasn't found.
259 */
260 virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress) = 0;
261
262 /*!
263 * @brief Get the physical address of the device with the given logical address.
264 * @param iLogicalAddress The device to get the vendor id for.
265 * @return The physical address or 0 if it wasn't found.
266 */
267 virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress) = 0;
268
269 /*!
270 * @brief Sends a POLL message to a device.
271 * @param iAddress The device to send the message to.
272 * @return True if the POLL was acked, false otherwise.
273 */
274 virtual bool PollDevice(cec_logical_address iAddress) = 0;
275
276 /*!
277 * @return The devices that are active on the bus and not handled by libcec.
278 */
279 virtual cec_logical_addresses GetActiveDevices(void) = 0;
280
281 /*!
282 * @brief Check whether a device is active on the bus.
283 * @param iAddress The address to check.
284 * @return True when active, false otherwise.
285 */
286 virtual bool IsActiveDevice(cec_logical_address iAddress) = 0;
287
288 /*!
289 * @brief Check whether a device of the given type is active on the bus.
290 * @param type The type to check.
291 * @return True when active, false otherwise.
292 */
293 virtual bool IsActiveDeviceType(cec_device_type type) = 0;
294
295 /*!
296 * @brief Sends a volume up keypress to an audiosystem if it's present.
297 * @param bSendRelease Send a key release after the keypress.
298 * @return The new audio status.
299 */
300 virtual uint8_t VolumeUp(bool bSendRelease = true) = 0;
301
302 /*!
303 * @brief Sends a volume down 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 VolumeDown(bool bSendRelease = true) = 0;
308
309 /*!
310 * @brief Sends a mute 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 MuteAudio(bool bSendRelease = true) = 0;
315
316 /*!
317 * @brief Send a keypress to a device on the CEC bus.
318 * @param iDestination The address to send the message to.
319 * @param key The key to send.
320 * @param bWait True to wait for a response, false otherwise.
321 * @return True when the keypress was acked, false otherwise.
322 */
323 virtual bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = false) = 0;
324
325 /*!
326 * @brief Send a key release to a device on the CEC bus.
327 * @param iDestination The address to send the message to.
328 * @param bWait True to wait for a response, false otherwise.
329 * @return True when the keypress was acked, false otherwise.
330 */
331 virtual bool SendKeyRelease(cec_logical_address iDestination, bool bWait = false) = 0;
332
333 /*!
334 * @brief Get the OSD name of a device on the CEC bus.
335 * @param iAddress The device to get the OSD name for.
336 * @return The OSD name.
337 */
338 virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress) = 0;
339
340 /*!
341 * @brief Get the logical address of the device that is currently the active source on the CEC bus.
342 * @return The active source or CECDEVICE_UNKNOWN when unknown.
343 */
344 virtual cec_logical_address GetActiveSource(void) = 0;
345
346 /*!
347 * @brief Check whether a device is currently the active source on the CEC bus.
348 * @param iAddress The address to check.
349 * @return True when it is the active source, false otherwise.
350 */
351 virtual bool IsActiveSource(cec_logical_address iAddress) = 0;
352
353 /*!
354 * @brief Sets the stream path to the device on the given logical address.
355 * @param iAddress The address to activate.
356 * @return True when the command was sent, false otherwise.
357 */
358 virtual bool SetStreamPath(cec_logical_address iAddress) = 0;
359
360 /*!
361 * @brief Sets the stream path to the device on the given logical address.
362 * @param iPhysicalAddress The address to activate.
363 * @return True when the command was sent, false otherwise.
364 */
365 virtual bool SetStreamPath(uint16_t iPhysicalAddress) = 0;
366
367 /*!
368 * @return The list of addresses that libCEC is controlling
369 */
370 virtual cec_logical_addresses GetLogicalAddresses(void) = 0;
371
372 /*!
373 * @brief Get libCEC's current configuration.
374 * @param configuration The configuration.
375 * @return True when the configuration was updated, false otherwise.
376 */
377 virtual bool GetCurrentConfiguration(libcec_configuration *configuration) = 0;
378
379 /*!
380 * @return True when this device can persist the user configuration, false otherwise.
381 */
382 virtual bool CanPersistConfiguration(void) = 0;
383
384 /*!
385 * @brief Persist the given configuration in adapter (if supported)
386 * @brief The configuration to store.
387 * @return True when the configuration was persisted, false otherwise.
388 */
389 virtual bool PersistConfiguration(libcec_configuration *configuration) = 0;
390
391 virtual const char *ToString(const cec_menu_state state) = 0;
392 virtual const char *ToString(const cec_version version) = 0;
393 virtual const char *ToString(const cec_power_status status) = 0;
394 virtual const char *ToString(const cec_logical_address address) = 0;
395 virtual const char *ToString(const cec_deck_control_mode mode) = 0;
396 virtual const char *ToString(const cec_deck_info status) = 0;
397 virtual const char *ToString(const cec_opcode opcode) = 0;
398 virtual const char *ToString(const cec_system_audio_status mode) = 0;
399 virtual const char *ToString(const cec_audio_status status) = 0;
400 virtual const char *ToString(const cec_vendor_id vendor) = 0;
401 virtual const char *ToString(const cec_client_version version) = 0;
402 };
403 };
404
405 /*!
406 * @brief Load the CEC adapter library.
407 * @param strDeviceName How to present this device to other devices.
408 * @param deviceTypes The device types to use on the CEC bus.
409 * @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()
410 * @return An instance of ICECAdapter or NULL on error.
411 */
412 extern "C" DECLSPEC void * CECInit(const char *strDeviceName, CEC::cec_device_type_list deviceTypes, uint16_t iPhysicalAddress = 0);
413
414 /*!
415 * @brief Load the CEC adapter library.
416 * @param configuration The configuration to pass to libCEC
417 * @return An instance of ICECAdapter or NULL on error.
418 */
419 extern "C" DECLSPEC void * CECInitialise(const CEC::libcec_configuration *configuration);
420
421 /*!
422 * @brief Unload the CEC adapter library.
423 */
424 extern "C" DECLSPEC void CECDestroy(CEC::ICECAdapter *instance);
425
426 #endif /* CECEXPORTS_H_ */