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
  36 #include "platform/threads/threads.h"
  37 #include "platform/util/buffer.h"
  38
  39 #include "adapter/AdapterCommunication.h"
  40 #include "devices/CECDeviceMap.h"
  41 #include "CECInputBuffer.h"
  42
  43 namespace CEC
  44 {
  45   class CLibCEC;
  46   class IAdapterCommunication;
  47   class CCECBusDevice;
  48   class CCECAudioSystem;
  49   class CCECPlaybackDevice;
  50   class CCECRecordingDevice;
  51   class CCECTuner;
  52   class CCECTV;
  53   class CCECClient;
  54
  55   class CCECProcessor : public PLATFORM::CThread, public IAdapterCommunicationCallback
  56   {
  57     public:
  58       CCECProcessor(CLibCEC *libcec);
  59       virtual ~CCECProcessor(void);
  60
  61       bool Start(const char *strPort, uint16_t iBaudRate = CEC_SERIAL_DEFAULT_BAUDRATE, uint32_t iTimeoutMs = CEC_DEFAULT_CONNECT_TIMEOUT);
  62       void *Process(void);
  63       void Close(void);
  64
  65       bool RegisterClient(CCECClient *client);
  66       bool UnregisterClient(CCECClient *client);
  67       void UnregisterClients(void);
  68       CCECClient *GetPrimaryClient(void);
  69       CCECClient *GetClient(const cec_logical_address address);
  70
  71       bool                  OnCommandReceived(const cec_command &command);
  72       void                  HandleLogicalAddressLost(cec_logical_address address);
  73
  74       CCECBusDevice *       GetDevice(cec_logical_address address) const;
  75       CCECAudioSystem *     GetAudioSystem(void) const;
  76       CCECPlaybackDevice *  GetPlaybackDevice(cec_logical_address address) const;
  77       CCECRecordingDevice * GetRecordingDevice(cec_logical_address address) const;
  78       CCECTuner *           GetTuner(cec_logical_address address) const;
  79       CCECTV *              GetTV(void) const;
  80
  81       CCECBusDevice *       GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress, bool bSuppressUpdate = true);
  82       CCECBusDevice *       GetPrimaryDevice(void);
  83       cec_logical_address   GetLogicalAddress(void);
  84       cec_logical_addresses GetLogicalAddresses(void);
  85       bool                  IsPresentDevice(cec_logical_address address);
  86       bool                  IsPresentDeviceType(cec_device_type type);
  87       uint16_t              GetDetectedPhysicalAddress(void) const;
  88       uint64_t              GetLastTransmission(void) const { return m_iLastTransmission; }
  89       cec_logical_address   GetActiveSource(bool bRequestActiveSource = true);
  90       bool                  IsActiveSource(cec_logical_address iAddress);
  91       bool                  CECInitialised(void);
  92
  93       bool                  StandbyDevices(const cec_logical_address initiator, const CECDEVICEVEC &devices);
  94       bool                  StandbyDevice(const cec_logical_address initiator, cec_logical_address address);
  95       bool                  PowerOnDevices(const cec_logical_address initiator, const CECDEVICEVEC &devices);
  96       bool                  PowerOnDevice(const cec_logical_address initiator, cec_logical_address address);
  97
  98       bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
  99       bool ActivateSource(uint16_t iStreamPath);
 100       bool PollDevice(cec_logical_address iAddress);
 101       void SetStandardLineTimeout(uint8_t iTimeout);
 102       uint8_t GetStandardLineTimeout(void);
 103       void SetRetryLineTimeout(uint8_t iTimeout);
 104       uint8_t GetRetryLineTimeout(void);
 105       bool CanPersistConfiguration(void);
 106       bool PersistConfiguration(const libcec_configuration &configuration);
 107       void RescanActiveDevices(void);
 108
 109       bool SetLineTimeout(uint8_t iTimeout);
 110
 111       bool Transmit(const cec_command &data, bool bIsReply);
 112       void TransmitAbort(cec_logical_address source, cec_logical_address destination, cec_opcode opcode, cec_abort_reason reason = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE);
 113
 114       bool StartBootloader(const char *strPort = NULL);
 115       bool PingAdapter(void);
 116       void HandlePoll(cec_logical_address initiator, cec_logical_address destination);
 117       bool HandleReceiveFailed(cec_logical_address initiator);
 118
 119       bool GetDeviceInformation(const char *strPort, libcec_configuration *config, uint32_t iTimeoutMs = CEC_DEFAULT_CONNECT_TIMEOUT);
 120
 121       bool TransmitPendingActiveSourceCommands(void);
 122
 123       CCECDeviceMap *GetDevices(void) const { return m_busDevices; }
 124       CLibCEC *GetLib(void) const { return m_libcec; }
 125
 126       bool IsHandledByLibCEC(const cec_logical_address address) const;
 127
 128       bool TryLogicalAddress(cec_logical_address address, cec_version libCECSpecVersion = CEC_VERSION_1_4);
 129
 130       bool IsRunningLatestFirmware(void);
 131       void SwitchMonitoring(bool bSwitchTo);
 132
 133     private:
 134       bool OpenConnection(const char *strPort, uint16_t iBaudRate, uint32_t iTimeoutMs, bool bStartListening = true);
 135       void SetCECInitialised(bool bSetTo = true);
 136
 137       void ReplaceHandlers(void);
 138       bool PhysicalAddressInUse(uint16_t iPhysicalAddress);
 139
 140       bool ClearLogicalAddresses(void);
 141       bool SetLogicalAddresses(const cec_logical_addresses &addresses);
 142
 143       void LogOutput(const cec_command &data);
 144       void ProcessCommand(const cec_command &command);
 145
 146       void ResetMembers(void);
 147
 148       bool                                        m_bInitialised;
 149       PLATFORM::CMutex                            m_mutex;
 150       IAdapterCommunication *                     m_communication;
 151       CLibCEC*                                    m_libcec;
 152       uint8_t                                     m_iStandardLineTimeout;
 153       uint8_t                                     m_iRetryLineTimeout;
 154       uint64_t                                    m_iLastTransmission;
 155       CCECInputBuffer                             m_inBuffer;
 156       CCECDeviceMap *                             m_busDevices;
 157       std::map<cec_logical_address, CCECClient *> m_clients;
 158       bool                                        m_bMonitor;
 159   };
 160 };