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 "devices/CECAudioSystem.h"
  38 #include "devices/CECPlaybackDevice.h"
  39 #include "devices/CECRecordingDevice.h"
  40 #include "devices/CECTuner.h"
  41 #include "devices/CECTV.h"
  42 #include "LibCEC.h"
  43 #include "util/StdString.h"
  44 #include "platform/timeutils.h"
  45
  46 using namespace CEC;
  47 using namespace std;
  48
  49 CCECProcessor::CCECProcessor(CLibCEC *controller, CAdapterCommunication *serComm, const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS*/) :
  50     m_bStarted(false),
  51     m_strDeviceName(strDeviceName),
  52     m_communication(serComm),
  53     m_controller(controller),
  54     m_bMonitor(false)
  55 {
  56   m_logicalAddresses.clear();
  57   m_logicalAddresses.set(iLogicalAddress);
  58   m_types.clear();
  59   for (int iPtr = 0; iPtr < 16; iPtr++)
  60     m_busDevices[iPtr] = new CCECBusDevice(this, (cec_logical_address) iPtr, iPtr == iLogicalAddress ? iPhysicalAddress : 0);
  61 }
  62
  63 CCECProcessor::CCECProcessor(CLibCEC *controller, CAdapterCommunication *serComm, const char *strDeviceName, const cec_device_type_list &types) :
  64     m_bStarted(false),
  65     m_strDeviceName(strDeviceName),
  66     m_types(types),
  67     m_communication(serComm),
  68     m_controller(controller),
  69     m_bMonitor(false)
  70 {
  71   m_logicalAddresses.clear();
  72   for (int iPtr = 0; iPtr < 16; iPtr++)
  73   {
  74     switch(iPtr)
  75     {
  76     case CECDEVICE_AUDIOSYSTEM:
  77       m_busDevices[iPtr] = new CCECAudioSystem(this, (cec_logical_address) iPtr, 0);
  78       break;
  79     case CECDEVICE_PLAYBACKDEVICE1:
  80     case CECDEVICE_PLAYBACKDEVICE2:
  81     case CECDEVICE_PLAYBACKDEVICE3:
  82       m_busDevices[iPtr] = new CCECPlaybackDevice(this, (cec_logical_address) iPtr, 0);
  83       break;
  84     case CECDEVICE_RECORDINGDEVICE1:
  85     case CECDEVICE_RECORDINGDEVICE2:
  86     case CECDEVICE_RECORDINGDEVICE3:
  87       m_busDevices[iPtr] = new CCECRecordingDevice(this, (cec_logical_address) iPtr, 0);
  88       break;
  89     case CECDEVICE_TUNER1:
  90     case CECDEVICE_TUNER2:
  91     case CECDEVICE_TUNER3:
  92     case CECDEVICE_TUNER4:
  93       m_busDevices[iPtr] = new CCECTuner(this, (cec_logical_address) iPtr, 0);
  94       break;
  95     case CECDEVICE_TV:
  96       m_busDevices[iPtr] = new CCECTV(this, (cec_logical_address) iPtr, 0);
  97       break;
  98     default:
  99       m_busDevices[iPtr] = new CCECBusDevice(this, (cec_logical_address) iPtr, 0);
 100       break;
 101     }
 102   }
 103 }
 104
 105 CCECProcessor::~CCECProcessor(void)
 106 {
 107   m_startCondition.Broadcast();
 108   StopThread();
 109   m_communication = NULL;
 110   m_controller = NULL;
 111   for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
 112     delete m_busDevices[iPtr];
 113 }
 114
 115 bool CCECProcessor::Start(void)
 116 {
 117   CLockObject lock(&m_mutex);
 118   if (!m_communication || !m_communication->IsOpen())
 119   {
 120     m_controller->AddLog(CEC_LOG_ERROR, "connection is closed");
 121     return false;
 122   }
 123
 124   if (CreateThread())
 125   {
 126     if (!m_startCondition.Wait(&m_mutex) || !m_bStarted)
 127     {
 128       m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
 129       return false;
 130     }
 131     return true;
 132   }
 133   else
 134     m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
 135
 136   return false;
 137 }
 138
 139 bool CCECProcessor::TryLogicalAddress(cec_logical_address address, const char *strLabel, unsigned int iIndex)
 140 {
 141   CStdString strLog;
 142   strLog.Format("trying logical address '%s'", strLabel);
 143   AddLog(CEC_LOG_DEBUG, strLog);
 144
 145   SetAckMask(0x1 << address);
 146   if (!m_busDevices[address]->PollDevice(address))
 147   {
 148     strLog.Format("using logical address '%s'", strLabel);
 149     AddLog(CEC_LOG_NOTICE, strLog);
 150
 151     /* only set our OSD name for the primary device */
 152     if (m_logicalAddresses.empty())
 153       m_busDevices[address]->m_strDeviceName = m_strDeviceName;
 154     m_logicalAddresses.set(address);
 155
 156     // TODO
 157     m_busDevices[address]->SetPhysicalAddress(CEC_DEFAULT_PHYSICAL_ADDRESS + iIndex);
 158
 159     return true;
 160   }
 161
 162   strLog.Format("logical address '%s' already taken", strLabel);
 163   AddLog(CEC_LOG_DEBUG, strLog);
 164   return false;
 165 }
 166
 167 bool CCECProcessor::FindLogicalAddressRecordingDevice(unsigned int iIndex)
 168 {
 169   AddLog(CEC_LOG_DEBUG, "detecting logical address for type 'recording device'");
 170   return TryLogicalAddress(CECDEVICE_RECORDINGDEVICE1, "recording 1", iIndex) ||
 171       TryLogicalAddress(CECDEVICE_RECORDINGDEVICE2, "recording 2", iIndex) ||
 172       TryLogicalAddress(CECDEVICE_RECORDINGDEVICE3, "recording 3", iIndex);
 173 }
 174
 175 bool CCECProcessor::FindLogicalAddressTuner(unsigned int iIndex)
 176 {
 177   AddLog(CEC_LOG_DEBUG, "detecting logical address for type 'tuner'");
 178   return TryLogicalAddress(CECDEVICE_TUNER1, "tuner 1", iIndex) ||
 179       TryLogicalAddress(CECDEVICE_TUNER2, "tuner 2", iIndex) ||
 180       TryLogicalAddress(CECDEVICE_TUNER3, "tuner 3", iIndex) ||
 181       TryLogicalAddress(CECDEVICE_TUNER4, "tuner 4", iIndex);
 182 }
 183
 184 bool CCECProcessor::FindLogicalAddressPlaybackDevice(unsigned int iIndex)
 185 {
 186   AddLog(CEC_LOG_DEBUG, "detecting logical address for type 'playback device'");
 187   return TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE1, "playback 1", iIndex) ||
 188       TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE2, "playback 2", iIndex) ||
 189       TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE3, "playback 3", iIndex);
 190 }
 191
 192 bool CCECProcessor::FindLogicalAddressAudioSystem(unsigned int iIndex)
 193 {
 194   AddLog(CEC_LOG_DEBUG, "detecting logical address for type 'audio'");
 195   return TryLogicalAddress(CECDEVICE_AUDIOSYSTEM, "audio", iIndex);
 196 }
 197
 198 bool CCECProcessor::FindLogicalAddresses(void)
 199 {
 200   bool bReturn(true);
 201   m_logicalAddresses.clear();
 202   CStdString strLog;
 203
 204   for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
 205   {
 206     if (m_types.types[iPtr] == CEC_DEVICE_TYPE_RESERVED)
 207       continue;
 208
 209     strLog.Format("%s - device %d: type %d", __FUNCTION__, iPtr, m_types.types[iPtr]);
 210     AddLog(CEC_LOG_DEBUG, strLog);
 211
 212     if (m_types.types[iPtr] == CEC_DEVICE_TYPE_RECORDING_DEVICE)
 213       bReturn &= FindLogicalAddressRecordingDevice(iPtr);
 214     if (m_types.types[iPtr] == CEC_DEVICE_TYPE_TUNER)
 215       bReturn &= FindLogicalAddressTuner(iPtr);
 216     if (m_types.types[iPtr] == CEC_DEVICE_TYPE_PLAYBACK_DEVICE)
 217       bReturn &= FindLogicalAddressPlaybackDevice(iPtr);
 218     if (m_types.types[iPtr] == CEC_DEVICE_TYPE_AUDIO_SYSTEM)
 219       bReturn &= FindLogicalAddressAudioSystem(iPtr);
 220   }
 221
 222   return bReturn;
 223 }
 224
 225 void *CCECProcessor::Process(void)
 226 {
 227   cec_command           command;
 228   CCECAdapterMessage    msg;
 229
 230   {
 231     if (m_logicalAddresses.empty() && !FindLogicalAddresses())
 232     {
 233       CLockObject lock(&m_mutex);
 234       m_controller->AddLog(CEC_LOG_ERROR, "could not detect our logical addressed");
 235       m_startCondition.Signal();
 236       return NULL;
 237     }
 238
 239     SetAckMask(m_logicalAddresses.ackmask());
 240
 241     {
 242       CLockObject lock(&m_mutex);
 243       m_controller->AddLog(CEC_LOG_DEBUG, "processor thread started");
 244       m_bStarted = true;
 245       m_startCondition.Signal();
 246     }
 247   }
 248
 249   while (!IsStopped())
 250   {
 251     bool bParseFrame(false);
 252     command.clear();
 253     msg.clear();
 254
 255     {
 256       CLockObject lock(&m_mutex);
 257       if (m_communication->IsOpen() && m_communication->Read(msg, 50))
 258       {
 259         m_controller->AddLog(msg.is_error() ? CEC_LOG_WARNING : CEC_LOG_DEBUG, msg.ToString());
 260         bParseFrame = ParseMessage(msg) && !IsStopped();
 261       }
 262
 263       if (bParseFrame)
 264         command = m_currentframe;
 265     }
 266
 267     if (bParseFrame)
 268       ParseCommand(command);
 269
 270     Sleep(5);
 271
 272     m_controller->CheckKeypressTimeout();
 273
 274     for (unsigned int iDevicePtr = 0; iDevicePtr < 16; iDevicePtr++)
 275       m_busDevices[iDevicePtr]->PollVendorId();
 276
 277     Sleep(5);
 278   }
 279
 280   return NULL;
 281 }
 282
 283 bool CCECProcessor::SetActiveView(void)
 284 {
 285   if (!IsRunning())
 286     return false;
 287
 288   if (!m_logicalAddresses.empty() && m_busDevices[m_logicalAddresses.primary])
 289     return m_busDevices[m_logicalAddresses.primary]->BroadcastActiveView();
 290   return false;
 291 }
 292
 293 bool CCECProcessor::SetInactiveView(void)
 294 {
 295   if (!IsRunning())
 296     return false;
 297
 298   if (!m_logicalAddresses.empty() && m_busDevices[m_logicalAddresses.primary])
 299     return m_busDevices[m_logicalAddresses.primary]->BroadcastInactiveView();
 300   return false;
 301 }
 302
 303 void CCECProcessor::LogOutput(const cec_command &data)
 304 {
 305   CStdString strTx;
 306   strTx.Format("<< %02x", ((uint8_t)data.initiator << 4) + (uint8_t)data.destination);
 307   if (data.opcode_set)
 308       strTx.AppendFormat(":%02x", (uint8_t)data.opcode);
 309
 310   for (uint8_t iPtr = 0; iPtr < data.parameters.size; iPtr++)
 311     strTx.AppendFormat(":%02x", data.parameters[iPtr]);
 312   m_controller->AddLog(CEC_LOG_TRAFFIC, strTx.c_str());
 313 }
 314
 315 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress)
 316 {
 317   if (m_logicalAddresses.primary != iLogicalAddress)
 318   {
 319     CStdString strLog;
 320     strLog.Format("<< setting primary logical address to %1x", iLogicalAddress);
 321     m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 322     m_logicalAddresses.primary = iLogicalAddress;
 323     m_logicalAddresses.set(iLogicalAddress);
 324     return SetAckMask(m_logicalAddresses.ackmask());
 325   }
 326
 327   return true;
 328 }
 329
 330 bool CCECProcessor::SetPhysicalAddress(uint16_t iPhysicalAddress)
 331 {
 332   if (!m_logicalAddresses.empty() && m_busDevices[m_logicalAddresses.primary])
 333   {
 334     m_busDevices[m_logicalAddresses.primary]->SetPhysicalAddress(iPhysicalAddress);
 335     return m_busDevices[m_logicalAddresses.primary]->BroadcastActiveView();
 336   }
 337   return false;
 338 }
 339
 340 bool CCECProcessor::SwitchMonitoring(bool bEnable)
 341 {
 342   CStdString strLog;
 343   strLog.Format("== %s monitoring mode ==", bEnable ? "enabling" : "disabling");
 344   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 345
 346   m_bMonitor = bEnable;
 347   if (bEnable)
 348     return SetAckMask(0);
 349   else
 350     return SetAckMask(m_logicalAddresses.ackmask());
 351 }
 352
 353 bool CCECProcessor::PollDevice(cec_logical_address iAddress)
 354 {
 355   if (iAddress != CECDEVICE_UNKNOWN && m_busDevices[iAddress])
 356     return m_busDevices[iAddress]->PollDevice();
 357   return false;
 358 }
 359
 360 cec_version CCECProcessor::GetDeviceCecVersion(cec_logical_address iAddress)
 361 {
 362   return m_busDevices[iAddress]->GetCecVersion();
 363 }
 364
 365 bool CCECProcessor::GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language)
 366 {
 367   if (m_busDevices[iAddress])
 368   {
 369     *language = m_busDevices[iAddress]->GetMenuLanguage();
 370     return (strcmp(language->language, "???") != 0);
 371   }
 372   return false;
 373 }
 374
 375 uint64_t CCECProcessor::GetDeviceVendorId(cec_logical_address iAddress)
 376 {
 377   if (m_busDevices[iAddress])
 378     return m_busDevices[iAddress]->GetVendorId();
 379   return false;
 380 }
 381
 382 cec_power_status CCECProcessor::GetDevicePowerStatus(cec_logical_address iAddress)
 383 {
 384   if (m_busDevices[iAddress])
 385     return m_busDevices[iAddress]->GetPowerStatus();
 386   return CEC_POWER_STATUS_UNKNOWN;
 387 }
 388
 389 bool CCECProcessor::Transmit(const cec_command &data)
 390 {
 391   bool bReturn(false);
 392   LogOutput(data);
 393
 394   CCECAdapterMessage *output = new CCECAdapterMessage(data);
 395   bReturn = Transmit(output);
 396   delete output;
 397
 398   return bReturn;
 399 }
 400
 401 bool CCECProcessor::Transmit(CCECAdapterMessage *output)
 402 {
 403   bool bReturn(false);
 404   CLockObject lock(&m_mutex);
 405   {
 406     CLockObject msgLock(&output->mutex);
 407     if (!m_communication || !m_communication->Write(output))
 408       return bReturn;
 409     else
 410     {
 411       output->condition.Wait(&output->mutex);
 412       if (output->state != ADAPTER_MESSAGE_STATE_SENT)
 413       {
 414         m_controller->AddLog(CEC_LOG_ERROR, "command was not sent");
 415         return bReturn;
 416       }
 417     }
 418
 419     if (output->transmit_timeout > 0)
 420     {
 421       if ((bReturn = WaitForTransmitSucceeded(output->size(), output->transmit_timeout)) == false)
 422         m_controller->AddLog(CEC_LOG_ERROR, "did not receive ack");
 423     }
 424     else
 425       bReturn = true;
 426   }
 427
 428   return bReturn;
 429 }
 430
 431 void CCECProcessor::TransmitAbort(cec_logical_address address, cec_opcode opcode, ECecAbortReason reason /* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
 432 {
 433   m_controller->AddLog(CEC_LOG_DEBUG, "<< transmitting abort message");
 434
 435   cec_command command;
 436   // TODO
 437   cec_command::format(command, m_logicalAddresses.primary, address, CEC_OPCODE_FEATURE_ABORT);
 438   command.parameters.push_back((uint8_t)opcode);
 439   command.parameters.push_back((uint8_t)reason);
 440
 441   Transmit(command);
 442 }
 443
 444 bool CCECProcessor::WaitForTransmitSucceeded(uint8_t iLength, uint32_t iTimeout /* = 1000 */)
 445 {
 446   bool bError(false);
 447   bool bTransmitSucceeded(false);
 448   uint8_t iPacketsLeft(iLength / 4);
 449
 450   int64_t iNow = GetTimeMs();
 451   int64_t iTargetTime = iNow + (uint64_t) iTimeout;
 452
 453   while (!bTransmitSucceeded && !bError && (iTimeout == 0 || iNow < iTargetTime))
 454   {
 455     CCECAdapterMessage msg;
 456
 457     if (!m_communication->Read(msg, iTimeout > 0 ? (int32_t)(iTargetTime - iNow) : 1000))
 458     {
 459       iNow = GetTimeMs();
 460       continue;
 461     }
 462
 463     if ((bError = msg.is_error()) == false)
 464     {
 465       m_controller->AddLog(bError ? CEC_LOG_WARNING : CEC_LOG_DEBUG, msg.ToString());
 466
 467       switch(msg.message())
 468       {
 469       case MSGCODE_COMMAND_ACCEPTED:
 470         if (iPacketsLeft > 0)
 471           iPacketsLeft--;
 472         break;
 473       case MSGCODE_TRANSMIT_SUCCEEDED:
 474         bTransmitSucceeded = (iPacketsLeft == 0);
 475         bError = !bTransmitSucceeded;
 476         break;
 477       default:
 478         ParseMessage(msg);
 479       }
 480
 481       iNow = GetTimeMs();
 482     }
 483   }
 484
 485   return bTransmitSucceeded && !bError;
 486 }
 487
 488 bool CCECProcessor::ParseMessage(const CCECAdapterMessage &msg)
 489 {
 490   bool bEom = false;
 491
 492   if (msg.empty())
 493     return bEom;
 494
 495   switch(msg.message())
 496   {
 497   case MSGCODE_FRAME_START:
 498     {
 499       m_currentframe.clear();
 500       if (msg.size() >= 2)
 501       {
 502         m_currentframe.initiator   = msg.initiator();
 503         m_currentframe.destination = msg.destination();
 504         m_currentframe.ack         = msg.ack();
 505         m_currentframe.eom         = msg.eom();
 506       }
 507     }
 508     break;
 509   case MSGCODE_FRAME_DATA:
 510     {
 511       if (msg.size() >= 2)
 512       {
 513         m_currentframe.push_back(msg[1]);
 514         m_currentframe.eom = msg.eom();
 515       }
 516       bEom = msg.eom();
 517     }
 518     break;
 519   default:
 520     break;
 521   }
 522
 523   return bEom;
 524 }
 525
 526 void CCECProcessor::ParseCommand(cec_command &command)
 527 {
 528   CStdString dataStr;
 529   dataStr.Format(">> %1x%1x:%02x", command.initiator, command.destination, command.opcode);
 530   for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
 531     dataStr.AppendFormat(":%02x", (unsigned int)command.parameters[iPtr]);
 532   m_controller->AddLog(CEC_LOG_TRAFFIC, dataStr.c_str());
 533
 534   if (!m_bMonitor)
 535     m_busDevices[(uint8_t)command.initiator]->HandleCommand(command);
 536 }
 537
 538 uint16_t CCECProcessor::GetPhysicalAddress(void) const
 539 {
 540   if (!m_logicalAddresses.empty() && m_busDevices[m_logicalAddresses.primary])
 541     return m_busDevices[m_logicalAddresses.primary]->GetPhysicalAddress();
 542   return false;
 543 }
 544
 545 void CCECProcessor::SetCurrentButton(cec_user_control_code iButtonCode)
 546 {
 547   m_controller->SetCurrentButton(iButtonCode);
 548 }
 549
 550 void CCECProcessor::AddCommand(const cec_command &command)
 551 {
 552   m_controller->AddCommand(command);
 553 }
 554
 555 void CCECProcessor::AddKey(cec_keypress &key)
 556 {
 557   m_controller->AddKey(key);
 558 }
 559
 560 void CCECProcessor::AddKey(void)
 561 {
 562   m_controller->AddKey();
 563 }
 564
 565 void CCECProcessor::AddLog(cec_log_level level, const CStdString &strMessage)
 566 {
 567   m_controller->AddLog(level, strMessage);
 568 }
 569
 570 bool CCECProcessor::SetAckMask(uint16_t iMask)
 571 {
 572   bool bReturn(false);
 573   CStdString strLog;
 574   strLog.Format("setting ackmask to %2x", iMask);
 575   m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
 576
 577   CCECAdapterMessage *output = new CCECAdapterMessage;
 578
 579   output->push_back(MSGSTART);
 580   output->push_escaped(MSGCODE_SET_ACK_MASK);
 581   output->push_escaped(iMask >> 8);
 582   output->push_escaped((uint8_t)iMask);
 583   output->push_back(MSGEND);
 584
 585   if ((bReturn = Transmit(output)) == false)
 586     m_controller->AddLog(CEC_LOG_ERROR, "could not set the ackmask");
 587
 588   delete output;
 589
 590   return bReturn;
 591 }