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