2 * This file is part of the libCEC(R) library.
4 * libCEC(R) is Copyright (C) 2011-2012 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/
35 #include "adapter/USBCECAdapterDetection.h"
36 #include "adapter/USBCECAdapterCommunication.h"
37 #include "CECProcessor.h"
38 #include "devices/CECBusDevice.h"
39 #include "platform/util/timeutils.h"
40 #include "platform/util/StdString.h"
44 using namespace PLATFORM
;
46 CLibCEC::CLibCEC(const char *strDeviceName
, cec_device_type_list types
, uint16_t iPhysicalAddress
/* = 0 */) :
47 m_iStartTime(GetTimeMs()),
48 m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN
),
53 m_cec
= new CCECProcessor(this, strDeviceName
, types
, iPhysicalAddress
);
56 CLibCEC::CLibCEC(libcec_configuration
*configuration
) :
57 m_iStartTime(GetTimeMs()),
58 m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN
),
60 m_callbacks(configuration
->callbacks
),
61 m_cbParam(configuration
->callbackParam
)
63 configuration
->serverVersion
= CEC_SERVER_VERSION_1_5_3
;
64 m_cec
= new CCECProcessor(this, configuration
);
67 CLibCEC::~CLibCEC(void)
72 bool CLibCEC::Open(const char *strPort
, uint32_t iTimeoutMs
/* = 10000 */)
74 if (m_cec
->IsRunning())
76 AddLog(CEC_LOG_ERROR
, "connection already open");
80 if (!m_cec
->Start(strPort
, 38400, iTimeoutMs
))
82 AddLog(CEC_LOG_ERROR
, "could not start CEC communications");
89 void CLibCEC::Close(void)
95 bool CLibCEC::EnableCallbacks(void *cbParam
, ICECCallbacks
*callbacks
)
97 CLockObject
lock(m_mutex
);
101 m_callbacks
= callbacks
;
106 int8_t CLibCEC::FindAdapters(cec_adapter
*deviceList
, uint8_t iBufSize
, const char *strDevicePath
/* = NULL */)
110 strDebug
.Format("trying to autodetect the com port for device path '%s'", strDevicePath
);
112 strDebug
.Format("trying to autodetect all CEC adapters");
113 AddLog(CEC_LOG_DEBUG
, strDebug
);
115 return CUSBCECAdapterDetection::FindAdapters(deviceList
, iBufSize
, strDevicePath
);
118 bool CLibCEC::PingAdapter(void)
120 return m_cec
? m_cec
->PingAdapter() : false;
123 bool CLibCEC::StartBootloader(void)
125 return m_cec
? m_cec
->StartBootloader() : false;
128 bool CLibCEC::GetNextLogMessage(cec_log_message
*message
)
130 return (m_logBuffer
.Pop(*message
));
133 bool CLibCEC::GetNextKeypress(cec_keypress
*key
)
135 return m_keyBuffer
.Pop(*key
);
138 bool CLibCEC::GetNextCommand(cec_command
*command
)
140 return m_commandBuffer
.Pop(*command
);
143 bool CLibCEC::Transmit(const cec_command
&data
)
145 return m_cec
? m_cec
->Transmit(data
) : false;
148 bool CLibCEC::SetLogicalAddress(cec_logical_address iLogicalAddress
)
150 return m_cec
? m_cec
->SetLogicalAddress(iLogicalAddress
) : false;
153 bool CLibCEC::SetPhysicalAddress(uint16_t iPhysicalAddress
/* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
155 return m_cec
? m_cec
->SetPhysicalAddress(iPhysicalAddress
) : false;
158 bool CLibCEC::SetHDMIPort(cec_logical_address iBaseDevice
, uint8_t iPort
/* = CEC_DEFAULT_HDMI_PORT */)
160 return m_cec
? m_cec
->SetHDMIPort(iBaseDevice
, iPort
) : false;
163 bool CLibCEC::EnablePhysicalAddressDetection(void)
165 return m_cec
? m_cec
->EnablePhysicalAddressDetection() : false;
168 bool CLibCEC::PowerOnDevices(cec_logical_address address
/* = CECDEVICE_TV */)
170 return m_cec
&& address
>= CECDEVICE_TV
&& address
<= CECDEVICE_BROADCAST
? m_cec
->PowerOnDevices(address
) : false;
173 bool CLibCEC::StandbyDevices(cec_logical_address address
/* = CECDEVICE_BROADCAST */)
175 return m_cec
&& address
>= CECDEVICE_TV
&& address
<= CECDEVICE_BROADCAST
? m_cec
->StandbyDevices(address
) : false;
178 bool CLibCEC::SetActiveSource(cec_device_type type
/* = CEC_DEVICE_TYPE_RESERVED */)
180 return m_cec
? m_cec
->SetActiveSource(type
) : false;
183 bool CLibCEC::SetActiveView(void)
185 return m_cec
? m_cec
->SetActiveView() : false;
188 bool CLibCEC::SetDeckControlMode(cec_deck_control_mode mode
, bool bSendUpdate
/* = true */)
190 return m_cec
? m_cec
->SetDeckControlMode(mode
, bSendUpdate
) : false;
193 bool CLibCEC::SetDeckInfo(cec_deck_info info
, bool bSendUpdate
/* = true */)
195 return m_cec
? m_cec
->SetDeckInfo(info
, bSendUpdate
) : false;
198 bool CLibCEC::SetInactiveView(void)
200 return m_cec
? m_cec
->TransmitInactiveSource() : false;
203 bool CLibCEC::SetMenuState(cec_menu_state state
, bool bSendUpdate
/* = true */)
205 return m_cec
? m_cec
->SetMenuState(state
, bSendUpdate
) : false;
208 bool CLibCEC::SetOSDString(cec_logical_address iLogicalAddress
, cec_display_control duration
, const char *strMessage
)
210 return m_cec
&& iLogicalAddress
>= CECDEVICE_TV
&& iLogicalAddress
<= CECDEVICE_BROADCAST
?
211 m_cec
->m_busDevices
[m_cec
->GetLogicalAddress()]->TransmitOSDString(iLogicalAddress
, duration
, strMessage
) :
215 bool CLibCEC::SwitchMonitoring(bool bEnable
)
217 return m_cec
? m_cec
->SwitchMonitoring(bEnable
) : false;
220 cec_version
CLibCEC::GetDeviceCecVersion(cec_logical_address iAddress
)
222 if (m_cec
&& iAddress
>= CECDEVICE_TV
&& iAddress
< CECDEVICE_BROADCAST
)
223 return m_cec
->GetDeviceCecVersion(iAddress
);
224 return CEC_VERSION_UNKNOWN
;
227 bool CLibCEC::GetDeviceMenuLanguage(cec_logical_address iAddress
, cec_menu_language
*language
)
229 if (m_cec
&& iAddress
>= CECDEVICE_TV
&& iAddress
< CECDEVICE_BROADCAST
)
230 return m_cec
->GetDeviceMenuLanguage(iAddress
, language
);
234 uint64_t CLibCEC::GetDeviceVendorId(cec_logical_address iAddress
)
236 if (m_cec
&& iAddress
>= CECDEVICE_TV
&& iAddress
< CECDEVICE_BROADCAST
)
237 return m_cec
->GetDeviceVendorId(iAddress
);
241 uint16_t CLibCEC::GetDevicePhysicalAddress(cec_logical_address iAddress
)
243 if (m_cec
&& iAddress
>= CECDEVICE_TV
&& iAddress
< CECDEVICE_BROADCAST
)
244 return m_cec
->GetDevicePhysicalAddress(iAddress
);
248 cec_logical_address
CLibCEC::GetActiveSource(void)
250 return m_cec
? m_cec
->GetActiveSource() : CECDEVICE_UNKNOWN
;
253 bool CLibCEC::IsActiveSource(cec_logical_address iAddress
)
255 if (m_cec
&& iAddress
>= CECDEVICE_TV
&& iAddress
< CECDEVICE_BROADCAST
)
256 return m_cec
->IsActiveSource(iAddress
);
260 cec_power_status
CLibCEC::GetDevicePowerStatus(cec_logical_address iAddress
)
262 if (m_cec
&& iAddress
>= CECDEVICE_TV
&& iAddress
< CECDEVICE_BROADCAST
)
263 return m_cec
->GetDevicePowerStatus(iAddress
);
264 return CEC_POWER_STATUS_UNKNOWN
;
267 bool CLibCEC::PollDevice(cec_logical_address iAddress
)
269 if (m_cec
&& iAddress
>= CECDEVICE_TV
&& iAddress
< CECDEVICE_BROADCAST
)
270 return m_cec
->PollDevice(iAddress
);
274 cec_logical_addresses
CLibCEC::GetActiveDevices(void)
276 cec_logical_addresses addresses
;
279 addresses
= m_cec
->GetActiveDevices();
283 bool CLibCEC::IsActiveDevice(cec_logical_address iAddress
)
285 if (m_cec
&& iAddress
>= CECDEVICE_TV
&& iAddress
< CECDEVICE_BROADCAST
)
286 return m_cec
->IsPresentDevice(iAddress
);
290 bool CLibCEC::IsActiveDeviceType(cec_device_type type
)
292 if (m_cec
&& type
>= CEC_DEVICE_TYPE_TV
&& type
<= CEC_DEVICE_TYPE_AUDIO_SYSTEM
)
293 return m_cec
->IsPresentDeviceType(type
);
297 uint8_t CLibCEC::VolumeUp(bool bSendRelease
/* = true */)
300 return m_cec
->VolumeUp(bSendRelease
);
304 uint8_t CLibCEC::VolumeDown(bool bSendRelease
/* = true */)
307 return m_cec
->VolumeDown(bSendRelease
);
312 uint8_t CLibCEC::MuteAudio(bool bSendRelease
/* = true */)
315 return m_cec
->MuteAudio(bSendRelease
);
319 bool CLibCEC::SendKeypress(cec_logical_address iDestination
, cec_user_control_code key
, bool bWait
/* = true */)
322 return m_cec
->TransmitKeypress(iDestination
, key
, bWait
);
326 bool CLibCEC::SendKeyRelease(cec_logical_address iDestination
, bool bWait
/* = true */)
329 return m_cec
->TransmitKeyRelease(iDestination
, bWait
);
333 cec_osd_name
CLibCEC::GetDeviceOSDName(cec_logical_address iAddress
)
336 retVal
.device
= iAddress
;
340 retVal
= m_cec
->GetDeviceOSDName(iAddress
);
345 void CLibCEC::AddLog(const cec_log_level level
, const char *strFormat
, ...)
350 va_start(argList
, strFormat
);
351 strLog
.FormatV(strFormat
, argList
);
354 CLibCEC
*instance
= CLibCEC::GetInstance();
357 CLockObject
lock(instance
->m_mutex
);
359 cec_log_message message
;
360 message
.level
= level
;
361 message
.time
= GetTimeMs() - instance
->m_iStartTime
;
362 snprintf(message
.message
, sizeof(message
.message
), "%s", strLog
.c_str());
364 if (instance
->m_callbacks
)
365 instance
->m_callbacks
->CBCecLogMessage(instance
->m_cbParam
, message
);
367 instance
->m_logBuffer
.Push(message
);
370 void CLibCEC::AddKey(const cec_keypress
&key
)
372 CLibCEC
*instance
= CLibCEC::GetInstance();
375 CLockObject
lock(instance
->m_mutex
);
377 AddLog(CEC_LOG_DEBUG
, "key pressed: %1x", key
.keycode
);
379 if (instance
->m_callbacks
)
380 instance
->m_callbacks
->CBCecKeyPress(instance
->m_cbParam
, key
);
382 instance
->m_keyBuffer
.Push(key
);
384 instance
->m_iCurrentButton
= key
.duration
> 0 ? CEC_USER_CONTROL_CODE_UNKNOWN
: key
.keycode
;
385 instance
->m_buttontime
= key
.duration
> 0 ? 0 : GetTimeMs();
388 void CLibCEC::ConfigurationChanged(const libcec_configuration
&config
)
390 CLibCEC
*instance
= CLibCEC::GetInstance();
391 CLockObject
lock(instance
->m_mutex
);
393 if (instance
->m_callbacks
&&
394 config
.clientVersion
>= CEC_CLIENT_VERSION_1_5_0
&&
395 instance
->m_callbacks
->CBCecConfigurationChanged
!= NULL
&&
396 instance
->m_cec
->IsInitialised())
397 instance
->m_callbacks
->CBCecConfigurationChanged(instance
->m_cbParam
, config
);
400 void CLibCEC::SetCurrentButton(cec_user_control_code iButtonCode
)
402 /* push keypress to the keybuffer with 0 duration.
403 push another press to the keybuffer with the duration set when the button is released */
406 key
.keycode
= iButtonCode
;
411 void CLibCEC::AddKey(void)
413 CLibCEC
*instance
= CLibCEC::GetInstance();
416 CLockObject
lock(instance
->m_mutex
);
418 if (instance
->m_iCurrentButton
!= CEC_USER_CONTROL_CODE_UNKNOWN
)
422 key
.duration
= (unsigned int) (GetTimeMs() - instance
->m_buttontime
);
423 key
.keycode
= instance
->m_iCurrentButton
;
424 AddLog(CEC_LOG_DEBUG
, "key released: %1x", key
.keycode
);
426 if (instance
->m_callbacks
)
427 instance
->m_callbacks
->CBCecKeyPress(instance
->m_cbParam
, key
);
429 instance
->m_keyBuffer
.Push(key
);
430 instance
->m_iCurrentButton
= CEC_USER_CONTROL_CODE_UNKNOWN
;
432 instance
->m_buttontime
= 0;
435 void CLibCEC::AddCommand(const cec_command
&command
)
437 CLibCEC
*instance
= CLibCEC::GetInstance();
440 CLockObject
lock(instance
->m_mutex
);
442 AddLog(CEC_LOG_NOTICE
, ">> %s (%X) -> %s (%X): %s (%2X)", instance
->m_cec
->ToString(command
.initiator
), command
.initiator
, instance
->m_cec
->ToString(command
.destination
), command
.destination
, instance
->m_cec
->ToString(command
.opcode
), command
.opcode
);
444 if (instance
->m_callbacks
)
445 instance
->m_callbacks
->CBCecCommand(instance
->m_cbParam
, command
);
446 else if (!instance
->m_commandBuffer
.Push(command
))
447 AddLog(CEC_LOG_WARNING
, "command buffer is full");
450 void CLibCEC::CheckKeypressTimeout(void)
452 if (m_iCurrentButton
!= CEC_USER_CONTROL_CODE_UNKNOWN
&& GetTimeMs() - m_buttontime
> CEC_BUTTON_TIMEOUT
)
455 m_iCurrentButton
= CEC_USER_CONTROL_CODE_UNKNOWN
;
459 bool CLibCEC::SetStreamPath(cec_logical_address iAddress
)
461 uint16_t iPhysicalAddress
= GetDevicePhysicalAddress(iAddress
);
462 if (iPhysicalAddress
!= 0xFFFF)
463 return SetStreamPath(iPhysicalAddress
);
467 bool CLibCEC::SetStreamPath(uint16_t iPhysicalAddress
)
469 return m_cec
->SetStreamPath(iPhysicalAddress
);
472 cec_logical_addresses
CLibCEC::GetLogicalAddresses(void)
474 cec_logical_addresses addr
= m_cec
->GetLogicalAddresses();
478 static CLibCEC
*g_libCEC_instance(NULL
);
479 CLibCEC
*CLibCEC::GetInstance(void)
481 return g_libCEC_instance
;
484 void CLibCEC::SetInstance(CLibCEC
*instance
)
486 if (g_libCEC_instance
)
487 delete g_libCEC_instance
;
488 g_libCEC_instance
= instance
;
491 void * CECInit(const char *strDeviceName
, CEC::cec_device_type_list types
, uint16_t UNUSED(iPhysicalAddress
) /* = 0 */)
493 CLibCEC
*lib
= new CLibCEC(strDeviceName
, types
);
494 CLibCEC::SetInstance(lib
);
495 return static_cast< void* > (lib
);
498 void * CECInitialise(libcec_configuration
*configuration
)
500 CLibCEC
*lib
= new CLibCEC(configuration
);
501 CLibCEC::SetInstance(lib
);
502 return static_cast< void* > (lib
);
505 bool CECStartBootloader(void)
508 cec_adapter deviceList
[1];
509 if (CUSBCECAdapterDetection::FindAdapters(deviceList
, 1) > 0)
511 CUSBCECAdapterCommunication
comm(NULL
, deviceList
[0].comm
);
512 CTimeout
timeout(10000);
513 while (timeout
.TimeLeft() > 0 && (bReturn
= comm
.Open(NULL
, (timeout
.TimeLeft() / CEC_CONNECT_TRIES
)), true) == false)
519 bReturn
= comm
.StartBootloader();
525 void CECDestroy(CEC::ICECAdapter
*UNUSED(instance
))
527 CLibCEC::SetInstance(NULL
);
530 const char *CLibCEC::ToString(const cec_menu_state state
)
532 return m_cec
->ToString(state
);
535 const char *CLibCEC::ToString(const cec_version version
)
537 return m_cec
->ToString(version
);
540 const char *CLibCEC::ToString(const cec_power_status status
)
542 return m_cec
->ToString(status
);
545 const char *CLibCEC::ToString(const cec_logical_address address
)
547 return m_cec
->ToString(address
);
550 const char *CLibCEC::ToString(const cec_deck_control_mode mode
)
552 return m_cec
->ToString(mode
);
555 const char *CLibCEC::ToString(const cec_deck_info status
)
557 return m_cec
->ToString(status
);
560 const char *CLibCEC::ToString(const cec_opcode opcode
)
562 return m_cec
->ToString(opcode
);
565 const char *CLibCEC::ToString(const cec_system_audio_status mode
)
567 return m_cec
->ToString(mode
);
570 const char *CLibCEC::ToString(const cec_audio_status status
)
572 return m_cec
->ToString(status
);
575 const char *CLibCEC::ToString(const cec_vendor_id vendor
)
577 return m_cec
->ToString(vendor
);
580 const char *CLibCEC::ToString(const cec_client_version version
)
582 return m_cec
->ToString(version
);
585 const char *CLibCEC::ToString(const cec_server_version version
)
587 return m_cec
->ToString(version
);
590 bool CLibCEC::GetCurrentConfiguration(libcec_configuration
*configuration
)
592 return m_cec
->IsInitialised() && m_cec
->GetCurrentConfiguration(configuration
);
595 bool CLibCEC::SetConfiguration(const libcec_configuration
*configuration
)
597 return m_cec
->SetConfiguration(configuration
);
600 bool CLibCEC::CanPersistConfiguration(void)
602 return m_cec
->CanPersistConfiguration();
605 bool CLibCEC::PersistConfiguration(libcec_configuration
*configuration
)
607 return m_cec
->PersistConfiguration(configuration
);
610 void CLibCEC::RescanActiveDevices(void)
612 return m_cec
->RescanActiveDevices();
615 bool CLibCEC::IsLibCECActiveSource(void)
620 cec_logical_address activeSource
= m_cec
->GetActiveSource();
621 if (activeSource
!= CECDEVICE_UNKNOWN
)
622 bReturn
= m_cec
->m_busDevices
[activeSource
]->GetStatus(false) == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC
;
627 cec_device_type
CLibCEC::GetType(cec_logical_address address
)
631 case CECDEVICE_AUDIOSYSTEM
:
632 return CEC_DEVICE_TYPE_AUDIO_SYSTEM
;
633 case CECDEVICE_PLAYBACKDEVICE1
:
634 case CECDEVICE_PLAYBACKDEVICE2
:
635 case CECDEVICE_PLAYBACKDEVICE3
:
636 return CEC_DEVICE_TYPE_PLAYBACK_DEVICE
;
637 case CECDEVICE_RECORDINGDEVICE1
:
638 case CECDEVICE_RECORDINGDEVICE2
:
639 case CECDEVICE_RECORDINGDEVICE3
:
640 return CEC_DEVICE_TYPE_RECORDING_DEVICE
;
641 case CECDEVICE_TUNER1
:
642 case CECDEVICE_TUNER2
:
643 case CECDEVICE_TUNER3
:
644 case CECDEVICE_TUNER4
:
645 return CEC_DEVICE_TYPE_TUNER
;
647 return CEC_DEVICE_TYPE_TV
;
649 return CEC_DEVICE_TYPE_RESERVED
;
653 uint16_t CLibCEC::GetMaskForType(cec_logical_address address
)
655 return GetMaskForType(GetType(address
));
658 uint16_t CLibCEC::GetMaskForType(cec_device_type type
)
662 case CEC_DEVICE_TYPE_AUDIO_SYSTEM
:
664 cec_logical_addresses addr
;
666 addr
.Set(CECDEVICE_AUDIOSYSTEM
);
667 return addr
.AckMask();
669 case CEC_DEVICE_TYPE_PLAYBACK_DEVICE
:
671 cec_logical_addresses addr
;
673 addr
.Set(CECDEVICE_PLAYBACKDEVICE1
);
674 addr
.Set(CECDEVICE_PLAYBACKDEVICE2
);
675 addr
.Set(CECDEVICE_PLAYBACKDEVICE3
);
676 return addr
.AckMask();
678 case CEC_DEVICE_TYPE_RECORDING_DEVICE
:
680 cec_logical_addresses addr
;
682 addr
.Set(CECDEVICE_RECORDINGDEVICE1
);
683 addr
.Set(CECDEVICE_RECORDINGDEVICE2
);
684 addr
.Set(CECDEVICE_RECORDINGDEVICE3
);
685 return addr
.AckMask();
687 case CEC_DEVICE_TYPE_TUNER
:
689 cec_logical_addresses addr
;
691 addr
.Set(CECDEVICE_TUNER1
);
692 addr
.Set(CECDEVICE_TUNER2
);
693 addr
.Set(CECDEVICE_TUNER3
);
694 addr
.Set(CECDEVICE_TUNER4
);
695 return addr
.AckMask();
697 case CEC_DEVICE_TYPE_TV
:
699 cec_logical_addresses addr
;
701 addr
.Set(CECDEVICE_TV
);
702 return addr
.AckMask();
709 bool CLibCEC::GetDeviceInformation(const char *strPort
, libcec_configuration
*config
, uint32_t iTimeoutMs
/* = 10000 */)
711 if (m_cec
->IsRunning())
714 return m_cec
->GetDeviceInformation(strPort
, config
, iTimeoutMs
);