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
)
52 CCECProcessor::~CCECProcessor(void)
55 m_communication
= NULL
;
59 bool CCECProcessor::Start(void)
61 if (!m_communication
|| !m_communication
->IsOpen())
63 m_controller
->AddLog(CEC_LOG_ERROR
, "connection is closed");
67 if (!SetLogicalAddress(m_iLogicalAddress
))
69 m_controller
->AddLog(CEC_LOG_ERROR
, "could not set the logical address");
76 m_controller
->AddLog(CEC_LOG_ERROR
, "could not create a processor thread");
81 void *CCECProcessor::Process(void)
83 m_controller
->AddLog(CEC_LOG_DEBUG
, "processor thread started");
87 bool bParseFrame(false);
92 CLockObject
lock(&m_mutex
);
93 if (m_communication
->IsOpen() && m_communication
->Read(msg
, 50))
94 bParseFrame
= ParseMessage(msg
) && !IsStopped();
104 ParseCurrentFrame(msg
);
106 m_controller
->CheckKeypressTimeout();
115 bool CCECProcessor::PowerOnDevices(cec_logical_address address
/* = CECDEVICE_TV */)
121 strLog
.Format("<< powering on device with logical address %d", (int8_t)address
);
122 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
126 frame
.push_back(GetSourceDestination(address
));
127 frame
.push_back((uint8_t) CEC_OPCODE_IMAGE_VIEW_ON
);
128 return Transmit(frame
);
131 bool CCECProcessor::StandbyDevices(cec_logical_address address
/* = CECDEVICE_BROADCAST */)
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());
142 frame
.push_back(GetSourceDestination(address
));
143 frame
.push_back((uint8_t) CEC_OPCODE_STANDBY
);
144 return Transmit(frame
);
147 bool CCECProcessor::SetActiveView(void)
152 m_controller
->AddLog(CEC_LOG_DEBUG
, "<< setting active view");
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
);
163 bool CCECProcessor::SetInactiveView(void)
168 m_controller
->AddLog(CEC_LOG_DEBUG
, "<< setting inactive view");
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
);
179 bool CCECProcessor::Transmit(const cec_frame
&data
, bool bWaitForAck
/* = true */)
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());
188 m_controller
->AddLog(CEC_LOG_WARNING
, "transmit buffer is empty");
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
);
200 if ((data
.data
[0] & 0xF) == 0xF)
201 CAdapterCommunication::PushEscaped(output
, CEC_TRUE
);
203 CAdapterCommunication::PushEscaped(output
, CEC_FALSE
);
205 output
.push_back(MSGEND
);
207 for (int8_t i
= 0; i
< data
.size
; i
++)
209 output
.push_back(MSGSTART
);
211 if (i
== (int8_t)data
.size
- 1)
212 CAdapterCommunication::PushEscaped(output
, MSGCODE_TRANSMIT_EOM
);
214 CAdapterCommunication::PushEscaped(output
, MSGCODE_TRANSMIT
);
216 CAdapterCommunication::PushEscaped(output
, data
.data
[i
]);
218 output
.push_back(MSGEND
);
221 return TransmitFormatted(output
, bWaitForAck
);
224 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress
)
227 strLog
.Format("<< setting logical address to %d", iLogicalAddress
);
228 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
230 m_iLogicalAddress
= iLogicalAddress
;
231 return m_communication
&& m_communication
->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress
);
234 bool CCECProcessor::TransmitFormatted(const cec_frame
&data
, bool bWaitForAck
/* = true */)
236 CLockObject
lock(&m_mutex
);
237 if (!m_communication
|| !m_communication
->Write(data
))
242 uint64_t now
= GetTimeMs();
243 uint64_t target
= now
+ 1000;
247 while (!bGotAck
&& now
< target
)
249 bGotAck
= WaitForAck(&bError
, (uint64_t) (target
- now
));
252 if (bError
&& now
< target
)
254 m_controller
->AddLog(CEC_LOG_ERROR
, "retransmitting previous frame");
255 if (!m_communication
->Write(data
))
264 void CCECProcessor::TransmitAbort(cec_logical_address address
, cec_opcode opcode
, ECecAbortReason reason
/* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
266 m_controller
->AddLog(CEC_LOG_DEBUG
, "transmitting abort message");
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
);
277 void CCECProcessor::ReportCECVersion(cec_logical_address address
/* = CECDEVICE_TV */)
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
);
289 void CCECProcessor::ReportPowerState(cec_logical_address address
/*= CECDEVICE_TV */, bool bOn
/* = true */)
295 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting \"On\" power status");
297 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting \"Off\" power status");
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
);
305 void CCECProcessor::ReportMenuState(cec_logical_address address
/* = CECDEVICE_TV */, bool bActive
/* = true */)
311 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting menu state as active");
313 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< reporting menu state as inactive");
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
);
321 void CCECProcessor::ReportVendorID(cec_logical_address address
/* = CECDEVICE_TV */)
323 m_controller
->AddLog(CEC_LOG_NOTICE
, "<< vendor ID requested, feature abort");
324 TransmitAbort(address
, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
);
327 void CCECProcessor::ReportOSDName(cec_logical_address address
/* = CECDEVICE_TV */)
332 const char *osdname
= m_strDeviceName
.c_str();
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
);
339 for (unsigned int i
= 0; i
< strlen(osdname
); i
++)
340 frame
.push_back(osdname
[i
]);
345 void CCECProcessor::ReportPhysicalAddress(void)
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
);
361 void CCECProcessor::BroadcastActiveSource(void)
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));
374 uint8_t CCECProcessor::GetSourceDestination(cec_logical_address destination
/* = CECDEVICE_BROADCAST */) const
376 return ((uint8_t)m_iLogicalAddress
<< 4) + (uint8_t)destination
;
379 bool CCECProcessor::WaitForAck(bool *bError
, uint32_t iTimeout
/* = 1000 */)
384 int64_t iNow
= GetTimeMs();
385 int64_t iTargetTime
= iNow
+ (uint64_t) iTimeout
;
387 while (!bGotAck
&& !bError
&& (iTimeout
== 0 || iNow
< iTargetTime
))
392 while (!bGotAck
&& !bError
&& m_communication
->Read(msg
, iTimeout
))
394 uint8_t iCode
= msg
.data
[0] & ~(MSGCODE_FRAME_EOM
| MSGCODE_FRAME_ACK
);
398 case MSGCODE_COMMAND_ACCEPTED
:
399 m_controller
->AddLog(CEC_LOG_DEBUG
, "MSGCODE_COMMAND_ACCEPTED");
401 case MSGCODE_TRANSMIT_SUCCEEDED
:
402 m_controller
->AddLog(CEC_LOG_DEBUG
, "MSGCODE_TRANSMIT_SUCCEEDED");
406 case MSGCODE_RECEIVE_FAILED
:
407 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_RECEIVE_FAILED");
410 case MSGCODE_COMMAND_REJECTED
:
411 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_COMMAND_REJECTED");
414 case MSGCODE_TRANSMIT_FAILED_LINE
:
415 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_LINE");
418 case MSGCODE_TRANSMIT_FAILED_ACK
:
419 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_ACK");
422 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA
:
423 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
426 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE
:
427 m_controller
->AddLog(CEC_LOG_WARNING
, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
431 m_frameBuffer
.Push(msg
);
438 return bGotAck
&& !bError
;
441 bool CCECProcessor::ParseMessage(cec_frame
&msg
)
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;
455 case MSGCODE_NOTHING
:
456 m_controller
->AddLog(CEC_LOG_DEBUG
, "MSGCODE_NOTHING");
458 case MSGCODE_TIMEOUT_ERROR
:
459 case MSGCODE_HIGH_ERROR
:
460 case MSGCODE_LOW_ERROR
:
462 if (iCode
== MSGCODE_TIMEOUT_ERROR
)
463 logStr
= "MSGCODE_TIMEOUT";
464 else if (iCode
== MSGCODE_HIGH_ERROR
)
465 logStr
= "MSGCODE_HIGH_ERROR";
467 logStr
= "MSGCODE_LOW_ERROR";
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());
476 case MSGCODE_FRAME_START
:
478 logStr
= "MSGCODE_FRAME_START";
479 m_currentframe
.clear();
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" : "");
486 m_currentframe
.push_back(msg
.data
[1]);
488 m_controller
->AddLog(CEC_LOG_DEBUG
, logStr
.c_str());
491 case MSGCODE_FRAME_DATA
:
493 logStr
= "MSGCODE_FRAME_DATA";
496 uint8_t iData
= msg
.data
[1];
497 logStr
.AppendFormat(" %02x", iData
);
498 m_currentframe
.push_back(iData
);
500 m_controller
->AddLog(CEC_LOG_DEBUG
, logStr
.c_str());
512 void CCECProcessor::ParseCurrentFrame(cec_frame
&frame
)
514 uint8_t initiator
= frame
.data
[0] >> 4;
515 uint8_t destination
= frame
.data
[0] & 0xF;
518 dataStr
.Format(">> received frame: initiator: %u destination: %u", initiator
, destination
);
523 for (unsigned int i
= 1; i
< frame
.size
; i
++)
524 dataStr
.AppendFormat(" %02x", frame
.data
[i
]);
526 m_controller
->AddLog(CEC_LOG_DEBUG
, dataStr
.c_str());
531 cec_opcode opCode
= (cec_opcode
) frame
.data
[1];
532 if (destination
== (uint16_t) m_iLogicalAddress
)
536 case CEC_OPCODE_GIVE_PHYSICAL_ADDRESS
:
537 ReportPhysicalAddress();
540 case CEC_OPCODE_GIVE_OSD_NAME
:
541 ReportOSDName((cec_logical_address
)initiator
);
543 case CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
:
544 ReportVendorID((cec_logical_address
)initiator
);
546 case CEC_OPCODE_MENU_REQUEST
:
547 ReportMenuState((cec_logical_address
)initiator
);
549 case CEC_OPCODE_GIVE_DEVICE_POWER_STATUS
:
550 ReportPowerState((cec_logical_address
)initiator
);
552 case CEC_OPCODE_GET_CEC_VERSION
:
553 ReportCECVersion((cec_logical_address
)initiator
);
555 case CEC_OPCODE_USER_CONTROL_PRESSED
:
558 m_controller
->AddKey();
560 if (frame
.data
[2] <= CEC_USER_CONTROL_CODE_MAX
)
561 m_controller
->SetCurrentButton((cec_user_control_code
) frame
.data
[2]);
564 case CEC_OPCODE_USER_CONTROL_RELEASE
:
565 m_controller
->AddKey();
568 cec_frame params
= frame
;
570 m_controller
->AddCommand((cec_logical_address
) initiator
, (cec_logical_address
) destination
, opCode
, ¶ms
);
574 else if (destination
== (uint8_t) CECDEVICE_BROADCAST
)
577 if (opCode
== CEC_OPCODE_REQUEST_ACTIVE_SOURCE
)
579 strLog
.Format(">> %i requests active source", initiator
);
580 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
581 BroadcastActiveSource();
583 else if (opCode
== CEC_OPCODE_SET_STREAM_PATH
)
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();
596 cec_frame params
= frame
;
598 m_controller
->AddCommand((cec_logical_address
) initiator
, (cec_logical_address
) destination
, opCode
, ¶ms
);
604 strLog
.Format("ignoring frame: destination: %u != %u", destination
, (uint16_t)m_iLogicalAddress
);
605 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());