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