cec: protect the SL state vars with a mutex
[deb_libcec.git] / src / lib / implementations / SLCommandHandler.cpp
index d0c87d69fa8382a1f026a23579667192d9418e92..e3259219b90141c611afb43dd1a9b9318da74eda 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the libCEC(R) library.
  *
- * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited.  All rights reserved.
+ * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited.  All rights reserved.
  * libCEC(R) is an original work, containing original code.
  *
  * libCEC(R) is a trademark of Pulse-Eight Limited.
 #include "../devices/CECBusDevice.h"
 #include "../devices/CECPlaybackDevice.h"
 #include "../CECProcessor.h"
-#include "../platform/timeutils.h"
+#include "../LibCEC.h"
 
 using namespace CEC;
+using namespace PLATFORM;
 
 #define SL_COMMAND_UNKNOWN_01           0x01
 #define SL_COMMAND_UNKNOWN_02           0x02
@@ -45,26 +46,118 @@ using namespace CEC;
 #define SL_COMMAND_REQUEST_POWER_STATUS 0xa0
 #define SL_COMMAND_POWER_ON             0x03
 #define SL_COMMAND_CONNECT_REQUEST      0x04
-#define SL_COMMAND_CONNECT_ACCEPT       0x05
+#define SL_COMMAND_SET_DEVICE_MODE      0x05
 
 CSLCommandHandler::CSLCommandHandler(CCECBusDevice *busDevice) :
     CCECCommandHandler(busDevice),
-    m_bAwaitingReceiveFailed(false),
     m_bSLEnabled(false),
+    m_bActiveSourceSent(false),
     m_bVendorIdSent(false)
 {
+  m_vendorId = CEC_VENDOR_LG;
+  CCECBusDevice *primary = m_processor->GetPrimaryDevice();
+
+  /* imitate LG devices */
+  if (primary && m_busDevice->GetLogicalAddress() != primary->GetLogicalAddress())
+    primary->SetVendorId(CEC_VENDOR_LG);
+
+  /* LG TVs don't always reply to CEC version requests, so just set it to 1.3a */
+  if (m_busDevice->GetLogicalAddress() == CECDEVICE_TV)
+    m_busDevice->SetCecVersion(CEC_VERSION_1_3A);
+
+  /* LG devices always return "korean" as language */
+  cec_menu_language lang;
+  lang.device = m_busDevice->GetLogicalAddress();
+  snprintf(lang.language, 4, "eng");
+  m_busDevice->SetMenuLanguage(lang);
 }
 
-void CSLCommandHandler::SetLGDeckStatus(void)
+bool CSLCommandHandler::InitHandler(void)
 {
-  /* LG TVs only route keypresses when the deck status is set to 0x20 */
-  CCECBusDevice *device = m_processor->GetDeviceByType(CEC_DEVICE_TYPE_PLAYBACK_DEVICE);
-  if (device)
-    ((CCECPlaybackDevice *)device)->SetDeckStatus(CEC_DECK_INFO_OTHER_STATUS_LG);
+  if (m_bHandlerInited)
+    return true;
+  m_bHandlerInited = true;
 
-  device = m_processor->GetDeviceByType(CEC_DEVICE_TYPE_RECORDING_DEVICE);
-  if (device)
-    ((CCECPlaybackDevice *)device)->SetDeckStatus(CEC_DECK_INFO_OTHER_STATUS_LG);
+  CCECBusDevice *primary = m_processor->GetPrimaryDevice();
+  if (m_busDevice->GetLogicalAddress() != primary->GetLogicalAddress())
+  {
+    /* start as 'in transition standby->on' */
+    primary->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
+    primary->TransmitPowerState(CECDEVICE_TV);
+  }
+
+  return true;
+}
+
+bool CSLCommandHandler::ActivateSource(void)
+{
+  /* reply with LGs vendor id */
+  bool bSendVendorId(false);
+  {
+    CLockObject lock(m_SLMutex);
+    bSendVendorId = !m_bVendorIdSent;
+    m_bVendorIdSent = true;
+  }
+  if (bSendVendorId)
+    m_processor->GetPrimaryDevice()->TransmitVendorID(CECDEVICE_BROADCAST, false);
+
+  if (!SLInitialised())
+  {
+    CLibCEC::AddLog(CEC_LOG_NOTICE, "not activating the source until SL has been initialised");
+    return true;
+  }
+
+  {
+    CLockObject lock(m_SLMutex);
+    if (m_bActiveSourceSent)
+      return true;
+    m_bActiveSourceSent = true;
+  }
+
+  CCECBusDevice *primary = m_processor->GetPrimaryDevice();
+  primary->SetActiveSource();
+  primary->TransmitActiveSource();
+  return true;
+}
+
+bool CSLCommandHandler::HandleActiveSource(const cec_command &command)
+{
+  if (command.parameters.size == 2)
+  {
+    uint16_t iAddress = ((uint16_t)command.parameters[0] << 8) | ((uint16_t)command.parameters[1]);
+    if (iAddress != m_busDevice->GetPhysicalAddress(false))
+    {
+      ResetSLState();
+    }
+    return m_processor->SetActiveSource(iAddress);
+  }
+
+  return true;
+}
+
+bool CSLCommandHandler::HandleDeviceVendorId(const cec_command &command)
+{
+  SetVendorId(command);
+
+  if (!SLInitialised())
+  {
+    cec_command response;
+    cec_command::Format(response, m_processor->GetLogicalAddress(), command.initiator, CEC_OPCODE_FEATURE_ABORT);
+    return Transmit(response);
+  }
+  return true;
+}
+
+bool CSLCommandHandler::HandleGivePhysicalAddress(const cec_command &command)
+{
+  if (m_processor->IsRunning() && m_busDevice->MyLogicalAddressContains(command.destination))
+  {
+    CCECBusDevice *device = GetDevice(command.destination);
+    if (device)
+      return device->TransmitPhysicalAddress(); // only the physical address, don't send image view on
+  }
+
+  return false;
 }
 
 bool CSLCommandHandler::HandleVendorCommand(const cec_command &command)
