src/lib/devices/CECBusDevice.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 "../../../include/cectypes.h"
  35 #include <set>
  36 #include "../platform/threads/mutex.h"
  37 #include "../platform/util/StdString.h"
  38
  39 namespace CEC
  40 {
  41   class CCECProcessor;
  42   class CCECCommandHandler;
  43
  44   class CCECBusDevice
  45   {
  46     friend class CCECProcessor;
  47
  48   public:
  49     CCECBusDevice(CCECProcessor *processor, cec_logical_address address, uint16_t iPhysicalAddress = 0);
  50     virtual ~CCECBusDevice(void);
  51
  52     virtual bool HandleCommand(const cec_command &command);
  53     virtual bool PowerOn(void);
  54     virtual bool Standby(void);
  55
  56     virtual cec_version           GetCecVersion(bool bUpdate = false);
  57     virtual CCECCommandHandler *  GetHandler(void) const { return m_handler; };
  58     virtual uint64_t              GetLastActive(void) const { return m_iLastActive; }
  59     virtual cec_logical_address   GetLogicalAddress(void) const { return m_iLogicalAddress; }
  60     virtual const char*           GetLogicalAddressName(void) const;
  61     virtual cec_menu_language &   GetMenuLanguage(bool bUpdate = false);
  62     virtual cec_menu_state        GetMenuState(void);
  63     virtual cec_logical_address   GetMyLogicalAddress(void) const;
  64     virtual uint16_t              GetMyPhysicalAddress(void) const;
  65     virtual CStdString            GetOSDName(bool bUpdate = false);
  66     virtual uint16_t              GetPhysicalAddress(bool bUpdate = false);
  67     virtual cec_power_status      GetPowerStatus(bool bUpdate = false);
  68     virtual CCECProcessor *       GetProcessor(void) const { return m_processor; }
  69     virtual cec_device_type       GetType(void) const { return m_type; }
  70     virtual cec_vendor_id         GetVendorId(bool bUpdate = false);
  71     virtual const char *          GetVendorName(bool bUpdate = false);
  72     virtual bool                  MyLogicalAddressContains(cec_logical_address address) const;
  73     virtual cec_bus_device_status GetStatus(bool bForcePoll = false);
  74     virtual bool                  IsActiveSource(void) const { return m_bActiveSource; }
  75     virtual bool                  IsUnsupportedFeature(cec_opcode opcode) const;
  76     virtual void                  SetUnsupportedFeature(cec_opcode opcode);
  77     virtual void                  HandlePoll(cec_logical_address initiator);
  78     virtual bool                  HandleReceiveFailed(void);
  79
  80     virtual void SetInactiveSource(void);
  81     virtual void SetActiveSource(void);
  82     virtual bool TryLogicalAddress(void);
  83     virtual bool ActivateSource(void);
  84
  85     virtual void SetDeviceStatus(const cec_bus_device_status newStatus);
  86     virtual void SetPhysicalAddress(uint16_t iNewAddress);
  87     virtual void SetStreamPath(uint16_t iNewAddress, uint16_t iOldAddress = 0);
  88     virtual void SetCecVersion(const cec_version newVersion);
  89     virtual void SetMenuLanguage(const cec_menu_language &menuLanguage);
  90     virtual void SetOSDName(CStdString strName);
  91     virtual void SetMenuState(const cec_menu_state state);
  92     virtual bool SetVendorId(uint64_t iVendorId);
  93     virtual void SetPowerStatus(const cec_power_status powerStatus);
  94
  95     virtual bool TransmitActiveSource(void);
  96     virtual bool TransmitCECVersion(cec_logical_address dest);
  97     virtual bool TransmitImageViewOn(void);
  98     virtual bool TransmitInactiveSource(void);
  99     virtual bool TransmitMenuState(cec_logical_address dest);
 100     virtual bool TransmitOSDName(cec_logical_address dest);
 101     virtual bool TransmitOSDString(cec_logical_address dest, cec_display_control duration, const char *strMessage);
 102     virtual bool TransmitPhysicalAddress(void);
 103     virtual bool TransmitPowerState(cec_logical_address dest);
 104     virtual bool TransmitPoll(cec_logical_address dest);
 105     virtual bool TransmitVendorID(cec_logical_address dest, bool bSendAbort = true);
 106     virtual bool TransmitKeypress(cec_user_control_code key, bool bWait = true);
 107     virtual bool TransmitKeyRelease(bool bWait = true);
 108
 109     bool ReplaceHandler(bool bActivateSource = true);
 110
 111   protected:
 112     void CheckVendorIdRequested(void);
 113     void MarkBusy(void);
 114     void MarkReady(void);
 115
 116     bool RequestCecVersion(void);
 117     bool RequestMenuLanguage(void);
 118     bool RequestPowerStatus(void);
 119     bool RequestVendorId(void);
 120     bool RequestPhysicalAddress(void);
 121     bool RequestOSDName(void);
 122
 123     bool NeedsPoll(void);
 124
 125     cec_device_type       m_type;
 126     CStdString            m_strDeviceName;
 127     uint16_t              m_iPhysicalAddress;
 128     uint16_t              m_iStreamPath;
 129     cec_logical_address   m_iLogicalAddress;
 130     cec_power_status      m_powerStatus;
 131     cec_menu_language     m_menuLanguage;
 132     CCECProcessor      *  m_processor;
 133     CCECCommandHandler *  m_handler;
 134     cec_vendor_id         m_vendor;
 135     bool                  m_bReplaceHandler;
 136     cec_menu_state        m_menuState;
 137     bool                  m_bActiveSource;
 138     uint64_t              m_iLastActive;
 139     uint64_t              m_iLastPowerStateUpdate;
 140     cec_version           m_cecVersion;
 141     cec_bus_device_status m_deviceStatus;
 142     std::set<cec_opcode>  m_unsupportedFeatures;
 143     PLATFORM::CMutex      m_mutex;
 144     PLATFORM::CMutex      m_handlerMutex;
 145     PLATFORM::CEvent      m_replacing;
 146     unsigned              m_iHandlerUseCount;
 147     bool                  m_bAwaitingReceiveFailed;
 148     bool                  m_bVendorIdRequested;
 149   };
 150 };