updated changelog for 1.5.0
[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);
50 CCECProcessor(CLibCEC *controller, 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 CStdString GetDeviceName(void) const
66 {
67 CStdString strName;
68 strName = m_configuration.strDeviceName;
69 return strName;
70 }
71 virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
72 virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress);
73 virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
74 virtual cec_logical_address GetLogicalAddress(void) const { return m_logicalAddresses.primary; }
75 virtual cec_logical_addresses GetLogicalAddresses(void) const { return m_logicalAddresses; }
76 virtual cec_logical_addresses GetActiveDevices(void);
77 virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress);
78 virtual bool HasLogicalAddress(cec_logical_address address) const { return m_logicalAddresses.IsSet(address); }
79 virtual bool IsPresentDevice(cec_logical_address address);
80 virtual bool IsPresentDeviceType(cec_device_type type);
81 virtual uint16_t GetPhysicalAddress(void) const;
82 virtual uint64_t GetLastTransmission(void) const { return m_iLastTransmission; }
83 virtual cec_logical_address GetActiveSource(void);
84 virtual bool IsActiveSource(cec_logical_address iAddress);
85 virtual bool IsInitialised(void);
86 virtual bool SetStreamPath(uint16_t iPhysicalAddress);
87 virtual cec_client_version GetClientVersion(void) const { return (cec_client_version)m_configuration.clientVersion; };
88 virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST);
89 virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_BROADCAST);
90
91 virtual bool SetActiveView(void);
92 virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
93 virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
94 virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
95 virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort, bool bForce = false);
96 virtual bool TransmitInactiveSource(void);
97 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress);
98 virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
99 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress, bool bSendUpdate = true);
100 virtual bool SetActiveSource(uint16_t iStreamPath);
101 virtual bool SwitchMonitoring(bool bEnable);
102 virtual bool PollDevice(cec_logical_address iAddress);
103 virtual uint8_t VolumeUp(bool bSendRelease = true);
104 virtual uint8_t VolumeDown(bool bSendRelease = true);
105 virtual uint8_t MuteAudio(bool bSendRelease = true);
106 virtual bool TransmitKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
107 virtual bool TransmitKeyRelease(cec_logical_address iDestination, bool bWait = true);
108 virtual bool EnablePhysicalAddressDetection(void);
109 void SetStandardLineTimeout(uint8_t iTimeout);
110 void SetRetryLineTimeout(uint8_t iTimeout);
111 virtual bool GetCurrentConfiguration(libcec_configuration *configuration);
112 virtual bool SetConfiguration(const libcec_configuration *configuration);
113 virtual bool CanPersistConfiguration(void);
114 virtual bool PersistConfiguration(libcec_configuration *configuration);
115 virtual void RescanActiveDevices(void);
116
117 bool SetLineTimeout(uint8_t iTimeout);
118
119 const char *ToString(const cec_device_type type);
120 const char *ToString(const cec_menu_state state);
121 const char *ToString(const cec_version version);
122 const char *ToString(const cec_power_status status);
123 const char *ToString(const cec_logical_address address);
124 const char *ToString(const cec_deck_control_mode mode);
125 const char *ToString(const cec_deck_info status);
126 const char *ToString(const cec_opcode opcode);
127 const char *ToString(const cec_system_audio_status mode);
128 const char *ToString(const cec_audio_status status);
129 const char *ToString(const cec_vendor_id vendor);
130 const char *ToString(const cec_client_version version);
131 const char *ToString(const cec_server_version version);
132
133 virtual bool Transmit(const cec_command &data);
134 virtual void TransmitAbort(cec_logical_address address, cec_opcode opcode, cec_abort_reason reason = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE);
135
136 virtual bool ChangeDeviceType(cec_device_type from, cec_device_type to);
137 virtual bool FindLogicalAddresses(void);
138 virtual bool SetAckMask(uint16_t iMask);
139
140 virtual bool StartBootloader(void);
141 virtual bool PingAdapter(void);
142 virtual void HandlePoll(cec_logical_address initiator, cec_logical_address destination);
143 virtual bool HandleReceiveFailed(cec_logical_address initiator);
144
145 CCECBusDevice * m_busDevices[16];
146 PLATFORM::CMutex m_transmitMutex;
147
148 private:
149 bool OpenConnection(const char *strPort, uint16_t iBaudRate, uint32_t iTimeoutMs);
150 bool Initialise(void);
151 void SetInitialised(bool bSetTo = true);
152 void CreateBusDevices(void);
153
154 void ReplaceHandlers(void);
155 bool PhysicalAddressInUse(uint16_t iPhysicalAddress);
156 bool TryLogicalAddress(cec_logical_address address);
157 bool FindLogicalAddressRecordingDevice(void);
158 bool FindLogicalAddressTuner(void);
159 bool FindLogicalAddressPlaybackDevice(void);
160 bool FindLogicalAddressAudioSystem(void);
161
162 void LogOutput(const cec_command &data);
163 void ParseCommand(const cec_command &command);
164
165 bool m_bConnectionOpened;
166 bool m_bInitialised;
167 cec_logical_addresses m_logicalAddresses;
168 PLATFORM::CMutex m_mutex;
169 IAdapterCommunication * m_communication;
170 CLibCEC* m_controller;
171 bool m_bMonitor;
172 cec_keypress m_previousKey;
173 PLATFORM::CThread * m_busScan;
174 uint8_t m_iLineTimeout;
175 uint8_t m_iStandardLineTimeout;
176 uint8_t m_iRetryLineTimeout;
177 uint64_t m_iLastTransmission;
178 libcec_configuration m_configuration;
179 };
180
181 class CCECBusScan : public PLATFORM::CThread
182 {
183 public:
184 CCECBusScan(CCECProcessor *processor) { m_processor = processor; }
185 virtual ~CCECBusScan(void) { StopThread(true); }
186 virtual void *Process(void);
187
188 private:
189 void WaitUntilIdle(void);
190
191 CCECProcessor *m_processor;
192 };
193 };