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