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