cec: refactor CEC command handling. split up standard and non-standard CEC implementa...
[deb_libcec.git] / src / lib / CECProcessor.cpp
index f9872fce8fd0cae5c8fbe883cfd76880b334af46..eae4c3cfa7b3b2e92eeae6d3623feaed19c43b39 100644 (file)
@@ -33,6 +33,7 @@
 #include "CECProcessor.h"
 
 #include "AdapterCommunication.h"
+#include "CECBusDevice.h"
 #include "LibCEC.h"
 #include "util/StdString.h"
 #include "platform/timeutils.h"
@@ -41,16 +42,15 @@ using namespace CEC;
 using namespace std;
 
 CCECProcessor::CCECProcessor(CLibCEC *controller, CAdapterCommunication *serComm, const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS*/) :
-    m_physicaladdress(iPhysicalAddress),
+    m_iPhysicalAddress(iPhysicalAddress),
     m_iLogicalAddress(iLogicalAddress),
     m_strDeviceName(strDeviceName),
     m_communication(serComm),
-    m_controller(controller)
+    m_controller(controller),
+    m_bMonitor(false)
 {
-  for (uint8_t iPtr = 0; iPtr < 16; iPtr++)
-    m_vendorIds[iPtr] = CEC_VENDOR_UNKNOWN;
-  for (uint8_t iPtr = 0; iPtr < 16; iPtr++)
-    m_vendorClasses[iPtr] = (uint8_t) 0;
+  for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
+    m_busDevices[iPtr] = new CCECBusDevice(this, (cec_logical_address) iPtr, 0);
 }
 
 CCECProcessor::~CCECProcessor(void)
@@ -58,6 +58,7 @@ CCECProcessor::~CCECProcessor(void)
   StopThread();
   m_communication = NULL;
   m_controller = NULL;
+  delete[] m_busDevices;
 }
 
 bool CCECProcessor::Start(void)
@@ -92,14 +93,17 @@ void *CCECProcessor::Process(void)
   while (!IsStopped())
   {
     bool bParseFrame(false);
+    bool bError(false);
+    bool bTransmitSucceeded(false);
     command.clear();
     msg.clear();
 
     {
       CLockObject lock(&m_mutex);
       if (m_communication->IsOpen() && m_communication->Read(msg, 50))
-        bParseFrame = ParseMessage(msg) && !IsStopped();
+        ParseMessage(msg, &bError, &bTransmitSucceeded, &bParseFrame);
 
+      bParseFrame &= !IsStopped();
       if (bParseFrame)
         command = m_currentframe;
     }
@@ -155,8 +159,8 @@ bool CCECProcessor::SetActiveView(void)
 
   cec_command command;
   cec_command::format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
-  command.parameters.push_back((m_physicaladdress >> 8) & 0xFF);
-  command.parameters.push_back(m_physicaladdress & 0xFF);
+  command.parameters.push_back((m_iPhysicalAddress >> 8) & 0xFF);
+  command.parameters.push_back(m_iPhysicalAddress & 0xFF);
 
   return Transmit(command);
 }
@@ -170,8 +174,8 @@ bool CCECProcessor::SetInactiveView(void)
 
   cec_command command;
   cec_command::format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_INACTIVE_SOURCE);
-  command.parameters.push_back((m_physicaladdress >> 8) & 0xFF);
-  command.parameters.push_back(m_physicaladdress & 0xFF);
+  command.parameters.push_back((m_iPhysicalAddress >> 8) & 0xFF);
+  command.parameters.push_back(m_iPhysicalAddress & 0xFF);
 
   return Transmit(command);
 }
