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