@@ -99,6 +192,7 @@ bool CSLCommandHandler::HandleVendorCommand(const cec_command &command)
 
 void CSLCommandHandler::HandleVendorCommand01(const cec_command &command)
 {
+  m_processor->GetPrimaryDevice()->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
   TransmitVendorCommand0205(command.destination, command.initiator);
 }
 
@@ -109,17 +203,7 @@ void CSLCommandHandler::TransmitVendorCommand0205(const cec_logical_address iSou
   response.PushBack(SL_COMMAND_UNKNOWN_02);
   response.PushBack(SL_COMMAND_UNKNOWN_03);
 
-  Transmit(response);
-}
-
-void CSLCommandHandler::TransmitVendorCommand05(const cec_logical_address iSource, const cec_logical_address iDestination)
-{
-  m_bSLEnabled = true;
-  cec_command response;
-  cec_command::Format(response, iSource, iDestination, CEC_OPCODE_VENDOR_COMMAND);
-  response.PushBack(SL_COMMAND_CONNECT_ACCEPT);
-  response.PushBack((uint8_t)iSource);
-  Transmit(response);
+  Transmit(response, false);
 }
 
 void CSLCommandHandler::HandleVendorCommandPowerOn(const cec_command &command)
@@ -127,24 +211,16 @@ void CSLCommandHandler::HandleVendorCommandPowerOn(const cec_command &command)
   CCECBusDevice *device = m_processor->GetPrimaryDevice();
   if (device)
   {
-    m_bSLEnabled = true;
-    SetLGDeckStatus();
-    device->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
+    SetSLInitialised();
+
+    device->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON); //XXX
     device->TransmitPowerState(command.initiator);
-    device->TransmitVendorID(command.initiator);
-    TransmitPowerOn(device->GetLogicalAddress(), command.initiator);
-  }
-}
+    device->SetPowerStatus(CEC_POWER_STATUS_ON);
 
-void CSLCommandHandler::HandleVendorCommandSLConnect(const cec_command &command)
-{
-  m_bSLEnabled = true;
-  m_processor->m_busDevices[command.initiator]->SetActiveSource();
-  m_processor->m_busDevices[command.destination]->TransmitActiveSource();
-  TransmitVendorCommand05(command.destination, command.initiator);
-  SetLGDeckStatus();
+    device->SetActiveSource();
+    TransmitImageViewOn(device->GetLogicalAddress(), command.initiator);
+  }
 }
-
 void CSLCommandHandler::HandleVendorCommandPowerOnStatus(const cec_command &command)
 {
   if (command.destination != CECDEVICE_BROADCAST)
@@ -156,128 +232,148 @@ void CSLCommandHandler::HandleVendorCommandPowerOnStatus(const cec_command &comm
   }
 }
 
