cec: more cleanups. split up cec_adapter_message and cec_command. use cec_command...
[deb_libcec.git] / src / lib / CECProcessor.cpp
index f53ee901eaa8fefd0a78f14db551e3a23174c054..4b7b66422abb764cad1f0aeeaf7b1fa1e1ebe372 100644 (file)
@@ -86,10 +86,13 @@ void *CCECProcessor::Process(void)
 {
   m_controller->AddLog(CEC_LOG_DEBUG, "processor thread started");
 
+  cec_command command;
+  cec_adapter_message msg;
+
   while (!IsStopped())
   {
     bool bParseFrame(false);
-    cec_frame msg;
+    command.clear();
     msg.clear();
 
     {
@@ -98,14 +101,11 @@ void *CCECProcessor::Process(void)
         bParseFrame = ParseMessage(msg) && !IsStopped();
 
       if (bParseFrame)
-      {
-        msg.clear();
-        msg = m_currentframe;
-      }
+        command = m_currentframe;
     }
 
     if (bParseFrame)
-      ParseCurrentFrame(msg);
+      ParseCommand(command);
 
     m_controller->CheckKeypressTimeout();
 
@@ -124,12 +124,8 @@ bool CCECProcessor::PowerOnDevices(cec_logical_address address /* = CECDEVICE_TV
   CStdString strLog;
   strLog.Format("<< powering on device with logical address %d", (int8_t)address);
   m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
-  cec_frame frame;
-  frame.clear();
 
-  frame.push_back(GetSourceDestination(address));
-  frame.push_back((uint8_t) CEC_OPCODE_IMAGE_VIEW_ON);
-  return Transmit(frame);
+  return Transmit(cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_IMAGE_VIEW_ON));
 }
 
 bool CCECProcessor::StandbyDevices(cec_logical_address address /* = CECDEVICE_BROADCAST */)
@@ -140,12 +136,8 @@ bool CCECProcessor::StandbyDevices(cec_logical_address address /* = CECDEVICE_BR
   CStdString strLog;
   strLog.Format("<< putting device with logical address %d in standby mode", (int8_t)address);
   m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
-  cec_frame frame;
-  frame.clear();
 
-  frame.push_back(GetSourceDestination(address));
-  frame.push_back((uint8_t) CEC_OPCODE_STANDBY);
-  return Transmit(frame);
+  return Transmit(cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_STANDBY));
 }
 
 bool CCECProcessor::SetActiveView(void)
@@ -154,14 +146,12 @@ bool CCECProcessor::SetActiveView(void)
     return false;
 
   m_controller->AddLog(CEC_LOG_DEBUG, "<< setting active view");
-  cec_frame frame;
-  frame.clear();
-
-  frame.push_back(GetSourceDestination(CECDEVICE_BROADCAST));
-  frame.push_back((uint8_t) CEC_OPCODE_ACTIVE_SOURCE);
-  frame.push_back((m_physicaladdress >> 8) & 0xFF);
-  frame.push_back(m_physicaladdress & 0xFF);
-  return Transmit(frame);
+
+  cec_command command = cec_command::format(m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
+  command.parameters.push_back((m_physicaladdress >> 8) & 0xFF);
+  command.parameters.push_back(m_physicaladdress & 0xFF);
+
+  return Transmit(command);
 }
 
 bool CCECProcessor::SetInactiveView(void)
@@ -170,57 +160,32 @@ bool CCECProcessor::SetInactiveView(void)
     return false;
 
   m_controller->AddLog(CEC_LOG_DEBUG, "<< setting inactive view");
-  cec_frame frame;
-  frame.clear();
-
-  frame.push_back(GetSourceDestination(CECDEVICE_BROADCAST));
-  frame.push_back((uint8_t) CEC_OPCODE_INACTIVE_SOURCE);
-  frame.push_back((m_physicaladdress >> 8) & 0xFF);
-  frame.push_back(m_physicaladdress & 0xFF);
-  return Transmit(frame);
+
+  cec_command command = cec_command::format(m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_INACTIVE_SOURCE);
+  command.parameters.push_back((m_physicaladdress >> 8) & 0xFF);
+  command.parameters.push_back(m_physicaladdress & 0xFF);
+
+  return Transmit(command);
 }
 
-bool CCECProcessor::Transmit(const cec_frame &data, bool bWaitForAck /* = true */)
+void CCECProcessor::LogOutput(const cec_command &data)
 {
   CStdString txStr = "transmit ";
-  for (unsigned int i = 0; i < data.size(); i++)
-    txStr.AppendFormat(" %02x", data[i]);
+  txStr.AppendFormat(" %02x", ((uint8_t)data.initiator << 4) + (uint8_t)data.destination);
+  txStr.AppendFormat(" %02x", (uint8_t)data.opcode);
+
+  for (unsigned int iPtr = 0; iPtr < data.parameters.size; iPtr++)
+    txStr.AppendFormat(" %02x", data.parameters[iPtr]);
   m_controller->AddLog(CEC_LOG_DEBUG, txStr.c_str());
+}
 
-  if (data.size() == 0)
-  {
-    m_controller->AddLog(CEC_LOG_WARNING, "transmit buffer is empty");
-    return false;
-  }
+bool CCECProcessor::Transmit(const cec_command &data, bool bWaitForAck /* = true */)
+{
+  LogOutput(data);
 
-  cec_frame output;
+  cec_adapter_message output;
   output.clear();
-
-  //set ack polarity to high when transmitting to the broadcast address
-  //set ack polarity low when transmitting to any other address
-  output.push_back(MSGSTART);
-  CAdapterCommunication::PushEscaped(output, MSGCODE_TRANSMIT_ACK_POLARITY);
-
-  if ((data[0] & 0xF) == 0xF)
-    CAdapterCommunication::PushEscaped(output, CEC_TRUE);
-  else
-    CAdapterCommunication::PushEscaped(output, CEC_FALSE);
-
-  output.push_back(MSGEND);
-
-  for (int8_t i = 0; i < data.size(); i++)
-  {
-    output.push_back(MSGSTART);
-
-    if (i == data.size() - 1)
-      CAdapterCommunication::PushEscaped(output, MSGCODE_TRANSMIT_EOM);
-    else
-      CAdapterCommunication::PushEscaped(output, MSGCODE_TRANSMIT);
-
-    CAdapterCommunication::PushEscaped(output, data[i]);
-
-    output.push_back(MSGEND);
-  }
+  CAdapterCommunication::FormatAdapterMessage(data, output);
 
   return TransmitFormatted(output, bWaitForAck);
 }
@@ -235,7 +200,7 @@ bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress)
   return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
 }
 
