3 * This file is part of the libCEC(R) library.
5 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
6 * libCEC(R) is an original work, containing original code.
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
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.
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.
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.
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
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/
44 virtual ~ICECAdapter() {};
45 /*! @name Adapter methods */
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.
54 virtual bool Open(const char *strPort
, uint32_t iTimeoutMs
= 10000) = 0;
57 * @brief Close the connection to the CEC adapter.
59 virtual void Close(void) = 0;
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.
66 virtual bool EnableCallbacks(ICECCallbacks
*callbacks
) = 0;
69 * @brief Try to find all connected CEC adapters. Only implemented on Linux and Windows at the moment.
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.
75 virtual int8_t FindAdapters(cec_adapter
*deviceList
, uint8_t iBufSize
, const char *strDevicePath
= NULL
) = 0;
78 * @brief Ping the CEC adapter.
79 * @return True when the ping was succesful, false otherwise.
81 virtual bool PingAdapter(void) = 0;
84 * @brief Start the bootloader of the CEC adapter.
85 * @return True when the command was sent succesfully, false otherwise.
87 virtual bool StartBootloader(void) = 0;
91 * @return Get the minimal version of libcec that this version of libcec can interface with.
93 virtual int8_t GetMinLibVersion(void) const = 0;
96 * @return Get the major version of libcec.
98 virtual int8_t GetLibVersionMajor(void) const = 0;
101 * @return Get the minor version of libcec.
103 virtual int8_t GetLibVersionMinor(void) const = 0;
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.
110 virtual bool GetNextLogMessage(cec_log_message
*message
) = 0;
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.
117 virtual bool GetNextKeypress(cec_keypress
*key
) = 0;
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.
124 virtual bool GetNextCommand(cec_command
*command
) = 0;
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.
131 virtual bool Transmit(const cec_command
&data
) = 0;
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.
138 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress
= CECDEVICE_PLAYBACKDEVICE1
) = 0;
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.
145 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress
= CEC_DEFAULT_PHYSICAL_ADDRESS
) = 0;
148 * @brief Enable physical address detection (if the connected adapter supports this).
149 * @return True when physical address detection was enabled, false otherwise.
151 virtual bool EnablePhysicalAddressDetection(void) = 0;
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.
159 virtual bool SetHDMIPort(cec_logical_address iBaseDevice
, uint8_t iPort
) = 0;
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.
166 virtual bool PowerOnDevices(cec_logical_address address
= CECDEVICE_TV
) = 0;
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.
173 virtual bool StandbyDevices(cec_logical_address address
= CECDEVICE_BROADCAST
) = 0;
176 * @brief Change the active source.
177 * @param type The new active source. Leave empty to use the primary type
178 * @return True when the command was sent succesfully, false otherwise.
180 virtual bool SetActiveSource(cec_device_type type
= CEC_DEVICE_TYPE_RESERVED
) = 0;
183 * @deprecated Use SetActiveSource() instead
185 virtual bool SetActiveView(void) = 0;
188 * @brief Change the deck control mode, if this adapter is registered as playback device.
189 * @param mode The new control mode.
190 * @param bSendUpdate True to send the status over the CEC line.
191 * @return True if set, false otherwise.
193 virtual bool SetDeckControlMode(cec_deck_control_mode mode
, bool bSendUpdate
= true) = 0;
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.
200 virtual bool SetDeckInfo(cec_deck_info info
, bool bSendUpdate
= true) = 0;
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.
206 virtual bool SetInactiveView(void) = 0;
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.
214 virtual bool SetMenuState(cec_menu_state state
, bool bSendUpdate
= true) = 0;
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.
223 virtual bool SetOSDString(cec_logical_address iLogicalAddress
, cec_display_control duration
, const char *strMessage
) = 0;
226 * @brief Enable or disable monitoring mode.
227 * @param bEnable True to enable, false to disable.
228 * @return True when switched successfully, false otherwise.
230 virtual bool SwitchMonitoring(bool bEnable
) = 0;
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.
237 virtual cec_version
GetDeviceCecVersion(cec_logical_address iAddress
) = 0;
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.
245 virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress
, cec_menu_language
*language
) = 0;
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.
252 virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress
) = 0;
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.
259 virtual cec_power_status
GetDevicePowerStatus(cec_logical_address iAddress
) = 0;
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.
266 virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress
) = 0;
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.
273 virtual bool PollDevice(cec_logical_address iAddress
) = 0;
276 * @return The devices that are active on the bus and not handled by libcec.
278 virtual cec_logical_addresses
GetActiveDevices(void) = 0;
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.
285 virtual bool IsActiveDevice(cec_logical_address iAddress
) = 0;
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.
292 virtual bool IsActiveDeviceType(cec_device_type type
) = 0;
295 * @brief Sends a volume up keypress to an audiosystem if it's present.
296 * @param bSendRelease Send a key release after the keypress.
297 * @return The new audio status.
299 virtual uint8_t VolumeUp(bool bSendRelease
= true) = 0;
302 * @brief Sends a volume down keypress to an audiosystem if it's present.
303 * @param bSendRelease Send a key release after the keypress.
304 * @return The new audio status.
306 virtual uint8_t VolumeDown(bool bSendRelease
= true) = 0;
309 * @brief Sends a mute keypress to an audiosystem if it's present.
310 * @param bSendRelease Send a key release after the keypress.
311 * @return The new audio status.
313 virtual uint8_t MuteAudio(bool bSendRelease
= true) = 0;
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.
322 virtual bool SendKeypress(cec_logical_address iDestination
, cec_user_control_code key
, bool bWait
= false) = 0;
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.
330 virtual bool SendKeyRelease(cec_logical_address iDestination
, bool bWait
= false) = 0;
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.
337 virtual cec_osd_name
GetDeviceOSDName(cec_logical_address iAddress
) = 0;
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.
343 virtual cec_logical_address
GetActiveSource(void) = 0;
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.
350 virtual bool IsActiveSource(cec_logical_address iAddress
) = 0;
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;
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.
371 extern "C" DECLSPEC
void * CECInit(const char *strDeviceName
, CEC::cec_device_type_list devicesTypes
);
374 * @deprecated Please use CECInit() instead
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.
381 extern "C" DECLSPEC
void * CECCreate(const char *strDeviceName
, CEC::cec_logical_address iLogicalAddress
= CEC::CECDEVICE_PLAYBACKDEVICE1
, uint16_t iPhysicalAddress
= CEC_DEFAULT_PHYSICAL_ADDRESS
);
384 * @brief Unload the CEC adapter library.
386 extern "C" DECLSPEC
void CECDestroy(CEC::ICECAdapter
*instance
);
388 #endif /* CECEXPORTS_H_ */