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-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 #include <string>
  35 #include "cec.h"
  36 #include "platform/util/buffer.h"
  37 #include "CECTypeUtils.h"
  38
  39 namespace CEC
  40 {
  41   class CAdapterCommunication;
  42   class CCECProcessor;
  43   class CCECClient;
  44
  45   class CLibCEC : public ICECAdapter
  46   {
  47     public:
  48       CLibCEC(void);
  49       virtual ~CLibCEC(void);
  50
  51     /*!
  52      * ICECAdapter implementation
  53      */
  54     //@{
  55       bool Open(const char *strPort, uint32_t iTimeout = CEC_DEFAULT_CONNECT_TIMEOUT);
  56       void Close(void);
  57       bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks);
  58       int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL);
  59       bool PingAdapter(void);
  60       bool StartBootloader(void);
  61
  62       bool Transmit(const cec_command &data);
  63       bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1);
  64       bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
  65
  66       bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV);
  67       bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST);
  68       bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
  69       bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
  70       bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
  71       bool SetInactiveView(void);
  72       bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
  73       bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage);
  74       bool SwitchMonitoring(bool bEnable);
  75       cec_version GetDeviceCecVersion(cec_logical_address iAddress);
  76       bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
  77       uint64_t GetDeviceVendorId(cec_logical_address iAddress);
  78       uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress);
  79       cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
  80       bool PollDevice(cec_logical_address iAddress);
  81       cec_logical_addresses GetActiveDevices(void);
  82       bool IsActiveDevice(cec_logical_address iAddress);
  83       bool IsActiveDeviceType(cec_device_type type);
  84       bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort = CEC_DEFAULT_HDMI_PORT);
  85       uint8_t VolumeUp(bool bSendRelease = true);
  86       uint8_t VolumeDown(bool bSendRelease = true);
  87       uint8_t MuteAudio(bool bSendRelease = true);
  88       bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
  89       bool SendKeyRelease(cec_logical_address iDestination, bool bWait = true);
  90       cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
  91       cec_logical_address GetActiveSource(void);
  92       bool IsActiveSource(cec_logical_address iAddress);
  93       bool SetStreamPath(cec_logical_address iAddress);
  94       bool SetStreamPath(uint16_t iPhysicalAddress);
  95       cec_logical_addresses GetLogicalAddresses(void);
  96       bool GetCurrentConfiguration(libcec_configuration *configuration);
  97       bool SetConfiguration(const libcec_configuration *configuration);
  98       bool CanPersistConfiguration(void);
  99       bool PersistConfiguration(libcec_configuration *configuration);
 100       void RescanActiveDevices(void);
 101       bool IsLibCECActiveSource(void);
 102
 103       const char *ToString(const cec_menu_state state)         { return CCECTypeUtils::ToString(state); }
 104       const char *ToString(const cec_version version)          { return CCECTypeUtils::ToString(version); }
 105       const char *ToString(const cec_power_status status)      { return CCECTypeUtils::ToString(status); }
 106       const char *ToString(const cec_logical_address address)  { return CCECTypeUtils::ToString(address); }
 107       const char *ToString(const cec_deck_control_mode mode)   { return CCECTypeUtils::ToString(mode); }
 108       const char *ToString(const cec_deck_info status)         { return CCECTypeUtils::ToString(status); }
 109       const char *ToString(const cec_opcode opcode)            { return CCECTypeUtils::ToString(opcode); }
 110       const char *ToString(const cec_system_audio_status mode) { return CCECTypeUtils::ToString(mode); }
 111       const char *ToString(const cec_audio_status status)      { return CCECTypeUtils::ToString(status); }
 112       const char *ToString(const cec_vendor_id vendor)         { return CCECTypeUtils::ToString(vendor); }
 113       const char *ToString(const cec_client_version version)   { return CCECTypeUtils::ToString(version); }
 114       const char *ToString(const cec_server_version version)   { return CCECTypeUtils::ToString(version); }
 115       const char *ToString(const cec_device_type type)         { return CCECTypeUtils::ToString(type); }
 116       const char *ToString(const cec_user_control_code key)    { return CCECTypeUtils::ToString(key); }
 117       const char *ToString(const cec_adapter_type type)        { return CCECTypeUtils::ToString(type); }
 118
 119       static cec_device_type GetType(cec_logical_address address);
 120       static uint16_t GetMaskForType(cec_logical_address address);
 121       static uint16_t GetMaskForType(cec_device_type type);
 122
 123       bool GetDeviceInformation(const char *strPort, libcec_configuration *config, uint32_t iTimeoutMs = CEC_DEFAULT_CONNECT_TIMEOUT);
 124     //@}
 125
 126       void AddLog(const cec_log_level level, const char *strFormat, ...);
 127       void AddCommand(const cec_command &command);
 128       void CheckKeypressTimeout(void);
 129       void Alert(const libcec_alert type, const libcec_parameter &param);
 130
 131       static bool IsValidPhysicalAddress(uint16_t iPhysicalAddress);
 132       CCECClient *RegisterClient(libcec_configuration &configuration);
 133       void UnregisterClients(void);
 134       std::vector<CCECClient *> GetClients(void) { return m_clients; };
 135       const char *GetLibInfo(void);
 136       void InitVideoStandalone(void);
 137
 138       CCECProcessor *           m_cec;
 139
 140     protected:
 141       int64_t                   m_iStartTime;
 142       PLATFORM::CMutex          m_mutex;
 143       CCECClient *              m_client;
 144       std::vector<CCECClient *> m_clients;
 145   };
 146 };