-bool CCECProcessor::TransmitFormatted(const cec_frame &data, bool bWaitForAck /* = true */)
+bool CCECProcessor::TransmitFormatted(const cec_adapter_message &data, bool bWaitForAck /* = true */)
 {
   CLockObject lock(&m_mutex);
   if (!m_communication || !m_communication->Write(data))
@@ -267,59 +232,49 @@ bool CCECProcessor::TransmitFormatted(const cec_frame &data, bool bWaitForAck /*
 
 void CCECProcessor::TransmitAbort(cec_logical_address address, cec_opcode opcode, ECecAbortReason reason /* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
 {
-  m_controller->AddLog(CEC_LOG_DEBUG, "transmitting abort message");
-  cec_frame frame;
-  frame.clear();
-
-  frame.push_back(GetSourceDestination(address));
-  frame.push_back((uint8_t) CEC_OPCODE_FEATURE_ABORT);
-  frame.push_back((uint8_t) opcode);
-  frame.push_back((uint8_t) reason);
-  Transmit(frame);
+  m_controller->AddLog(CEC_LOG_DEBUG, "<< transmitting abort message");
+
+  cec_command command = cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_FEATURE_ABORT);
+  command.parameters.push_back((uint8_t)opcode);
+  command.parameters.push_back((uint8_t)reason);
+
+  Transmit(command);
 }
 
 void CCECProcessor::ReportCECVersion(cec_logical_address address /* = CECDEVICE_TV */)
 {
-  cec_frame frame;
-  frame.clear();
-
   m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting CEC version as 1.3a");
-  frame.push_back(GetSourceDestination(address));
-  frame.push_back((uint8_t) CEC_OPCODE_CEC_VERSION);
-  frame.push_back((uint8_t) CEC_VERSION_1_3A);
-  Transmit(frame);
+
+  cec_command command = cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_CEC_VERSION);
+  command.parameters.push_back(CEC_VERSION_1_3A);
+
+  Transmit(command);
 }
 
 void CCECProcessor::ReportPowerState(cec_logical_address address /*= CECDEVICE_TV */, bool bOn /* = true */)
 {
-  cec_frame frame;
-  frame.clear();
-
   if (bOn)
     m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting \"On\" power status");
   else
     m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting \"Off\" power status");
 
