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