cec: persist settings directly when they're changed, only persist settings that actua...
[deb_libcec.git] / src / lib / adapter / USBCECAdapterCommands.cpp
index 38e19507b39b31bc37cfe3855a3259ea27b27f56..69a263267e568ba8b23b536749f1a383da688494 100644 (file)
 using namespace CEC;
 using namespace PLATFORM;
 
+CUSBCECAdapterCommands::CUSBCECAdapterCommands(CUSBCECAdapterCommunication *comm) :
+    m_comm(comm),
+    m_bSettingsRetrieved(false),
+    m_bSettingAutoEnabled(false),
+    m_settingCecVersion(CEC_VERSION_UNKNOWN),
+    m_iSettingLAMask(0),
+    m_bNeedsWrite(false)
+{
+  m_persistedConfiguration.Clear();
+}
+
 cec_datapacket CUSBCECAdapterCommands::RequestSetting(cec_adapter_messagecode msgCode)
 {
   cec_datapacket retVal;
@@ -56,15 +67,15 @@ cec_datapacket CUSBCECAdapterCommands::RequestSetting(cec_adapter_messagecode ms
 
 uint16_t CUSBCECAdapterCommands::RequestFirmwareVersion(void)
 {
-  m_iFirmwareVersion = CEC_FW_VERSION_UNKNOWN;
+  m_persistedConfiguration.iFirmwareVersion = CEC_FW_VERSION_UNKNOWN;
   unsigned int iFwVersionTry(0);
 
-  while (m_iFirmwareVersion == CEC_FW_VERSION_UNKNOWN && iFwVersionTry++ < 3)
+  while (m_persistedConfiguration.iFirmwareVersion == CEC_FW_VERSION_UNKNOWN && iFwVersionTry++ < 3)
   {
     CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting the firmware version");
     cec_datapacket response = RequestSetting(MSGCODE_FIRMWARE_VERSION);
     if (response.size == 2)
-      m_iFirmwareVersion = (response[0] << 8 | response[1]);
+      m_persistedConfiguration.iFirmwareVersion = (response[0] << 8 | response[1]);
     else
     {
       CLibCEC::AddLog(CEC_LOG_WARNING, "the adapter did not respond with a correct firmware version (try %d)", iFwVersionTry);
@@ -72,211 +83,321 @@ uint16_t CUSBCECAdapterCommands::RequestFirmwareVersion(void)
     }
   }
 
-  if (m_iFirmwareVersion == CEC_FW_VERSION_UNKNOWN)
+  if (m_persistedConfiguration.iFirmwareVersion == CEC_FW_VERSION_UNKNOWN)
   {
     CLibCEC::AddLog(CEC_LOG_DEBUG, "defaulting to firmware version 1");
-    m_iFirmwareVersion = 1;
+    m_persistedConfiguration.iFirmwareVersion = 1;
   }
 
-  return m_iFirmwareVersion;
+  return m_persistedConfiguration.iFirmwareVersion;
 }
 
-bool CUSBCECAdapterCommands::RequestSettingAutoEnabled(bool &enabled)
+bool CUSBCECAdapterCommands::RequestSettingAutoEnabled(void)
 {
   CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting autonomous mode setting");
 
   cec_datapacket response = RequestSetting(MSGCODE_GET_AUTO_ENABLED);
   if (response.size == 1)
   {
-    enabled = response[0] == 1;
+    m_bSettingAutoEnabled = response[0] == 1;
     return true;
   }
   return false;
 }
 
-bool CUSBCECAdapterCommands::RequestSettingCECVersion(cec_version &version)
+bool CUSBCECAdapterCommands::RequestSettingCECVersion(void)
 {
   CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting CEC version setting");
 
   cec_datapacket response = RequestSetting(MSGCODE_GET_HDMI_VERSION);
   if (response.size == 1)
   {
-    version = (cec_version)response[0];
+    m_settingCecVersion = (cec_version)response[0];
     return true;
   }
   return false;
 }
 
-bool CUSBCECAdapterCommands::RequestSettingDefaultLogicalAddress(cec_logical_address &address)
+bool CUSBCECAdapterCommands::RequestSettingDefaultLogicalAddress(void)
 {
   CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting default logical address setting");
 
   cec_datapacket response = RequestSetting(MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS);
   if (response.size == 1)
   {
-    address = (cec_logical_address)response[0];
+    m_persistedConfiguration.logicalAddresses.primary = (cec_logical_address)response[0];
     return true;
   }
   return false;
 }
 
-bool CUSBCECAdapterCommands::RequestSettingDeviceType(cec_device_type &value)
+bool CUSBCECAdapterCommands::RequestSettingDeviceType(void)
 {
   CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting device type setting");
+  m_persistedConfiguration.deviceTypes.Clear();
 
   cec_datapacket response = RequestSetting(MSGCODE_GET_DEVICE_TYPE);
   if (response.size == 1)
   {
-    value = (cec_device_type)response[0];
+    m_persistedConfiguration.deviceTypes.Add((cec_device_type)response[0]);
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "using persisted device type setting %s", CLibCEC::GetInstance()->ToString((cec_device_type)response[0]));
     return true;
   }
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "no persisted device type setting");
   return false;
 }
 
