cec: added typedefs for the callback methods
[deb_libcec.git] / src / lib / implementations / CECCommandHandler.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 <vector>
36 #include "../util/StdString.h"
37 #include "../platform/threads.h"
38
39 namespace CEC
40 {
41 class CCECProcessor;
42 class CCECBusDevice;
43
44 class CCECCommandHandler
45 {
46 public:
47 CCECCommandHandler(CCECBusDevice *busDevice);
48 virtual ~CCECCommandHandler(void);
49
50 virtual bool HandleCommand(const cec_command &command);
51 virtual cec_vendor_id GetVendorId(void) { return m_vendorId; };
52 virtual void SetVendorId(cec_vendor_id vendorId) { m_vendorId = vendorId; }
53 virtual void HandlePoll(const cec_logical_address iInitiator, const cec_logical_address iDestination);
54 virtual bool HandleReceiveFailed(void);
55 static bool HasSpecificHandler(cec_vendor_id vendorId) { return vendorId == CEC_VENDOR_LG || vendorId == CEC_VENDOR_SAMSUNG || vendorId == CEC_VENDOR_PANASONIC;}
56
57 virtual bool InitHandler(void) { return true; }
58 virtual bool ActivateSource(void);
59 virtual uint8_t GetTransmitRetries(void) const { return m_iTransmitRetries; }
60
61 virtual bool TransmitImageViewOn(const cec_logical_address iInitiator, const cec_logical_address iDestination);
62 virtual bool TransmitStandby(const cec_logical_address iInitiator, const cec_logical_address iDestination);
63 virtual bool TransmitRequestCecVersion(const cec_logical_address iInitiator, const cec_logical_address iDestination);
64 virtual bool TransmitRequestMenuLanguage(const cec_logical_address iInitiator, const cec_logical_address iDestination);
65 virtual bool TransmitRequestOSDName(const cec_logical_address iInitiator, const cec_logical_address iDestination);
66 virtual bool TransmitRequestPhysicalAddress(const cec_logical_address iInitiator, const cec_logical_address iDestination);
67 virtual bool TransmitRequestPowerStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination);
68 virtual bool TransmitRequestVendorId(const cec_logical_address iInitiator, const cec_logical_address iDestination);
69 virtual bool TransmitActiveSource(const cec_logical_address iInitiator, uint16_t iPhysicalAddress);
70 virtual bool TransmitCECVersion(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_version cecVersion);
71 virtual bool TransmitInactiveSource(const cec_logical_address iInitiator, uint16_t iPhysicalAddress);
72 virtual bool TransmitMenuState(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_menu_state menuState);
73 virtual bool TransmitOSDName(const cec_logical_address iInitiator, const cec_logical_address iDestination, CStdString strDeviceName);
74 virtual bool TransmitOSDString(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_display_control duration, const char *strMessage);
75 virtual bool TransmitPhysicalAddress(const cec_logical_address iInitiator, uint16_t iPhysicalAddress, cec_device_type type);
76 virtual bool TransmitPoll(const cec_logical_address iInitiator, const cec_logical_address iDestination);
77 virtual bool TransmitPowerState(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_power_status state);
78 virtual bool TransmitVendorID(const cec_logical_address iInitiator, uint64_t iVendorId);
79 virtual bool TransmitAudioStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, uint8_t state);
80 virtual bool TransmitSetSystemAudioMode(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_system_audio_status state);
81 virtual bool TransmitSystemAudioModeStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_system_audio_status state);
82 virtual bool TransmitDeckStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_deck_info state);
83 virtual bool TransmitKeypress(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
84 virtual bool TransmitKeyRelease(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWait = true);
85
86 virtual void MarkBusy(void);
87 virtual bool MarkReady(void);
88 virtual bool InUse(void);
89
90 virtual bool SendDeckStatusUpdateOnActiveSource(void) const { return m_bOPTSendDeckStatusUpdateOnActiveSource; };
91
92 protected:
93 virtual bool HandleActiveSource(const cec_command &command);
94 virtual bool HandleDeckControl(const cec_command &command);
95 virtual bool HandleDeviceCecVersion(const cec_command &command);
96 virtual bool HandleDeviceVendorCommandWithId(const cec_command &command);
97 virtual bool HandleDeviceVendorId(const cec_command &command);
98 virtual bool HandleFeatureAbort(const cec_command &command);
99 virtual bool HandleGetCecVersion(const cec_command &command);
100 virtual bool HandleGiveAudioStatus(const cec_command &command);
101 virtual bool HandleGiveDeckStatus(const cec_command &command);
102 virtual bool HandleGiveDevicePowerStatus(const cec_command &command);
103 virtual bool HandleGiveDeviceVendorId(const cec_command &command);
104 virtual bool HandleGiveOSDName(const cec_command &command);
105 virtual bool HandleGivePhysicalAddress(const cec_command &command);
106 virtual bool HandleGiveSystemAudioModeStatus(const cec_command &command);
107 virtual bool HandleImageViewOn(const cec_command &command);
108 virtual bool HandleMenuRequest(const cec_command &command);
109 virtual bool HandleReportAudioStatus(const cec_command &command);
110 virtual bool HandleReportPhysicalAddress(const cec_command &command);
111 virtual bool HandleReportPowerStatus(const cec_command &command);
112 virtual bool HandleRequestActiveSource(const cec_command &command);
113 virtual bool HandleRoutingChange(const cec_command &command);
114 virtual bool HandleRoutingInformation(const cec_command &command);
115 virtual bool HandleSetMenuLanguage(const cec_command &command);
116 virtual bool HandleSetOSDName(const cec_command &command);
117 virtual bool HandleSetStreamPath(const cec_command &command);
118 virtual bool HandleSystemAudioModeRequest(const cec_command &command);
119 virtual bool HandleStandby(const cec_command &command);
120 virtual bool HandleSystemAudioModeStatus(const cec_command &command);
121 virtual bool HandleSetSystemAudioMode(const cec_command &command);
122 virtual bool HandleTextViewOn(const cec_command &command);
123 virtual bool HandleUserControlPressed(const cec_command &command);
124 virtual bool HandleUserControlRelease(const cec_command &command);
125 virtual bool HandleVendorCommand(const cec_command &command);
126 virtual void UnhandledCommand(const cec_command &command);
127
128 virtual unsigned int GetMyDevices(std::vector<CCECBusDevice *> &devices) const;
129 virtual CCECBusDevice *GetDevice(cec_logical_address iLogicalAddress) const;
130 virtual CCECBusDevice *GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress) const;
131 virtual CCECBusDevice *GetDeviceByType(cec_device_type type) const;
132
133 virtual bool SetVendorId(const cec_command &command);
134 virtual void SetPhysicalAddress(cec_logical_address iAddress, uint16_t iNewAddress);
135
136 virtual bool Transmit(cec_command &command, bool bExpectResponse = true, cec_opcode expectedResponse = CEC_OPCODE_NONE);
137
138 CCECBusDevice *m_busDevice;
139 CCECProcessor *m_processor;
140 int32_t m_iTransmitTimeout;
141 int32_t m_iTransmitWait;
142 int8_t m_iTransmitRetries;
143 bool m_bHandlerInited;
144 uint8_t m_iUseCounter;
145 cec_opcode m_expectedResponse;
146 bool m_bOPTSendDeckStatusUpdateOnActiveSource;
147 cec_vendor_id m_vendorId;
148 CMutex m_receiveMutex;
149 CCondition m_condition;
150 };
151 };