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 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 <cectypes.h>
  35 #include "../platform/threads.h"
  36 #include "../util/StdString.h"
  37
  38 namespace CEC
  39 {
  40   class CCECProcessor;
  41   class CCECCommandHandler;
  42
  43   class CCECBusDevice
  44   {
  45     friend class CCECProcessor;
  46
  47   public:
  48     CCECBusDevice(CCECProcessor *processor, cec_logical_address address, uint16_t iPhysicalAddress = 0);
  49     virtual ~CCECBusDevice(void);
  50
  51     virtual bool                MyLogicalAddressContains(cec_logical_address address) const;
  52     virtual cec_logical_address GetMyLogicalAddress(void) const;
  53     virtual uint16_t            GetMyPhysicalAddress(void) const;
  54     virtual const char *        GetVendorName(void) { return GetVendor().AsString(); }
  55     virtual cec_vendor_id       GetVendorId(void) { return GetVendor().vendor; };
  56     virtual const cec_vendor &  GetVendor(void);
  57     virtual uint8_t             GetVendorClass(void) const { return m_iVendorClass; }
  58     virtual uint64_t            GetLastActive(void) const { return m_iLastActive; }
  59     virtual cec_logical_address GetLogicalAddress(void) const { return m_iLogicalAddress; }
  60     virtual uint16_t            GetPhysicalAddress(void) const { return m_iPhysicalAddress; }
  61     virtual cec_version         GetCecVersion(bool bRefresh = true);
  62     virtual cec_menu_language & GetMenuLanguage(bool bRefresh = true);
  63     virtual cec_power_status    GetPowerStatus(bool bRefresh = true);
  64     virtual bool                PollDevice(cec_logical_address source = CECDEVICE_UNKNOWN);
  65
  66     virtual bool PowerOn(void);
  67     virtual bool Standby(void);
  68     virtual bool SetOSDString(cec_display_control duration, const char *strMessage);
  69     virtual void PollVendorId(void);
  70
  71     virtual void SetPhysicalAddress(uint16_t iNewAddress, uint16_t iOldAddress = 0);
  72     virtual void SetCecVersion(const cec_version newVersion);
  73     virtual void SetMenuLanguage(const cec_menu_language &menuLanguage);
  74     virtual void SetVendorId(const cec_datapacket &data);
  75     virtual void SetVendorId(uint64_t iVendorId, uint8_t iVendorClass = 0);
  76     virtual void SetPowerStatus(const cec_power_status powerStatus);
  77
  78     virtual bool HandleCommand(const cec_command &command);
  79
  80     virtual void AddLog(cec_log_level level, const CStdString &strMessage);
  81     virtual CCECProcessor *GetProcessor() const { return m_processor; }
  82     virtual CCECCommandHandler *GetHandler(void) const { return m_handler; };
  83
  84     virtual bool ReportCECVersion(cec_logical_address dest);
  85     virtual bool ReportDeckStatus(cec_logical_address dest);
  86     virtual bool ReportMenuState(cec_logical_address dest);
  87     virtual bool ReportOSDName(cec_logical_address dest);
  88     virtual bool ReportPowerState(cec_logical_address dest);
  89     virtual bool ReportVendorID(cec_logical_address dest);
  90
  91     virtual bool BroadcastActiveView(void);
  92     virtual bool BroadcastInactiveView(void);
  93     virtual bool BroadcastPhysicalAddress(void);
  94     virtual bool BroadcastActiveSource(void);
  95
  96   protected:
  97     cec_device_type     m_type;
  98     CStdString          m_strDeviceName;
  99     uint16_t            m_iPhysicalAddress;
 100     cec_logical_address m_iLogicalAddress;
 101     cec_power_status    m_powerStatus;
 102     cec_menu_language   m_menuLanguage;
 103     CCECProcessor      *m_processor;
 104     CCECCommandHandler *m_handler;
 105     cec_vendor          m_vendor;
 106     bool                m_bMenuActive;
 107     uint8_t             m_iVendorClass;
 108     uint64_t            m_iLastActive;
 109     cec_version         m_cecVersion;
 110     CMutex              m_mutex;
 111     CCondition          m_condition;
 112   };
 113 };