cec: refactor CEC read/write. keep a single lock for all writes, not one per device
[deb_libcec.git] / src / lib / devices / CECBusDevice.h
CommitLineData
e9de9629
LOK
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
1b5cc4a2 34#include <cectypes.h>
eafa9d46
LOK
35#include "../platform/threads.h"
36#include "../util/StdString.h"
e9de9629
LOK
37
38namespace CEC
39{
40 class CCECProcessor;
1b5cc4a2 41 class CCECCommandHandler;
e9de9629
LOK
42
43 class CCECBusDevice
44 {
787a3cb8
LOK
45 friend class CCECProcessor;
46
e9de9629
LOK
47 public:
48 CCECBusDevice(CCECProcessor *processor, cec_logical_address address, uint16_t iPhysicalAddress = 0);
49 virtual ~CCECBusDevice(void);
50
38bdb943
LOK
51 virtual void AddLog(cec_log_level level, const CStdString &strMessage);
52 virtual bool HandleCommand(const cec_command &command);
38bdb943
LOK
53 virtual bool PowerOn(void);
54 virtual bool Standby(void);
55
f8ae3295
LOK
56 virtual cec_version GetCecVersion(void);
57 virtual CCECCommandHandler * GetHandler(void) const { return m_handler; };
5e5637c6 58 virtual uint64_t GetLastCommandSent(void) const;
f8ae3295
LOK
59 virtual uint64_t GetLastActive(void) const { return m_iLastActive; }
60 virtual cec_logical_address GetLogicalAddress(void) const { return m_iLogicalAddress; }
61 virtual const char* GetLogicalAddressName(void) const;
62 virtual cec_menu_language & GetMenuLanguage(void);
63 virtual cec_logical_address GetMyLogicalAddress(void) const;
64 virtual uint16_t GetMyPhysicalAddress(void) const;
ed21be2a 65 virtual CStdString GetOSDName(void);
16b1e052 66 virtual uint16_t GetPhysicalAddress(bool bRefresh = true);
f8ae3295
LOK
67 virtual cec_power_status GetPowerStatus(void);
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(void);
71 virtual const char * GetVendorName(void);
72 virtual bool MyLogicalAddressContains(cec_logical_address address) const;
9fd73dd4 73 virtual cec_bus_device_status GetStatus(bool bForcePoll = false);
e9de9629 74
f294b22f
LOK
75 bool RequestCecVersion(void);
76 bool RequestMenuLanguage(void);
77 bool RequestPowerStatus(void);
78 bool RequestVendorId(void);
16b1e052 79 bool RequestPhysicalAddress(void);
ed21be2a 80 bool RequestOSDName(void);
f294b22f 81
7856411b
LOK
82 virtual void SetInactiveDevice(void);
83 virtual void SetActiveDevice(void);
93fff5c1 84 virtual bool TryLogicalAddress(void);
7856411b 85
93fff5c1 86 virtual void SetDeviceStatus(const cec_bus_device_status newStatus);
9dc04b07
LOK
87 virtual void SetPhysicalAddress(uint16_t iNewAddress);
88 virtual void SetStreamPath(uint16_t iNewAddress, uint16_t iOldAddress = 0);
e55f3f70 89 virtual void SetCecVersion(const cec_version newVersion);
a3269a0a 90 virtual void SetMenuLanguage(const cec_menu_language &menuLanguage);
15d1a84c 91 virtual void SetOSDName(CStdString strName);
28fa6c97 92 virtual void SetMenuState(const cec_menu_state state);
8fa35473 93 virtual bool SetVendorId(uint64_t iVendorId, bool bInitHandler = true);
e55f3f70 94 virtual void SetPowerStatus(const cec_power_status powerStatus);
0ab58650 95
38bdb943 96 virtual bool TransmitActiveSource(void);
29912296 97 virtual bool TransmitCECVersion(cec_logical_address dest);
ab27363d 98 virtual bool TransmitInactiveSource(void);
29912296
LOK
99 virtual bool TransmitMenuState(cec_logical_address dest);
100 virtual bool TransmitOSDName(cec_logical_address dest);
38bdb943
LOK
101 virtual bool TransmitOSDString(cec_logical_address dest, cec_display_control duration, const char *strMessage);
102 virtual bool TransmitPhysicalAddress(void);
29912296 103 virtual bool TransmitPowerState(cec_logical_address dest);
93729720 104 virtual bool TransmitPoll(cec_logical_address dest);
29912296 105 virtual bool TransmitVendorID(cec_logical_address dest);
8fa35473
LOK
106 virtual bool SendKeypress(cec_user_control_code key);
107 virtual bool SendKeyRelease(void);
0f23c85c 108
e9de9629 109 protected:
9fd73dd4
LOK
110 bool NeedsPoll(void);
111
f8ae3295
LOK
112 cec_device_type m_type;
113 CStdString m_strDeviceName;
114 uint16_t m_iPhysicalAddress;
115 uint16_t m_iStreamPath;
116 cec_logical_address m_iLogicalAddress;
117 cec_power_status m_powerStatus;
118 cec_menu_language m_menuLanguage;
119 CCECProcessor * m_processor;
120 CCECCommandHandler * m_handler;
121 cec_vendor_id m_vendor;
122 cec_menu_state m_menuState;
123 bool m_bActiveSource;
124 uint64_t m_iLastCommandSent;
125 uint64_t m_iLastActive;
126 cec_version m_cecVersion;
127 cec_bus_device_status m_deviceStatus;
5e5637c6 128 CMutex m_writeMutex;
f8ae3295 129 CMutex m_mutex;
e9de9629
LOK
130 };
131};