src/lib/LibCEC.h

   1 #pragma once
   2 /*
   3  * This file is part of the libCEC(R) library.
   4  *
   5  * libCEC(R) is Copyright (C) 2011 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 #include <string>
  35 #include <cec.h>
  36 #include "util/buffer.h"
  37
  38 namespace CEC
  39 {
  40   class CAdapterCommunication;
  41   class CCECProcessor;
  42
  43   class CLibCEC : public ICECAdapter
  44   {
  45     public:
  46     /*!
  47      * ICECAdapter implementation
  48      */
  49     //@{
  50       CLibCEC(const char *strDeviceName, cec_device_type_list types);
  51       CLibCEC(const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
  52       virtual ~CLibCEC(void);
  53
  54       virtual bool Open(const char *strPort, uint32_t iTimeout = 10000);
  55       virtual void Close(void);
  56       virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL);
  57       virtual bool PingAdapter(void);
  58       virtual bool StartBootloader(void);
  59
  60       virtual int8_t GetMinLibVersion(void) const{ return CEC_MIN_LIB_VERSION; };
  61       virtual int8_t GetLibVersionMajor(void) const { return CEC_LIB_VERSION_MAJOR; };
  62       virtual int8_t GetLibVersionMinor(void) const { return CEC_LIB_VERSION_MINOR; };
  63
  64       virtual bool GetNextLogMessage(cec_log_message *message);
  65       virtual bool GetNextKeypress(cec_keypress *key);
  66       virtual bool GetNextCommand(cec_command *command);
  67
  68       virtual bool Transmit(const cec_command &data);
  69       virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1);
  70       virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
  71
  72       virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV);
  73       virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST);
  74       virtual bool SetActiveView(void);
  75       virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
  76       virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
  77       virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
  78       virtual bool SetInactiveView(void);
  79       virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
  80       virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage);
  81       virtual bool SwitchMonitoring(bool bEnable);
  82       virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress);
  83       virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
  84       virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress);
  85       virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
  86       virtual bool PollDevice(cec_logical_address iAddress);
  87       virtual cec_logical_addresses GetActiveDevices(void);
  88       virtual bool IsActiveDevice(cec_logical_address iAddress);
  89       virtual bool IsActiveDeviceType(cec_device_type type);
  90       virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort = CEC_DEFAULT_HDMI_PORT);
  91       virtual uint8_t VolumeUp(bool bWait = true);
  92       virtual uint8_t VolumeDown(bool bWait = true);
  93       virtual uint8_t MuteAudio(bool bWait = true);
  94       virtual bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = false);
  95       virtual bool SendKeyRelease(cec_logical_address iDestination, bool bWait = false);
  96       virtual cec_osd_name GetOSDName(cec_logical_address iAddress);
  97       virtual bool EnablePhysicalAddressDetection(void);
  98
  99       const char *ToString(const cec_menu_state state);
 100       const char *ToString(const cec_version version);
 101       const char *ToString(const cec_power_status status);
 102       const char *ToString(const cec_logical_address address);
 103       const char *ToString(const cec_deck_control_mode mode);
 104       const char *ToString(const cec_deck_info status);
 105       const char *ToString(const cec_opcode opcode);
 106       const char *ToString(const cec_system_audio_status mode);
 107       const char *ToString(const cec_audio_status status);
 108       const char *ToString(const cec_vendor_id vendor);
 109     //@}
 110
 111       virtual void AddLog(cec_log_level level, const std::string &strMessage);
 112       virtual void AddKey(void);
 113       virtual void AddKey(cec_keypress &key);
 114       virtual void AddCommand(const cec_command &command);
 115       virtual void CheckKeypressTimeout(void);
 116       virtual void SetCurrentButton(cec_user_control_code iButtonCode);
 117
 118     protected:
 119       int64_t                    m_iStartTime;
 120       cec_user_control_code      m_iCurrentButton;
 121       int64_t                    m_buttontime;
 122       CCECProcessor             *m_cec;
 123       CAdapterCommunication     *m_comm;
 124       CecBuffer<cec_log_message> m_logBuffer;
 125       CecBuffer<cec_keypress>    m_keyBuffer;
 126       CecBuffer<cec_command>     m_commandBuffer;
 127   };
 128 };