[deb_libcec.git] / src / lib / devices / CECBusDevice.h

#pragma once
/*
 * 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 an original work, containing original code.
 *
 * libCEC(R) is a trademark of Pulse-Eight Limited.
 *
 * This program is dual-licensed; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 *
 * Alternatively, you can license this library under a commercial license,
 * please contact Pulse-Eight Licensing for more information.
 *
 * For more information contact:
 * Pulse-Eight Licensing       <license@pulse-eight.com>
 *     http://www.pulse-eight.com/
 *     http://www.pulse-eight.net/
 */

#include "../../../include/cectypes.h"
#include <set>
#include "../platform/threads/mutex.h"
#include "../platform/util/StdString.h"

namespace CEC
{
  class CCECProcessor;
  class CCECCommandHandler;

  class CCECBusDevice
  {
    friend class CCECProcessor;

  public:
    CCECBusDevice(CCECProcessor *processor, cec_logical_address address, uint16_t iPhysicalAddress = 0);
    virtual ~CCECBusDevice(void);

    virtual bool HandleCommand(const cec_command &command);
    virtual bool PowerOn(void);
    virtual bool Standby(void);

    virtual cec_version           GetCecVersion(bool bUpdate = false);
    virtual CCECCommandHandler *  GetHandler(void) const { return m_handler; };
    virtual uint64_t              GetLastActive(void) const { return m_iLastActive; }
    virtual cec_logical_address   GetLogicalAddress(void) const { return m_iLogicalAddress; }
    virtual const char*           GetLogicalAddressName(void) const;
    virtual cec_menu_language &   GetMenuLanguage(bool bUpdate = false);
    virtual cec_menu_state        GetMenuState(void);
    virtual cec_logical_address   GetMyLogicalAddress(void) const;
    virtual uint16_t              GetMyPhysicalAddress(void) const;
    virtual CStdString            GetOSDName(bool bUpdate = false);
    virtual uint16_t              GetPhysicalAddress(bool bSuppressUpdate = true);
    virtual cec_power_status      GetPowerStatus(bool bUpdate = false);
    virtual CCECProcessor *       GetProcessor(void) const { return m_processor; }
    virtual cec_device_type       GetType(void) const { return m_type; }
    virtual cec_vendor_id         GetVendorId(bool bUpdate = false);
    virtual const char *          GetVendorName(bool bUpdate = false);
    virtual bool                  MyLogicalAddressContains(cec_logical_address address) const;
    virtual cec_bus_device_status GetStatus(bool bForcePoll = false, bool bSuppressPoll = false);
    virtual bool                  IsActiveSource(void) const { return m_bActiveSource; }
    virtual bool                  IsUnsupportedFeature(cec_opcode opcode);
    virtual void                  SetUnsupportedFeature(cec_opcode opcode);
    virtual void                  HandlePoll(cec_logical_address destination);
    virtual void                  HandlePollFrom(cec_logical_address initiator);
    virtual bool                  HandleReceiveFailed(void);

    virtual void SetInactiveSource(void);
    virtual void SetActiveSource(void);
    virtual bool TryLogicalAddress(void);
    virtual bool ActivateSource(void);

    virtual void SetDeviceStatus(const cec_bus_device_status newStatus);
    virtual void SetPhysicalAddress(uint16_t iNewAddress);
    virtual void SetStreamPath(uint16_t iNewAddress, uint16_t iOldAddress = 0xFFFF);
    virtual void SetCecVersion(const cec_version newVersion);
    virtual void SetMenuLanguage(const cec_menu_language &menuLanguage);
    virtual void SetOSDName(CStdString strName);
    virtual void SetMenuState(const cec_menu_state state);
    virtual bool SetVendorId(uint64_t iVendorId);
    virtual void SetPowerStatus(const cec_power_status powerStatus);

    virtual bool TransmitActiveSource(void);
    virtual bool TransmitCECVersion(cec_logical_address dest);
    virtual bool TransmitImageViewOn(void);
    virtual bool TransmitInactiveSource(void);
    virtual bool TransmitMenuState(cec_logical_address dest);
    virtual bool TransmitOSDName(cec_logical_address dest);
    virtual bool TransmitOSDString(cec_logical_address dest, cec_display_control duration, const char *strMessage);
    virtual bool TransmitPhysicalAddress(void);
    virtual bool TransmitSetMenuLanguage(cec_logical_address dest);
    virtual bool TransmitPowerState(cec_logical_address dest);
    virtual bool TransmitPoll(cec_logical_address dest);
    virtual bool TransmitVendorID(cec_logical_address dest, bool bSendAbort = true);
    virtual bool TransmitKeypress(cec_user_control_code key, bool bWait = true);
    virtual bool TransmitKeyRelease(bool bWait = true);

    bool ReplaceHandler(bool bActivateSource = true);
    virtual bool TransmitPendingActiveSourceCommands(void);

  protected:
    void ResetDeviceStatus(void);
    void CheckVendorIdRequested(void);
    void MarkBusy(void);
    void MarkReady(void);

    bool RequestCecVersion(bool bWaitForResponse = true);
    bool RequestMenuLanguage(bool bWaitForResponse = true);
    bool RequestPowerStatus(bool bWaitForResponse = true);
    bool RequestVendorId(bool bWaitForResponse = true);
    bool RequestPhysicalAddress(bool bWaitForResponse = true);
    bool RequestOSDName(bool bWaitForResponse = true);

    bool NeedsPoll(void);

