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");
90 cec_adapter_message msg
;
94 bool bParseFrame(false);
99 CLockObject
lock(&m_mutex
);
100 if (m_communication
->IsOpen() && m_communication
->Read(msg
, 50))
101 bParseFrame
= ParseMessage(msg
) && !IsStopped();
104 command
= m_currentframe
;
108 ParseCommand(command
);
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());
129 cec_command::format(command
, m_iLogicalAddress
, address
, CEC_OPCODE_IMAGE_VIEW_ON
);
131 return Transmit(command
);
134 bool CCECProcessor::StandbyDevices(cec_logical_address address
/* = CECDEVICE_BROADCAST */)
140 strLog
.Format("<< putting device with logical address %d in standby mode", (int8_t)address
);
141 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
144 cec_command::format(command
, m_iLogicalAddress
, address
, CEC_OPCODE_STANDBY
);
146 return Transmit(command
);
149 bool CCECProcessor::SetActiveView(void)
154 m_controller
->AddLog(CEC_LOG_DEBUG
, "<< setting active view");
157 cec_command::format(command
, m_iLogicalAddress
, CECDEVICE_BROADCAST
, CEC_OPCODE_ACTIVE_SOURCE
);
158 command
.parameters
.push_back((m_physicaladdress
>> 8) & 0xFF);
159 command
.parameters
.push_back(m_physicaladdress
& 0xFF);
161 return Transmit(command
);
164 bool CCECProcessor::SetInactiveView(void)
169 m_controller
->AddLog(CEC_LOG_DEBUG
, "<< setting inactive view");
172 cec_command::format(command
, m_iLogicalAddress
, CECDEVICE_BROADCAST
, CEC_OPCODE_INACTIVE_SOURCE
);
173 command
.parameters
.push_back((m_physicaladdress
>> 8) & 0xFF);
174 command
.parameters
.push_back(m_physicaladdress
& 0xFF);
176 return Transmit(command
);
179 void CCECProcessor::LogOutput(const cec_command
&data
)
181 CStdString txStr
= "transmit ";
182 txStr
.AppendFormat(" %02x", ((uint8_t)data
.initiator
<< 4) + (uint8_t)data
.destination
);
183 txStr
.AppendFormat(" %02x", (uint8_t)data
.opcode
);
185 for (uint8_t iPtr
= 0; iPtr
< data
.parameters
.size
; iPtr
++)
186 txStr
.AppendFormat(" %02x", data
.parameters
[iPtr
]);
187 m_controller
->AddLog(CEC_LOG_DEBUG
, txStr
.c_str());
190 bool CCECProcessor::Transmit(const cec_command
&data
, bool bWaitForAck
/* = true */)
194 cec_adapter_message output
;
196 CAdapterCommunication::FormatAdapterMessage(data
, output
);
198 return TransmitFormatted(output
, bWaitForAck
);
201 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress
)
204 strLog
.Format("<< setting logical address to %d", iLogicalAddress
);
205 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
207 m_iLogicalAddress
= iLogicalAddress
;
208 return m_communication
&& m_communication
->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress
);
211 bool CCECProcessor::TransmitFormatted(const cec_adapter_message
&data
, bool bWaitForAck
/* = true */)
213 CLockObject
lock(&m_mutex
);
214 if (!m_communication
|| !m_communication
->Write(data
))
219 uint64_t now
= GetTimeMs();
220 uint64_t target
= now
+ 1000;
224 while (!bGotAck
&& now
< target
)
226 bGotAck
= WaitForAck(&bError
, (uint32_t) (target
- now
));
229 if (bError
&& now
< target
)
231 m_controller
->AddLog(CEC_LOG_ERROR
, "retransmitting previous frame");
232 if (!m_communication
->Write(data
))
241 void CCECProcessor::TransmitAbort(cec_logical_address address
, cec_opcode opcode
, ECecAbortReason reason
/* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
243 m_controller
->AddLog(CEC_LOG_DEBUG
, "<< transmitting abort message");
246 cec_command::format(command
, m_iLogicalAddress
, address
, CEC_OPCODE_FEATURE_ABORT
);
247 command
.parameters
.push_back((uint8_t)opcode
);
248 command
.parameters
.push_back((uint8_t)reason
);
253 void CCECProcessor::ReportCECVersion(cec_logical_address address
/* = CECDEVICE_TV */)
255 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting CEC version as 1.3a");
258 cec_command::format(command
, m_iLogicalAddress
, address
, CEC_OPCODE_CEC_VERSION
);
259 command
.parameters
.push_back(CEC_VERSION_1_3A
);
264 void CCECProcessor::ReportPowerState(cec_logical_address address
/*= CECDEVICE_TV */, bool bOn
/* = true */)
267 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting \"On\" power status");
269 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting \"Off\" power status");
272 cec_command::format(command
, m_iLogicalAddress
, address
, CEC_OPCODE_REPORT_POWER_STATUS
);
273 command
.parameters
.push_back(bOn
? (uint8_t) CEC_POWER_STATUS_ON
: (uint8_t) CEC_POWER_STATUS_STANDBY
);
278 void CCECProcessor::ReportMenuState(cec_logical_address address
/* = CECDEVICE_TV */, bool bActive
/* = true */)
281 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting menu state as active");
283 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting menu state as inactive");
286 cec_command::format(command
, m_iLogicalAddress
, address
, CEC_OPCODE_MENU_STATUS
);
287 command
.parameters
.push_back(bActive
? (uint8_t) CEC_MENU_STATE_ACTIVATED
: (uint8_t) CEC_MENU_STATE_DEACTIVATED
);
292 void CCECProcessor::ReportVendorID(cec_logical_address address
/* = CECDEVICE_TV */)
294 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< vendor ID requested, feature abort");
295 TransmitAbort(address
, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
);
298 void CCECProcessor::ReportOSDName(cec_logical_address address
/* = CECDEVICE_TV */)
300 const char *osdname
= m_strDeviceName
.c_str();
302 strLog
.Format("<< reporting OSD name as %s", osdname
);
303 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
306 cec_command::format(command
, m_iLogicalAddress
, address
, CEC_OPCODE_SET_OSD_NAME
);
307 for (unsigned int iPtr
= 0; iPtr
< strlen(osdname
); iPtr
++)
308 command
.parameters
.push_back(osdname
[iPtr
]);
313 void CCECProcessor::ReportPhysicalAddress(void)
316 strLog
.Format("<< reporting physical address as %04x", m_physicaladdress
);
317 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
320 cec_command::format(command
, m_iLogicalAddress
, CECDEVICE_BROADCAST
, CEC_OPCODE_REPORT_PHYSICAL_ADDRESS
);
321 command
.parameters
.push_back((uint8_t) ((m_physicaladdress
>> 8) & 0xFF));
322 command
.parameters
.push_back((uint8_t) (m_physicaladdress
& 0xFF));
327 void CCECProcessor::BroadcastActiveSource(void)
329 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< broadcasting active source");
332 cec_command::format(command
, m_iLogicalAddress
, CECDEVICE_BROADCAST
, CEC_OPCODE_ACTIVE_SOURCE
);
333 command
.parameters
.push_back((uint8_t) ((m_physicaladdress
>> 8) & 0xFF));
334 command
.parameters
.push_back((uint8_t) (m_physicaladdress
& 0xFF));
339 bool CCECProcessor::WaitForAck(bool *bError
, uint32_t iTimeout
/* = 1000 */)
344 int64_t iNow
= GetTimeMs();
345 int64_t iTargetTime
= iNow
+ (uint64_t) iTimeout
;
347 while (!bGotAck
&& !*bError
&& (iTimeout
== 0 || iNow
< iTargetTime
))
349 cec_adapter_message msg
;
352 if (!m_communication
->Read(msg
, iTimeout
> 0 ? (int32_t)(iTargetTime
- iNow
) : 1000))
358 switch (msg
.message())
360 case MSGCODE_COMMAND_ACCEPTED
:
361 m_controller
->AddLog(CEC_LOG_DEBUG
, "MSGCODE_COMMAND_ACCEPTED");
363 case MSGCODE_TRANSMIT_SUCCEEDED
:
364 m_controller
->AddLog(CEC_LOG_DEBUG
, "MSGCODE_TRANSMIT_SUCCEEDED");
367 case MSGCODE_RECEIVE_FAILED
:
368 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_RECEIVE_FAILED");
371 case MSGCODE_COMMAND_REJECTED
:
372 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_COMMAND_REJECTED");
375 case MSGCODE_TRANSMIT_FAILED_LINE
:
376 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_LINE");
379 case MSGCODE_TRANSMIT_FAILED_ACK
:
380 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_ACK");
383 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA
:
384 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
387 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE
:
388 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
392 m_frameBuffer
.Push(msg
);
399 return bGotAck
&& !*bError
;
402 bool CCECProcessor::ParseMessage(cec_adapter_message
&msg
)
411 switch(msg
.message())
413 case MSGCODE_NOTHING
:
414 m_controller
->AddLog(CEC_LOG_DEBUG
, "MSGCODE_NOTHING");
416 case MSGCODE_TIMEOUT_ERROR
:
417 case MSGCODE_HIGH_ERROR
:
418 case MSGCODE_LOW_ERROR
:
420 if (msg
.message() == MSGCODE_TIMEOUT_ERROR
)
421 logStr
= "MSGCODE_TIMEOUT";
422 else if (msg
.message() == MSGCODE_HIGH_ERROR
)
423 logStr
= "MSGCODE_HIGH_ERROR";
425 logStr
= "MSGCODE_LOW_ERROR";
427 int iLine
= (msg
.size() >= 3) ? (msg
[1] << 8) | (msg
[2]) : 0;
428 uint32_t iTime
= (msg
.size() >= 7) ? (msg
[3] << 24) | (msg
[4] << 16) | (msg
[5] << 8) | (msg
[6]) : 0;
429 logStr
.AppendFormat(" line:%i", iLine
);
430 logStr
.AppendFormat(" time:%u", iTime
);
431 m_controller
->AddLog(CEC_LOG_WARNING
, logStr
.c_str());
434 case MSGCODE_FRAME_START
:
436 logStr
= "MSGCODE_FRAME_START";
437 m_currentframe
.clear();
440 logStr
.AppendFormat(" initiator:%u destination:%u ack:%s %s", msg
.initiator(), msg
.destination(), msg
.ack() ? "high" : "low", msg
.eom() ? "eom" : "");
441 m_currentframe
.initiator
= msg
.initiator();
442 m_currentframe
.destination
= msg
.destination();
443 m_currentframe
.ack
= msg
.ack();
444 m_currentframe
.eom
= msg
.eom();
446 m_controller
->AddLog(CEC_LOG_DEBUG
, logStr
.c_str());
449 case MSGCODE_FRAME_DATA
:
451 logStr
= "MSGCODE_FRAME_DATA";
454 uint8_t iData
= msg
[1];
455 logStr
.AppendFormat(" %02x", iData
);
456 m_currentframe
.push_back(iData
);
458 m_controller
->AddLog(CEC_LOG_DEBUG
, logStr
.c_str());
470 void CCECProcessor::ParseVendorId(cec_logical_address device
, const cec_datapacket
&data
)
474 m_controller
->AddLog(CEC_LOG_WARNING
, "invalid vendor ID received");
478 uint64_t iVendorId
= ((uint64_t)data
[0] << 3) +
479 ((uint64_t)data
[1] << 2) +
482 m_vendorIds
[(uint8_t)device
] = iVendorId
;
483 m_vendorClasses
[(uint8_t)device
] = data
.size
>= 4 ? data
[3] : 0;
486 strLog
.Format("device %d: vendor = %s (%lld) class = %2x", (uint8_t)device
, CECVendorIdToString(m_vendorIds
[(uint8_t)device
]), iVendorId
, m_vendorClasses
[(uint8_t)device
]);
487 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
490 void CCECProcessor::ParseCommand(cec_command
&command
)
493 dataStr
.Format(">> received frame: initiator: %u destination: %u", command
.initiator
, command
.destination
);
494 if (command
.parameters
.size
> 1)
497 for (uint8_t iPtr
= 0; iPtr
< command
.parameters
.size
; iPtr
++)
498 dataStr
.AppendFormat(" %02x", (unsigned int)command
.parameters
[iPtr
]);
500 m_controller
->AddLog(CEC_LOG_DEBUG
, dataStr
.c_str());
502 if (command
.destination
== m_iLogicalAddress
)
504 switch(command
.opcode
)
506 case CEC_OPCODE_GIVE_PHYSICAL_ADDRESS
:
507 ReportPhysicalAddress();
509 case CEC_OPCODE_GIVE_OSD_NAME
:
510 ReportOSDName(command
.initiator
);
512 case CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
:
513 ReportVendorID(command
.initiator
);
515 case CEC_OPCODE_VENDOR_COMMAND_WITH_ID
:
516 ParseVendorId(command
.initiator
, command
.parameters
);
517 TransmitAbort(command
.initiator
, CEC_OPCODE_VENDOR_COMMAND_WITH_ID
);
519 case CEC_OPCODE_GIVE_DECK_STATUS
:
520 // need to support opcodes play and deck control before doing anything with this
521 TransmitAbort(command
.initiator
, CEC_OPCODE_GIVE_DECK_STATUS
);
523 case CEC_OPCODE_MENU_REQUEST
:
524 if (command
.parameters
[0] == CEC_MENU_REQUEST_TYPE_QUERY
)
525 ReportMenuState(command
.initiator
);
527 case CEC_OPCODE_GIVE_DEVICE_POWER_STATUS
:
528 ReportPowerState(command
.initiator
);
531 case CEC_OPCODE_GET_CEC_VERSION
:
532 ReportCECVersion(command
.initiator
);
534 case CEC_OPCODE_USER_CONTROL_PRESSED
:
535 if (command
.parameters
.size
> 0)
537 m_controller
->AddKey();
539 if (command
.parameters
[0] <= CEC_USER_CONTROL_CODE_MAX
)
540 m_controller
->SetCurrentButton((cec_user_control_code
) command
.parameters
[0]);
543 case CEC_OPCODE_USER_CONTROL_RELEASE
:
544 m_controller
->AddKey();
546 case CEC_OPCODE_ROUTING_CHANGE
:
547 m_controller
->SetActiveView();
550 m_controller
->AddCommand(command
);
554 else if (command
.destination
== CECDEVICE_BROADCAST
)
557 if (command
.opcode
== CEC_OPCODE_REQUEST_ACTIVE_SOURCE
)
559 strLog
.Format(">> %i requests active source", (uint8_t) command
.initiator
);
560 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
561 BroadcastActiveSource();
563 else if (command
.opcode
== CEC_OPCODE_SET_STREAM_PATH
)
565 if (command
.parameters
.size
>= 2)
567 int streamaddr
= ((int)command
.parameters
[0] << 8) | ((int)command
.parameters
[1]);
568 strLog
.Format(">> %i requests stream path from physical address %04x", command
.initiator
, streamaddr
);
569 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
570 if (streamaddr
== m_physicaladdress
)
571 BroadcastActiveSource();
576 m_controller
->AddCommand(command
);
582 strLog
.Format("ignoring frame: destination: %u != %u", command
.destination
, (uint8_t)m_iLogicalAddress
);
583 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
587 const char *CCECProcessor::CECVendorIdToString(const uint64_t iVendorId
)
591 case CEC_VENDOR_SAMSUNG
: