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