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