@@ -180,10 +184,10 @@ void CCECProcessor::LogOutput(const cec_command &data)
 {
   CStdString txStr = "transmit ";
   txStr.AppendFormat(" %02x", ((uint8_t)data.initiator << 4) + (uint8_t)data.destination);
-  txStr.AppendFormat(" %02x", (uint8_t)data.opcode);
+  txStr.AppendFormat(":%02x", (uint8_t)data.opcode);
 
   for (uint8_t iPtr = 0; iPtr < data.parameters.size; iPtr++)
-    txStr.AppendFormat(" %02x", data.parameters[iPtr]);
+    txStr.AppendFormat(":%02x", data.parameters[iPtr]);
   m_controller->AddLog(CEC_LOG_DEBUG, txStr.c_str());
 }
 
@@ -201,13 +205,52 @@ bool CCECProcessor::Transmit(const cec_command &data, bool bWaitForAck /* = true
 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress)
 {
   CStdString strLog;
-  strLog.Format("<< setting logical address to %d", iLogicalAddress);
+  strLog.Format("<< setting logical address to %1x", iLogicalAddress);
   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 
   m_iLogicalAddress = iLogicalAddress;
   return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
 }
 
+bool CCECProcessor::SetPhysicalAddress(uint16_t iPhysicalAddress)
+{
+  CStdString strLog;
+  strLog.Format("<< setting physical address to %2x", iPhysicalAddress);
+  m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
+
+  m_iPhysicalAddress = iPhysicalAddress;
+  return SetActiveView();
+}
+
+bool CCECProcessor::SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage)
+{
+  CStdString strLog;
+  strLog.Format("<< display message '%s'", strMessage);
+  m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
+
+  cec_command command;
+  cec_command::format(command, m_iLogicalAddress, iLogicalAddress, CEC_OPCODE_SET_OSD_STRING);
+  command.parameters.push_back((uint8_t)duration);
+
+  for (unsigned int iPtr = 0; iPtr < strlen(strMessage); iPtr++)
+    command.parameters.push_back(strMessage[iPtr]);
+
+  return Transmit(command);
+}
+
+bool CCECProcessor::SwitchMonitoring(bool bEnable)
+{
+  CStdString strLog;
+  strLog.Format("== %s monitoring mode ==", bEnable ? "enabling" : "disabling");
+  m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
+
+  m_bMonitor = bEnable;
+  if (bEnable)
+    return m_communication && m_communication->SetAckMask(0);
+  else
+    return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
+}
+
 bool CCECProcessor::TransmitFormatted(const cec_adapter_message &data, bool bWaitForAck /* = true */)
 {
   CLockObject lock(&m_mutex);
@@ -313,13 +356,13 @@ void CCECProcessor::ReportOSDName(cec_logical_address address /* = CECDEVICE_TV
 void CCECProcessor::ReportPhysicalAddress(void)
 {
   CStdString strLog;
-  strLog.Format("<< reporting physical address as %04x", m_physicaladdress);
+  strLog.Format("<< reporting physical address as %04x", m_iPhysicalAddress);
   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
 
   cec_command command;
   cec_command::format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_REPORT_PHYSICAL_ADDRESS);
-  command.parameters.push_back((uint8_t) ((m_physicaladdress >> 8) & 0xFF));
-  command.parameters.push_back((uint8_t) (m_physicaladdress & 0xFF));
+  command.parameters.push_back((uint8_t) ((m_iPhysicalAddress >> 8) & 0xFF));
+  command.parameters.push_back((uint8_t) (m_iPhysicalAddress & 0xFF));
   command.parameters.push_back((uint8_t) (CEC_DEVICE_TYPE_PLAYBACK_DEVICE));
 
   Transmit(command);
@@ -331,21 +374,21 @@ void CCECProcessor::BroadcastActiveSource(void)
 
   cec_command command;
   cec_command::format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
-  command.parameters.push_back((uint8_t) ((m_physicaladdress >> 8) & 0xFF));
-  command.parameters.push_back((uint8_t) (m_physicaladdress & 0xFF));
+  command.parameters.push_back((uint8_t) ((m_iPhysicalAddress >> 8) & 0xFF));
+  command.parameters.push_back((uint8_t) (m_iPhysicalAddress & 0xFF));
 
   Transmit(command);
 }
 
 bool CCECProcessor::WaitForAck(bool *bError, uint32_t iTimeout /* = 1000 */)
 {
-  bool bGotAck(false);
+  bool bTransmitSucceeded = false, bEom = false;
   *bError = false;
 
   int64_t iNow = GetTimeMs();
   int64_t iTargetTime = iNow + (uint64_t) iTimeout;
 
-  while (!bGotAck && !*bError && (iTimeout == 0 || iNow < iTargetTime))
+  while (!bTransmitSucceeded && !*bError && (iTimeout == 0 || iNow < iTargetTime))
   {
     cec_adapter_message msg;
     msg.clear();
@@ -356,56 +399,21 @@ bool CCECProcessor::WaitForAck(bool *bError, uint32_t iTimeout /* = 1000 */)
       continue;
     }
 
-    switch (msg.message())
-    {
-    case MSGCODE_COMMAND_ACCEPTED:
-      m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
-      break;
-    case MSGCODE_TRANSMIT_SUCCEEDED:
-      m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
-      bGotAck = true;
-      break;
-    case MSGCODE_RECEIVE_FAILED:
-      m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
-      *bError = true;
-      break;
-    case MSGCODE_COMMAND_REJECTED:
-      m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
-      *bError = true;
-      break;
-    case MSGCODE_TRANSMIT_FAILED_LINE:
-      m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
-      *bError = true;
-      break;
-    case MSGCODE_TRANSMIT_FAILED_ACK:
-      m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
-      *bError = true;
-      break;
-    case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
-      m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
-      *bError = true;
-      break;
-    case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
-      m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
-      *bError = true;
-      break;
-    default:
-      m_frameBuffer.Push(msg);
-      break;
-    }
-
+    ParseMessage(msg, bError, &bTransmitSucceeded, &bEom, false);
     iNow = GetTimeMs();
   }
 
-  return bGotAck && !*bError;
+  return bTransmitSucceeded && !*bError;
 }
 