-bool CUSBCECAdapterCommands::RequestSettingLogicalAddressMask(uint16_t &iMask)
+bool CUSBCECAdapterCommands::RequestSettingLogicalAddressMask(void)
 {
   CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting logical address mask setting");
 
   cec_datapacket response = RequestSetting(MSGCODE_GET_LOGICAL_ADDRESS_MASK);
   if (response.size == 2)
   {
-    iMask = ((uint16_t)response[0] << 8) | ((uint16_t)response[1]);
+    m_iSettingLAMask = ((uint16_t)response[0] << 8) | ((uint16_t)response[1]);
     return true;
   }
   return false;
 }
 
-bool CUSBCECAdapterCommands::RequestSettingOSDName(CStdString &strOSDName)
+bool CUSBCECAdapterCommands::RequestSettingOSDName(void)
 {
   CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting OSD name setting");
 
+  memset(m_persistedConfiguration.strDeviceName, 0, 13);
   cec_datapacket response = RequestSetting(MSGCODE_GET_OSD_NAME);
   if (response.size == 0)
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "no persisted device name setting");
     return false;
+  }
 
   char buf[14];
   for (uint8_t iPtr = 0; iPtr < response.size && iPtr < 13; iPtr++)
     buf[iPtr] = (char)response[iPtr];
   buf[response.size] = 0;
 
-  strOSDName.Format("%s", buf);
+  snprintf(m_persistedConfiguration.strDeviceName, 13, "%s", buf);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "using persisted device name setting %s", buf);
   return true;
 }
 
-bool CUSBCECAdapterCommands::RequestSettingPhysicalAddress(uint16_t &iPhysicalAddress)
+bool CUSBCECAdapterCommands::RequestSettingPhysicalAddress(void)
 {
   CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting physical address setting");
 
   cec_datapacket response = RequestSetting(MSGCODE_GET_PHYSICAL_ADDRESS);
   if (response.size == 2)
   {
-    iPhysicalAddress = ((uint16_t)response[0] << 8) | ((uint16_t)response[1]);
+    m_persistedConfiguration.iPhysicalAddress = ((uint16_t)response[0] << 8) | ((uint16_t)response[1]);
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "using persisted physical address setting %4x", m_persistedConfiguration.iPhysicalAddress);
     return true;
   }
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "no persisted physical address setting");
   return false;
 }
 
 bool CUSBCECAdapterCommands::SetSettingAutoEnabled(bool enabled)
 {
+  bool bReturn(true);
+
+  /* check whether this value was changed */
+  if (m_bSettingAutoEnabled == enabled)
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "autonomous mode setting unchanged (%s)", enabled ? "on" : "off");
+    return bReturn;
+  }
+
+  m_bNeedsWrite = true;
   CLibCEC::AddLog(CEC_LOG_DEBUG, "turning autonomous mode %s", enabled ? "on" : "off");
 
   CCECAdapterMessage params;
   params.PushEscaped(enabled ? 1 : 0);
   CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_AUTO_ENABLED, params);
-  bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
   delete message;
+
+  if (bReturn)
+    m_bSettingAutoEnabled = enabled;
+
   return bReturn;
 }
 
 bool CUSBCECAdapterCommands::SetSettingDeviceType(cec_device_type type)
 {
-  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the device type to %1X", (uint8_t)type);
+  bool bReturn(true);
+
+  /* check whether this value was changed */
+  if (m_persistedConfiguration.deviceTypes.types[0] == type)
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "device type setting unchanged (%X)", (uint8_t)type);
+    return bReturn;
+  }
+
+  m_bNeedsWrite = true;
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the device type to %X", (uint8_t)type);
 
   CCECAdapterMessage params;
   params.PushEscaped((uint8_t)type);
   CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_DEVICE_TYPE, params);