-  frame.push_back(GetSourceDestination(address));
-  frame.push_back((uint8_t) CEC_OPCODE_REPORT_POWER_STATUS);
-  frame.push_back(bOn ? (uint8_t) CEC_POWER_STATUS_ON : (uint8_t) CEC_POWER_STATUS_STANDBY);
-  Transmit(frame);
+  cec_command command = cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_REPORT_POWER_STATUS);
+  command.parameters.push_back(bOn ? (uint8_t) CEC_POWER_STATUS_ON : (uint8_t) CEC_POWER_STATUS_STANDBY);
+
+  Transmit(command);
 }
 
 void CCECProcessor::ReportMenuState(cec_logical_address address /* = CECDEVICE_TV */, bool bActive /* = true */)
 {
-  cec_frame frame;
-  frame.clear();
-
   if (bActive)
     m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting menu state as active");
   else
     m_controller->AddLog(CEC_LOG_NOTICE, "<< reporting menu state as inactive");
 
-  frame.push_back(GetSourceDestination(address));
-  frame.push_back((uint8_t) CEC_OPCODE_MENU_STATUS);
-  frame.push_back(bActive ? (uint8_t) CEC_MENU_STATE_ACTIVATED : (uint8_t) CEC_MENU_STATE_DEACTIVATED);
-  Transmit(frame);
+  cec_command command = cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_MENU_STATUS);
+  command.parameters.push_back(bActive ? (uint8_t) CEC_MENU_STATE_ACTIVATED : (uint8_t) CEC_MENU_STATE_DEACTIVATED);
+
+  Transmit(command);
 }
 
 void CCECProcessor::ReportVendorID(cec_logical_address address /* = CECDEVICE_TV */)
@@ -330,54 +285,40 @@ void CCECProcessor::ReportVendorID(cec_logical_address address /* = CECDEVICE_TV
 
 void CCECProcessor::ReportOSDName(cec_logical_address address /* = CECDEVICE_TV */)
 {
-  cec_frame frame;
-  frame.clear();
-
   const char *osdname = m_strDeviceName.c_str();
   CStdString strLog;
   strLog.Format("<< reporting OSD name as %s", osdname);
   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
-  frame.push_back(GetSourceDestination(address));
-  frame.push_back((uint8_t) CEC_OPCODE_SET_OSD_NAME);
 
-  for (unsigned int i = 0; i < strlen(osdname); i++)
-    frame.push_back(osdname[i]);
+  cec_command command = cec_command::format(m_iLogicalAddress, address, CEC_OPCODE_SET_OSD_NAME);
+  for (unsigned int iPtr = 0; iPtr < strlen(osdname); iPtr++)
+    command.parameters.push_back(osdname[iPtr]);
 
-  Transmit(frame);
+  Transmit(command);
 }
 
 void CCECProcessor::ReportPhysicalAddress(void)
 {
-  cec_frame frame;
-  frame.clear();
-
   CStdString strLog;
   strLog.Format("<< reporting physical address as %04x", m_physicaladdress);
   m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
-  frame.push_back(GetSourceDestination(CECDEVICE_BROADCAST));
-  frame.push_back((uint8_t) CEC_OPCODE_REPORT_PHYSICAL_ADDRESS);
-  frame.push_back((uint8_t) ((m_physicaladdress >> 8) & 0xFF));
-  frame.push_back((uint8_t) (m_physicaladdress & 0xFF));
-  frame.push_back((uint8_t) CEC_DEVICE_TYPE_PLAYBACK_DEVICE);
-  Transmit(frame);
+
+  cec_command command = cec_command::format(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));
+
+  Transmit(command);
 }
 
 void CCECProcessor::BroadcastActiveSource(void)
 {
-  cec_frame frame;
-  frame.clear();
-
   m_controller->AddLog(CEC_LOG_NOTICE, "<< broadcasting active source");
-  frame.push_back(GetSourceDestination(CECDEVICE_BROADCAST));
-  frame.push_back((uint8_t) CEC_OPCODE_ACTIVE_SOURCE);
-  frame.push_back((uint8_t) ((m_physicaladdress >> 8) & 0xFF));
-  frame.push_back((uint8_t) (m_physicaladdress & 0xFF));
-  Transmit(frame);
-}
 
