2 * This file is part of the libCEC(R) library.
4 * libCEC(R) is Copyright (C) 2011-2013 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/
34 #include "CECProcessor.h"
36 #include "adapter/AdapterFactory.h"
37 #include "devices/CECBusDevice.h"
38 #include "devices/CECAudioSystem.h"
39 #include "devices/CECPlaybackDevice.h"
40 #include "devices/CECRecordingDevice.h"
41 #include "devices/CECTuner.h"
42 #include "devices/CECTV.h"
43 #include "implementations/CECCommandHandler.h"
45 #include "CECClient.h"
46 #include "CECTypeUtils.h"
47 #include "platform/util/timeutils.h"
48 #include "platform/util/util.h"
52 using namespace PLATFORM
;
54 #define CEC_PROCESSOR_SIGNAL_WAIT_TIME 1000
55 #define ACTIVE_SOURCE_CHECK_INTERVAL 500
56 #define TV_PRESENT_CHECK_INTERVAL 30000
58 #define ToString(x) CCECTypeUtils::ToString(x)
60 CCECProcessor::CCECProcessor(CLibCEC
*libcec
) :
61 m_bInitialised(false),
62 m_communication(NULL
),
64 m_iStandardLineTimeout(3),
65 m_iRetryLineTimeout(3),
66 m_iLastTransmission(0),
68 m_addrAllocator(NULL
),
69 m_bStallCommunication(false)
71 m_busDevices
= new CCECDeviceMap(this);
74 CCECProcessor::~CCECProcessor(void)
76 m_bStallCommunication
= false;
77 DELETE_AND_NULL(m_addrAllocator
);
79 DELETE_AND_NULL(m_busDevices
);
82 bool CCECProcessor::Start(const char *strPort
, uint16_t iBaudRate
/* = CEC_SERIAL_DEFAULT_BAUDRATE */, uint32_t iTimeoutMs
/* = CEC_DEFAULT_CONNECT_TIMEOUT */)
84 CLockObject
lock(m_mutex
);
86 if (!OpenConnection(strPort
, iBaudRate
, iTimeoutMs
))
89 // create the processor thread
94 m_libcec
->AddLog(CEC_LOG_ERROR
, "could not create a processor thread");
102 void CCECProcessor::Close(void)
104 // mark as uninitialised
105 SetCECInitialised(false);
107 // stop the processor
109 m_inBuffer
.Broadcast();
112 // close the connection
113 DELETE_AND_NULL(m_communication
);
116 void CCECProcessor::ResetMembers(void)
118 // close the connection
119 DELETE_AND_NULL(m_communication
);
121 // reset the other members to the initial state
122 m_iStandardLineTimeout
= 3;
123 m_iRetryLineTimeout
= 3;
124 m_iLastTransmission
= 0;
125 m_busDevices
->ResetDeviceStatus();
128 bool CCECProcessor::OpenConnection(const char *strPort
, uint16_t iBaudRate
, uint32_t iTimeoutMs
, bool bStartListening
/* = true */)
131 CTimeout
timeout(iTimeoutMs
> 0 ? iTimeoutMs
: CEC_DEFAULT_TRANSMIT_WAIT
);
133 // ensure that a previous connection is closed
136 // reset all member to the initial state
139 // check whether the Close() method deleted any previous connection
142 m_libcec
->AddLog(CEC_LOG_ERROR
, "previous connection could not be closed");
146 // create a new connection
147 m_communication
= CAdapterFactory(this->m_libcec
).GetInstance(strPort
, iBaudRate
);
149 // open a new connection
150 unsigned iConnectTry(0);
151 while (timeout
.TimeLeft() > 0 && (bReturn
= m_communication
->Open((timeout
.TimeLeft() / CEC_CONNECT_TRIES
), false, bStartListening
)) == false)
153 m_libcec
->AddLog(CEC_LOG_ERROR
, "could not open a connection (try %d)", ++iConnectTry
);
154 m_communication
->Close();
155 CEvent::Sleep(CEC_DEFAULT_CONNECT_RETRY_WAIT
);
158 m_libcec
->AddLog(CEC_LOG_NOTICE
, "connection opened");
160 // mark as initialised
161 SetCECInitialised(true);
166 bool CCECProcessor::CECInitialised(void)
168 CLockObject
lock(m_threadMutex
);
169 return m_bInitialised
;
172 void CCECProcessor::SetCECInitialised(bool bSetTo
/* = true */)
175 CLockObject
lock(m_mutex
);
176 m_bInitialised
= bSetTo
;
182 bool CCECProcessor::TryLogicalAddress(cec_logical_address address
, cec_version libCECSpecVersion
/* = CEC_VERSION_1_4 */)
185 CCECBusDevice
*device
= m_busDevices
->At(address
);
188 // check if it's already marked as present or used
189 if (device
->IsPresent() || device
->IsHandledByLibCEC())
192 // poll the LA if not
193 return device
->TryLogicalAddress(libCECSpecVersion
);
199 void CCECProcessor::ReplaceHandlers(void)
201 if (!CECInitialised())
205 for (CECDEVICEMAP::iterator it
= m_busDevices
->Begin(); it
!= m_busDevices
->End(); it
++)
206 it
->second
->ReplaceHandler(true);
209 bool CCECProcessor::OnCommandReceived(const cec_command
&command
)
211 return m_inBuffer
.Push(command
);
214 void *CCECProcessor::Process(void)
216 m_libcec
->AddLog(CEC_LOG_DEBUG
, "processor thread started");
218 cec_command command
; command
.Clear();
219 CTimeout
activeSourceCheck(ACTIVE_SOURCE_CHECK_INTERVAL
);
220 CTimeout
tvPresentCheck(TV_PRESENT_CHECK_INTERVAL
);
222 // as long as we're not being stopped and the connection is open
223 while (!IsStopped() && m_communication
->IsOpen())
225 // wait for a new incoming command, and process it
226 if (m_inBuffer
.Pop(command
, CEC_PROCESSOR_SIGNAL_WAIT_TIME
))
227 ProcessCommand(command
);
229 if (CECInitialised() && !IsStopped())
231 // check clients for keypress timeouts
232 m_libcec
->CheckKeypressTimeout();
234 // check if we need to replace handlers
237 // check whether we need to activate a source, if it failed before
238 if (activeSourceCheck
.TimeLeft() == 0)
240 if (CECInitialised())
241 TransmitPendingActiveSourceCommands();
242 activeSourceCheck
.Init(ACTIVE_SOURCE_CHECK_INTERVAL
);
245 // check whether the TV is present and responding
246 if (tvPresentCheck
.TimeLeft() == 0)
248 if (!m_busDevices
->At(CECDEVICE_TV
)->IsPresent())
250 libcec_parameter param
;
251 param
.paramType
= CEC_PARAMETER_TYPE_STRING
;
252 param
.paramData
= (void*)"TV does not respond to CEC polls";
253 GetPrimaryClient()->Alert(CEC_ALERT_TV_POLL_FAILED
, param
);
255 tvPresentCheck
.Init(TV_PRESENT_CHECK_INTERVAL
);
263 bool CCECProcessor::ActivateSource(uint16_t iStreamPath
)
267 // find the device with the given PA
268 CCECBusDevice
*device
= GetDeviceByPhysicalAddress(iStreamPath
);
269 // and make it the active source when found
271 bReturn
= device
->ActivateSource();
273 m_libcec
->AddLog(CEC_LOG_DEBUG
, "device with PA '%04x' not found", iStreamPath
);
278 void CCECProcessor::SetActiveSource(bool bSetTo
, bool bClientUnregistered
)
281 m_communication
->SetActiveSource(bSetTo
, bClientUnregistered
);
284 void CCECProcessor::SetStandardLineTimeout(uint8_t iTimeout
)
286 CLockObject
lock(m_mutex
);
287 m_iStandardLineTimeout
= iTimeout
;
290 uint8_t CCECProcessor::GetStandardLineTimeout(void)
292 CLockObject
lock(m_mutex
);
293 return m_iStandardLineTimeout
;
296 void CCECProcessor::SetRetryLineTimeout(uint8_t iTimeout
)
298 CLockObject
lock(m_mutex
);
299 m_iRetryLineTimeout
= iTimeout
;
302 uint8_t CCECProcessor::GetRetryLineTimeout(void)
304 CLockObject
lock(m_mutex
);
305 return m_iRetryLineTimeout
;
308 bool CCECProcessor::PhysicalAddressInUse(uint16_t iPhysicalAddress
)
310 CCECBusDevice
*device
= GetDeviceByPhysicalAddress(iPhysicalAddress
);
311 return device
!= NULL
;
314 void CCECProcessor::LogOutput(const cec_command
&data
)
318 // initiator and destination
319 strTx
.Format("<< %02x", ((uint8_t)data
.initiator
<< 4) + (uint8_t)data
.destination
);
323 strTx
.AppendFormat(":%02x", (uint8_t)data
.opcode
);
325 // append the parameters
326 for (uint8_t iPtr
= 0; iPtr
< data
.parameters
.size
; iPtr
++)
327 strTx
.AppendFormat(":%02x", data
.parameters
[iPtr
]);
330 m_libcec
->AddLog(CEC_LOG_TRAFFIC
, strTx
.c_str());
333 bool CCECProcessor::PollDevice(cec_logical_address iAddress
)
335 // try to find the primary device
336 CCECBusDevice
*primary
= GetPrimaryDevice();
337 // poll the destination, with the primary as source
339 return primary
->TransmitPoll(iAddress
, true);
341 CCECBusDevice
*device
= m_busDevices
->At(CECDEVICE_UNREGISTERED
);
343 return device
->TransmitPoll(iAddress
, true);
348 CCECBusDevice
*CCECProcessor::GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress
, bool bSuppressUpdate
/* = true */)
350 return m_busDevices
?
351 m_busDevices
->GetDeviceByPhysicalAddress(iPhysicalAddress
, bSuppressUpdate
) :
355 CCECBusDevice
*CCECProcessor::GetDevice(cec_logical_address address
) const
357 return m_busDevices
?
358 m_busDevices
->At(address
) :
362 cec_logical_address
CCECProcessor::GetActiveSource(bool bRequestActiveSource
/* = true */)
364 // get the device that is marked as active source from the device map
365 CCECBusDevice
*activeSource
= m_busDevices
->GetActiveSource();
367 return activeSource
->GetLogicalAddress();
369 if (bRequestActiveSource
)
371 // request the active source from the bus
372 CCECBusDevice
*primary
= GetPrimaryDevice();
375 primary
->RequestActiveSource();
376 return GetActiveSource(false);
381 return CECDEVICE_UNKNOWN
;
384 bool CCECProcessor::IsActiveSource(cec_logical_address iAddress
)
386 CCECBusDevice
*device
= m_busDevices
->At(iAddress
);
387 return device
&& device
->IsActiveSource();
390 bool CCECProcessor::Transmit(const cec_command
&data
, bool bIsReply
)
392 cec_command
transmitData(data
);
393 uint8_t iMaxTries(0);
397 // get the current timeout setting
398 uint8_t iLineTimeout(GetStandardLineTimeout());
400 // reset the state of this message to 'unknown'
401 cec_adapter_message_state adapterState
= ADAPTER_MESSAGE_STATE_UNKNOWN
;
403 if (!m_communication
->SupportsSourceLogicalAddress(transmitData
.initiator
))
405 if (transmitData
.initiator
== CECDEVICE_UNREGISTERED
&& m_communication
->SupportsSourceLogicalAddress(CECDEVICE_FREEUSE
))
407 m_libcec
->AddLog(CEC_LOG_DEBUG
, "initiator '%s' is not supported by the CEC adapter. using '%s' instead", ToString(transmitData
.initiator
), ToString(CECDEVICE_FREEUSE
));
408 transmitData
.initiator
= CECDEVICE_FREEUSE
;
412 m_libcec
->AddLog(CEC_LOG_DEBUG
, "initiator '%s' is not supported by the CEC adapter", ToString(transmitData
.initiator
));
417 LogOutput(transmitData
);
419 // find the initiator device
420 CCECBusDevice
*initiator
= m_busDevices
->At(transmitData
.initiator
);
423 m_libcec
->AddLog(CEC_LOG_WARNING
, "invalid initiator");
427 // find the destination device, if it's not the broadcast address
428 if (transmitData
.destination
!= CECDEVICE_BROADCAST
)
430 // check if the device is marked as handled by libCEC
431 CCECBusDevice
*destination
= m_busDevices
->At(transmitData
.destination
);
432 if (destination
&& destination
->IsHandledByLibCEC())
434 // and reject the command if it's trying to send data to a device that is handled by libCEC
435 m_libcec
->AddLog(CEC_LOG_WARNING
, "not sending data to myself!");
440 // wait until we finished allocating a new LA if it got lost
441 while (m_bStallCommunication
) Sleep(5);
444 CLockObject
lock(m_mutex
);
445 m_iLastTransmission
= GetTimeMs();
446 // set the number of tries
447 iMaxTries
= initiator
->GetHandler()->GetTransmitRetries() + 1;
448 initiator
->MarkHandlerReady();
451 // and try to send the command
452 while (bRetry
&& ++iTries
< iMaxTries
)
454 if (initiator
->IsUnsupportedFeature(transmitData
.opcode
))
457 adapterState
= !IsStopped() && m_communication
&& m_communication
->IsOpen() ?
458 m_communication
->Write(transmitData
, bRetry
, iLineTimeout
, bIsReply
) :
459 ADAPTER_MESSAGE_STATE_ERROR
;
460 iLineTimeout
= m_iRetryLineTimeout
;
464 adapterState
== ADAPTER_MESSAGE_STATE_SENT_ACKED
|| adapterState
== ADAPTER_MESSAGE_STATE_SENT
|| adapterState
== ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT
:
465 adapterState
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
468 void CCECProcessor::TransmitAbort(cec_logical_address source
, cec_logical_address destination
, cec_opcode opcode
, cec_abort_reason reason
/* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
470 m_libcec
->AddLog(CEC_LOG_DEBUG
, "<< transmitting abort message");
473 cec_command::Format(command
, source
, destination
, CEC_OPCODE_FEATURE_ABORT
);
474 command
.parameters
.PushBack((uint8_t)opcode
);
475 command
.parameters
.PushBack((uint8_t)reason
);
477 Transmit(command
, true);
480 void CCECProcessor::ProcessCommand(const cec_command
&command
)
484 dataStr
.Format(">> %1x%1x", command
.initiator
, command
.destination
);
485 if (command
.opcode_set
== 1)
486 dataStr
.AppendFormat(":%02x", command
.opcode
);
487 for (uint8_t iPtr
= 0; iPtr
< command
.parameters
.size
; iPtr
++)
488 dataStr
.AppendFormat(":%02x", (unsigned int)command
.parameters
[iPtr
]);
489 m_libcec
->AddLog(CEC_LOG_TRAFFIC
, dataStr
.c_str());
491 // find the initiator
492 CCECBusDevice
*device
= m_busDevices
->At(command
.initiator
);
495 device
->HandleCommand(command
);
498 bool CCECProcessor::IsPresentDevice(cec_logical_address address
)
500 CCECBusDevice
*device
= m_busDevices
->At(address
);
501 return device
&& device
->GetStatus() == CEC_DEVICE_STATUS_PRESENT
;
504 bool CCECProcessor::IsPresentDeviceType(cec_device_type type
)
506 CECDEVICEVEC devices
;
507 m_busDevices
->GetByType(type
, devices
);
508 CCECDeviceMap::FilterActive(devices
);
509 return !devices
.empty();
512 uint16_t CCECProcessor::GetDetectedPhysicalAddress(void) const
514 return m_communication
? m_communication
->GetPhysicalAddress() : CEC_INVALID_PHYSICAL_ADDRESS
;
517 bool CCECProcessor::ClearLogicalAddresses(void)
519 cec_logical_addresses addresses
; addresses
.Clear();
520 return SetLogicalAddresses(addresses
);
523 bool CCECProcessor::SetLogicalAddresses(const cec_logical_addresses
&addresses
)
525 return m_communication
? m_communication
->SetLogicalAddresses(addresses
) : false;
528 bool CCECProcessor::StandbyDevices(const cec_logical_address initiator
, const CECDEVICEVEC
&devices
)
531 for (CECDEVICEVEC::const_iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
532 bReturn
&= (*it
)->Standby(initiator
);
536 bool CCECProcessor::StandbyDevice(const cec_logical_address initiator
, cec_logical_address address
)
538 CCECBusDevice
*device
= m_busDevices
->At(address
);
539 return device
? device
->Standby(initiator
) : false;
542 bool CCECProcessor::PowerOnDevices(const cec_logical_address initiator
, const CECDEVICEVEC
&devices
)
545 for (CECDEVICEVEC::const_iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
546 bReturn
&= (*it
)->PowerOn(initiator
);
550 bool CCECProcessor::PowerOnDevice(const cec_logical_address initiator
, cec_logical_address address
)
552 CCECBusDevice
*device
= m_busDevices
->At(address
);
553 return device
? device
->PowerOn(initiator
) : false;
556 bool CCECProcessor::StartBootloader(const char *strPort
/* = NULL */)
559 // open a connection if no connection has been opened
560 if (!m_communication
&& strPort
)
562 CAdapterFactory
factory(this->m_libcec
);
563 IAdapterCommunication
*comm
= factory
.GetInstance(strPort
);
564 CTimeout
timeout(CEC_DEFAULT_CONNECT_TIMEOUT
);
566 while (timeout
.TimeLeft() > 0 && (bReturn
= comm
->Open(timeout
.TimeLeft() / CEC_CONNECT_TRIES
, true)) == false)
568 m_libcec
->AddLog(CEC_LOG_ERROR
, "could not open a connection (try %d)", ++iConnectTry
);
570 Sleep(CEC_DEFAULT_TRANSMIT_RETRY_WAIT
);
574 bReturn
= comm
->StartBootloader();
575 DELETE_AND_NULL(comm
);
581 m_communication
->StartBootloader();
589 bool CCECProcessor::PingAdapter(void)
591 return m_communication
->PingAdapter();
594 void CCECProcessor::HandlePoll(cec_logical_address initiator
, cec_logical_address destination
)
596 CCECBusDevice
*device
= m_busDevices
->At(destination
);
598 device
->HandlePollFrom(initiator
);
601 bool CCECProcessor::HandleReceiveFailed(cec_logical_address initiator
)
603 CCECBusDevice
*device
= m_busDevices
->At(initiator
);
604 return !device
|| !device
->HandleReceiveFailed();
607 bool CCECProcessor::CanPersistConfiguration(void)
609 return m_communication
? m_communication
->GetFirmwareVersion() >= 2 : false;
612 bool CCECProcessor::PersistConfiguration(const libcec_configuration
&configuration
)
614 libcec_configuration persistConfiguration
= configuration
;
615 if (!CLibCEC::IsValidPhysicalAddress(configuration
.iPhysicalAddress
))
617 CCECBusDevice
*device
= GetPrimaryDevice();
619 persistConfiguration
.iPhysicalAddress
= device
->GetCurrentPhysicalAddress();
622 return m_communication
? m_communication
->PersistConfiguration(persistConfiguration
) : false;
625 void CCECProcessor::RescanActiveDevices(void)
627 for (CECDEVICEMAP::iterator it
= m_busDevices
->Begin(); it
!= m_busDevices
->End(); it
++)
628 it
->second
->GetStatus(true);
631 bool CCECProcessor::GetDeviceInformation(const char *strPort
, libcec_configuration
*config
, uint32_t iTimeoutMs
/* = CEC_DEFAULT_CONNECT_TIMEOUT */)
633 if (!OpenConnection(strPort
, CEC_SERIAL_DEFAULT_BAUDRATE
, iTimeoutMs
, false))
636 config
->iFirmwareVersion
= m_communication
->GetFirmwareVersion();
637 config
->iPhysicalAddress
= m_communication
->GetPhysicalAddress();
638 config
->iFirmwareBuildDate
= m_communication
->GetFirmwareBuildDate();
639 config
->adapterType
= m_communication
->GetAdapterType();
646 bool CCECProcessor::TransmitPendingActiveSourceCommands(void)
649 for (CECDEVICEMAP::iterator it
= m_busDevices
->Begin(); it
!= m_busDevices
->End(); it
++)
650 bReturn
&= it
->second
->TransmitPendingActiveSourceCommands();
654 CCECTV
*CCECProcessor::GetTV(void) const
656 return CCECBusDevice::AsTV(m_busDevices
->At(CECDEVICE_TV
));
659 CCECAudioSystem
*CCECProcessor::GetAudioSystem(void) const
661 return CCECBusDevice::AsAudioSystem(m_busDevices
->At(CECDEVICE_AUDIOSYSTEM
));
664 CCECPlaybackDevice
*CCECProcessor::GetPlaybackDevice(cec_logical_address address
) const
666 return CCECBusDevice::AsPlaybackDevice(m_busDevices
->At(address
));
669 CCECRecordingDevice
*CCECProcessor::GetRecordingDevice(cec_logical_address address
) const
671 return CCECBusDevice::AsRecordingDevice(m_busDevices
->At(address
));
674 CCECTuner
*CCECProcessor::GetTuner(cec_logical_address address
) const
676 return CCECBusDevice::AsTuner(m_busDevices
->At(address
));
679 bool CCECProcessor::AllocateLogicalAddresses(CCECClient
* client
)
681 libcec_configuration
&configuration
= *client
->GetConfiguration();
683 // mark as unregistered
684 client
->SetRegistered(false);
686 // unregister this client from the old addresses
687 CECDEVICEVEC devices
;
688 m_busDevices
->GetByLogicalAddresses(devices
, configuration
.logicalAddresses
);
689 for (CECDEVICEVEC::const_iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
691 // remove client entry
692 CLockObject
lock(m_mutex
);
693 m_clients
.erase((*it
)->GetLogicalAddress());
696 // find logical addresses for this client
697 if (!client
->AllocateLogicalAddresses())
699 m_libcec
->AddLog(CEC_LOG_ERROR
, "failed to find a free logical address for the client");
703 // register this client on the new addresses
705 m_busDevices
->GetByLogicalAddresses(devices
, configuration
.logicalAddresses
);
706 for (CECDEVICEVEC::const_iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
708 // set the physical address of the device at this LA
709 if (CLibCEC::IsValidPhysicalAddress(configuration
.iPhysicalAddress
))
710 (*it
)->SetPhysicalAddress(configuration
.iPhysicalAddress
);
712 // replace a previous client
713 CLockObject
lock(m_mutex
);
714 m_clients
.erase((*it
)->GetLogicalAddress());
715 m_clients
.insert(make_pair
<cec_logical_address
, CCECClient
*>((*it
)->GetLogicalAddress(), client
));
718 // set the new ackmask
719 SetLogicalAddresses(GetLogicalAddresses());
721 // resume outgoing communication
722 m_bStallCommunication
= false;
727 uint16_t CCECProcessor::GetPhysicalAddressFromEeprom(void)
729 libcec_configuration config
; config
.Clear();
731 m_communication
->GetConfiguration(config
);
732 return config
.iPhysicalAddress
;
735 bool CCECProcessor::RegisterClient(CCECClient
*client
)
740 libcec_configuration
&configuration
= *client
->GetConfiguration();
742 if (configuration
.clientVersion
< CEC_CLIENT_VERSION_2_0_0
)
744 m_libcec
->AddLog(CEC_LOG_ERROR
, "failed to register a new CEC client: client version %s is no longer supported", ToString((cec_client_version
)configuration
.clientVersion
));
748 if (configuration
.bMonitorOnly
== 1)
751 if (!CECInitialised())
753 m_libcec
->AddLog(CEC_LOG_ERROR
, "failed to register a new CEC client: CEC processor is not initialised");
757 // unregister the client first if it's already been marked as registered
758 if (client
->IsRegistered())
759 UnregisterClient(client
);
761 // ensure that controlled mode is enabled
762 m_communication
->SetControlledMode(true);
765 // source logical address for requests
766 cec_logical_address
sourceAddress(CECDEVICE_UNREGISTERED
);
767 if (!m_communication
->SupportsSourceLogicalAddress(CECDEVICE_UNREGISTERED
))
769 if (m_communication
->SupportsSourceLogicalAddress(CECDEVICE_FREEUSE
))
770 sourceAddress
= CECDEVICE_FREEUSE
;
773 m_libcec
->AddLog(CEC_LOG_ERROR
, "failed to register a new CEC client: both unregistered and free use are not supported by the device");
778 // ensure that we know the vendor id of the TV
779 CCECBusDevice
*tv
= GetTV();
780 cec_vendor_id
tvVendor(tv
->GetVendorId(sourceAddress
));
782 // wait until the handler is replaced, to avoid double registrations
783 if (tvVendor
!= CEC_VENDOR_UNKNOWN
&&
784 CCECCommandHandler::HasSpecificHandler(tvVendor
))
786 while (!tv
->ReplaceHandler(false))
790 // get the configuration from the client
791 m_libcec
->AddLog(CEC_LOG_NOTICE
, "registering new CEC client - v%s", ToString((cec_client_version
)configuration
.clientVersion
));
793 // get the current ackmask, so we can restore it if polling fails
794 cec_logical_addresses previousMask
= GetLogicalAddresses();
796 // mark as uninitialised
797 client
->SetInitialised(false);
799 // find logical addresses for this client
800 if (!AllocateLogicalAddresses(client
))
802 m_libcec
->AddLog(CEC_LOG_ERROR
, "failed to register the new CEC client - cannot allocate the requested device types");
803 SetLogicalAddresses(previousMask
);
807 // get the settings from the rom
808 if (configuration
.bGetSettingsFromROM
== 1)
810 libcec_configuration config
; config
.Clear();
811 m_communication
->GetConfiguration(config
);
813 CLockObject
lock(m_mutex
);
814 if (!config
.deviceTypes
.IsEmpty())
815 configuration
.deviceTypes
= config
.deviceTypes
;
816 if (CLibCEC::IsValidPhysicalAddress(config
.iPhysicalAddress
))
817 configuration
.iPhysicalAddress
= config
.iPhysicalAddress
;
818 snprintf(configuration
.strDeviceName
, 13, "%s", config
.strDeviceName
);
821 // set the firmware version and build date
822 configuration
.serverVersion
= LIBCEC_VERSION_CURRENT
;
823 configuration
.iFirmwareVersion
= m_communication
->GetFirmwareVersion();
824 configuration
.iFirmwareBuildDate
= m_communication
->GetFirmwareBuildDate();
825 configuration
.adapterType
= m_communication
->GetAdapterType();
827 // mark the client as registered
828 client
->SetRegistered(true);
830 sourceAddress
= client
->GetPrimaryLogicalAdddress();
832 // initialise the client
833 bool bReturn
= client
->OnRegister();
835 // log the new registration
837 strLog
.Format("%s: %s", bReturn
? "CEC client registered" : "failed to register the CEC client", client
->GetConnectionInfo().c_str());
838 m_libcec
->AddLog(bReturn
? CEC_LOG_NOTICE
: CEC_LOG_ERROR
, strLog
);
840 // display a warning if the firmware can be upgraded
841 if (bReturn
&& !IsRunningLatestFirmware())
843 const char *strUpgradeMessage
= "The firmware of this adapter can be upgraded. Please visit http://blog.pulse-eight.com/ for more information.";
844 m_libcec
->AddLog(CEC_LOG_WARNING
, strUpgradeMessage
);
845 libcec_parameter param
;
846 param
.paramData
= (void*)strUpgradeMessage
; param
.paramType
= CEC_PARAMETER_TYPE_STRING
;
847 client
->Alert(CEC_ALERT_SERVICE_DEVICE
, param
);
850 // ensure that the command handler for the TV is initialised
853 CCECCommandHandler
*handler
= GetTV()->GetHandler();
855 handler
->InitHandler();
856 GetTV()->MarkHandlerReady();
859 // report our OSD name to the TV, since some TVs don't request it
860 client
->GetPrimaryDevice()->TransmitOSDName(CECDEVICE_TV
, false);
862 // request the power status of the TV
863 tv
->RequestPowerStatus(sourceAddress
, true);
868 bool CCECProcessor::UnregisterClient(CCECClient
*client
)
873 if (client
->IsRegistered())
874 m_libcec
->AddLog(CEC_LOG_NOTICE
, "unregistering client: %s", client
->GetConnectionInfo().c_str());
876 // notify the client that it will be unregistered
877 client
->OnUnregister();
880 CLockObject
lock(m_mutex
);
881 // find all devices that match the LA's of this client
882 CECDEVICEVEC devices
;
883 m_busDevices
->GetByLogicalAddresses(devices
, client
->GetConfiguration()->logicalAddresses
);
884 for (CECDEVICEVEC::const_iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
887 map
<cec_logical_address
, CCECClient
*>::iterator entry
= m_clients
.find((*it
)->GetLogicalAddress());
888 // unregister the client
889 if (entry
!= m_clients
.end())
890 m_clients
.erase(entry
);
892 // reset the device status
893 (*it
)->ResetDeviceStatus(true);
897 // set the new ackmask
898 cec_logical_addresses addresses
= GetLogicalAddresses();
899 if (SetLogicalAddresses(addresses
))
901 // no more clients left, disable controlled mode
902 if (addresses
.IsEmpty() && !m_bMonitor
)
903 m_communication
->SetControlledMode(false);
911 void CCECProcessor::UnregisterClients(void)
913 m_libcec
->AddLog(CEC_LOG_DEBUG
, "unregistering all CEC clients");
915 vector
<CCECClient
*> clients
= m_libcec
->GetClients();
916 for (vector
<CCECClient
*>::iterator client
= clients
.begin(); client
!= clients
.end(); client
++)
917 UnregisterClient(*client
);
919 CLockObject
lock(m_mutex
);
923 CCECClient
*CCECProcessor::GetClient(const cec_logical_address address
)
925 CLockObject
lock(m_mutex
);
926 map
<cec_logical_address
, CCECClient
*>::const_iterator client
= m_clients
.find(address
);
927 if (client
!= m_clients
.end())
928 return client
->second
;
932 CCECClient
*CCECProcessor::GetPrimaryClient(void)
934 CLockObject
lock(m_mutex
);
935 map
<cec_logical_address
, CCECClient
*>::const_iterator client
= m_clients
.begin();
936 if (client
!= m_clients
.end())
937 return client
->second
;
941 CCECBusDevice
*CCECProcessor::GetPrimaryDevice(void)
943 return m_busDevices
->At(GetLogicalAddress());
946 cec_logical_address
CCECProcessor::GetLogicalAddress(void)
948 cec_logical_addresses addresses
= GetLogicalAddresses();
949 return addresses
.primary
;
952 cec_logical_addresses
CCECProcessor::GetLogicalAddresses(void)
954 CLockObject
lock(m_mutex
);
955 cec_logical_addresses addresses
;
957 for (map
<cec_logical_address
, CCECClient
*>::const_iterator client
= m_clients
.begin(); client
!= m_clients
.end(); client
++)
958 addresses
.Set(client
->first
);
963 bool CCECProcessor::IsHandledByLibCEC(const cec_logical_address address
) const
965 CCECBusDevice
*device
= GetDevice(address
);
966 return device
&& device
->IsHandledByLibCEC();
969 bool CCECProcessor::IsRunningLatestFirmware(void)
971 return m_communication
&& m_communication
->IsOpen() ?
972 m_communication
->IsRunningLatestFirmware() :
976 void CCECProcessor::SwitchMonitoring(bool bSwitchTo
)
979 CLockObject
lock(m_mutex
);
980 m_bMonitor
= bSwitchTo
;
986 void CCECProcessor::HandleLogicalAddressLost(cec_logical_address oldAddress
)
988 // stall outgoing messages until we know our new LA
989 m_bStallCommunication
= true;
991 m_libcec
->AddLog(CEC_LOG_NOTICE
, "logical address %x was taken by another device, allocating a new address", oldAddress
);
992 CCECClient
* client
= GetClient(oldAddress
);
994 client
= GetPrimaryClient();
998 while (m_addrAllocator
->IsRunning()) Sleep(5);
999 delete m_addrAllocator
;
1001 m_addrAllocator
= new CCECAllocateLogicalAddress(this, client
);
1002 m_addrAllocator
->CreateThread();
1006 void CCECProcessor::HandlePhysicalAddressChanged(uint16_t iNewAddress
)
1008 m_libcec
->AddLog(CEC_LOG_NOTICE
, "physical address changed to %04x", iNewAddress
);
1009 CCECClient
* client
= GetPrimaryClient();
1011 client
->SetPhysicalAddress(iNewAddress
);
1014 uint16_t CCECProcessor::GetAdapterVendorId(void) const
1016 return m_communication
? m_communication
->GetAdapterVendorId() : 0;
1019 uint16_t CCECProcessor::GetAdapterProductId(void) const
1021 return m_communication
? m_communication
->GetAdapterProductId() : 0;
1024 CCECAllocateLogicalAddress::CCECAllocateLogicalAddress(CCECProcessor
* processor
, CCECClient
* client
) :
1025 m_processor(processor
),
1026 m_client(client
) { }
1028 void* CCECAllocateLogicalAddress::Process(void)
1030 m_processor
->AllocateLogicalAddresses(m_client
);