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"
36 #include "devices/CECBusDevice.h"
37 #include "devices/CECAudioSystem.h"
38 #include "devices/CECPlaybackDevice.h"
39 #include "devices/CECRecordingDevice.h"
40 #include "devices/CECTuner.h"
41 #include "devices/CECTV.h"
42 #include "implementations/CECCommandHandler.h"
44 #include "util/StdString.h"
45 #include "platform/timeutils.h"
50 CCECProcessor::CCECProcessor(CLibCEC
*controller
, CAdapterCommunication
*serComm
, const char *strDeviceName
, cec_logical_address iLogicalAddress
/* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress
/* = CEC_DEFAULT_PHYSICAL_ADDRESS*/) :
52 m_strDeviceName(strDeviceName
),
53 m_communication(serComm
),
54 m_controller(controller
),
57 m_logicalAddresses
.clear();
58 m_logicalAddresses
.set(iLogicalAddress
);
60 for (int iPtr
= 0; iPtr
< 16; iPtr
++)
61 m_busDevices
[iPtr
] = new CCECBusDevice(this, (cec_logical_address
) iPtr
, iPtr
== iLogicalAddress
? iPhysicalAddress
: 0);
64 CCECProcessor::CCECProcessor(CLibCEC
*controller
, CAdapterCommunication
*serComm
, const char *strDeviceName
, const cec_device_type_list
&types
) :
66 m_strDeviceName(strDeviceName
),
68 m_communication(serComm
),
69 m_controller(controller
),
72 m_logicalAddresses
.clear();
73 for (int iPtr
= 0; iPtr
< 16; iPtr
++)
77 case CECDEVICE_AUDIOSYSTEM
:
78 m_busDevices
[iPtr
] = new CCECAudioSystem(this, (cec_logical_address
) iPtr
, 0xFFFF);
80 case CECDEVICE_PLAYBACKDEVICE1
:
81 case CECDEVICE_PLAYBACKDEVICE2
:
82 case CECDEVICE_PLAYBACKDEVICE3
:
83 m_busDevices
[iPtr
] = new CCECPlaybackDevice(this, (cec_logical_address
) iPtr
, 0xFFFF);
85 case CECDEVICE_RECORDINGDEVICE1
:
86 case CECDEVICE_RECORDINGDEVICE2
:
87 case CECDEVICE_RECORDINGDEVICE3
:
88 m_busDevices
[iPtr
] = new CCECRecordingDevice(this, (cec_logical_address
) iPtr
, 0xFFFF);
90 case CECDEVICE_TUNER1
:
91 case CECDEVICE_TUNER2
:
92 case CECDEVICE_TUNER3
:
93 case CECDEVICE_TUNER4
:
94 m_busDevices
[iPtr
] = new CCECTuner(this, (cec_logical_address
) iPtr
, 0xFFFF);
97 m_busDevices
[iPtr
] = new CCECTV(this, (cec_logical_address
) iPtr
, 0);
100 m_busDevices
[iPtr
] = new CCECBusDevice(this, (cec_logical_address
) iPtr
, 0xFFFF);
106 CCECProcessor::~CCECProcessor(void)
108 m_startCondition
.Broadcast();
110 m_communication
= NULL
;
112 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
113 delete m_busDevices
[iPtr
];
116 bool CCECProcessor::Start(void)
118 CLockObject
lock(&m_mutex
);
119 if (!m_communication
|| !m_communication
->IsOpen())
121 m_controller
->AddLog(CEC_LOG_ERROR
, "connection is closed");
127 if (!m_startCondition
.Wait(&m_mutex
) || !m_bStarted
)
129 m_controller
->AddLog(CEC_LOG_ERROR
, "could not create a processor thread");
135 m_controller
->AddLog(CEC_LOG_ERROR
, "could not create a processor thread");
140 bool CCECProcessor::TryLogicalAddress(cec_logical_address address
, unsigned int iIndex
)
142 const char *strLabel
= CCECCommandHandler::ToString(address
);
144 strLog
.Format("trying logical address '%s'", strLabel
);
145 AddLog(CEC_LOG_DEBUG
, strLog
);
147 SetAckMask(0x1 << address
);
148 if (!m_busDevices
[address
]->TransmitPoll(address
))
150 strLog
.Format("using logical address '%s'", strLabel
);
151 AddLog(CEC_LOG_NOTICE
, strLog
);
153 /* only set our OSD name and active source for the primary device */
154 if (m_logicalAddresses
.empty())
156 m_busDevices
[address
]->m_strDeviceName
= m_strDeviceName
;
157 m_busDevices
[address
]->m_bActiveSource
= true;
159 m_busDevices
[address
]->m_powerStatus
= CEC_POWER_STATUS_STANDBY
;
160 m_busDevices
[address
]->m_cecVersion
= CEC_VERSION_1_3A
;
161 m_logicalAddresses
.set(address
);
164 m_busDevices
[address
]->SetPhysicalAddress((uint16_t)CEC_DEFAULT_PHYSICAL_ADDRESS
+ ((uint16_t)iIndex
* 0x100));
169 strLog
.Format("logical address '%s' already taken", strLabel
);
170 AddLog(CEC_LOG_DEBUG
, strLog
);
174 bool CCECProcessor::FindLogicalAddressRecordingDevice(unsigned int iIndex
)
176 AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'recording device'");
177 return TryLogicalAddress(CECDEVICE_RECORDINGDEVICE1
, iIndex
) ||
178 TryLogicalAddress(CECDEVICE_RECORDINGDEVICE2
, iIndex
) ||
179 TryLogicalAddress(CECDEVICE_RECORDINGDEVICE3
, iIndex
);
182 bool CCECProcessor::FindLogicalAddressTuner(unsigned int iIndex
)
184 AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'tuner'");
185 return TryLogicalAddress(CECDEVICE_TUNER1
, iIndex
) ||
186 TryLogicalAddress(CECDEVICE_TUNER2
, iIndex
) ||
187 TryLogicalAddress(CECDEVICE_TUNER3
, iIndex
) ||
188 TryLogicalAddress(CECDEVICE_TUNER4
, iIndex
);
191 bool CCECProcessor::FindLogicalAddressPlaybackDevice(unsigned int iIndex
)
193 AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'playback device'");
194 return TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE1
, iIndex
) ||
195 TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE2
, iIndex
) ||
196 TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE3
, iIndex
);
199 bool CCECProcessor::FindLogicalAddressAudioSystem(unsigned int iIndex
)
201 AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'audio'");
202 return TryLogicalAddress(CECDEVICE_AUDIOSYSTEM
, iIndex
);
205 bool CCECProcessor::FindLogicalAddresses(void)
208 m_logicalAddresses
.clear();
211 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
213 if (m_types
.types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
216 strLog
.Format("%s - device %d: type %d", __FUNCTION__
, iPtr
, m_types
.types
[iPtr
]);
217 AddLog(CEC_LOG_DEBUG
, strLog
);
219 if (m_types
.types
[iPtr
] == CEC_DEVICE_TYPE_RECORDING_DEVICE
)
220 bReturn
&= FindLogicalAddressRecordingDevice(iPtr
);
221 if (m_types
.types
[iPtr
] == CEC_DEVICE_TYPE_TUNER
)
222 bReturn
&= FindLogicalAddressTuner(iPtr
);
223 if (m_types
.types
[iPtr
] == CEC_DEVICE_TYPE_PLAYBACK_DEVICE
)
224 bReturn
&= FindLogicalAddressPlaybackDevice(iPtr
);
225 if (m_types
.types
[iPtr
] == CEC_DEVICE_TYPE_AUDIO_SYSTEM
)
226 bReturn
&= FindLogicalAddressAudioSystem(iPtr
);
232 void *CCECProcessor::Process(void)
234 bool bParseFrame(false);
236 CCECAdapterMessage msg
;
239 if (m_logicalAddresses
.empty() && !FindLogicalAddresses())
241 CLockObject
lock(&m_mutex
);
242 m_controller
->AddLog(CEC_LOG_ERROR
, "could not detect our logical addressed");
243 m_startCondition
.Signal();
247 SetAckMask(m_logicalAddresses
.ackmask());
250 CLockObject
lock(&m_mutex
);
251 m_controller
->AddLog(CEC_LOG_DEBUG
, "processor thread started");
253 m_startCondition
.Signal();
263 CLockObject
lock(&m_mutex
);
264 if (m_commandBuffer
.Pop(command
))
268 else if (m_communication
->IsOpen() && m_communication
->Read(msg
, 50))
270 m_controller
->AddLog(msg
.is_error() ? CEC_LOG_WARNING
: CEC_LOG_DEBUG
, msg
.ToString());
271 if ((bParseFrame
= (ParseMessage(msg
) && !IsStopped())) == true)
272 command
= m_currentframe
;
277 ParseCommand(command
);
282 m_controller
->CheckKeypressTimeout();
284 for (unsigned int iDevicePtr
= 0; iDevicePtr
< 16; iDevicePtr
++)
285 m_busDevices
[iDevicePtr
]->PollVendorId();
293 bool CCECProcessor::SetActiveSource(cec_device_type type
/* = CEC_DEVICE_TYPE_RESERVED */)
300 cec_logical_address addr
= m_logicalAddresses
.primary
;
302 if (type
!= CEC_DEVICE_TYPE_RESERVED
)
304 for (uint8_t iPtr
= 0; iPtr
< 16; iPtr
++)
306 if (m_logicalAddresses
[iPtr
] && m_busDevices
[iPtr
]->m_type
== type
)
308 addr
= (cec_logical_address
) iPtr
;
314 return SetStreamPath(m_busDevices
[addr
]->GetPhysicalAddress());
317 bool CCECProcessor::SetActiveView(void)
319 return SetActiveSource();
322 bool CCECProcessor::SetStreamPath(uint16_t iStreamPath
)
326 CCECBusDevice
*device
= GetDeviceByPhysicalAddress(iStreamPath
);
329 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
330 m_busDevices
[iPtr
]->m_bActiveSource
= false;
332 device
->m_bActiveSource
= true;
333 device
->m_powerStatus
= CEC_POWER_STATUS_ON
;
335 if (m_logicalAddresses
.isset(device
->m_iLogicalAddress
))
336 bReturn
= device
->TransmitActiveSource();
344 bool CCECProcessor::SetInactiveView(void)
349 if (!m_logicalAddresses
.empty() && m_busDevices
[m_logicalAddresses
.primary
])
350 return m_busDevices
[m_logicalAddresses
.primary
]->TransmitInactiveView();
354 void CCECProcessor::LogOutput(const cec_command
&data
)
357 strTx
.Format("<< %02x", ((uint8_t)data
.initiator
<< 4) + (uint8_t)data
.destination
);
359 strTx
.AppendFormat(":%02x", (uint8_t)data
.opcode
);
361 for (uint8_t iPtr
= 0; iPtr
< data
.parameters
.size
; iPtr
++)
362 strTx
.AppendFormat(":%02x", data
.parameters
[iPtr
]);
363 m_controller
->AddLog(CEC_LOG_TRAFFIC
, strTx
.c_str());
366 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress
)
368 if (m_logicalAddresses
.primary
!= iLogicalAddress
)
371 strLog
.Format("<< setting primary logical address to %1x", iLogicalAddress
);
372 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
373 m_logicalAddresses
.primary
= iLogicalAddress
;
374 m_logicalAddresses
.set(iLogicalAddress
);
375 return SetAckMask(m_logicalAddresses
.ackmask());
381 bool CCECProcessor::SetPhysicalAddress(uint16_t iPhysicalAddress
)
383 if (!m_logicalAddresses
.empty() && m_busDevices
[m_logicalAddresses
.primary
])
385 m_busDevices
[m_logicalAddresses
.primary
]->SetPhysicalAddress(iPhysicalAddress
);
386 return SetActiveView();
391 bool CCECProcessor::SwitchMonitoring(bool bEnable
)
394 strLog
.Format("== %s monitoring mode ==", bEnable
? "enabling" : "disabling");
395 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
397 m_bMonitor
= bEnable
;
399 return SetAckMask(0);
401 return SetAckMask(m_logicalAddresses
.ackmask());
404 bool CCECProcessor::PollDevice(cec_logical_address iAddress
)
406 if (iAddress
!= CECDEVICE_UNKNOWN
&& m_busDevices
[iAddress
])
407 return m_busDevices
[m_logicalAddresses
.primary
]->TransmitPoll(iAddress
);
412 CCECBusDevice
*CCECProcessor::GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress
) const
414 CCECBusDevice
*device
= NULL
;
416 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
418 if (m_busDevices
[iPtr
]->GetPhysicalAddress() == iPhysicalAddress
)
420 device
= m_busDevices
[iPtr
];
428 cec_version
CCECProcessor::GetDeviceCecVersion(cec_logical_address iAddress
)
430 return m_busDevices
[iAddress
]->GetCecVersion();
433 bool CCECProcessor::GetDeviceMenuLanguage(cec_logical_address iAddress
, cec_menu_language
*language
)
435 if (m_busDevices
[iAddress
])
437 *language
= m_busDevices
[iAddress
]->GetMenuLanguage();
438 return (strcmp(language
->language
, "???") != 0);
443 uint64_t CCECProcessor::GetDeviceVendorId(cec_logical_address iAddress
)
445 if (m_busDevices
[iAddress
])
446 return m_busDevices
[iAddress
]->GetVendorId();
450 cec_power_status
CCECProcessor::GetDevicePowerStatus(cec_logical_address iAddress
)
452 if (m_busDevices
[iAddress
])
453 return m_busDevices
[iAddress
]->GetPowerStatus();
454 return CEC_POWER_STATUS_UNKNOWN
;
457 bool CCECProcessor::Transmit(const cec_command
&data
)
462 CCECAdapterMessage
*output
= new CCECAdapterMessage(data
);
463 bReturn
= Transmit(output
);
469 bool CCECProcessor::Transmit(CCECAdapterMessage
*output
)
472 CLockObject
lock(&m_mutex
);
474 CLockObject
msgLock(&output
->mutex
);
475 if (!m_communication
|| !m_communication
->Write(output
))
479 output
->condition
.Wait(&output
->mutex
);
480 if (output
->state
!= ADAPTER_MESSAGE_STATE_SENT
)
482 m_controller
->AddLog(CEC_LOG_ERROR
, "command was not sent");
487 if (output
->transmit_timeout
> 0)
489 if ((bReturn
= WaitForTransmitSucceeded(output
->size(), output
->transmit_timeout
)) == false)
490 m_controller
->AddLog(CEC_LOG_DEBUG
, "did not receive ack");
499 void CCECProcessor::TransmitAbort(cec_logical_address address
, cec_opcode opcode
, ECecAbortReason reason
/* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
501 m_controller
->AddLog(CEC_LOG_DEBUG
, "<< transmitting abort message");
505 cec_command::format(command
, m_logicalAddresses
.primary
, address
, CEC_OPCODE_FEATURE_ABORT
);
506 command
.parameters
.push_back((uint8_t)opcode
);
507 command
.parameters
.push_back((uint8_t)reason
);
512 bool CCECProcessor::WaitForTransmitSucceeded(uint8_t iLength
, uint32_t iTimeout
/* = 1000 */)
515 bool bTransmitSucceeded(false);
516 uint8_t iPacketsLeft(iLength
/ 4);
518 int64_t iNow
= GetTimeMs();
519 int64_t iTargetTime
= iNow
+ (uint64_t) iTimeout
;
521 while (!bTransmitSucceeded
&& !bError
&& (iTimeout
== 0 || iNow
< iTargetTime
))
523 CCECAdapterMessage msg
;
525 if (!m_communication
->Read(msg
, iTimeout
> 0 ? (int32_t)(iTargetTime
- iNow
) : 1000))
531 if ((bError
= msg
.is_error()) == false)
533 m_controller
->AddLog(bError
? CEC_LOG_WARNING
: CEC_LOG_DEBUG
, msg
.ToString());
535 switch(msg
.message())
537 case MSGCODE_COMMAND_ACCEPTED
:
538 if (iPacketsLeft
> 0)
541 case MSGCODE_TRANSMIT_SUCCEEDED
:
542 bTransmitSucceeded
= (iPacketsLeft
== 0);
543 bError
= !bTransmitSucceeded
;
546 if (ParseMessage(msg
))
547 m_commandBuffer
.Push(m_currentframe
);
554 return bTransmitSucceeded
&& !bError
;
557 bool CCECProcessor::ParseMessage(const CCECAdapterMessage
&msg
)
564 switch(msg
.message())
566 case MSGCODE_FRAME_START
:
568 m_currentframe
.clear();
571 m_currentframe
.initiator
= msg
.initiator();
572 m_currentframe
.destination
= msg
.destination();
573 m_currentframe
.ack
= msg
.ack();
574 m_currentframe
.eom
= msg
.eom();
578 case MSGCODE_FRAME_DATA
:
582 m_currentframe
.push_back(msg
[1]);
583 m_currentframe
.eom
= msg
.eom();
595 void CCECProcessor::ParseCommand(cec_command
&command
)
598 dataStr
.Format(">> %1x%1x:%02x", command
.initiator
, command
.destination
, command
.opcode
);
599 for (uint8_t iPtr
= 0; iPtr
< command
.parameters
.size
; iPtr
++)
600 dataStr
.AppendFormat(":%02x", (unsigned int)command
.parameters
[iPtr
]);
601 m_controller
->AddLog(CEC_LOG_TRAFFIC
, dataStr
.c_str());
604 m_busDevices
[(uint8_t)command
.initiator
]->HandleCommand(command
);
607 uint16_t CCECProcessor::GetPhysicalAddress(void) const
609 if (!m_logicalAddresses
.empty() && m_busDevices
[m_logicalAddresses
.primary
])
610 return m_busDevices
[m_logicalAddresses
.primary
]->GetPhysicalAddress();
614 void CCECProcessor::SetCurrentButton(cec_user_control_code iButtonCode
)
616 m_controller
->SetCurrentButton(iButtonCode
);
619 void CCECProcessor::AddCommand(const cec_command
&command
)
621 m_controller
->AddCommand(command
);
624 void CCECProcessor::AddKey(cec_keypress
&key
)
626 m_controller
->AddKey(key
);
629 void CCECProcessor::AddKey(void)
631 m_controller
->AddKey();
634 void CCECProcessor::AddLog(cec_log_level level
, const CStdString
&strMessage
)
636 m_controller
->AddLog(level
, strMessage
);
639 bool CCECProcessor::SetAckMask(uint16_t iMask
)
643 strLog
.Format("setting ackmask to %2x", iMask
);
644 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
646 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
648 output
->push_back(MSGSTART
);
649 output
->push_escaped(MSGCODE_SET_ACK_MASK
);
650 output
->push_escaped(iMask
>> 8);
651 output
->push_escaped((uint8_t)iMask
);
652 output
->push_back(MSGEND
);
654 if ((bReturn
= Transmit(output
)) == false)
655 m_controller
->AddLog(CEC_LOG_ERROR
, "could not set the ackmask");