-  bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
   delete message;
+
   return bReturn;
 }
 
 bool CUSBCECAdapterCommands::SetSettingDefaultLogicalAddress(cec_logical_address address)
 {
-  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the default logical address to %1X", address);
+  bool bReturn(true);
+
+  /* check whether this value was changed */
+  if (m_persistedConfiguration.logicalAddresses.primary == address)
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "logical address setting unchanged (%X)", (uint8_t)address);
+    return bReturn;
+  }
+
+  m_bNeedsWrite = true;
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the default logical address to %X", (uint8_t)address);
 
   CCECAdapterMessage params;
   params.PushEscaped((uint8_t)address);
   CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS, params);
-  bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
   delete message;
+
+  if (bReturn)
+    m_persistedConfiguration.logicalAddresses.primary = address;
+
   return bReturn;
 }
 
 bool CUSBCECAdapterCommands::SetSettingLogicalAddressMask(uint16_t iMask)
 {
+  bool bReturn(true);
+
+  /* check whether this value was changed */
+  if (m_iSettingLAMask == iMask)
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "logical address mask setting unchanged (%2X)", iMask);
+    return bReturn;
+  }
+
+  m_bNeedsWrite = true;
   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the logical address mask to %2X", iMask);
 
   CCECAdapterMessage params;
   params.PushEscaped(iMask >> 8);
   params.PushEscaped((uint8_t)iMask);
   CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_LOGICAL_ADDRESS_MASK, params);
-  bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
   delete message;
+
+  if (bReturn)
+    m_iSettingLAMask = iMask;
+
   return bReturn;
 }
 
 bool CUSBCECAdapterCommands::SetSettingPhysicalAddress(uint16_t iPhysicalAddress)
 {
+  bool bReturn(true);
+
+  /* check whether this value was changed */
+  if (m_persistedConfiguration.iPhysicalAddress == iPhysicalAddress)
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "logical address mask setting unchanged (%04X)", iPhysicalAddress);
+    return bReturn;
+  }
+
+  m_bNeedsWrite = true;
   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the physical address to %04X", iPhysicalAddress);
 
   CCECAdapterMessage params;
   params.PushEscaped(iPhysicalAddress >> 8);
   params.PushEscaped((uint8_t)iPhysicalAddress);
   CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_PHYSICAL_ADDRESS, params);
-  bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
   delete message;
+
+  if (bReturn)
+    m_persistedConfiguration.iPhysicalAddress = iPhysicalAddress;
+
   return bReturn;
 }
 
 bool CUSBCECAdapterCommands::SetSettingCECVersion(cec_version version)
 {
+  bool bReturn(true);
+
+  /* check whether this value was changed */
+  if (m_settingCecVersion == version)
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "CEC version setting unchanged (%s)", CLibCEC::GetInstance()->ToString(version));
+    return bReturn;
+  }
+
+  m_bNeedsWrite = true;
   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the CEC version to %s", CLibCEC::GetInstance()->ToString(version));
 
   CCECAdapterMessage params;
   params.PushEscaped((uint8_t)version);
   CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_HDMI_VERSION, params);
-  bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
   delete message;
+
+  if (bReturn)
+    m_settingCecVersion = version;
+
   return bReturn;
 }
 
 bool CUSBCECAdapterCommands::SetSettingOSDName(const char *strOSDName)
 {
+  bool bReturn(true);
+
+  /* check whether this value was changed */
+  if (!strcmp(m_persistedConfiguration.strDeviceName, strOSDName))
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "OSD name setting unchanged (%s)", strOSDName);
+    return bReturn;
+  }
+
   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the OSD name to %s", strOSDName);
 
   CCECAdapterMessage params;
   for (size_t iPtr = 0; iPtr < strlen(strOSDName); iPtr++)
     params.PushEscaped(strOSDName[iPtr]);
   CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_OSD_NAME, params);
-  bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
   delete message;
+
+  if (bReturn)
+    snprintf(m_persistedConfiguration.strDeviceName, 13, "%s", strOSDName);
+
   return bReturn;
 }
 
 bool CUSBCECAdapterCommands::WriteEEPROM(void)
 {
+  if (!m_bNeedsWrite)
+    return true;
+
   CLibCEC::AddLog(CEC_LOG_DEBUG, "writing settings in the EEPROM");
 
   CCECAdapterMessage params;
   CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_WRITE_EEPROM, params);
-  bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  m_bNeedsWrite = !(message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED);
   delete message;
