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 "CECTypeUtils.h"
37 #include "devices/CECPlaybackDevice.h"
38 #include "devices/CECAudioSystem.h"
39 #include "devices/CECTV.h"
40 #include "implementations/CECCommandHandler.h"
43 using namespace PLATFORM
;
45 #define LIB_CEC m_processor->GetLib()
46 #define ToString(x) CCECTypeUtils::ToString(x)
48 CCECClient::CCECClient(CCECProcessor
*processor
, const libcec_configuration
&configuration
) :
49 m_processor(processor
),
50 m_bInitialised(false),
52 m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN
),
55 // set the initial configuration
56 SetConfiguration(configuration
);
59 CCECClient::~CCECClient(void)
61 // unregister the client
62 if (m_processor
&& IsRegistered())
63 m_processor
->UnregisterClient(this);
66 bool CCECClient::IsInitialised(void)
68 CLockObject
lock(m_mutex
);
69 return m_bInitialised
&& m_processor
;
72 void CCECClient::SetInitialised(bool bSetTo
)
74 CLockObject
lock(m_mutex
);
75 m_bInitialised
= bSetTo
;
78 bool CCECClient::IsRegistered(void)
80 CLockObject
lock(m_mutex
);
81 return m_bRegistered
&& m_processor
;
84 void CCECClient::SetRegistered(bool bSetTo
)
86 CLockObject
lock(m_mutex
);
87 m_bRegistered
= bSetTo
;
90 bool CCECClient::OnRegister(void)
92 // return false if already initialised
96 // get all device we control
98 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
100 // return false when no devices were found
103 LIB_CEC
->AddLog(CEC_LOG_WARNING
, "cannot find the primary device (logical address %x)", GetPrimaryLogicalAdddress());
107 // mark as initialised
108 SetInitialised(true);
110 // configure all devices
111 for (CECDEVICEVEC::iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
113 // only set our OSD name for the primary device
114 if ((*it
)->GetLogicalAddress() == GetPrimaryLogicalAdddress())
115 (*it
)->SetOSDName(m_configuration
.strDeviceName
);
117 // set the default menu language for devices we control
118 (*it
)->SetMenuLanguage(m_configuration
.strDeviceLanguage
);
121 // set the physical address
122 SetPhysicalAddress(m_configuration
);
124 // make the primary device the active source if the option is set
125 if (m_configuration
.bActivateSource
== 1)
126 GetPrimaryDevice()->ActivateSource();
131 bool CCECClient::SetHDMIPort(const cec_logical_address iBaseDevice
, const uint8_t iPort
, bool bForce
/* = false */)
135 // limit the HDMI port range to 1-15
136 if (iPort
< CEC_MIN_HDMI_PORTNUMBER
||
137 iPort
> CEC_MAX_HDMI_PORTNUMBER
)
140 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting HDMI port to %d on device %s (%d)", iPort
, ToString(iBaseDevice
), (int)iBaseDevice
);
142 // update the configuration
144 CLockObject
lock(m_mutex
);
145 m_configuration
.baseDevice
= iBaseDevice
;
146 m_configuration
.iHDMIPort
= iPort
;
149 // don't continue if the connection isn't opened
150 if (!m_processor
->CECInitialised() && !bForce
)
153 // get the PA of the base device
154 uint16_t iPhysicalAddress(CEC_INVALID_PHYSICAL_ADDRESS
);
155 CCECBusDevice
*baseDevice
= m_processor
->GetDevice(iBaseDevice
);
157 iPhysicalAddress
= baseDevice
->GetPhysicalAddress(GetPrimaryLogicalAdddress());
159 // add our port number
160 if (iPhysicalAddress
<= CEC_MAX_PHYSICAL_ADDRESS
)
162 if (iPhysicalAddress
== 0)
163 iPhysicalAddress
+= 0x1000 * iPort
;
164 else if (iPhysicalAddress
% 0x1000 == 0)
165 iPhysicalAddress
+= 0x100 * iPort
;
166 else if (iPhysicalAddress
% 0x100 == 0)
167 iPhysicalAddress
+= 0x10 * iPort
;
168 else if (iPhysicalAddress
% 0x10 == 0)
169 iPhysicalAddress
+= iPort
;
174 // set the default address when something went wrong
177 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
);
178 iPhysicalAddress
= CEC_DEFAULT_PHYSICAL_ADDRESS
;
181 // and set the address
182 SetDevicePhysicalAddress(iPhysicalAddress
);
184 ConfigurationChanged(m_configuration
);
189 void CCECClient::ResetPhysicalAddress(void)
191 SetPhysicalAddress(m_configuration
);
194 void CCECClient::SetPhysicalAddress(const libcec_configuration
&configuration
)
198 // override the physical address from configuration.iPhysicalAddress if it's set
199 if (!bPASet
&& CLibCEC::IsValidPhysicalAddress(configuration
.iPhysicalAddress
))
200 bPASet
= SetPhysicalAddress(configuration
.iPhysicalAddress
);
202 // try to autodetect the address
203 if (!bPASet
&& m_processor
->CECInitialised())
205 bPASet
= AutodetectPhysicalAddress();
206 m_configuration
.bAutodetectAddress
= bPASet
? 1 : 0;
209 // use the base device + hdmi port settings
211 bPASet
= SetHDMIPort(configuration
.baseDevice
, configuration
.iHDMIPort
);
213 // reset to defaults if something went wrong
216 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - resetting HDMI port and base device to defaults", __FUNCTION__
);
217 m_configuration
.baseDevice
= CECDEVICE_UNKNOWN
;
218 m_configuration
.iHDMIPort
= CEC_HDMI_PORTNUMBER_NONE
;
222 bool CCECClient::SetPhysicalAddress(const uint16_t iPhysicalAddress
)
224 // update the configuration
226 CLockObject
lock(m_mutex
);
227 if (m_configuration
.iPhysicalAddress
== iPhysicalAddress
)
229 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "physical address unchanged (%04X)", iPhysicalAddress
);
234 m_configuration
.iPhysicalAddress
= iPhysicalAddress
;
235 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting physical address to '%04X'", iPhysicalAddress
);
239 // persist the new configuration
240 m_processor
->PersistConfiguration(m_configuration
);
242 // set the physical address for each device
243 SetDevicePhysicalAddress(iPhysicalAddress
);
245 // and send back the updated configuration
246 ConfigurationChanged(m_configuration
);
251 void CCECClient::SetSupportedDeviceTypes(void)
253 cec_device_type_list types
;
256 // get the command handler for the tv
257 CCECCommandHandler
*tvHandler
= m_processor
->GetTV()->GetHandler();
261 // check all device types
262 for (uint8_t iPtr
= 0; iPtr
< 5; iPtr
++)
264 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
267 // get the supported device type. the handler will replace types it doesn't support by one it does support
268 cec_device_type type
= tvHandler
->GetReplacementDeviceType(m_configuration
.deviceTypes
.types
[iPtr
]);
269 if (!types
.IsSet(type
))
272 m_processor
->GetTV()->MarkHandlerReady();
274 // set the new type list
275 m_configuration
.deviceTypes
= types
;
278 bool CCECClient::AllocateLogicalAddresses(void)
280 // reset all previous LAs that were set
281 m_configuration
.logicalAddresses
.Clear();
283 // get the supported device types from the command handler of the TV
284 SetSupportedDeviceTypes();
286 // display an error if no device types are set
287 if (m_configuration
.deviceTypes
.IsEmpty())
289 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "no device types given");
293 // check each entry of the list
294 for (uint8_t iPtr
= 0; iPtr
< 5; iPtr
++)
296 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
299 // find an LA for this type
300 cec_logical_address
address(CECDEVICE_UNKNOWN
);
301 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_RECORDING_DEVICE
)
302 address
= AllocateLogicalAddressRecordingDevice();
303 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_TUNER
)
304 address
= AllocateLogicalAddressTuner();
305 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_PLAYBACK_DEVICE
)
306 address
= AllocateLogicalAddressPlaybackDevice();
307 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_AUDIO_SYSTEM
)
308 address
= AllocateLogicalAddressAudioSystem();
310 // display an error if no LA could be allocated
311 if (address
== CECDEVICE_UNKNOWN
)
313 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - failed to allocate device '%d', type '%s'", __FUNCTION__
, iPtr
, ToString(m_configuration
.deviceTypes
.types
[iPtr
]));
317 // display the registered LA
318 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - device '%d', type '%s', LA '%X'", __FUNCTION__
, iPtr
, ToString(m_configuration
.deviceTypes
.types
[iPtr
]), address
);
319 m_configuration
.logicalAddresses
.Set(address
);
325 cec_logical_address
CCECClient::AllocateLogicalAddressRecordingDevice(void)
327 cec_logical_address
retVal(CECDEVICE_UNKNOWN
);
329 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'recording device'");
330 if (m_processor
->TryLogicalAddress(CECDEVICE_RECORDINGDEVICE1
))
331 retVal
= CECDEVICE_RECORDINGDEVICE1
;
332 else if (m_processor
->TryLogicalAddress(CECDEVICE_RECORDINGDEVICE2
))
333 retVal
= CECDEVICE_RECORDINGDEVICE2
;
334 else if (m_processor
->TryLogicalAddress(CECDEVICE_RECORDINGDEVICE3
))
335 retVal
= CECDEVICE_RECORDINGDEVICE3
;
340 cec_logical_address
CCECClient::AllocateLogicalAddressTuner(void)
342 cec_logical_address
retVal(CECDEVICE_UNKNOWN
);
344 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'tuner'");
345 if (m_processor
->TryLogicalAddress(CECDEVICE_TUNER1
))
346 retVal
= CECDEVICE_TUNER1
;
347 else if (m_processor
->TryLogicalAddress(CECDEVICE_TUNER2
))
348 retVal
= CECDEVICE_TUNER2
;
349 else if (m_processor
->TryLogicalAddress(CECDEVICE_TUNER3
))
350 retVal
= CECDEVICE_TUNER3
;
351 else if (m_processor
->TryLogicalAddress(CECDEVICE_TUNER4
))
352 retVal
= CECDEVICE_TUNER4
;
357 cec_logical_address
CCECClient::AllocateLogicalAddressPlaybackDevice(void)
359 cec_logical_address
retVal(CECDEVICE_UNKNOWN
);
361 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'playback device'");
362 if (m_processor
->TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE1
))
363 retVal
= CECDEVICE_PLAYBACKDEVICE1
;
364 else if (m_processor
->TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE2
))
365 retVal
= CECDEVICE_PLAYBACKDEVICE2
;
366 else if (m_processor
->TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE3
))
367 retVal
= CECDEVICE_PLAYBACKDEVICE3
;
372 cec_logical_address
CCECClient::AllocateLogicalAddressAudioSystem(void)
374 cec_logical_address
retVal(CECDEVICE_UNKNOWN
);
376 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'audiosystem'");
377 if (m_processor
->TryLogicalAddress(CECDEVICE_AUDIOSYSTEM
))
378 retVal
= CECDEVICE_AUDIOSYSTEM
;
383 CCECBusDevice
*CCECClient::GetDeviceByType(const cec_device_type type
) const
385 // get all devices that match our logical addresses
386 CECDEVICEVEC devices
;
387 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
389 // filter the type we need
390 CCECDeviceMap::FilterType(type
, devices
);
392 return devices
.empty() ?
397 bool CCECClient::ChangeDeviceType(const cec_device_type from
, const cec_device_type to
)
399 LIB_CEC
->AddLog(CEC_LOG_NOTICE
, "changing device type '%s' into '%s'", ToString(from
), ToString(to
));
401 CLockObject
lock(m_mutex
);
403 // get the previous device that was allocated
404 CCECBusDevice
*previousDevice
= GetDeviceByType(from
);
408 // change the type in the device type list
409 bool bChanged(false);
410 for (uint8_t iPtr
= 0; iPtr
< 5; iPtr
++)
412 if (m_configuration
.deviceTypes
.types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
415 if (m_configuration
.deviceTypes
.types
[iPtr
] == from
)
418 m_configuration
.deviceTypes
.types
[iPtr
] = to
;
420 else if (m_configuration
.deviceTypes
.types
[iPtr
] == to
&& bChanged
)
422 // ensure that dupes are removed
423 m_configuration
.deviceTypes
.types
[iPtr
] = CEC_DEVICE_TYPE_RESERVED
;
427 // re-register the client to set the new ackmask
428 if (!m_processor
->RegisterClient(this))
434 bool CCECClient::SetLogicalAddress(const cec_logical_address iLogicalAddress
)
436 CLockObject
lock(m_mutex
);
437 if (GetPrimaryLogicalAdddress() != iLogicalAddress
)
440 CLockObject
lock(m_mutex
);
441 LIB_CEC
->AddLog(CEC_LOG_NOTICE
, "<< setting primary logical address to %1x", iLogicalAddress
);
442 m_configuration
.logicalAddresses
.primary
= iLogicalAddress
;
443 m_configuration
.logicalAddresses
.Set(iLogicalAddress
);
445 return m_processor
->RegisterClient(this);
451 bool CCECClient::Transmit(const cec_command
&data
)
453 return m_processor
? m_processor
->Transmit(data
) : false;
456 bool CCECClient::SendPowerOnDevices(const cec_logical_address address
/* = CECDEVICE_TV */)
458 // if the broadcast address if set as destination and the client version >=1.5.0, read the wakeDevices setting
459 if (address
== CECDEVICE_BROADCAST
&& m_configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_0
)
461 CECDEVICEVEC devices
;
462 m_processor
->GetDevices()->GetWakeDevices(m_configuration
, devices
);
463 return m_processor
->PowerOnDevices(GetPrimaryLogicalAdddress(), devices
);
466 return m_processor
->PowerOnDevice(GetPrimaryLogicalAdddress(), address
);
469 bool CCECClient::SendStandbyDevices(const cec_logical_address address
/* = CECDEVICE_BROADCAST */)
471 // if the broadcast address if set as destination and the client version >=1.5.0, read the standbyDevices setting
472 if (address
== CECDEVICE_BROADCAST
&& m_configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_0
)
474 CECDEVICEVEC devices
;
475 m_processor
->GetDevices()->GetPowerOffDevices(m_configuration
, devices
);
476 return m_processor
->StandbyDevices(GetPrimaryLogicalAdddress(), devices
);
479 return m_processor
->StandbyDevice(GetPrimaryLogicalAdddress(), address
);
482 bool CCECClient::SendSetActiveSource(const cec_device_type type
/* = CEC_DEVICE_TYPE_RESERVED */)
484 // get the devices that are controlled by us
485 CECDEVICEVEC devices
;
486 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
488 // filter out the device that matches the given type
489 if (type
!= CEC_DEVICE_TYPE_RESERVED
)
490 CCECDeviceMap::FilterType(type
, devices
);
492 // no devices left, re-fetch the list of devices that are controlled by us
494 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
496 if (!devices
.empty())
498 // get the first device from the list
499 CCECBusDevice
*device
= *devices
.begin();
502 if (!m_processor
->CECInitialised())
503 device
->MarkAsActiveSource();
504 else if (device
->HasValidPhysicalAddress())
505 return device
->ActivateSource();
511 CCECPlaybackDevice
*CCECClient::GetPlaybackDevice(void)
513 CCECPlaybackDevice
*device(NULL
);
514 CECDEVICEVEC devices
;
516 // get the playback devices
517 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
518 CCECDeviceMap::FilterType(CEC_DEVICE_TYPE_PLAYBACK_DEVICE
, devices
);
520 // no matches, get the recording devices
523 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
524 CCECDeviceMap::FilterType(CEC_DEVICE_TYPE_RECORDING_DEVICE
, devices
);
527 // get the first device that matches, and cast it to CCECPlaybackDevice
528 if (!devices
.empty())
529 device
= (*devices
.begin())->AsPlaybackDevice();
534 cec_logical_address
CCECClient::GetPrimaryLogicalAdddress(void)
536 CLockObject
lock(m_mutex
);
537 return m_configuration
.logicalAddresses
.primary
;
540 CCECBusDevice
*CCECClient::GetPrimaryDevice(void)
542 return m_processor
->GetDevice(GetPrimaryLogicalAdddress());
545 bool CCECClient::SendSetDeckControlMode(const cec_deck_control_mode mode
, bool bSendUpdate
/* = true */)
547 // find a playback device that we control
548 CCECPlaybackDevice
*device
= GetPlaybackDevice();
551 // and set the deck control mode if there is a match
552 device
->SetDeckControlMode(mode
);
554 return device
->TransmitDeckStatus(CECDEVICE_TV
);
562 bool CCECClient::SendSetDeckInfo(const cec_deck_info info
, bool bSendUpdate
/* = true */)
564 // find a playback device that we control
565 CCECPlaybackDevice
*device
= GetPlaybackDevice();
568 // and set the deck status if there is a match
569 device
->SetDeckStatus(info
);
571 return device
->AsPlaybackDevice()->TransmitDeckStatus(CECDEVICE_TV
);
579 bool CCECClient::SendSetMenuState(const cec_menu_state state
, bool bSendUpdate
/* = true */)
581 CECDEVICEVEC devices
;
583 // set the menu state for all devices that are controlled by us
584 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
585 for (CECDEVICEVEC::iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
587 (*it
)->SetMenuState(state
);
589 (*it
)->TransmitMenuState(CECDEVICE_TV
);
595 bool CCECClient::SendSetInactiveView(void)
597 CECDEVICEVEC devices
;
599 // mark all devices that are controlled by us as inactive source
600 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
601 for (CECDEVICEVEC::iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
603 if ((*it
)->IsActiveSource())
605 (*it
)->MarkAsInactiveSource();
606 return (*it
)->TransmitInactiveSource();
613 bool CCECClient::SendSetOSDString(const cec_logical_address iLogicalAddress
, const cec_display_control duration
, const char *strMessage
)
615 CCECBusDevice
*primary
= GetPrimaryDevice();
617 return primary
->TransmitOSDString(iLogicalAddress
, duration
, strMessage
);
622 cec_version
CCECClient::GetDeviceCecVersion(const cec_logical_address iAddress
)
624 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
626 return device
->GetCecVersion(GetPrimaryLogicalAdddress());
627 return CEC_VERSION_UNKNOWN
;
630 bool CCECClient::GetDeviceMenuLanguage(const cec_logical_address iAddress
, cec_menu_language
&language
)
632 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
635 language
= device
->GetMenuLanguage(GetPrimaryLogicalAdddress());
636 return (strcmp(language
.language
, "???") != 0);
641 cec_osd_name
CCECClient::GetDeviceOSDName(const cec_logical_address iAddress
)
644 retVal
.device
= iAddress
;
647 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
650 CStdString strOSDName
= device
->GetOSDName(GetPrimaryLogicalAdddress());
651 snprintf(retVal
.name
, sizeof(retVal
.name
), "%s", strOSDName
.c_str());
652 retVal
.device
= iAddress
;
658 uint16_t CCECClient::GetDevicePhysicalAddress(const cec_logical_address iAddress
)
660 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
662 return device
->GetPhysicalAddress(GetPrimaryLogicalAdddress());
663 return CEC_INVALID_PHYSICAL_ADDRESS
;
666 cec_power_status
CCECClient::GetDevicePowerStatus(const cec_logical_address iAddress
)
668 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
670 return device
->GetPowerStatus(GetPrimaryLogicalAdddress());
671 return CEC_POWER_STATUS_UNKNOWN
;
674 uint64_t CCECClient::GetDeviceVendorId(const cec_logical_address iAddress
)
676 CCECBusDevice
*device
= m_processor
->GetDevice(iAddress
);
678 return device
->GetVendorId(GetPrimaryLogicalAdddress());
679 return CEC_VENDOR_UNKNOWN
;
682 uint8_t CCECClient::SendVolumeUp(bool bSendRelease
/* = true */)
684 CCECBusDevice
*device
= GetPrimaryDevice();
685 CCECAudioSystem
*audio
= m_processor
->GetAudioSystem();
687 return device
&& audio
&& audio
->IsPresent() ?
688 audio
->VolumeUp(device
->GetLogicalAddress(), bSendRelease
) :
689 (uint8_t)CEC_AUDIO_VOLUME_STATUS_UNKNOWN
;
692 uint8_t CCECClient::SendVolumeDown(bool bSendRelease
/* = true */)
694 CCECBusDevice
*device
= GetPrimaryDevice();
695 CCECAudioSystem
*audio
= m_processor
->GetAudioSystem();
697 return device
&& audio
&& audio
->IsPresent() ?
698 audio
->VolumeDown(device
->GetLogicalAddress(), bSendRelease
) :
699 (uint8_t)CEC_AUDIO_VOLUME_STATUS_UNKNOWN
;
702 uint8_t CCECClient::SendMuteAudio(void)
704 CCECBusDevice
*device
= GetPrimaryDevice();
705 CCECAudioSystem
*audio
= m_processor
->GetAudioSystem();
707 return device
&& audio
&& audio
->IsPresent() ?
708 audio
->MuteAudio(device
->GetLogicalAddress()) :
709 (uint8_t)CEC_AUDIO_VOLUME_STATUS_UNKNOWN
;
712 bool CCECClient::SendKeypress(const cec_logical_address iDestination
, const cec_user_control_code key
, bool bWait
/* = true */)
714 CCECBusDevice
*dest
= m_processor
->GetDevice(iDestination
);
717 dest
->TransmitKeypress(GetPrimaryLogicalAdddress(), key
, bWait
) :
721 bool CCECClient::SendKeyRelease(const cec_logical_address iDestination
, bool bWait
/* = true */)
723 CCECBusDevice
*dest
= m_processor
->GetDevice(iDestination
);
726 dest
->TransmitKeyRelease(GetPrimaryLogicalAdddress(), bWait
) :
730 bool CCECClient::GetCurrentConfiguration(libcec_configuration
&configuration
)
732 CLockObject
lock(m_mutex
);
734 // client version 1.5.0
735 snprintf(configuration
.strDeviceName
, 13, "%s", m_configuration
.strDeviceName
);
736 configuration
.deviceTypes
= m_configuration
.deviceTypes
;
737 configuration
.bAutodetectAddress
= m_configuration
.bAutodetectAddress
;
738 configuration
.iPhysicalAddress
= m_configuration
.iPhysicalAddress
;
739 configuration
.baseDevice
= m_configuration
.baseDevice
;
740 configuration
.iHDMIPort
= m_configuration
.iHDMIPort
;
741 configuration
.clientVersion
= m_configuration
.clientVersion
;
742 configuration
.serverVersion
= m_configuration
.serverVersion
;
743 configuration
.tvVendor
= m_configuration
.tvVendor
;
745 configuration
.bGetSettingsFromROM
= m_configuration
.bGetSettingsFromROM
;
746 configuration
.bUseTVMenuLanguage
= m_configuration
.bUseTVMenuLanguage
;
747 configuration
.bActivateSource
= m_configuration
.bActivateSource
;
748 configuration
.wakeDevices
= m_configuration
.wakeDevices
;
749 configuration
.powerOffDevices
= m_configuration
.powerOffDevices
;
750 configuration
.bPowerOffScreensaver
= m_configuration
.bPowerOffScreensaver
;
751 configuration
.bPowerOffOnStandby
= m_configuration
.bPowerOffOnStandby
;
753 // client version 1.5.1
754 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_1
)
755 configuration
.bSendInactiveSource
= m_configuration
.bSendInactiveSource
;
757 // client version 1.5.3
758 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_3
)
759 configuration
.logicalAddresses
= m_configuration
.logicalAddresses
;
761 // client version 1.6.0
762 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_0
)
764 configuration
.iFirmwareVersion
= m_configuration
.iFirmwareVersion
;
765 configuration
.bPowerOffDevicesOnStandby
= m_configuration
.bPowerOffDevicesOnStandby
;
766 configuration
.bShutdownOnStandby
= m_configuration
.bShutdownOnStandby
;
769 // client version 1.6.2
770 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_2
)
772 memcpy(configuration
.strDeviceLanguage
, m_configuration
.strDeviceLanguage
, 3);
773 configuration
.iFirmwareBuildDate
= m_configuration
.iFirmwareBuildDate
;
776 // client version 1.6.3
777 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_3
)
779 configuration
.bMonitorOnly
= m_configuration
.bMonitorOnly
;
785 bool CCECClient::SetConfiguration(const libcec_configuration
&configuration
)
787 bool bIsRunning(m_processor
&& m_processor
->CECInitialised());
788 CCECBusDevice
*primary
= bIsRunning
? GetPrimaryDevice() : NULL
;
789 uint16_t iPA
= primary
? primary
->GetCurrentPhysicalAddress() : CEC_INVALID_PHYSICAL_ADDRESS
;
791 // update the callbacks
792 if (configuration
.callbacks
)
793 EnableCallbacks(configuration
.callbackParam
, configuration
.callbacks
);
795 // update the client version
796 SetClientVersion((cec_client_version
)configuration
.clientVersion
);
798 // update the OSD name
799 CStdString
strOSDName(configuration
.strDeviceName
);
800 SetOSDName(strOSDName
);
802 // update the TV vendor override
803 SetTVVendorOverride((cec_vendor_id
)configuration
.tvVendor
);
807 CLockObject
lock(m_mutex
);
808 m_configuration
.bUseTVMenuLanguage
= configuration
.bUseTVMenuLanguage
;
809 m_configuration
.bActivateSource
= configuration
.bActivateSource
;
810 m_configuration
.bGetSettingsFromROM
= configuration
.bGetSettingsFromROM
;
811 m_configuration
.wakeDevices
= configuration
.wakeDevices
;
812 m_configuration
.powerOffDevices
= configuration
.powerOffDevices
;
813 m_configuration
.bPowerOffScreensaver
= configuration
.bPowerOffScreensaver
;
814 m_configuration
.bPowerOffOnStandby
= configuration
.bPowerOffOnStandby
;
816 // client version 1.5.1
817 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_1
)
818 m_configuration
.bSendInactiveSource
= configuration
.bSendInactiveSource
;
820 // client version 1.6.0
821 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_0
)
823 m_configuration
.bPowerOffDevicesOnStandby
= configuration
.bPowerOffDevicesOnStandby
;
824 m_configuration
.bShutdownOnStandby
= configuration
.bShutdownOnStandby
;
827 // client version 1.6.2
828 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_2
)
830 memcpy(m_configuration
.strDeviceLanguage
, configuration
.strDeviceLanguage
, 3);
833 // client version 1.6.3
834 if (configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_3
)
836 m_configuration
.bMonitorOnly
= configuration
.bMonitorOnly
;
839 // ensure that there is at least 1 device type set
840 if (m_configuration
.deviceTypes
.IsEmpty())
841 m_configuration
.deviceTypes
.Add(CEC_DEVICE_TYPE_RECORDING_DEVICE
);
844 bool bNeedReinit(false);
847 if (SetDeviceTypes(configuration
.deviceTypes
))
849 // the device type changed. just copy the rest, and re-register
851 CLockObject
lock(m_mutex
);
852 m_configuration
.iPhysicalAddress
= configuration
.iPhysicalAddress
;
853 m_configuration
.baseDevice
= configuration
.baseDevice
;
854 m_configuration
.iHDMIPort
= configuration
.iHDMIPort
;
860 // set the physical address
861 SetPhysicalAddress(configuration
);
864 m_processor
->PersistConfiguration(m_configuration
);
867 primary
= GetPrimaryDevice();
869 if (bNeedReinit
|| !primary
|| primary
->GetCurrentPhysicalAddress() != iPA
)
871 // PA or device type changed
872 m_processor
->RegisterClient(this);
874 else if (primary
&& configuration
.bActivateSource
== 1 && bIsRunning
&& !primary
->IsActiveSource())
876 // activate the source if we're not already the active source
877 primary
->ActivateSource();
883 void CCECClient::AddCommand(const cec_command
&command
)
885 CLockObject
lock(m_mutex
);
887 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
);
889 if (m_configuration
.callbacks
&& m_configuration
.callbacks
->CBCecCommand
)
890 m_configuration
.callbacks
->CBCecCommand(m_configuration
.callbackParam
, command
);
891 else if (!m_commandBuffer
.Push(command
))
892 LIB_CEC
->AddLog(CEC_LOG_WARNING
, "command buffer is full");
895 int CCECClient::MenuStateChanged(const cec_menu_state newState
)
897 CLockObject
lock(m_mutex
);
899 LIB_CEC
->AddLog(CEC_LOG_NOTICE
, ">> %s: %s", ToString(CEC_OPCODE_MENU_REQUEST
), ToString(newState
));
901 if (m_configuration
.callbacks
&&
902 m_configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_2
&&
903 m_configuration
.callbacks
->CBCecMenuStateChanged
)
904 return m_configuration
.callbacks
->CBCecMenuStateChanged(m_configuration
.callbackParam
, newState
);
909 void CCECClient::Alert(const libcec_alert type
, const libcec_parameter
¶m
)
911 CLockObject
lock(m_mutex
);
913 if (m_configuration
.callbacks
&&
914 m_configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_6_0
&&
915 m_configuration
.callbacks
->CBCecAlert
)
916 m_configuration
.callbacks
->CBCecAlert(m_configuration
.callbackParam
, type
, param
);
919 void CCECClient::AddLog(const cec_log_message
&message
)
921 CLockObject
lock(m_logMutex
);
922 if (m_configuration
.callbacks
&& m_configuration
.callbacks
->CBCecLogMessage
)
923 m_configuration
.callbacks
->CBCecLogMessage(m_configuration
.callbackParam
, message
);
925 m_logBuffer
.Push(message
);
928 void CCECClient::AddKey(void)
930 CLockObject
lock(m_mutex
);
932 if (m_iCurrentButton
!= CEC_USER_CONTROL_CODE_UNKNOWN
)
936 key
.duration
= (unsigned int) (GetTimeMs() - m_buttontime
);
937 key
.keycode
= m_iCurrentButton
;
938 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "key released: %1x", key
.keycode
);
940 if (m_configuration
.callbacks
&& m_configuration
.callbacks
->CBCecKeyPress
)
941 m_configuration
.callbacks
->CBCecKeyPress(m_configuration
.callbackParam
, key
);
943 m_keyBuffer
.Push(key
);
944 m_iCurrentButton
= CEC_USER_CONTROL_CODE_UNKNOWN
;
950 void CCECClient::AddKey(const cec_keypress
&key
)
952 CLockObject
lock(m_mutex
);
954 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "key pressed: %1x", key
.keycode
);
956 if (m_configuration
.callbacks
&& m_configuration
.callbacks
->CBCecKeyPress
)
957 m_configuration
.callbacks
->CBCecKeyPress(m_configuration
.callbackParam
, key
);
959 m_keyBuffer
.Push(key
);
961 m_iCurrentButton
= key
.duration
> 0 ? CEC_USER_CONTROL_CODE_UNKNOWN
: key
.keycode
;
962 m_buttontime
= key
.duration
> 0 ? 0 : GetTimeMs();
965 void CCECClient::SetCurrentButton(const cec_user_control_code iButtonCode
)
967 // push a keypress to the buffer with 0 duration and another with the duration set when released
970 key
.keycode
= iButtonCode
;
975 void CCECClient::CheckKeypressTimeout(void)
977 if (m_iCurrentButton
!= CEC_USER_CONTROL_CODE_UNKNOWN
&& GetTimeMs() - m_buttontime
> CEC_BUTTON_TIMEOUT
)
980 m_iCurrentButton
= CEC_USER_CONTROL_CODE_UNKNOWN
;
984 void CCECClient::ConfigurationChanged(const libcec_configuration
&config
)
986 CLockObject
lock(m_mutex
);
988 if (m_configuration
.callbacks
&&
989 m_configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_5_0
&&
990 m_configuration
.callbacks
->CBCecConfigurationChanged
&&
991 m_processor
->CECInitialised())
992 m_configuration
.callbacks
->CBCecConfigurationChanged(m_configuration
.callbackParam
, config
);
995 bool CCECClient::EnableCallbacks(void *cbParam
, ICECCallbacks
*callbacks
)
997 CLockObject
lock(m_mutex
);
998 m_configuration
.callbackParam
= cbParam
;
999 m_configuration
.callbacks
= callbacks
;
1003 bool CCECClient::PingAdapter(void)
1005 return m_processor
? m_processor
->PingAdapter() : false;
1008 bool CCECClient::GetNextLogMessage(cec_log_message
*message
)
1010 return (m_logBuffer
.Pop(*message
));
1013 bool CCECClient::GetNextKeypress(cec_keypress
*key
)
1015 return m_keyBuffer
.Pop(*key
);
1018 bool CCECClient::GetNextCommand(cec_command
*command
)
1020 return m_commandBuffer
.Pop(*command
);
1023 CStdString
CCECClient::GetConnectionInfo(void)
1026 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
);
1027 if (m_configuration
.iFirmwareBuildDate
!= CEC_FW_BUILD_UNKNOWN
)
1029 time_t buildTime
= (time_t)m_configuration
.iFirmwareBuildDate
;
1030 strLog
.AppendFormat(", firmware build date: %s", asctime(gmtime(&buildTime
)));
1031 strLog
= strLog
.Left((int)strLog
.length() - 1); // strip \n added by asctime
1032 strLog
.append(" +0000");
1035 // log the addresses that are being used
1036 if (!m_configuration
.logicalAddresses
.IsEmpty())
1038 strLog
.append(", logical address(es) = ");
1039 CECDEVICEVEC devices
;
1040 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
1041 for (CECDEVICEVEC::iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
1042 strLog
.AppendFormat("%s (%X) ", (*it
)->GetLogicalAddressName(), (*it
)->GetLogicalAddress());
1045 if (!CLibCEC::IsValidPhysicalAddress(m_configuration
.iPhysicalAddress
))
1046 strLog
.AppendFormat(", base device: %s (%X), HDMI port number: %d", ToString(m_configuration
.baseDevice
), m_configuration
.baseDevice
, m_configuration
.iHDMIPort
);
1048 strLog
.AppendFormat(", physical address: %04x", m_configuration
.iPhysicalAddress
);
1053 void CCECClient::SetTVVendorOverride(const cec_vendor_id id
)
1056 CLockObject
lock(m_mutex
);
1057 m_configuration
.tvVendor
= id
;
1060 if (id
!= CEC_VENDOR_UNKNOWN
)
1062 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vendor id '%s'", __FUNCTION__
, ToString(id
));
1064 CCECBusDevice
*tv
= m_processor
? m_processor
->GetTV() : NULL
;
1066 tv
->SetVendorId((uint64_t)id
);
1070 cec_vendor_id
CCECClient::GetTVVendorOverride(void)
1072 CLockObject
lock(m_mutex
);
1073 return (cec_vendor_id
)m_configuration
.tvVendor
;
1076 void CCECClient::SetOSDName(const CStdString
&strDeviceName
)
1079 CLockObject
lock(m_mutex
);
1080 snprintf(m_configuration
.strDeviceName
, 13, "%s", strDeviceName
.c_str());
1083 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - using OSD name '%s'", __FUNCTION__
, strDeviceName
.c_str());
1085 CCECBusDevice
*primary
= GetPrimaryDevice();
1086 if (primary
&& !primary
->GetCurrentOSDName().Equals(strDeviceName
))
1088 primary
->SetOSDName(strDeviceName
);
1089 if (m_processor
&& m_processor
->CECInitialised())
1090 primary
->TransmitOSDName(CECDEVICE_TV
);
1094 CStdString
CCECClient::GetOSDName(void)
1096 CLockObject
lock(m_mutex
);
1097 CStdString
strOSDName(m_configuration
.strDeviceName
);
1101 void CCECClient::SetWakeDevices(const cec_logical_addresses
&addresses
)
1103 CLockObject
lock(m_mutex
);
1104 m_configuration
.wakeDevices
= addresses
;
1107 cec_logical_addresses
CCECClient::GetWakeDevices(void)
1109 CLockObject
lock(m_mutex
);
1110 return m_configuration
.wakeDevices
;
1113 bool CCECClient::AutodetectPhysicalAddress(void)
1115 bool bPhysicalAutodetected(false);
1116 uint16_t iPhysicalAddress
= m_processor
? m_processor
->GetDetectedPhysicalAddress() : CEC_INVALID_PHYSICAL_ADDRESS
;
1118 if (CLibCEC::IsValidPhysicalAddress(iPhysicalAddress
))
1120 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - autodetected physical address '%04X'", __FUNCTION__
, iPhysicalAddress
);
1122 CLockObject
lock(m_mutex
);
1123 m_configuration
.iPhysicalAddress
= iPhysicalAddress
;
1124 m_configuration
.iHDMIPort
= CEC_HDMI_PORTNUMBER_NONE
;
1125 m_configuration
.baseDevice
= CECDEVICE_UNKNOWN
;
1126 bPhysicalAutodetected
= true;
1129 SetDevicePhysicalAddress(iPhysicalAddress
);
1131 return bPhysicalAutodetected
;
1134 void CCECClient::SetClientVersion(const cec_client_version version
)
1136 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - using client version '%s'", __FUNCTION__
, ToString(version
));
1138 CLockObject
lock(m_mutex
);
1139 m_configuration
.clientVersion
= (uint32_t)version
;
1142 cec_client_version
CCECClient::GetClientVersion(void)
1144 CLockObject
lock(m_mutex
);
1145 return (cec_client_version
)m_configuration
.clientVersion
;
1148 bool CCECClient::SetDeviceTypes(const cec_device_type_list
&deviceTypes
)
1150 bool bNeedReinit(false);
1153 CLockObject
lock(m_mutex
);
1154 bNeedReinit
= m_processor
&& m_processor
->CECInitialised() &&
1155 (m_configuration
.deviceTypes
!= deviceTypes
);
1156 m_configuration
.deviceTypes
= deviceTypes
;
1160 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - using primary device type '%s'", __FUNCTION__
, ToString(deviceTypes
[0]));
1165 cec_device_type_list
CCECClient::GetDeviceTypes(void)
1167 cec_device_type_list retVal
;
1168 CLockObject
lock(m_mutex
);
1169 retVal
= m_configuration
.deviceTypes
;
1173 bool CCECClient::SetDevicePhysicalAddress(const uint16_t iPhysicalAddress
)
1175 if (!CLibCEC::IsValidPhysicalAddress(iPhysicalAddress
))
1178 // reconfigure all devices
1179 cec_logical_address
reactivateSource(CECDEVICE_UNKNOWN
);
1180 CECDEVICEVEC devices
;
1181 m_processor
->GetDevices()->GetByLogicalAddresses(devices
, m_configuration
.logicalAddresses
);
1182 for (CECDEVICEVEC::iterator it
= devices
.begin(); it
!= devices
.end(); it
++)
1184 // if this device was the active source, reactivate it afterwards
1185 if ((*it
)->IsActiveSource())
1186 reactivateSource
= (*it
)->GetLogicalAddress();
1188 // mark the device as inactive source
1189 if (IsInitialised())
1190 (*it
)->MarkAsInactiveSource();
1192 // set the new physical address
1193 (*it
)->SetPhysicalAddress(iPhysicalAddress
);
1196 if (IsInitialised())
1197 (*it
)->TransmitPhysicalAddress();
1200 // reactivate the previous active source
1201 if (reactivateSource
!= CECDEVICE_UNKNOWN
&&
1202 m_processor
->CECInitialised() &&
1205 CCECBusDevice
*device
= m_processor
->GetDevice(reactivateSource
);
1207 device
->ActivateSource();
1213 bool CCECClient::SwitchMonitoring(bool bEnable
)
1215 LIB_CEC
->AddLog(CEC_LOG_NOTICE
, "== %s monitoring mode ==", bEnable
? "enabling" : "disabling");
1220 return m_processor
->UnregisterClient(this);
1223 m_configuration
.bMonitorOnly
= false;
1224 return m_processor
->RegisterClient(this);
1231 bool CCECClient::PollDevice(const cec_logical_address iAddress
)
1233 // try to find the primary device
1234 CCECBusDevice
*primary
= GetPrimaryDevice();
1235 // poll the destination, with the primary as source
1237 return primary
->TransmitPoll(iAddress
);
1239 return m_processor
? m_processor
->PollDevice(iAddress
) : false;
1242 cec_logical_addresses
CCECClient::GetActiveDevices(void)
1244 CECDEVICEVEC activeDevices
;
1246 m_processor
->GetDevices()->GetActive(activeDevices
);
1247 return CCECDeviceMap::ToLogicalAddresses(activeDevices
);
1250 bool CCECClient::IsActiveDevice(const cec_logical_address iAddress
)
1252 cec_logical_addresses activeDevices
= GetActiveDevices();
1253 return activeDevices
.IsSet(iAddress
);
1256 bool CCECClient::IsActiveDeviceType(const cec_device_type type
)
1258 CECDEVICEVEC activeDevices
;
1260 m_processor
->GetDevices()->GetActive(activeDevices
);
1261 CCECDeviceMap::FilterType(type
, activeDevices
);
1262 return !activeDevices
.empty();
1265 cec_logical_address
CCECClient::GetActiveSource(void)
1267 return m_processor
? m_processor
->GetActiveSource() : CECDEVICE_UNKNOWN
;
1270 bool CCECClient::IsActiveSource(const cec_logical_address iAddress
)
1272 return m_processor
? m_processor
->IsActiveSource(iAddress
) : false;
1275 bool CCECClient::SetStreamPath(const cec_logical_address iAddress
)
1277 uint16_t iPhysicalAddress
= GetDevicePhysicalAddress(iAddress
);
1278 if (iPhysicalAddress
!= CEC_INVALID_PHYSICAL_ADDRESS
)
1279 return SetStreamPath(iPhysicalAddress
);
1283 bool CCECClient::SetStreamPath(const uint16_t iPhysicalAddress
)
1285 return m_processor
? m_processor
->SetStreamPath(iPhysicalAddress
) : false;
1288 cec_logical_addresses
CCECClient::GetLogicalAddresses(void)
1290 cec_logical_addresses addresses
;
1291 CLockObject
lock(m_mutex
);
1292 addresses
= m_configuration
.logicalAddresses
;
1296 bool CCECClient::CanPersistConfiguration(void)
1298 return m_processor
? m_processor
->CanPersistConfiguration() : false;
1301 bool CCECClient::PersistConfiguration(const libcec_configuration
&configuration
)
1303 return m_processor
? m_processor
->PersistConfiguration(configuration
) : false;
1306 void CCECClient::RescanActiveDevices(void)
1309 m_processor
->RescanActiveDevices();
1312 bool CCECClient::IsLibCECActiveSource(void)
1314 bool bReturn(false);
1317 cec_logical_address activeSource
= m_processor
->GetActiveSource();
1318 CCECBusDevice
*device
= m_processor
->GetDevice(activeSource
);
1320 bReturn
= device
->IsHandledByLibCEC();