Changeset 56088 in vbox

Timestamp:

May 27, 2015 8:55:54 AM (10 years ago)

Author:

vboxsync

Message:

pr6522. First part: added logic which allows to read\save audio properties in form key=value in VM xml setting file

Location:

trunk

Files:

• include/VBox/settings.h (modified) (2 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (1 diff)
• src/VBox/Main/include/AudioAdapterImpl.h (modified) (1 diff)
• src/VBox/Main/src-client/ConsoleImpl2.cpp (modified) (1 diff)
• src/VBox/Main/src-server/AudioAdapterImpl.cpp (modified) (4 diffs)
• src/VBox/Main/xml/Settings.cpp (modified) (2 diffs)

trunk/include/VBox/settings.h

@@ -705 +705 @@
                      && (controllerType  == a.controllerType)
                      && (driverType      == a.driverType)
+                     && (properties      == a.properties)
                    );
     }
@@ -711 +712 @@
     AudioControllerType_T   controllerType;
     AudioDriverType_T       driverType;
+    std::map<com::Utf8Str, com::Utf8Str> properties;
 };
 

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -18397 +18397 @@
       </desc>
     </attribute>
+    <attribute name="propertiesList" type="wstring" readonly="yes" safearray="yes">
+      <desc>
+        Array of names of tunable properties, which can be supported by audio driver.
+      </desc>
+    </attribute>
+
+    <method name="setProperty">
+      <desc>
+        Sets an audio specific property string.
+
+        If you pass @c null or empty string as a key @a value, the given @a key
+        will be deleted.
+
+      </desc>
+      <param name="key" type="wstring" dir="in">
+        <desc>Name of the key to set.</desc>
+      </param>
+      <param name="value" type="wstring" dir="in">
+        <desc>Value to assign to the key.</desc>
+      </param>
+    </method>
+
+    <method name="getProperty" const="yes">
+      <desc>
+        Returns an audio specific property string.
+
+        If the requested data @a key does not exist, this function will
+        succeed and return an empty string in the @a value argument.
+
+      </desc>
+      <param name="key" type="wstring" dir="in">
+        <desc>Name of the key to get.</desc>
+      </param>
+      <param name="value" type="wstring" dir="return">
+        <desc>Value of the requested key.</desc>
+      </param>
+    </method>
+
   </interface>
 

trunk/src/VBox/Main/include/AudioAdapterImpl.h

@@ -65 +65 @@
     HRESULT getAudioController(AudioControllerType_T *aAudioController);
     HRESULT setAudioController(AudioControllerType_T aAudioController);
+    HRESULT getPropertiesList(std::vector<com::Utf8Str>& aProperties);
+    HRESULT getProperty(const com::Utf8Str &aKey, com::Utf8Str &aValue);
+    HRESULT setProperty(const com::Utf8Str &aKey, const com::Utf8Str &aValue);
 
     Machine * const     mParent;

trunk/src/VBox/Main/src-client/ConsoleImpl2.cpp

@@ -2736 +2736 @@
                     InsertConfigNode(pInst,    "Config", &pCfg);
                 }
+            }
+
+            PCFGMNODE pCfgAudioSettings = NULL;
+            InsertConfigNode(pInst, "AudioConfig", &pCfgAudioSettings);
+            SafeArray<BSTR> audioProps;
+            hrc = audioAdapter->COMGETTER(PropertiesList)(ComSafeArrayAsOutParam(audioProps));  H();
+
+            std::list<Utf8Str> audioPropertyNamesList;
+            std::map<Utf8Str, Utf8Str> audioProperties;
+            for (size_t i = 0; i < audioProps.size(); ++i)
+            {
+                Bstr bstrValue;
+                audioPropertyNamesList.push_back(Utf8Str(audioProps[i]));
+                hrc = audioAdapter->GetProperty(audioProps[i], bstrValue.asOutParam());
+                Utf8Str strKey(audioProps[i]);
+                audioProperties[strKey] = Utf8Str(bstrValue);
+                InsertConfigString(pCfgAudioSettings, strKey.c_str(), bstrValue);
             }
 

trunk/src/VBox/Main/src-server/AudioAdapterImpl.cpp

