src/lib/devices/CECBusDevice.cpp

   1 /*
   2  * This file is part of the libCEC(R) library.
   3  *
   4  * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited.  All rights reserved.
   5  * libCEC(R) is an original work, containing original code.
   6  *
   7  * libCEC(R) is a trademark of Pulse-Eight Limited.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  22  *
  23  *
  24  * Alternatively, you can license this library under a commercial license,
  25  * please contact Pulse-Eight Licensing for more information.
  26  *
  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/
  31  */
  32
  33 #include "CECBusDevice.h"
  34 #include "../CECProcessor.h"
  35 #include "../implementations/ANCommandHandler.h"
  36 #include "../implementations/CECCommandHandler.h"
  37 #include "../implementations/SLCommandHandler.h"
  38 #include "../implementations/VLCommandHandler.h"
  39 #include "../LibCEC.h"
  40 #include "../platform/util/timeutils.h"
  41
  42 using namespace CEC;
  43 using namespace PLATFORM;
  44
  45 #define ToString(p) m_processor->ToString(p)
  46
  47 CCECBusDevice::CCECBusDevice(CCECProcessor *processor, cec_logical_address iLogicalAddress, uint16_t iPhysicalAddress) :
  48   m_type                  (CEC_DEVICE_TYPE_RESERVED),
  49   m_iPhysicalAddress      (iPhysicalAddress),
  50   m_iStreamPath           (0),
  51   m_iLogicalAddress       (iLogicalAddress),
  52   m_powerStatus           (CEC_POWER_STATUS_UNKNOWN),
  53   m_processor             (processor),
  54   m_vendor                (CEC_VENDOR_UNKNOWN),
  55   m_bReplaceHandler       (false),
  56   m_menuState             (CEC_MENU_STATE_ACTIVATED),
  57   m_bActiveSource         (false),
  58   m_iLastActive           (0),
  59   m_iLastPowerStateUpdate (0),
  60   m_cecVersion            (CEC_VERSION_UNKNOWN),
  61   m_deviceStatus          (CEC_DEVICE_STATUS_UNKNOWN),
  62   m_iHandlerUseCount      (0),
  63   m_bAwaitingReceiveFailed(false),
  64   m_bVendorIdRequested    (false)
  65 {
  66   m_handler = new CCECCommandHandler(this);
  67
  68   for (unsigned int iPtr = 0; iPtr < 4; iPtr++)
  69     m_menuLanguage.language[iPtr] = '?';
  70   m_menuLanguage.language[3] = 0;
  71   m_menuLanguage.device = iLogicalAddress;
  72
  73   m_strDeviceName = ToString(m_iLogicalAddress);
  74 }
  75
  76 CCECBusDevice::~CCECBusDevice(void)
  77 {
  78   delete m_handler;
  79 }
  80
  81 bool CCECBusDevice::HandleCommand(const cec_command &command)
  82 {
  83   bool bHandled(false);
  84
  85   /* update "last active" */
  86   {
  87     CLockObject lock(m_mutex);
  88     m_iLastActive = GetTimeMs();
  89
  90     /* don't call GetStatus() here, just read the value with the mutex locked */
  91     if (m_deviceStatus != CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC && command.opcode_set == 1)
  92       m_deviceStatus = CEC_DEVICE_STATUS_PRESENT;
  93
  94     MarkBusy();
  95   }
  96
  97   /* handle the command */
  98   bHandled = m_handler->HandleCommand(command);
  99
 100   /* change status to present */
 101   if (bHandled)
 102   {
 103     CLockObject lock(m_mutex);
 104     if (m_deviceStatus != CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC)
 105     {
 106       if (m_deviceStatus != CEC_DEVICE_STATUS_PRESENT)
 107         CLibCEC::AddLog(CEC_LOG_DEBUG, "device %s (%x) status changed to present after command %s", GetLogicalAddressName(), (uint8_t)GetLogicalAddress(), ToString(command.opcode));
 108       m_deviceStatus = CEC_DEVICE_STATUS_PRESENT;
 109     }
 110   }
 111
 112   MarkReady();
 113   return bHandled;
 114 }
 115
 116 bool CCECBusDevice::PowerOn(void)
 117 {
 118   bool bReturn(false);
 119   GetVendorId(); // ensure that we got the vendor id, because the implementations vary per vendor
 120
 121   MarkBusy();
 122   cec_power_status currentStatus = GetPowerStatus(false);
 123   if (currentStatus != CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON &&
 124     currentStatus != CEC_POWER_STATUS_ON)
 125   {
 126     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< powering on '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 127     if (m_handler->PowerOn(GetMyLogicalAddress(), m_iLogicalAddress))
 128     {
 129       SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
 130       bReturn = true;
 131     }
 132   }
 133   else
 134   {
 135     CLibCEC::AddLog(CEC_LOG_NOTICE, "'%s' (%X) is already '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(currentStatus));
 136   }
 137
 138   MarkReady();
 139   return bReturn;
 140 }
 141
 142 bool CCECBusDevice::Standby(void)
 143 {
 144   CLibCEC::AddLog(CEC_LOG_DEBUG, "<< putting '%s' (%X) in standby mode", GetLogicalAddressName(), m_iLogicalAddress);
 145   MarkBusy();
 146   bool bReturn = m_handler->TransmitStandby(GetMyLogicalAddress(), m_iLogicalAddress);
 147   MarkReady();
 148   return bReturn;
 149 }
 150
 151 /** @name Getters */
 152 //@{
 153 cec_version CCECBusDevice::GetCecVersion(bool bUpdate /* = false */)
 154 {
 155   bool bIsPresent(GetStatus() == CEC_DEVICE_STATUS_PRESENT);
 156   bool bRequestUpdate(false);
 157   {
 158     CLockObject lock(m_mutex);
 159     bRequestUpdate = bIsPresent &&
 160         (bUpdate || m_cecVersion == CEC_VERSION_UNKNOWN);
 161   }
 162
 163   if (bRequestUpdate)
 164   {
 165     CheckVendorIdRequested();
 166     RequestCecVersion();
 167   }
 168
 169   CLockObject lock(m_mutex);
 170   return m_cecVersion;
 171 }
 172
 173 bool CCECBusDevice::RequestCecVersion(bool bWaitForResponse /* = true */)
 174 {
 175   bool bReturn(false);
 176
 177   if (!MyLogicalAddressContains(m_iLogicalAddress) &&
 178       !IsUnsupportedFeature(CEC_OPCODE_GET_CEC_VERSION))
 179   {
 180     MarkBusy();
 181     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< requesting CEC version of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 182
 183     bReturn = m_handler->TransmitRequestCecVersion(GetMyLogicalAddress(), m_iLogicalAddress, bWaitForResponse);
 184     MarkReady();
 185   }
 186   return bReturn;
 187 }
 188
 189 const char* CCECBusDevice::GetLogicalAddressName(void) const
 190 {
 191   return ToString(m_iLogicalAddress);
 192 }
 193
 194 cec_menu_language &CCECBusDevice::GetMenuLanguage(bool bUpdate /* = false */)
 195 {
 196   bool bIsPresent(GetStatus() == CEC_DEVICE_STATUS_PRESENT);
 197   bool bRequestUpdate(false);
 198   {
 199     CLockObject lock(m_mutex);
 200     bRequestUpdate = (bIsPresent &&
 201         (bUpdate || !strcmp(m_menuLanguage.language, "???")));
 202   }
 203
 204   if (bRequestUpdate)
 205   {
 206     CheckVendorIdRequested();
 207     RequestMenuLanguage();
 208   }
 209
 210   CLockObject lock(m_mutex);
 211   return m_menuLanguage;
 212 }
 213
 214 bool CCECBusDevice::RequestMenuLanguage(bool bWaitForResponse /* = true */)
 215 {
 216   bool bReturn(false);
 217
 218   if (!MyLogicalAddressContains(m_iLogicalAddress) &&
 219       !IsUnsupportedFeature(CEC_OPCODE_GET_MENU_LANGUAGE))
 220   {
 221     MarkBusy();
 222     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< requesting menu language of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 223     bReturn = m_handler->TransmitRequestMenuLanguage(GetMyLogicalAddress(), m_iLogicalAddress, bWaitForResponse);
 224     MarkReady();
 225   }
 226   return bReturn;
 227 }
 228
 229 cec_menu_state CCECBusDevice::GetMenuState(void)
 230 {
 231   CLockObject lock(m_mutex);
 232   return m_menuState;
 233 }
 234
 235 cec_logical_address CCECBusDevice::GetMyLogicalAddress(void) const
 236 {
 237   return m_processor->GetLogicalAddress();
 238 }
 239
 240 uint16_t CCECBusDevice::GetMyPhysicalAddress(void) const
 241 {
 242   return m_processor->GetPhysicalAddress();
 243 }
 244
 245 CStdString CCECBusDevice::GetOSDName(bool bUpdate /* = false */)
 246 {
 247   bool bIsPresent(GetStatus() == CEC_DEVICE_STATUS_PRESENT);
 248   bool bRequestUpdate(false);
 249   {
 250     CLockObject lock(m_mutex);
 251     bRequestUpdate = bIsPresent &&
 252         (bUpdate || m_strDeviceName.Equals(ToString(m_iLogicalAddress))) &&
 253         m_type != CEC_DEVICE_TYPE_TV;
 254   }
 255
 256   if (bRequestUpdate)
 257   {
 258     CheckVendorIdRequested();
 259     RequestOSDName();
 260   }
 261
 262   CLockObject lock(m_mutex);
 263   return m_strDeviceName;
 264 }
 265
 266 bool CCECBusDevice::RequestOSDName(bool bWaitForResponse /* = true */)
 267 {
 268   bool bReturn(false);
 269
 270   if (!MyLogicalAddressContains(m_iLogicalAddress) &&
 271       !IsUnsupportedFeature(CEC_OPCODE_GIVE_OSD_NAME))
 272   {
 273     MarkBusy();
 274     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< requesting OSD name of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 275     bReturn = m_handler->TransmitRequestOSDName(GetMyLogicalAddress(), m_iLogicalAddress, bWaitForResponse);
 276     MarkReady();
 277   }
 278   return bReturn;
 279 }
 280
 281 uint16_t CCECBusDevice::GetPhysicalAddress(bool bSuppressUpdate /* = true */)
 282 {
 283   if (!bSuppressUpdate)
 284   {
 285     bool bIsPresent(GetStatus() == CEC_DEVICE_STATUS_PRESENT);
 286     bool bRequestUpdate(false);
 287     {
 288       CLockObject lock(m_mutex);
 289       bRequestUpdate = bIsPresent && m_iPhysicalAddress == 0xFFFF;
 290     }
 291
 292     if (bRequestUpdate)
 293     {
 294       CheckVendorIdRequested();
 295       if (!RequestPhysicalAddress())
 296         CLibCEC::AddLog(CEC_LOG_ERROR, "failed to request the physical address");
 297     }
 298   }
 299
 300   CLockObject lock(m_mutex);
 301   return m_iPhysicalAddress;
 302 }
 303
 304 bool CCECBusDevice::RequestPhysicalAddress(bool bWaitForResponse /* = true */)
 305 {
 306   bool bReturn(false);
 307
 308   if (!MyLogicalAddressContains(m_iLogicalAddress))
 309   {
 310     MarkBusy();
 311     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< requesting physical address of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 312     bReturn = m_handler->TransmitRequestPhysicalAddress(GetMyLogicalAddress(), m_iLogicalAddress, bWaitForResponse);
 313     MarkReady();
 314   }
 315   return bReturn;
 316 }
 317
 318 cec_power_status CCECBusDevice::GetPowerStatus(bool bUpdate /* = false */)
 319 {
 320   bool bIsPresent(GetStatus() == CEC_DEVICE_STATUS_PRESENT);
 321   bool bRequestUpdate(false);
 322   {
 323     CLockObject lock(m_mutex);
 324     bRequestUpdate = (bIsPresent &&
 325         (bUpdate || m_powerStatus == CEC_POWER_STATUS_UNKNOWN ||
 326             m_powerStatus == CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON ||
 327             m_powerStatus == CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY ||
 328             GetTimeMs() - m_iLastPowerStateUpdate >= CEC_POWER_STATE_REFRESH_TIME));
 329   }
 330
 331   if (bRequestUpdate)
 332   {
 333     CheckVendorIdRequested();
 334     RequestPowerStatus();
 335   }
 336
 337   CLockObject lock(m_mutex);
 338   return m_powerStatus;
 339 }
 340
 341 bool CCECBusDevice::RequestPowerStatus(bool bWaitForResponse /* = true */)
 342 {
 343   bool bReturn(false);
 344
 345   if (!MyLogicalAddressContains(m_iLogicalAddress) &&
 346       !IsUnsupportedFeature(CEC_OPCODE_GIVE_DEVICE_POWER_STATUS))
 347   {
 348     MarkBusy();
 349     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< requesting power status of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 350     bReturn = m_handler->TransmitRequestPowerStatus(GetMyLogicalAddress(), m_iLogicalAddress, bWaitForResponse);
 351     MarkReady();
 352   }
 353   return bReturn;
 354 }
 355
 356 cec_vendor_id CCECBusDevice::GetVendorId(bool bUpdate /* = false */)
 357 {
 358   bool bIsPresent(GetStatus() == CEC_DEVICE_STATUS_PRESENT);
 359   bool bRequestUpdate(false);
 360   {
 361     CLockObject lock(m_mutex);
 362     bRequestUpdate = (bIsPresent &&
 363         (bUpdate || m_vendor == CEC_VENDOR_UNKNOWN));
 364   }
 365
 366   if (bRequestUpdate)
 367     RequestVendorId();
 368
 369   CLockObject lock(m_mutex);
 370   return m_vendor;
 371 }
 372
 373 bool CCECBusDevice::RequestVendorId(bool bWaitForResponse /* = true */)
 374 {
 375   bool bReturn(false);
 376
 377   if (!MyLogicalAddressContains(m_iLogicalAddress) && GetMyLogicalAddress() != CECDEVICE_UNKNOWN)
 378   {
 379     MarkBusy();
 380     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< requesting vendor ID of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 381     bReturn = m_handler->TransmitRequestVendorId(GetMyLogicalAddress(), m_iLogicalAddress, bWaitForResponse);
 382     MarkReady();
 383
 384     if (bWaitForResponse)
 385       ReplaceHandler(true);
 386   }
 387   return bReturn;
 388 }
 389
 390 const char *CCECBusDevice::GetVendorName(bool bUpdate /* = false */)
 391 {
 392   return ToString(GetVendorId(bUpdate));
 393 }
 394
 395 bool CCECBusDevice::MyLogicalAddressContains(cec_logical_address address) const
 396 {
 397   return m_processor->HasLogicalAddress(address);
 398 }
 399
 400 bool CCECBusDevice::NeedsPoll(void)
 401 {
 402   bool bSendPoll(false);
 403   switch (m_iLogicalAddress)
 404   {
 405   case CECDEVICE_PLAYBACKDEVICE3:
 406     {
 407       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_PLAYBACKDEVICE2]->GetStatus();
 408       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 409     }
 410     break;
 411   case CECDEVICE_PLAYBACKDEVICE2:
 412     {
 413       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_PLAYBACKDEVICE1]->GetStatus();
 414       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 415     }
 416     break;
 417   case CECDEVICE_RECORDINGDEVICE3:
 418     {
 419       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_RECORDINGDEVICE2]->GetStatus();
 420       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 421     }
 422     break;
 423   case CECDEVICE_RECORDINGDEVICE2:
 424     {
 425       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_RECORDINGDEVICE1]->GetStatus();
 426       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 427     }
 428     break;
 429   case CECDEVICE_TUNER4:
 430     {
 431       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_TUNER3]->GetStatus();
 432       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 433     }
 434     break;
 435   case CECDEVICE_TUNER3:
 436     {
 437       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_TUNER2]->GetStatus();
 438       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 439     }
 440     break;
 441   case CECDEVICE_TUNER2:
 442     {
 443       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_TUNER1]->GetStatus();
 444       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 445     }
 446     break;
 447   case CECDEVICE_AUDIOSYSTEM:
 448   case CECDEVICE_PLAYBACKDEVICE1:
 449   case CECDEVICE_RECORDINGDEVICE1:
 450   case CECDEVICE_TUNER1:
 451   case CECDEVICE_TV:
 452     bSendPoll = true;
 453     break;
 454   default:
 455     break;
 456   }
 457
 458   return bSendPoll;
 459 }
 460
 461 cec_bus_device_status CCECBusDevice::GetStatus(bool bForcePoll /* = false */, bool bSuppressPoll /* = false */)
 462 {
 463   cec_bus_device_status status(CEC_DEVICE_STATUS_UNKNOWN);
 464   bool bNeedsPoll(false);
 465
 466   {
 467     CLockObject lock(m_mutex);
 468     status = m_deviceStatus;
 469     bNeedsPoll = !bSuppressPoll &&
 470         (bForcePoll || m_deviceStatus == CEC_DEVICE_STATUS_UNKNOWN);
 471   }
 472
 473   if (bNeedsPoll)
 474   {
 475     bool bPollAcked(false);
 476     if (bNeedsPoll && NeedsPoll())
 477       bPollAcked = m_processor->PollDevice(m_iLogicalAddress);
 478
 479     status = bPollAcked ? CEC_DEVICE_STATUS_PRESENT : CEC_DEVICE_STATUS_NOT_PRESENT;
 480     SetDeviceStatus(status);
 481   }
 482
 483   return status;
 484 }
 485
 486 //@}
 487
 488 /** @name Setters */
 489 //@{
 490 void CCECBusDevice::SetCecVersion(const cec_version newVersion)
 491 {
 492   if (m_cecVersion != newVersion)
 493     CLibCEC::AddLog(CEC_LOG_DEBUG, "%s (%X): CEC version %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(newVersion));
 494   m_cecVersion = newVersion;
 495 }
 496
 497 void CCECBusDevice::SetMenuLanguage(const cec_menu_language &language)
 498 {
 499   CLockObject lock(m_mutex);
 500   if (language.device == m_iLogicalAddress &&
 501       strcmp(language.language, m_menuLanguage.language))
 502   {
 503     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): menu language set to '%s'", GetLogicalAddressName(), m_iLogicalAddress, language.language);
 504     m_menuLanguage = language;
 505   }
 506 }
 507
 508 void CCECBusDevice::SetOSDName(CStdString strName)
 509 {
 510   CLockObject lock(m_mutex);
 511   if (m_strDeviceName != strName)
 512   {
 513     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): osd name set to '%s'", GetLogicalAddressName(), m_iLogicalAddress, strName.c_str());
 514     m_strDeviceName = strName;
 515   }
 516 }
 517
 518 void CCECBusDevice::SetMenuState(const cec_menu_state state)
 519 {
 520   CLockObject lock(m_mutex);
 521   if (m_menuState != state)
 522   {
 523     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): menu state set to '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(m_menuState));
 524     m_menuState = state;
 525   }
 526 }
 527
 528 void CCECBusDevice::SetInactiveSource(void)
 529 {
 530   {
 531     CLockObject lock(m_mutex);
 532     if (m_bActiveSource)
 533       CLibCEC::AddLog(CEC_LOG_DEBUG, "marking %s (%X) as inactive source", GetLogicalAddressName(), m_iLogicalAddress);
 534     m_bActiveSource = false;
 535   }
 536
 537   if (MyLogicalAddressContains(m_iLogicalAddress))
 538     SetPowerStatus(CEC_POWER_STATUS_STANDBY);
 539 }
 540
 541 void CCECBusDevice::SetActiveSource(void)
 542 {
 543   CLockObject lock(m_mutex);
 544   if (!m_bActiveSource)
 545     CLibCEC::AddLog(CEC_LOG_DEBUG, "making %s (%x) the active source", GetLogicalAddressName(), m_iLogicalAddress);
 546
 547   for (int iPtr = 0; iPtr < 16; iPtr++)
 548     if (iPtr != m_iLogicalAddress)
 549       m_processor->m_busDevices[iPtr]->SetInactiveSource();
 550
 551   m_bActiveSource = true;
 552   SetPowerStatus(CEC_POWER_STATUS_ON);
 553 }
 554
 555 bool CCECBusDevice::TryLogicalAddress(void)
 556 {
 557   CLibCEC::AddLog(CEC_LOG_DEBUG, "trying logical address '%s'", GetLogicalAddressName());
 558
 559   m_processor->SetAckMask(0);
 560   if (!TransmitPoll(m_iLogicalAddress))
 561   {
 562     CLibCEC::AddLog(CEC_LOG_NOTICE, "using logical address '%s'", GetLogicalAddressName());
 563     SetDeviceStatus(CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 564
 565     return true;
 566   }
 567
 568   CLibCEC::AddLog(CEC_LOG_DEBUG, "logical address '%s' already taken", GetLogicalAddressName());
 569   SetDeviceStatus(CEC_DEVICE_STATUS_PRESENT);
 570   return false;
 571 }
 572
 573 void CCECBusDevice::ResetDeviceStatus(void)
 574 {
 575   CLockObject lock(m_mutex);
 576   SetPowerStatus   (CEC_POWER_STATUS_UNKNOWN);
 577   SetVendorId      (CEC_VENDOR_UNKNOWN);
 578   SetMenuState     (CEC_MENU_STATE_ACTIVATED);
 579   SetCecVersion    (CEC_VERSION_UNKNOWN);
 580   SetStreamPath    (0);
 581   SetOSDName       (ToString(m_iLogicalAddress));
 582   SetInactiveSource();
 583   m_iLastActive = 0;
 584 }
 585
 586 void CCECBusDevice::SetDeviceStatus(const cec_bus_device_status newStatus)
 587 {
 588   {
 589     CLockObject lock(m_mutex);
 590     switch (newStatus)
 591     {
 592     case CEC_DEVICE_STATUS_UNKNOWN:
 593       if (m_deviceStatus != newStatus)
 594         CLibCEC::AddLog(CEC_LOG_DEBUG, "device status of %s changed into 'unknown'", ToString(m_iLogicalAddress));
 595       ResetDeviceStatus();
 596       m_deviceStatus = newStatus;
 597       break;
 598     case CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC:
 599       if (m_deviceStatus != newStatus)
 600         CLibCEC::AddLog(CEC_LOG_DEBUG, "device status of %s changed into 'handled by libCEC'", ToString(m_iLogicalAddress));
 601       SetPowerStatus   (CEC_POWER_STATUS_ON);
 602       SetVendorId      (CEC_VENDOR_UNKNOWN);
 603       SetMenuState     (CEC_MENU_STATE_ACTIVATED);
 604       SetCecVersion    (CEC_VERSION_1_3A);
 605       SetStreamPath    (0);
 606       SetInactiveSource();
 607       m_iLastActive   = 0;
 608       m_deviceStatus  = newStatus;
 609       break;
 610     case CEC_DEVICE_STATUS_PRESENT:
 611       if (m_deviceStatus != newStatus)
 612         CLibCEC::AddLog(CEC_LOG_DEBUG, "device status of %s changed into 'present'", ToString(m_iLogicalAddress));
 613       m_deviceStatus = newStatus;
 614       break;
 615     case CEC_DEVICE_STATUS_NOT_PRESENT:
 616       if (m_deviceStatus != newStatus)
 617       {
 618         CLibCEC::AddLog(CEC_LOG_DEBUG, "device status of %s changed into 'not present'", ToString(m_iLogicalAddress));
 619         ResetDeviceStatus();
 620         m_deviceStatus = newStatus;
 621       }
 622       break;
 623     }
 624   }
 625
 626   if (newStatus == CEC_DEVICE_STATUS_PRESENT)
 627     RequestVendorId(false);
 628 }
 629
 630 void CCECBusDevice::SetPhysicalAddress(uint16_t iNewAddress)
 631 {
 632   CLockObject lock(m_mutex);
 633   if (iNewAddress > 0 && m_iPhysicalAddress != iNewAddress)
 634   {
 635     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): physical address changed from %04x to %04x", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress, iNewAddress);
 636     m_iPhysicalAddress = iNewAddress;
 637   }
 638 }
 639
 640 void CCECBusDevice::SetStreamPath(uint16_t iNewAddress, uint16_t iOldAddress /* = 0 */)
 641 {
 642   CLockObject lock(m_mutex);
 643   if (iNewAddress > 0)
 644   {
 645     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): stream path changed from %04x to %04x", GetLogicalAddressName(), m_iLogicalAddress, iOldAddress == 0 ? m_iStreamPath : iOldAddress, iNewAddress);
 646     m_iStreamPath = iNewAddress;
 647
 648     // suppress polls when searching for a device
 649     CCECBusDevice *device = m_processor->GetDeviceByPhysicalAddress(iNewAddress);
 650     if (device)
 651     {
 652       // if a device is found with the new physical address, mark it as active, which will automatically mark all other devices as inactive
 653       device->SetActiveSource();
 654     }
 655     else
 656     {
 657       // try to find the device with the old address, and mark it as inactive when found
 658       device = m_processor->GetDeviceByPhysicalAddress(iOldAddress);
 659       if (device)
 660         device->SetInactiveSource();
 661     }
 662
 663     if (iNewAddress > 0)
 664     {
 665       lock.Unlock();
 666       SetPowerStatus(CEC_POWER_STATUS_ON);
 667     }
 668   }
 669 }
 670
 671 void CCECBusDevice::SetPowerStatus(const cec_power_status powerStatus)
 672 {
 673   CLockObject lock(m_mutex);
 674   if (m_powerStatus != powerStatus)
 675   {
 676     m_iLastPowerStateUpdate = GetTimeMs();
 677     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): power status changed from '%s' to '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(m_powerStatus), ToString(powerStatus));
 678     m_powerStatus = powerStatus;
 679   }
 680 }
 681
 682 void CCECBusDevice::MarkBusy(void)
 683 {
 684   CLockObject handlerLock(m_handlerMutex);
 685   ++m_iHandlerUseCount;
 686 }
 687
 688 void CCECBusDevice::MarkReady(void)
 689 {
 690   CLockObject handlerLock(m_handlerMutex);
 691   if (m_iHandlerUseCount > 0)
 692     --m_iHandlerUseCount;
 693 }
 694
 695 bool CCECBusDevice::ReplaceHandler(bool bActivateSource /* = true */)
 696 {
 697   bool bInitHandler(false);
 698   {
 699     CTryLockObject lock(m_mutex);
 700     if (!lock.IsLocked())
 701       return false;
 702
 703     CLockObject handlerLock(m_handlerMutex);
 704     if (m_iHandlerUseCount > 0)
 705       return false;
 706
 707     MarkBusy();
 708
 709     if (m_vendor != m_handler->GetVendorId())
 710     {
 711       if (CCECCommandHandler::HasSpecificHandler(m_vendor))
 712       {
 713         CLibCEC::AddLog(CEC_LOG_DEBUG, "replacing the command handler for device '%s' (%x)", GetLogicalAddressName(), GetLogicalAddress());
 714         delete m_handler;
 715
 716         switch (m_vendor)
 717         {
 718         case CEC_VENDOR_SAMSUNG:
 719           m_handler = new CANCommandHandler(this);
 720           break;
 721         case CEC_VENDOR_LG:
 722           m_handler = new CSLCommandHandler(this);
 723           break;
 724         case CEC_VENDOR_PANASONIC:
 725           m_handler = new CVLCommandHandler(this);
 726           break;
 727         default:
 728           m_handler = new CCECCommandHandler(this);
 729           break;
 730         }
 731
 732         m_handler->SetVendorId(m_vendor);
 733         bInitHandler = true;
 734       }
 735     }
 736   }
 737
 738   if (bInitHandler)
 739   {
 740     m_handler->InitHandler();
 741
 742     if (bActivateSource && m_processor->GetLogicalAddresses().IsSet(m_iLogicalAddress) && m_processor->IsInitialised() && IsActiveSource())
 743       m_handler->ActivateSource();
 744   }
 745
 746   MarkReady();
 747
 748   return true;
 749 }
 750
 751 bool CCECBusDevice::SetVendorId(uint64_t iVendorId)
 752 {
 753   bool bVendorChanged(false);
 754
 755   {
 756     CLockObject lock(m_mutex);
 757     bVendorChanged = (m_vendor != (cec_vendor_id)iVendorId);
 758     m_vendor = (cec_vendor_id)iVendorId;
 759   }
 760
 761   if (bVendorChanged)
 762     CLibCEC::AddLog(CEC_LOG_DEBUG, "%s (%X): vendor = %s (%06x)", GetLogicalAddressName(), m_iLogicalAddress, ToString(m_vendor), m_vendor);
 763
 764   return bVendorChanged;
 765 }
 766 //@}
 767
 768 /** @name Transmit methods */
 769 //@{
 770 bool CCECBusDevice::TransmitActiveSource(void)
 771 {
 772   bool bSendActiveSource(false);
 773
 774   {
 775     CLockObject lock(m_mutex);
 776     if (m_powerStatus != CEC_POWER_STATUS_ON && m_powerStatus != CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON)
 777       CLibCEC::AddLog(CEC_LOG_DEBUG, "<< %s (%X) is not powered on", GetLogicalAddressName(), m_iLogicalAddress);
 778     else if (m_bActiveSource)
 779     {
 780       CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> broadcast (F): active source (%4x)", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress);
 781       bSendActiveSource = true;
 782     }
 783     else
 784       CLibCEC::AddLog(CEC_LOG_DEBUG, "<< %s (%X) is not the active source", GetLogicalAddressName(), m_iLogicalAddress);
 785   }
 786
 787   if (bSendActiveSource)
 788   {
 789     MarkBusy();
 790     m_handler->TransmitActiveSource(m_iLogicalAddress, m_iPhysicalAddress);
 791     MarkReady();
 792     return true;
 793   }
 794
 795   return false;
 796 }
 797
 798 bool CCECBusDevice::TransmitCECVersion(cec_logical_address dest)
 799 {
 800   cec_version version;
 801   {
 802     CLockObject lock(m_mutex);
 803     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): cec version %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_cecVersion));
 804     version = m_cecVersion;
 805   }
 806
 807   MarkBusy();
 808   bool bReturn = m_handler->TransmitCECVersion(m_iLogicalAddress, dest, version);
 809   MarkReady();
 810   return bReturn;
 811 }
 812
 813 bool CCECBusDevice::TransmitImageViewOn(void)
 814 {
 815   {
 816     CLockObject lock(m_mutex);
 817     if (m_powerStatus != CEC_POWER_STATUS_ON && m_powerStatus != CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON)
 818     {
 819       CLibCEC::AddLog(CEC_LOG_DEBUG, "<< %s (%X) is not powered on", GetLogicalAddressName(), m_iLogicalAddress);
 820       return false;
 821     }
 822   }
 823
 824   MarkBusy();
 825   m_handler->TransmitImageViewOn(m_iLogicalAddress, CECDEVICE_TV);
 826   MarkReady();
 827   return true;
 828 }
 829
 830 bool CCECBusDevice::TransmitInactiveSource(void)
 831 {
 832   uint16_t iPhysicalAddress;
 833   {
 834     CLockObject lock(m_mutex);
 835     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> broadcast (F): inactive source", GetLogicalAddressName(), m_iLogicalAddress);
 836     iPhysicalAddress = m_iPhysicalAddress;
 837   }
 838
 839   MarkBusy();
 840   bool bReturn = m_handler->TransmitInactiveSource(m_iLogicalAddress, iPhysicalAddress);
 841   MarkReady();
 842   return bReturn;
 843 }
 844
 845 bool CCECBusDevice::TransmitMenuState(cec_logical_address dest)
 846 {
 847   cec_menu_state menuState;
 848   {
 849     CLockObject lock(m_mutex);
 850     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): menu state '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_menuState));
 851     menuState = m_menuState;
 852   }
 853
 854   MarkBusy();
 855   bool bReturn = m_handler->TransmitMenuState(m_iLogicalAddress, dest, menuState);
 856   MarkReady();
 857   return bReturn;
 858 }
 859
 860 bool CCECBusDevice::TransmitOSDName(cec_logical_address dest)
 861 {
 862   CStdString strDeviceName;
 863   {
 864     CLockObject lock(m_mutex);
 865     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): OSD name '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, m_strDeviceName.c_str());
 866     strDeviceName = m_strDeviceName;
 867   }
 868
 869   MarkBusy();
 870   bool bReturn = m_handler->TransmitOSDName(m_iLogicalAddress, dest, strDeviceName);
 871   MarkReady();
 872   return bReturn;
 873 }
 874
 875 bool CCECBusDevice::TransmitOSDString(cec_logical_address dest, cec_display_control duration, const char *strMessage)
 876 {
 877   bool bReturn(false);
 878   if (!m_processor->m_busDevices[dest]->IsUnsupportedFeature(CEC_OPCODE_SET_OSD_STRING))
 879   {
 880     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): display OSD message '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, strMessage);
 881     MarkBusy();
 882     bReturn = m_handler->TransmitOSDString(m_iLogicalAddress, dest, duration, strMessage);
 883     MarkReady();
 884   }
 885   return bReturn;
 886 }
 887
 888 bool CCECBusDevice::TransmitPhysicalAddress(void)
 889 {
 890   uint16_t iPhysicalAddress;
 891   cec_device_type type;
 892   {
 893     CLockObject lock(m_mutex);
 894     if (m_iPhysicalAddress == 0xffff)
 895       return false;
 896
 897     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> broadcast (F): physical adddress %4x", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress);
 898     iPhysicalAddress = m_iPhysicalAddress;
 899     type = m_type;
 900   }
 901
 902   MarkBusy();
 903   bool bReturn = m_handler->TransmitPhysicalAddress(m_iLogicalAddress, iPhysicalAddress, type);
 904   MarkReady();
 905   return bReturn;
 906 }
 907
 908 bool CCECBusDevice::TransmitSetMenuLanguage(cec_logical_address dest)
 909 {
 910   bool bReturn(false);
 911   cec_menu_language language = GetMenuLanguage();
 912
 913   char lang[3];
 914   {
 915     CLockObject lock(m_mutex);
 916     lang[0] = language.language[0];
 917     lang[1] = language.language[1];
 918     lang[2] = language.language[2];
 919   }
 920
 921   MarkBusy();
 922   if (lang[0] == '?' && lang[1] == '?' && lang[2] == '?')
 923   {
 924       CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): Menu language feature abort", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
 925       m_processor->TransmitAbort(dest, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 926       bReturn = true;
 927   }
 928   else
 929   {
 930       CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> broadcast (F): Menu language '%s'", GetLogicalAddressName(), m_iLogicalAddress, lang);
 931       bReturn = m_handler->TransmitSetMenuLanguage(m_iLogicalAddress, lang);
 932   }
 933   MarkReady();
 934   return bReturn;
 935 }
 936
 937 bool CCECBusDevice::TransmitPoll(cec_logical_address dest)
 938 {
 939   bool bReturn(false);
 940   if (dest == CECDEVICE_UNKNOWN)
 941     dest = m_iLogicalAddress;
 942
 943   CCECBusDevice *destDevice = m_processor->m_busDevices[dest];
 944   if (destDevice->m_deviceStatus == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC)
 945     return bReturn;
 946
 947   MarkBusy();
 948   CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): POLL", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
 949   bReturn = m_handler->TransmitPoll(m_iLogicalAddress, dest);
 950   CLibCEC::AddLog(CEC_LOG_DEBUG, bReturn ? ">> POLL sent" : ">> POLL not sent");
 951
 952   CLockObject lock(m_mutex);
 953   if (bReturn)
 954   {
 955     m_iLastActive = GetTimeMs();
 956     destDevice->m_deviceStatus = CEC_DEVICE_STATUS_PRESENT;
 957   }
 958   else
 959     destDevice->m_deviceStatus = CEC_DEVICE_STATUS_NOT_PRESENT;
 960
 961   MarkReady();
 962   return bReturn;
 963 }
 964
 965 bool CCECBusDevice::TransmitPowerState(cec_logical_address dest)
 966 {
 967   cec_power_status state;
 968   {
 969     CLockObject lock(m_mutex);
 970     if (!IsActiveSource())
 971     {
 972       CLibCEC::AddLog(CEC_LOG_NOTICE, "power state requested of %s (%X), but we are not the active source. setting power state to standby", GetLogicalAddressName(), m_iLogicalAddress);
 973       SetPowerStatus(CEC_POWER_STATUS_STANDBY);
 974     }
 975
 976     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_powerStatus));
 977     state = m_powerStatus;
 978   }
 979
 980   MarkBusy();
 981   bool bReturn = m_handler->TransmitPowerState(m_iLogicalAddress, dest, state);
 982   MarkReady();
 983   return bReturn;
 984 }
 985
 986 bool CCECBusDevice::TransmitVendorID(cec_logical_address dest, bool bSendAbort /* = true */)
 987 {
 988   bool bReturn(false);
 989   uint64_t iVendorId;
 990   {
 991     CLockObject lock(m_mutex);
 992     iVendorId = (uint64_t)m_vendor;
 993   }
 994
 995   MarkBusy();
 996   if (iVendorId == CEC_VENDOR_UNKNOWN)
 997   {
 998     if (bSendAbort)
 999     {
1000       CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): vendor id feature abort", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
1001       m_processor->TransmitAbort(dest, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
1002       bReturn = true;
1003     }
1004   }
1005   else
1006   {
1007     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): vendor id %s (%x)", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString((cec_vendor_id)iVendorId), iVendorId);
1008     bReturn = m_handler->TransmitVendorID(m_iLogicalAddress, iVendorId);
1009   }
1010   MarkReady();
1011   return bReturn;
1012 }
1013
1014 bool CCECBusDevice::TransmitKeypress(cec_user_control_code key, bool bWait /* = true */)
1015 {
1016   MarkBusy();
1017   bool bReturn = m_handler->TransmitKeypress(m_processor->GetLogicalAddress(), m_iLogicalAddress, key, bWait);
1018   MarkReady();
1019   return bReturn;
1020 }
1021
1022 bool CCECBusDevice::TransmitKeyRelease(bool bWait /* = true */)
1023 {
1024   MarkBusy();
1025   bool bReturn = m_handler->TransmitKeyRelease(m_processor->GetLogicalAddress(), m_iLogicalAddress, bWait);
1026   MarkReady();
1027   return bReturn;
1028 }
1029
1030 bool CCECBusDevice::IsUnsupportedFeature(cec_opcode opcode)
1031 {
1032   CLockObject lock(m_mutex);
1033   bool bUnsupported = (m_unsupportedFeatures.find(opcode) != m_unsupportedFeatures.end());
1034   if (bUnsupported)
1035     CLibCEC::AddLog(CEC_LOG_DEBUG, "'%s' is marked as unsupported feature for device '%s'", ToString(opcode), GetLogicalAddressName());
1036   return bUnsupported;
1037 }
1038
1039 void CCECBusDevice::SetUnsupportedFeature(cec_opcode opcode)
1040 {
1041   // some commands should never be marked as unsupported
1042   if (opcode == CEC_OPCODE_VENDOR_COMMAND ||
1043       opcode == CEC_OPCODE_VENDOR_COMMAND_WITH_ID ||
1044       opcode == CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN ||
1045       opcode == CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP ||
1046       opcode == CEC_OPCODE_ABORT ||
1047       opcode == CEC_OPCODE_FEATURE_ABORT ||
1048       opcode == CEC_OPCODE_NONE)
1049     return;
1050
1051   {
1052     CLockObject lock(m_mutex);
1053     if (m_unsupportedFeatures.find(opcode) == m_unsupportedFeatures.end())
1054     {
1055       CLibCEC::AddLog(CEC_LOG_DEBUG, "marking opcode '%s' as unsupported feature for device '%s'", ToString(opcode), GetLogicalAddressName());
1056       m_unsupportedFeatures.insert(opcode);
1057     }
1058   }
1059
1060   // signal threads that are waiting for a reponse
1061   MarkBusy();
1062   m_handler->SignalOpcode(cec_command::GetResponseOpcode(opcode));
1063   MarkReady();
1064 }
1065
1066 bool CCECBusDevice::ActivateSource(void)
1067 {
1068   CLibCEC::AddLog(CEC_LOG_DEBUG, "activating source '%s'", ToString(m_iLogicalAddress));
1069   MarkBusy();
1070   bool bReturn = m_handler->ActivateSource();
1071   MarkReady();
1072   return bReturn;
1073 }
1074
1075 void CCECBusDevice::HandlePoll(cec_logical_address destination)
1076 {
1077   if (destination >= 0 && destination < CECDEVICE_BROADCAST)
1078   {
1079     CCECBusDevice *device = m_processor->m_busDevices[destination];
1080     if (device)
1081       device->HandlePollFrom(m_iLogicalAddress);
1082   }
1083 }
1084
1085 void CCECBusDevice::HandlePollFrom(cec_logical_address initiator)
1086 {
1087   CLibCEC::AddLog(CEC_LOG_DEBUG, "<< POLL: %s (%x) -> %s (%x)", ToString(initiator), initiator, ToString(m_iLogicalAddress), m_iLogicalAddress);
1088   m_bAwaitingReceiveFailed = true;
1089 }
1090
1091 bool CCECBusDevice::HandleReceiveFailed(void)
1092 {
1093   bool bReturn = m_bAwaitingReceiveFailed;
1094   m_bAwaitingReceiveFailed = false;
1095   return bReturn;
1096 }
1097
1098 void CCECBusDevice::CheckVendorIdRequested(void)
1099 {
1100   bool bRequestVendorId(false);
1101   {
1102     CLockObject lock(m_mutex);
1103     bRequestVendorId = !m_bVendorIdRequested;
1104     m_bVendorIdRequested = true;
1105   }
1106
1107   if (bRequestVendorId)
1108   {
1109     ReplaceHandler(false);
1110     GetVendorId();
1111   }
1112 }
1113
1114 bool CCECBusDevice::TransmitPendingActiveSourceCommands(void)
1115 {
1116   MarkBusy();
1117   bool bReturn = m_handler->TransmitPendingActiveSourceCommands();
1118   MarkReady();
1119   return bReturn;
1120 }
1121
1122 //@}