added protection against standby without a notification from XBMC and clock changes...
[deb_libcec.git] / src / lib / CECProcessor.h
index 2d6ca5e50907a84dfd107991b637dcb8d47eed52..44f1fc170bf1d22d674e7d057c44fa4024b5afb6 100644 (file)
@@ -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-2013 Pulse-Eight Limited.  All rights reserved.
  * libCEC(R) is an original work, containing original code.
  *
  * libCEC(R) is a trademark of Pulse-Eight Limited.
  */
 
 #include <string>
-#include <cectypes.h>
-#include "AdapterCommunication.h"
-#include "platform/os.h"
 
-class CSerialPort;
+#include "platform/threads/threads.h"
+#include "platform/util/buffer.h"
+
+#include "adapter/AdapterCommunication.h"
+#include "devices/CECDeviceMap.h"
+#include "CECInputBuffer.h"
 
 namespace CEC
 {
   class CLibCEC;
-  class CAdapterCommunication;
+  class IAdapterCommunication;
   class CCECBusDevice;
+  class CCECAudioSystem;
+  class CCECPlaybackDevice;
+  class CCECRecordingDevice;
+  class CCECTuner;
+  class CCECTV;
+  class CCECClient;
+  class CCECProcessor;
+  class CCECStandbyProtection;
+
+  class CCECAllocateLogicalAddress : public PLATFORM::CThread
+  {
+  public:
+    CCECAllocateLogicalAddress(CCECProcessor* processor, CCECClient* client);
+    void* Process(void);
 
-  class CCECProcessor : public PLATFORM::CThread
+  private:
+    CCECProcessor* m_processor;
+    CCECClient*    m_client;
+  };
+
+  class CCECProcessor : public PLATFORM::CThread, public IAdapterCommunicationCallback
   {
     public:
-      CCECProcessor(CLibCEC *controller, const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
-      CCECProcessor(CLibCEC *controller, const char *strDeviceName, const cec_device_type_list &types);
+      CCECProcessor(CLibCEC *libcec);
       virtual ~CCECProcessor(void);
 
-      virtual bool Start(const char *strPort, uint16_t iBaudRate = 38400, uint32_t iTimeoutMs = 10000);
-      virtual void *Process(void);
-
-      virtual bool                  IsMonitoring(void) const { return m_bMonitor; }
-      virtual CCECBusDevice *       GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress, bool bRefresh = false) const;
-      virtual CCECBusDevice *       GetDeviceByType(cec_device_type type) const;
-      virtual CCECBusDevice *       GetPrimaryDevice(void) const;
-      virtual cec_version           GetDeviceCecVersion(cec_logical_address iAddress);
-      virtual bool                  GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
-      virtual const std::string &   GetDeviceName(void) { return m_strDeviceName; }
-      virtual cec_osd_name          GetDeviceOSDName(cec_logical_address iAddress);
-      virtual uint64_t              GetDeviceVendorId(cec_logical_address iAddress);
-      virtual cec_power_status      GetDevicePowerStatus(cec_logical_address iAddress);
-      virtual cec_logical_address   GetLogicalAddress(void) const { return m_logicalAddresses.primary; }
-      virtual cec_logical_addresses GetLogicalAddresses(void) const { return m_logicalAddresses; }
-      virtual cec_logical_addresses GetActiveDevices(void);
-      virtual uint16_t              GetDevicePhysicalAddress(cec_logical_address iAddress);
-      virtual bool                  HasLogicalAddress(cec_logical_address address) const { return m_logicalAddresses.IsSet(address); }
-      virtual bool                  IsPresentDevice(cec_logical_address address);
-      virtual bool                  IsPresentDeviceType(cec_device_type type);
-      virtual uint16_t              GetPhysicalAddress(void) const;
-      virtual uint64_t              GetLastTransmission(void) const { return m_iLastTransmission; }
-      virtual bool                  IsStarted(void) const { return m_bStarted; }
-      virtual cec_logical_address   GetActiveSource(void);
-      virtual bool                  IsActiveSource(cec_logical_address iAddress);
-      virtual bool                  IsInitialised(void) const { return m_bInitialised; }
-
-      virtual bool SetActiveView(void);
-      virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
-      virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
-      virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
-      virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort, bool bForce = false);
-      virtual bool TransmitInactiveSource(void);
-      virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress);
-      virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
-      virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress, bool bSendUpdate = true);
-      virtual bool SetActiveSource(uint16_t iStreamPath);
-      virtual bool SwitchMonitoring(bool bEnable);
-      virtual bool PollDevice(cec_logical_address iAddress);
-      virtual uint8_t VolumeUp(bool bSendRelease = true);
-      virtual uint8_t VolumeDown(bool bSendRelease = true);
-      virtual uint8_t MuteAudio(bool bSendRelease = true);
-      virtual bool TransmitKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
-      virtual bool TransmitKeyRelease(cec_logical_address iDestination, bool bWait = true);
-      virtual bool EnablePhysicalAddressDetection(void) { return false; };
+      bool Start(const char *strPort, uint16_t iBaudRate = CEC_SERIAL_DEFAULT_BAUDRATE, uint32_t iTimeoutMs = CEC_DEFAULT_CONNECT_TIMEOUT);
+      void *Process(void);
+      void Close(void);
+
+      bool RegisterClient(CCECClient *client);
+      bool UnregisterClient(CCECClient *client);
+      void UnregisterClients(void);
+      uint16_t GetPhysicalAddressFromEeprom(void);
+      CCECClient *GetPrimaryClient(void);
+      CCECClient *GetClient(const cec_logical_address address);
+
+      bool                  OnCommandReceived(const cec_command &command);
+      void                  HandleLogicalAddressLost(cec_logical_address oldAddress);
+      void                  HandlePhysicalAddressChanged(uint16_t iNewAddress);
+
+      CCECBusDevice *       GetDevice(cec_logical_address address) const;
+      CCECAudioSystem *     GetAudioSystem(void) const;
+      CCECPlaybackDevice *  GetPlaybackDevice(cec_logical_address address) const;
+      CCECRecordingDevice * GetRecordingDevice(cec_logical_address address) const;
+      CCECTuner *           GetTuner(cec_logical_address address) const;
+      CCECTV *              GetTV(void) const;
+
+      CCECBusDevice *       GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress, bool bSuppressUpdate = true);
+      CCECBusDevice *       GetPrimaryDevice(void);
+      cec_logical_address   GetLogicalAddress(void);
+      cec_logical_addresses GetLogicalAddresses(void);
+      bool                  IsPresentDevice(cec_logical_address address);
+      bool                  IsPresentDeviceType(cec_device_type type);
+      uint16_t              GetDetectedPhysicalAddress(void) const;
+      uint64_t              GetLastTransmission(void) const { return m_iLastTransmission; }
+      cec_logical_address   GetActiveSource(bool bRequestActiveSource = true);
+      bool                  IsActiveSource(cec_logical_address iAddress);
+      bool                  CECInitialised(void);
+
+      bool                  StandbyDevices(const cec_logical_address initiator, const CECDEVICEVEC &devices);
+      bool                  StandbyDevice(const cec_logical_address initiator, cec_logical_address address);
+      bool                  PowerOnDevices(const cec_logical_address initiator, const CECDEVICEVEC &devices);
+      bool                  PowerOnDevice(const cec_logical_address initiator, cec_logical_address address);
+
+      bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
+      bool ActivateSource(uint16_t iStreamPath);
+      void SetActiveSource(bool bSetTo, bool bClientUnregistered);
+      bool PollDevice(cec_logical_address iAddress);
       void SetStandardLineTimeout(uint8_t iTimeout);
