sharp: check whether the 'auto power on' option is disabled and tell the user how...
[deb_libcec.git] / src / lib / implementations / CECCommandHandler.h
... / ...
CommitLineData
1#pragma once
2/*
3 * This file is part of the libCEC(R) library.
4 *
5 * libCEC(R) is Copyright (C) 2011-2013 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 <vector>
35#include <string>
36#include <map>
37#include "lib/platform/threads/mutex.h"
38
39namespace CEC
40{
41 #define COMMAND_HANDLED 0xFF
42
43 class CCECProcessor;
44 class CCECBusDevice;
45
46 class CCECCommandHandler
47 {
48 friend class CCECBusDevice;
49
50 public:
51 CCECCommandHandler(CCECBusDevice *busDevice,
52 int32_t iTransmitTimeout = CEC_DEFAULT_TRANSMIT_TIMEOUT,
53 int32_t iTransmitWait = CEC_DEFAULT_TRANSMIT_WAIT,
54 int8_t iTransmitRetries = CEC_DEFAULT_TRANSMIT_RETRIES,
55 int64_t iActiveSourcePending = 0);
56 virtual ~CCECCommandHandler(void) {};
57
58 virtual bool HandleCommand(const cec_command &command);
59 virtual cec_vendor_id GetVendorId(void) { return m_vendorId; };
60 virtual void SetVendorId(cec_vendor_id vendorId) { m_vendorId = vendorId; }
61 static bool HasSpecificHandler(cec_vendor_id vendorId) { return vendorId == CEC_VENDOR_LG || vendorId == CEC_VENDOR_SAMSUNG || vendorId == CEC_VENDOR_PANASONIC || vendorId == CEC_VENDOR_PHILIPS || vendorId == CEC_VENDOR_SHARP;}
62
63 virtual bool InitHandler(void) { return true; }
64 virtual bool ActivateSource(bool bTransmitDelayedCommandsOnly = false);
65 virtual uint8_t GetTransmitRetries(void) const { return m_iTransmitRetries; }
66
67 virtual bool PowerOn(const cec_logical_address iInitiator, const cec_logical_address iDestination);
68 virtual bool TransmitImageViewOn(const cec_logical_address iInitiator, const cec_logical_address iDestination);
69 virtual bool TransmitStandby(const cec_logical_address iInitiator, const cec_logical_address iDestination);
70 virtual bool TransmitRequestActiveSource(const cec_logical_address iInitiator, bool bWaitForResponse = true);
71 virtual bool TransmitRequestCecVersion(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
72 virtual bool TransmitRequestMenuLanguage(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
73 virtual bool TransmitRequestOSDName(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
74 virtual bool TransmitRequestAudioStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
75 virtual bool TransmitRequestPhysicalAddress(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
76 virtual bool TransmitRequestPowerStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bUpdate, bool bWaitForResponse = true);
77 virtual bool TransmitRequestVendorId(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
78 virtual bool TransmitActiveSource(const cec_logical_address iInitiator, uint16_t iPhysicalAddress, bool bIsReply);
79 virtual bool TransmitCECVersion(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_version cecVersion, bool bIsReply);
80 virtual bool TransmitInactiveSource(const cec_logical_address iInitiator, uint16_t iPhysicalAddress);
81 virtual bool TransmitMenuState(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_menu_state menuState, bool bIsReply);
82 virtual bool TransmitOSDName(const cec_logical_address iInitiator, const cec_logical_address iDestination, std::string strDeviceName, bool bIsReply);
83 virtual bool TransmitOSDString(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_display_control duration, const char *strMessage, bool bIsReply);
84 virtual bool TransmitPhysicalAddress(const cec_logical_address iInitiator, uint16_t iPhysicalAddress, cec_device_type type, bool bIsReply);
85 virtual bool TransmitSetMenuLanguage(const cec_logical_address iInitiator, const char lang[4], bool bIsReply);
86 virtual bool TransmitPoll(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bIsReply);
87 virtual bool TransmitPowerState(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_power_status state, bool bIsReply);
88 virtual bool TransmitVendorID(const cec_logical_address iInitiator, const cec_logical_address iDestination, uint64_t iVendorId, bool bIsReply);
89 virtual bool TransmitAudioStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, uint8_t state, bool bIsReply);
90 virtual bool TransmitSetSystemAudioMode(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_system_audio_status state, bool bIsReply);
91 virtual bool TransmitSystemAudioModeStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_system_audio_status state, bool bIsReply);
92 virtual bool TransmitDeckStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_deck_info state, bool bIsReply);
93 virtual bool TransmitKeypress(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
94 virtual bool TransmitKeyRelease(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWait = true);
95 virtual bool TransmitSetStreamPath(uint16_t iStreamPath, bool bIsReply);
96 virtual bool SendDeckStatusUpdateOnActiveSource(void) const { return m_bOPTSendDeckStatusUpdateOnActiveSource; };
97
98 virtual void ScheduleActivateSource(uint64_t iDelay);
99
100 virtual bool SupportsDeviceType(const cec_device_type UNUSED(type)) const { return true; };
101 virtual cec_device_type GetReplacementDeviceType(const cec_device_type type) const { return type; }
102 virtual bool ActiveSourcePending(void) const { return m_iActiveSourcePending != 0; }
103
104 protected:
105 virtual int HandleActiveSource(const cec_command &command);
106 virtual int HandleDeckControl(const cec_command &command);
107 virtual int HandleDeviceCecVersion(const cec_command &command);
108 virtual int HandleDeviceVendorCommandWithId(const cec_command &command);
109 virtual int HandleDeviceVendorId(const cec_command &command);
110 virtual int HandleFeatureAbort(const cec_command &command);
111 virtual int HandleGetCecVersion(const cec_command &command);
112 virtual int HandleGiveAudioStatus(const cec_command &command);
113 virtual int HandleGiveDeckStatus(const cec_command &command);
114 virtual int HandleGiveDevicePowerStatus(const cec_command &command);
115 virtual int HandleGiveDeviceVendorId(const cec_command &command);
116 virtual int HandleGiveOSDName(const cec_command &command);
117 virtual int HandleGivePhysicalAddress(const cec_command &command);
118 virtual int HandleGiveMenuLanguage(const cec_command &command);
119 virtual int HandleGiveSystemAudioModeStatus(const cec_command &command);
120 virtual int HandleImageViewOn(const cec_command &command);
121 virtual int HandleMenuRequest(const cec_command &command);
122 virtual bool HandlePoll(const cec_command &command);
123 virtual int HandleReportAudioStatus(const cec_command &command);
124 virtual int HandleReportPhysicalAddress(const cec_command &command);
125 virtual int HandleReportPowerStatus(const cec_command &command);
126 virtual int HandleRequestActiveSource(const cec_command &command);
127 virtual int HandleRoutingChange(const cec_command &command);
128 virtual int HandleRoutingInformation(const cec_command &command);
129 virtual int HandleSetMenuLanguage(const cec_command &command);
130 virtual int HandleSetOSDName(const cec_command &command);
131 virtual int HandleSetStreamPath(const cec_command &command);
132 virtual int HandleSystemAudioModeRequest(const cec_command &command);
133 virtual int HandleStandby(const cec_command &command);
134 virtual int HandleSystemAudioModeStatus(const cec_command &command);
135 virtual int HandleSetSystemAudioMode(const cec_command &command);
136 virtual int HandleTextViewOn(const cec_command &command);
137 virtual int HandleUserControlPressed(const cec_command &command);
138 virtual int HandleUserControlRelease(const cec_command &command);
139 virtual int HandleVendorCommand(const cec_command &command);
140 virtual int HandleVendorRemoteButtonDown(const cec_command& command);
141 virtual int HandleVendorRemoteButtonUp(const cec_command& command) { return HandleUserControlRelease(command); }
142 virtual void UnhandledCommand(const cec_command &command, const cec_abort_reason reason);
143 virtual void RequestEmailFromCustomer(const cec_command& command);
144
145 virtual void VendorPreActivateSourceHook(void) {};
146
147 virtual size_t GetMyDevices(std::vector<CCECBusDevice *> &devices) const;
148 virtual CCECBusDevice *GetDevice(cec_logical_address iLogicalAddress) const;
149 virtual CCECBusDevice *GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress) const;
150
151 virtual bool SetVendorId(const cec_command &command);
152 virtual void SetPhysicalAddress(cec_logical_address iAddress, uint16_t iNewAddress);
153
154 virtual bool Transmit(cec_command &command, bool bSuppressWait, bool bIsReply);
155
156 virtual bool SourceSwitchAllowed(void) { return true; }
157
158 CCECBusDevice * m_busDevice;
159 CCECProcessor * m_processor;
160 int32_t m_iTransmitTimeout;
161 int32_t m_iTransmitWait;
162 int8_t m_iTransmitRetries;
163 bool m_bHandlerInited;
164 bool m_bOPTSendDeckStatusUpdateOnActiveSource;
165 cec_vendor_id m_vendorId;
166 int64_t m_iActiveSourcePending;
167 PLATFORM::CMutex m_mutex;
168 int64_t m_iPowerStatusRequested;
169 std::map<cec_opcode, std::vector<cec_command> > m_logsRequested;
170 };
171};