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