cec: keep the 'busy state' of the command handler in CCECBusDevice
[deb_libcec.git] / src / lib / implementations / CECCommandHandler.h
CommitLineData
e9de9629
LOK
1#pragma once
2/*
3 * This file is part of the libCEC(R) library.
4 *
b492c10e 5 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
e9de9629
LOK
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
4c9b9776 34#include "../../../include/cectypes.h"
8747dd4f 35#include <vector>
ba65909d
LOK
36#include "../platform/threads/mutex.h"
37#include "../platform/util/StdString.h"
e9de9629
LOK
38
39namespace CEC
40{
fcf10e27 41 class CCECProcessor;
e9de9629
LOK
42 class CCECBusDevice;
43
44 class CCECCommandHandler
45 {
46 public:
47 CCECCommandHandler(CCECBusDevice *busDevice);
8fa35473 48 virtual ~CCECCommandHandler(void);
e9de9629
LOK
49
50 virtual bool HandleCommand(const cec_command &command);
cf4931be
LOK
51 virtual cec_vendor_id GetVendorId(void) { return m_vendorId; };
52 virtual void SetVendorId(cec_vendor_id vendorId) { m_vendorId = vendorId; }
2e49a6e4 53 static bool HasSpecificHandler(cec_vendor_id vendorId) { return vendorId == CEC_VENDOR_LG || vendorId == CEC_VENDOR_SAMSUNG || vendorId == CEC_VENDOR_PANASONIC;}
e9de9629 54
3e61b350
LOK
55 virtual bool InitHandler(void) { return true; }
56 virtual bool ActivateSource(void);
e107f073 57 virtual uint8_t GetTransmitRetries(void) const { return m_iTransmitRetries; }
8d915412 58
b64db02e 59 virtual bool TransmitImageViewOn(const cec_logical_address iInitiator, const cec_logical_address iDestination);
8fa35473
LOK
60 virtual bool TransmitStandby(const cec_logical_address iInitiator, const cec_logical_address iDestination);
61 virtual bool TransmitRequestCecVersion(const cec_logical_address iInitiator, const cec_logical_address iDestination);
62 virtual bool TransmitRequestMenuLanguage(const cec_logical_address iInitiator, const cec_logical_address iDestination);
63 virtual bool TransmitRequestOSDName(const cec_logical_address iInitiator, const cec_logical_address iDestination);
64 virtual bool TransmitRequestPhysicalAddress(const cec_logical_address iInitiator, const cec_logical_address iDestination);
65 virtual bool TransmitRequestPowerStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination);
66 virtual bool TransmitRequestVendorId(const cec_logical_address iInitiator, const cec_logical_address iDestination);
67 virtual bool TransmitActiveSource(const cec_logical_address iInitiator, uint16_t iPhysicalAddress);
68 virtual bool TransmitCECVersion(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_version cecVersion);
69 virtual bool TransmitInactiveSource(const cec_logical_address iInitiator, uint16_t iPhysicalAddress);
70 virtual bool TransmitMenuState(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_menu_state menuState);
71 virtual bool TransmitOSDName(const cec_logical_address iInitiator, const cec_logical_address iDestination, CStdString strDeviceName);
72 virtual bool TransmitOSDString(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_display_control duration, const char *strMessage);
73 virtual bool TransmitPhysicalAddress(const cec_logical_address iInitiator, uint16_t iPhysicalAddress, cec_device_type type);
74 virtual bool TransmitPoll(const cec_logical_address iInitiator, const cec_logical_address iDestination);
75 virtual bool TransmitPowerState(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_power_status state);
76 virtual bool TransmitVendorID(const cec_logical_address iInitiator, uint64_t iVendorId);
77 virtual bool TransmitAudioStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, uint8_t state);
78 virtual bool TransmitSetSystemAudioMode(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_system_audio_status state);
79 virtual bool TransmitSystemAudioModeStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_system_audio_status state);
80 virtual bool TransmitDeckStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_deck_info state);
4bec9d79
LOK
81 virtual bool TransmitKeypress(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
82 virtual bool TransmitKeyRelease(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWait = true);
f42d3e0f 83 virtual bool TransmitSetStreamPath(uint16_t iStreamPath);
7b74fdfb
LOK
84 virtual bool SendDeckStatusUpdateOnActiveSource(void) const { return m_bOPTSendDeckStatusUpdateOnActiveSource; };
85
e9de9629 86 protected:
be5b0e24 87 virtual bool HandleActiveSource(const cec_command &command);
a9232a79 88 virtual bool HandleDeckControl(const cec_command &command);
a1f8fb1b
LOK
89 virtual bool HandleDeviceCecVersion(const cec_command &command);
90 virtual bool HandleDeviceVendorCommandWithId(const cec_command &command);
91 virtual bool HandleDeviceVendorId(const cec_command &command);
4d738fe3 92 virtual bool HandleFeatureAbort(const cec_command &command);
a1f8fb1b
LOK
93 virtual bool HandleGetCecVersion(const cec_command &command);
94 virtual bool HandleGiveAudioStatus(const cec_command &command);
95 virtual bool HandleGiveDeckStatus(const cec_command &command);
96 virtual bool HandleGiveDevicePowerStatus(const cec_command &command);
97 virtual bool HandleGiveDeviceVendorId(const cec_command &command);
98 virtual bool HandleGiveOSDName(const cec_command &command);
99 virtual bool HandleGivePhysicalAddress(const cec_command &command);
1a6669b8
LOK
100 virtual bool HandleGiveSystemAudioModeStatus(const cec_command &command);
101 virtual bool HandleImageViewOn(const cec_command &command);
a1f8fb1b 102 virtual bool HandleMenuRequest(const cec_command &command);
15d1a84c 103 virtual bool HandleReportAudioStatus(const cec_command &command);
907bd60f 104 virtual bool HandleReportPhysicalAddress(const cec_command &command);
a1f8fb1b
LOK
105 virtual bool HandleReportPowerStatus(const cec_command &command);
106 virtual bool HandleRequestActiveSource(const cec_command &command);
107 virtual bool HandleRoutingChange(const cec_command &command);
907bd60f 108 virtual bool HandleRoutingInformation(const cec_command &command);
a1f8fb1b 109 virtual bool HandleSetMenuLanguage(const cec_command &command);
15d1a84c 110 virtual bool HandleSetOSDName(const cec_command &command);
a1f8fb1b 111 virtual bool HandleSetStreamPath(const cec_command &command);
aa517a0d 112 virtual bool HandleSystemAudioModeRequest(const cec_command &command);
4d6b4433 113 virtual bool HandleStandby(const cec_command &command);
aa517a0d
LOK
114 virtual bool HandleSystemAudioModeStatus(const cec_command &command);
115 virtual bool HandleSetSystemAudioMode(const cec_command &command);
1a6669b8 116 virtual bool HandleTextViewOn(const cec_command &command);
a1f8fb1b
LOK
117 virtual bool HandleUserControlPressed(const cec_command &command);
118 virtual bool HandleUserControlRelease(const cec_command &command);
1de6617c 119 virtual bool HandleVendorCommand(const cec_command &command);
a1f8fb1b 120 virtual void UnhandledCommand(const cec_command &command);
e9de9629 121
6f14b512 122 virtual size_t GetMyDevices(std::vector<CCECBusDevice *> &devices) const;
a1f8fb1b 123 virtual CCECBusDevice *GetDevice(cec_logical_address iLogicalAddress) const;
6685ae07 124 virtual CCECBusDevice *GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress) const;
c4098482 125 virtual CCECBusDevice *GetDeviceByType(cec_device_type type) const;
181b3475 126
8fa35473 127 virtual bool SetVendorId(const cec_command &command);
16b1e052
LOK
128 virtual void SetPhysicalAddress(cec_logical_address iAddress, uint16_t iNewAddress);
129
446c0cfc 130 virtual bool Transmit(cec_command &command, bool bExpectResponse = true, cec_opcode expectedResponse = CEC_OPCODE_NONE);
8fa35473 131
960f33c6
LOK
132 CCECBusDevice * m_busDevice;
133 CCECProcessor * m_processor;
134 int32_t m_iTransmitTimeout;
135 int32_t m_iTransmitWait;
136 int8_t m_iTransmitRetries;
137 bool m_bHandlerInited;
960f33c6
LOK
138 cec_opcode m_expectedResponse;
139 bool m_bOPTSendDeckStatusUpdateOnActiveSource;
140 cec_vendor_id m_vendorId;
141 PLATFORM::CMutex m_receiveMutex;
142 PLATFORM::CCondition<volatile bool &> m_condition;
143 volatile bool m_bRcvSignal;
e9de9629
LOK
144 };
145};