Commit | Line | Data |
---|---|---|
abbca718 LOK |
1 | #pragma once |
2 | /* | |
3 | * This file is part of the libCEC(R) library. | |
4 | * | |
b492c10e | 5 | * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved. |
abbca718 LOK |
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 | ||
acec5f48 LOK |
34 | #ifndef CECEXPORTS_H_ |
35 | #define CECEXPORTS_H_ | |
36 | ||
bafc6701 | 37 | #include "cectypes.h" |
acec5f48 | 38 | |
1664420d | 39 | #define LIBCEC_VERSION_CURRENT CEC_SERVER_VERSION_1_9_0 |
f250c7a4 | 40 | |
abbca718 LOK |
41 | namespace CEC |
42 | { | |
2abe74eb | 43 | class ICECAdapter |
abbca718 LOK |
44 | { |
45 | public: | |
6eb6d0fd | 46 | virtual ~ICECAdapter() {}; |
2abe74eb LOK |
47 | /*! @name Adapter methods */ |
48 | //@{ | |
d9106f08 | 49 | |
abbca718 | 50 | /*! |
d9106f08 LOK |
51 | * @brief Open a connection to the CEC adapter. |
52 | * @param strPort The path to the port. | |
8d901fdb | 53 | * @param iTimeoutMs Connection timeout in ms. |
d9106f08 | 54 | * @return True when connected, false otherwise. |
abbca718 | 55 | */ |
25701fa6 | 56 | virtual bool Open(const char *strPort, uint32_t iTimeoutMs = 10000) = 0; |
abbca718 | 57 | |
f99bc831 | 58 | /*! |
d9106f08 | 59 | * @brief Close the connection to the CEC adapter. |
f99bc831 | 60 | */ |
5f39c4d8 | 61 | virtual void Close(void) = 0; |
f99bc831 | 62 | |
b0cb809d LOK |
63 | // XXX XBMC Eden for Windows has been built against 1.2.0 and Ubuntu against 1.5.2 |
64 | // we accidently broke the abi between these versions, and this will ensure the upgrade will still work | |
65 | #if !defined(_WIN32) && !defined(_WIN64) | |
66 | /*! | |
67 | * @brief Set and enable the callback methods. If this method is not called, the GetNext...() methods will have to be used. | |
68 | * @param cbParam Parameter to pass to callback methods. | |
69 | * @param callbacks The callbacks to set. | |
70 | * @return True when enabled, false otherwise. | |
71 | */ | |
72 | virtual bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks) = 0; | |
73 | #endif | |
74 | ||
fa4798bd LOK |
75 | /*! |
76 | * @brief Try to find all connected CEC adapters. Only implemented on Linux and Windows at the moment. | |
d9106f08 LOK |
77 | * @param deviceList The vector to store device descriptors in. |
78 | * @param iBufSize The size of the deviceList buffer. | |
79 | * @param strDevicePath Optional device path. Only adds device descriptors that match the given device path. | |
80 | * @return The number of devices that were found, or -1 when an error occured. | |
abbca718 | 81 | */ |
25701fa6 | 82 | virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL) = 0; |
abbca718 LOK |
83 | |
84 | /*! | |
d9106f08 LOK |
85 | * @brief Ping the CEC adapter. |
86 | * @return True when the ping was succesful, false otherwise. | |
abbca718 | 87 | */ |
2abe74eb | 88 | virtual bool PingAdapter(void) = 0; |
abbca718 LOK |
89 | |
90 | /*! | |
d9106f08 LOK |
91 | * @brief Start the bootloader of the CEC adapter. |
92 | * @return True when the command was sent succesfully, false otherwise. | |
abbca718 LOK |
93 | */ |
94 | virtual bool StartBootloader(void) = 0; | |
2abe74eb | 95 | //@} |
abbca718 | 96 | |
dc2c98f6 LOK |
97 | /*! |
98 | * @deprecated Use libcec_configuration instead | |
99 | * @return Get the minimal version of libcec that this version of libcec can interface with. | |
100 | */ | |
101 | virtual int8_t GetMinLibVersion(void) const = 0; | |
102 | ||
103 | /*! | |
104 | * @deprecated Use libcec_configuration instead | |
105 | * @return Get the major version of libcec. | |
106 | */ | |
107 | virtual int8_t GetLibVersionMajor(void) const = 0; | |
108 | ||
109 | /*! | |
110 | * @deprecated Use libcec_configuration instead | |
111 | * @return Get the minor version of libcec. | |
112 | */ | |
113 | virtual int8_t GetLibVersionMinor(void) const = 0; | |
114 | ||
115 | /*! | |
116 | * @deprecated Use callback methods instead | |
117 | * @brief Get the next log message in the queue, if there is one. | |
118 | * @param message The next message. | |
119 | * @return True if a message was passed, false otherwise. | |
120 | */ | |
121 | virtual bool GetNextLogMessage(cec_log_message *message) = 0; | |
122 | ||
123 | /*! | |
124 | * @deprecated Use callback methods instead | |
125 | * @brief Get the next keypress in the queue, if there is one. | |
126 | * @param key The next keypress. | |
127 | * @return True if a key was passed, false otherwise. | |
128 | */ | |
129 | virtual bool GetNextKeypress(cec_keypress *key) = 0; | |
130 | ||
131 | /*! | |
132 | * @deprecated Use callback methods instead | |
133 | * @brief Get the next CEC command that was received by the adapter. | |
8d901fdb | 134 | * @param command The next command. |
dc2c98f6 LOK |
135 | * @return True when a command was passed, false otherwise. |
136 | */ | |
137 | virtual bool GetNextCommand(cec_command *command) = 0; | |
138 | ||
abbca718 | 139 | /*! |
d9106f08 LOK |
140 | * @brief Transmit a command over the CEC line. |
141 | * @param data The command to send. | |
142 | * @return True when the data was sent and acked, false otherwise. | |
abbca718 | 143 | */ |
8d84e2c0 | 144 | virtual bool Transmit(const cec_command &data) = 0; |
abbca718 LOK |
145 | |
146 | /*! | |
d9106f08 LOK |
147 | * @brief Change the logical address of the CEC adapter. |
148 | * @param iLogicalAddress The CEC adapter's new logical address. | |
149 | * @return True when the logical address was set successfully, false otherwise. | |
abbca718 | 150 | */ |
2492216a LOK |
151 | virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1) = 0; |
152 | ||
153 | /*! | |
d9106f08 LOK |
154 | * @brief Change the physical address (HDMI port) of the CEC adapter. |
155 | * @param iPhysicalAddress The CEC adapter's new physical address. | |
156 | * @brief True when the physical address was set successfully, false otherwise. | |
2492216a LOK |
157 | */ |
158 | virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0; | |
6dfe9213 | 159 | |
b0cb809d LOK |
160 | // XXX XBMC Eden for Windows has been built against 1.2.0 and Ubuntu against 1.5.2 |
161 | // we accidently broke the abi between these versions, and this will ensure the upgrade will still work | |
162 | #if !defined(_WIN32) && !defined(_WIN64) | |
163 | /*! | |
164 | * @deprecated Use libcec_configuration instead. | |
165 | * @brief Enable physical address detection (if the connected adapter supports this). | |
166 | * @return True when physical address detection was enabled, false otherwise. | |
167 | */ | |
168 | virtual bool EnablePhysicalAddressDetection(void) = 0; | |
169 | ||
170 | /*! | |
171 | * @brief Changes the active HDMI port. | |
172 | * @param iBaseDevice The device to which this libcec is connected. | |
173 | * @param iPort The new port number. | |
174 | * @return True when changed, false otherwise. | |
175 | */ | |
176 | virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort) = 0; | |
177 | #endif | |
178 | ||
6dfe9213 | 179 | /*! |
d9106f08 LOK |
180 | * @brief Power on the connected CEC capable devices. |
181 | * @param address The logical address to power on. | |
182 | * @return True when the command was sent succesfully, false otherwise. | |
6dfe9213 | 183 | */ |
2abe74eb | 184 | virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0; |
abbca718 | 185 | |
df7339c6 | 186 | /*! |
d9106f08 LOK |
187 | * @brief Put connected CEC capable devices in standby mode. |
188 | * @brief address The logical address of the device to put in standby. | |
189 | * @return True when the command was sent succesfully, false otherwise. | |
df7339c6 | 190 | */ |
2abe74eb | 191 | virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0; |
df7339c6 LOK |
192 | |
193 | /*! | |
18203d17 LOK |
194 | * @brief Change the active source. |
195 | * @param type The new active source. Leave empty to use the primary type | |
d9106f08 | 196 | * @return True when the command was sent succesfully, false otherwise. |
df7339c6 | 197 | */ |
18203d17 LOK |
198 | virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED) = 0; |
199 | ||
dc2c98f6 LOK |
200 | /*! |
201 | * @deprecated Use SetActiveSource() instead | |
202 | */ | |
203 | virtual bool SetActiveView(void) = 0; | |
204 | ||
a9232a79 LOK |
205 | /*! |
206 | * @brief Change the deck control mode, if this adapter is registered as playback device. | |
207 | * @param mode The new control mode. | |
28fa6c97 | 208 | * @param bSendUpdate True to send the status over the CEC line. |
a9232a79 LOK |
209 | * @return True if set, false otherwise. |
210 | */ | |
28fa6c97 | 211 | virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true) = 0; |
a9232a79 LOK |
212 | |
213 | /*! | |
214 | * @brief Change the deck info, if this adapter is a playback device. | |
215 | * @param info The new deck info. | |
8d901fdb | 216 | * @param bSendUpdate True to send the status over the CEC line. |
a9232a79 LOK |
217 | * @return True if set, false otherwise. |
218 | */ | |
28fa6c97 | 219 | virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true) = 0; |
a9232a79 | 220 | |
2abe74eb | 221 | /*! |
d9106f08 LOK |
222 | * @brief Broadcast a message that notifies connected CEC capable devices that this device is no longer the active source. |
223 | * @return True when the command was sent succesfully, false otherwise. | |
2abe74eb LOK |
224 | */ |
225 | virtual bool SetInactiveView(void) = 0; | |
1969b140 | 226 | |
28fa6c97 LOK |
227 | /*! |
228 | * @brief Change the menu state. | |
229 | * @param state The new true. | |
230 | * @param bSendUpdate True to send the status over the CEC line. | |
231 | * @return True if set, false otherwise. | |
232 | */ | |
233 | virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true) = 0; | |
234 | ||
1969b140 | 235 | /*! |
d9106f08 | 236 | * @brief Display a message on the device with the given logical address. |
8d901fdb | 237 | * @param iLogicalAddress The device to display the message on. |
d9106f08 LOK |
238 | * @param duration The duration of the message |
239 | * @param strMessage The message to display. | |
240 | * @return True when the command was sent, false otherwise. | |
1969b140 LOK |
241 | */ |
242 | virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0; | |
8b7e5ff6 LOK |
243 | |
244 | /*! | |
d9106f08 LOK |
245 | * @brief Enable or disable monitoring mode. |
246 | * @param bEnable True to enable, false to disable. | |
247 | * @return True when switched successfully, false otherwise. | |
8b7e5ff6 LOK |
248 | */ |
249 | virtual bool SwitchMonitoring(bool bEnable) = 0; | |
6a1c0009 LOK |
250 | |
251 | /*! | |
d9106f08 LOK |
252 | * @brief Get the CEC version of the device with the given logical address |
253 | * @param iLogicalAddress The device to get the CEC version for. | |
254 | * @return The version or CEC_VERSION_UNKNOWN when the version couldn't be fetched. | |
6a1c0009 | 255 | */ |
8d901fdb | 256 | virtual cec_version GetDeviceCecVersion(cec_logical_address iLogicalAddress) = 0; |
a3269a0a LOK |
257 | |
258 | /*! | |
d9106f08 LOK |
259 | * @brief Get the menu language of the device with the given logical address |
260 | * @param iLogicalAddress The device to get the menu language for. | |
261 | * @param language The requested menu language. | |
262 | * @return True when fetched succesfully, false otherwise. | |
a3269a0a | 263 | */ |
8d901fdb | 264 | virtual bool GetDeviceMenuLanguage(cec_logical_address iLogicalAddress, cec_menu_language *language) = 0; |
44c74256 LOK |
265 | |
266 | /*! | |
d9106f08 LOK |
267 | * @brief Get the vendor ID of the device with the given logical address. |
268 | * @param iLogicalAddress The device to get the vendor id for. | |
269 | * @return The vendor ID or 0 if it wasn't found. | |
44c74256 | 270 | */ |
8d901fdb | 271 | virtual uint64_t GetDeviceVendorId(cec_logical_address iLogicalAddress) = 0; |
e55f3f70 LOK |
272 | |
273 | /*! | |
d9106f08 LOK |
274 | * @brief Get the power status of the device with the given logical address. |
275 | * @param iLogicalAddress The device to get the power status for. | |
276 | * @return The power status or CEC_POWER_STATUS_UNKNOWN if it wasn't found. | |
e55f3f70 | 277 | */ |
8d901fdb | 278 | virtual cec_power_status GetDevicePowerStatus(cec_logical_address iLogicalAddress) = 0; |
57f45e6c | 279 | |
b0cb809d LOK |
280 | // XXX XBMC Eden for Windows has been built against 1.2.0 and Ubuntu against 1.5.2 |
281 | // we accidently broke the abi between these versions, and this will ensure the upgrade will still work | |
282 | #if !defined(_WIN32) && !defined(_WIN64) | |
283 | /*! | |
284 | * @brief Get the physical address of the device with the given logical address. | |
285 | * @param iLogicalAddress The device to get the vendor id for. | |
286 | * @return The physical address or 0 if it wasn't found. | |
287 | */ | |
288 | virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iLogicalAddress) = 0; | |
289 | #endif | |
290 | ||
57f45e6c | 291 | /*! |
d9106f08 | 292 | * @brief Sends a POLL message to a device. |
8d901fdb | 293 | * @param iLogicalAddress The device to send the message to. |
d9106f08 | 294 | * @return True if the POLL was acked, false otherwise. |
57f45e6c | 295 | */ |
8d901fdb | 296 | virtual bool PollDevice(cec_logical_address iLogicalAddress) = 0; |
6d858ba4 LOK |
297 | |
298 | /*! | |
299 | * @return The devices that are active on the bus and not handled by libcec. | |
300 | */ | |
301 | virtual cec_logical_addresses GetActiveDevices(void) = 0; | |
302 | ||
303 | /*! | |
304 | * @brief Check whether a device is active on the bus. | |
8d901fdb | 305 | * @param iLogicalAddress The address to check. |
6d858ba4 LOK |
306 | * @return True when active, false otherwise. |
307 | */ | |
8d901fdb | 308 | virtual bool IsActiveDevice(cec_logical_address iLogicalAddress) = 0; |
6d858ba4 LOK |
309 | |
310 | /*! | |
311 | * @brief Check whether a device of the given type is active on the bus. | |
312 | * @param type The type to check. | |
313 | * @return True when active, false otherwise. | |
314 | */ | |
315 | virtual bool IsActiveDeviceType(cec_device_type type) = 0; | |
16b1e052 | 316 | |
04e637f9 LOK |
317 | /*! |
318 | * @brief Sends a volume up keypress to an audiosystem if it's present. | |
5c73f7f7 | 319 | * @param bSendRelease Send a key release after the keypress. |
04e637f9 LOK |
320 | * @return The new audio status. |
321 | */ | |
5c73f7f7 | 322 | virtual uint8_t VolumeUp(bool bSendRelease = true) = 0; |
04e637f9 LOK |
323 | |
324 | /*! | |
325 | * @brief Sends a volume down keypress to an audiosystem if it's present. | |
5c73f7f7 | 326 | * @param bSendRelease Send a key release after the keypress. |
04e637f9 LOK |
327 | * @return The new audio status. |
328 | */ | |
5c73f7f7 | 329 | virtual uint8_t VolumeDown(bool bSendRelease = true) = 0; |
04e637f9 LOK |
330 | |
331 | /*! | |
332 | * @brief Sends a mute keypress to an audiosystem if it's present. | |
5c73f7f7 | 333 | * @param bSendRelease Send a key release after the keypress. |
04e637f9 LOK |
334 | * @return The new audio status. |
335 | */ | |
5c73f7f7 | 336 | virtual uint8_t MuteAudio(bool bSendRelease = true) = 0; |
a33794d8 LOK |
337 | |
338 | /*! | |
339 | * @brief Send a keypress to a device on the CEC bus. | |
340 | * @param iDestination The address to send the message to. | |
341 | * @param key The key to send. | |
342 | * @param bWait True to wait for a response, false otherwise. | |
343 | * @return True when the keypress was acked, false otherwise. | |
344 | */ | |
345 | virtual bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = false) = 0; | |
346 | ||
347 | /*! | |
348 | * @brief Send a key release to a device on the CEC bus. | |
349 | * @param iDestination The address to send the message to. | |
350 | * @param bWait True to wait for a response, false otherwise. | |
351 | * @return True when the keypress was acked, false otherwise. | |
352 | */ | |
353 | virtual bool SendKeyRelease(cec_logical_address iDestination, bool bWait = false) = 0; | |
ed21be2a LOK |
354 | |
355 | /*! | |
356 | * @brief Get the OSD name of a device on the CEC bus. | |
8d901fdb | 357 | * @param iLogicalAddress The device to get the OSD name for. |
ed21be2a LOK |
358 | * @return The OSD name. |
359 | */ | |
8d901fdb | 360 | virtual cec_osd_name GetDeviceOSDName(cec_logical_address iLogicalAddress) = 0; |
03ae897d | 361 | |
b4b1b49b LOK |
362 | /*! |
363 | * @brief Get the logical address of the device that is currently the active source on the CEC bus. | |
364 | * @return The active source or CECDEVICE_UNKNOWN when unknown. | |
365 | */ | |
366 | virtual cec_logical_address GetActiveSource(void) = 0; | |
367 | ||
368 | /*! | |
369 | * @brief Check whether a device is currently the active source on the CEC bus. | |
8d901fdb | 370 | * @param iLogicalAddress The address to check. |
b4b1b49b LOK |
371 | * @return True when it is the active source, false otherwise. |
372 | */ | |
8d901fdb | 373 | virtual bool IsActiveSource(cec_logical_address iLogicalAddress) = 0; |
b4b1b49b | 374 | |
f42d3e0f LOK |
375 | /*! |
376 | * @brief Sets the stream path to the device on the given logical address. | |
8d901fdb | 377 | * @param iLogicalAddress The address to activate. |
f42d3e0f LOK |
378 | * @return True when the command was sent, false otherwise. |
379 | */ | |
8d901fdb | 380 | virtual bool SetStreamPath(cec_logical_address iLogicalAddress) = 0; |
f42d3e0f LOK |
381 | |
382 | /*! | |
383 | * @brief Sets the stream path to the device on the given logical address. | |
384 | * @param iPhysicalAddress The address to activate. | |
385 | * @return True when the command was sent, false otherwise. | |
386 | */ | |
387 | virtual bool SetStreamPath(uint16_t iPhysicalAddress) = 0; | |
388 | ||
80b72250 LOK |
389 | /*! |
390 | * @return The list of addresses that libCEC is controlling | |
391 | */ | |
392 | virtual cec_logical_addresses GetLogicalAddresses(void) = 0; | |
393 | ||
dc2c98f6 LOK |
394 | virtual const char *ToString(const cec_menu_state state) = 0; |
395 | virtual const char *ToString(const cec_version version) = 0; | |
396 | virtual const char *ToString(const cec_power_status status) = 0; | |
397 | virtual const char *ToString(const cec_logical_address address) = 0; | |
398 | virtual const char *ToString(const cec_deck_control_mode mode) = 0; | |
399 | virtual const char *ToString(const cec_deck_info status) = 0; | |
400 | virtual const char *ToString(const cec_opcode opcode) = 0; | |
401 | virtual const char *ToString(const cec_system_audio_status mode) = 0; | |
402 | virtual const char *ToString(const cec_audio_status status) = 0; | |
403 | virtual const char *ToString(const cec_vendor_id vendor) = 0; | |
404 | virtual const char *ToString(const cec_client_version version) = 0; | |
405 | virtual const char *ToString(const cec_server_version version) = 0; | |
406 | ||
d40928b5 LOK |
407 | /*! |
408 | * @brief Get libCEC's current configuration. | |
409 | * @param configuration The configuration. | |
410 | * @return True when the configuration was updated, false otherwise. | |
411 | */ | |
412 | virtual bool GetCurrentConfiguration(libcec_configuration *configuration) = 0; | |
413 | ||
30b4aac0 LOK |
414 | /*! |
415 | * @brief Change libCEC's configuration. | |
416 | * @param configuration The new configuration. | |
417 | * @return True when the configuration was changed successfully, false otherwise. | |
418 | */ | |
419 | virtual bool SetConfiguration(const libcec_configuration *configuration) = 0; | |
420 | ||
224ea877 LOK |
421 | /*! |
422 | * @return True when this device can persist the user configuration, false otherwise. | |
423 | */ | |
424 | virtual bool CanPersistConfiguration(void) = 0; | |
425 | ||
426 | /*! | |
427 | * @brief Persist the given configuration in adapter (if supported) | |
428 | * @brief The configuration to store. | |
429 | * @return True when the configuration was persisted, false otherwise. | |
430 | */ | |
431 | virtual bool PersistConfiguration(libcec_configuration *configuration) = 0; | |
432 | ||
3efda01a | 433 | /*! |
dc2c98f6 | 434 | * @brief Tell libCEC to poll for active devices on the bus. |
3efda01a | 435 | */ |
dc2c98f6 | 436 | virtual void RescanActiveDevices(void) = 0; |
c9549d35 LOK |
437 | |
438 | /*! | |
439 | * @return true when libCEC is the active source on the bus, false otherwise. | |
440 | */ | |
441 | virtual bool IsLibCECActiveSource(void) = 0; | |
f80cd208 LOK |
442 | |
443 | /*! | |
444 | * @brief Get information about the given device | |
445 | * @param strPort The port to which the device is connected | |
446 | * @param config The device configuration | |
447 | * @param iTimeoutMs The timeout in milliseconds | |
448 | * @return True when the device was found, false otherwise | |
449 | */ | |
450 | virtual bool GetDeviceInformation(const char *strPort, libcec_configuration *config, uint32_t iTimeoutMs = 10000) = 0; | |
38f1fbcc | 451 | |
b0cb809d LOK |
452 | // XXX XBMC Eden for Windows has been built against 1.2.0 and Ubuntu against 1.5.2 |
453 | // we accidently broke the abi between these versions, and this will ensure the upgrade will still work | |
454 | #if defined(_WIN32) || defined(_WIN64) | |
38f1fbcc LOK |
455 | /*! |
456 | * @brief Set and enable the callback methods. If this method is not called, the GetNext...() methods will have to be used. | |
457 | * @param cbParam Parameter to pass to callback methods. | |
458 | * @param callbacks The callbacks to set. | |
459 | * @return True when enabled, false otherwise. | |
460 | */ | |
461 | virtual bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks) = 0; | |
462 | ||
463 | /*! | |
464 | * @deprecated Use libcec_configuration instead. | |
465 | * @brief Enable physical address detection (if the connected adapter supports this). | |
466 | * @return True when physical address detection was enabled, false otherwise. | |
467 | */ | |
468 | virtual bool EnablePhysicalAddressDetection(void) = 0; | |
469 | ||
470 | /*! | |
471 | * @brief Changes the active HDMI port. | |
472 | * @param iBaseDevice The device to which this libcec is connected. | |
473 | * @param iPort The new port number. | |
474 | * @return True when changed, false otherwise. | |
475 | */ | |
476 | virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort) = 0; | |
477 | ||
478 | /*! | |
479 | * @brief Get the physical address of the device with the given logical address. | |
480 | * @param iLogicalAddress The device to get the vendor id for. | |
481 | * @return The physical address or 0 if it wasn't found. | |
482 | */ | |
483 | virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iLogicalAddress) = 0; | |
b0cb809d | 484 | #endif |
2b44051c LOK |
485 | |
486 | /*! | |
487 | * @return A string with information about how libCEC was compiled. | |
488 | */ | |
489 | virtual const char *GetLibInfo(void) = 0; | |
490 | ||
491 | virtual const char *ToString(const cec_user_control_code key) = 0; | |
492 | ||
493 | /*! | |
494 | * @brief Calling this method will initialise the host on which libCEC is running. | |
495 | * Calling this method will initialise the host on which libCEC is running. On the RPi, it calls | |
496 | * bcm_host_init(), which may only be called once per process, and is called by any process using | |
497 | * the video api on that system. So only call this method if libCEC is used in an application that | |
498 | * does not already initialise the video api. | |
499 | * | |
500 | * Should be called as first call to libCEC, directly after CECInitialise() and before using Open() | |
501 | */ | |
502 | virtual void InitVideoStandalone(void) = 0; | |
2d418322 LOK |
503 | |
504 | virtual const char *ToString(const cec_adapter_type type) = 0; | |
abbca718 LOK |
505 | }; |
506 | }; | |
507 | ||
d9106f08 LOK |
508 | /*! |
509 | * @brief Load the CEC adapter library. | |
510 | * @param strDeviceName How to present this device to other devices. | |
511 | * @param deviceTypes The device types to use on the CEC bus. | |
512 | * @return An instance of ICECAdapter or NULL on error. | |
513 | */ | |
38f1fbcc LOK |
514 | extern "C" DECLSPEC void * CECInit(const char *strDeviceName, CEC::cec_device_type_list deviceTypes); |
515 | ||
516 | /*! | |
517 | * @deprecated | |
518 | */ | |
519 | extern "C" DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS); | |
520 | ||
521 | /*! | |
522 | * @brief Unload the CEC adapter library. | |
523 | */ | |
524 | extern "C" DECLSPEC void CECDestroy(CEC::ICECAdapter *instance); | |
caca2d81 LOK |
525 | |
526 | /*! | |
527 | * @brief Load the CEC adapter library. | |
528 | * @param configuration The configuration to pass to libCEC | |
529 | * @return An instance of ICECAdapter or NULL on error. | |
530 | */ | |
3efda01a | 531 | extern "C" DECLSPEC void * CECInitialise(CEC::libcec_configuration *configuration); |
d9106f08 | 532 | |
a2198e5e LOK |
533 | /*! |
534 | * @brief Try to connect to the adapter and send the "start bootloader" command, without initialising libCEC and going through all checks | |
535 | * @return True when the command was send, false otherwise. | |
536 | */ | |
537 | extern "C" DECLSPEC bool CECStartBootloader(void); | |
538 | ||
acec5f48 | 539 | #endif /* CECEXPORTS_H_ */ |