Merge branch 'master' into release
[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 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 <cectypes.h>
36 #include "AdapterCommunication.h"
37 #include "platform/threads.h"
38 #include "util/buffer.h"
39 #include "util/StdString.h"
40
41 class CSerialPort;
42
43 namespace CEC
44 {
45 class CLibCEC;
46 class CAdapterCommunication;
47 class CCECBusDevice;
48
49 class CCECProcessor : public CThread
50 {
51 public:
52 CCECProcessor(CLibCEC *controller, const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
53 CCECProcessor(CLibCEC *controller, const char *strDeviceName, const cec_device_type_list &types);
54 virtual ~CCECProcessor(void);
55
56 virtual bool Start(const char *strPort, uint16_t iBaudRate = 38400, uint32_t iTimeoutMs = 10000);
57 virtual void *Process(void);
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 cec_version GetDeviceCecVersion(cec_logical_address iAddress);
63 virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
64 virtual const std::string & GetDeviceName(void) { return m_strDeviceName; }
65 virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
66 virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress);
67 virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
68 virtual cec_logical_address GetLogicalAddress(void) const { return m_logicalAddresses.primary; }
69 virtual cec_logical_addresses GetLogicalAddresses(void) const { return m_logicalAddresses; }
70 virtual cec_logical_addresses GetActiveDevices(void);
71 virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress);
72 virtual bool HasLogicalAddress(cec_logical_address address) const { return m_logicalAddresses.IsSet(address); }
73 virtual bool IsPresentDevice(cec_logical_address address);
74 virtual bool IsPresentDeviceType(cec_device_type type);
75 virtual uint16_t GetPhysicalAddress(void) const;
76 virtual uint64_t GetLastTransmission(void) const { return m_iLastTransmission; }
77 virtual bool IsStarted(void) const { return m_bStarted; }
78 virtual cec_logical_address GetActiveSource(void);
79 virtual bool IsActiveSource(cec_logical_address iAddress);
80
81 virtual bool SetActiveView(void);
82 virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
83 virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
84 virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
85 virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort, bool bForce = false);
86 virtual bool TransmitInactiveSource(void);
87 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress);
88 virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
89 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress);
90 virtual bool SetActiveSource(uint16_t iStreamPath);
91 virtual bool SwitchMonitoring(bool bEnable);
92 virtual bool PollDevice(cec_logical_address iAddress);
93 virtual uint8_t VolumeUp(void);
94 virtual uint8_t VolumeDown(void);
95 virtual uint8_t MuteAudio(void);
96 virtual bool TransmitKeypress(cec_logical_address iDestination, cec_user_control_code key);
97 virtual bool TransmitKeyRelease(cec_logical_address iDestination);
98 virtual bool EnablePhysicalAddressDetection(void) { return false; };
99 void SetStandardLineTimeout(uint8_t iTimeout);
100 void SetRetryLineTimeout(uint8_t iTimeout);
101
102 bool SetLineTimeout(uint8_t iTimeout);
103
104 const char *ToString(const cec_menu_state state);
105 const char *ToString(const cec_version version);
106 const char *ToString(const cec_power_status status);
107 const char *ToString(const cec_logical_address address);
108 const char *ToString(const cec_deck_control_mode mode);
109 const char *ToString(const cec_deck_info status);
110 const char *ToString(const cec_opcode opcode);
111 const char *ToString(const cec_system_audio_status mode);
112 const char *ToString(const cec_audio_status status);
113 const char *ToString(const cec_vendor_id vendor);
114
115 virtual bool Transmit(const cec_command &data);
116 virtual bool Transmit(CCECAdapterMessage *output);
117 virtual void TransmitAbort(cec_logical_address address, cec_opcode opcode, cec_abort_reason reason = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE);
118
119 virtual void SetCurrentButton(cec_user_control_code iButtonCode);
120 virtual void AddCommand(const cec_command &command);
121 virtual void AddKey(cec_keypress &key);
122 virtual void AddKey(void);
123 virtual void AddLog(cec_log_level level, const CStdString &strMessage);
124
125 virtual bool FindLogicalAddresses(void);
126 virtual bool SetAckMask(uint16_t iMask);
127
128 virtual bool StartBootloader(void);
129 virtual bool PingAdapter(void);
130
131 CCECBusDevice *m_busDevices[16];
132 CMutex m_transmitMutex;
133
134 private:
135 void ScanCECBus(void);
136 bool PhysicalAddressInUse(uint16_t iPhysicalAddress);
137 bool TryLogicalAddress(cec_logical_address address);
138 bool FindLogicalAddressRecordingDevice(void);
139 bool FindLogicalAddressTuner(void);
140 bool FindLogicalAddressPlaybackDevice(void);
141 bool FindLogicalAddressAudioSystem(void);
142
143 void LogOutput(const cec_command &data);
144 bool WaitForTransmitSucceeded(CCECAdapterMessage *message);
145 bool ParseMessage(const CCECAdapterMessage &msg);
146 void ParseCommand(cec_command &command);
147
148 bool m_bStarted;
149 uint8_t m_iHDMIPort;
150 cec_logical_address m_iBaseDevice;
151 cec_command m_currentframe;
152 cec_logical_addresses m_logicalAddresses;
153 cec_logical_address m_lastInitiator;
154 std::string m_strDeviceName;
155 cec_device_type_list m_types;
156 CMutex m_mutex;
157 CCondition m_startCondition;
158 CAdapterCommunication* m_communication;
159 CLibCEC* m_controller;
160 bool m_bMonitor;
161 CecBuffer<cec_command> m_commandBuffer;
162 cec_keypress m_previousKey;
163 CThread * m_busScan;
164 uint8_t m_iLineTimeout;
165 uint8_t m_iStandardLineTimeout;
166 uint8_t m_iRetryLineTimeout;
167 uint64_t m_iLastTransmission;
168 };
169
170 class CCECBusScan : public CThread
171 {
172 public:
173 CCECBusScan(CCECProcessor *processor) { m_processor = processor; }
174 virtual ~CCECBusScan(void) { StopThread(true); }
175 virtual void *Process(void);
176
177 private:
178 void WaitUntilIdle(void);
179
180 CCECProcessor *m_processor;
181 };
182 };