cec: made = operator private for CCECAdapterMessage. these should not be copied
[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 StopThread();
58 m_communication = NULL;
59 m_controller = NULL;
60 for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
61 delete m_busDevices[iPtr];
62}
63
64bool CCECProcessor::Start(void)
65{
66 if (!m_communication || !m_communication->IsOpen())
67 {
68 m_controller->AddLog(CEC_LOG_ERROR, "connection is closed");
69 return false;
70 }
71
72 if (!SetLogicalAddress(m_iLogicalAddress))
73 {
74 m_controller->AddLog(CEC_LOG_ERROR, "could not set the logical address");
75 return false;
76 }
77
78 if (CreateThread())
79 return true;
80 else
81 m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
82
83 return false;
84}
85
86void *CCECProcessor::Process(void)
87{
88 m_controller->AddLog(CEC_LOG_DEBUG, "processor thread started");
89
90 cec_command command;
91 CCECAdapterMessage msg;
92 CCECAdapterMessagePtr msgPtr;
93
94 while (!IsStopped())
95 {
96 bool bParseFrame(false);
97 command.clear();
98 msg.clear();
99
100 {
101 CLockObject lock(&m_mutex);
102 if (m_frameBuffer.Pop(msgPtr))
103 bParseFrame = ParseMessage(msgPtr);
104 else if (m_communication->IsOpen() && m_communication->Read(msg, 50))
105 {
106 msgPtr = CCECAdapterMessagePtr(new CCECAdapterMessage(msg));
107 bParseFrame = ParseMessage(msgPtr);
108 }
109
110 bParseFrame &= !IsStopped();
111 if (bParseFrame)
112 command = m_currentframe;
113 }
114
115 if (bParseFrame)
116 ParseCommand(command);
117
118 m_controller->CheckKeypressTimeout();
119
120 for (unsigned int iDevicePtr = 0; iDevicePtr < 16; iDevicePtr++)
121 m_busDevices[iDevicePtr]->PollVendorId();
122
123 if (!IsStopped())
124 Sleep(5);
125 }
126
127 return NULL;
128}
129
130bool CCECProcessor::SetActiveView(void)
131{
132 if (!IsRunning())
133 return false;
134
135 return m_busDevices[m_iLogicalAddress]->BroadcastActiveView();
136}
137
138bool CCECProcessor::SetInactiveView(void)
139{
140 if (!IsRunning())
141 return false;
142
143 return m_busDevices[m_iLogicalAddress]->BroadcastInactiveView();
144}
145
146void CCECProcessor::LogOutput(const cec_command &data)
147{
148 CStdString strTx;
149 strTx.Format("<< %02x:%02x", ((uint8_t)data.initiator << 4) + (uint8_t)data.destination, (uint8_t)data.opcode);
150
151 for (uint8_t iPtr = 0; iPtr < data.parameters.size; iPtr++)
152 strTx.AppendFormat(":%02x", data.parameters[iPtr]);
153 m_controller->AddLog(CEC_LOG_TRAFFIC, strTx.c_str());
154}
155
156bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress)
157{
158 if (m_iLogicalAddress != iLogicalAddress)
159 {
160 CStdString strLog;
161 strLog.Format("<< setting logical address to %1x", iLogicalAddress);
162 m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
163
164 m_iLogicalAddress = iLogicalAddress;
165 return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
166 }
167
168 return true;
169}
170
171bool CCECProcessor::SetPhysicalAddress(uint16_t iPhysicalAddress)
172{
173 m_busDevices[m_iLogicalAddress]->SetPhysicalAddress(iPhysicalAddress);
174 return m_busDevices[m_iLogicalAddress]->BroadcastActiveView();
175}
176
177bool CCECProcessor::SwitchMonitoring(bool bEnable)
178{
179 CStdString strLog;
180 strLog.Format("== %s monitoring mode ==", bEnable ? "enabling" : "disabling");
181 m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
182
183 m_bMonitor = bEnable;
184 if (bEnable)
185 return m_communication && m_communication->SetAckMask(0);
186 else
187 return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
188}
189
190bool CCECProcessor::Transmit(const cec_command &data, bool bWaitForAck /* = true */)
191{
192 bool bReturn(false);
193 LogOutput(data);
194
195 CCECAdapterMessagePtr output(new CCECAdapterMessage(data));
196
197 CLockObject lock(&m_mutex);
198 if (!m_communication || !m_communication->Write(output))
199 return bReturn;
200
201 if (bWaitForAck)
202 {
203 bool bError(false);
204 if ((bReturn = WaitForAck(&bError, output->size(), 1000)) == false)
205 m_controller->AddLog(CEC_LOG_ERROR, "did not receive ack");
206 }
207 else
208 {
209 bReturn = true;
210 }
211
212 return bReturn;
213}
214
215void CCECProcessor::TransmitAbort(cec_logical_address address, cec_opcode opcode, ECecAbortReason reason /* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
216{
217 m_controller->AddLog(CEC_LOG_DEBUG, "<< transmitting abort message");
218
219 cec_command command;
220 cec_command::format(command, m_iLogicalAddress, address, CEC_OPCODE_FEATURE_ABORT);
221 command.parameters.push_back((uint8_t)opcode);
222 command.parameters.push_back((uint8_t)reason);
223
224 Transmit(command);
225}
226
227bool CCECProcessor::WaitForAck(bool *bError, uint8_t iLength, uint32_t iTimeout /* = 1000 */)
228{
229 bool bTransmitSucceeded = false;
230 uint8_t iPacketsLeft(iLength / 4);
231 *bError = false;
232
233 int64_t iNow = GetTimeMs();
234 int64_t iTargetTime = iNow + (uint64_t) iTimeout;
235
236 while (!bTransmitSucceeded && !*bError && (iTimeout == 0 || iNow < iTargetTime))
237 {
238 CCECAdapterMessage msg;
239
240 if (!m_communication->Read(msg, iTimeout > 0 ? (int32_t)(iTargetTime - iNow) : 1000))
241 {
242 iNow = GetTimeMs();
243 continue;
244 }
245
246 switch(msg.message())
247 {
248 case MSGCODE_TIMEOUT_ERROR:
249 case MSGCODE_HIGH_ERROR:
250 case MSGCODE_LOW_ERROR:
251 {
252 CStdString logStr;
253 if (msg.message() == MSGCODE_TIMEOUT_ERROR)
254 logStr = "MSGCODE_TIMEOUT";
255 else if (msg.message() == MSGCODE_HIGH_ERROR)
256 logStr = "MSGCODE_HIGH_ERROR";
257 else
258 logStr = "MSGCODE_LOW_ERROR";
259
260 int iLine = (msg.size() >= 3) ? (msg[1] << 8) | (msg[2]) : 0;
261 uint32_t iTime = (msg.size() >= 7) ? (msg[3] << 24) | (msg[4] << 16) | (msg[5] << 8) | (msg[6]) : 0;
262 logStr.AppendFormat(" line:%i", iLine);
263 logStr.AppendFormat(" time:%u", iTime);
264 m_controller->AddLog(CEC_LOG_WARNING, logStr.c_str());
265 *bError = true;
266 }
267 break;
268 case MSGCODE_COMMAND_ACCEPTED:
269 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
270 iPacketsLeft--;
271 break;
272 case MSGCODE_TRANSMIT_SUCCEEDED:
273 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
274 bTransmitSucceeded = (iPacketsLeft == 0);
275 *bError = !bTransmitSucceeded;
276 break;
277 case MSGCODE_RECEIVE_FAILED:
278 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
279 *bError = true;
280 break;
281 case MSGCODE_COMMAND_REJECTED:
282 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
283 *bError = true;
284 break;
285 case MSGCODE_TRANSMIT_FAILED_LINE:
286 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
287 *bError = true;
288 break;
289 case MSGCODE_TRANSMIT_FAILED_ACK:
290 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
291 *bError = true;
292 break;
293 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
294 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
295 *bError = true;
296 break;
297 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
298 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
299 *bError = true;
300 break;
301 default:
302 CCECAdapterMessagePtr msgPtr = CCECAdapterMessagePtr(new CCECAdapterMessage(msg));
303 m_frameBuffer.Push(msgPtr);
304 break;
305 }
306
307 iNow = GetTimeMs();
308 }
309
310 return bTransmitSucceeded && !*bError;
311}
312
313bool CCECProcessor::ParseMessage(CCECAdapterMessagePtr msg)
314{
315 bool bEom = false;
316
317 if (msg->empty())
318 return bEom;
319
320 CStdString logStr;
321
322 switch(msg->message())
323 {
324 case MSGCODE_NOTHING:
325 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_NOTHING");
326 break;
327 case MSGCODE_TIMEOUT_ERROR:
328 case MSGCODE_HIGH_ERROR:
329 case MSGCODE_LOW_ERROR:
330 {
331 if (msg->message() == MSGCODE_TIMEOUT_ERROR)
332 logStr = "MSGCODE_TIMEOUT";
333 else if (msg->message() == MSGCODE_HIGH_ERROR)
334 logStr = "MSGCODE_HIGH_ERROR";
335 else
336 logStr = "MSGCODE_LOW_ERROR";
337
338 int iLine = (msg->size() >= 3) ? (msg->at(1) << 8) | (msg->at(2)) : 0;
339 uint32_t iTime = (msg->size() >= 7) ? (msg->at(3) << 24) | (msg->at(4) << 16) | (msg->at(5) << 8) | (msg->at(6)) : 0;
340 logStr.AppendFormat(" line:%i", iLine);
341 logStr.AppendFormat(" time:%u", iTime);
342 m_controller->AddLog(CEC_LOG_WARNING, logStr.c_str());
343 }
344 break;
345 case MSGCODE_FRAME_START:
346 {
347 logStr = "MSGCODE_FRAME_START";
348 m_currentframe.clear();
349 if (msg->size() >= 2)
350 {
351 logStr.AppendFormat(" initiator:%u destination:%u ack:%s %s", msg->initiator(), msg->destination(), msg->ack() ? "high" : "low", msg->eom() ? "eom" : "");
352 m_currentframe.initiator = msg->initiator();
353 m_currentframe.destination = msg->destination();
354 m_currentframe.ack = msg->ack();
355 m_currentframe.eom = msg->eom();
356 }
357 m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
358 }
359 break;
360 case MSGCODE_FRAME_DATA:
361 {
362 logStr = "MSGCODE_FRAME_DATA";
363 if (msg->size() >= 2)
364 {
365 uint8_t iData = msg->at(1);
366 logStr.AppendFormat(" %02x", iData);
367 m_currentframe.push_back(iData);
368 m_currentframe.eom = msg->eom();
369 }
370 m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
371
372 bEom = msg->eom();
373 }
374 break;
375 case MSGCODE_COMMAND_ACCEPTED:
376 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
377 break;
378 case MSGCODE_TRANSMIT_SUCCEEDED:
379 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
380 break;
381 case MSGCODE_RECEIVE_FAILED:
382 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
383 break;
384 case MSGCODE_COMMAND_REJECTED:
385 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
386 break;
387 case MSGCODE_TRANSMIT_FAILED_LINE:
388 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
389 break;
390 case MSGCODE_TRANSMIT_FAILED_ACK:
391 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
392 break;
393 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
394 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
395 break;
396 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
397 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
398 break;
399 default:
400 break;
401 }
402
403 return bEom;
404}
405
406void CCECProcessor::ParseCommand(cec_command &command)
407{
408 CStdString dataStr;
409 dataStr.Format(">> %1x%1x:%02x", command.initiator, command.destination, command.opcode);
410 for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
411 dataStr.AppendFormat(":%02x", (unsigned int)command.parameters[iPtr]);
412 m_controller->AddLog(CEC_LOG_TRAFFIC, dataStr.c_str());
413
414 if (!m_bMonitor)
415 m_busDevices[(uint8_t)command.initiator]->HandleCommand(command);
416}
417
418uint16_t CCECProcessor::GetPhysicalAddress(void) const
419{
420 return m_busDevices[m_iLogicalAddress]->GetPhysicalAddress();
421}
422
423void CCECProcessor::SetCurrentButton(cec_user_control_code iButtonCode)
424{
425 m_controller->SetCurrentButton(iButtonCode);
426}
427
428void CCECProcessor::AddCommand(const cec_command &command)
429{
430 m_controller->AddCommand(command);
431}
432
433void CCECProcessor::AddKey(void)
434{
435 m_controller->AddKey();
436}
437
438void CCECProcessor::AddLog(cec_log_level level, const CStdString &strMessage)
439{
440 m_controller->AddLog(level, strMessage);
441}