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/
33 #include "CECClient.h"
34 #include "CECProcessor.h"
36 #include "devices/CECPlaybackDevice.h"
37 #include "devices/CECAudioSystem.h"
38 #include "devices/CECTV.h"
41 using namespace PLATFORM
;
43 #define LIB_CEC m_processor->GetLib()
44 #define ToString(x) LIB_CEC->ToString(x)
46 CCECClient::CCECClient(CCECProcessor
*processor
, const libcec_configuration
&configuration
) :
47 m_processor(processor
),
48 m_bInitialised(false),
50 m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN
),
53 // set the initial configuration
54 SetConfiguration(configuration
);
57 CCECClient::~CCECClient(void)
59 // unregister the client
60 if (m_processor
&& IsRegistered())
61 m_processor
->UnregisterClient(this);
64 bool CCECClient::IsInitialised(void)
66 CLockObject
lock(m_mutex
);
67 return m_bInitialised
&& m_processor
;
70 void CCECClient::SetInitialised(bool bSetTo
)
72 CLockObject
lock(m_mutex
);
73 m_bInitialised
= bSetTo
;
76 bool CCECClient::IsRegistered(void)
78 CLockObject
lock(m_mutex
);
79 return m_bRegistered
&& m_processor
;
82 void CCECClient::SetRegistered(bool bSetTo
)
84 CLockObject
lock(m_mutex
);
85 m_bRegistered
= bSetTo
;
88 bool CCECClient::OnRegister(void)
90 // return false if already initialised
94 // get all device we control
96 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
98 // return false when no devices were found
101 LIB_CEC
->AddLog(CEC_LOG_WARNING
, "cannot find the primary device (logical address %x)", GetPrimaryLogicalAdddress());
105 // mark as initialised
106 SetInitialised(true);
108 // configure all devices
109 for (CECDEVICEVEC::iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
111 // only set our OSD name for the primary device
112 if ((*it
)->GetLogicalAddress() == GetPrimaryLogicalAdddress())
113 (*it
)->SetOSDName(m_configuration
.strDeviceName
);
115 // set the default menu language for devices we control
116 (*it
)->SetMenuLanguage(m_configuration
.strDeviceLanguage
);
119 // set the physical address
120 SetPhysicalAddress(m_configuration
);
122 // ensure that we know the vendor id of the TV, so we are using the correct handler
123 m_processor
->GetTV()->GetVendorId(GetPrimaryLogicalAdddress());
125 // make the primary device the active source if the option is set
126 if (m_configuration
.bActivateSource
== 1)
127 GetPrimaryDevice()->ActivateSource();
132 bool CCECClient::SetHDMIPort(const cec_logical_address iBaseDevice
, const uint8_t iPort
, bool bForce
/* = false */)
136 // limit the HDMI port range to 1-15
137 if (iPort
< CEC_MIN_HDMI_PORTNUMBER
||
138 iPort
> CEC_MAX_HDMI_PORTNUMBER
)
141 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting HDMI port to %d on device %s (%d)", iPort
, ToString(iBaseDevice
), (int)iBaseDevice
);
143 // update the configuration
145 CLockObject
lock(m_mutex
);
146 m_configuration
.baseDevice
= iBaseDevice
;
147 m_configuration
.iHDMIPort
= iPort
;
150 // don't continue if the connection isn't opened
151 if (!m_processor
->CECInitialised() && !bForce
)
154 // get the PA of the base device
155 uint16_t iPhysicalAddress(CEC_INVALID_PHYSICAL_ADDRESS
);
156 CCECBusDevice
*baseDevice
= m_processor
->GetDevice(iBaseDevice
);
158 iPhysicalAddress
= baseDevice
->GetPhysicalAddress(GetPrimaryLogicalAdddress());
160 // add our port number
161 if (iPhysicalAddress
<= CEC_MAX_PHYSICAL_ADDRESS
)
163 if (iPhysicalAddress
== 0)
164 iPhysicalAddress
+= 0x1000 * iPort
;
165 else if (iPhysicalAddress
% 0x1000 == 0)
166 iPhysicalAddress
+= 0x100 * iPort
;
167 else if (iPhysicalAddress
% 0x100 == 0)
168 iPhysicalAddress
+= 0x10 * iPort
;
169 else if (iPhysicalAddress
% 0x10 == 0)
170 iPhysicalAddress
+= iPort
;
175 // set the default address when something went wrong
178 LIB_CEC
->AddLog(CEC_LOG_WARNING
, "failed to set the physical address to %04X, setting it to the default value %04X", iPhysicalAddress
, CEC_DEFAULT_PHYSICAL_ADDRESS
);
179 iPhysicalAddress
= CEC_DEFAULT_PHYSICAL_ADDRESS
;
182 // and set the address
183 SetDevicePhysicalAddress(iPhysicalAddress
);
185 ConfigurationChanged(m_configuration
);
190 void CCECClient::ResetPhysicalAddress(void)
192 SetPhysicalAddress(m_configuration
);
195 void CCECClient::SetPhysicalAddress(const libcec_configuration
&configuration
)
197 // try to autodetect the address
199 if (m_processor
->CECInitialised() && configuration
.bAutodetectAddress
== 1)
200 bPASet
= AutodetectPhysicalAddress();
202 // try to use physical address setting
203 if (!bPASet
&& CLibCEC::IsValidPhysicalAddress(configuration
.iPhysicalAddress
))
204 bPASet
= SetPhysicalAddress(configuration
.iPhysicalAddress
);
206 // use the base device + hdmi port settings
208 bPASet
= SetHDMIPort(configuration
.baseDevice
, configuration
.iHDMIPort
);
210 // reset to defaults if something went wrong
213 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - resetting HDMI port and base device to defaults", __FUNCTION__
);
214 m_configuration
.baseDevice
= CECDEVICE_UNKNOWN
;
215 m_configuration
.iHDMIPort
= CEC_HDMI_PORTNUMBER_NONE
;
219 bool CCECClient::SetPhysicalAddress(const uint16_t iPhysicalAddress
)
221 // update the configuration
223 CLockObject
lock(m_mutex
);
224 if (m_configuration
.iPhysicalAddress
== iPhysicalAddress
)
226 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "physical address unchanged (%04X)", iPhysicalAddress
);
231 m_configuration
.iPhysicalAddress
= iPhysicalAddress
;
232 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting physical address to '%04X'", iPhysicalAddress
);
236 // persist the new configuration
237 m_processor
->PersistConfiguration(m_configuration
);
239 // set the physical address for each device
240 SetDevicePhysicalAddress(iPhysicalAddress
);
242 // and send back the updated configuration
243 ConfigurationChanged(m_configuration
);
248 bool CCECClient::AllocateLogicalAddresses(void)
250 // reset all previous LAs that were set
251 m_configuration
.logicalAddresses
.Clear();
253 // display an error if no device types are set
254 if (m_configuration
.deviceTypes
.IsEmpty())
256 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "no device types given");
260 // check each entry of the list
261 for (uint8_t iPtr
= 0; iPtr
< 5; iPtr
++)
263 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
266 // find an LA for this type
267 cec_logical_address
address(CECDEVICE_UNKNOWN
);
268 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_RECORDING_DEVICE
)
269 address
= AllocateLogicalAddressRecordingDevice();
270 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_TUNER
)
271 address
= AllocateLogicalAddressTuner();
272 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_PLAYBACK_DEVICE
)
273 address
= AllocateLogicalAddressPlaybackDevice();
274 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_AUDIO_SYSTEM
)
275 address
= AllocateLogicalAddressAudioSystem();
277 // display an error if no LA could be allocated
278 if (address
== CECDEVICE_UNKNOWN
)
280 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - failed to allocate device '%d', type '%s'", __FUNCTION__
, iPtr
, ToString(m_configuration
.deviceTypes
.types
[iPtr
]));
284 // display the registered LA
285 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - device '%d', type '%s', LA '%X'", __FUNCTION__
, iPtr
, ToString(m_configuration
.deviceTypes
.types
[iPtr
]), address
);
286 m_configuration
.logicalAddresses
.Set(address
);
292 cec_logical_address
CCECClient::AllocateLogicalAddressRecordingDevice(void)
294 cec_logical_address
retVal(CECDEVICE_UNKNOWN
);
296 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'recording device'");
297 if (m_processor
->TryLogicalAddress(CECDEVICE_RECORDINGDEVICE1
))
298 retVal
= CECDEVICE_RECORDINGDEVICE1
;
299 else if (m_processor
->TryLogicalAddress(CECDEVICE_RECORDINGDEVICE2
))
300 retVal
= CECDEVICE_RECORDINGDEVICE2
;
301 else if (m_processor
->TryLogicalAddress(CECDEVICE_RECORDINGDEVICE3
))
302 retVal
= CECDEVICE_RECORDINGDEVICE3
;
307 cec_logical_address
CCECClient::AllocateLogicalAddressTuner(void)
309 cec_logical_address
retVal(CECDEVICE_UNKNOWN
);
311 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'tuner'");
312 if (m_processor
->TryLogicalAddress(CECDEVICE_TUNER1
))
313 retVal
= CECDEVICE_TUNER1
;
314 else if (m_processor
->TryLogicalAddress(CECDEVICE_TUNER2
))
315 retVal
= CECDEVICE_TUNER2
;
316 else if (m_processor
->TryLogicalAddress(CECDEVICE_TUNER3
))
317 retVal
= CECDEVICE_TUNER3
;
318 else if (m_processor
->TryLogicalAddress(CECDEVICE_TUNER4
))
319 retVal
= CECDEVICE_TUNER4
;
324 cec_logical_address
CCECClient::AllocateLogicalAddressPlaybackDevice(void)
326 cec_logical_address
retVal(CECDEVICE_UNKNOWN
);
328 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'playback device'");
329 if (m_processor
->TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE1
))
330 retVal
= CECDEVICE_PLAYBACKDEVICE1
;
331 else if (m_processor
->TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE2
))
332 retVal
= CECDEVICE_PLAYBACKDEVICE2
;
333 else if (m_processor
->TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE3
))
334 retVal
= CECDEVICE_PLAYBACKDEVICE3
;
339 cec_logical_address
CCECClient::AllocateLogicalAddressAudioSystem(void)
341 cec_logical_address
retVal(CECDEVICE_UNKNOWN
);
343 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'audiosystem'");
344 if (m_processor
->TryLogicalAddress(CECDEVICE_AUDIOSYSTEM
))
345 retVal
= CECDEVICE_AUDIOSYSTEM
;
350 CCECBusDevice
*CCECClient::GetDeviceByType(const cec_device_type type
) const
352 // get all devices that match our logical addresses
353 CECDEVICEVEC devices
;
354 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
356 // filter the type we need
357 CCECDeviceMap::FilterType(type
, devices
);
359 return devices
.empty() ?
364 bool CCECClient::ChangeDeviceType(const cec_device_type from
, const cec_device_type to
)
366 LIB_CEC
->AddLog(CEC_LOG_NOTICE
, "changing device type '%s' into '%s'", ToString(from
), ToString(to
));
368 CLockObject
lock(m_mutex
);
370 // get the previous device that was allocated
371 CCECBusDevice
*previousDevice
= GetDeviceByType(from
);
375 // change the type in the device type list
376 bool bChanged(false);
377 for (uint8_t iPtr
= 0; iPtr
< 5; iPtr
++)
379 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
382 if (m_configuration
.deviceTypes
.types
[iPtr
] == from
)
385 m_configuration
.deviceTypes
.types
[iPtr
] = to
;
387 else if (m_configuration
.deviceTypes
.types
[iPtr
] == to
&& bChanged
)
389 // ensure that dupes are removed
390 m_configuration
.deviceTypes
.types
[iPtr
] = CEC_DEVICE_TYPE_RESERVED
;
394 // re-register the client to set the new ackmask
395 if (!m_processor
->RegisterClient(this))
401 bool CCECClient::SetLogicalAddress(const cec_logical_address iLogicalAddress
)
403 CLockObject
lock(m_mutex
);
404 if (GetPrimaryLogicalAdddress() != iLogicalAddress
)
407 CLockObject
lock(m_mutex
);
408 LIB_CEC
->AddLog(CEC_LOG_NOTICE
, "<< setting primary logical address to %1x", iLogicalAddress
);
409 m_configuration
.logicalAddresses
.primary
= iLogicalAddress
;
410 m_configuration
.logicalAddresses
.Set(iLogicalAddress
);
412 return m_processor
->RegisterClient(this);
418 bool CCECClient::Transmit(const cec_command
&data
)
420 return m_processor
? m_processor
->Transmit(data
) : false;
423 bool CCECClient::SendPowerOnDevices(const cec_logical_address address
/* = CECDEVICE_TV */)
425 // if the broadcast address if set as destination and the client version >=1.5.0, read the wakeDevices setting
426 if (address
== CECDEVICE_BROADCAST
&& m_configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_0
)
428 CECDEVICEVEC devices
;
429 m_processor
->GetDevices()->GetWakeDevices(m_configuration
, devices
);
430 return m_processor
->PowerOnDevices(GetPrimaryLogicalAdddress(), devices
);
433 return m_processor
->PowerOnDevice(GetPrimaryLogicalAdddress(), address
);
436 bool CCECClient::SendStandbyDevices(const cec_logical_address address
/* = CECDEVICE_BROADCAST */)
438 // if the broadcast address if set as destination and the client version >=1.5.0, read the standbyDevices setting
439 if (address
== CECDEVICE_BROADCAST
&& m_configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_0
)
441 CECDEVICEVEC devices
;
442 m_processor
->GetDevices()->GetPowerOffDevices(m_configuration
, devices
);
443 return m_processor
->StandbyDevices(GetPrimaryLogicalAdddress(), devices
);
446 return m_processor
->StandbyDevice(GetPrimaryLogicalAdddress(), address
);
449 bool CCECClient::SendSetActiveSource(const cec_device_type type
/* = CEC_DEVICE_TYPE_RESERVED */)
451 // get the devices that are controlled by us
452 CECDEVICEVEC devices
;
453 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
455 // filter out the device that matches the given type
456 if (type
!= CEC_DEVICE_TYPE_RESERVED
)
457 CCECDeviceMap::FilterType(type
, devices
);
459 // no devices left, re-fetch the list of devices that are controlled by us
461 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
463 if (!devices
.empty())
465 // get the first device from the list
466 CCECBusDevice
*device
= *devices
.begin();
469 if (!m_processor
->CECInitialised())
470 device
->MarkAsActiveSource();
471 else if (device
->HasValidPhysicalAddress())
472 return device
->ActivateSource();
478 CCECPlaybackDevice
*CCECClient::GetPlaybackDevice(void)
480 CCECPlaybackDevice
*device(NULL
);
481 CECDEVICEVEC devices
;
483 // get the playback devices
484 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
485 CCECDeviceMap::FilterType(CEC_DEVICE_TYPE_PLAYBACK_DEVICE
, devices
);
487 // no matches, get the recording devices
490 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
491 CCECDeviceMap::FilterType(CEC_DEVICE_TYPE_RECORDING_DEVICE
, devices
);
494 // get the first device that matches, and cast it to CCECPlaybackDevice
495 if (!devices
.empty())
496 device
= (*devices
.begin())->AsPlaybackDevice();
501 cec_logical_address
CCECClient::GetPrimaryLogicalAdddress(void)
503 CLockObject
lock(m_mutex
);
504 return m_configuration
.logicalAddresses
.primary
;
507 CCECBusDevice
*CCECClient::GetPrimaryDevice(void)
509 return m_processor
->GetDevice(GetPrimaryLogicalAdddress());
512 bool CCECClient::SendSetDeckControlMode(const cec_deck_control_mode mode
, bool bSendUpdate
/* = true */)
514 // find a playback device that we control
515 CCECPlaybackDevice
*device
= GetPlaybackDevice();
518 // and set the deck control mode if there is a match
519 device
->SetDeckControlMode(mode
);
521 return device
->TransmitDeckStatus(CECDEVICE_TV
);
529 bool CCECClient::SendSetDeckInfo(const cec_deck_info info
, bool bSendUpdate
/* = true */)
531 // find a playback device that we control
532 CCECPlaybackDevice
*device
= GetPlaybackDevice();
535 // and set the deck status if there is a match
536 device
->SetDeckStatus(info
);
538 return device
->AsPlaybackDevice()->TransmitDeckStatus(CECDEVICE_TV
);
546 bool CCECClient::SendSetMenuState(const cec_menu_state state
, bool bSendUpdate
/* = true */)
548 CECDEVICEVEC devices
;
550 // set the menu state for all devices that are controlled by us
551 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
552 for (CECDEVICEVEC::iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
554 (*it
)->SetMenuState(state
);
556 (*it
)->TransmitMenuState(CECDEVICE_TV
);
562 bool CCECClient::SendSetInactiveView(void)
564 CECDEVICEVEC devices
;
566 // mark all devices that are controlled by us as inactive source
567 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
568 for (CECDEVICEVEC::iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
570 if ((*it
)->IsActiveSource())
572 (*it
)->MarkAsInactiveSource();
573 return (*it
)->TransmitInactiveSource();
580 bool CCECClient::SendSetOSDString(const cec_logical_address iLogicalAddress
, const cec_display_control duration
, const char *strMessage
)
582 CCECBusDevice
*primary
= GetPrimaryDevice();
584 return primary
->TransmitOSDString(iLogicalAddress
, duration
, strMessage
);
589 cec_version
CCECClient::GetDeviceCecVersion(const cec_logical_address iAddress
)
591 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
593 return device
->GetCecVersion(GetPrimaryLogicalAdddress());
594 return CEC_VERSION_UNKNOWN
;
597 bool CCECClient::GetDeviceMenuLanguage(const cec_logical_address iAddress
, cec_menu_language
&language
)
599 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
602 language
= device
->GetMenuLanguage(GetPrimaryLogicalAdddress());
603 return (strcmp(language
.language
, "???") != 0);
608 cec_osd_name
CCECClient::GetDeviceOSDName(const cec_logical_address iAddress
)
611 retVal
.device
= iAddress
;
614 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
617 CStdString strOSDName
= device
->GetOSDName(GetPrimaryLogicalAdddress());
618 snprintf(retVal
.name
, sizeof(retVal
.name
), "%s", strOSDName
.c_str());
619 retVal
.device
= iAddress
;
625 uint16_t CCECClient::GetDevicePhysicalAddress(const cec_logical_address iAddress
)
627 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
629 return device
->GetPhysicalAddress(GetPrimaryLogicalAdddress());
630 return CEC_INVALID_PHYSICAL_ADDRESS
;
633 cec_power_status
CCECClient::GetDevicePowerStatus(const cec_logical_address iAddress
)
635 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
637 return device
->GetPowerStatus(GetPrimaryLogicalAdddress());
638 return CEC_POWER_STATUS_UNKNOWN
;
641 uint64_t CCECClient::GetDeviceVendorId(const cec_logical_address iAddress
)
643 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
645 return device
->GetVendorId(GetPrimaryLogicalAdddress());
646 return CEC_VENDOR_UNKNOWN
;
649 uint8_t CCECClient::SendVolumeUp(bool bSendRelease
/* = true */)
651 CCECBusDevice
*device
= GetPrimaryDevice();
652 CCECAudioSystem
*audio
= m_processor
->GetAudioSystem();
654 return device
&& audio
&& audio
->IsPresent() ?
655 audio
->VolumeUp(device
->GetLogicalAddress(), bSendRelease
) :
656 (uint8_t)CEC_AUDIO_VOLUME_STATUS_UNKNOWN
;
659 uint8_t CCECClient::SendVolumeDown(bool bSendRelease
/* = true */)
661 CCECBusDevice
*device
= GetPrimaryDevice();
662 CCECAudioSystem
*audio
= m_processor
->GetAudioSystem();
664 return device
&& audio
&& audio
->IsPresent() ?
665 audio
->VolumeDown(device
->GetLogicalAddress(), bSendRelease
) :
666 (uint8_t)CEC_AUDIO_VOLUME_STATUS_UNKNOWN
;
669 uint8_t CCECClient::SendMuteAudio(void)
671 CCECBusDevice
*device
= GetPrimaryDevice();
672 CCECAudioSystem
*audio
= m_processor
->GetAudioSystem();
674 return device
&& audio
&& audio
->IsPresent() ?
675 audio
->MuteAudio(device
->GetLogicalAddress()) :
676 (uint8_t)CEC_AUDIO_VOLUME_STATUS_UNKNOWN
;
679 bool CCECClient::SendKeypress(const cec_logical_address iDestination
, const cec_user_control_code key
, bool bWait
/* = true */)
681 CCECBusDevice
*dest
= m_processor
->GetDevice(iDestination
);
684 dest
->TransmitKeypress(GetPrimaryLogicalAdddress(), key
, bWait
) :
688 bool CCECClient::SendKeyRelease(const cec_logical_address iDestination
, bool bWait
/* = true */)
690 CCECBusDevice
*dest
= m_processor
->GetDevice(iDestination
);
693 dest
->TransmitKeyRelease(GetPrimaryLogicalAdddress(), bWait
) :
697 bool CCECClient::GetCurrentConfiguration(libcec_configuration
&configuration
)
699 CLockObject
lock(m_mutex
);
701 // client version 1.5.0
702 snprintf(configuration
.strDeviceName
, 13, "%s", m_configuration
.strDeviceName
);
703 configuration
.deviceTypes
= m_configuration
.deviceTypes
;
704 configuration
.bAutodetectAddress
= m_configuration
.bAutodetectAddress
;
705 configuration
.iPhysicalAddress
= m_configuration
.iPhysicalAddress
;
706 configuration
.baseDevice
= m_configuration
.baseDevice
;
707 configuration
.iHDMIPort
= m_configuration
.iHDMIPort
;
708 configuration
.clientVersion
= m_configuration
.clientVersion
;
709 configuration
.serverVersion
= m_configuration
.serverVersion
;
710 configuration
.tvVendor
= m_configuration
.tvVendor
;
712 configuration
.bGetSettingsFromROM
= m_configuration
.bGetSettingsFromROM
;
713 configuration
.bUseTVMenuLanguage
= m_configuration
.bUseTVMenuLanguage
;
714 configuration
.bActivateSource
= m_configuration
.bActivateSource
;
715 configuration
.wakeDevices
= m_configuration
.wakeDevices
;
716 configuration
.powerOffDevices
= m_configuration
.powerOffDevices
;
717 configuration
.bPowerOffScreensaver
= m_configuration
.bPowerOffScreensaver
;
718 configuration
.bPowerOffOnStandby
= m_configuration
.bPowerOffOnStandby
;
720 // client version 1.5.1
721 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_1
)
722 configuration
.bSendInactiveSource
= m_configuration
.bSendInactiveSource
;
724 // client version 1.5.3
725 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_3
)
726 configuration
.logicalAddresses
= m_configuration
.logicalAddresses
;
728 // client version 1.6.0
729 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_0
)
731 configuration
.iFirmwareVersion
= m_configuration
.iFirmwareVersion
;
732 configuration
.bPowerOffDevicesOnStandby
= m_configuration
.bPowerOffDevicesOnStandby
;
733 configuration
.bShutdownOnStandby
= m_configuration
.bShutdownOnStandby
;
736 // client version 1.6.2
737 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_2
)
739 memcpy(configuration
.strDeviceLanguage
, m_configuration
.strDeviceLanguage
, 3);
740 configuration
.iFirmwareBuildDate
= m_configuration
.iFirmwareBuildDate
;
743 // client version 1.6.3
744 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_3
)
746 configuration
.bMonitorOnly
= m_configuration
.bMonitorOnly
;
752 bool CCECClient::SetConfiguration(const libcec_configuration
&configuration
)
754 bool bIsRunning(m_processor
&& m_processor
->CECInitialised());
755 CCECBusDevice
*primary
= bIsRunning
? GetPrimaryDevice() : NULL
;
756 uint16_t iPA
= primary
? primary
->GetCurrentPhysicalAddress() : CEC_INVALID_PHYSICAL_ADDRESS
;
758 // update the callbacks
759 if (configuration
.callbacks
)
760 EnableCallbacks(configuration
.callbackParam
, configuration
.callbacks
);
762 // update the client version
763 SetClientVersion((cec_client_version
)configuration
.clientVersion
);
765 // update the OSD name
766 CStdString
strOSDName(configuration
.strDeviceName
);
767 SetOSDName(strOSDName
);
769 // update the TV vendor override
770 SetTVVendorOverride((cec_vendor_id
)configuration
.tvVendor
);
774 CLockObject
lock(m_mutex
);
775 m_configuration
.bUseTVMenuLanguage
= configuration
.bUseTVMenuLanguage
;
776 m_configuration
.bActivateSource
= configuration
.bActivateSource
;
777 m_configuration
.bGetSettingsFromROM
= configuration
.bGetSettingsFromROM
;
778 m_configuration
.wakeDevices
= configuration
.wakeDevices
;
779 m_configuration
.powerOffDevices
= configuration
.powerOffDevices
;
780 m_configuration
.bPowerOffScreensaver
= configuration
.bPowerOffScreensaver
;
781 m_configuration
.bPowerOffOnStandby
= configuration
.bPowerOffOnStandby
;
783 // client version 1.5.1
784 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_1
)
785 m_configuration
.bSendInactiveSource
= configuration
.bSendInactiveSource
;
787 // client version 1.6.0
788 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_0
)
790 m_configuration
.bPowerOffDevicesOnStandby
= configuration
.bPowerOffDevicesOnStandby
;
791 m_configuration
.bShutdownOnStandby
= configuration
.bShutdownOnStandby
;
794 // client version 1.6.2
795 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_2
)
797 memcpy(m_configuration
.strDeviceLanguage
, configuration
.strDeviceLanguage
, 3);
800 // client version 1.6.3
801 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_3
)
803 m_configuration
.bMonitorOnly
= configuration
.bMonitorOnly
;
806 // ensure that there is at least 1 device type set
807 if (m_configuration
.deviceTypes
.IsEmpty())
808 m_configuration
.deviceTypes
.Add(CEC_DEVICE_TYPE_RECORDING_DEVICE
);
811 bool bNeedReinit(false);
814 if (SetDeviceTypes(configuration
.deviceTypes
))
816 // the device type changed. just copy the rest, and re-register
818 CLockObject
lock(m_mutex
);
819 m_configuration
.iPhysicalAddress
= configuration
.iPhysicalAddress
;
820 m_configuration
.baseDevice
= configuration
.baseDevice
;
821 m_configuration
.iHDMIPort
= configuration
.iHDMIPort
;
827 // set the physical address
828 SetPhysicalAddress(configuration
);
831 m_processor
->PersistConfiguration(m_configuration
);
834 primary
= GetPrimaryDevice();
836 if (bNeedReinit
|| !primary
|| primary
->GetCurrentPhysicalAddress() != iPA
)
838 // PA or device type changed
839 m_processor
->RegisterClient(this);
841 else if (primary
&& configuration
.bActivateSource
== 1 && bIsRunning
&& !primary
->IsActiveSource())
843 // activate the source if we're not already the active source
844 primary
->ActivateSource();
850 void CCECClient::AddCommand(const cec_command
&command
)
852 CLockObject
lock(m_mutex
);
854 LIB_CEC
->AddLog(CEC_LOG_NOTICE
, ">> %s (%X) -> %s (%X): %s (%2X)", ToString(command
.initiator
), command
.initiator
, ToString(command
.destination
), command
.destination
, ToString(command
.opcode
), command
.opcode
);
856 if (m_configuration
.callbacks
&& m_configuration
.callbacks
->CBCecCommand
)
857 m_configuration
.callbacks
->CBCecCommand(m_configuration
.callbackParam
, command
);
858 else if (!m_commandBuffer
.Push(command
))
859 LIB_CEC
->AddLog(CEC_LOG_WARNING
, "command buffer is full");
862 int CCECClient::MenuStateChanged(const cec_menu_state newState
)
864 CLockObject
lock(m_mutex
);
866 LIB_CEC
->AddLog(CEC_LOG_NOTICE
, ">> %s: %s", ToString(CEC_OPCODE_MENU_REQUEST
), ToString(newState
));
868 if (m_configuration
.callbacks
&&
869 m_configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_2
&&
870 m_configuration
.callbacks
->CBCecMenuStateChanged
)
871 return m_configuration
.callbacks
->CBCecMenuStateChanged(m_configuration
.callbackParam
, newState
);
876 void CCECClient::Alert(const libcec_alert type
, const libcec_parameter
¶m
)
878 CLockObject
lock(m_mutex
);
880 if (m_configuration
.callbacks
&&
881 m_configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_0
&&
882 m_configuration
.callbacks
->CBCecAlert
)
883 m_configuration
.callbacks
->CBCecAlert(m_configuration
.callbackParam
, type
, param
);
886 void CCECClient::AddLog(const cec_log_message
&message
)
888 CLockObject
lock(m_logMutex
);
889 if (m_configuration
.callbacks
&& m_configuration
.callbacks
->CBCecLogMessage
)
890 m_configuration
.callbacks
->CBCecLogMessage(m_configuration
.callbackParam
, message
);
892 m_logBuffer
.Push(message
);
895 void CCECClient::AddKey(void)
897 CLockObject
lock(m_mutex
);
899 if (m_iCurrentButton
!= CEC_USER_CONTROL_CODE_UNKNOWN
)
903 key
.duration
= (unsigned int) (GetTimeMs() - m_buttontime
);
904 key
.keycode
= m_iCurrentButton
;
905 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "key released: %1x", key
.keycode
);
907 if (m_configuration
.callbacks
&& m_configuration
.callbacks
->CBCecKeyPress
)
908 m_configuration
.callbacks
->CBCecKeyPress(m_configuration
.callbackParam
, key
);
910 m_keyBuffer
.Push(key
);
911 m_iCurrentButton
= CEC_USER_CONTROL_CODE_UNKNOWN
;
917 void CCECClient::AddKey(const cec_keypress
&key
)
919 CLockObject
lock(m_mutex
);
921 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "key pressed: %1x", key
.keycode
);
923 if (m_configuration
.callbacks
&& m_configuration
.callbacks
->CBCecKeyPress
)
924 m_configuration
.callbacks
->CBCecKeyPress(m_configuration
.callbackParam
, key
);
926 m_keyBuffer
.Push(key
);
928 m_iCurrentButton
= key
.duration
> 0 ? CEC_USER_CONTROL_CODE_UNKNOWN
: key
.keycode
;
929 m_buttontime
= key
.duration
> 0 ? 0 : GetTimeMs();
932 void CCECClient::SetCurrentButton(const cec_user_control_code iButtonCode
)
934 // push a keypress to the buffer with 0 duration and another with the duration set when released
937 key
.keycode
= iButtonCode
;
942 void CCECClient::CheckKeypressTimeout(void)
944 if (m_iCurrentButton
!= CEC_USER_CONTROL_CODE_UNKNOWN
&& GetTimeMs() - m_buttontime
> CEC_BUTTON_TIMEOUT
)
947 m_iCurrentButton
= CEC_USER_CONTROL_CODE_UNKNOWN
;
951 void CCECClient::ConfigurationChanged(const libcec_configuration
&config
)
953 CLockObject
lock(m_mutex
);
955 if (m_configuration
.callbacks
&&
956 m_configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_0
&&
957 m_configuration
.callbacks
->CBCecConfigurationChanged
&&
958 m_processor
->CECInitialised())
959 m_configuration
.callbacks
->CBCecConfigurationChanged(m_configuration
.callbackParam
, config
);
962 bool CCECClient::EnableCallbacks(void *cbParam
, ICECCallbacks
*callbacks
)
964 CLockObject
lock(m_mutex
);
965 m_configuration
.callbackParam
= cbParam
;
966 m_configuration
.callbacks
= callbacks
;
970 bool CCECClient::PingAdapter(void)
972 return m_processor
? m_processor
->PingAdapter() : false;
975 bool CCECClient::GetNextLogMessage(cec_log_message
*message
)
977 return (m_logBuffer
.Pop(*message
));
980 bool CCECClient::GetNextKeypress(cec_keypress
*key
)
982 return m_keyBuffer
.Pop(*key
);
985 bool CCECClient::GetNextCommand(cec_command
*command
)
987 return m_commandBuffer
.Pop(*command
);
990 CStdString
CCECClient::GetConnectionInfo(void)
993 strLog
.Format("libCEC version = %s, client version = %s, firmware version = %d", ToString((cec_server_version
)m_configuration
.serverVersion
), ToString((cec_client_version
)m_configuration
.clientVersion
), m_configuration
.iFirmwareVersion
);
994 if (m_configuration
.iFirmwareBuildDate
!= CEC_FW_BUILD_UNKNOWN
)
996 time_t buildTime
= (time_t)m_configuration
.iFirmwareBuildDate
;
997 strLog
.AppendFormat(", firmware build date: %s", asctime(gmtime(&buildTime
)));
998 strLog
= strLog
.Left((int)strLog
.length() - 1); // strip \n added by asctime
999 strLog
.append(" +0000");
1002 // log the addresses that are being used
1003 if (!m_configuration
.logicalAddresses
.IsEmpty())
1005 strLog
.append(", logical address(es) = ");
1006 CECDEVICEVEC devices
;
1007 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
1008 for (CECDEVICEVEC::iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
1009 strLog
.AppendFormat("%s (%X) ", (*it
)->GetLogicalAddressName(), (*it
)->GetLogicalAddress());
1012 if (!CLibCEC::IsValidPhysicalAddress(m_configuration
.iPhysicalAddress
))
1013 strLog
.AppendFormat(", base device: %s (%X), HDMI port number: %d", ToString(m_configuration
.baseDevice
), m_configuration
.baseDevice
, m_configuration
.iHDMIPort
);
1015 strLog
.AppendFormat(", physical address: %04x", m_configuration
.iPhysicalAddress
);
1020 void CCECClient::SetTVVendorOverride(const cec_vendor_id id
)
1023 CLockObject
lock(m_mutex
);
1024 m_configuration
.tvVendor
= id
;
1027 if (id
!= CEC_VENDOR_UNKNOWN
)
1029 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vendor id '%s'", __FUNCTION__
, ToString(id
));
1031 CCECBusDevice
*tv
= m_processor
? m_processor
->GetTV() : NULL
;
1033 tv
->SetVendorId((uint64_t)id
);
1037 cec_vendor_id
CCECClient::GetTVVendorOverride(void)
1039 CLockObject
lock(m_mutex
);
1040 return (cec_vendor_id
)m_configuration
.tvVendor
;
1043 void CCECClient::SetOSDName(const CStdString
&strDeviceName
)
1046 CLockObject
lock(m_mutex
);
1047 snprintf(m_configuration
.strDeviceName
, 13, "%s", strDeviceName
.c_str());
1050 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - using OSD name '%s'", __FUNCTION__
, strDeviceName
.c_str());
1052 CCECBusDevice
*primary
= GetPrimaryDevice();
1053 if (primary
&& !primary
->GetCurrentOSDName().Equals(strDeviceName
))
1055 primary
->SetOSDName(strDeviceName
);
1056 if (m_processor
&& m_processor
->CECInitialised())
1057 primary
->TransmitOSDName(CECDEVICE_TV
);
1061 CStdString
CCECClient::GetOSDName(void)
1063 CLockObject
lock(m_mutex
);
1064 CStdString
strOSDName(m_configuration
.strDeviceName
);
1068 void CCECClient::SetWakeDevices(const cec_logical_addresses
&addresses
)
1070 CLockObject
lock(m_mutex
);
1071 m_configuration
.wakeDevices
= addresses
;
1074 cec_logical_addresses
CCECClient::GetWakeDevices(void)
1076 CLockObject
lock(m_mutex
);
1077 return m_configuration
.wakeDevices
;
1080 bool CCECClient::AutodetectPhysicalAddress(void)
1082 bool bPhysicalAutodetected(false);
1083 uint16_t iPhysicalAddress
= m_processor
? m_processor
->GetDetectedPhysicalAddress() : CEC_INVALID_PHYSICAL_ADDRESS
;
1085 if (CLibCEC::IsValidPhysicalAddress(iPhysicalAddress
))
1087 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - autodetected physical address '%04X'", __FUNCTION__
, iPhysicalAddress
);
1089 CLockObject
lock(m_mutex
);
1090 m_configuration
.iPhysicalAddress
= iPhysicalAddress
;
1091 m_configuration
.iHDMIPort
= CEC_HDMI_PORTNUMBER_NONE
;
1092 m_configuration
.baseDevice
= CECDEVICE_UNKNOWN
;
1093 bPhysicalAutodetected
= true;
1096 SetDevicePhysicalAddress(iPhysicalAddress
);
1098 return bPhysicalAutodetected
;
1101 void CCECClient::SetClientVersion(const cec_client_version version
)
1103 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - using client version '%s'", __FUNCTION__
, ToString(version
));
1105 CLockObject
lock(m_mutex
);
1106 m_configuration
.clientVersion
= (uint32_t)version
;
1109 cec_client_version
CCECClient::GetClientVersion(void)
1111 CLockObject
lock(m_mutex
);
1112 return (cec_client_version
)m_configuration
.clientVersion
;
1115 bool CCECClient::SetDeviceTypes(const cec_device_type_list
&deviceTypes
)
1117 bool bNeedReinit(false);
1120 CLockObject
lock(m_mutex
);
1121 bNeedReinit
= m_processor
&& m_processor
->CECInitialised() &&
1122 (m_configuration
.deviceTypes
!= deviceTypes
);
1123 m_configuration
.deviceTypes
= deviceTypes
;
1127 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - using primary device type '%s'", __FUNCTION__
, ToString(deviceTypes
[0]));
1132 cec_device_type_list
CCECClient::GetDeviceTypes(void)
1134 cec_device_type_list retVal
;
1135 CLockObject
lock(m_mutex
);
1136 retVal
= m_configuration
.deviceTypes
;
1140 bool CCECClient::SetDevicePhysicalAddress(const uint16_t iPhysicalAddress
)
1142 if (!CLibCEC::IsValidPhysicalAddress(iPhysicalAddress
))
1145 // reconfigure all devices
1146 cec_logical_address
reactivateSource(CECDEVICE_UNKNOWN
);
1147 CECDEVICEVEC devices
;
1148 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
1149 for (CECDEVICEVEC::iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
1151 // if this device was the active source, reactivate it afterwards
1152 if ((*it
)->IsActiveSource())
1153 reactivateSource
= (*it
)->GetLogicalAddress();
1155 // mark the device as inactive source
1156 if (IsInitialised())
1157 (*it
)->MarkAsInactiveSource();
1159 // set the new physical address
1160 (*it
)->SetPhysicalAddress(iPhysicalAddress
);
1163 if (IsInitialised())
1164 (*it
)->TransmitPhysicalAddress();
1167 // reactivate the previous active source
1168 if (reactivateSource
!= CECDEVICE_UNKNOWN
&&
1169 m_processor
->CECInitialised() &&
1172 CCECBusDevice
*device
= m_processor
->GetDevice(reactivateSource
);
1174 device
->ActivateSource();
1180 bool CCECClient::SwitchMonitoring(bool bEnable
)
1182 LIB_CEC
->AddLog(CEC_LOG_NOTICE
, "== %s monitoring mode ==", bEnable
? "enabling" : "disabling");
1187 return m_processor
->UnregisterClient(this);
1190 m_configuration
.bMonitorOnly
= false;
1191 return m_processor
->RegisterClient(this);
1198 bool CCECClient::PollDevice(const cec_logical_address iAddress
)
1200 // try to find the primary device
1201 CCECBusDevice
*primary
= GetPrimaryDevice();
1202 // poll the destination, with the primary as source
1204 return primary
->TransmitPoll(iAddress
);
1206 return m_processor
? m_processor
->PollDevice(iAddress
) : false;
1209 cec_logical_addresses
CCECClient::GetActiveDevices(void)
1211 CECDEVICEVEC activeDevices
;
1213 m_processor
->GetDevices()->GetActive(activeDevices
);
1214 return CCECDeviceMap::ToLogicalAddresses(activeDevices
);
1217 bool CCECClient::IsActiveDevice(const cec_logical_address iAddress
)
1219 cec_logical_addresses activeDevices
= GetActiveDevices();
1220 return activeDevices
.IsSet(iAddress
);
1223 bool CCECClient::IsActiveDeviceType(const cec_device_type type
)
1225 CECDEVICEVEC activeDevices
;
1227 m_processor
->GetDevices()->GetActive(activeDevices
);
1228 CCECDeviceMap::FilterType(type
, activeDevices
);
1229 return !activeDevices
.empty();
1232 cec_logical_address
CCECClient::GetActiveSource(void)
1234 return m_processor
? m_processor
->GetActiveSource() : CECDEVICE_UNKNOWN
;
1237 bool CCECClient::IsActiveSource(const cec_logical_address iAddress
)
1239 return m_processor
? m_processor
->IsActiveSource(iAddress
) : false;
1242 bool CCECClient::SetStreamPath(const cec_logical_address iAddress
)
1244 uint16_t iPhysicalAddress
= GetDevicePhysicalAddress(iAddress
);
1245 if (iPhysicalAddress
!= CEC_INVALID_PHYSICAL_ADDRESS
)
1246 return SetStreamPath(iPhysicalAddress
);
1250 bool CCECClient::SetStreamPath(const uint16_t iPhysicalAddress
)
1252 return m_processor
? m_processor
->SetStreamPath(iPhysicalAddress
) : false;
1255 cec_logical_addresses
CCECClient::GetLogicalAddresses(void)
1257 cec_logical_addresses addresses
;
1258 CLockObject
lock(m_mutex
);
1259 addresses
= m_configuration
.logicalAddresses
;
1263 bool CCECClient::CanPersistConfiguration(void)
1265 return m_processor
? m_processor
->CanPersistConfiguration() : false;
1268 bool CCECClient::PersistConfiguration(const libcec_configuration
&configuration
)
1270 return m_processor
? m_processor
->PersistConfiguration(configuration
) : false;
1273 void CCECClient::RescanActiveDevices(void)
1276 m_processor
->RescanActiveDevices();
1279 bool CCECClient::IsLibCECActiveSource(void)
1281 bool bReturn(false);
1284 cec_logical_address activeSource
= m_processor
->GetActiveSource();
1285 CCECBusDevice
*device
= m_processor
->GetDevice(activeSource
);
1287 bReturn
= device
->IsHandledByLibCEC();