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 {
  51   for (unsigned 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   StopThread();
  58   m_communication = NULL;
  59   m_controller = NULL;
  60   for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
  61     delete m_busDevices[iPtr];
  62 }
  63
  64 bool CCECProcessor::Start(void)
  65 {
  66   if (!m_communication || !m_communication->IsOpen())
  67   {
  68     m_controller->AddLog(CEC_LOG_ERROR, "connection is closed");
  69     return false;
  70   }
  71
  72   if (!SetLogicalAddress(m_iLogicalAddress))
  73   {
  74     m_controller->AddLog(CEC_LOG_ERROR, "could not set the logical address");
  75     return false;
  76   }
  77
  78   if (CreateThread())
  79     return true;
  80   else
  81     m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
  82
  83   return false;
  84 }
  85
  86 void *CCECProcessor::Process(void)
  87 {
  88   m_controller->AddLog(CEC_LOG_DEBUG, "processor thread started");
  89
  90   cec_command command;
  91   cec_adapter_message msg;
  92
  93   while (!IsStopped())
  94   {
  95     bool bParseFrame(false);
  96     bool bError(false);
  97     bool bTransmitSucceeded(false);
  98     command.clear();
  99     msg.clear();
 100
 101     {
 102       CLockObject lock(&m_mutex);
 103       if (m_communication->IsOpen() && m_communication->Read(msg, 50))
 104         ParseMessage(msg, &bError, &bTransmitSucceeded, &bParseFrame);
 105
 106       bParseFrame &= !IsStopped();
 107       if (bParseFrame)
 108         command = m_currentframe;
 109     }
 110
 111     if (bParseFrame)
 112       ParseCommand(command);
 113
 114     m_controller->CheckKeypressTimeout();
 115
 116     for (unsigned int iDevicePtr = 0; iDevicePtr < 16; iDevicePtr++)
 117       m_busDevices[iDevicePtr]->PollVendorId();
 118
 119     if (!IsStopped())
 120       Sleep(5);
 121   }
 122
 123   return NULL;
 124 }
 125
 126 bool CCECProcessor::SetActiveView(void)
 127 {
 128   if (!IsRunning())
 129     return false;
 130
 131   return m_busDevices[m_iLogicalAddress]->BroadcastActiveView();
 132 }
 133
 134 bool CCECProcessor::SetInactiveView(void)
 135 {
 136   if (!IsRunning())
 137     return false;
 138
 139   return m_busDevices[m_iLogicalAddress]->BroadcastInactiveView();
 140 }
 141
 142 void CCECProcessor::LogOutput(const cec_command &data)
 143 {
 144   CStdString strTx;
 145   strTx.Format("<< %02x:%02x", ((uint8_t)data.initiator << 4) + (uint8_t)data.destination, (uint8_t)data.opcode);
 146
 147   for (uint8_t iPtr = 0; iPtr < data.parameters.size; iPtr++)
 148     strTx.AppendFormat(":%02x", data.parameters[iPtr]);
 149   m_controller->AddLog(CEC_LOG_TRAFFIC, strTx.c_str());
 150 }
 151
 152 bool CCECProcessor::Transmit(const cec_command &data, bool bWaitForAck /* = true */)
 153 {
 154   LogOutput(data);
 155
 156   cec_adapter_message output;
 157   output.clear();
 158   CAdapterCommunication::FormatAdapterMessage(data, output);
 159
 160   return TransmitFormatted(output, bWaitForAck);
 161 }
 162
 163 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress)
 164 {
 165   CStdString strLog;
 166   strLog.Format("<< setting logical address to %1x", iLogicalAddress);
 167   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 168
 169   m_iLogicalAddress = iLogicalAddress;
 170   return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
 171 }
 172
 173 bool CCECProcessor::SetPhysicalAddress(uint16_t iPhysicalAddress)
 174 {
 175   m_busDevices[m_iLogicalAddress]->SetPhysicalAddress(iPhysicalAddress);
 176   return m_busDevices[m_iLogicalAddress]->BroadcastActiveView();
 177 }
 178
 179 bool CCECProcessor::SwitchMonitoring(bool bEnable)
 180 {
 181   CStdString strLog;
 182   strLog.Format("== %s monitoring mode ==", bEnable ? "enabling" : "disabling");
 183   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 184
 185   m_bMonitor = bEnable;
 186   if (bEnable)
 187     return m_communication && m_communication->SetAckMask(0);
 188   else
 189     return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
 190 }
 191
 192 bool CCECProcessor::TransmitFormatted(const cec_adapter_message &data, bool bWaitForAck /* = true */)
 193 {
 194   CLockObject lock(&m_mutex);
 195   if (!m_communication || !m_communication->Write(data))
 196     return false;
 197
 198   if (bWaitForAck)
 199   {
 200     uint64_t now = GetTimeMs();
 201     uint64_t target = now + 1000;
 202     bool bError(false);
 203     bool bGotAck(false);
 204
 205     while (!bGotAck && now < target)
 206     {
 207       bGotAck = WaitForAck(&bError, (uint32_t) (target - now));
 208       now = GetTimeMs();
 209
 210       if (bError && now < target)
 211       {
 212         m_controller->AddLog(CEC_LOG_ERROR, "retransmitting previous frame");
 213         if (!m_communication->Write(data))
 214           return false;
 215       }
 216     }
 217   }
 218
 219   return true;
 220 }
 221
 222 void CCECProcessor::TransmitAbort(cec_logical_address address, cec_opcode opcode, ECecAbortReason reason /* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
 223 {
 224   m_controller->AddLog(CEC_LOG_DEBUG, "<< transmitting abort message");
 225
 226   cec_command command;
 227   cec_command::format(command, m_iLogicalAddress, address, CEC_OPCODE_FEATURE_ABORT);
 228   command.parameters.push_back((uint8_t)opcode);
 229   command.parameters.push_back((uint8_t)reason);
 230
 231   Transmit(command);
 232 }
 233
 234 bool CCECProcessor::WaitForAck(bool *bError, uint32_t iTimeout /* = 1000 */)
 235 {
 236   bool bTransmitSucceeded = false, bEom = false;
 237   *bError = false;
 238
 239   int64_t iNow = GetTimeMs();
 240   int64_t iTargetTime = iNow + (uint64_t) iTimeout;
 241
 242   while (!bTransmitSucceeded && !*bError && (iTimeout == 0 || iNow < iTargetTime))
 243   {
 244     cec_adapter_message msg;
 245     msg.clear();
 246
 247     if (!m_communication->Read(msg, iTimeout > 0 ? (int32_t)(iTargetTime - iNow) : 1000))
 248     {
 249       iNow = GetTimeMs();
 250       continue;
 251     }
 252
 253     ParseMessage(msg, bError, &bTransmitSucceeded, &bEom, false);
 254     iNow = GetTimeMs();
 255   }
 256
 257   return bTransmitSucceeded && !*bError;
 258 }
 259
 260 void CCECProcessor::ParseMessage(cec_adapter_message &msg, bool *bError, bool *bTransmitSucceeded, bool *bEom, bool bProcessMessages /* = true */)
 261 {
 262   *bError = false;
 263   *bTransmitSucceeded = false;
 264   *bEom = false;
 265
 266   if (msg.empty())
 267     return;
 268
 269   CStdString logStr;
 270
 271   switch(msg.message())
 272   {
 273   case MSGCODE_NOTHING:
 274     m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_NOTHING");
 275     break;
 276   case MSGCODE_TIMEOUT_ERROR:
 277   case MSGCODE_HIGH_ERROR:
 278   case MSGCODE_LOW_ERROR:
 279     {
 280       if (msg.message() == MSGCODE_TIMEOUT_ERROR)
 281         logStr = "MSGCODE_TIMEOUT";
 282       else if (msg.message() == MSGCODE_HIGH_ERROR)
 283         logStr = "MSGCODE_HIGH_ERROR";
 284       else
 285         logStr = "MSGCODE_LOW_ERROR";
 286
 287       int iLine      = (msg.size() >= 3) ? (msg[1] << 8) | (msg[2]) : 0;
 288       uint32_t iTime = (msg.size() >= 7) ? (msg[3] << 24) | (msg[4] << 16) | (msg[5] << 8) | (msg[6]) : 0;
 289       logStr.AppendFormat(" line:%i", iLine);
 290       logStr.AppendFormat(" time:%u", iTime);
 291       m_controller->AddLog(CEC_LOG_WARNING, logStr.c_str());
 292       *bError = true;
 293     }
 294     break;
 295   case MSGCODE_FRAME_START:
 296     {
 297       if (bProcessMessages)
 298       {
 299         logStr = "MSGCODE_FRAME_START";
 300         m_currentframe.clear();
 301         if (msg.size() >= 2)
 302         {
 303           logStr.AppendFormat(" initiator:%u destination:%u ack:%s %s", msg.initiator(), msg.destination(), msg.ack() ? "high" : "low", msg.eom() ? "eom" : "");
 304           m_currentframe.initiator   = msg.initiator();
 305           m_currentframe.destination = msg.destination();
 306           m_currentframe.ack         = msg.ack();
 307           m_currentframe.eom         = msg.eom();
 308         }
 309         m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
 310       }
 311       else
 312       {
 313         m_frameBuffer.Push(msg);
 314       }
 315     }
 316     break;
 317   case MSGCODE_FRAME_DATA:
 318     {
 319       if (bProcessMessages)
 320       {
 321         logStr = "MSGCODE_FRAME_DATA";
 322         if (msg.size() >= 2)
 323         {
 324           uint8_t iData = msg[1];
 325           logStr.AppendFormat(" %02x", iData);
 326           m_currentframe.push_back(iData);
 327           m_currentframe.eom = msg.eom();
 328         }
 329         m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
 330       }
 331       else
 332       {
 333         m_frameBuffer.Push(msg);
 334       }
 335
 336       *bEom = msg.eom();
 337     }
 338     break;
 339   case MSGCODE_COMMAND_ACCEPTED:
 340     m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
 341     break;
 342   case MSGCODE_TRANSMIT_SUCCEEDED:
 343     m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
 344     *bTransmitSucceeded = true;
 345     break;
 346   case MSGCODE_RECEIVE_FAILED:
 347     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
 348     *bError = true;
 349     break;
 350   case MSGCODE_COMMAND_REJECTED:
 351     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
 352     *bError = true;
 353     break;
 354   case MSGCODE_TRANSMIT_FAILED_LINE:
 355     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
 356     *bError = true;
 357     break;
 358   case MSGCODE_TRANSMIT_FAILED_ACK:
 359     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
 360     *bError = true;
 361     break;
 362   case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
 363     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
 364     *bError = true;
 365     break;
 366   case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
 367     m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
 368     *bError = true;
 369     break;
 370   default:
 371     break;
 372   }
 373 }
 374
 375 void CCECProcessor::ParseCommand(cec_command &command)
 376 {
 377   CStdString dataStr;
 378   dataStr.Format(">> %1x%1x:%02x", command.initiator, command.destination, command.opcode);
 379   for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
 380     dataStr.AppendFormat(":%02x", (unsigned int)command.parameters[iPtr]);
 381   m_controller->AddLog(CEC_LOG_TRAFFIC, dataStr.c_str());
 382
 383   if (!m_bMonitor)
 384     m_busDevices[(uint8_t)command.initiator]->HandleCommand(command);
 385 }
 386
 387 uint16_t CCECProcessor::GetPhysicalAddress(void) const
 388 {
 389   return m_busDevices[m_iLogicalAddress]->GetPhysicalAddress();
 390 }
 391
 392 void CCECProcessor::SetCurrentButton(cec_user_control_code iButtonCode)
 393 {
 394   m_controller->SetCurrentButton(iButtonCode);
 395 }
 396
 397 void CCECProcessor::AddCommand(const cec_command &command)
 398 {
 399   m_controller->AddCommand(command);
 400 }
 401
 402 void CCECProcessor::AddKey(void)
 403 {
 404   m_controller->AddKey();
 405 }
 406
 407 void CCECProcessor::AddLog(cec_log_level level, const CStdString &strMessage)
 408 {
 409   m_controller->AddLog(level, strMessage);
 410 }