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