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