+      uint8_t GetStandardLineTimeout(void);
       void SetRetryLineTimeout(uint8_t iTimeout);
+      uint8_t GetRetryLineTimeout(void);
+      bool CanPersistConfiguration(void);
+      bool PersistConfiguration(const libcec_configuration &configuration);
+      void RescanActiveDevices(void);
 
       bool SetLineTimeout(uint8_t iTimeout);
 
-      const char *ToString(const cec_device_type type);
-      const char *ToString(const cec_menu_state state);
-      const char *ToString(const cec_version version);
-      const char *ToString(const cec_power_status status);
-      const char *ToString(const cec_logical_address address);
-      const char *ToString(const cec_deck_control_mode mode);
-      const char *ToString(const cec_deck_info status);
-      const char *ToString(const cec_opcode opcode);
-      const char *ToString(const cec_system_audio_status mode);
-      const char *ToString(const cec_audio_status status);
-      const char *ToString(const cec_vendor_id vendor);
-
-      virtual bool Transmit(const cec_command &data);
-      virtual bool Transmit(CCECAdapterMessage *output);
-      virtual void TransmitAbort(cec_logical_address address, cec_opcode opcode, cec_abort_reason reason = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE);
-
-      virtual void SetCurrentButton(cec_user_control_code iButtonCode);
-      virtual void AddCommand(const cec_command &command);
-      virtual void AddKey(cec_keypress &key);
-      virtual void AddKey(void);
-      virtual void AddLog(cec_log_level level, const CStdString &strMessage);
-
-      virtual bool ChangeDeviceType(cec_device_type from, cec_device_type to);
-      virtual bool FindLogicalAddresses(void);
-      virtual bool SetAckMask(uint16_t iMask);
-
-      virtual bool StartBootloader(void);
-      virtual bool PingAdapter(void);
-
-      CCECBusDevice *  m_busDevices[16];
-      PLATFORM::CMutex m_transmitMutex;
+      bool Transmit(const cec_command &data, bool bIsReply);
+      void TransmitAbort(cec_logical_address source, cec_logical_address destination, cec_opcode opcode, cec_abort_reason reason = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE);
 