@@ -39 +39 @@
     AudioDriverType_T mAudioDriver;
     AudioControllerType_T mAudioController;
+    std::map<com::Utf8Str, com::Utf8Str>  properties;
 };
 
@@ -347 +348 @@
 }
 
+HRESULT AudioAdapter::getPropertiesList(std::vector<com::Utf8Str>& aProperties)
+{
+    using namespace settings;
+
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    aProperties.resize(0);
+    StringsMap::const_iterator cit = mData->m->properties.begin();
+    while(cit!=mData->m->properties.end())
+    {
+        Utf8Str key = cit->first;
+        aProperties.push_back(cit->first);
+        ++cit;
+    }
+
+    return S_OK;
+}
+
+HRESULT AudioAdapter::getProperty(const com::Utf8Str &aKey, com::Utf8Str &aValue)
+{
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    settings::StringsMap::const_iterator cit = mData->m->properties.find(aKey);
+    if (cit != mData->m->properties.end())
+        aValue = cit->second;
+
+    return S_OK;
+}
+
+HRESULT AudioAdapter::setProperty(const com::Utf8Str &aKey, const com::Utf8Str &aValue)
+{
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    /* Generic properties processing.
+     * Look up the old value first; if nothing's changed then do nothing.
+     */
+    Utf8Str strOldValue;
+
+    settings::StringsMap::const_iterator cit = mData->m->properties.find(aKey);
+    if (cit != mData->m->properties.end())
+        strOldValue = cit->second;
+
+    if (strOldValue != aValue)
+    {
+        if (aValue.isEmpty())
+            mData->m->properties.erase(aKey);
+        else
+            mData->m->properties[aKey] = aValue;
+    }
+
+    alock.release();
+
+    return S_OK;
+}
+
 // IAudioAdapter methods
 /////////////////////////////////////////////////////////////////////////////
@@ -383 +439 @@
     mData->m->mAudioDriver = data.driverType;
 
+    std::map<com::Utf8Str, com::Utf8Str>::const_iterator cit = data.properties.begin();
+    while(cit!=data.properties.end())
+    {
+        mData->m->properties[cit->first] = cit->second;
+        ++cit;
+    }
+
     return S_OK;
 }
@@ -403 +466 @@
     data.controllerType = mData->m->mAudioController;
     data.driverType = mData->m->mAudioDriver;
+
+    std::map<com::Utf8Str, com::Utf8Str>::const_iterator cit = mData->m->properties.begin();
+    while(cit!=mData->m->properties.end())
+    {
+        data.properties[cit->first] = cit->second;
+        ++cit;
+    }
+
     return S_OK;
 }

trunk/src/VBox/Main/xml/Settings.cpp

@@ -2622 +2622 @@
                                          AudioAdapter &aa)
 {
+
+    // get all properties
+    xml::NodesLoop nl1(elmAudioAdapter, "Property");
+    const xml::ElementNode *pelmModeChild;
+    while ((pelmModeChild = nl1.forAllNodes()))
+    {
+        Utf8Str strPropName, strPropValue;
+        if (   pelmModeChild->getAttributeValue("name", strPropName)
+            && pelmModeChild->getAttributeValue("value", strPropValue) )
+            aa.properties[strPropName] = strPropValue;
+        else
+            throw ConfigFileError(this, pelmModeChild, N_("Required AudioAdapter/Property/@name or @value attribute "
+                                                          "is missing"));
+    }
+
     elmAudioAdapter.getAttributeValue("enabled", aa.fEnabled);
 
@@ -4730 +4745 @@
 
     pelmAudio->setAttribute("enabled", hw.audioAdapter.fEnabled);
+
+    if (hw.audioAdapter.properties.size() > 0)
+    {
+        for (StringsMap::const_iterator it = hw.audioAdapter.properties.begin();
+             it != hw.audioAdapter.properties.end();
+             ++it)
+        {
+            const Utf8Str &strName = it->first;
+            const Utf8Str &strValue = it->second;
+            xml::ElementNode *pelm = pelmAudio->createChild("Property");
+            pelm->setAttribute("name", strName);
+            pelm->setAttribute("value", strValue);
+        }
+    }
 
     xml::ElementNode *pelmSharedFolders = pelmHardware->createChild("SharedFolders");