-uint8_t CCECProcessor::GetSourceDestination(cec_logical_address destination /* = CECDEVICE_BROADCAST */) const
-{
-  return ((uint8_t)m_iLogicalAddress << 4) + (uint8_t)destination;
+  cec_command command = cec_command::format(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));
+
+  Transmit(command);
 }
 
 bool CCECProcessor::WaitForAck(bool *bError, uint32_t iTimeout /* = 1000 */)
@@ -390,7 +331,7 @@ bool CCECProcessor::WaitForAck(bool *bError, uint32_t iTimeout /* = 1000 */)
 
   while (!bGotAck && !*bError && (iTimeout == 0 || iNow < iTargetTime))
   {
-    cec_frame msg;
+    cec_adapter_message msg;
     msg.clear();
 
     if (!m_communication->Read(msg, iTimeout > 0 ? iTargetTime - iNow : 1000))
@@ -399,9 +340,7 @@ bool CCECProcessor::WaitForAck(bool *bError, uint32_t iTimeout /* = 1000 */)
       continue;
     }
 
-    uint8_t iCode = msg[0] & ~(MSGCODE_FRAME_EOM | MSGCODE_FRAME_ACK);
-
-    switch (iCode)
+    switch (msg.message())
     {
     case MSGCODE_COMMAND_ACCEPTED:
       m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
@@ -445,7 +384,7 @@ bool CCECProcessor::WaitForAck(bool *bError, uint32_t iTimeout /* = 1000 */)
   return bGotAck && !*bError;
 }
 
-bool CCECProcessor::ParseMessage(cec_frame &msg)
+bool CCECProcessor::ParseMessage(cec_adapter_message &msg)
 {
   bool bReturn(false);
 
@@ -484,8 +423,10 @@ bool CCECProcessor::ParseMessage(cec_frame &msg)
       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.push_back(msg[1]);
+        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());
     }
@@ -511,9 +452,9 @@ bool CCECProcessor::ParseMessage(cec_frame &msg)
   return bReturn;
 }
 
-void CCECProcessor::ParseVendorId(cec_logical_address device, cec_frame data)
+void CCECProcessor::ParseVendorId(cec_logical_address device, const cec_datapacket &data)
 {
-  if (data.size() < 3)
+  if (data.size < 3)
   {
     m_controller->AddLog(CEC_LOG_WARNING, "invalid vendor ID received");
     return;
@@ -524,100 +465,89 @@ void CCECProcessor::ParseVendorId(cec_logical_address device, cec_frame data)
                         (uint64_t)data[2];
 
   m_vendorIds[(uint8_t)device]     = iVendorId;
-  m_vendorClasses[(uint8_t)device] = data.size() >= 4 ? data[3] : 0;
+  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());
 }
 
