src/lib/CECProcessor.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 "CECProcessor.h"
  34
  35 #include "AdapterCommunication.h"
  36 #include "LibCEC.h"
  37 #include "util/StdString.h"
  38 #include "platform/timeutils.h"
  39
  40 using namespace CEC;
  41 using namespace std;
  42
  43 CCECProcessor::CCECProcessor(CLibCEC *controller, CAdapterCommunication *serComm, const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS*/) :
  44     m_physicaladdress(iPhysicalAddress),
  45     m_iLogicalAddress(iLogicalAddress),
  46     m_strDeviceName(strDeviceName),
  47     m_communication(serComm),
  48     m_controller(controller)
  49 {
  50   for (uint8_t iPtr = 0; iPtr < 16; iPtr++)
  51     m_vendorIds[iPtr] = CEC_VENDOR_UNKNOWN;
  52   for (uint8_t iPtr = 0; iPtr < 16; iPtr++)
  53     m_vendorClasses[iPtr] = (uint8_t) 0;
  54 }
  55
  56 CCECProcessor::~CCECProcessor(void)
  57 {
  58   StopThread();
  59   m_communication = NULL;
  60   m_controller = NULL;
  61 }
  62
  63 bool CCECProcessor::Start(void)
  64 {
  65   if (!m_communication || !m_communication->IsOpen())
  66   {
  67     m_controller->AddLog(CEC_LOG_ERROR, "connection is closed");
  68     return false;
  69   }
  70
  71   if (!SetLogicalAddress(m_iLogicalAddress))
  72   {
  73     m_controller->AddLog(CEC_LOG_ERROR, "could not set the logical address");
  74     return false;
  75   }
  76
  77   if (CreateThread())
  78     return true;
  79   else
  80     m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
  81
  82   return false;
  83 }
  84
  85 void *CCECProcessor::Process(void)
  86 {
  87   m_controller->AddLog(CEC_LOG_DEBUG, "processor thread started");
  88
  89   cec_command command;
  90   cec_adapter_message msg;
  91
  92   while (!IsStopped())
  93   {
  94     bool bParseFrame(false);
  95     command.clear();
  96     msg.clear();
  97
  98     {
  99       CLockObject lock(&m_mutex);
 100       if (m_communication->IsOpen() && m_communication->Read(msg, 50))
 101         bParseFrame = ParseMessage(msg) && !IsStopped();
 102
 103       if (bParseFrame)
 104         command = m_currentframe;
 105     }
 106
 107     if (bParseFrame)
 108       ParseCommand(command);
 109
 110     m_controller->CheckKeypressTimeout();
 111
 112     if (!IsStopped())
 113       Sleep(5);
 114   }
 115
 116   return NULL;
 117 }
 118
 119 bool CCECProcessor::PowerOnDevices(cec_logical_address address /* = CECDEVICE_TV */)
 120 {
 121   if (!IsRunning())
 122     return false;
 123
 124   CStdString strLog;
 125   strLog.Format("<< powering on device with logical address %d", (int8_t)address);
 126   m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
 127
 128   return Transmit(cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_IMAGE_VIEW_ON));
 129 }
 130
 131 bool CCECProcessor::StandbyDevices(cec_logical_address address /* = CECDEVICE_BROADCAST */)
 132 {
 133   if (!IsRunning())
 134     return false;
 135
 136   CStdString strLog;
 137   strLog.Format("<< putting device with logical address %d in standby mode", (int8_t)address);
 138   m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
 139
 140   return Transmit(cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_STANDBY));
 141 }
 142
 143 bool CCECProcessor::SetActiveView(void)
 144 {
 145   if (!IsRunning())
 146     return false;
 147
 148   m_controller->AddLog(CEC_LOG_DEBUG, "<< setting active view");
 149
 150   cec_command command = cec_command::format(m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
 151   command.parameters.push_back((m_physicaladdress >> 8) & 0xFF);
 152   command.parameters.push_back(m_physicaladdress & 0xFF);
 153
 154   return Transmit(command);
 155 }
 156
 157 bool CCECProcessor::SetInactiveView(void)
 158 {
 159   if (!IsRunning())
 160     return false;
 161
 162   m_controller->AddLog(CEC_LOG_DEBUG, "<< setting inactive view");
 163
 164   cec_command command = cec_command::format(m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_INACTIVE_SOURCE);
 165   command.parameters.push_back((m_physicaladdress >> 8) & 0xFF);
 166   command.parameters.push_back(m_physicaladdress & 0xFF);
 167
 168   return Transmit(command);
 169 }
 170
 171 void CCECProcessor::LogOutput(const cec_command &data)
 172 {
 173   CStdString txStr = "transmit ";
 174   txStr.AppendFormat(" %02x", ((uint8_t)data.initiator << 4) + (uint8_t)data.destination);
 175   txStr.AppendFormat(" %02x", (uint8_t)data.opcode);
 176
 177   for (unsigned int iPtr = 0; iPtr < data.parameters.size; iPtr++)
 178     txStr.AppendFormat(" %02x", data.parameters[iPtr]);
 179   m_controller->AddLog(CEC_LOG_DEBUG, txStr.c_str());
 180 }
 181
 182 bool CCECProcessor::Transmit(const cec_command &data, bool bWaitForAck /* = true */)
 183 {
 184   LogOutput(data);
 185
 186   cec_adapter_message output;
 187   output.clear();
 188   CAdapterCommunication::FormatAdapterMessage(data, output);
 189
 190   return TransmitFormatted(output, bWaitForAck);
 191 }
 192
 193 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress)
 194 {
 195   CStdString strLog;
 196   strLog.Format("<< setting logical address to %d", iLogicalAddress);
 197   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 198
 199   m_iLogicalAddress = iLogicalAddress;
 200   return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
 201 }
 202
 203 bool CCECProcessor::TransmitFormatted(const cec_adapter_message &data, bool bWaitForAck /* = true */)
 204 {
 205   CLockObject lock(&m_mutex);
 206   if (!m_communication || !m_communication->Write(data))
 207     return false;
 208
 209   if (bWaitForAck)
 210   {
 211     uint64_t now = GetTimeMs();
 212     uint64_t target = now + 1000;
 213     bool bError(false);
 214     bool bGotAck(false);
 215
 216     while (!bGotAck && now < target)
 217     {
 218       bGotAck = WaitForAck(&bError, (uint64_t) (target - now));
 219       now = GetTimeMs();
 220
 221       if (bError && now < target)
 222       {
 223         m_controller->AddLog(CEC_LOG_ERROR, "retransmitting previous frame");
 224         if (!m_communication->Write(data))
 225           return false;
 226       }
 227     }
 228   }
 229
 230   return true;
 231 }
 232
 233 void CCECProcessor::TransmitAbort(cec_logical_address address, cec_opcode opcode, ECecAbortReason reason /* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
 234 {
 235   m_controller->AddLog(CEC_LOG_DEBUG, "<< transmitting abort message");
 236
 237   cec_command command = cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_FEATURE_ABORT);
 238   command.parameters.push_back((uint8_t)opcode);
 239   command.parameters.push_back((uint8_t)reason);
 240
 241   Transmit(command);
 242 }
 243
 244 void CCECProcessor::ReportCECVersion(cec_logical_address address /* = CECDEVICE_TV */)
 245 {
 246   m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting CEC version as 1.3a");
 247
 248   cec_command command = cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_CEC_VERSION);
 249   command.parameters.push_back(CEC_VERSION_1_3A);
 250
 251   Transmit(command);
 252 }
 253
 254 void CCECProcessor::ReportPowerState(cec_logical_address address /*= CECDEVICE_TV */, bool bOn /* = true */)
 255 {
 256   if (bOn)
 257     m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting \"On\" power status");
 258   else
 259     m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting \"Off\" power status");
 260
 261   cec_command command = cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_REPORT_POWER_STATUS);
 262   command.parameters.push_back(bOn ? (uint8_t) CEC_POWER_STATUS_ON : (uint8_t) CEC_POWER_STATUS_STANDBY);
 263
 264   Transmit(command);
 265 }
 266
 267 void CCECProcessor::ReportMenuState(cec_logical_address address /* = CECDEVICE_TV */, bool bActive /* = true */)
 268 {
 269   if (bActive)
 270     m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting menu state as active");
 271   else
 272     m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting menu state as inactive");
 273
 274   cec_command command = cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_MENU_STATUS);
 275   command.parameters.push_back(bActive ? (uint8_t) CEC_MENU_STATE_ACTIVATED : (uint8_t) CEC_MENU_STATE_DEACTIVATED);
 276
 277   Transmit(command);
 278 }
 279
 280 void CCECProcessor::ReportVendorID(cec_logical_address address /* = CECDEVICE_TV */)
 281 {
 282   m_controller->AddLog(CEC_LOG_NOTICE, "<< vendor ID requested, feature abort");
 283   TransmitAbort(address, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
 284 }
 285
 286 void CCECProcessor::ReportOSDName(cec_logical_address address /* = CECDEVICE_TV */)
 287 {
 288   const char *osdname = m_strDeviceName.c_str();
 289   CStdString strLog;
 290   strLog.Format("<< reporting OSD name as %s", osdname);
 291   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 292
 293   cec_command command = cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_SET_OSD_NAME);
 294   for (unsigned int iPtr = 0; iPtr < strlen(osdname); iPtr++)
 295     command.parameters.push_back(osdname[iPtr]);
 296
 297   Transmit(command);
 298 }
 299
 300 void CCECProcessor::ReportPhysicalAddress(void)
 301 {
 302   CStdString strLog;
 303   strLog.Format("<< reporting physical address as %04x", m_physicaladdress);
 304   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 305
 306   cec_command command = cec_command::format(m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_REPORT_PHYSICAL_ADDRESS);
 307   command.parameters.push_back((uint8_t) ((m_physicaladdress >> 8) & 0xFF));
 308   command.parameters.push_back((uint8_t) (m_physicaladdress & 0xFF));
 309
 310   Transmit(command);
 311 }
 312
 313 void CCECProcessor::BroadcastActiveSource(void)
 314 {
 315   m_controller->AddLog(CEC_LOG_NOTICE, "<< broadcasting active source");
 316
 317   cec_command command = cec_command::format(m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
 318   command.parameters.push_back((uint8_t) ((m_physicaladdress >> 8) & 0xFF));
 319   command.parameters.push_back((uint8_t) (m_physicaladdress & 0xFF));
 320
 321   Transmit(command);
 322 }
 323
 324 bool CCECProcessor::WaitForAck(bool *bError, uint32_t iTimeout /* = 1000 */)
 325 {
 326   bool bGotAck(false);
 327   *bError = false;
 328
 329   int64_t iNow = GetTimeMs();
 330   int64_t iTargetTime = iNow + (uint64_t) iTimeout;
 331
 332   while (!bGotAck && !*bError && (iTimeout == 0 || iNow < iTargetTime))
 333   {
 334     cec_adapter_message msg;
 335     msg.clear();
 336
 337     if (!m_communication->Read(msg, iTimeout > 0 ? iTargetTime - iNow : 1000))
 338     {
 339       iNow = GetTimeMs();
 340       continue;
 341     }
 342
 343     switch (msg.message())
 344     {
 345     case MSGCODE_COMMAND_ACCEPTED:
 346       m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
 347       break;
 348     case MSGCODE_TRANSMIT_SUCCEEDED:
 349       m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
 350       bGotAck = true;
 351       break;
 352     case MSGCODE_RECEIVE_FAILED:
 353       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
 354       *bError = true;
 355       break;
 356     case MSGCODE_COMMAND_REJECTED:
 357       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
 358       *bError = true;
 359       break;
 360     case MSGCODE_TRANSMIT_FAILED_LINE:
 361       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
 362       *bError = true;
 363       break;
 364     case MSGCODE_TRANSMIT_FAILED_ACK:
 365       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
 366       *bError = true;
 367       break;
 368     case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
 369       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
 370       *bError = true;
 371       break;
 372     case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
 373       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
 374       *bError = true;
 375       break;
 376     default:
 377       m_frameBuffer.Push(msg);
 378       break;
 379     }
 380
 381     iNow = GetTimeMs();
 382   }
 383
 384   return bGotAck && !*bError;
 385 }
 386
 387 bool CCECProcessor::ParseMessage(cec_adapter_message &msg)
 388 {
 389   bool bReturn(false);
 390
 391   if (msg.empty())
 392     return bReturn;
 393
 394   CStdString logStr;
 395
 396   switch(msg.message())
 397   {
 398   case MSGCODE_NOTHING:
 399     m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_NOTHING");
 400     break;
 401   case MSGCODE_TIMEOUT_ERROR:
 402   case MSGCODE_HIGH_ERROR:
 403   case MSGCODE_LOW_ERROR:
 404     {
 405       if (msg.message() == MSGCODE_TIMEOUT_ERROR)
 406         logStr = "MSGCODE_TIMEOUT";
 407       else if (msg.message() == MSGCODE_HIGH_ERROR)
 408         logStr = "MSGCODE_HIGH_ERROR";
 409       else
 410         logStr = "MSGCODE_LOW_ERROR";
 411
 412       int iLine      = (msg.size() >= 3) ? (msg[1] << 8) | (msg[2]) : 0;
 413       uint32_t iTime = (msg.size() >= 7) ? (msg[3] << 24) | (msg[4] << 16) | (msg[5] << 8) | (msg[6]) : 0;
 414       logStr.AppendFormat(" line:%i", iLine);
 415       logStr.AppendFormat(" time:%u", iTime);
 416       m_controller->AddLog(CEC_LOG_WARNING, logStr.c_str());
 417     }
 418     break;
 419   case MSGCODE_FRAME_START:
 420     {
 421       logStr = "MSGCODE_FRAME_START";
 422       m_currentframe.clear();
 423       if (msg.size() >= 2)
 424       {
 425         logStr.AppendFormat(" initiator:%u destination:%u ack:%s %s", msg.initiator(), msg.destination(), msg.ack() ? "high" : "low", msg.eom() ? "eom" : "");
 426         m_currentframe.initiator   =  msg.initiator();
 427         m_currentframe.destination = msg.destination();
 428         m_currentframe.ack         = msg.ack();
 429         m_currentframe.eom         = msg.eom();
 430       }
 431       m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
 432     }
 433     break;
 434   case MSGCODE_FRAME_DATA:
 435     {
 436       logStr = "MSGCODE_FRAME_DATA";
 437       if (msg.size() >= 2)
 438       {
 439         uint8_t iData = msg[1];
 440         logStr.AppendFormat(" %02x", iData);
 441         m_currentframe.push_back(iData);
 442       }
 443       m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
 444     }
 445     if (msg.eom())
 446       bReturn = true;
 447     break;
 448   default:
 449     break;
 450   }
 451
 452   return bReturn;
 453 }
 454
 455 void CCECProcessor::ParseVendorId(cec_logical_address device, const cec_datapacket &data)
 456 {
 457   if (data.size < 3)
 458   {
 459     m_controller->AddLog(CEC_LOG_WARNING, "invalid vendor ID received");
 460     return;
 461   }
 462
 463   uint64_t iVendorId = ((uint64_t)data[0] << 3) +
 464                        ((uint64_t)data[1] << 2) +
 465                         (uint64_t)data[2];
 466
 467   m_vendorIds[(uint8_t)device]     = iVendorId;
 468   m_vendorClasses[(uint8_t)device] = data.size >= 4 ? data[3] : 0;
 469
 470   CStdString strLog;
 471   strLog.Format("device %d: vendor = %s (%lld) class = %2x", (uint8_t)device, CECVendorIdToString(m_vendorIds[(uint8_t)device]), iVendorId, m_vendorClasses[(uint8_t)device]);
 472   m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
 473 }
 474
 475 void CCECProcessor::ParseCommand(cec_command &command)
 476 {
 477   CStdString dataStr;
 478   dataStr.Format(">> received frame: initiator: %u destination: %u", command.initiator, command.destination);
 479   if (command.parameters.size > 1)
 480   {
 481     dataStr += " data:";
 482     for (unsigned int iPtr = 0; iPtr < command.parameters.size; iPtr++)
 483       dataStr.AppendFormat(" %02x", command.parameters[iPtr]);
 484   }
 485   m_controller->AddLog(CEC_LOG_DEBUG, dataStr.c_str());
 486
 487   if (command.destination == m_iLogicalAddress)
 488   {
 489     switch(command.opcode)
 490     {
 491     case CEC_OPCODE_GIVE_PHYSICAL_ADDRESS:
 492       ReportPhysicalAddress();
 493       break;
 494     case CEC_OPCODE_GIVE_OSD_NAME:
 495       ReportOSDName(command.initiator);
 496       break;
 497     case CEC_OPCODE_GIVE_DEVICE_VENDOR_ID:
 498       ReportVendorID(command.initiator);
 499       break;
 500     case CEC_OPCODE_VENDOR_COMMAND_WITH_ID:
 501       ParseVendorId(command.initiator, command.parameters);
 502       TransmitAbort(command.initiator, CEC_OPCODE_VENDOR_COMMAND_WITH_ID);
 503       break;
 504     case CEC_OPCODE_GIVE_DECK_STATUS:
 505       // need to support opcodes play and deck control before doing anything with this
 506       TransmitAbort(command.initiator, CEC_OPCODE_GIVE_DECK_STATUS);
 507       break;
 508     case CEC_OPCODE_MENU_REQUEST:
 509       if (command.parameters[0] == CEC_MENU_REQUEST_TYPE_QUERY)
 510         ReportMenuState(command.initiator);
 511       break;
 512     case CEC_OPCODE_GIVE_DEVICE_POWER_STATUS:
 513       ReportPowerState(command.initiator);
 514       SetActiveView();
 515       break;
 516     case CEC_OPCODE_GET_CEC_VERSION:
 517       ReportCECVersion(command.initiator);
 518       break;
 519     case CEC_OPCODE_USER_CONTROL_PRESSED:
 520       if (command.parameters.size > 0)
 521       {
 522         m_controller->AddKey();
 523
 524         if (command.parameters[0] <= CEC_USER_CONTROL_CODE_MAX)
 525           m_controller->SetCurrentButton((cec_user_control_code) command.parameters[0]);
 526       }
 527       break;
 528     case CEC_OPCODE_USER_CONTROL_RELEASE:
 529       m_controller->AddKey();
 530       break;
 531     default:
 532       m_controller->AddCommand(command);
 533       break;
 534     }
 535   }
 536   else if (command.destination == CECDEVICE_BROADCAST)
 537   {
 538     CStdString strLog;
 539     if (command.opcode == CEC_OPCODE_REQUEST_ACTIVE_SOURCE)
 540     {
 541       strLog.Format(">> %i requests active source", (uint8_t) command.initiator);
 542       m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
 543       BroadcastActiveSource();
 544     }
 545     else if (command.opcode == CEC_OPCODE_SET_STREAM_PATH)
 546     {
 547       if (command.parameters.size >= 2)
 548       {
 549         int streamaddr = ((int)command.parameters[0] << 8) | ((int)command.parameters[1]);
 550         strLog.Format(">> %i requests stream path from physical address %04x", command.initiator, streamaddr);
 551         m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
 552         if (streamaddr == m_physicaladdress)
 553           BroadcastActiveSource();
 554       }
 555     }
 556     else
 557     {
 558       m_controller->AddCommand(command);
 559     }
 560   }
 561   else
 562   {
 563     CStdString strLog;
 564     strLog.Format("ignoring frame: destination: %u != %u", command.destination, (uint8_t)m_iLogicalAddress);
 565     m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
 566   }
 567 }