Commit | Line | Data |
---|---|---|
abbca718 LOK |
1 | #pragma once |
2 | /* | |
3 | * This file is part of the libCEC(R) library. | |
4 | * | |
5 | * libCEC(R) is Copyright (C) 2011 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 | ||
acec5f48 LOK |
34 | #ifndef CECEXPORTS_H_ |
35 | #define CECEXPORTS_H_ | |
36 | ||
761dcc45 | 37 | #include <cectypes.h> |
acec5f48 | 38 | |
abbca718 LOK |
39 | namespace CEC |
40 | { | |
2abe74eb | 41 | class ICECAdapter |
abbca718 LOK |
42 | { |
43 | public: | |
6eb6d0fd | 44 | virtual ~ICECAdapter() {}; |
2abe74eb LOK |
45 | /*! @name Adapter methods */ |
46 | //@{ | |
d9106f08 | 47 | |
abbca718 | 48 | /*! |
d9106f08 LOK |
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. | |
abbca718 | 53 | */ |
25701fa6 | 54 | virtual bool Open(const char *strPort, uint32_t iTimeoutMs = 10000) = 0; |
abbca718 | 55 | |
f99bc831 | 56 | /*! |
d9106f08 | 57 | * @brief Close the connection to the CEC adapter. |
f99bc831 | 58 | */ |
5f39c4d8 | 59 | virtual void Close(void) = 0; |
f99bc831 | 60 | |
abbca718 | 61 | /*! |
fa4798bd LOK |
62 | * @brief Set and enable the callback methods. If this method is not called, the GetNext...() methods will have to be used. |
63 | * @param callbacks The callbacks to set. | |
64 | * @return True when enabled, false otherwise. | |
65 | */ | |
66 | virtual bool EnableCallbacks(ICECCallbacks *callbacks) = 0; | |
67 | ||
68 | /*! | |
69 | * @brief Try to find all connected CEC adapters. Only implemented on Linux and Windows at the moment. | |
d9106f08 LOK |
70 | * @param deviceList The vector to store device descriptors in. |
71 | * @param iBufSize The size of the deviceList buffer. | |
72 | * @param strDevicePath Optional device path. Only adds device descriptors that match the given device path. | |
73 | * @return The number of devices that were found, or -1 when an error occured. | |
abbca718 | 74 | */ |
25701fa6 | 75 | virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL) = 0; |
abbca718 LOK |
76 | |
77 | /*! | |
d9106f08 LOK |
78 | * @brief Ping the CEC adapter. |
79 | * @return True when the ping was succesful, false otherwise. | |
abbca718 | 80 | */ |
2abe74eb | 81 | virtual bool PingAdapter(void) = 0; |
abbca718 LOK |
82 | |
83 | /*! | |
d9106f08 LOK |
84 | * @brief Start the bootloader of the CEC adapter. |
85 | * @return True when the command was sent succesfully, false otherwise. | |
abbca718 LOK |
86 | */ |
87 | virtual bool StartBootloader(void) = 0; | |
2abe74eb | 88 | //@} |
abbca718 LOK |
89 | |
90 | /*! | |
d9106f08 | 91 | * @return Get the minimal version of libcec that this version of libcec can interface with. |
abbca718 | 92 | */ |
99e89a5b | 93 | virtual int8_t GetMinLibVersion(void) const = 0; |
abbca718 LOK |
94 | |
95 | /*! | |
d9106f08 | 96 | * @return Get the major version of libcec. |
abbca718 | 97 | */ |
99e89a5b | 98 | virtual int8_t GetLibVersionMajor(void) const = 0; |
abbca718 | 99 | |
eafd9bed | 100 | /*! |
d9106f08 | 101 | * @return Get the minor version of libcec. |
eafd9bed | 102 | */ |
99e89a5b | 103 | virtual int8_t GetLibVersionMinor(void) const = 0; |
eafd9bed | 104 | |
abbca718 | 105 | /*! |
d9106f08 LOK |
106 | * @brief Get the next log message in the queue, if there is one. |
107 | * @param message The next message. | |
108 | * @return True if a message was passed, false otherwise. | |
abbca718 LOK |
109 | */ |
110 | virtual bool GetNextLogMessage(cec_log_message *message) = 0; | |
111 | ||
112 | /*! | |
d9106f08 LOK |
113 | * @brief Get the next keypress in the queue, if there is one. |
114 | * @param key The next keypress. | |
115 | * @return True if a key was passed, false otherwise. | |
abbca718 LOK |
116 | */ |
117 | virtual bool GetNextKeypress(cec_keypress *key) = 0; | |
118 | ||
825ddb96 | 119 | /*! |
d9106f08 LOK |
120 | * @brief Get the next CEC command that was received by the adapter. |
121 | * @param action The next command. | |
122 | * @return True when a command was passed, false otherwise. | |
825ddb96 LOK |
123 | */ |
124 | virtual bool GetNextCommand(cec_command *command) = 0; | |
125 | ||
abbca718 | 126 | /*! |
d9106f08 LOK |
127 | * @brief Transmit a command over the CEC line. |
128 | * @param data The command to send. | |
129 | * @return True when the data was sent and acked, false otherwise. | |
abbca718 | 130 | */ |
8d84e2c0 | 131 | virtual bool Transmit(const cec_command &data) = 0; |
abbca718 LOK |
132 | |
133 | /*! | |
d9106f08 LOK |
134 | * @brief Change the logical address of the CEC adapter. |
135 | * @param iLogicalAddress The CEC adapter's new logical address. | |
136 | * @return True when the logical address was set successfully, false otherwise. | |
abbca718 | 137 | */ |
2492216a LOK |
138 | virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1) = 0; |
139 | ||
140 | /*! | |
d9106f08 LOK |
141 | * @brief Change the physical address (HDMI port) of the CEC adapter. |
142 | * @param iPhysicalAddress The CEC adapter's new physical address. | |
143 | * @brief True when the physical address was set successfully, false otherwise. | |
2492216a LOK |
144 | */ |
145 | virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0; | |
6dfe9213 | 146 | |
2dbd78f8 LOK |
147 | /*! |
148 | * @brief Enable physical address detection (if the connected adapter supports this). | |
149 | * @return True when physical address detection was enabled, false otherwise. | |
150 | */ | |
151 | virtual bool EnablePhysicalAddressDetection(void) = 0; | |
152 | ||
153 | /*! | |
154 | * @brief Changes the active HDMI port. | |
155 | * @param iBaseDevice The device to which this libcec is connected. | |
156 | * @param iPort The new port number. | |
157 | * @return True when changed, false otherwise. | |
158 | */ | |
159 | virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort) = 0; | |
160 | ||
6dfe9213 | 161 | /*! |
d9106f08 LOK |
162 | * @brief Power on the connected CEC capable devices. |
163 | * @param address The logical address to power on. | |
164 | * @return True when the command was sent succesfully, false otherwise. | |
6dfe9213 | 165 | */ |
2abe74eb | 166 | virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0; |
abbca718 | 167 | |
df7339c6 | 168 | /*! |
d9106f08 LOK |
169 | * @brief Put connected CEC capable devices in standby mode. |
170 | * @brief address The logical address of the device to put in standby. | |
171 | * @return True when the command was sent succesfully, false otherwise. | |
df7339c6 | 172 | */ |
2abe74eb | 173 | virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0; |
df7339c6 LOK |
174 | |
175 | /*! | |
18203d17 LOK |
176 | * @brief Change the active source. |
177 | * @param type The new active source. Leave empty to use the primary type | |
d9106f08 | 178 | * @return True when the command was sent succesfully, false otherwise. |
df7339c6 | 179 | */ |
18203d17 LOK |
180 | virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED) = 0; |
181 | ||
182 | /*! | |
183 | * @deprecated Use SetActiveSource() instead | |
184 | */ | |
2abe74eb LOK |
185 | virtual bool SetActiveView(void) = 0; |
186 | ||
a9232a79 LOK |
187 | /*! |
188 | * @brief Change the deck control mode, if this adapter is registered as playback device. | |
189 | * @param mode The new control mode. | |
28fa6c97 | 190 | * @param bSendUpdate True to send the status over the CEC line. |
a9232a79 LOK |
191 | * @return True if set, false otherwise. |
192 | */ | |
28fa6c97 | 193 | virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true) = 0; |
a9232a79 LOK |
194 | |
195 | /*! | |
196 | * @brief Change the deck info, if this adapter is a playback device. | |
197 | * @param info The new deck info. | |
198 | * @return True if set, false otherwise. | |
199 | */ | |
28fa6c97 | 200 | virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true) = 0; |
a9232a79 | 201 | |
2abe74eb | 202 | /*! |
d9106f08 LOK |
203 | * @brief Broadcast a message that notifies connected CEC capable devices that this device is no longer the active source. |
204 | * @return True when the command was sent succesfully, false otherwise. | |
2abe74eb LOK |
205 | */ |
206 | virtual bool SetInactiveView(void) = 0; | |
1969b140 | 207 | |
28fa6c97 LOK |
208 | /*! |
209 | * @brief Change the menu state. | |
210 | * @param state The new true. | |
211 | * @param bSendUpdate True to send the status over the CEC line. | |
212 | * @return True if set, false otherwise. | |
213 | */ | |
214 | virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true) = 0; | |
215 | ||
1969b140 | 216 | /*! |
d9106f08 LOK |
217 | * @brief Display a message on the device with the given logical address. |
218 | * @param iLogicalAddres The device to display the message on. | |
219 | * @param duration The duration of the message | |
220 | * @param strMessage The message to display. | |
221 | * @return True when the command was sent, false otherwise. | |
1969b140 LOK |
222 | */ |
223 | virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0; | |
8b7e5ff6 LOK |
224 | |
225 | /*! | |
d9106f08 LOK |
226 | * @brief Enable or disable monitoring mode. |
227 | * @param bEnable True to enable, false to disable. | |
228 | * @return True when switched successfully, false otherwise. | |
8b7e5ff6 LOK |
229 | */ |
230 | virtual bool SwitchMonitoring(bool bEnable) = 0; | |
6a1c0009 LOK |
231 | |
232 | /*! | |
d9106f08 LOK |
233 | * @brief Get the CEC version of the device with the given logical address |
234 | * @param iLogicalAddress The device to get the CEC version for. | |
235 | * @return The version or CEC_VERSION_UNKNOWN when the version couldn't be fetched. | |
6a1c0009 LOK |
236 | */ |
237 | virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress) = 0; | |
a3269a0a LOK |
238 | |
239 | /*! | |
d9106f08 LOK |
240 | * @brief Get the menu language of the device with the given logical address |
241 | * @param iLogicalAddress The device to get the menu language for. | |
242 | * @param language The requested menu language. | |
243 | * @return True when fetched succesfully, false otherwise. | |
a3269a0a LOK |
244 | */ |
245 | virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language) = 0; | |
44c74256 LOK |
246 | |
247 | /*! | |
d9106f08 LOK |
248 | * @brief Get the vendor ID of the device with the given logical address. |
249 | * @param iLogicalAddress The device to get the vendor id for. | |
250 | * @return The vendor ID or 0 if it wasn't found. | |
44c74256 LOK |
251 | */ |
252 | virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress) = 0; | |
e55f3f70 LOK |
253 | |
254 | /*! | |
d9106f08 LOK |
255 | * @brief Get the power status of the device with the given logical address. |
256 | * @param iLogicalAddress The device to get the power status for. | |
257 | * @return The power status or CEC_POWER_STATUS_UNKNOWN if it wasn't found. | |
e55f3f70 LOK |
258 | */ |
259 | virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress) = 0; | |
57f45e6c | 260 | |
eab72c40 LOK |
261 | /*! |
262 | * @brief Get the physical address of the device with the given logical address. | |
263 | * @param iLogicalAddress The device to get the vendor id for. | |
264 | * @return The physical address or 0 if it wasn't found. | |
265 | */ | |
266 | virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress) = 0; | |
267 | ||
57f45e6c | 268 | /*! |
d9106f08 LOK |
269 | * @brief Sends a POLL message to a device. |
270 | * @param iAddress The device to send the message to. | |
271 | * @return True if the POLL was acked, false otherwise. | |
57f45e6c LOK |
272 | */ |
273 | virtual bool PollDevice(cec_logical_address iAddress) = 0; | |
6d858ba4 LOK |
274 | |
275 | /*! | |
276 | * @return The devices that are active on the bus and not handled by libcec. | |
277 | */ | |
278 | virtual cec_logical_addresses GetActiveDevices(void) = 0; | |
279 | ||
280 | /*! | |
281 | * @brief Check whether a device is active on the bus. | |
282 | * @param iAddress The address to check. | |
283 | * @return True when active, false otherwise. | |
284 | */ | |
285 | virtual bool IsActiveDevice(cec_logical_address iAddress) = 0; | |
286 | ||
287 | /*! | |
288 | * @brief Check whether a device of the given type is active on the bus. | |
289 | * @param type The type to check. | |
290 | * @return True when active, false otherwise. | |
291 | */ | |
292 | virtual bool IsActiveDeviceType(cec_device_type type) = 0; | |
16b1e052 | 293 | |
04e637f9 LOK |
294 | /*! |
295 | * @brief Sends a volume up keypress to an audiosystem if it's present. | |
5c73f7f7 | 296 | * @param bSendRelease Send a key release after the keypress. |
04e637f9 LOK |
297 | * @return The new audio status. |
298 | */ | |
5c73f7f7 | 299 | virtual uint8_t VolumeUp(bool bSendRelease = true) = 0; |
04e637f9 LOK |
300 | |
301 | /*! | |
302 | * @brief Sends a volume down keypress to an audiosystem if it's present. | |
5c73f7f7 | 303 | * @param bSendRelease Send a key release after the keypress. |
04e637f9 LOK |
304 | * @return The new audio status. |
305 | */ | |
5c73f7f7 | 306 | virtual uint8_t VolumeDown(bool bSendRelease = true) = 0; |
04e637f9 LOK |
307 | |
308 | /*! | |
309 | * @brief Sends a mute keypress to an audiosystem if it's present. | |
5c73f7f7 | 310 | * @param bSendRelease Send a key release after the keypress. |
04e637f9 LOK |
311 | * @return The new audio status. |
312 | */ | |
5c73f7f7 | 313 | virtual uint8_t MuteAudio(bool bSendRelease = true) = 0; |
a33794d8 LOK |
314 | |
315 | /*! | |
316 | * @brief Send a keypress to a device on the CEC bus. | |
317 | * @param iDestination The address to send the message to. | |
318 | * @param key The key to send. | |
319 | * @param bWait True to wait for a response, false otherwise. | |
320 | * @return True when the keypress was acked, false otherwise. | |
321 | */ | |
322 | virtual bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = false) = 0; | |
323 | ||
324 | /*! | |
325 | * @brief Send a key release to a device on the CEC bus. | |
326 | * @param iDestination The address to send the message to. | |
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 SendKeyRelease(cec_logical_address iDestination, bool bWait = false) = 0; | |
ed21be2a LOK |
331 | |
332 | /*! | |
333 | * @brief Get the OSD name of a device on the CEC bus. | |
334 | * @param iAddress The device to get the OSD name for. | |
335 | * @return The OSD name. | |
336 | */ | |
f71a1df9 | 337 | virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress) = 0; |
03ae897d | 338 | |
b4b1b49b LOK |
339 | /*! |
340 | * @brief Get the logical address of the device that is currently the active source on the CEC bus. | |
341 | * @return The active source or CECDEVICE_UNKNOWN when unknown. | |
342 | */ | |
343 | virtual cec_logical_address GetActiveSource(void) = 0; | |
344 | ||
345 | /*! | |
346 | * @brief Check whether a device is currently the active source on the CEC bus. | |
347 | * @param iAddress The address to check. | |
348 | * @return True when it is the active source, false otherwise. | |
349 | */ | |
350 | virtual bool IsActiveSource(cec_logical_address iAddress) = 0; | |
351 | ||
03ae897d LOK |
352 | virtual const char *ToString(const cec_menu_state state) = 0; |
353 | virtual const char *ToString(const cec_version version) = 0; | |
354 | virtual const char *ToString(const cec_power_status status) = 0; | |
355 | virtual const char *ToString(const cec_logical_address address) = 0; | |
356 | virtual const char *ToString(const cec_deck_control_mode mode) = 0; | |
357 | virtual const char *ToString(const cec_deck_info status) = 0; | |
358 | virtual const char *ToString(const cec_opcode opcode) = 0; | |
359 | virtual const char *ToString(const cec_system_audio_status mode) = 0; | |
360 | virtual const char *ToString(const cec_audio_status status) = 0; | |
361 | virtual const char *ToString(const cec_vendor_id vendor) = 0; | |
abbca718 LOK |
362 | }; |
363 | }; | |
364 | ||
d9106f08 LOK |
365 | /*! |
366 | * @brief Load the CEC adapter library. | |
367 | * @param strDeviceName How to present this device to other devices. | |
368 | * @param deviceTypes The device types to use on the CEC bus. | |
369 | * @return An instance of ICECAdapter or NULL on error. | |
370 | */ | |
f8513317 | 371 | extern "C" DECLSPEC void * CECInit(const char *strDeviceName, CEC::cec_device_type_list devicesTypes); |
d9106f08 LOK |
372 | |
373 | /*! | |
53024cc1 | 374 | * @deprecated Please use CECInit() instead |
d9106f08 LOK |
375 | * @brief Load the CEC adapter library. |
376 | * @param strDeviceName How to present this device to other devices. | |
377 | * @param iLogicalAddress The logical of this device. PLAYBACKDEVICE1 by default. | |
378 | * @param iPhysicalAddress The physical address of this device. 0x1000 by default. | |
379 | * @return An instance of ICECAdapter or NULL on error. | |
380 | */ | |
acec5f48 | 381 | extern "C" DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS); |
d9106f08 LOK |
382 | |
383 | /*! | |
384 | * @brief Unload the CEC adapter library. | |
385 | */ | |
acec5f48 | 386 | extern "C" DECLSPEC void CECDestroy(CEC::ICECAdapter *instance); |
abbca718 | 387 | |
acec5f48 | 388 | #endif /* CECEXPORTS_H_ */ |