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