-bool CSLCommandHandler::TransmitLGVendorId(const cec_logical_address iInitiator, const cec_logical_address iDestination)
+void CSLCommandHandler::HandleVendorCommandSLConnect(const cec_command &command)
 {
-  cec_command response;
-  cec_command::Format(response, iInitiator, iDestination, CEC_OPCODE_DEVICE_VENDOR_ID);
-  response.parameters.PushBack((uint8_t) (((uint64_t)CEC_VENDOR_LG >> 16) & 0xFF));
-  response.parameters.PushBack((uint8_t) (((uint64_t)CEC_VENDOR_LG >> 8) & 0xFF));
-  response.parameters.PushBack((uint8_t) ((uint64_t)CEC_VENDOR_LG & 0xFF));
-
-  Transmit(response);
+  SetSLInitialised();
+  TransmitVendorCommandSetDeviceMode(m_processor->GetLogicalAddress(), command.initiator, CEC_DEVICE_TYPE_RECORDING_DEVICE);
 
-  cec_command::Format(response, iInitiator, iDestination, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
-  Transmit(response);
-
-  return true;
+  ActivateSource();
 }
 
-bool CSLCommandHandler::HandleCommand(const cec_command &command)
+void CSLCommandHandler::TransmitVendorCommandSetDeviceMode(const cec_logical_address iSource, const cec_logical_address iDestination, const cec_device_type type)
 {
-  bool bHandled(false);
+  cec_command response;
+  cec_command::Format(response, iSource, iDestination, CEC_OPCODE_VENDOR_COMMAND);
+  response.PushBack(SL_COMMAND_SET_DEVICE_MODE);
+  response.PushBack((uint8_t)type);
+  Transmit(response, false);
+}
 
-  if (m_processor->IsStarted() && (m_busDevice->MyLogicalAddressContains(command.destination) ||
-      command.destination == CECDEVICE_BROADCAST))
+bool CSLCommandHandler::HandleGiveDeckStatus(const cec_command &command)
+{
+  if (m_processor->IsRunning() && m_busDevice->MyLogicalAddressContains(command.destination))
   {
-    switch(command.opcode)
+    CCECBusDevice *device = GetDevice(command.destination);
+    if (device && (device->GetType() == CEC_DEVICE_TYPE_PLAYBACK_DEVICE || device->GetType() == CEC_DEVICE_TYPE_RECORDING_DEVICE))
     {
-    case CEC_OPCODE_VENDOR_COMMAND:
-      bHandled = HandleVendorCommand(command);
-      break;
-    case CEC_OPCODE_FEATURE_ABORT:
+      if (command.parameters.size > 0)
       {
-        if (!m_bVendorIdSent)
+        if (command.parameters[0] == CEC_STATUS_REQUEST_ON)
+        {
+          ((CCECPlaybackDevice *) device)->SetDeckStatus(CEC_DECK_INFO_STOP);
+          return ((CCECPlaybackDevice *) device)->TransmitDeckStatus(command.initiator) &&
+              device->TransmitImageViewOn() &&
+              device->TransmitPhysicalAddress();
+        }
+        else if (command.parameters[0] == CEC_STATUS_REQUEST_ONCE)
         {
-          m_bVendorIdSent = true;
-          TransmitLGVendorId(m_processor->GetLogicalAddresses().primary, CECDEVICE_BROADCAST);
-          m_processor->GetPrimaryDevice()->SetPowerStatus(CEC_POWER_STATUS_STANDBY);
+          ((CCECPlaybackDevice *) device)->SetDeckStatus(CEC_DECK_INFO_OTHER_STATUS_LG);
+          return ((CCECPlaybackDevice *) device)->TransmitDeckStatus(command.initiator);
         }
       }
-      bHandled = true;
-      break;
-    default:
-      break;
     }
+    return CCECCommandHandler::HandleGiveDeckStatus(command);
   }
 
-  if (!bHandled)
-    bHandled = CCECCommandHandler::HandleCommand(command);
-
-  return bHandled;
-}
-
-void CSLCommandHandler::HandlePoll(const cec_logical_address iInitiator, const cec_logical_address iDestination)
-{
-  CCECCommandHandler::HandlePoll(iInitiator, iDestination);
-  m_bAwaitingReceiveFailed = true;
+  return false;
 }
 
-bool CSLCommandHandler::HandleReceiveFailed(void)
+bool CSLCommandHandler::HandleGiveDevicePowerStatus(const cec_command &command)
 {
-  if (m_bAwaitingReceiveFailed)
+  bool bReturn(false);
+  if (m_processor->IsRunning() && m_busDevice->MyLogicalAddressContains(command.destination))
   {
-    m_bAwaitingReceiveFailed = false;
-    return false;
+    CCECBusDevice *device = GetDevice(command.destination);
+    if (device && device->GetPowerStatus(false) != CEC_POWER_STATUS_ON)
+    {
+      bReturn = device->TransmitPowerState(command.initiator);
+      device->SetPowerStatus(CEC_POWER_STATUS_ON);
+    }
+    else
+    {
+      if (!ActiveSourceSent())
+      {
+        device->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
+        bReturn = device->TransmitPowerState(command.initiator);
+        ActivateSource();
+      }
+      else if (m_resetPowerState.IsSet() && m_resetPowerState.TimeLeft() > 0)
+      {
+        /* assume that we've bugged out */
+        CLibCEC::AddLog(CEC_LOG_NOTICE, "LG seems to have bugged out. resetting to 'in transition standby to on'");
+        {
+          CLockObject lock(m_SLMutex);
+          m_bActiveSourceSent = false;
+        }
+        device->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
+        bReturn = device->TransmitPowerState(command.initiator);
+        device->SetPowerStatus(CEC_POWER_STATUS_ON);
+        m_resetPowerState.Init(5000);
+      }
+      else
+      {
+        bReturn = device->TransmitPowerState(command.initiator);
+        m_resetPowerState.Init(5000);
+      }
+    }
   }
 
-  return true;
+  return bReturn;
 }
 
-bool CSLCommandHandler::InitHandler(void)
+bool CSLCommandHandler::HandleRequestActiveSource(const cec_command &command)
 {
-  if (m_bHandlerInited)
+  if (m_processor->IsRunning())
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %i requests active source, ignored", (uint8_t) command.initiator);
     return true;
-  m_bHandlerInited = true;
-
-  CCECBusDevice *primary = m_processor->GetPrimaryDevice();
-
-  /* imitate LG devices */
-  if (m_busDevice->GetLogicalAddress() != primary->GetLogicalAddress())
-    primary->SetVendorId(CEC_VENDOR_LG, false);
+  }
+  return false;
+}
 
