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 bUpdate /* = false */, bool bSuppressPoll /* = false */)
 282 {
 283   bool bIsPresent(GetStatus(false, bSuppressPoll) == CEC_DEVICE_STATUS_PRESENT);
 284   bool bRequestUpdate(false);
 285   {
 286     CLockObject lock(m_mutex);
 287     bRequestUpdate = bIsPresent &&
 288       (m_iPhysicalAddress == 0xFFFF || bUpdate);
 289   }
 290
 291   if (bRequestUpdate)
 292   {
 293     CheckVendorIdRequested();
 294     if (!RequestPhysicalAddress())
 295       CLibCEC::AddLog(CEC_LOG_ERROR, "failed to request the physical address");
 296   }
 297
 298   CLockObject lock(m_mutex);
 299   return m_iPhysicalAddress;
 300 }
 301
 302 bool CCECBusDevice::RequestPhysicalAddress(bool bWaitForResponse /* = true */)
 303 {
 304   bool bReturn(false);
 305
 306   if (!MyLogicalAddressContains(m_iLogicalAddress))
 307   {
 308     MarkBusy();
 309     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< requesting physical address of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 310     bReturn = m_handler->TransmitRequestPhysicalAddress(GetMyLogicalAddress(), m_iLogicalAddress, bWaitForResponse);
 311     MarkReady();
 312   }
 313   return bReturn;
 314 }
 315
 316 cec_power_status CCECBusDevice::GetPowerStatus(bool bUpdate /* = false */)
 317 {
 318   bool bIsPresent(GetStatus() == CEC_DEVICE_STATUS_PRESENT);
 319   bool bRequestUpdate(false);
 320   {
 321     CLockObject lock(m_mutex);
 322     bRequestUpdate = (bIsPresent &&
 323         (bUpdate || m_powerStatus == CEC_POWER_STATUS_UNKNOWN ||
 324             m_powerStatus == CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON ||
 325             m_powerStatus == CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY ||
 326             GetTimeMs() - m_iLastPowerStateUpdate >= CEC_POWER_STATE_REFRESH_TIME));
 327   }
 328
 329   if (bRequestUpdate)
 330   {
 331     CheckVendorIdRequested();
 332     RequestPowerStatus();
 333   }
 334
 335   CLockObject lock(m_mutex);
 336   return m_powerStatus;
 337 }
 338
 339 bool CCECBusDevice::RequestPowerStatus(bool bWaitForResponse /* = true */)
 340 {
 341   bool bReturn(false);
 342
 343   if (!MyLogicalAddressContains(m_iLogicalAddress) &&
 344       !IsUnsupportedFeature(CEC_OPCODE_GIVE_DEVICE_POWER_STATUS))
 345   {
 346     MarkBusy();
 347     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< requesting power status of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 348     bReturn = m_handler->TransmitRequestPowerStatus(GetMyLogicalAddress(), m_iLogicalAddress, bWaitForResponse);
 349     MarkReady();
 350   }
 351   return bReturn;
 352 }
 353
 354 cec_vendor_id CCECBusDevice::GetVendorId(bool bUpdate /* = false */)
 355 {
 356   bool bIsPresent(GetStatus() == CEC_DEVICE_STATUS_PRESENT);
 357   bool bRequestUpdate(false);
 358   {
 359     CLockObject lock(m_mutex);
 360     bRequestUpdate = (bIsPresent &&
 361         (bUpdate || m_vendor == CEC_VENDOR_UNKNOWN));
 362   }
 363
 364   if (bRequestUpdate)
 365     RequestVendorId();
 366
 367   CLockObject lock(m_mutex);
 368   return m_vendor;
 369 }
 370
 371 bool CCECBusDevice::RequestVendorId(bool bWaitForResponse /* = true */)
 372 {
 373   bool bReturn(false);
 374
 375   if (!MyLogicalAddressContains(m_iLogicalAddress) && GetMyLogicalAddress() != CECDEVICE_UNKNOWN)
 376   {
 377     MarkBusy();
 378     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< requesting vendor ID of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 379     bReturn = m_handler->TransmitRequestVendorId(GetMyLogicalAddress(), m_iLogicalAddress, bWaitForResponse);
 380     MarkReady();
 381
 382     if (bWaitForResponse)
 383       ReplaceHandler(true);
 384   }
 385   return bReturn;
 386 }
 387
 388 const char *CCECBusDevice::GetVendorName(bool bUpdate /* = false */)
 389 {
 390   return ToString(GetVendorId(bUpdate));
 391 }
 392
 393 bool CCECBusDevice::MyLogicalAddressContains(cec_logical_address address) const
 394 {
 395   return m_processor->HasLogicalAddress(address);
 396 }
 397
 398 bool CCECBusDevice::NeedsPoll(void)
 399 {
 400   bool bSendPoll(false);
 401   switch (m_iLogicalAddress)
 402   {
 403   case CECDEVICE_PLAYBACKDEVICE3:
 404     {
 405       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_PLAYBACKDEVICE2]->GetStatus();
 406       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 407     }
 408     break;
 409   case CECDEVICE_PLAYBACKDEVICE2:
 410     {
 411       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_PLAYBACKDEVICE1]->GetStatus();
 412       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 413     }
 414     break;
 415   case CECDEVICE_RECORDINGDEVICE3:
 416     {
 417       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_RECORDINGDEVICE2]->GetStatus();
 418       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 419     }
 420     break;
 421   case CECDEVICE_RECORDINGDEVICE2:
 422     {
 423       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_RECORDINGDEVICE1]->GetStatus();
 424       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 425     }
 426     break;
 427   case CECDEVICE_TUNER4:
 428     {
 429       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_TUNER3]->GetStatus();
 430       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 431     }
 432     break;
 433   case CECDEVICE_TUNER3:
 434     {
 435       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_TUNER2]->GetStatus();
 436       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 437     }
 438     break;
 439   case CECDEVICE_TUNER2:
 440     {
 441       cec_bus_device_status status = m_processor->m_busDevices[CECDEVICE_TUNER1]->GetStatus();
 442       bSendPoll = (status == CEC_DEVICE_STATUS_PRESENT || status == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 443     }
 444     break;
 445   case CECDEVICE_AUDIOSYSTEM:
 446   case CECDEVICE_PLAYBACKDEVICE1:
 447   case CECDEVICE_RECORDINGDEVICE1:
 448   case CECDEVICE_TUNER1:
 449   case CECDEVICE_TV:
 450     bSendPoll = true;
 451     break;
 452   default:
 453     break;
 454   }
 455
 456   return bSendPoll;
 457 }
 458
 459 cec_bus_device_status CCECBusDevice::GetStatus(bool bForcePoll /* = false */, bool bSuppressPoll /* = false */)
 460 {
 461   cec_bus_device_status status(CEC_DEVICE_STATUS_UNKNOWN);
 462   bool bNeedsPoll(false);
 463
 464   {
 465     CLockObject lock(m_mutex);
 466     status = m_deviceStatus;
 467     bNeedsPoll = !bSuppressPoll &&
 468         (bForcePoll || m_deviceStatus == CEC_DEVICE_STATUS_UNKNOWN);
 469   }
 470
 471   if (bNeedsPoll)
 472   {
 473     bool bPollAcked(false);
 474     if (bNeedsPoll && NeedsPoll())
 475       bPollAcked = m_processor->PollDevice(m_iLogicalAddress);
 476
 477     status = bPollAcked ? CEC_DEVICE_STATUS_PRESENT : CEC_DEVICE_STATUS_NOT_PRESENT;
 478     SetDeviceStatus(status);
 479   }
 480
 481   return status;
 482 }
 483
 484 //@}
 485
 486 /** @name Setters */
 487 //@{
 488 void CCECBusDevice::SetCecVersion(const cec_version newVersion)
 489 {
 490   m_cecVersion = newVersion;
 491   CLibCEC::AddLog(CEC_LOG_DEBUG, "%s (%X): CEC version %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(newVersion));
 492 }
 493
 494 void CCECBusDevice::SetMenuLanguage(const cec_menu_language &language)
 495 {
 496   CLockObject lock(m_mutex);
 497   if (language.device == m_iLogicalAddress)
 498   {
 499     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): menu language set to '%s'", GetLogicalAddressName(), m_iLogicalAddress, language.language);
 500     m_menuLanguage = language;
 501   }
 502 }
 503
 504 void CCECBusDevice::SetOSDName(CStdString strName)
 505 {
 506   CLockObject lock(m_mutex);
 507   if (m_strDeviceName != strName)
 508   {
 509     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): osd name set to '%s'", GetLogicalAddressName(), m_iLogicalAddress, strName.c_str());
 510     m_strDeviceName = strName;
 511   }
 512 }
 513
 514 void CCECBusDevice::SetMenuState(const cec_menu_state state)
 515 {
 516   CLockObject lock(m_mutex);
 517   if (m_menuState != state)
 518   {
 519     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): menu state set to '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(m_menuState));
 520     m_menuState = state;
 521   }
 522 }
 523
 524 void CCECBusDevice::SetInactiveSource(void)
 525 {
 526   {
 527     CLockObject lock(m_mutex);
 528     if (m_bActiveSource)
 529       CLibCEC::AddLog(CEC_LOG_DEBUG, "marking %s (%X) as inactive source", GetLogicalAddressName(), m_iLogicalAddress);
 530     m_bActiveSource = false;
 531   }
 532
 533   if (MyLogicalAddressContains(m_iLogicalAddress))
 534     SetPowerStatus(CEC_POWER_STATUS_STANDBY);
 535 }
 536
 537 void CCECBusDevice::SetActiveSource(void)
 538 {
 539   CLockObject lock(m_mutex);
 540   if (!m_bActiveSource)
 541     CLibCEC::AddLog(CEC_LOG_DEBUG, "making %s (%x) the active source", GetLogicalAddressName(), m_iLogicalAddress);
 542
 543   for (int iPtr = 0; iPtr < 16; iPtr++)
 544     if (iPtr != m_iLogicalAddress)
 545       m_processor->m_busDevices[iPtr]->SetInactiveSource();
 546
 547   m_bActiveSource = true;
 548   SetPowerStatus(CEC_POWER_STATUS_ON);
 549 }
 550
 551 bool CCECBusDevice::TryLogicalAddress(void)
 552 {
 553   CLibCEC::AddLog(CEC_LOG_DEBUG, "trying logical address '%s'", GetLogicalAddressName());
 554
 555   m_processor->SetAckMask(0);
 556   if (!TransmitPoll(m_iLogicalAddress))
 557   {
 558     CLibCEC::AddLog(CEC_LOG_NOTICE, "using logical address '%s'", GetLogicalAddressName());
 559     SetDeviceStatus(CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC);
 560
 561     return true;
 562   }
 563
 564   CLibCEC::AddLog(CEC_LOG_DEBUG, "logical address '%s' already taken", GetLogicalAddressName());
 565   SetDeviceStatus(CEC_DEVICE_STATUS_PRESENT);
 566   return false;
 567 }
 568
 569 void CCECBusDevice::SetDeviceStatus(const cec_bus_device_status newStatus)
 570 {
 571   {
 572     CLockObject lock(m_mutex);
 573     switch (newStatus)
 574     {
 575     case CEC_DEVICE_STATUS_UNKNOWN:
 576       if (m_deviceStatus != newStatus)
 577         CLibCEC::AddLog(CEC_LOG_DEBUG, "device status of %s changed into 'unknown'", ToString(m_iLogicalAddress));
 578       m_iStreamPath      = 0;
 579       m_powerStatus      = CEC_POWER_STATUS_UNKNOWN;
 580       m_vendor           = CEC_VENDOR_UNKNOWN;
 581       m_menuState        = CEC_MENU_STATE_ACTIVATED;
 582       m_bActiveSource    = false;
 583       m_iLastActive      = 0;
 584       m_cecVersion       = CEC_VERSION_UNKNOWN;
 585       m_deviceStatus     = newStatus;
 586       break;
 587     case CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC:
 588       if (m_deviceStatus != newStatus)
 589         CLibCEC::AddLog(CEC_LOG_DEBUG, "device status of %s changed into 'handled by libCEC'", ToString(m_iLogicalAddress));
 590       m_iStreamPath      = 0;
 591       m_powerStatus      = CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON;
 592       m_vendor           = CEC_VENDOR_UNKNOWN;
 593       m_menuState        = CEC_MENU_STATE_ACTIVATED;
 594       m_bActiveSource    = false;
 595       m_iLastActive      = 0;
 596       m_cecVersion       = CEC_VERSION_1_3A;
 597       m_deviceStatus     = newStatus;
 598       break;
 599     case CEC_DEVICE_STATUS_PRESENT:
 600       if (m_deviceStatus != newStatus)
 601         CLibCEC::AddLog(CEC_LOG_DEBUG, "device status of %s changed into 'present'", ToString(m_iLogicalAddress));
 602       m_deviceStatus = newStatus;
 603       break;
 604     case CEC_DEVICE_STATUS_NOT_PRESENT:
 605       if (m_deviceStatus != newStatus)
 606         CLibCEC::AddLog(CEC_LOG_DEBUG, "device status of %s changed into 'not present'", ToString(m_iLogicalAddress));
 607       m_deviceStatus = newStatus;
 608       break;
 609     }
 610   }
 611
 612   if (newStatus == CEC_DEVICE_STATUS_PRESENT)
 613     RequestVendorId(false);
 614 }
 615
 616 void CCECBusDevice::SetPhysicalAddress(uint16_t iNewAddress)
 617 {
 618   CLockObject lock(m_mutex);
 619   if (iNewAddress > 0 && m_iPhysicalAddress != iNewAddress)
 620   {
 621     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): physical address changed from %04x to %04x", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress, iNewAddress);
 622     m_iPhysicalAddress = iNewAddress;
 623   }
 624 }
 625
 626 void CCECBusDevice::SetStreamPath(uint16_t iNewAddress, uint16_t iOldAddress /* = 0 */)
 627 {
 628   CLockObject lock(m_mutex);
 629   if (iNewAddress > 0)
 630   {
 631     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): stream path changed from %04x to %04x", GetLogicalAddressName(), m_iLogicalAddress, iOldAddress == 0 ? m_iStreamPath : iOldAddress, iNewAddress);
 632     m_iStreamPath = iNewAddress;
 633
 634     // suppress polls when searching for a device
 635     CCECBusDevice *device = m_processor->GetDeviceByPhysicalAddress(iNewAddress, false, true);
 636     if (device)
 637     {
 638       // if a device is found with the new physical address, mark it as active, which will automatically mark all other devices as inactive
 639       device->SetActiveSource();
 640     }
 641     else
 642     {
 643       // try to find the device with the old address, and mark it as inactive when found
 644       device = m_processor->GetDeviceByPhysicalAddress(iOldAddress, false, true);
 645       if (device)
 646         device->SetInactiveSource();
 647     }
 648
 649     if (iNewAddress > 0)
 650     {
 651       lock.Unlock();
 652       SetPowerStatus(CEC_POWER_STATUS_ON);
 653     }
 654   }
 655 }
 656
 657 void CCECBusDevice::SetPowerStatus(const cec_power_status powerStatus)
 658 {
 659   CLockObject lock(m_mutex);
 660   if (m_powerStatus != powerStatus)
 661   {
 662     m_iLastPowerStateUpdate = GetTimeMs();
 663     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %s (%X): power status changed from '%s' to '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(m_powerStatus), ToString(powerStatus));
 664     m_powerStatus = powerStatus;
 665   }
 666 }
 667
 668 void CCECBusDevice::MarkBusy(void)
 669 {
 670   CLockObject handlerLock(m_handlerMutex);
 671   ++m_iHandlerUseCount;
 672 }
 673
 674 void CCECBusDevice::MarkReady(void)
 675 {
 676   CLockObject handlerLock(m_handlerMutex);
 677   if (m_iHandlerUseCount > 0)
 678     --m_iHandlerUseCount;
 679 }
 680
 681 bool CCECBusDevice::ReplaceHandler(bool bActivateSource /* = true */)
 682 {
 683   bool bInitHandler(false);
 684   {
 685     CTryLockObject lock(m_mutex);
 686     if (!lock.IsLocked())
 687       return false;
 688
 689     CLockObject handlerLock(m_handlerMutex);
 690     if (m_iHandlerUseCount > 0)
 691       return false;
 692
 693     MarkBusy();
 694
 695     if (m_vendor != m_handler->GetVendorId())
 696     {
 697       if (CCECCommandHandler::HasSpecificHandler(m_vendor))
 698       {
 699         CLibCEC::AddLog(CEC_LOG_DEBUG, "replacing the command handler for device '%s' (%x)", GetLogicalAddressName(), GetLogicalAddress());
 700         delete m_handler;
 701
 702         switch (m_vendor)
 703         {
 704         case CEC_VENDOR_SAMSUNG:
 705           m_handler = new CANCommandHandler(this);
 706           break;
 707         case CEC_VENDOR_LG:
 708           m_handler = new CSLCommandHandler(this);
 709           break;
 710         case CEC_VENDOR_PANASONIC:
 711           m_handler = new CVLCommandHandler(this);
 712           break;
 713         default:
 714           m_handler = new CCECCommandHandler(this);
 715           break;
 716         }
 717
 718         m_handler->SetVendorId(m_vendor);
 719         bInitHandler = true;
 720       }
 721     }
 722   }
 723
 724   if (bInitHandler)
 725   {
 726     m_handler->InitHandler();
 727
 728     if (bActivateSource && m_processor->GetLogicalAddresses().IsSet(m_iLogicalAddress) && m_processor->IsInitialised() && IsActiveSource())
 729       m_handler->ActivateSource();
 730   }
 731
 732   MarkReady();
 733
 734   return true;
 735 }
 736
 737 bool CCECBusDevice::SetVendorId(uint64_t iVendorId)
 738 {
 739   bool bVendorChanged(false);
 740
 741   {
 742     CLockObject lock(m_mutex);
 743     bVendorChanged = (m_vendor != (cec_vendor_id)iVendorId);
 744     m_vendor = (cec_vendor_id)iVendorId;
 745   }
 746
 747   CLibCEC::AddLog(CEC_LOG_DEBUG, "%s (%X): vendor = %s (%06x)", GetLogicalAddressName(), m_iLogicalAddress, ToString(m_vendor), m_vendor);
 748
 749   return bVendorChanged;
 750 }
 751 //@}
 752
 753 /** @name Transmit methods */
 754 //@{
 755 bool CCECBusDevice::TransmitActiveSource(void)
 756 {
 757   bool bSendActiveSource(false);
 758
 759   {
 760     CLockObject lock(m_mutex);
 761     if (m_powerStatus != CEC_POWER_STATUS_ON && m_powerStatus != CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON)
 762       CLibCEC::AddLog(CEC_LOG_DEBUG, "<< %s (%X) is not powered on", GetLogicalAddressName(), m_iLogicalAddress);
 763     else if (m_bActiveSource)
 764     {
 765       CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> broadcast (F): active source (%4x)", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress);
 766       bSendActiveSource = true;
 767     }
 768     else
 769       CLibCEC::AddLog(CEC_LOG_DEBUG, "<< %s (%X) is not the active source", GetLogicalAddressName(), m_iLogicalAddress);
 770   }
 771
 772   if (bSendActiveSource)
 773   {
 774     MarkBusy();
 775     m_handler->TransmitActiveSource(m_iLogicalAddress, m_iPhysicalAddress);
 776     MarkReady();
 777     return true;
 778   }
 779
 780   return false;
 781 }
 782
 783 bool CCECBusDevice::TransmitCECVersion(cec_logical_address dest)
 784 {
 785   cec_version version;
 786   {
 787     CLockObject lock(m_mutex);
 788     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): cec version %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_cecVersion));
 789     version = m_cecVersion;
 790   }
 791
 792   MarkBusy();
 793   bool bReturn = m_handler->TransmitCECVersion(m_iLogicalAddress, dest, version);
 794   MarkReady();
 795   return bReturn;
 796 }
 797
 798 bool CCECBusDevice::TransmitImageViewOn(void)
 799 {
 800   {
 801     CLockObject lock(m_mutex);
 802     if (m_powerStatus != CEC_POWER_STATUS_ON && m_powerStatus != CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON)
 803     {
 804       CLibCEC::AddLog(CEC_LOG_DEBUG, "<< %s (%X) is not powered on", GetLogicalAddressName(), m_iLogicalAddress);
 805       return false;
 806     }
 807   }
 808
 809   MarkBusy();
 810   m_handler->TransmitImageViewOn(m_iLogicalAddress, CECDEVICE_TV);
 811   MarkReady();
 812   return true;
 813 }
 814
 815 bool CCECBusDevice::TransmitInactiveSource(void)
 816 {
 817   uint16_t iPhysicalAddress;
 818   {
 819     CLockObject lock(m_mutex);
 820     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> broadcast (F): inactive source", GetLogicalAddressName(), m_iLogicalAddress);
 821     iPhysicalAddress = m_iPhysicalAddress;
 822   }
 823
 824   MarkBusy();
 825   bool bReturn = m_handler->TransmitInactiveSource(m_iLogicalAddress, iPhysicalAddress);
 826   MarkReady();
 827   return bReturn;
 828 }
 829
 830 bool CCECBusDevice::TransmitMenuState(cec_logical_address dest)
 831 {
 832   cec_menu_state menuState;
 833   {
 834     CLockObject lock(m_mutex);
 835     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): menu state '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_menuState));
 836     menuState = m_menuState;
 837   }
 838
 839   MarkBusy();
 840   bool bReturn = m_handler->TransmitMenuState(m_iLogicalAddress, dest, menuState);
 841   MarkReady();
 842   return bReturn;
 843 }
 844
 845 bool CCECBusDevice::TransmitOSDName(cec_logical_address dest)
 846 {
 847   CStdString strDeviceName;
 848   {
 849     CLockObject lock(m_mutex);
 850     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): OSD name '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, m_strDeviceName.c_str());
 851     strDeviceName = m_strDeviceName;
 852   }
 853
 854   MarkBusy();
 855   bool bReturn = m_handler->TransmitOSDName(m_iLogicalAddress, dest, strDeviceName);
 856   MarkReady();
 857   return bReturn;
 858 }
 859
 860 bool CCECBusDevice::TransmitOSDString(cec_logical_address dest, cec_display_control duration, const char *strMessage)
 861 {
 862   bool bReturn(false);
 863   if (!m_processor->m_busDevices[dest]->IsUnsupportedFeature(CEC_OPCODE_SET_OSD_STRING))
 864   {
 865     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): display OSD message '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, strMessage);
 866     MarkBusy();
 867     bReturn = m_handler->TransmitOSDString(m_iLogicalAddress, dest, duration, strMessage);
 868     MarkReady();
 869   }
 870   return bReturn;
 871 }
 872
 873 bool CCECBusDevice::TransmitPhysicalAddress(void)
 874 {
 875   uint16_t iPhysicalAddress;
 876   cec_device_type type;
 877   {
 878     CLockObject lock(m_mutex);
 879     if (m_iPhysicalAddress == 0xffff)
 880       return false;
 881
 882     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> broadcast (F): physical adddress %4x", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress);
 883     iPhysicalAddress = m_iPhysicalAddress;
 884     type = m_type;
 885   }
 886
 887   MarkBusy();
 888   bool bReturn = m_handler->TransmitPhysicalAddress(m_iLogicalAddress, iPhysicalAddress, type);
 889   MarkReady();
 890   return bReturn;
 891 }
 892
 893 bool CCECBusDevice::TransmitSetMenuLanguage(cec_logical_address dest)
 894 {
 895   bool bReturn(false);
 896   cec_menu_language language = GetMenuLanguage();
 897
 898   char lang[3];
 899   {
 900     CLockObject lock(m_mutex);
 901     lang[0] = language.language[0];
 902     lang[1] = language.language[1];
 903     lang[2] = language.language[2];
 904   }
 905
 906   MarkBusy();
 907   if (lang[0] == '?' && lang[1] == '?' && lang[2] == '?')
 908   {
 909       CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): Menu language feature abort", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
 910       m_processor->TransmitAbort(dest, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 911       bReturn = true;
 912   }
 913   else
 914   {
 915       CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> broadcast (F): Menu language '%s'", GetLogicalAddressName(), m_iLogicalAddress, lang);
 916       bReturn = m_handler->TransmitSetMenuLanguage(m_iLogicalAddress, lang);
 917   }
 918   MarkReady();
 919   return bReturn;
 920 }
 921
 922 bool CCECBusDevice::TransmitPoll(cec_logical_address dest)
 923 {
 924   bool bReturn(false);
 925   if (dest == CECDEVICE_UNKNOWN)
 926     dest = m_iLogicalAddress;
 927
 928   CCECBusDevice *destDevice = m_processor->m_busDevices[dest];
 929   if (destDevice->m_deviceStatus == CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC)
 930     return bReturn;
 931
 932   MarkBusy();
 933   CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): POLL", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
 934   bReturn = m_handler->TransmitPoll(m_iLogicalAddress, dest);
 935   CLibCEC::AddLog(CEC_LOG_DEBUG, bReturn ? ">> POLL sent" : ">> POLL not sent");
 936
 937   CLockObject lock(m_mutex);
 938   if (bReturn)
 939   {
 940     m_iLastActive = GetTimeMs();
 941     destDevice->m_deviceStatus = CEC_DEVICE_STATUS_PRESENT;
 942   }
 943   else
 944     destDevice->m_deviceStatus = CEC_DEVICE_STATUS_NOT_PRESENT;
 945
 946   MarkReady();
 947   return bReturn;
 948 }
 949
 950 bool CCECBusDevice::TransmitPowerState(cec_logical_address dest)
 951 {
 952   cec_power_status state;
 953   {
 954     CLockObject lock(m_mutex);
 955     if (!IsActiveSource())
 956     {
 957       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);
 958       SetPowerStatus(CEC_POWER_STATUS_STANDBY);
 959     }
 960
 961     CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_powerStatus));
 962     state = m_powerStatus;
 963   }
 964
 965   MarkBusy();
 966   bool bReturn = m_handler->TransmitPowerState(m_iLogicalAddress, dest, state);
 967   MarkReady();
 968   return bReturn;
 969 }
 970
 971 bool CCECBusDevice::TransmitVendorID(cec_logical_address dest, bool bSendAbort /* = true */)
 972 {
 973   bool bReturn(false);
 974   uint64_t iVendorId;
 975   {
 976     CLockObject lock(m_mutex);
 977     iVendorId = (uint64_t)m_vendor;
 978   }
 979
 980   MarkBusy();
 981   if (iVendorId == CEC_VENDOR_UNKNOWN)
 982   {
 983     if (bSendAbort)
 984     {
 985       CLibCEC::AddLog(CEC_LOG_NOTICE, "<< %s (%X) -> %s (%X): vendor id feature abort", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
 986       m_processor->TransmitAbort(dest, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 987       bReturn = true;
 988     }
 989   }
 990   else
 991   {
 992     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);
 993     bReturn = m_handler->TransmitVendorID(m_iLogicalAddress, iVendorId);
 994   }
 995   MarkReady();
 996   return bReturn;
 997 }
 998
 999 bool CCECBusDevice::TransmitKeypress(cec_user_control_code key, bool bWait /* = true */)
1000 {
1001   MarkBusy();
1002   bool bReturn = m_handler->TransmitKeypress(m_processor->GetLogicalAddress(), m_iLogicalAddress, key, bWait);
1003   MarkReady();
1004   return bReturn;
1005 }
1006
1007 bool CCECBusDevice::TransmitKeyRelease(bool bWait /* = true */)
1008 {
1009   MarkBusy();
1010   bool bReturn = m_handler->TransmitKeyRelease(m_processor->GetLogicalAddress(), m_iLogicalAddress, bWait);
1011   MarkReady();
1012   return bReturn;
1013 }
1014
1015 bool CCECBusDevice::IsUnsupportedFeature(cec_opcode opcode)
1016 {
1017   CLockObject lock(m_mutex);
1018   bool bUnsupported = (m_unsupportedFeatures.find(opcode) != m_unsupportedFeatures.end());
1019   if (bUnsupported)
1020     CLibCEC::AddLog(CEC_LOG_NOTICE, "'%s' is marked as unsupported feature for device '%s'", ToString(opcode), GetLogicalAddressName());
1021   return bUnsupported;
1022 }
1023
1024 void CCECBusDevice::SetUnsupportedFeature(cec_opcode opcode)
1025 {
1026   CLockObject lock(m_mutex);
1027   CLibCEC::AddLog(CEC_LOG_DEBUG, "marking opcode '%s' as unsupported feature for device '%s'", ToString(opcode), GetLogicalAddressName());
1028   m_unsupportedFeatures.insert(opcode);
1029 }
1030
1031 bool CCECBusDevice::ActivateSource(void)
1032 {
1033   CLibCEC::AddLog(CEC_LOG_DEBUG, "activating source '%s'", ToString(m_iLogicalAddress));
1034   MarkBusy();
1035   bool bReturn = m_handler->ActivateSource();
1036   MarkReady();
1037   return bReturn;
1038 }
1039
1040 void CCECBusDevice::HandlePoll(cec_logical_address destination)
1041 {
1042   if (destination >= 0 && destination < CECDEVICE_BROADCAST)
1043   {
1044     CCECBusDevice *device = m_processor->m_busDevices[destination];
1045     if (device)
1046       device->HandlePollFrom(m_iLogicalAddress);
1047   }
1048 }
1049
1050 void CCECBusDevice::HandlePollFrom(cec_logical_address initiator)
1051 {
1052   CLibCEC::AddLog(CEC_LOG_DEBUG, "<< POLL: %s (%x) -> %s (%x)", ToString(initiator), initiator, ToString(m_iLogicalAddress), m_iLogicalAddress);
1053   m_bAwaitingReceiveFailed = true;
1054 }
1055
1056 bool CCECBusDevice::HandleReceiveFailed(void)
1057 {
1058   bool bReturn = m_bAwaitingReceiveFailed;
1059   m_bAwaitingReceiveFailed = false;
1060   return bReturn;
1061 }
1062
1063 void CCECBusDevice::CheckVendorIdRequested(void)
1064 {
1065   bool bRequestVendorId(false);
1066   {
1067     CLockObject lock(m_mutex);
1068     bRequestVendorId = !m_bVendorIdRequested;
1069     m_bVendorIdRequested = true;
1070   }
1071
1072   if (bRequestVendorId)
1073   {
1074     ReplaceHandler(false);
1075     GetVendorId();
1076   }
1077 }
1078
1079 bool CCECBusDevice::TransmitPendingActiveSourceCommands(void)
1080 {
1081   MarkBusy();
1082   bool bReturn = m_handler->TransmitPendingActiveSourceCommands();
1083   MarkReady();
1084   return bReturn;
1085 }
1086
1087 //@}