moved CResponse and CWaitForResponse implementation from .h to .cpp
[deb_libcec.git] / src / lib / devices / CECBusDevice.h
index 0e11d42725a5591f5670b60a5e02bf52501afa68..d227c0312749611f7bc753a51abab5de3542a1df 100644 (file)
@@ -2,7 +2,7 @@
 /*
  * This file is part of the libCEC(R) library.
  *
- * libCEC(R) is Copyright (C) 2011-2012 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.
  *     http://www.pulse-eight.net/
  */
 
-#include "../../../include/cectypes.h"
 #include <set>
-#include "../platform/threads/mutex.h"
-#include "../platform/util/StdString.h"
+#include <map>
+#include "lib/platform/threads/mutex.h"
+#include "lib/platform/util/StdString.h"
 
 namespace CEC
 {
@@ -47,6 +47,37 @@ namespace CEC
   class CCECTuner;
   class CCECTV;
 
+  class CResponse
+  {
+  public:
+    CResponse(cec_opcode opcode);
+    ~CResponse(void);
+
+    bool Wait(uint32_t iTimeout);
+    void Broadcast(void);
+
+  private:
+    cec_opcode       m_opcode;
+    PLATFORM::CEvent m_event;
+  };
+
+  class CWaitForResponse
+  {
+  public:
+    CWaitForResponse(void);
+    ~CWaitForResponse(void);
+
+    void Clear();
+    bool Wait(cec_opcode opcode, uint32_t iTimeout = CEC_DEFAULT_TRANSMIT_WAIT);
+    void Received(cec_opcode opcode);
+
+  private:
+    CResponse *GetEvent(cec_opcode opcode);
+
+    PLATFORM::CMutex                 m_mutex;
+    std::map<cec_opcode, CResponse*> m_waitingFor;
+  };
+
   class CCECBusDevice
   {
     friend class CCECProcessor;
@@ -56,7 +87,19 @@ namespace CEC
     virtual ~CCECBusDevice(void);
 
     virtual bool                  ReplaceHandler(bool bActivateSource = true);
-    virtual CCECCommandHandler *  GetHandler(void) const        { return m_handler; };
+
+    // TODO use something smarter than this
+    /*!
+     * @brief Get the command handler for this device. Call MarkHandlerReady() when done with it.
+     * @return The current handler.
+     */
+    virtual CCECCommandHandler *  GetHandler(void);
+
+    /*!
+     * @brief To be called after GetHandler(), when no longer using it.
+     */
+    virtual void                  MarkHandlerReady(void) { MarkReady(); }
+
     virtual CCECProcessor *       GetProcessor(void) const      { return m_processor; }
     virtual uint64_t              GetLastActive(void) const     { return m_iLastActive; }
     virtual cec_device_type       GetType(void) const           { return m_type; }
@@ -75,72 +118,77 @@ namespace CEC
     virtual cec_version           GetCecVersion(const cec_logical_address initiator, bool bUpdate = false);
     virtual void                  SetCecVersion(const cec_version newVersion);
     virtual bool                  RequestCecVersion(const cec_logical_address initiator, bool bWaitForResponse = true);
-    virtual bool                  TransmitCECVersion(const cec_logical_address destination);
+    virtual bool                  TransmitCECVersion(const cec_logical_address destination, bool bIsReply);
 
     virtual cec_menu_language &   GetMenuLanguage(const cec_logical_address initiator, bool bUpdate = false);
     virtual void                  SetMenuLanguage(const char *strLanguage);
     virtual void                  SetMenuLanguage(const cec_menu_language &menuLanguage);
     virtual bool                  RequestMenuLanguage(const cec_logical_address initiator, bool bWaitForResponse = true);
-    virtual bool                  TransmitSetMenuLanguage(const cec_logical_address destination);
+    virtual bool                  TransmitSetMenuLanguage(const cec_logical_address destination, bool bIsReply);
 
-    virtual bool                  TransmitOSDString(const cec_logical_address destination, cec_display_control duration, const char *strMessage);
+    virtual bool                  TransmitOSDString(const cec_logical_address destination, cec_display_control duration, const char *strMessage, bool bIsReply);
 
     virtual CStdString            GetCurrentOSDName(void);
     virtual CStdString            GetOSDName(const cec_logical_address initiator, bool bUpdate = false);
     virtual void                  SetOSDName(CStdString strName);
     virtual bool                  RequestOSDName(const cec_logical_address source, bool bWaitForResponse = true);
-    virtual bool                  TransmitOSDName(const cec_logical_address destination);
+    virtual bool                  TransmitOSDName(const cec_logical_address destination, bool bIsReply);
 
     virtual uint16_t              GetCurrentPhysicalAddress(void);
     virtual bool                  HasValidPhysicalAddress(void);
     virtual uint16_t              GetPhysicalAddress(const cec_logical_address initiator, bool bSuppressUpdate = false);
     virtual bool                  SetPhysicalAddress(uint16_t iNewAddress);
     virtual bool                  RequestPhysicalAddress(const cec_logical_address initiator, bool bWaitForResponse = true);
-    virtual bool                  TransmitPhysicalAddress(void);
+    virtual bool                  TransmitPhysicalAddress(bool bIsReply);
 
     virtual cec_power_status      GetCurrentPowerStatus(void);
     virtual cec_power_status      GetPowerStatus(const cec_logical_address initiator, bool bUpdate = false);
     virtual void                  SetPowerStatus(const cec_power_status powerStatus);
-    virtual bool                  RequestPowerStatus(const cec_logical_address initiator, bool bWaitForResponse = true);
-    virtual bool                  TransmitPowerState(const cec_logical_address destination);
+    virtual void                  OnImageViewOnSent(bool bSentByLibCEC);
+    virtual bool                  ImageViewOnSent(void);
+    virtual bool                  RequestPowerStatus(const cec_logical_address initiator, bool bUpdate, bool bWaitForResponse = true);
+    virtual bool                  TransmitPowerState(const cec_logical_address destination, bool bIsReply);
 
     virtual cec_vendor_id         GetCurrentVendorId(void);
     virtual cec_vendor_id         GetVendorId(const cec_logical_address initiator, bool bUpdate = false);
     virtual const char *          GetVendorName(const cec_logical_address initiator, bool bUpdate = false);
     virtual bool                  SetVendorId(uint64_t iVendorId);
     virtual bool                  RequestVendorId(const cec_logical_address initiator, bool bWaitForResponse = true);
-    virtual bool                  TransmitVendorID(const cec_logical_address destination, bool bSendAbort = true);
+    virtual bool                  TransmitVendorID(const cec_logical_address destination, bool bSendAbort, bool bIsReply);
 
     virtual cec_bus_device_status GetCurrentStatus(void) { return GetStatus(false, true); }
     virtual cec_bus_device_status GetStatus(bool bForcePoll = false, bool bSuppressPoll = false);
-    virtual void                  SetDeviceStatus(const cec_bus_device_status newStatus);
-    virtual void                  ResetDeviceStatus(void);
-    virtual bool                  TransmitPoll(const cec_logical_address destination);
+    virtual void                  SetDeviceStatus(const cec_bus_device_status newStatus, cec_version libCECSpecVersion = CEC_VERSION_1_4);
+    virtual void                  ResetDeviceStatus(bool bClientUnregistered = false);
+    virtual bool                  TransmitPoll(const cec_logical_address destination, bool bUpdateDeviceStatus);
     virtual void                  HandlePoll(const cec_logical_address destination);
     virtual void                  HandlePollFrom(const cec_logical_address initiator);
     virtual bool                  HandleReceiveFailed(void);
 
     virtual cec_menu_state        GetMenuState(const cec_logical_address initiator);
     virtual void                  SetMenuState(const cec_menu_state state);
-    virtual bool                  TransmitMenuState(const cec_logical_address destination);
+    virtual bool                  TransmitMenuState(const cec_logical_address destination, bool bIsReply);
 
-    virtual bool                  ActivateSource(void);
+    virtual bool                  ActivateSource(uint64_t iDelay = 0);
     virtual bool                  IsActiveSource(void) const    { return m_bActiveSource; }
     virtual bool                  RequestActiveSource(bool bWaitForResponse = true);
     virtual void                  MarkAsActiveSource(void);
-    virtual void                  MarkAsInactiveSource(void);
-    virtual bool                  TransmitActiveSource(void);
+    virtual void                  MarkAsInactiveSource(bool bClientUnregistered = false);
+    virtual bool                  TransmitActiveSource(bool bIsReply);
     virtual bool                  TransmitImageViewOn(void);
     virtual bool                  TransmitInactiveSource(void);
     virtual bool                  TransmitPendingActiveSourceCommands(void);
+    virtual void                  SetActiveRoute(uint16_t iRoute);
     virtual void                  SetStreamPath(uint16_t iNewAddress, uint16_t iOldAddress = CEC_INVALID_PHYSICAL_ADDRESS);
 
     virtual bool                  PowerOn(const cec_logical_address initiator);
     virtual bool                  Standby(const cec_logical_address initiator);
 
-    virtual bool                  TryLogicalAddress(void);
+    virtual bool                  TryLogicalAddress(cec_version libCECSpecVersion = CEC_VERSION_1_4);
 
     CCECClient *                  GetClient(void);
+    void                          SignalOpcode(cec_opcode opcode);
+    bool                          WaitForOpcode(cec_opcode opcode);
 
            CCECAudioSystem *      AsAudioSystem(void);
     static CCECAudioSystem *      AsAudioSystem(CCECBusDevice *device);
@@ -173,8 +221,8 @@ namespace CEC
     bool                  m_bReplaceHandler;
     cec_menu_state        m_menuState;
     bool                  m_bActiveSource;
-    uint64_t              m_iLastActive;
-    uint64_t              m_iLastPowerStateUpdate;
+    int64_t               m_iLastActive;
+    int64_t               m_iLastPowerStateUpdate;
     cec_version           m_cecVersion;
     cec_bus_device_status m_deviceStatus;
     std::set<cec_opcode>  m_unsupportedFeatures;
@@ -184,5 +232,7 @@ namespace CEC
     unsigned              m_iHandlerUseCount;
     bool                  m_bAwaitingReceiveFailed;
     bool                  m_bVendorIdRequested;
+    CWaitForResponse     *m_waitForResponse;
+    bool                  m_bImageViewOnSent;
   };
 };