-  /* LG TVs don't always reply to CEC version requests, so just set it to 1.3a */
-  if (m_busDevice->GetLogicalAddress() == CECDEVICE_TV)
-    m_busDevice->SetCecVersion(CEC_VERSION_1_3A);
+bool CSLCommandHandler::HandleFeatureAbort(const cec_command &command)
+{
+  if (command.parameters.size == 0 && m_processor->GetPrimaryDevice()->GetPowerStatus() == CEC_POWER_STATUS_ON && !SLInitialised())
+  {
+    m_processor->GetPrimaryDevice()->TransmitPowerState(command.initiator);
+    m_processor->GetPrimaryDevice()->TransmitVendorID(CECDEVICE_BROADCAST, false);
+  }
 
-  /* LG devices always return "korean" as language */
-  cec_menu_language lang;
-  lang.device = m_busDevice->GetLogicalAddress();
-  snprintf(lang.language, 4, "eng");
-  m_busDevice->SetMenuLanguage(lang);
+  return CCECCommandHandler::HandleFeatureAbort(command);
+}
 
-  /* reply with LGs vendor id */
-  if (m_busDevice->GetLogicalAddress() != primary->GetLogicalAddress())
-    primary->TransmitVendorID(CECDEVICE_TV, false);
+bool CSLCommandHandler::HandleStandby(const cec_command &command)
+{
+  if (command.initiator == CECDEVICE_TV)
+    ResetSLState();
 
-  return true;
+  return CCECCommandHandler::HandleStandby(command);
 }
 
-bool CSLCommandHandler::TransmitPowerOn(const cec_logical_address iInitiator, const cec_logical_address iDestination)
+void CSLCommandHandler::ResetSLState(void)
 {
-  if (iDestination != CECDEVICE_BROADCAST &&
-      iDestination != CECDEVICE_TV &&
-      m_processor->m_busDevices[iDestination]->GetVendorId(false) == CEC_VENDOR_LG)
-  {
-    cec_command command;
-    cec_command::Format(command, iInitiator, iDestination, CEC_OPCODE_VENDOR_COMMAND);
-    command.parameters.PushBack((uint8_t)SL_COMMAND_POWER_ON);
-    command.parameters.PushBack(0x00);
-    return Transmit(command);
-  }
+  CLibCEC::AddLog(CEC_LOG_NOTICE, "resetting SL initialised state");
+  CLockObject lock(m_SLMutex);
+  m_bSLEnabled = false;
+  m_bActiveSourceSent = false;
+  m_processor->GetPrimaryDevice()->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
+}
 
-  return CCECCommandHandler::TransmitImageViewOn(iInitiator, iDestination);
+void CSLCommandHandler::SetSLInitialised(void)
+{
+  CLibCEC::AddLog(CEC_LOG_NOTICE, "SL initialised");
+  CLockObject lock(m_SLMutex);
+  m_bSLEnabled = true;
 }
 
-bool CSLCommandHandler::HandleActiveSource(const cec_command &command)
+bool CSLCommandHandler::SLInitialised(void)
 {
-  if (command.parameters.size == 2)
-  {
-    uint16_t iAddress = ((uint16_t)command.parameters[0] << 8) | ((uint16_t)command.parameters[1]);
-    if (iAddress == 0)
-      return m_processor->GetPrimaryDevice()->TransmitPhysicalAddress();
-    else
-      return m_processor->SetActiveSource(iAddress);
-  }
+  CLockObject lock(m_SLMutex);
+  return m_bSLEnabled;
+}
 
-  return true;
+bool CSLCommandHandler::ActiveSourceSent(void)
+{
+  CLockObject lock(m_SLMutex);
+  return m_bActiveSourceSent;
 }