2 * This file is part of the libCEC(R) library.
4 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
5 * libCEC(R) is an original work, containing original code.
7 * libCEC(R) is a trademark of Pulse-Eight Limited.
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.
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.
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.
24 * Alternatively, you can license this library under a commercial license,
25 * please contact Pulse-Eight Licensing for more information.
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/
33 #include "CECProcessor.h"
35 #include "AdapterCommunication.h"
37 #include "util/StdString.h"
38 #include "platform/timeutils.h"
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
)
50 for (uint8_t iPtr
= 0; iPtr
< 16; iPtr
++)
51 m_vendorIds
[iPtr
] = CEC_VENDOR_UNKNOWN
;
52 for (uint8_t iPtr
= 0; iPtr
< 16; iPtr
++)
53 m_vendorClasses
[iPtr
] = (uint8_t) 0;
56 CCECProcessor::~CCECProcessor(void)
59 m_communication
= NULL
;
63 bool CCECProcessor::Start(void)
65 if (!m_communication
|| !m_communication
->IsOpen())
67 m_controller
->AddLog(CEC_LOG_ERROR
, "connection is closed");
71 if (!SetLogicalAddress(m_iLogicalAddress
))
73 m_controller
->AddLog(CEC_LOG_ERROR
, "could not set the logical address");
80 m_controller
->AddLog(CEC_LOG_ERROR
, "could not create a processor thread");
85 void *CCECProcessor::Process(void)
87 m_controller
->AddLog(CEC_LOG_DEBUG
, "processor thread started");
91 bool bParseFrame(false);
96 CLockObject
lock(&m_mutex
);
97 if (m_communication
->IsOpen() && m_communication
->Read(msg
, 50))
98 bParseFrame
= ParseMessage(msg
) && !IsStopped();
103 msg
= m_currentframe
;
108 ParseCurrentFrame(msg
);
110 m_controller
->CheckKeypressTimeout();
119 bool CCECProcessor::PowerOnDevices(cec_logical_address address
/* = CECDEVICE_TV */)
125 strLog
.Format("<< powering on device with logical address %d", (int8_t)address
);
126 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
130 frame
.push_back(GetSourceDestination(address
));
131 frame
.push_back((uint8_t) CEC_OPCODE_IMAGE_VIEW_ON
);
132 return Transmit(frame
);
135 bool CCECProcessor::StandbyDevices(cec_logical_address address
/* = CECDEVICE_BROADCAST */)
141 strLog
.Format("<< putting device with logical address %d in standby mode", (int8_t)address
);
142 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
146 frame
.push_back(GetSourceDestination(address
));
147 frame
.push_back((uint8_t) CEC_OPCODE_STANDBY
);
148 return Transmit(frame
);
151 bool CCECProcessor::SetActiveView(void)
156 m_controller
->AddLog(CEC_LOG_DEBUG
, "<< setting active view");
160 frame
.push_back(GetSourceDestination(CECDEVICE_BROADCAST
));
161 frame
.push_back((uint8_t) CEC_OPCODE_ACTIVE_SOURCE
);
162 frame
.push_back((m_physicaladdress
>> 8) & 0xFF);
163 frame
.push_back(m_physicaladdress
& 0xFF);
164 return Transmit(frame
);
167 bool CCECProcessor::SetInactiveView(void)
172 m_controller
->AddLog(CEC_LOG_DEBUG
, "<< setting inactive view");
176 frame
.push_back(GetSourceDestination(CECDEVICE_BROADCAST
));
177 frame
.push_back((uint8_t) CEC_OPCODE_INACTIVE_SOURCE
);
178 frame
.push_back((m_physicaladdress
>> 8) & 0xFF);
179 frame
.push_back(m_physicaladdress
& 0xFF);
180 return Transmit(frame
);
183 bool CCECProcessor::Transmit(const cec_frame
&data
, bool bWaitForAck
/* = true */)
185 CStdString txStr
= "transmit ";
186 for (unsigned int i
= 0; i
< data
.size
; i
++)
187 txStr
.AppendFormat(" %02x", data
.data
[i
]);
188 m_controller
->AddLog(CEC_LOG_DEBUG
, txStr
.c_str());
192 m_controller
->AddLog(CEC_LOG_WARNING
, "transmit buffer is empty");
199 //set ack polarity to high when transmitting to the broadcast address
200 //set ack polarity low when transmitting to any other address
201 output
.push_back(MSGSTART
);
202 CAdapterCommunication::PushEscaped(output
, MSGCODE_TRANSMIT_ACK_POLARITY
);
204 if ((data
.data
[0] & 0xF) == 0xF)
205 CAdapterCommunication::PushEscaped(output
, CEC_TRUE
);
207 CAdapterCommunication::PushEscaped(output
, CEC_FALSE
);
209 output
.push_back(MSGEND
);
211 for (int8_t i
= 0; i
< data
.size
; i
++)
213 output
.push_back(MSGSTART
);
215 if (i
== (int8_t)data
.size
- 1)
216 CAdapterCommunication::PushEscaped(output
, MSGCODE_TRANSMIT_EOM
);
218 CAdapterCommunication::PushEscaped(output
, MSGCODE_TRANSMIT
);
220 CAdapterCommunication::PushEscaped(output
, data
.data
[i
]);
222 output
.push_back(MSGEND
);
225 return TransmitFormatted(output
, bWaitForAck
);
228 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress
)
231 strLog
.Format("<< setting logical address to %d", iLogicalAddress
);
232 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
234 m_iLogicalAddress
= iLogicalAddress
;
235 return m_communication
&& m_communication
->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress
);
238 bool CCECProcessor::TransmitFormatted(const cec_frame
&data
, bool bWaitForAck
/* = true */)
240 CLockObject
lock(&m_mutex
);
241 if (!m_communication
|| !m_communication
->Write(data
))
244 CCondition::Sleep((uint32_t) data
.size
* (uint32_t)24 /*data*/ + (uint32_t)5 /*start bit (4.5 ms)*/);
248 uint64_t now
= GetTimeMs();
249 uint64_t target
= now
+ 1000;
253 while (!bGotAck
&& now
< target
)
255 bGotAck
= WaitForAck(&bError
, (uint64_t) (target
- now
));
258 if (bError
&& now
< target
)
260 m_controller
->AddLog(CEC_LOG_ERROR
, "retransmitting previous frame");
261 if (!m_communication
->Write(data
))
270 void CCECProcessor::TransmitAbort(cec_logical_address address
, cec_opcode opcode
, ECecAbortReason reason
/* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
272 m_controller
->AddLog(CEC_LOG_DEBUG
, "transmitting abort message");
276 frame
.push_back(GetSourceDestination(address
));
277 frame
.push_back((uint8_t) CEC_OPCODE_FEATURE_ABORT
);
278 frame
.push_back((uint8_t) opcode
);
279 frame
.push_back((uint8_t) reason
);
283 void CCECProcessor::ReportCECVersion(cec_logical_address address
/* = CECDEVICE_TV */)
288 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting CEC version as 1.3a");
289 frame
.push_back(GetSourceDestination(address
));
290 frame
.push_back((uint8_t) CEC_OPCODE_CEC_VERSION
);
291 frame
.push_back((uint8_t) CEC_VERSION_1_3A
);
295 void CCECProcessor::ReportPowerState(cec_logical_address address
/*= CECDEVICE_TV */, bool bOn
/* = true */)
301 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting \"On\" power status");
303 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting \"Off\" power status");
305 frame
.push_back(GetSourceDestination(address
));
306 frame
.push_back((uint8_t) CEC_OPCODE_REPORT_POWER_STATUS
);
307 frame
.push_back(bOn
? (uint8_t) CEC_POWER_STATUS_ON
: (uint8_t) CEC_POWER_STATUS_STANDBY
);
311 void CCECProcessor::ReportMenuState(cec_logical_address address
/* = CECDEVICE_TV */, bool bActive
/* = true */)
317 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting menu state as active");
319 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting menu state as inactive");
321 frame
.push_back(GetSourceDestination(address
));
322 frame
.push_back((uint8_t) CEC_OPCODE_MENU_STATUS
);
323 frame
.push_back(bActive
? (uint8_t) CEC_MENU_STATE_ACTIVATED
: (uint8_t) CEC_MENU_STATE_DEACTIVATED
);
327 void CCECProcessor::ReportVendorID(cec_logical_address address
/* = CECDEVICE_TV */)
329 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< vendor ID requested, feature abort");
330 TransmitAbort(address
, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
);
333 void CCECProcessor::ReportOSDName(cec_logical_address address
/* = CECDEVICE_TV */)
338 const char *osdname
= m_strDeviceName
.c_str();
340 strLog
.Format("<< reporting OSD name as %s", osdname
);
341 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
342 frame
.push_back(GetSourceDestination(address
));
343 frame
.push_back((uint8_t) CEC_OPCODE_SET_OSD_NAME
);
345 for (unsigned int i
= 0; i
< strlen(osdname
); i
++)
346 frame
.push_back(osdname
[i
]);
351 void CCECProcessor::ReportPhysicalAddress(void)
357 strLog
.Format("<< reporting physical address as %04x", m_physicaladdress
);
358 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
359 frame
.push_back(GetSourceDestination(CECDEVICE_BROADCAST
));
360 frame
.push_back((uint8_t) CEC_OPCODE_REPORT_PHYSICAL_ADDRESS
);
361 frame
.push_back((uint8_t) ((m_physicaladdress
>> 8) & 0xFF));
362 frame
.push_back((uint8_t) (m_physicaladdress
& 0xFF));
363 frame
.push_back((uint8_t) CEC_DEVICE_TYPE_PLAYBACK_DEVICE
);
367 void CCECProcessor::BroadcastActiveSource(void)
372 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< broadcasting active source");
373 frame
.push_back(GetSourceDestination(CECDEVICE_BROADCAST
));
374 frame
.push_back((uint8_t) CEC_OPCODE_ACTIVE_SOURCE
);
375 frame
.push_back((uint8_t) ((m_physicaladdress
>> 8) & 0xFF));
376 frame
.push_back((uint8_t) (m_physicaladdress
& 0xFF));
380 uint8_t CCECProcessor::GetSourceDestination(cec_logical_address destination
/* = CECDEVICE_BROADCAST */) const
382 return ((uint8_t)m_iLogicalAddress
<< 4) + (uint8_t)destination
;
385 bool CCECProcessor::WaitForAck(bool *bError
, uint32_t iTimeout
/* = 1000 */)
390 int64_t iNow
= GetTimeMs();
391 int64_t iTargetTime
= iNow
+ (uint64_t) iTimeout
;
393 while (!bGotAck
&& !*bError
&& (iTimeout
== 0 || iNow
< iTargetTime
))
398 if (!m_communication
->Read(msg
, iTimeout
> 0 ? iTargetTime
- iNow
: 1000))
404 uint8_t iCode
= msg
.data
[0] & ~(MSGCODE_FRAME_EOM
| MSGCODE_FRAME_ACK
);
408 case MSGCODE_COMMAND_ACCEPTED
:
409 m_controller
->AddLog(CEC_LOG_DEBUG
, "MSGCODE_COMMAND_ACCEPTED");
411 case MSGCODE_TRANSMIT_SUCCEEDED
:
412 m_controller
->AddLog(CEC_LOG_DEBUG
, "MSGCODE_TRANSMIT_SUCCEEDED");
415 case MSGCODE_RECEIVE_FAILED
:
416 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_RECEIVE_FAILED");
419 case MSGCODE_COMMAND_REJECTED
:
420 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_COMMAND_REJECTED");
423 case MSGCODE_TRANSMIT_FAILED_LINE
:
424 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_LINE");
427 case MSGCODE_TRANSMIT_FAILED_ACK
:
428 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_ACK");
431 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA
:
432 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
435 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE
:
436 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
440 m_frameBuffer
.Push(msg
);
447 return bGotAck
&& !*bError
;
450 bool CCECProcessor::ParseMessage(cec_frame
&msg
)
458 uint8_t iCode
= msg
.data
[0] & ~(MSGCODE_FRAME_EOM
| MSGCODE_FRAME_ACK
);
459 bool bEom
= (msg
.data
[0] & MSGCODE_FRAME_EOM
) != 0;
460 bool bAck
= (msg
.data
[0] & MSGCODE_FRAME_ACK
) != 0;
464 case MSGCODE_NOTHING
:
465 m_controller
->AddLog(CEC_LOG_DEBUG
, "MSGCODE_NOTHING");
467 case MSGCODE_TIMEOUT_ERROR
:
468 case MSGCODE_HIGH_ERROR
:
469 case MSGCODE_LOW_ERROR
:
471 if (iCode
== MSGCODE_TIMEOUT_ERROR
)
472 logStr
= "MSGCODE_TIMEOUT";
473 else if (iCode
== MSGCODE_HIGH_ERROR
)
474 logStr
= "MSGCODE_HIGH_ERROR";
476 logStr
= "MSGCODE_LOW_ERROR";
478 int iLine
= (msg
.size
>= 3) ? (msg
.data
[1] << 8) | (msg
.data
[2]) : 0;
479 uint32_t iTime
= (msg
.size
>= 7) ? (msg
.data
[3] << 24) | (msg
.data
[4] << 16) | (msg
.data
[5] << 8) | (msg
.data
[6]) : 0;
480 logStr
.AppendFormat(" line:%i", iLine
);
481 logStr
.AppendFormat(" time:%u", iTime
);
482 m_controller
->AddLog(CEC_LOG_WARNING
, logStr
.c_str());
485 case MSGCODE_FRAME_START
:
487 logStr
= "MSGCODE_FRAME_START";
488 m_currentframe
.clear();
491 int iInitiator
= msg
.data
[1] >> 4;
492 int iDestination
= msg
.data
[1] & 0xF;
493 logStr
.AppendFormat(" initiator:%u destination:%u ack:%s %s", iInitiator
, iDestination
, bAck
? "high" : "low", bEom
? "eom" : "");
495 m_currentframe
.push_back(msg
.data
[1]);
497 m_controller
->AddLog(CEC_LOG_DEBUG
, logStr
.c_str());
500 case MSGCODE_FRAME_DATA
:
502 logStr
= "MSGCODE_FRAME_DATA";
505 uint8_t iData
= msg
.data
[1];
506 logStr
.AppendFormat(" %02x", iData
);
507 m_currentframe
.push_back(iData
);
509 m_controller
->AddLog(CEC_LOG_DEBUG
, logStr
.c_str());
521 void CCECProcessor::ParseVendorId(cec_logical_address device
, cec_frame data
)
525 m_controller
->AddLog(CEC_LOG_WARNING
, "invalid vendor ID received");
529 uint64_t iVendorId
= ((uint64_t)data
.data
[0] << 3) +
530 ((uint64_t)data
.data
[1] << 2) +
531 (uint64_t)data
.data
[2];
533 m_vendorIds
[(uint8_t)device
] = iVendorId
;
534 m_vendorClasses
[(uint8_t)device
] = data
.size
>= 4 ? data
.data
[3] : 0;
537 strLog
.Format("device %d: vendor = %s (%lld) class = %2x", (uint8_t)device
, CECVendorIdToString(m_vendorIds
[(uint8_t)device
]), iVendorId
, m_vendorClasses
[(uint8_t)device
]);
538 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
541 void CCECProcessor::ParseCurrentFrame(cec_frame
&frame
)
543 uint8_t initiator
= frame
.data
[0] >> 4;
544 uint8_t destination
= frame
.data
[0] & 0xF;
547 dataStr
.Format(">> received frame: initiator: %u destination: %u", initiator
, destination
);
552 for (unsigned int i
= 1; i
< frame
.size
; i
++)
553 dataStr
.AppendFormat(" %02x", frame
.data
[i
]);
555 m_controller
->AddLog(CEC_LOG_DEBUG
, dataStr
.c_str());
560 cec_opcode opCode
= (cec_opcode
) frame
.data
[1];
561 if (destination
== (uint16_t) m_iLogicalAddress
)
565 case CEC_OPCODE_GIVE_PHYSICAL_ADDRESS
:
566 ReportPhysicalAddress();
568 case CEC_OPCODE_GIVE_OSD_NAME
:
569 ReportOSDName((cec_logical_address
)initiator
);
571 case CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
:
572 ReportVendorID((cec_logical_address
)initiator
);
574 case CEC_OPCODE_VENDOR_COMMAND_WITH_ID
:
576 ParseVendorId((cec_logical_address
)initiator
, frame
);
577 TransmitAbort((cec_logical_address
)initiator
, CEC_OPCODE_VENDOR_COMMAND_WITH_ID
);
579 case CEC_OPCODE_GIVE_DECK_STATUS
:
580 // need to support opcodes play and deck control before doing anything with this
581 TransmitAbort((cec_logical_address
)initiator
, CEC_OPCODE_GIVE_DECK_STATUS
);
583 case CEC_OPCODE_MENU_REQUEST
:
585 if (frame
.data
[0] == CEC_MENU_REQUEST_TYPE_QUERY
)
586 ReportMenuState((cec_logical_address
)initiator
);
588 case CEC_OPCODE_GIVE_DEVICE_POWER_STATUS
:
589 ReportPowerState((cec_logical_address
)initiator
);
592 case CEC_OPCODE_GET_CEC_VERSION
:
593 ReportCECVersion((cec_logical_address
)initiator
);
595 case CEC_OPCODE_USER_CONTROL_PRESSED
:
598 m_controller
->AddKey();
600 if (frame
.data
[2] <= CEC_USER_CONTROL_CODE_MAX
)
601 m_controller
->SetCurrentButton((cec_user_control_code
) frame
.data
[2]);
604 case CEC_OPCODE_USER_CONTROL_RELEASE
:
605 m_controller
->AddKey();
609 m_controller
->AddCommand((cec_logical_address
) initiator
, (cec_logical_address
) destination
, opCode
, &frame
);
613 else if (destination
== (uint8_t) CECDEVICE_BROADCAST
)
616 if (opCode
== CEC_OPCODE_REQUEST_ACTIVE_SOURCE
)
618 strLog
.Format(">> %i requests active source", initiator
);
619 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
620 BroadcastActiveSource();
622 else if (opCode
== CEC_OPCODE_SET_STREAM_PATH
)
626 int streamaddr
= ((int)frame
.data
[2] << 8) | ((int)frame
.data
[3]);
627 strLog
.Format(">> %i requests stream path from physical address %04x", initiator
, streamaddr
);
628 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
629 if (streamaddr
== m_physicaladdress
)
630 BroadcastActiveSource();
635 cec_frame params
= frame
;
637 m_controller
->AddCommand((cec_logical_address
) initiator
, (cec_logical_address
) destination
, opCode
, ¶ms
);
643 strLog
.Format("ignoring frame: destination: %u != %u", destination
, (uint16_t)m_iLogicalAddress
);
644 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());