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