-  return bReturn;
+  return m_bNeedsWrite;
 }
 
 bool CUSBCECAdapterCommands::PersistConfiguration(libcec_configuration *configuration)
 {
-  if (m_iFirmwareVersion < 2)
+  if (m_persistedConfiguration.iFirmwareVersion < 2)
+    return false;
+
+  if (!RequestSettings())
     return false;
 
   bool bReturn(true);
@@ -287,52 +408,29 @@ bool CUSBCECAdapterCommands::PersistConfiguration(libcec_configuration *configur
   bReturn &= SetSettingPhysicalAddress(configuration->iPhysicalAddress);
   bReturn &= SetSettingCECVersion(CEC_VERSION_1_3A);
   bReturn &= SetSettingOSDName(configuration->strDeviceName);
-  if (bReturn)
-    bReturn = WriteEEPROM();
+  bReturn &= WriteEEPROM();
   return bReturn;
 }
 
-bool CUSBCECAdapterCommands::GetConfiguration(libcec_configuration *configuration)
+bool CUSBCECAdapterCommands::RequestSettings(void)
 {
-  configuration->iFirmwareVersion = m_iFirmwareVersion;
-  if (m_iFirmwareVersion < 2)
-    return false;
-
-  bool bReturn(true);
-  cec_device_type type;
-  if (RequestSettingDeviceType(type))
-  {
-    CLibCEC::AddLog(CEC_LOG_DEBUG, "using persisted device type setting %s", CLibCEC::GetInstance()->ToString(type));
-    configuration->deviceTypes.Clear();
-    configuration->deviceTypes.Add(type);
-  }
-  else
+  if (m_persistedConfiguration.iFirmwareVersion < 2)
   {
-    CLibCEC::AddLog(CEC_LOG_DEBUG, "no persisted device type setting");
-    bReturn = false;
+    // settings can only be persisted with firmware v2+
+    return false;
   }
 
-  if (RequestSettingPhysicalAddress(configuration->iPhysicalAddress))
-  {
-    CLibCEC::AddLog(CEC_LOG_DEBUG, "using persisted physical address setting %4x", configuration->iPhysicalAddress);
-  }
-  else
-  {
-    CLibCEC::AddLog(CEC_LOG_DEBUG, "no persisted physical address setting");
-    bReturn = false;
-  }
+  if (!m_bSettingsRetrieved)
+    return true;
 
-  CStdString strDeviceName;
-  if (RequestSettingOSDName(strDeviceName))
-  {
-    snprintf(configuration->strDeviceName, 13, "%s", strDeviceName.c_str());
-    CLibCEC::AddLog(CEC_LOG_DEBUG, "using persisted device name setting %s", configuration->strDeviceName);
-  }
-  else
-  {
-    CLibCEC::AddLog(CEC_LOG_DEBUG, "no persisted device name setting");
-    bReturn = false;
-  }
+  bool bReturn(true);
+  bReturn &= RequestSettingAutoEnabled();
+  bReturn &= RequestSettingCECVersion();
+  bReturn &= RequestSettingDefaultLogicalAddress();
+  bReturn &= RequestSettingDeviceType();
+  bReturn &= RequestSettingLogicalAddressMask();
+  bReturn &= RequestSettingOSDName();
+  bReturn &= RequestSettingPhysicalAddress();
 
   // don't read the following settings:
   // - auto enabled (always enabled)
@@ -351,9 +449,27 @@ bool CUSBCECAdapterCommands::GetConfiguration(libcec_configuration *configuratio
   // - power off screensaver (1 bit)
   // - power off on standby (1 bit)
   // - send inactive source (1 bit)
+
+  m_bSettingsRetrieved = true;
+
   return bReturn;
 }
 
+bool CUSBCECAdapterCommands::GetConfiguration(libcec_configuration *configuration)
+{
+  // get the settings from the eeprom if needed
+  if (!RequestSettings())
+    return false;
+
+  // copy the settings
+  configuration->iFirmwareVersion = m_persistedConfiguration.iFirmwareVersion;
+  configuration->deviceTypes      = m_persistedConfiguration.deviceTypes;
+  configuration->iPhysicalAddress = m_persistedConfiguration.iPhysicalAddress;
+  snprintf(configuration->strDeviceName, 13, "%s", m_persistedConfiguration.strDeviceName);
+
+  return true;
+}
+
 bool CUSBCECAdapterCommands::PingAdapter(void)
 {
   CLibCEC::AddLog(CEC_LOG_DEBUG, "sending ping");