50d6bf253b6376d8e3d9be90e8e1a77148d30a63
[deb_libcec.git] / src / lib / CECProcessor.h
1 #pragma once
2 /*
3 * This file is part of the libCEC(R) library.
4 *
5 * libCEC(R) is Copyright (C) 2011-2012 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 <string>
35 #include "../../include/cectypes.h"
36 #include "platform/threads/threads.h"
37 #include "platform/util/buffer.h"
38 #include "adapter/AdapterCommunication.h"
39
40 namespace CEC
41 {
42 class CLibCEC;
43 struct IAdapterCommunication;
44 class CCECBusDevice;
45
46 class CCECProcessor : public PLATFORM::CThread, public IAdapterCommunicationCallback
47 {
48 public:
49 CCECProcessor(CLibCEC *controller, const char *strDeviceName, const cec_device_type_list &types, uint16_t iPhysicalAddress, cec_client_version clientVersion);
50 CCECProcessor(CLibCEC *controller, const libcec_configuration *configuration);
51 virtual ~CCECProcessor(void);
52
53 virtual bool Start(const char *strPort, uint16_t iBaudRate = 38400, uint32_t iTimeoutMs = 10000);
54 virtual void *Process(void);
55 virtual void Close(void);
56
57 virtual bool OnCommandReceived(const cec_command &command);
58
59 virtual bool IsMonitoring(void) const { return m_bMonitor; }
60 virtual CCECBusDevice * GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress, bool bRefresh = false) const;
61 virtual CCECBusDevice * GetDeviceByType(cec_device_type type) const;
62 virtual CCECBusDevice * GetPrimaryDevice(void) const;
63 virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress);
64 virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
65 virtual const std::string & GetDeviceName(void) { return m_strDeviceName; }
66 virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
67 virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress);
68 virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
69 virtual cec_logical_address GetLogicalAddress(void) const { return m_logicalAddresses.primary; }
70 virtual cec_logical_addresses GetLogicalAddresses(void) const { return m_logicalAddresses; }
71 virtual cec_logical_addresses GetActiveDevices(void);
72 virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress);
73 virtual bool HasLogicalAddress(cec_logical_address address) const { return m_logicalAddresses.IsSet(address); }
74 virtual bool IsPresentDevice(cec_logical_address address);
75 virtual bool IsPresentDeviceType(cec_device_type type);
76 virtual uint16_t GetPhysicalAddress(void) const;
77 virtual uint64_t GetLastTransmission(void) const { return m_iLastTransmission; }
78 virtual cec_logical_address GetActiveSource(void);
79 virtual bool IsActiveSource(cec_logical_address iAddress);
80 virtual bool IsInitialised(void);
81 virtual bool SetStreamPath(uint16_t iPhysicalAddress);
82
83 virtual bool SetActiveView(void);
84 virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
85 virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
86 virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
87 virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort, bool bForce = false);
88 virtual bool TransmitInactiveSource(void);
89 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress);
90 virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
91 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress, bool bSendUpdate = true);
92 virtual bool SetActiveSource(uint16_t iStreamPath);
93 virtual bool SwitchMonitoring(bool bEnable);
94 virtual bool PollDevice(cec_logical_address iAddress);
95 virtual uint8_t VolumeUp(bool bSendRelease = true);
96 virtual uint8_t VolumeDown(bool bSendRelease = true);
97 virtual uint8_t MuteAudio(bool bSendRelease = true);
98 virtual bool TransmitKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
99 virtual bool TransmitKeyRelease(cec_logical_address iDestination, bool bWait = true);
100 virtual bool EnablePhysicalAddressDetection(void) { return false; };
101 void SetStandardLineTimeout(uint8_t iTimeout);
102 void SetRetryLineTimeout(uint8_t iTimeout);
103 virtual bool GetCurrentConfiguration(libcec_configuration *configuration);
104
105 bool SetLineTimeout(uint8_t iTimeout);
106
107 const char *ToString(const cec_device_type type);
108 const char *ToString(const cec_menu_state state);
109 const char *ToString(const cec_version version);
110 const char *ToString(const cec_power_status status);
111 const char *ToString(const cec_logical_address address);
112 const char *ToString(const cec_deck_control_mode mode);
113 const char *ToString(const cec_deck_info status);
114 const char *ToString(const cec_opcode opcode);
115 const char *ToString(const cec_system_audio_status mode);
116 const char *ToString(const cec_audio_status status);
117 const char *ToString(const cec_vendor_id vendor);
118 const char *ToString(const cec_client_version version);
119
120 virtual bool Transmit(const cec_command &data);
121 virtual void TransmitAbort(cec_logical_address address, cec_opcode opcode, cec_abort_reason reason = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE);
122
123 virtual bool ChangeDeviceType(cec_device_type from, cec_device_type to);
124 virtual bool FindLogicalAddresses(void);
125 virtual bool SetAckMask(uint16_t iMask);
126
127 virtual bool StartBootloader(void);
128 virtual bool PingAdapter(void);
129 virtual void HandlePoll(cec_logical_address initiator, cec_logical_address destination);
130 virtual bool HandleReceiveFailed(cec_logical_address initiator);
131
132 CCECBusDevice * m_busDevices[16];
133 PLATFORM::CMutex m_transmitMutex;
134
135 private:
136 bool OpenConnection(const char *strPort, uint16_t iBaudRate, uint32_t iTimeoutMs);
137 bool Initialise(void);
138 void SetInitialised(bool bSetTo = true);
139 void CreateBusDevices(void);
140
141 void ReplaceHandlers(void);
142 void ScanCECBus(void);
143 bool PhysicalAddressInUse(uint16_t iPhysicalAddress);
144 bool TryLogicalAddress(cec_logical_address address);
145 bool FindLogicalAddressRecordingDevice(void);
146 bool FindLogicalAddressTuner(void);
147 bool FindLogicalAddressPlaybackDevice(void);
148 bool FindLogicalAddressAudioSystem(void);
149
150 void LogOutput(const cec_command &data);
151 void ParseCommand(const cec_command &command);
152
153 bool m_bInitialised;
154 uint16_t m_iPhysicalAddress;
155 uint8_t m_iHDMIPort;
156 cec_logical_address m_iBaseDevice;
157 cec_logical_addresses m_logicalAddresses;
158 std::string m_strDeviceName;
159 cec_device_type_list m_types;
160 PLATFORM::CMutex m_mutex;
161 IAdapterCommunication * m_communication;
162 CLibCEC* m_controller;
163 bool m_bMonitor;
164 PLATFORM::SyncedBuffer<cec_command> m_commandBuffer;
165 cec_keypress m_previousKey;
166 PLATFORM::CThread * m_busScan;
167 uint8_t m_iLineTimeout;
168 uint8_t m_iStandardLineTimeout;
169 uint8_t m_iRetryLineTimeout;
170 uint64_t m_iLastTransmission;
171 cec_client_version m_clientVersion;
172 };
173
174 class CCECBusScan : public PLATFORM::CThread
175 {
176 public:
177 CCECBusScan(CCECProcessor *processor) { m_processor = processor; }
178 virtual ~CCECBusScan(void) { StopThread(true); }
179 virtual void *Process(void);
180
181 private:
182 void WaitUntilIdle(void);
183
184 CCECProcessor *m_processor;
185 };
186 };