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_processor(processor),
  46   m_iVendorId(0),
  47   m_iVendorClass(CEC_VENDOR_UNKNOWN),
  48   m_iLastActive(0)
  49 {
  50   m_handler = new CCECCommandHandler(this);
  51 }
  52
  53 CCECBusDevice::~CCECBusDevice(void)
  54 {
  55   delete m_handler;
  56 }
  57
  58 cec_logical_address CCECBusDevice::GetMyLogicalAddress(void) const
  59 {
  60   return m_processor->GetLogicalAddress();
  61 }
  62
  63 uint16_t CCECBusDevice::GetMyPhysicalAddress(void) const
  64 {
  65   return m_processor->GetPhysicalAddress();
  66 }
  67
  68 void CCECBusDevice::AddLog(cec_log_level level, const CStdString &strMessage)
  69 {
  70   m_processor->AddLog(level, strMessage);
  71 }
  72
  73 void CCECBusDevice::SetVendorId(const cec_datapacket &data)
  74 {
  75   if (data.size < 3)
  76   {
  77     AddLog(CEC_LOG_WARNING, "invalid vendor ID received");
  78     return;
  79   }
  80
  81   uint64_t iVendorId = ((uint64_t)data[0] << 3) +
  82                        ((uint64_t)data[1] << 2) +
  83                         (uint64_t)data[2];
  84
  85   SetVendorId(iVendorId, data.size >= 4 ? data[3] : 0);
  86 }
  87
  88 void CCECBusDevice::SetVendorId(uint64_t iVendorId, uint8_t iVendorClass /* = 0 */)
  89 {
  90   m_iVendorId = iVendorId;
  91   m_iVendorClass = iVendorClass;
  92
  93   switch (iVendorId)
  94   {
  95   case CEC_VENDOR_SAMSUNG:
  96     if (m_handler->GetVendorId() != CEC_VENDOR_SAMSUNG)
  97     {
  98       delete m_handler;
  99       m_handler = new CANCommandHandler(this);
 100     }
 101     break;
 102   case CEC_VENDOR_LG:
 103     if (m_handler->GetVendorId() != CEC_VENDOR_LG)
 104     {
 105       delete m_handler;
 106       m_handler = new CSLCommandHandler(this);
 107     }
 108     break;
 109   default:
 110     if (m_handler->GetVendorId() != CEC_VENDOR_UNKNOWN)
 111     {
 112       delete m_handler;
 113       m_handler = new CCECCommandHandler(this);
 114     }
 115     break;
 116   }
 117
 118   CStdString strLog;
 119   strLog.Format("device %d: vendor = %s (%06x) class = %2x", m_iLogicalAddress, GetVendorName(), GetVendorId(), GetVendorClass());
 120   m_processor->AddLog(CEC_LOG_DEBUG, strLog.c_str());
 121 }
 122
 123 bool CCECBusDevice::HandleCommand(const cec_command &command)
 124 {
 125   CLockObject lock(&m_mutex);
 126   m_iLastActive = GetTimeMs();
 127   m_handler->HandleCommand(command);
 128   return true;
 129 }
 130
 131 void CCECBusDevice::PollVendorId(void)
 132 {
 133   CLockObject lock(&m_mutex);
 134   if (m_iLastActive > 0 && m_iLogicalAddress != CECDEVICE_BROADCAST &&
 135       m_iVendorId == CEC_VENDOR_UNKNOWN &&
 136       GetTimeMs() - m_iLastActive > 5000)
 137   {
 138     m_iLastActive = GetTimeMs();
 139
 140     cec_command command;
 141     cec_command::format(command, GetMyLogicalAddress(), GetLogicalAddress(), CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 142     m_processor->Transmit(command, false);
 143   }
 144 }
 145
 146 void CCECBusDevice::SetPhysicalAddress(uint16_t iNewAddress, uint16_t iOldAddress /* = 0 */)
 147 {
 148   CStdString strLog;
 149   strLog.Format(">> %i changed physical address from %04x to %04x", GetLogicalAddress(), m_iPhysicalAddress, iNewAddress);
 150   AddLog(CEC_LOG_DEBUG, strLog.c_str());
 151
 152   m_iPhysicalAddress = iNewAddress;
 153 }
 154
 155 bool CCECBusDevice::PowerOn(void)
 156 {
 157   CStdString strLog;
 158   strLog.Format("<< powering on device with logical address %d", (int8_t)m_iLogicalAddress);
 159   AddLog(CEC_LOG_DEBUG, strLog.c_str());
 160
 161   cec_command command;
 162   cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_IMAGE_VIEW_ON);
 163
 164   return m_processor->Transmit(command);
 165 }
 166
 167 bool CCECBusDevice::Standby(void)
 168 {
 169   CStdString strLog;
 170   strLog.Format("<< putting device with logical address %d in standby mode", (int8_t)m_iLogicalAddress);
 171   AddLog(CEC_LOG_DEBUG, strLog.c_str());
 172
 173   cec_command command;
 174   cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_STANDBY);
 175
 176   return m_processor->Transmit(command);
 177 }
 178
 179 bool CCECBusDevice::SetOSDString(cec_display_control duration, const char *strMessage)
 180 {
 181   CStdString strLog;
 182   strLog.Format("<< display message '%s'", strMessage);
 183   AddLog(CEC_LOG_NOTICE, strLog.c_str());
 184
 185   cec_command command;
 186   cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_SET_OSD_STRING);
 187   command.parameters.push_back((uint8_t)duration);
 188
 189   for (unsigned int iPtr = 0; iPtr < strlen(strMessage); iPtr++)
 190     command.parameters.push_back(strMessage[iPtr]);
 191
 192   return m_processor->Transmit(command);
 193 }
 194
 195 bool CCECBusDevice::ReportCECVersion(void)
 196 {
 197   AddLog(CEC_LOG_NOTICE, "<< reporting CEC version as 1.3a");
 198
 199   cec_command command;
 200   cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_CEC_VERSION);
 201   command.parameters.push_back(CEC_VERSION_1_3A);
 202
 203   return m_processor->Transmit(command);
 204 }
 205
 206 bool CCECBusDevice::ReportDeckStatus(void)
 207 {
 208   // need to support opcodes play and deck control before doing anything with this
 209   AddLog(CEC_LOG_NOTICE, "<< deck status requested, feature abort");
 210   m_processor->TransmitAbort(m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 211   return false;
 212 }
 213
 214 bool CCECBusDevice::ReportMenuState(bool bActive /* = true */)
 215 {
 216   if (bActive)
 217     AddLog(CEC_LOG_NOTICE, "<< reporting menu state as active");
 218   else
 219     AddLog(CEC_LOG_NOTICE, "<< reporting menu state as inactive");
 220
 221   cec_command command;
 222   cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_MENU_STATUS);
 223   command.parameters.push_back(bActive ? (uint8_t) CEC_MENU_STATE_ACTIVATED : (uint8_t) CEC_MENU_STATE_DEACTIVATED);
 224
 225   return m_processor->Transmit(command);
 226 }
 227
 228 bool CCECBusDevice::ReportOSDName(void)
 229 {
 230   const char *osdname = m_processor->GetDeviceName().c_str();
 231   CStdString strLog;
 232   strLog.Format("<< reporting OSD name as %s", osdname);
 233   AddLog(CEC_LOG_NOTICE, strLog.c_str());
 234
 235   cec_command command;
 236   cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_SET_OSD_NAME);
 237   for (unsigned int iPtr = 0; iPtr < strlen(osdname); iPtr++)
 238     command.parameters.push_back(osdname[iPtr]);
 239
 240   return m_processor->Transmit(command);
 241 }
 242
 243 bool CCECBusDevice::ReportPowerState(bool bOn /* = true */)
 244 {
 245   if (bOn)
 246     AddLog(CEC_LOG_NOTICE, "<< reporting \"On\" power status");
 247   else
 248     AddLog(CEC_LOG_NOTICE, "<< reporting \"Off\" power status");
 249
 250   cec_command command;
 251   cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_REPORT_POWER_STATUS);
 252   command.parameters.push_back(bOn ? (uint8_t) CEC_POWER_STATUS_ON : (uint8_t) CEC_POWER_STATUS_STANDBY);
 253
 254   return m_processor->Transmit(command);
 255 }
 256
 257 bool CCECBusDevice::ReportVendorID(void)
 258 {
 259   AddLog(CEC_LOG_NOTICE, "<< vendor ID requested, feature abort");
 260   m_processor->TransmitAbort(m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 261   return false;
 262 }
 263
 264 bool CCECBusDevice::BroadcastActiveView(void)
 265 {
 266   AddLog(CEC_LOG_DEBUG, "<< setting active view");
 267
 268   cec_command command;
 269   cec_command::format(command, GetMyLogicalAddress(), CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
 270   command.parameters.push_back((m_iPhysicalAddress >> 8) & 0xFF);
 271   command.parameters.push_back(m_iPhysicalAddress & 0xFF);
 272
 273   return m_processor->Transmit(command);
 274 }
 275
 276 bool CCECBusDevice::BroadcastInactiveView(void)
 277 {
 278   AddLog(CEC_LOG_DEBUG, "<< setting inactive view");
 279
 280   cec_command command;
 281   cec_command::format(command, GetMyLogicalAddress(), CECDEVICE_BROADCAST, CEC_OPCODE_INACTIVE_SOURCE);
 282   command.parameters.push_back((m_iPhysicalAddress >> 8) & 0xFF);
 283   command.parameters.push_back(m_iPhysicalAddress & 0xFF);
 284
 285   return m_processor->Transmit(command);
 286 }
 287
 288 bool CCECBusDevice::BroadcastPhysicalAddress(void)
 289 {
 290   CStdString strLog;
 291   strLog.Format("<< reporting physical address as %04x", m_iPhysicalAddress);
 292   AddLog(CEC_LOG_NOTICE, strLog.c_str());
 293
 294   cec_command command;
 295   cec_command::format(command, GetMyLogicalAddress(), CECDEVICE_BROADCAST, CEC_OPCODE_REPORT_PHYSICAL_ADDRESS);
 296   command.parameters.push_back((uint8_t) ((m_iPhysicalAddress >> 8) & 0xFF));
 297   command.parameters.push_back((uint8_t) (m_iPhysicalAddress & 0xFF));
 298   command.parameters.push_back((uint8_t) (CEC_DEVICE_TYPE_PLAYBACK_DEVICE));
 299
 300   return m_processor->Transmit(command);
 301 }
 302
 303 bool CCECBusDevice::BroadcastActiveSource(void)
 304 {
 305   AddLog(CEC_LOG_NOTICE, "<< broadcasting active source");
 306
 307   cec_command command;
 308   cec_command::format(command, GetMyLogicalAddress(), CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
 309   command.parameters.push_back((uint8_t) ((m_iPhysicalAddress >> 8) & 0xFF));
 310   command.parameters.push_back((uint8_t) (m_iPhysicalAddress & 0xFF));
 311
 312   return m_processor->Transmit(command);
 313 }
 314
 315 const char *CCECBusDevice::CECVendorIdToString(const uint64_t iVendorId)
 316 {
 317   switch (iVendorId)
 318   {
 319   case CEC_VENDOR_SAMSUNG:
 320     return "Samsung";
 321   case CEC_VENDOR_LG:
 322       return "LG";
 323   default:
 324     return "Unknown";
 325   }
 326 }