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 "devices/CECBusDevice.h"
  37 #include "LibCEC.h"
  38 #include "util/StdString.h"
  39 #include "platform/timeutils.h"
  40
  41 using namespace CEC;
  42 using namespace std;
  43
  44 CCECProcessor::CCECProcessor(CLibCEC *controller, CAdapterCommunication *serComm, const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS*/) :
  45     m_iLogicalAddress(CECDEVICE_UNKNOWN),
  46     m_strDeviceName(strDeviceName),
  47     m_communication(serComm),
  48     m_controller(controller),
  49     m_bMonitor(false)
  50 {
  51   for (int iPtr = 0; iPtr < 16; iPtr++)
  52     m_busDevices[iPtr] = new CCECBusDevice(this, (cec_logical_address) iPtr, iPtr == iLogicalAddress ? iPhysicalAddress : 0);
  53 }
  54
  55 CCECProcessor::~CCECProcessor(void)
  56 {
  57   m_startCondition.Broadcast();
  58   StopThread();
  59   m_communication = NULL;
  60   m_controller = NULL;
  61   for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
  62     delete m_busDevices[iPtr];
  63 }
  64
  65 bool CCECProcessor::Start(void)
  66 {
  67   CLockObject lock(&m_mutex);
  68   if (!m_communication || !m_communication->IsOpen())
  69   {
  70     m_controller->AddLog(CEC_LOG_ERROR, "connection is closed");
  71     return false;
  72   }
  73
  74   if (!SetLogicalAddress(m_iLogicalAddress))
  75   {
  76     m_controller->AddLog(CEC_LOG_ERROR, "could not set the logical address");
  77     return false;
  78   }
  79
  80   if (CreateThread())
  81   {
  82     if (!m_startCondition.Wait(&m_mutex))
  83     {
  84       m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
  85       return false;
  86     }
  87     return true;
  88   }
  89   else
  90     m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
  91
  92   return false;
  93 }
  94
  95 void *CCECProcessor::Process(void)
  96 {
  97   {
  98     CLockObject lock(&m_mutex);
  99     m_controller->AddLog(CEC_LOG_DEBUG, "processor thread started");
 100     m_startCondition.Signal();
 101   }
 102
 103   cec_command           command;
 104   CCECAdapterMessage    msg;
 105   CCECAdapterMessagePtr msgPtr;
 106
 107   m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
 108
 109   while (!IsStopped())
 110   {
 111     bool bParseFrame(false);
 112     command.clear();
 113     msg.clear();
 114
 115     {
 116       CLockObject lock(&m_mutex);
 117       if (m_frameBuffer.Pop(msgPtr))
 118         bParseFrame = ParseMessage(msgPtr);
 119       else if (m_communication->IsOpen() && m_communication->Read(msg, 50))
 120       {
 121         msgPtr = CCECAdapterMessagePtr(new CCECAdapterMessage(msg));
 122         bParseFrame = ParseMessage(msgPtr);
 123       }
 124
 125       bParseFrame &= !IsStopped();
 126       if (bParseFrame)
 127         command = m_currentframe;
 128     }
 129
 130     if (bParseFrame)
 131       ParseCommand(command);
 132
 133     m_controller->CheckKeypressTimeout();
 134
 135     for (unsigned int iDevicePtr = 0; iDevicePtr < 16; iDevicePtr++)
 136       m_busDevices[iDevicePtr]->PollVendorId();
 137
 138     if (!IsStopped())
 139       Sleep(5);
 140   }
 141
 142   return NULL;
 143 }
 144
 145 bool CCECProcessor::SetActiveView(void)
 146 {
 147   if (!IsRunning())
 148     return false;
 149
 150   return m_busDevices[m_iLogicalAddress]->BroadcastActiveView();
 151 }
 152
 153 bool CCECProcessor::SetInactiveView(void)
 154 {
 155   if (!IsRunning())
 156     return false;
 157
 158   return m_busDevices[m_iLogicalAddress]->BroadcastInactiveView();
 159 }
 160
 161 void CCECProcessor::LogOutput(const cec_command &data)
 162 {
 163   CStdString strTx;
 164   strTx.Format("<< %02x:%02x", ((uint8_t)data.initiator << 4) + (uint8_t)data.destination, (uint8_t)data.opcode);
 165
 166   for (uint8_t iPtr = 0; iPtr < data.parameters.size; iPtr++)
 167     strTx.AppendFormat(":%02x", data.parameters[iPtr]);
 168   m_controller->AddLog(CEC_LOG_TRAFFIC, strTx.c_str());
 169 }
 170
 171 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress)
 172 {
 173   if (m_iLogicalAddress != iLogicalAddress)
 174   {
 175     CStdString strLog;
 176     strLog.Format("<< setting logical address to %1x", iLogicalAddress);
 177     m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 178
 179     m_iLogicalAddress = iLogicalAddress;
 180     return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
 181   }
 182
 183   return true;
 184 }
 185
 186 bool CCECProcessor::SetPhysicalAddress(uint16_t iPhysicalAddress)
 187 {
 188   m_busDevices[m_iLogicalAddress]->SetPhysicalAddress(iPhysicalAddress);
 189   return m_busDevices[m_iLogicalAddress]->BroadcastActiveView();
 190 }
 191
 192 bool CCECProcessor::SwitchMonitoring(bool bEnable)
 193 {
 194   CStdString strLog;
 195   strLog.Format("== %s monitoring mode ==", bEnable ? "enabling" : "disabling");
 196   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 197
 198   m_bMonitor = bEnable;
 199   if (bEnable)
 200     return m_communication && m_communication->SetAckMask(0);
 201   else
 202     return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
 203 }
 204
 205 cec_version CCECProcessor::GetDeviceCecVersion(cec_logical_address iAddress)
 206 {
 207   return m_busDevices[iAddress]->GetCecVersion();
 208 }
 209
 210 bool CCECProcessor::GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language)
 211 {
 212   *language = m_busDevices[iAddress]->GetMenuLanguage();
 213   return (strcmp(language->language, "???"));
 214 }
 215
 216 uint64_t CCECProcessor::GetDeviceVendorId(cec_logical_address iAddress)
 217 {
 218   return m_busDevices[iAddress]->GetVendorId();
 219 }
 220
 221 bool CCECProcessor::Transmit(const cec_command &data)
 222 {
 223   bool bReturn(false);
 224   LogOutput(data);
 225
 226   CCECAdapterMessagePtr output(new CCECAdapterMessage(data));
 227
 228   CLockObject lock(&m_mutex);
 229   {
 230     CLockObject msgLock(&output->mutex);
 231     if (!m_communication || !m_communication->Write(output))
 232       return bReturn;
 233     else
 234     {
 235       output->condition.Wait(&output->mutex);
 236       if (output->state != ADAPTER_MESSAGE_STATE_SENT)
 237       {
 238         m_controller->AddLog(CEC_LOG_ERROR, "command was not sent");
 239         return bReturn;
 240       }
 241     }
 242
 243     if (data.ack_timeout > 0)
 244     {
 245       bool bError(false);
 246       if ((bReturn = WaitForAck(&bError, output->size(), data.ack_timeout)) == false)
 247         m_controller->AddLog(CEC_LOG_ERROR, "did not receive ack");
 248     }
 249     else
 250     {
 251       bReturn = true;
 252     }
 253   }
 254
 255   return bReturn;
 256 }
 257
 258 void CCECProcessor::TransmitAbort(cec_logical_address address, cec_opcode opcode, ECecAbortReason reason /* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
 259 {
 260   m_controller->AddLog(CEC_LOG_DEBUG, "<< transmitting abort message");
 261
 262   cec_command command;
 263   cec_command::format(command, m_iLogicalAddress, address, CEC_OPCODE_FEATURE_ABORT);
 264   command.parameters.push_back((uint8_t)opcode);
 265   command.parameters.push_back((uint8_t)reason);
 266
 267   Transmit(command);
 268 }
 269
 270 bool CCECProcessor::WaitForAck(bool *bError, uint8_t iLength, uint32_t iTimeout /* = 1000 */)
 271 {
 272   bool bTransmitSucceeded = false;
 273   uint8_t iPacketsLeft(iLength / 4);
 274   *bError = false;
 275
 276   int64_t iNow = GetTimeMs();
 277   int64_t iTargetTime = iNow + (uint64_t) iTimeout;
 278
 279   while (!bTransmitSucceeded && !*bError && (iTimeout == 0 || iNow < iTargetTime))
 280   {
 281     CCECAdapterMessage msg;
 282
 283     if (!m_communication->Read(msg, iTimeout > 0 ? (int32_t)(iTargetTime - iNow) : 1000))
 284     {
 285       iNow = GetTimeMs();
 286       continue;
 287     }
 288
 289     switch(msg.message())
 290     {
 291     case MSGCODE_TIMEOUT_ERROR:
 292     case MSGCODE_HIGH_ERROR:
 293     case MSGCODE_LOW_ERROR:
 294       {
 295         CStdString logStr;
 296         if (msg.message() == MSGCODE_TIMEOUT_ERROR)
 297           logStr = "MSGCODE_TIMEOUT";
 298         else if (msg.message() == MSGCODE_HIGH_ERROR)
 299           logStr = "MSGCODE_HIGH_ERROR";
 300         else
 301           logStr = "MSGCODE_LOW_ERROR";
 302
 303         int iLine      = (msg.size() >= 3) ? (msg[1] << 8) | (msg[2]) : 0;
 304         uint32_t iTime = (msg.size() >= 7) ? (msg[3] << 24) | (msg[4] << 16) | (msg[5] << 8) | (msg[6]) : 0;
 305         logStr.AppendFormat(" line:%i", iLine);
 306         logStr.AppendFormat(" time:%u", iTime);
 307         m_controller->AddLog(CEC_LOG_WARNING, logStr.c_str());
 308         *bError = true;
 309       }
 310       break;
 311     case MSGCODE_COMMAND_ACCEPTED:
 312       m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
 313       iPacketsLeft--;
 314       break;
 315     case MSGCODE_TRANSMIT_SUCCEEDED:
 316       m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
 317       bTransmitSucceeded = (iPacketsLeft == 0);
 318       *bError = !bTransmitSucceeded;
 319       break;
 320     case MSGCODE_RECEIVE_FAILED:
 321       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
 322       *bError = true;
 323       break;
 324     case MSGCODE_COMMAND_REJECTED:
 325       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
 326       *bError = true;
 327       break;
 328     case MSGCODE_TRANSMIT_FAILED_LINE:
 329       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
 330       *bError = true;
 331       break;
 332     case MSGCODE_TRANSMIT_FAILED_ACK:
 333       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
 334       *bError = true;
 335       break;
 336     case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
 337       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
 338       *bError = true;
 339       break;
 340     case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
 341       m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
 342       *bError = true;
 343       break;
 344     default:
 345       CCECAdapterMessagePtr msgPtr = CCECAdapterMessagePtr(new CCECAdapterMessage(msg));
 346       m_frameBuffer.Push(msgPtr);
 347       break;
 348     }
 349
 350     iNow = GetTimeMs();
 351   }
 352
 353   return bTransmitSucceeded && !*bError;
 354 }
 355
 356 bool CCECProcessor::ParseMessage(CCECAdapterMessagePtr msg)
 357 {
 358   bool bEom = false;
 359
 360   if (msg->empty())
 361     return bEom;
 362
 363   CStdString logStr;
 364
 365   switch(msg->message())
 366   {
 367   case MSGCODE_NOTHING:
 368     m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_NOTHING");
 369     break;
 370   case MSGCODE_TIMEOUT_ERROR:
 371   case MSGCODE_HIGH_ERROR:
 372   case MSGCODE_LOW_ERROR:
 373     {
 374       if (msg->message() == MSGCODE_TIMEOUT_ERROR)
 375         logStr = "MSGCODE_TIMEOUT";
 376       else if (msg->message() == MSGCODE_HIGH_ERROR)
 377         logStr = "MSGCODE_HIGH_ERROR";
 378       else
 379         logStr = "MSGCODE_LOW_ERROR";
 380
 381       int iLine      = (msg->size() >= 3) ? (msg->at(1) << 8) | (msg->at(2)) : 0;
 382       uint32_t iTime = (msg->size() >= 7) ? (msg->at(3) << 24) | (msg->at(4) << 16) | (msg->at(5) << 8) | (msg->at(6)) : 0;
 383       logStr.AppendFormat(" line:%i", iLine);
 384       logStr.AppendFormat(" time:%u", iTime);
 385       m_controller->AddLog(CEC_LOG_WARNING, logStr.c_str());
 386     }
 387     break;
 388   case MSGCODE_FRAME_START:
 389     {
 390       logStr = "MSGCODE_FRAME_START";
 391       m_currentframe.clear();
 392       if (msg->size() >= 2)
 393       {
 394         logStr.AppendFormat(" initiator:%u destination:%u ack:%s %s", msg->initiator(), msg->destination(), msg->ack() ? "high" : "low", msg->eom() ? "eom" : "");
 395         m_currentframe.initiator   = msg->initiator();
 396         m_currentframe.destination = msg->destination();
 397         m_currentframe.ack         = msg->ack();
 398         m_currentframe.eom         = msg->eom();
 399       }
 400       m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
 401     }
 402     break;
 403   case MSGCODE_FRAME_DATA:
 404     {
 405       logStr = "MSGCODE_FRAME_DATA";
 406       if (msg->size() >= 2)
 407       {
 408         uint8_t iData = msg->at(1);
 409         logStr.AppendFormat(" %02x", iData);
 410         m_currentframe.push_back(iData);
 411         m_currentframe.eom = msg->eom();
 412       }
 413       m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
 414
 415       bEom = msg->eom();
 416     }
 417     break;
 418   case MSGCODE_COMMAND_ACCEPTED:
 419     m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
 420     break;
 421   case MSGCODE_TRANSMIT_SUCCEEDED:
 422     m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
 423     break;
 424   case MSGCODE_RECEIVE_FAILED:
 425     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
 426     break;
 427   case MSGCODE_COMMAND_REJECTED:
 428     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
 429     break;
 430   case MSGCODE_TRANSMIT_FAILED_LINE:
 431     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
 432     break;
 433   case MSGCODE_TRANSMIT_FAILED_ACK:
 434     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
 435     break;
 436   case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
 437     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
 438     break;
 439   case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
 440     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
 441     break;
 442   default:
 443     break;
 444   }
 445
 446   return bEom;
 447 }
 448
 449 void CCECProcessor::ParseCommand(cec_command &command)
 450 {
 451   CStdString dataStr;
 452   dataStr.Format(">> %1x%1x:%02x", command.initiator, command.destination, command.opcode);
 453   for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
 454     dataStr.AppendFormat(":%02x", (unsigned int)command.parameters[iPtr]);
 455   m_controller->AddLog(CEC_LOG_TRAFFIC, dataStr.c_str());
 456
 457   if (!m_bMonitor)
 458     m_busDevices[(uint8_t)command.initiator]->HandleCommand(command);
 459 }
 460
 461 uint16_t CCECProcessor::GetPhysicalAddress(void) const
 462 {
 463   return m_busDevices[m_iLogicalAddress]->GetPhysicalAddress();
 464 }
 465
 466 void CCECProcessor::SetCurrentButton(cec_user_control_code iButtonCode)
 467 {
 468   m_controller->SetCurrentButton(iButtonCode);
 469 }
 470
 471 void CCECProcessor::AddCommand(const cec_command &command)
 472 {
 473   m_controller->AddCommand(command);
 474 }
 475
 476 void CCECProcessor::AddKey(void)
 477 {
 478   m_controller->AddKey();
 479 }
 480
 481 void CCECProcessor::AddLog(cec_log_level level, const CStdString &strMessage)
 482 {
 483   m_controller->AddLog(level, strMessage);
 484 }