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