cec: don't hack around the issue that samsung's vendor specific keypresses aren't...
[deb_libcec.git] / src / lib / CECProcessor.cpp
... / ...
CommitLineData
1/*
2 * This file is part of the libCEC(R) library.
3 *
4 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
5 * libCEC(R) is an original work, containing original code.
6 *
7 * libCEC(R) is a trademark of Pulse-Eight Limited.
8 *
9 * This program is dual-licensed; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 *
23 *
24 * Alternatively, you can license this library under a commercial license,
25 * please contact Pulse-Eight Licensing for more information.
26 *
27 * For more information contact:
28 * Pulse-Eight Licensing <license@pulse-eight.com>
29 * http://www.pulse-eight.com/
30 * http://www.pulse-eight.net/
31 */
32
33#include "CECProcessor.h"
34
35#include "AdapterCommunication.h"
36#include "devices/CECBusDevice.h"
37#include "LibCEC.h"
38#include "util/StdString.h"
39#include "platform/timeutils.h"
40
41using namespace CEC;
42using namespace std;
43
44CCECProcessor::CCECProcessor(CLibCEC *controller, CAdapterCommunication *serComm, const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS*/) :
45 m_iLogicalAddress(iLogicalAddress),
46 m_strDeviceName(strDeviceName),
47 m_communication(serComm),
48 m_controller(controller),
49 m_bMonitor(false)
50{
51 for (int iPtr = 0; iPtr < 16; iPtr++)
52 m_busDevices[iPtr] = new CCECBusDevice(this, (cec_logical_address) iPtr, iPtr == iLogicalAddress ? iPhysicalAddress : 0);
53}
54
55CCECProcessor::~CCECProcessor(void)
56{
57 m_startCondition.Broadcast();
58 StopThread();
59 m_communication = NULL;
60 m_controller = NULL;
61 for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
62 delete m_busDevices[iPtr];
63}
64
65bool CCECProcessor::Start(void)
66{
67 CLockObject lock(&m_mutex);
68 if (!m_communication || !m_communication->IsOpen())
69 {
70 m_controller->AddLog(CEC_LOG_ERROR, "connection is closed");
71 return false;
72 }
73
74 if (CreateThread())
75 {
76 if (!m_startCondition.Wait(&m_mutex))
77 {
78 m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
79 return false;
80 }
81 return true;
82 }
83 else
84 m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
85
86 return false;
87}
88
89void *CCECProcessor::Process(void)
90{
91 cec_command command;
92 CCECAdapterMessage msg;
93
94 SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
95
96 {
97 CLockObject lock(&m_mutex);
98 m_controller->AddLog(CEC_LOG_DEBUG, "processor thread started");
99 m_startCondition.Signal();
100 }
101
102 while (!IsStopped())
103 {
104 bool bParseFrame(false);
105 command.clear();
106 msg.clear();
107
108 {
109 CLockObject lock(&m_mutex);
110 if (m_communication->IsOpen() && m_communication->Read(msg, 50))
111 {
112 m_controller->AddLog(msg.is_error() ? CEC_LOG_WARNING : CEC_LOG_DEBUG, msg.ToString());
113 bParseFrame = ParseMessage(msg) && !IsStopped();
114 }
115
116 if (bParseFrame)
117 command = m_currentframe;
118 }
119
120 if (bParseFrame)
121 ParseCommand(command);
122
123 Sleep(5);
124
125 m_controller->CheckKeypressTimeout();
126
127 for (unsigned int iDevicePtr = 0; iDevicePtr < 16; iDevicePtr++)
128 m_busDevices[iDevicePtr]->PollVendorId();
129
130 Sleep(5);
131 }
132
133 return NULL;
134}
135
136bool CCECProcessor::SetActiveView(void)
137{
138 if (!IsRunning())
139 return false;
140
141 if (m_iLogicalAddress != CECDEVICE_UNKNOWN && m_busDevices[m_iLogicalAddress])
142 return m_busDevices[m_iLogicalAddress]->BroadcastActiveView();
143 return false;
144}
145
146bool CCECProcessor::SetInactiveView(void)
147{
148 if (!IsRunning())
149 return false;
150
151 if (m_iLogicalAddress != CECDEVICE_UNKNOWN && m_busDevices[m_iLogicalAddress])
152 return m_busDevices[m_iLogicalAddress]->BroadcastInactiveView();
153 return false;
154}
155
156void CCECProcessor::LogOutput(const cec_command &data)
157{
158 CStdString strTx;
159 strTx.Format("<< %02x:%02x", ((uint8_t)data.initiator << 4) + (uint8_t)data.destination, (uint8_t)data.opcode);
160
161 for (uint8_t iPtr = 0; iPtr < data.parameters.size; iPtr++)
162 strTx.AppendFormat(":%02x", data.parameters[iPtr]);
163 m_controller->AddLog(CEC_LOG_TRAFFIC, strTx.c_str());
164}
165
166bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress)
167{
168 if (m_iLogicalAddress != iLogicalAddress)
169 {
170 CStdString strLog;
171 strLog.Format("<< setting logical address to %1x", iLogicalAddress);
172 m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
173 m_iLogicalAddress = iLogicalAddress;
174 return SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
175 }
176
177 return true;
178}
179
180bool CCECProcessor::SetPhysicalAddress(uint16_t iPhysicalAddress)
181{
182 if (m_iLogicalAddress != CECDEVICE_UNKNOWN && m_busDevices[m_iLogicalAddress])
183 {
184 m_busDevices[m_iLogicalAddress]->SetPhysicalAddress(iPhysicalAddress);
185 return m_busDevices[m_iLogicalAddress]->BroadcastActiveView();
186 }
187 return false;
188}
189
190bool CCECProcessor::SwitchMonitoring(bool bEnable)
191{
192 CStdString strLog;
193 strLog.Format("== %s monitoring mode ==", bEnable ? "enabling" : "disabling");
194 m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
195
196 m_bMonitor = bEnable;
197 if (bEnable)
198 return SetAckMask(0);
199 else
200 return SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
201}
202
203cec_version CCECProcessor::GetDeviceCecVersion(cec_logical_address iAddress)
204{
205 return m_busDevices[iAddress]->GetCecVersion();
206}
207
208bool CCECProcessor::GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language)
209{
210 if (m_busDevices[iAddress])
211 {
212 *language = m_busDevices[iAddress]->GetMenuLanguage();
213 return (strcmp(language->language, "???") != 0);
214 }
215 return false;
216}
217
218uint64_t CCECProcessor::GetDeviceVendorId(cec_logical_address iAddress)
219{
220 if (m_busDevices[iAddress])
221 return m_busDevices[iAddress]->GetVendorId();
222 return false;
223}
224
225cec_power_status CCECProcessor::GetDevicePowerStatus(cec_logical_address iAddress)
226{
227 if (m_busDevices[iAddress])
228 return m_busDevices[iAddress]->GetPowerStatus();
229 return CEC_POWER_STATUS_UNKNOWN;
230}
231
232bool CCECProcessor::Transmit(const cec_command &data)
233{
234 bool bReturn(false);
235 LogOutput(data);
236
237 CCECAdapterMessage *output = new CCECAdapterMessage(data);
238 bReturn = Transmit(output);
239 delete output;
240
241 return bReturn;
242}
243
244bool CCECProcessor::Transmit(CCECAdapterMessage *output)
245{
246 bool bReturn(false);
247 CLockObject lock(&m_mutex);
248 {
249 CLockObject msgLock(&output->mutex);
250 if (!m_communication || !m_communication->Write(output))
251 return bReturn;
252 else
253 {
254 output->condition.Wait(&output->mutex);
255 if (output->state != ADAPTER_MESSAGE_STATE_SENT)
256 {
257 m_controller->AddLog(CEC_LOG_ERROR, "command was not sent");
258 return bReturn;
259 }
260 }
261
262 if (output->transmit_timeout > 0)
263 {
264 if ((bReturn = WaitForTransmitSucceeded(output->size(), output->transmit_timeout)) == false)
265 m_controller->AddLog(CEC_LOG_ERROR, "did not receive ack");
266 }
267 else
268 bReturn = true;
269 }
270
271 return bReturn;
272}
273
274void CCECProcessor::TransmitAbort(cec_logical_address address, cec_opcode opcode, ECecAbortReason reason /* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
275{
276 m_controller->AddLog(CEC_LOG_DEBUG, "<< transmitting abort message");
277
278 cec_command command;
279 cec_command::format(command, m_iLogicalAddress, address, CEC_OPCODE_FEATURE_ABORT);
280 command.parameters.push_back((uint8_t)opcode);
281 command.parameters.push_back((uint8_t)reason);
282
283 Transmit(command);
284}
285
286bool CCECProcessor::WaitForTransmitSucceeded(uint8_t iLength, uint32_t iTimeout /* = 1000 */)
287{
288 bool bError(false);
289 bool bTransmitSucceeded(false);
290 uint8_t iPacketsLeft(iLength / 4);
291
292 int64_t iNow = GetTimeMs();
293 int64_t iTargetTime = iNow + (uint64_t) iTimeout;
294
295 while (!bTransmitSucceeded && !bError && (iTimeout == 0 || iNow < iTargetTime))
296 {
297 CCECAdapterMessage msg;
298
299 if (!m_communication->Read(msg, iTimeout > 0 ? (int32_t)(iTargetTime - iNow) : 1000))
300 {
301 iNow = GetTimeMs();
302 continue;
303 }
304
305 if ((bError = msg.is_error()) == false)
306 {
307 m_controller->AddLog(bError ? CEC_LOG_WARNING : CEC_LOG_DEBUG, msg.ToString());
308
309 switch(msg.message())
310 {
311 case MSGCODE_COMMAND_ACCEPTED:
312 if (iPacketsLeft > 0)
313 iPacketsLeft--;
314 break;
315 case MSGCODE_TRANSMIT_SUCCEEDED:
316 bTransmitSucceeded = (iPacketsLeft == 0);
317 bError = !bTransmitSucceeded;
318 break;
319 default:
320 ParseMessage(msg);
321 }
322
323 iNow = GetTimeMs();
324 }
325 }
326
327 return bTransmitSucceeded && !bError;
328}
329
330bool CCECProcessor::ParseMessage(const CCECAdapterMessage &msg)
331{
332 bool bEom = false;
333
334 if (msg.empty())
335 return bEom;
336
337 switch(msg.message())
338 {
339 case MSGCODE_FRAME_START:
340 {
341 m_currentframe.clear();
342 if (msg.size() >= 2)
343 {
344 m_currentframe.initiator = msg.initiator();
345 m_currentframe.destination = msg.destination();
346 m_currentframe.ack = msg.ack();
347 m_currentframe.eom = msg.eom();
348 }
349 }
350 break;
351 case MSGCODE_FRAME_DATA:
352 {
353 if (msg.size() >= 2)
354 {
355 m_currentframe.push_back(msg[1]);
356 m_currentframe.eom = msg.eom();
357 }
358 bEom = msg.eom();
359 }
360 break;
361 default:
362 break;
363 }
364
365 return bEom;
366}
367
368void CCECProcessor::ParseCommand(cec_command &command)
369{
370 CStdString dataStr;
371 dataStr.Format(">> %1x%1x:%02x", command.initiator, command.destination, command.opcode);
372 for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
373 dataStr.AppendFormat(":%02x", (unsigned int)command.parameters[iPtr]);
374 m_controller->AddLog(CEC_LOG_TRAFFIC, dataStr.c_str());
375
376 if (!m_bMonitor)
377 m_busDevices[(uint8_t)command.initiator]->HandleCommand(command);
378}
379
380uint16_t CCECProcessor::GetPhysicalAddress(void) const
381{
382 if (m_iLogicalAddress != CECDEVICE_UNKNOWN && m_busDevices[m_iLogicalAddress])
383 return m_busDevices[m_iLogicalAddress]->GetPhysicalAddress();
384 return false;
385}
386
387void CCECProcessor::SetCurrentButton(cec_user_control_code iButtonCode)
388{
389 m_controller->SetCurrentButton(iButtonCode);
390}
391
392void CCECProcessor::AddCommand(const cec_command &command)
393{
394 m_controller->AddCommand(command);
395}
396
397void CCECProcessor::AddKey(cec_keypress &key)
398{
399 m_controller->AddKey(key);
400}
401
402void CCECProcessor::AddKey(void)
403{
404 m_controller->AddKey();
405}
406
407void CCECProcessor::AddLog(cec_log_level level, const CStdString &strMessage)
408{
409 m_controller->AddLog(level, strMessage);
410}
411
412bool CCECProcessor::SetAckMask(uint16_t iMask)
413{
414 bool bReturn(false);
415 CStdString strLog;
416 strLog.Format("setting ackmask to %2x", iMask);
417 m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
418
419 CCECAdapterMessage *output = new CCECAdapterMessage;
420
421 output->push_back(MSGSTART);
422 output->push_escaped(MSGCODE_SET_ACK_MASK);
423 output->push_escaped(iMask >> 8);
424 output->push_escaped((uint8_t)iMask);
425 output->push_back(MSGEND);
426
427 if ((bReturn = Transmit(output)) == false)
428 m_controller->AddLog(CEC_LOG_ERROR, "could not set the ackmask");
429
430 delete output;
431
432 return bReturn;
433}