cec: retransmit if needed. wait long enough for an ack message
[deb_libcec.git] / src / lib / CECProcessor.cpp
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 "LibCEC.h"
37 #include "util/StdString.h"
38 #include "platform/timeutils.h"
39
40 using namespace CEC;
41 using namespace std;
42
43 CCECProcessor::CCECProcessor(CLibCEC *controller, CAdapterCommunication *serComm, const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS*/) :
44 m_physicaladdress(iPhysicalAddress),
45 m_iLogicalAddress(iLogicalAddress),
46 m_strDeviceName(strDeviceName),
47 m_communication(serComm),
48 m_controller(controller)
49 {
50 }
51
52 CCECProcessor::~CCECProcessor(void)
53 {
54 StopThread();
55 m_communication = NULL;
56 m_controller = NULL;
57 }
58
59 bool CCECProcessor::Start(void)
60 {
61 if (!m_communication || !m_communication->IsOpen())
62 {
63 m_controller->AddLog(CEC_LOG_ERROR, "connection is closed");
64 return false;
65 }
66
67 if (!SetLogicalAddress(m_iLogicalAddress))
68 {
69 m_controller->AddLog(CEC_LOG_ERROR, "could not set the logical address");
70 return false;
71 }
72
73 if (CreateThread())
74 return true;
75 else
76 m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
77
78 return false;
79 }
80
81 void *CCECProcessor::Process(void)
82 {
83 m_controller->AddLog(CEC_LOG_DEBUG, "processor thread started");
84
85 while (!IsStopped())
86 {
87 bool bParseFrame(false);
88 cec_frame msg;
89 msg.clear();
90
91 {
92 CLockObject lock(&m_mutex);
93 if (m_communication->IsOpen() && m_communication->Read(msg, 50))
94 bParseFrame = ParseMessage(msg) && !IsStopped();
95
96 if (bParseFrame)
97 {
98 msg.clear();
99 msg = m_currentframe;
100 }
101 }
102
103 if (bParseFrame)
104 ParseCurrentFrame(msg);
105
106 m_controller->CheckKeypressTimeout();
107
108 if (!IsStopped())
109 Sleep(50);
110 }
111
112 return NULL;
113 }
114
115 bool CCECProcessor::PowerOnDevices(cec_logical_address address /* = CECDEVICE_TV */)
116 {
117 if (!IsRunning())
118 return false;
119
120 CStdString strLog;
121 strLog.Format("<< powering on device with logical address %d", (int8_t)address);
122 m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
123 cec_frame frame;
124 frame.clear();
125
126 frame.push_back(GetSourceDestination(address));
127 frame.push_back((uint8_t) CEC_OPCODE_IMAGE_VIEW_ON);
128 return Transmit(frame);
129 }
130
131 bool CCECProcessor::StandbyDevices(cec_logical_address address /* = CECDEVICE_BROADCAST */)
132 {
133 if (!IsRunning())
134 return false;
135
136 CStdString strLog;
137 strLog.Format("<< putting device with logical address %d in standby mode", (int8_t)address);
138 m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
139 cec_frame frame;
140 frame.clear();
141
142 frame.push_back(GetSourceDestination(address));
143 frame.push_back((uint8_t) CEC_OPCODE_STANDBY);
144 return Transmit(frame);
145 }
146
147 bool CCECProcessor::SetActiveView(void)
148 {
149 if (!IsRunning())
150 return false;
151
152 m_controller->AddLog(CEC_LOG_DEBUG, "<< setting active view");
153 cec_frame frame;
154 frame.clear();
155
156 frame.push_back(GetSourceDestination(CECDEVICE_BROADCAST));
157 frame.push_back((uint8_t) CEC_OPCODE_ACTIVE_SOURCE);
158 frame.push_back((m_physicaladdress >> 8) & 0xFF);
159 frame.push_back(m_physicaladdress & 0xFF);
160 return Transmit(frame);
161 }
162
163 bool CCECProcessor::SetInactiveView(void)
164 {
165 if (!IsRunning())
166 return false;
167
168 m_controller->AddLog(CEC_LOG_DEBUG, "<< setting inactive view");
169 cec_frame frame;
170 frame.clear();
171
172 frame.push_back(GetSourceDestination(CECDEVICE_BROADCAST));
173 frame.push_back((uint8_t) CEC_OPCODE_INACTIVE_SOURCE);
174 frame.push_back((m_physicaladdress >> 8) & 0xFF);
175 frame.push_back(m_physicaladdress & 0xFF);
176 return Transmit(frame);
177 }
178
179 bool CCECProcessor::Transmit(const cec_frame &data, bool bWaitForAck /* = true */)
180 {
181 CStdString txStr = "transmit ";
182 for (unsigned int i = 0; i < data.size; i++)
183 txStr.AppendFormat(" %02x", data.data[i]);
184 m_controller->AddLog(CEC_LOG_DEBUG, txStr.c_str());
185
186 if (data.size == 0)
187 {
188 m_controller->AddLog(CEC_LOG_WARNING, "transmit buffer is empty");
189 return false;
190 }
191
192 cec_frame output;
193 output.clear();
194
195 //set ack polarity to high when transmitting to the broadcast address
196 //set ack polarity low when transmitting to any other address
197 output.push_back(MSGSTART);
198 CAdapterCommunication::PushEscaped(output, MSGCODE_TRANSMIT_ACK_POLARITY);
199
200 if ((data.data[0] & 0xF) == 0xF)
201 CAdapterCommunication::PushEscaped(output, CEC_TRUE);
202 else
203 CAdapterCommunication::PushEscaped(output, CEC_FALSE);
204
205 output.push_back(MSGEND);
206
207 for (int8_t i = 0; i < data.size; i++)
208 {
209 output.push_back(MSGSTART);
210
211 if (i == (int8_t)data.size - 1)
212 CAdapterCommunication::PushEscaped(output, MSGCODE_TRANSMIT_EOM);
213 else
214 CAdapterCommunication::PushEscaped(output, MSGCODE_TRANSMIT);
215
216 CAdapterCommunication::PushEscaped(output, data.data[i]);
217
218 output.push_back(MSGEND);
219 }
220
221 return TransmitFormatted(output, bWaitForAck);
222 }
223
224 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress)
225 {
226 CStdString strLog;
227 strLog.Format("<< setting logical address to %d", iLogicalAddress);
228 m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
229
230 m_iLogicalAddress = iLogicalAddress;
231 return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
232 }
233
234 bool CCECProcessor::TransmitFormatted(const cec_frame &data, bool bWaitForAck /* = true */)
235 {
236 CLockObject lock(&m_mutex);
237 if (!m_communication || !m_communication->Write(data))
238 return false;
239
240 if (bWaitForAck)
241 {
242 uint64_t now = GetTimeMs();
243 uint64_t target = now + 1000;
244 bool bError(false);
245 bool bGotAck(false);
246
247 while (!bGotAck && now < target)
248 {
249 bGotAck = WaitForAck(&bError, (uint64_t) (target - now));
250 now = GetTimeMs();
251
252 if (bError && now < target)
253 {
254 m_controller->AddLog(CEC_LOG_ERROR, "retransmitting previous frame");
255 if (!m_communication->Write(data))
256 return false;
257 }
258 }
259 }
260
261 return true;
262 }
263
264 void CCECProcessor::TransmitAbort(cec_logical_address address, cec_opcode opcode, ECecAbortReason reason /* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
265 {
266 m_controller->AddLog(CEC_LOG_DEBUG, "transmitting abort message");
267 cec_frame frame;
268 frame.clear();
269
270 frame.push_back(GetSourceDestination(address));
271 frame.push_back((uint8_t) CEC_OPCODE_FEATURE_ABORT);
272 frame.push_back((uint8_t) opcode);
273 frame.push_back((uint8_t) reason);
274 Transmit(frame);
275 }
276
277 void CCECProcessor::ReportCECVersion(cec_logical_address address /* = CECDEVICE_TV */)
278 {
279 cec_frame frame;
280 frame.clear();
281
282 m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting CEC version as 1.3a");
283 frame.push_back(GetSourceDestination(address));
284 frame.push_back((uint8_t) CEC_OPCODE_CEC_VERSION);
285 frame.push_back((uint8_t) CEC_VERSION_1_3A);
286 Transmit(frame);
287 }
288
289 void CCECProcessor::ReportPowerState(cec_logical_address address /*= CECDEVICE_TV */, bool bOn /* = true */)
290 {
291 cec_frame frame;
292 frame.clear();
293
294 if (bOn)
295 m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting \"On\" power status");
296 else
297 m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting \"Off\" power status");
298
299 frame.push_back(GetSourceDestination(address));
300 frame.push_back((uint8_t) CEC_OPCODE_REPORT_POWER_STATUS);
301 frame.push_back(bOn ? (uint8_t) CEC_POWER_STATUS_ON : (uint8_t) CEC_POWER_STATUS_STANDBY);
302 Transmit(frame);
303 }
304
305 void CCECProcessor::ReportMenuState(cec_logical_address address /* = CECDEVICE_TV */, bool bActive /* = true */)
306 {
307 cec_frame frame;
308 frame.clear();
309
310 if (bActive)
311 m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting menu state as active");
312 else
313 m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting menu state as inactive");
314
315 frame.push_back(GetSourceDestination(address));
316 frame.push_back((uint8_t) CEC_OPCODE_MENU_STATUS);
317 frame.push_back(bActive ? (uint8_t) CEC_MENU_STATE_ACTIVATED : (uint8_t) CEC_MENU_STATE_DEACTIVATED);
318 Transmit(frame);
319 }
320
321 void CCECProcessor::ReportVendorID(cec_logical_address address /* = CECDEVICE_TV */)
322 {
323 m_controller->AddLog(CEC_LOG_NOTICE, "<< vendor ID requested, feature abort");
324 TransmitAbort(address, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
325 }
326
327 void CCECProcessor::ReportOSDName(cec_logical_address address /* = CECDEVICE_TV */)
328 {
329 cec_frame frame;
330 frame.clear();
331
332 const char *osdname = m_strDeviceName.c_str();
333 CStdString strLog;
334 strLog.Format("<< reporting OSD name as %s", osdname);
335 m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
336 frame.push_back(GetSourceDestination(address));
337 frame.push_back((uint8_t) CEC_OPCODE_SET_OSD_NAME);
338
339 for (unsigned int i = 0; i < strlen(osdname); i++)
340 frame.push_back(osdname[i]);
341
342 Transmit(frame);
343 }
344
345 void CCECProcessor::ReportPhysicalAddress(void)
346 {
347 cec_frame frame;
348 frame.clear();
349
350 CStdString strLog;
351 strLog.Format("<< reporting physical address as %04x", m_physicaladdress);
352 m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
353 frame.push_back(GetSourceDestination(CECDEVICE_BROADCAST));
354 frame.push_back((uint8_t) CEC_OPCODE_REPORT_PHYSICAL_ADDRESS);
355 frame.push_back((uint8_t) ((m_physicaladdress >> 8) & 0xFF));
356 frame.push_back((uint8_t) (m_physicaladdress & 0xFF));
357 frame.push_back((uint8_t) CEC_DEVICE_TYPE_PLAYBACK_DEVICE);
358 Transmit(frame);
359 }
360
361 void CCECProcessor::BroadcastActiveSource(void)
362 {
363 cec_frame frame;
364 frame.clear();
365
366 m_controller->AddLog(CEC_LOG_NOTICE, "broadcasting active source");
367 frame.push_back(GetSourceDestination(CECDEVICE_BROADCAST));
368 frame.push_back((uint8_t) CEC_OPCODE_ACTIVE_SOURCE);
369 frame.push_back((uint8_t) ((m_physicaladdress >> 8) & 0xFF));
370 frame.push_back((uint8_t) (m_physicaladdress & 0xFF));
371 Transmit(frame);
372 }
373
374 uint8_t CCECProcessor::GetSourceDestination(cec_logical_address destination /* = CECDEVICE_BROADCAST */) const
375 {
376 return ((uint8_t)m_iLogicalAddress << 4) + (uint8_t)destination;
377 }
378
379 bool CCECProcessor::WaitForAck(bool *bError, uint32_t iTimeout /* = 1000 */)
380 {
381 bool bGotAck(false);
382 *bError = false;
383
384 int64_t iNow = GetTimeMs();
385 int64_t iTargetTime = iNow + (uint64_t) iTimeout;
386
387 while (!bGotAck && !bError && (iTimeout == 0 || iNow < iTargetTime))
388 {
389 cec_frame msg;
390 msg.clear();
391
392 while (!bGotAck && !bError && m_communication->Read(msg, iTimeout))
393 {
394 uint8_t iCode = msg.data[0] & ~(MSGCODE_FRAME_EOM | MSGCODE_FRAME_ACK);
395
396 switch (iCode)
397 {
398 case MSGCODE_COMMAND_ACCEPTED:
399 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
400 break;
401 case MSGCODE_TRANSMIT_SUCCEEDED:
402 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
403 // TODO
404 bGotAck = true;
405 break;
406 case MSGCODE_RECEIVE_FAILED:
407 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
408 *bError = true;
409 break;
410 case MSGCODE_COMMAND_REJECTED:
411 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
412 *bError = true;
413 break;
414 case MSGCODE_TRANSMIT_FAILED_LINE:
415 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
416 *bError = true;
417 break;
418 case MSGCODE_TRANSMIT_FAILED_ACK:
419 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
420 *bError = true;
421 break;
422 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
423 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
424 *bError = true;
425 break;
426 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
427 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
428 *bError = true;
429 break;
430 default:
431 m_frameBuffer.Push(msg);
432 break;
433 }
434 iNow = GetTimeMs();
435 }
436 }
437
438 return bGotAck && !bError;
439 }
440
441 bool CCECProcessor::ParseMessage(cec_frame &msg)
442 {
443 bool bReturn(false);
444
445 if (msg.size == 0)
446 return bReturn;
447
448 CStdString logStr;
449 uint8_t iCode = msg.data[0] & ~(MSGCODE_FRAME_EOM | MSGCODE_FRAME_ACK);
450 bool bEom = (msg.data[0] & MSGCODE_FRAME_EOM) != 0;
451 bool bAck = (msg.data[0] & MSGCODE_FRAME_ACK) != 0;
452
453 switch(iCode)
454 {
455 case MSGCODE_NOTHING:
456 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_NOTHING");
457 break;
458 case MSGCODE_TIMEOUT_ERROR:
459 case MSGCODE_HIGH_ERROR:
460 case MSGCODE_LOW_ERROR:
461 {
462 if (iCode == MSGCODE_TIMEOUT_ERROR)
463 logStr = "MSGCODE_TIMEOUT";
464 else if (iCode == MSGCODE_HIGH_ERROR)
465 logStr = "MSGCODE_HIGH_ERROR";
466 else
467 logStr = "MSGCODE_LOW_ERROR";
468
469 int iLine = (msg.size >= 3) ? (msg.data[1] << 8) | (msg.data[2]) : 0;
470 uint32_t iTime = (msg.size >= 7) ? (msg.data[3] << 24) | (msg.data[4] << 16) | (msg.data[5] << 8) | (msg.data[6]) : 0;
471 logStr.AppendFormat(" line:%i", iLine);
472 logStr.AppendFormat(" time:%u", iTime);
473 m_controller->AddLog(CEC_LOG_WARNING, logStr.c_str());
474 }
475 break;
476 case MSGCODE_FRAME_START:
477 {
478 logStr = "MSGCODE_FRAME_START";
479 m_currentframe.clear();
480 if (msg.size >= 2)
481 {
482 int iInitiator = msg.data[1] >> 4;
483 int iDestination = msg.data[1] & 0xF;
484 logStr.AppendFormat(" initiator:%u destination:%u ack:%s %s", iInitiator, iDestination, bAck ? "high" : "low", bEom ? "eom" : "");
485
486 m_currentframe.push_back(msg.data[1]);
487 }
488 m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
489 }
490 break;
491 case MSGCODE_FRAME_DATA:
492 {
493 logStr = "MSGCODE_FRAME_DATA";
494 if (msg.size >= 2)
495 {
496 uint8_t iData = msg.data[1];
497 logStr.AppendFormat(" %02x", iData);
498 m_currentframe.push_back(iData);
499 }
500 m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
501 }
502 if (bEom)
503 bReturn = true;
504 break;
505 default:
506 break;
507 }
508
509 return bReturn;
510 }
511
512 void CCECProcessor::ParseCurrentFrame(cec_frame &frame)
513 {
514 uint8_t initiator = frame.data[0] >> 4;
515 uint8_t destination = frame.data[0] & 0xF;
516
517 CStdString dataStr;
518 dataStr.Format(">> received frame: initiator: %u destination: %u", initiator, destination);
519
520 if (frame.size > 1)
521 {
522 dataStr += " data:";
523 for (unsigned int i = 1; i < frame.size; i++)
524 dataStr.AppendFormat(" %02x", frame.data[i]);
525 }
526 m_controller->AddLog(CEC_LOG_DEBUG, dataStr.c_str());
527
528 if (frame.size <= 1)
529 return;
530
531 cec_opcode opCode = (cec_opcode) frame.data[1];
532 if (destination == (uint16_t) m_iLogicalAddress)
533 {
534 switch(opCode)
535 {
536 case CEC_OPCODE_GIVE_PHYSICAL_ADDRESS:
537 ReportPhysicalAddress();
538 SetActiveView();
539 break;
540 case CEC_OPCODE_GIVE_OSD_NAME:
541 ReportOSDName((cec_logical_address)initiator);
542 break;
543 case CEC_OPCODE_GIVE_DEVICE_VENDOR_ID:
544 ReportVendorID((cec_logical_address)initiator);
545 break;
546 case CEC_OPCODE_MENU_REQUEST:
547 ReportMenuState((cec_logical_address)initiator);
548 break;
549 case CEC_OPCODE_GIVE_DEVICE_POWER_STATUS:
550 ReportPowerState((cec_logical_address)initiator);
551 break;
552 case CEC_OPCODE_GET_CEC_VERSION:
553 ReportCECVersion((cec_logical_address)initiator);
554 break;
555 case CEC_OPCODE_USER_CONTROL_PRESSED:
556 if (frame.size > 2)
557 {
558 m_controller->AddKey();
559
560 if (frame.data[2] <= CEC_USER_CONTROL_CODE_MAX)
561 m_controller->SetCurrentButton((cec_user_control_code) frame.data[2]);
562 }
563 break;
564 case CEC_OPCODE_USER_CONTROL_RELEASE:
565 m_controller->AddKey();
566 break;
567 default:
568 cec_frame params = frame;
569 params.shift(2);
570 m_controller->AddCommand((cec_logical_address) initiator, (cec_logical_address) destination, opCode, &params);
571 break;
572 }
573 }
574 else if (destination == (uint8_t) CECDEVICE_BROADCAST)
575 {
576 CStdString strLog;
577 if (opCode == CEC_OPCODE_REQUEST_ACTIVE_SOURCE)
578 {
579 strLog.Format(">> %i requests active source", initiator);
580 m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
581 BroadcastActiveSource();
582 }
583 else if (opCode == CEC_OPCODE_SET_STREAM_PATH)
584 {
585 if (frame.size >= 4)
586 {
587 int streamaddr = ((int)frame.data[2] << 8) | ((int)frame.data[3]);
588 strLog.Format(">> %i requests stream path from physical address %04x", initiator, streamaddr);
589 m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
590 if (streamaddr == m_physicaladdress)
591 BroadcastActiveSource();
592 }
593 }
594 else
595 {
596 cec_frame params = frame;
597 params.shift(2);
598 m_controller->AddCommand((cec_logical_address) initiator, (cec_logical_address) destination, opCode, &params);
599 }
600 }
601 else
602 {
603 CStdString strLog;
604 strLog.Format("ignoring frame: destination: %u != %u", destination, (uint16_t)m_iLogicalAddress);
605 m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
606 }
607 }