-void CCECProcessor::ParseCurrentFrame(cec_frame &frame)
+void CCECProcessor::ParseCommand(cec_command &command)
 {
-  uint8_t initiator = frame[0] >> 4;
-  uint8_t destination = frame[0] & 0xF;
-
   CStdString dataStr;
-  dataStr.Format(">> received frame: initiator: %u destination: %u", initiator, destination);
-
-  if (frame.size() > 1)
+  dataStr.Format(">> received frame: initiator: %u destination: %u", command.initiator, command.destination);
+  if (command.parameters.size > 1)
   {
     dataStr += " data:";
-    for (unsigned int i = 1; i < frame.size(); i++)
-      dataStr.AppendFormat(" %02x", frame[i]);
+    for (unsigned int iPtr = 0; iPtr < command.parameters.size; iPtr++)
+      dataStr.AppendFormat(" %02x", command.parameters[iPtr]);
   }
   m_controller->AddLog(CEC_LOG_DEBUG, dataStr.c_str());
 
-  if (frame.size() <= 1)
-    return;
-
-  cec_opcode opCode = (cec_opcode) frame[1];
-  if (destination == (uint16_t) m_iLogicalAddress)
+  if (command.destination == m_iLogicalAddress)
   {
-    switch(opCode)
+    switch(command.opcode)
     {
     case CEC_OPCODE_GIVE_PHYSICAL_ADDRESS:
       ReportPhysicalAddress();
       break;
     case CEC_OPCODE_GIVE_OSD_NAME:
-      ReportOSDName((cec_logical_address)initiator);
+      ReportOSDName(command.initiator);
       break;
     case CEC_OPCODE_GIVE_DEVICE_VENDOR_ID:
-      ReportVendorID((cec_logical_address)initiator);
+      ReportVendorID(command.initiator);
       break;
     case CEC_OPCODE_VENDOR_COMMAND_WITH_ID:
-      frame.shift(2);
-      ParseVendorId((cec_logical_address)initiator, frame);
-      TransmitAbort((cec_logical_address)initiator, 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((cec_logical_address)initiator, CEC_OPCODE_GIVE_DECK_STATUS);
+      TransmitAbort(command.initiator, CEC_OPCODE_GIVE_DECK_STATUS);
       break;
     case CEC_OPCODE_MENU_REQUEST:
-      frame.shift(2);
-      if (frame[0] == CEC_MENU_REQUEST_TYPE_QUERY)
-        ReportMenuState((cec_logical_address)initiator);
+      if (command.parameters[0] == CEC_MENU_REQUEST_TYPE_QUERY)
+        ReportMenuState(command.initiator);
       break;
     case CEC_OPCODE_GIVE_DEVICE_POWER_STATUS:
-      ReportPowerState((cec_logical_address)initiator);
+      ReportPowerState(command.initiator);
       SetActiveView();
       break;
     case CEC_OPCODE_GET_CEC_VERSION:
-      ReportCECVersion((cec_logical_address)initiator);
+      ReportCECVersion(command.initiator);
       break;
     case CEC_OPCODE_USER_CONTROL_PRESSED:
-      if (frame.size() > 2)
+      if (command.parameters.size > 0)
       {
         m_controller->AddKey();
 
-        if (frame[2] <= CEC_USER_CONTROL_CODE_MAX)
-          m_controller->SetCurrentButton((cec_user_control_code) frame[2]);
+        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;
     default:
-      frame.shift(2);
-      m_controller->AddCommand((cec_logical_address) initiator, (cec_logical_address) destination, opCode, &frame);
+      m_controller->AddCommand(command);
       break;
     }
   }
-  else if (destination == (uint8_t) CECDEVICE_BROADCAST)
+  else if (command.destination == CECDEVICE_BROADCAST)
   {
     CStdString strLog;
-    if (opCode == CEC_OPCODE_REQUEST_ACTIVE_SOURCE)
+    if (command.opcode == CEC_OPCODE_REQUEST_ACTIVE_SOURCE)
     {
-      strLog.Format(">> %i requests active source", initiator);
+      strLog.Format(">> %i requests active source", (uint8_t) command.initiator);
       m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
       BroadcastActiveSource();
     }
-    else if (opCode == CEC_OPCODE_SET_STREAM_PATH)
+    else if (command.opcode == CEC_OPCODE_SET_STREAM_PATH)
     {
-      if (frame.size() >= 4)
+      if (command.parameters.size >= 2)
       {
-        int streamaddr = ((int)frame[2] << 8) | ((int)frame[3]);
-        strLog.Format(">> %i requests stream path from physical address %04x", initiator, streamaddr);
+        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();
@@ -625,15 +555,13 @@ void CCECProcessor::ParseCurrentFrame(cec_frame &frame)
     }
     else
     {
-      cec_frame params = frame;
-      frame.shift(2);
-      m_controller->AddCommand((cec_logical_address) initiator, (cec_logical_address) destination, opCode, &params);
+      m_controller->AddCommand(command);
     }
   }
   else
   {
     CStdString strLog;
-    strLog.Format("ignoring frame: destination: %u != %u", destination, (uint16_t)m_iLogicalAddress);
+    strLog.Format("ignoring frame: destination: %u != %u", command.destination, (uint8_t)m_iLogicalAddress);
     m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
   }
 }