-bool CCECProcessor::ParseMessage(cec_adapter_message &msg)
+void CCECProcessor::ParseMessage(cec_adapter_message &msg, bool *bError, bool *bTransmitSucceeded, bool *bEom, bool bProcessMessages /* = true */)
 {
-  bool bReturn(false);
+  *bError = false;
+  *bTransmitSucceeded = false;
+  *bEom = false;
 
   if (msg.empty())
-    return bReturn;
+    return;
 
   CStdString logStr;
 
@@ -430,42 +438,87 @@ bool CCECProcessor::ParseMessage(cec_adapter_message &msg)
       logStr.AppendFormat(" line:%i", iLine);
       logStr.AppendFormat(" time:%u", iTime);
       m_controller->AddLog(CEC_LOG_WARNING, logStr.c_str());
+      *bError = true;
     }
     break;
   case MSGCODE_FRAME_START:
     {
-      logStr = "MSGCODE_FRAME_START";
-      m_currentframe.clear();
-      if (msg.size() >= 2)
+      if (bProcessMessages)
+      {
+        logStr = "MSGCODE_FRAME_START";
+        m_currentframe.clear();
+        if (msg.size() >= 2)
+        {
+          logStr.AppendFormat(" initiator:%u destination:%u ack:%s %s", msg.initiator(), msg.destination(), msg.ack() ? "high" : "low", msg.eom() ? "eom" : "");
+          m_currentframe.initiator   = msg.initiator();
+          m_currentframe.destination = msg.destination();
+          m_currentframe.ack         = msg.ack();
+          m_currentframe.eom         = msg.eom();
+        }
+        m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
+      }
+      else
       {
-        logStr.AppendFormat(" initiator:%u destination:%u ack:%s %s", msg.initiator(), msg.destination(), msg.ack() ? "high" : "low", msg.eom() ? "eom" : "");
-        m_currentframe.initiator   =  msg.initiator();
-        m_currentframe.destination = msg.destination();
-        m_currentframe.ack         = msg.ack();
-        m_currentframe.eom         = msg.eom();
+        m_frameBuffer.Push(msg);
       }
-      m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
     }
     break;
   case MSGCODE_FRAME_DATA:
     {
-      logStr = "MSGCODE_FRAME_DATA";
-      if (msg.size() >= 2)
+      if (bProcessMessages)
       {
-        uint8_t iData = msg[1];
-        logStr.AppendFormat(" %02x", iData);
-        m_currentframe.push_back(iData);
+        logStr = "MSGCODE_FRAME_DATA";
+        if (msg.size() >= 2)
+        {
+          uint8_t iData = msg[1];
+          logStr.AppendFormat(" %02x", iData);
+          m_currentframe.push_back(iData);
+          m_currentframe.eom = msg.eom();
+        }
+        m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
       }
-      m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
+      else
+      {
+        m_frameBuffer.Push(msg);
+      }
+
+      *bEom = msg.eom();
     }
