src/lib/CECProcessor.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 "../../include/cectypes.h"
  36 #include "platform/threads/threads.h"
  37 #include "platform/util/buffer.h"
  38 #include "adapter/AdapterCommunication.h"
  39
  40 namespace CEC
  41 {
  42   class CLibCEC;
  43   struct IAdapterCommunication;
  44   class CCECBusDevice;
  45
  46   class CCECProcessor : public PLATFORM::CThread, public IAdapterCommunicationCallback
  47   {
  48     public:
  49       CCECProcessor(CLibCEC *controller, const char *strDeviceName, const cec_device_type_list &types, uint16_t iPhysicalAddress, cec_client_version clientVersion);
  50       CCECProcessor(CLibCEC *controller, const libcec_configuration *configuration);
  51       virtual ~CCECProcessor(void);
  52
  53       virtual bool Start(const char *strPort, uint16_t iBaudRate = 38400, uint32_t iTimeoutMs = 10000);
  54       virtual void *Process(void);
  55       virtual void Close(void);
  56
  57       virtual bool                  OnCommandReceived(const cec_command &command);
  58
  59       virtual bool                  IsMonitoring(void) const { return m_bMonitor; }
  60       virtual CCECBusDevice *       GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress, bool bRefresh = false) const;
  61       virtual CCECBusDevice *       GetDeviceByType(cec_device_type type) const;
  62       virtual CCECBusDevice *       GetPrimaryDevice(void) const;
  63       virtual cec_version           GetDeviceCecVersion(cec_logical_address iAddress);
  64       virtual bool                  GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
  65       virtual const std::string &   GetDeviceName(void) { return m_strDeviceName; }
  66       virtual cec_osd_name          GetDeviceOSDName(cec_logical_address iAddress);
  67       virtual uint64_t              GetDeviceVendorId(cec_logical_address iAddress);
  68       virtual cec_power_status      GetDevicePowerStatus(cec_logical_address iAddress);
  69       virtual cec_logical_address   GetLogicalAddress(void) const { return m_logicalAddresses.primary; }
  70       virtual cec_logical_addresses GetLogicalAddresses(void) const { return m_logicalAddresses; }
  71       virtual cec_logical_addresses GetActiveDevices(void);
  72       virtual uint16_t              GetDevicePhysicalAddress(cec_logical_address iAddress);
  73       virtual bool                  HasLogicalAddress(cec_logical_address address) const { return m_logicalAddresses.IsSet(address); }
  74       virtual bool                  IsPresentDevice(cec_logical_address address);
  75       virtual bool                  IsPresentDeviceType(cec_device_type type);
  76       virtual uint16_t              GetPhysicalAddress(void) const;
  77       virtual uint64_t              GetLastTransmission(void) const { return m_iLastTransmission; }
  78       virtual cec_logical_address   GetActiveSource(void);
  79       virtual bool                  IsActiveSource(cec_logical_address iAddress);
  80       virtual bool                  IsInitialised(void);
  81       virtual bool                  SetStreamPath(uint16_t iPhysicalAddress);
  82
  83       virtual bool SetActiveView(void);
  84       virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
  85       virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
  86       virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
  87       virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort, bool bForce = false);
  88       virtual bool TransmitInactiveSource(void);
  89       virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress);
  90       virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
  91       virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress, bool bSendUpdate = true);
  92       virtual bool SetActiveSource(uint16_t iStreamPath);
  93       virtual bool SwitchMonitoring(bool bEnable);
  94       virtual bool PollDevice(cec_logical_address iAddress);
  95       virtual uint8_t VolumeUp(bool bSendRelease = true);
  96       virtual uint8_t VolumeDown(bool bSendRelease = true);
  97       virtual uint8_t MuteAudio(bool bSendRelease = true);
  98       virtual bool TransmitKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
  99       virtual bool TransmitKeyRelease(cec_logical_address iDestination, bool bWait = true);
 100       virtual bool EnablePhysicalAddressDetection(void) { return false; };
 101       void SetStandardLineTimeout(uint8_t iTimeout);
 102       void SetRetryLineTimeout(uint8_t iTimeout);
 103       virtual bool GetCurrentConfiguration(libcec_configuration *configuration);
 104       virtual bool CanPersistConfiguration(void);
 105       virtual bool PersistConfiguration(libcec_configuration *configuration);
 106
 107       bool SetLineTimeout(uint8_t iTimeout);
 108
 109       const char *ToString(const cec_device_type type);
 110       const char *ToString(const cec_menu_state state);
 111       const char *ToString(const cec_version version);
 112       const char *ToString(const cec_power_status status);
 113       const char *ToString(const cec_logical_address address);
 114       const char *ToString(const cec_deck_control_mode mode);
 115       const char *ToString(const cec_deck_info status);
 116       const char *ToString(const cec_opcode opcode);
 117       const char *ToString(const cec_system_audio_status mode);
 118       const char *ToString(const cec_audio_status status);
 119       const char *ToString(const cec_vendor_id vendor);
 120       const char *ToString(const cec_client_version version);
 121
 122       virtual bool Transmit(const cec_command &data);
 123       virtual void TransmitAbort(cec_logical_address address, cec_opcode opcode, cec_abort_reason reason = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE);
 124
 125       virtual bool ChangeDeviceType(cec_device_type from, cec_device_type to);
 126       virtual bool FindLogicalAddresses(void);
 127       virtual bool SetAckMask(uint16_t iMask);
 128
 129       virtual bool StartBootloader(void);
 130       virtual bool PingAdapter(void);
 131       virtual void HandlePoll(cec_logical_address initiator, cec_logical_address destination);
 132       virtual bool HandleReceiveFailed(cec_logical_address initiator);
 133
 134       CCECBusDevice *  m_busDevices[16];
 135       PLATFORM::CMutex m_transmitMutex;
 136
 137   private:
 138       bool OpenConnection(const char *strPort, uint16_t iBaudRate, uint32_t iTimeoutMs);
 139       bool Initialise(void);
 140       void SetInitialised(bool bSetTo = true);
 141       void CreateBusDevices(void);
 142
 143       void ReplaceHandlers(void);
 144       void ScanCECBus(void);
 145       bool PhysicalAddressInUse(uint16_t iPhysicalAddress);
 146       bool TryLogicalAddress(cec_logical_address address);
 147       bool FindLogicalAddressRecordingDevice(void);
 148       bool FindLogicalAddressTuner(void);
 149       bool FindLogicalAddressPlaybackDevice(void);
 150       bool FindLogicalAddressAudioSystem(void);
 151
 152       void LogOutput(const cec_command &data);
 153       void ParseCommand(const cec_command &command);
 154
 155       bool                                m_bInitialised;
 156       uint16_t                            m_iPhysicalAddress;
 157       uint8_t                             m_iHDMIPort;
 158       cec_logical_address                 m_iBaseDevice;
 159       cec_logical_addresses               m_logicalAddresses;
 160       std::string                         m_strDeviceName;
 161       cec_device_type_list                m_types;
 162       PLATFORM::CMutex                    m_mutex;
 163       IAdapterCommunication *             m_communication;
 164       CLibCEC*                            m_controller;
 165       bool                                m_bMonitor;
 166       PLATFORM::SyncedBuffer<cec_command> m_commandBuffer;
 167       cec_keypress                        m_previousKey;
 168       PLATFORM::CThread *                 m_busScan;
 169       uint8_t                             m_iLineTimeout;
 170       uint8_t                             m_iStandardLineTimeout;
 171       uint8_t                             m_iRetryLineTimeout;
 172       uint64_t                            m_iLastTransmission;
 173       cec_client_version                  m_clientVersion;
 174   };
 175
 176   class CCECBusScan : public PLATFORM::CThread
 177   {
 178   public:
 179     CCECBusScan(CCECProcessor *processor) { m_processor = processor; }
 180     virtual ~CCECBusScan(void) { StopThread(true); }
 181     virtual void *Process(void);
 182
 183   private:
 184     void WaitUntilIdle(void);
 185
 186     CCECProcessor *m_processor;
 187   };
 188 };