cec: display an alert message when the firmware of the adapter can be upgraded. bugzi...
[deb_libcec.git] / src / lib / devices / CECBusDevice.h
... / ...
CommitLineData
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
39namespace 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 = CEC_INVALID_PHYSICAL_ADDRESS);
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 = CEC_INVALID_PHYSICAL_ADDRESS);
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 virtual bool RequestActiveSource(bool bWaitForResponse = true);
115
116 protected:
117 void ResetDeviceStatus(void);
118 void CheckVendorIdRequested(void);
119 void MarkBusy(void);
120 void MarkReady(void);
121
122 bool RequestCecVersion(bool bWaitForResponse = true);
123 bool RequestMenuLanguage(bool bWaitForResponse = true);
124 bool RequestPowerStatus(bool bWaitForResponse = true);
125 bool RequestVendorId(bool bWaitForResponse = true);
126 bool RequestPhysicalAddress(bool bWaitForResponse = true);
127 bool RequestOSDName(bool bWaitForResponse = true);
128
129 bool NeedsPoll(void);
130
131 cec_device_type m_type;
132 CStdString m_strDeviceName;
133 uint16_t m_iPhysicalAddress;
134 uint16_t m_iStreamPath;
135 cec_logical_address m_iLogicalAddress;
136 cec_power_status m_powerStatus;
137 cec_menu_language m_menuLanguage;
138 CCECProcessor * m_processor;
139 CCECCommandHandler * m_handler;
140 cec_vendor_id m_vendor;
141 bool m_bReplaceHandler;
142 cec_menu_state m_menuState;
143 bool m_bActiveSource;
144 uint64_t m_iLastActive;
145 uint64_t m_iLastPowerStateUpdate;
146 cec_version m_cecVersion;
147 cec_bus_device_status m_deviceStatus;
148 std::set<cec_opcode> m_unsupportedFeatures;
149 PLATFORM::CMutex m_mutex;
150 PLATFORM::CMutex m_handlerMutex;
151 PLATFORM::CEvent m_replacing;
152 unsigned m_iHandlerUseCount;
153 bool m_bAwaitingReceiveFailed;
154 bool m_bVendorIdRequested;
155 };
156};