-    if (msg.eom())
-      bReturn = true;
+    break;
+  case MSGCODE_COMMAND_ACCEPTED:
+    m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
+    break;
+  case MSGCODE_TRANSMIT_SUCCEEDED:
+    m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
+    *bTransmitSucceeded = true;
+    break;
+  case MSGCODE_RECEIVE_FAILED:
+    m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
+    *bError = true;
+    break;
+  case MSGCODE_COMMAND_REJECTED:
+    m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
+    *bError = true;
+    break;
+  case MSGCODE_TRANSMIT_FAILED_LINE:
+    m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
+    *bError = true;
+    break;
+  case MSGCODE_TRANSMIT_FAILED_ACK:
+    m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
+    *bError = true;
+    break;
+  case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
+    m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
+    *bError = true;
+    break;
+  case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
+    m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
+    *bError = true;
     break;
   default:
     break;
   }
-
-  return bReturn;
 }
 
 void CCECProcessor::ParseVendorId(cec_logical_address device, const cec_datapacket &data)
@@ -480,118 +533,37 @@ void CCECProcessor::ParseVendorId(cec_logical_address device, const cec_datapack
                        ((uint64_t)data[1] << 2) +
                         (uint64_t)data[2];
 
-  m_vendorIds[(uint8_t)device]     = iVendorId;
-  m_vendorClasses[(uint8_t)device] = data.size >= 4 ? data[3] : 0;
-
-  CStdString strLog;
-  strLog.Format("device %d: vendor = %s (%lld) class = %2x", (uint8_t)device, CECVendorIdToString(m_vendorIds[(uint8_t)device]), iVendorId, m_vendorClasses[(uint8_t)device]);
-  m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
+  m_busDevices[(uint8_t)device]->SetVendorId(iVendorId, data.size >= 4 ? data[3] : 0);
 }
 
 void CCECProcessor::ParseCommand(cec_command &command)
 {
   CStdString dataStr;
-  dataStr.Format(">> received frame: initiator: %u destination: %u", command.initiator, command.destination);
-  if (command.parameters.size > 1)
-  {
-    dataStr += " data:";
-    for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
-      dataStr.AppendFormat(" %02x", (unsigned int)command.parameters[iPtr]);
-  }
+  dataStr.Format(">> received frame: %1x%1x:%02x", command.initiator, command.destination, command.opcode);
+  for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
+    dataStr.AppendFormat(":%02x", (unsigned int)command.parameters[iPtr]);
   m_controller->AddLog(CEC_LOG_DEBUG, dataStr.c_str());
 
-  if (command.destination == m_iLogicalAddress)
-  {
-    switch(command.opcode)
-    {
-    case CEC_OPCODE_GIVE_PHYSICAL_ADDRESS:
-      ReportPhysicalAddress();
-      break;
-    case CEC_OPCODE_GIVE_OSD_NAME:
-      ReportOSDName(command.initiator);
-      break;
-    case CEC_OPCODE_GIVE_DEVICE_VENDOR_ID:
-      ReportVendorID(command.initiator);
-      break;
-    case CEC_OPCODE_VENDOR_COMMAND_WITH_ID:
-      ParseVendorId(command.initiator, command.parameters);
-      TransmitAbort(command.initiator, CEC_OPCODE_VENDOR_COMMAND_WITH_ID);
-      break;
-    case CEC_OPCODE_GIVE_DECK_STATUS:
-      // need to support opcodes play and deck control before doing anything with this
-      TransmitAbort(command.initiator, CEC_OPCODE_GIVE_DECK_STATUS);
-      break;
-    case CEC_OPCODE_MENU_REQUEST:
-      if (command.parameters[0] == CEC_MENU_REQUEST_TYPE_QUERY)
-        ReportMenuState(command.initiator);
-      break;
-    case CEC_OPCODE_GIVE_DEVICE_POWER_STATUS:
-      ReportPowerState(command.initiator);
-      SetActiveView();
-      break;
-    case CEC_OPCODE_GET_CEC_VERSION:
-      ReportCECVersion(command.initiator);
-      break;
-    case CEC_OPCODE_USER_CONTROL_PRESSED:
-      if (command.parameters.size > 0)
-      {
-        m_controller->AddKey();
+  if (!m_bMonitor)
+    m_busDevices[(uint8_t)command.initiator]->HandleCommand(command);
+}
 
-        if (command.parameters[0] <= CEC_USER_CONTROL_CODE_MAX)
-          m_controller->SetCurrentButton((cec_user_control_code) command.parameters[0]);
-      }
-      break;
-    case CEC_OPCODE_USER_CONTROL_RELEASE:
-      m_controller->AddKey();
-      break;
-    case CEC_OPCODE_ROUTING_CHANGE:
-      m_controller->SetActiveView();
-      break;
-    default:
-      m_controller->AddCommand(command);
-      break;
-    }
-  }
-  else if (command.destination == CECDEVICE_BROADCAST)
-  {
-    CStdString strLog;
-    if (command.opcode == CEC_OPCODE_REQUEST_ACTIVE_SOURCE)
-    {
-      strLog.Format(">> %i requests active source", (uint8_t) command.initiator);
-      m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
-      BroadcastActiveSource();
-    }
-    else if (command.opcode == CEC_OPCODE_SET_STREAM_PATH)
-    {
-      if (command.parameters.size >= 2)
-      {
-        int streamaddr = ((int)command.parameters[0] << 8) | ((int)command.parameters[1]);
-        strLog.Format(">> %i requests stream path from physical address %04x", command.initiator, streamaddr);
-        m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
-        if (streamaddr == m_physicaladdress)
-          BroadcastActiveSource();
-      }
-    }
-    else
-    {
-      m_controller->AddCommand(command);
-    }
-  }
-  else
-  {
-    CStdString strLog;
-    strLog.Format("ignoring frame: destination: %u != %u", command.destination, (uint8_t)m_iLogicalAddress);
-    m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
-  }
+void CCECProcessor::SetCurrentButton(cec_user_control_code iButtonCode)
+{
+  m_controller->SetCurrentButton(iButtonCode);
 }
 
-const char *CCECProcessor::CECVendorIdToString(const uint64_t iVendorId)
+void CCECProcessor::AddCommand(const cec_command &command)
 {
-  switch (iVendorId)
-  {
-  case CEC_VENDOR_SAMSUNG:
-    return "Samsung";
-  default:
-    return "Unknown";
-  }
+  m_controller->AddCommand(command);
+}
+
+void CCECProcessor::AddKey(void)
+{
+  m_controller->AddKey();
+}
+
+void CCECProcessor::AddLog(cec_log_level level, const CStdString &strMessage)
+{
+  m_controller->AddLog(level, strMessage);
 }