    cec_device_type       m_type;
    CStdString            m_strDeviceName;
    uint16_t              m_iPhysicalAddress;
    uint16_t              m_iStreamPath;
    cec_logical_address   m_iLogicalAddress;
    cec_power_status      m_powerStatus;
    cec_menu_language     m_menuLanguage;
    CCECProcessor      *  m_processor;
    CCECCommandHandler *  m_handler;
    cec_vendor_id         m_vendor;
    bool                  m_bReplaceHandler;
    cec_menu_state        m_menuState;
    bool                  m_bActiveSource;
    uint64_t              m_iLastActive;
    uint64_t              m_iLastPowerStateUpdate;
    cec_version           m_cecVersion;
    cec_bus_device_status m_deviceStatus;
    std::set<cec_opcode>  m_unsupportedFeatures;
    PLATFORM::CMutex      m_mutex;
    PLATFORM::CMutex      m_handlerMutex;
    PLATFORM::CEvent      m_replacing;
    unsigned              m_iHandlerUseCount;
    bool                  m_bAwaitingReceiveFailed;
    bool                  m_bVendorIdRequested;
  };
};
Commit	Line	Data
	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 bSuppressUpdate = true);
	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, bool bSuppressPoll = false);
	74	virtual bool IsActiveSource(void) const { return m_bActiveSource; }
	75	virtual bool IsUnsupportedFeature(cec_opcode opcode);
	76	virtual void SetUnsupportedFeature(cec_opcode opcode);
	77	virtual void HandlePoll(cec_logical_address destination);
	78	virtual void HandlePollFrom(cec_logical_address initiator);
	79	virtual bool HandleReceiveFailed(void);
	80
	81	virtual void SetInactiveSource(void);
	82	virtual void SetActiveSource(void);
	83	virtual bool TryLogicalAddress(void);
	84	virtual bool ActivateSource(void);
	85
	86	virtual void SetDeviceStatus(const cec_bus_device_status newStatus);
	87	virtual void SetPhysicalAddress(uint16_t iNewAddress);
	88	virtual void SetStreamPath(uint16_t iNewAddress, uint16_t iOldAddress = 0xFFFF);
	89	virtual void SetCecVersion(const cec_version newVersion);
	90	virtual void SetMenuLanguage(const cec_menu_language &menuLanguage);
	91	virtual void SetOSDName(CStdString strName);
	92	virtual void SetMenuState(const cec_menu_state state);
	93	virtual bool SetVendorId(uint64_t iVendorId);
	94	virtual void SetPowerStatus(const cec_power_status powerStatus);
	95
	96	virtual bool TransmitActiveSource(void);
	97	virtual bool TransmitCECVersion(cec_logical_address dest);
	98	virtual bool TransmitImageViewOn(void);
	99	virtual bool TransmitInactiveSource(void);
	100	virtual bool TransmitMenuState(cec_logical_address dest);
	101	virtual bool TransmitOSDName(cec_logical_address dest);
	102	virtual bool TransmitOSDString(cec_logical_address dest, cec_display_control duration, const char *strMessage);
	103	virtual bool TransmitPhysicalAddress(void);
	104	virtual bool TransmitSetMenuLanguage(cec_logical_address dest);
	105	virtual bool TransmitPowerState(cec_logical_address dest);
	106	virtual bool TransmitPoll(cec_logical_address dest);
	107	virtual bool TransmitVendorID(cec_logical_address dest, bool bSendAbort = true);
	108	virtual bool TransmitKeypress(cec_user_control_code key, bool bWait = true);
	109	virtual bool TransmitKeyRelease(bool bWait = true);
	110
	111	bool ReplaceHandler(bool bActivateSource = true);
	112	virtual bool TransmitPendingActiveSourceCommands(void);
	113
	114	protected:
	115	void ResetDeviceStatus(void);
	116	void CheckVendorIdRequested(void);
	117	void MarkBusy(void);
	118	void MarkReady(void);
	119
	120	bool RequestCecVersion(bool bWaitForResponse = true);
	121	bool RequestMenuLanguage(bool bWaitForResponse = true);
	122	bool RequestPowerStatus(bool bWaitForResponse = true);
	123	bool RequestVendorId(bool bWaitForResponse = true);
	124	bool RequestPhysicalAddress(bool bWaitForResponse = true);
	125	bool RequestOSDName(bool bWaitForResponse = true);
	126
	127	bool NeedsPoll(void);
	128
	129	cec_device_type m_type;
	130	CStdString m_strDeviceName;
	131	uint16_t m_iPhysicalAddress;
	132	uint16_t m_iStreamPath;
	133	cec_logical_address m_iLogicalAddress;
	134	cec_power_status m_powerStatus;
	135	cec_menu_language m_menuLanguage;
	136	CCECProcessor * m_processor;
	137	CCECCommandHandler * m_handler;
	138	cec_vendor_id m_vendor;
	139	bool m_bReplaceHandler;
	140	cec_menu_state m_menuState;
	141	bool m_bActiveSource;
	142	uint64_t m_iLastActive;
	143	uint64_t m_iLastPowerStateUpdate;
	144	cec_version m_cecVersion;
	145	cec_bus_device_status m_deviceStatus;
	146	std::set<cec_opcode> m_unsupportedFeatures;
	147	PLATFORM::CMutex m_mutex;
	148	PLATFORM::CMutex m_handlerMutex;
	149	PLATFORM::CEvent m_replacing;
	150	unsigned m_iHandlerUseCount;
	151	bool m_bAwaitingReceiveFailed;
	152	bool m_bVendorIdRequested;
	153	};
	154	};