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