-  private:
-      bool OpenConnection(const char *strPort, uint16_t iBaudRate, uint32_t iTimeoutMs);
-      bool Initialise(void);
+      bool StartBootloader(const char *strPort = NULL);
+      bool PingAdapter(void);
+      void HandlePoll(cec_logical_address initiator, cec_logical_address destination);
+      bool HandleReceiveFailed(cec_logical_address initiator);
+
+      bool GetDeviceInformation(const char *strPort, libcec_configuration *config, uint32_t iTimeoutMs = CEC_DEFAULT_CONNECT_TIMEOUT);
+
+      bool TransmitPendingActiveSourceCommands(void);
+
+      CCECDeviceMap *GetDevices(void) const { return m_busDevices; }
+      CLibCEC *GetLib(void) const { return m_libcec; }
+
+      bool IsHandledByLibCEC(const cec_logical_address address) const;
+
+      bool TryLogicalAddress(cec_logical_address address, cec_version libCECSpecVersion = CEC_VERSION_1_4);
+
+      bool IsRunningLatestFirmware(void);
+      void SwitchMonitoring(bool bSwitchTo);
+
+      bool AllocateLogicalAddresses(CCECClient* client);
+
+      uint16_t GetAdapterVendorId(void) const;
+      uint16_t GetAdapterProductId(void) const;
+    private:
+      bool OpenConnection(const char *strPort, uint16_t iBaudRate, uint32_t iTimeoutMs, bool bStartListening = true);
+      void SetCECInitialised(bool bSetTo = true);
 
       void ReplaceHandlers(void);
-      void ScanCECBus(void);
       bool PhysicalAddressInUse(uint16_t iPhysicalAddress);
-      bool TryLogicalAddress(cec_logical_address address);
-      bool FindLogicalAddressRecordingDevice(void);
-      bool FindLogicalAddressTuner(void);
-      bool FindLogicalAddressPlaybackDevice(void);
-      bool FindLogicalAddressAudioSystem(void);
+
+      bool ClearLogicalAddresses(void);
+      bool SetLogicalAddresses(const cec_logical_addresses &addresses);
 
       void LogOutput(const cec_command &data);
-      bool WaitForTransmitSucceeded(CCECAdapterMessage *message);
-      bool ParseMessage(const CCECAdapterMessage &msg);
-      void ParseCommand(cec_command &command);
-
-      bool                                m_bStarted;
-      bool                                m_bInitialised;
-      uint8_t                             m_iHDMIPort;
-      cec_logical_address                 m_iBaseDevice;
-      cec_command                         m_currentframe;
-      cec_logical_addresses               m_logicalAddresses;
-      cec_logical_address                 m_lastInitiator;
-      std::string                         m_strDeviceName;
-      cec_device_type_list                m_types;
-      PLATFORM::CMutex                    m_mutex;
-      PLATFORM::CCondition                m_startCondition;
-      CAdapterCommunication*              m_communication;
-      CLibCEC*                            m_controller;
-      bool                                m_bMonitor;
-      PLATFORM::SyncedBuffer<cec_command> m_commandBuffer;
-      cec_keypress                        m_previousKey;
-      PLATFORM::CThread *                 m_busScan;
-      uint8_t                             m_iLineTimeout;
-      uint8_t                             m_iStandardLineTimeout;
-      uint8_t                             m_iRetryLineTimeout;
-      uint64_t                            m_iLastTransmission;
+      void ProcessCommand(const cec_command &command);
+
+      void ResetMembers(void);
+
+      bool                                        m_bInitialised;
+      PLATFORM::CMutex                            m_mutex;
+      IAdapterCommunication *                     m_communication;
+      CLibCEC*                                    m_libcec;
+      uint8_t                                     m_iStandardLineTimeout;
+      uint8_t                                     m_iRetryLineTimeout;
+      uint64_t                                    m_iLastTransmission;
+      CCECInputBuffer                             m_inBuffer;
+      CCECDeviceMap *                             m_busDevices;
+      std::map<cec_logical_address, CCECClient *> m_clients;
+      bool                                        m_bMonitor;
+      CCECAllocateLogicalAddress*                 m_addrAllocator;
+      bool                                        m_bStallCommunication;
+      CCECStandbyProtection*                      m_connCheck;
   };
 
-  class CCECBusScan : public PLATFORM::CThread
+  class CCECStandbyProtection : public PLATFORM::CThread
   {
   public:
-    CCECBusScan(CCECProcessor *processor) { m_processor = processor; }
-    virtual ~CCECBusScan(void) { StopThread(true); }
-    virtual void *Process(void);
+    CCECStandbyProtection(CCECProcessor* processor);
+    virtual ~CCECStandbyProtection(void);
+    void* Process(void);
 
   private:
-    void WaitUntilIdle(void);
-
-    CCECProcessor *m_processor;
+    CCECProcessor* m_processor;
   };
 };