src/lib/devices/CECBusDevice.cpp

   1 /*
   2  * This file is part of the libCEC(R) library.
   3  *
   4  * libCEC(R) is Copyright (C) 2011 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 "../platform/timeutils.h"
  40
  41 using namespace CEC;
  42
  43 #define ToString(p) CCECCommandHandler::ToString(p)
  44
  45 CCECBusDevice::CCECBusDevice(CCECProcessor *processor, cec_logical_address iLogicalAddress, uint16_t iPhysicalAddress) :
  46   m_type(CEC_DEVICE_TYPE_RESERVED),
  47   m_iPhysicalAddress(iPhysicalAddress),
  48   m_iStreamPath(0),
  49   m_iLogicalAddress(iLogicalAddress),
  50   m_powerStatus(CEC_POWER_STATUS_UNKNOWN),
  51   m_processor(processor),
  52   m_vendor(CEC_VENDOR_UNKNOWN),
  53   m_bMenuActive(true),
  54   m_bActiveSource(false),
  55   m_iLastCommandSent(0),
  56   m_iLastActive(0),
  57   m_cecVersion(CEC_VERSION_UNKNOWN)
  58 {
  59   m_handler = new CCECCommandHandler(this);
  60
  61   for (unsigned int iPtr = 0; iPtr < 4; iPtr++)
  62     m_menuLanguage.language[iPtr] = '?';
  63   m_menuLanguage.language[3] = 0;
  64   m_menuLanguage.device = iLogicalAddress;
  65
  66   m_strDeviceName = ToString(m_iLogicalAddress);
  67 }
  68
  69 CCECBusDevice::~CCECBusDevice(void)
  70 {
  71   m_condition.Broadcast();
  72   delete m_handler;
  73 }
  74
  75 void CCECBusDevice::AddLog(cec_log_level level, const CStdString &strMessage)
  76 {
  77   m_processor->AddLog(level, strMessage);
  78 }
  79
  80 bool CCECBusDevice::HandleCommand(const cec_command &command)
  81 {
  82   CLockObject lock(&m_mutex);
  83   m_iLastActive = GetTimeMs();
  84   m_handler->HandleCommand(command);
  85   m_condition.Signal();
  86   return true;
  87 }
  88
  89 void CCECBusDevice::PollVendorId(void)
  90 {
  91   CLockObject lock(&m_mutex);
  92   if (m_iLastActive > 0 && m_iLogicalAddress != CECDEVICE_BROADCAST &&
  93       m_vendor == CEC_VENDOR_UNKNOWN &&
  94       GetTimeMs() - m_iLastCommandSent > 5000 &&
  95       !m_processor->IsMonitoring())
  96   {
  97     CStdString strLog;
  98     strLog.Format("<< requesting vendor ID of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
  99     AddLog(CEC_LOG_NOTICE, strLog);
 100     m_iLastCommandSent = GetTimeMs();
 101
 102     cec_command command;
 103     cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 104     if (m_processor->Transmit(command))
 105       m_condition.Wait(&m_mutex, 1000);
 106   }
 107 }
 108
 109 bool CCECBusDevice::PowerOn(void)
 110 {
 111   cec_power_status current = GetPowerStatus();
 112   if (current != CEC_POWER_STATUS_ON &&
 113       current != CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON)
 114   {
 115     CStdString strLog;
 116     strLog.Format("<< powering on '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 117     AddLog(CEC_LOG_DEBUG, strLog.c_str());
 118
 119     SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
 120
 121     cec_command command;
 122     cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_IMAGE_VIEW_ON);
 123
 124     return m_processor->Transmit(command);
 125   }
 126
 127   return true;
 128 }
 129
 130 bool CCECBusDevice::Standby(void)
 131 {
 132   CStdString strLog;
 133   strLog.Format("<< putting '%s' (%X) in standby mode", GetLogicalAddressName(), m_iLogicalAddress);
 134   AddLog(CEC_LOG_DEBUG, strLog.c_str());
 135
 136   cec_command command;
 137   cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_STANDBY);
 138
 139   return m_processor->Transmit(command);
 140 }
 141
 142 /** @name Getters */
 143 //@{
 144 cec_version CCECBusDevice::GetCecVersion(void)
 145 {
 146   if (m_cecVersion == CEC_VERSION_UNKNOWN)
 147   {
 148     if (!MyLogicalAddressContains(m_iLogicalAddress))
 149     {
 150       CStdString strLog;
 151       strLog.Format("<< requesting CEC version of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 152       AddLog(CEC_LOG_NOTICE, strLog);
 153       cec_command command;
 154       cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GET_CEC_VERSION);
 155       CLockObject lock(&m_mutex);
 156       if (m_processor->Transmit(command))
 157         m_condition.Wait(&m_mutex, 1000);
 158     }
 159   }
 160
 161   return m_cecVersion;
 162 }
 163
 164 const char* CCECBusDevice::GetLogicalAddressName(void) const
 165 {
 166   return ToString(m_iLogicalAddress);
 167 }
 168
 169 cec_menu_language &CCECBusDevice::GetMenuLanguage(void)
 170 {
 171   if (!strcmp(m_menuLanguage.language, "???"))
 172   {
 173     if (!MyLogicalAddressContains(m_iLogicalAddress))
 174     {
 175       CStdString strLog;
 176       strLog.Format("<< requesting menu language of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 177       AddLog(CEC_LOG_NOTICE, strLog);
 178       cec_command command;
 179       cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GET_MENU_LANGUAGE);
 180       CLockObject lock(&m_mutex);
 181       if (m_processor->Transmit(command))
 182         m_condition.Wait(&m_mutex, 1000);
 183     }
 184   }
 185
 186   return m_menuLanguage;
 187 }
 188
 189 cec_logical_address CCECBusDevice::GetMyLogicalAddress(void) const
 190 {
 191   return m_processor->GetLogicalAddress();
 192 }
 193
 194 uint16_t CCECBusDevice::GetMyPhysicalAddress(void) const
 195 {
 196   return m_processor->GetPhysicalAddress();
 197 }
 198
 199 cec_power_status CCECBusDevice::GetPowerStatus(void)
 200 {
 201   if (m_powerStatus == CEC_POWER_STATUS_UNKNOWN)
 202   {
 203     if (!MyLogicalAddressContains(m_iLogicalAddress))
 204     {
 205       CStdString strLog;
 206       strLog.Format("<< requesting power status of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 207       AddLog(CEC_LOG_NOTICE, strLog);
 208       cec_command command;
 209       cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_POWER_STATUS);
 210       CLockObject lock(&m_mutex);
 211       if (m_processor->Transmit(command))
 212         m_condition.Wait(&m_mutex, 1000);
 213     }
 214   }
 215
 216   return m_powerStatus;
 217 }
 218
 219 const cec_vendor_id CCECBusDevice::GetVendorId(void)
 220 {
 221   if (m_vendor == CEC_VENDOR_UNKNOWN)
 222   {
 223     if (!MyLogicalAddressContains(m_iLogicalAddress))
 224     {
 225       CStdString strLog;
 226       strLog.Format("<< requesting vendor ID of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
 227       AddLog(CEC_LOG_NOTICE, strLog);
 228       cec_command command;
 229       cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 230       CLockObject lock(&m_mutex);
 231
 232       if (m_processor->Transmit(command))
 233         m_condition.Wait(&m_mutex, 1000);
 234     }
 235   }
 236
 237   return m_vendor;
 238 }
 239
 240 const char *CCECBusDevice::GetVendorName(void)
 241 {
 242   GetVendorId();
 243   return ToString(m_vendor);
 244 }
 245
 246 bool CCECBusDevice::MyLogicalAddressContains(cec_logical_address address) const
 247 {
 248   return m_processor->HasLogicalAddress(address);
 249 }
 250
 251 //@}
 252
 253 /** @name Setters */
 254 //@{
 255 void CCECBusDevice::SetCecVersion(const cec_version newVersion)
 256 {
 257   m_cecVersion = newVersion;
 258
 259   CStdString strLog;
 260   strLog.Format("%s (%X): CEC version %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(newVersion));
 261   AddLog(CEC_LOG_DEBUG, strLog);
 262 }
 263
 264 void CCECBusDevice::SetMenuLanguage(const cec_menu_language &language)
 265 {
 266   if (language.device == m_iLogicalAddress)
 267   {
 268     CStdString strLog;
 269     strLog.Format(">> %s (%X): menu language set to '%s'", GetLogicalAddressName(), m_iLogicalAddress, language.language);
 270     m_processor->AddLog(CEC_LOG_DEBUG, strLog);
 271     m_menuLanguage = language;
 272   }
 273 }
 274
 275 void CCECBusDevice::SetPhysicalAddress(uint16_t iNewAddress)
 276 {
 277   if (iNewAddress > 0)
 278   {
 279     CStdString strLog;
 280     strLog.Format(">> %s (%X): physical address changed from %04x to %04x", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress, iNewAddress);
 281     AddLog(CEC_LOG_DEBUG, strLog.c_str());
 282
 283     m_iPhysicalAddress = iNewAddress;
 284   }
 285 }
 286
 287 void CCECBusDevice::SetStreamPath(uint16_t iNewAddress, uint16_t iOldAddress /* = 0 */)
 288 {
 289   if (iNewAddress > 0)
 290   {
 291     CStdString strLog;
 292     strLog.Format(">> %s (%X): stream path changed from %04x to %04x", GetLogicalAddressName(), m_iLogicalAddress, iOldAddress, iNewAddress);
 293     AddLog(CEC_LOG_DEBUG, strLog.c_str());
 294
 295     m_iStreamPath = iNewAddress;
 296
 297     if (iNewAddress > 0)
 298       SetPowerStatus(CEC_POWER_STATUS_ON);
 299   }
 300 }
 301
 302 void CCECBusDevice::SetPowerStatus(const cec_power_status powerStatus)
 303 {
 304   if (m_powerStatus != powerStatus)
 305   {
 306     CStdString strLog;
 307     strLog.Format(">> %s (%X): power status changed from '%s' to '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(m_powerStatus), ToString(powerStatus));
 308     m_processor->AddLog(CEC_LOG_DEBUG, strLog);
 309     m_powerStatus = powerStatus;
 310   }
 311 }
 312
 313 void CCECBusDevice::SetVendorId(uint64_t iVendorId)
 314 {
 315   m_vendor = (cec_vendor_id)iVendorId;
 316
 317   switch (iVendorId)
 318   {
 319   case CEC_VENDOR_SAMSUNG:
 320     if (m_handler->GetVendorId() != CEC_VENDOR_SAMSUNG)
 321     {
 322       delete m_handler;
 323       m_handler = new CANCommandHandler(this);
 324     }
 325     break;
 326   case CEC_VENDOR_LG:
 327     if (m_handler->GetVendorId() != CEC_VENDOR_LG)
 328     {
 329       delete m_handler;
 330       m_handler = new CSLCommandHandler(this);
 331     }
 332     break;
 333   case CEC_VENDOR_PANASONIC:
 334     if (m_handler->GetVendorId() != CEC_VENDOR_PANASONIC)
 335     {
 336       delete m_handler;
 337       m_handler = new CVLCommandHandler(this);
 338     }
 339     break;
 340   default:
 341     if (m_handler->GetVendorId() != CEC_VENDOR_UNKNOWN)
 342     {
 343       delete m_handler;
 344       m_handler = new CCECCommandHandler(this);
 345     }
 346     break;
 347   }
 348
 349   CStdString strLog;
 350   strLog.Format("%s (%X): vendor = %s (%06x)", GetLogicalAddressName(), m_iLogicalAddress, GetVendorName(), GetVendorId());
 351   m_processor->AddLog(CEC_LOG_DEBUG, strLog.c_str());
 352 }
 353 //@}
 354
 355 /** @name Transmit methods */
 356 //@{
 357 bool CCECBusDevice::TransmitActiveSource(void)
 358 {
 359   if (m_powerStatus != CEC_POWER_STATUS_ON)
 360   {
 361     CStdString strLog;
 362     strLog.Format("<< %s (%X) is not powered on", GetLogicalAddressName(), m_iLogicalAddress);
 363     AddLog(CEC_LOG_DEBUG, strLog);
 364   }
 365   else if (m_bActiveSource)
 366   {
 367     CStdString strLog;
 368     strLog.Format("<< %s (%X) -> broadcast (F): active source (%4x)", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress);
 369     AddLog(CEC_LOG_NOTICE, strLog);
 370
 371     cec_command command;
 372     cec_command::format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
 373     command.parameters.push_back((uint8_t) ((m_iPhysicalAddress >> 8) & 0xFF));
 374     command.parameters.push_back((uint8_t) (m_iPhysicalAddress & 0xFF));
 375
 376     return m_processor->Transmit(command);
 377   }
 378   else
 379   {
 380     CStdString strLog;
 381     strLog.Format("<< %s (%X) is not the active source", GetLogicalAddressName(), m_iLogicalAddress);
 382     AddLog(CEC_LOG_DEBUG, strLog);
 383   }
 384
 385   return false;
 386 }
 387
 388 bool CCECBusDevice::TransmitCECVersion(cec_logical_address dest)
 389 {
 390   CStdString strLog;
 391   strLog.Format("<< %s (%X) -> %s (%X): cec version %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_cecVersion));
 392   AddLog(CEC_LOG_NOTICE, strLog);
 393
 394   cec_command command;
 395   cec_command::format(command, m_iLogicalAddress, dest, CEC_OPCODE_CEC_VERSION);
 396   command.parameters.push_back((uint8_t)m_cecVersion);
 397
 398   return m_processor->Transmit(command);
 399 }
 400
 401 bool CCECBusDevice::TransmitInactiveView(void)
 402 {
 403   CStdString strLog;
 404   strLog.Format("<< %s (%X) -> broadcast (F): inactive view", GetLogicalAddressName(), m_iLogicalAddress);
 405   AddLog(CEC_LOG_NOTICE, strLog);
 406
 407   cec_command command;
 408   cec_command::format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_INACTIVE_SOURCE);
 409   command.parameters.push_back((m_iPhysicalAddress >> 8) & 0xFF);
 410   command.parameters.push_back(m_iPhysicalAddress & 0xFF);
 411
 412   return m_processor->Transmit(command);
 413 }
 414
 415 bool CCECBusDevice::TransmitMenuState(cec_logical_address dest)
 416 {
 417   CStdString strLog;
 418   strLog.Format("<< %s (%X) -> %s (%X): ", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
 419   if (m_bMenuActive)
 420     strLog.append("menu active");
 421   else
 422     strLog.append("menu inactive");
 423   AddLog(CEC_LOG_NOTICE, strLog);
 424
 425   cec_command command;
 426   cec_command::format(command, m_iLogicalAddress, dest, CEC_OPCODE_MENU_STATUS);
 427   command.parameters.push_back(m_bMenuActive ? (uint8_t) CEC_MENU_STATE_ACTIVATED : (uint8_t) CEC_MENU_STATE_DEACTIVATED);
 428
 429   return m_processor->Transmit(command);
 430 }
 431
 432 bool CCECBusDevice::TransmitOSDName(cec_logical_address dest)
 433 {
 434   CStdString strLog;
 435   strLog.Format("<< %s (%X) -> %s (%X): OSD name '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, m_strDeviceName.c_str());
 436   AddLog(CEC_LOG_NOTICE, strLog.c_str());
 437
 438   cec_command command;
 439   cec_command::format(command, m_iLogicalAddress, dest, CEC_OPCODE_SET_OSD_NAME);
 440   for (unsigned int iPtr = 0; iPtr < m_strDeviceName.length(); iPtr++)
 441     command.parameters.push_back(m_strDeviceName.at(iPtr));
 442
 443   return m_processor->Transmit(command);
 444 }
 445
 446 bool CCECBusDevice::TransmitOSDString(cec_logical_address dest, cec_display_control duration, const char *strMessage)
 447 {
 448   CStdString strLog;
 449   strLog.Format("<< %s (%X) -> %s (%X): display OSD message '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, strMessage);
 450   AddLog(CEC_LOG_NOTICE, strLog.c_str());
 451
 452   cec_command command;
 453   cec_command::format(command, m_iLogicalAddress, dest, CEC_OPCODE_SET_OSD_STRING);
 454   command.parameters.push_back((uint8_t)duration);
 455
 456   unsigned int iLen = strlen(strMessage);
 457   if (iLen > 13) iLen = 13;
 458
 459   for (unsigned int iPtr = 0; iPtr < iLen; iPtr++)
 460     command.parameters.push_back(strMessage[iPtr]);
 461
 462   return m_processor->Transmit(command);
 463 }
 464
 465 bool CCECBusDevice::TransmitPhysicalAddress(void)
 466 {
 467   CStdString strLog;
 468   strLog.Format("<< %s (%X) -> broadcast (F): physical adddress %4x", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress);
 469   AddLog(CEC_LOG_NOTICE, strLog.c_str());
 470
 471   cec_command command;
 472   cec_command::format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_REPORT_PHYSICAL_ADDRESS);
 473   command.parameters.push_back((uint8_t) ((m_iPhysicalAddress >> 8) & 0xFF));
 474   command.parameters.push_back((uint8_t) (m_iPhysicalAddress & 0xFF));
 475   command.parameters.push_back((uint8_t) (m_type));
 476
 477   return m_processor->Transmit(command);
 478 }
 479
 480 bool CCECBusDevice::TransmitPoll(cec_logical_address dest)
 481 {
 482   bool bReturn(false);
 483
 484   if (dest == CECDEVICE_UNKNOWN)
 485     dest = m_iLogicalAddress;
 486
 487   CStdString strLog;
 488   strLog.Format("<< %s (%X) -> %s (%X): POLL", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
 489   AddLog(CEC_LOG_NOTICE, strLog.c_str());
 490
 491   cec_command command;
 492   cec_command::format(command, m_iLogicalAddress, dest, CEC_OPCODE_NONE);
 493   CLockObject lock(&m_mutex);
 494
 495   bReturn = m_processor->Transmit(command);
 496   AddLog(CEC_LOG_DEBUG, bReturn ? ">> POLL sent" : ">> POLL not sent");
 497   return bReturn;
 498 }
 499
 500 bool CCECBusDevice::TransmitPowerState(cec_logical_address dest)
 501 {
 502   CStdString strLog;
 503   strLog.Format("<< %s (%X) -> %s (%X): %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_powerStatus));
 504   AddLog(CEC_LOG_NOTICE, strLog.c_str());
 505
 506   cec_command command;
 507   cec_command::format(command, m_iLogicalAddress, dest, CEC_OPCODE_REPORT_POWER_STATUS);
 508   command.parameters.push_back((uint8_t) m_powerStatus);
 509
 510   return m_processor->Transmit(command);
 511 }
 512
 513 bool CCECBusDevice::TransmitVendorID(cec_logical_address dest)
 514 {
 515   if (m_vendor == CEC_VENDOR_UNKNOWN)
 516   {
 517     CStdString strLog;
 518     strLog.Format("<< %s (%X) -> %s (%X): vendor id feature abort", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
 519     AddLog(CEC_LOG_NOTICE, strLog);
 520
 521     m_processor->TransmitAbort(dest, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 522     return false;
 523   }
 524   else
 525   {
 526     CStdString strLog;
 527     strLog.Format("<< %s (%X) -> %s (%X): vendor id %s (%x)", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_vendor), (uint64_t)m_vendor);
 528     AddLog(CEC_LOG_NOTICE, strLog);
 529
 530     cec_command command;
 531     cec_command::format(command, m_iLogicalAddress, dest, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 532
 533     command.parameters.push_back((uint8_t) (((uint64_t)m_vendor >> 16) & 0xFF));
 534     command.parameters.push_back((uint8_t) (((uint64_t)m_vendor >> 8) & 0xFF));
 535     command.parameters.push_back((uint8_t) ((uint64_t)m_vendor & 0xFF));
 536
 537     return m_processor->Transmit(command);
 538   }
 539 }
 540 //@}