X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=include%2Fcec.h;h=97e75a46f8e778b7d05471c9ea1e3f58afa81c97;hb=66e5bd7231e47eaef8a6472856443b4acffb48bd;hp=7ac25fdfaf9b68b47839235e4fcf225651b21c80;hpb=04e637f9e37a0bcbd6aacc51746bb548293007ef;p=deb_libcec.git diff --git a/include/cec.h b/include/cec.h index 7ac25fd..97e75a4 100644 --- a/include/cec.h +++ b/include/cec.h @@ -2,7 +2,7 @@ /* * This file is part of the libCEC(R) library. * - * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved. + * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved. * libCEC(R) is an original work, containing original code. * * libCEC(R) is a trademark of Pulse-Eight Limited. @@ -59,7 +59,15 @@ namespace CEC virtual void Close(void) = 0; /*! - * @brief Try to find all connected CEC adapters. Only implemented on Linux at the moment. + * @brief Set and enable the callback methods. If this method is not called, the GetNext...() methods will have to be used. + * @param cbParam Parameter to pass to callback methods. + * @param callbacks The callbacks to set. + * @return True when enabled, false otherwise. + */ + virtual bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks) = 0; + + /*! + * @brief Try to find all connected CEC adapters. Only implemented on Linux and Windows at the moment. * @param deviceList The vector to store device descriptors in. * @param iBufSize The size of the deviceList buffer. * @param strDevicePath Optional device path. Only adds device descriptors that match the given device path. @@ -137,6 +145,20 @@ namespace CEC */ virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0; + /*! + * @brief Enable physical address detection (if the connected adapter supports this). + * @return True when physical address detection was enabled, false otherwise. + */ + virtual bool EnablePhysicalAddressDetection(void) = 0; + + /*! + * @brief Changes the active HDMI port. + * @param iBaseDevice The device to which this libcec is connected. + * @param iPort The new port number. + * @return True when changed, false otherwise. + */ + virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort) = 0; + /*! * @brief Power on the connected CEC capable devices. * @param address The logical address to power on. @@ -237,6 +259,13 @@ namespace CEC */ virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress) = 0; + /*! + * @brief Get the physical address of the device with the given logical address. + * @param iLogicalAddress The device to get the vendor id for. + * @return The physical address or 0 if it wasn't found. + */ + virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress) = 0; + /*! * @brief Sends a POLL message to a device. * @param iAddress The device to send the message to. @@ -263,30 +292,88 @@ namespace CEC */ virtual bool IsActiveDeviceType(cec_device_type type) = 0; - /*! - * @brief Changes the active HDMI port. - * @param iPort The new port number. - * @return True when changed, false otherwise. - */ - virtual bool SetHDMIPort(uint8_t iPort) = 0; - /*! * @brief Sends a volume up keypress to an audiosystem if it's present. + * @param bSendRelease Send a key release after the keypress. * @return The new audio status. */ - virtual uint8_t VolumeUp(void) = 0; + virtual uint8_t VolumeUp(bool bSendRelease = true) = 0; /*! * @brief Sends a volume down keypress to an audiosystem if it's present. + * @param bSendRelease Send a key release after the keypress. * @return The new audio status. */ - virtual uint8_t VolumeDown(void) = 0; + virtual uint8_t VolumeDown(bool bSendRelease = true) = 0; /*! * @brief Sends a mute keypress to an audiosystem if it's present. + * @param bSendRelease Send a key release after the keypress. * @return The new audio status. */ - virtual uint8_t MuteAudio(void) = 0; + virtual uint8_t MuteAudio(bool bSendRelease = true) = 0; + + /*! + * @brief Send a keypress to a device on the CEC bus. + * @param iDestination The address to send the message to. + * @param key The key to send. + * @param bWait True to wait for a response, false otherwise. + * @return True when the keypress was acked, false otherwise. + */ + virtual bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = false) = 0; + + /*! + * @brief Send a key release to a device on the CEC bus. + * @param iDestination The address to send the message to. + * @param bWait True to wait for a response, false otherwise. + * @return True when the keypress was acked, false otherwise. + */ + virtual bool SendKeyRelease(cec_logical_address iDestination, bool bWait = false) = 0; + + /*! + * @brief Get the OSD name of a device on the CEC bus. + * @param iAddress The device to get the OSD name for. + * @return The OSD name. + */ + virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress) = 0; + + /*! + * @brief Get the logical address of the device that is currently the active source on the CEC bus. + * @return The active source or CECDEVICE_UNKNOWN when unknown. + */ + virtual cec_logical_address GetActiveSource(void) = 0; + + /*! + * @brief Check whether a device is currently the active source on the CEC bus. + * @param iAddress The address to check. + * @return True when it is the active source, false otherwise. + */ + virtual bool IsActiveSource(cec_logical_address iAddress) = 0; + + /*! + * @brief Sets the stream path to the device on the given logical address. + * @param iAddress The address to activate. + * @return True when the command was sent, false otherwise. + */ + virtual bool SetStreamPath(cec_logical_address iAddress) = 0; + + /*! + * @brief Sets the stream path to the device on the given logical address. + * @param iPhysicalAddress The address to activate. + * @return True when the command was sent, false otherwise. + */ + virtual bool SetStreamPath(uint16_t iPhysicalAddress) = 0; + + virtual const char *ToString(const cec_menu_state state) = 0; + virtual const char *ToString(const cec_version version) = 0; + virtual const char *ToString(const cec_power_status status) = 0; + virtual const char *ToString(const cec_logical_address address) = 0; + virtual const char *ToString(const cec_deck_control_mode mode) = 0; + virtual const char *ToString(const cec_deck_info status) = 0; + virtual const char *ToString(const cec_opcode opcode) = 0; + virtual const char *ToString(const cec_system_audio_status mode) = 0; + virtual const char *ToString(const cec_audio_status status) = 0; + virtual const char *ToString(const cec_vendor_id vendor) = 0; }; };