runtime/phonon/kcm/globalconfig.cpp

   1 /*  This file is part of the KDE project
   2     Copyright (C) 2006-2008 Matthias Kretz <kretz@kde.org>
   3
   4     This library is free software; you can redistribute it and/or
   5     modify it under the terms of the GNU Library General Public
   6     License version 2 as published by the Free Software Foundation.
   7
   8     This library is distributed in the hope that it will be useful,
   9     but WITHOUT ANY WARRANTY; without even the implied warranty of
  10     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11     Library General Public License for more details.
  12
  13     You should have received a copy of the GNU Library General Public License
  14     along with this library; see the file COPYING.LIB.  If not, write to
  15     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16     Boston, MA 02110-1301, USA.
  17
  18 */
  19
  20 #include "globalconfig_p.h"
  21
  22 #include "factory_p.h"
  23 #include "phonon/objectdescription.h"
  24 #include "phonondefs_p.h"
  25 #include "phonon/platformplugin.h"
  26 #include "phonon/backendinterface.h"
  27 #include "qsettingsgroup_p.h"
  28 #include "phononnamespace_p.h"
  29
  30 #include <QtCore/QList>
  31 #include <QtCore/QVariant>
  32
  33 QT_BEGIN_NAMESPACE
  34
  35 namespace Phonon
  36 {
  37
  38 GlobalConfig::GlobalConfig(QObject *parent)
  39     : QObject(parent)
  40     , m_config(QLatin1String("kde.org"), QLatin1String("libphonon"))
  41 {
  42 }
  43
  44 GlobalConfig::~GlobalConfig()
  45 {
  46 }
  47
  48 enum WhatToFilter {
  49     FilterAdvancedDevices = 1,
  50     FilterHardwareDevices = 2
  51 };
  52
  53 static void filter(ObjectDescriptionType type, BackendInterface *backendIface, QList<int> *list, int whatToFilter)
  54 {
  55     QMutableListIterator<int> it(*list);
  56     while (it.hasNext()) {
  57         const QHash<QByteArray, QVariant> properties = backendIface->objectDescriptionProperties(type, it.next());
  58         QVariant var;
  59         if (whatToFilter & FilterAdvancedDevices) {
  60             var = properties.value("isAdvanced");
  61             if (var.isValid() && var.toBool()) {
  62                 it.remove();
  63                 continue;
  64             }
  65         }
  66         if (whatToFilter & FilterHardwareDevices) {
  67             var = properties.value("isHardwareDevice");
  68             if (var.isValid() && var.toBool()) {
  69                 it.remove();
  70                 continue;
  71             }
  72         }
  73     }
  74 }
  75
  76 static QList<int> listSortedByConfig(const QSettingsGroup &backendConfig, Phonon::Category category, QList<int> &defaultList)
  77 {
  78     if (defaultList.size() <= 1) {
  79         // nothing to sort
  80         return defaultList;
  81     } else {
  82         // make entries unique
  83         QSet<int> seen;
  84         QMutableListIterator<int> it(defaultList);
  85         while (it.hasNext()) {
  86             if (seen.contains(it.next())) {
  87                 it.remove();
  88             } else {
  89                 seen.insert(it.value());
  90             }
  91         }
  92     }
  93
  94     QString categoryKey = QLatin1String("Category_") + QString::number(static_cast<int>(category));
  95     if (!backendConfig.hasKey(categoryKey)) {
  96         // no list in config for the given category
  97         categoryKey = QLatin1String("Category_") + QString::number(static_cast<int>(Phonon::NoCategory));
  98         if (!backendConfig.hasKey(categoryKey)) {
  99             // no list in config for NoCategory
 100             return defaultList;
 101         }
 102     }
 103
 104     //Now the list from m_config
 105     QList<int> deviceList = backendConfig.value(categoryKey, QList<int>());
 106
 107     //if there are devices in m_config that the backend doesn't report, remove them from the list
 108     QMutableListIterator<int> i(deviceList);
 109     while (i.hasNext()) {
 110         if (0 == defaultList.removeAll(i.next())) {
 111             i.remove();
 112         }
 113     }
 114
 115     //if the backend reports more devices that are not in m_config append them to the list
 116     deviceList += defaultList;
 117
 118     return deviceList;
 119 }
 120
 121 QList<int> GlobalConfig::audioOutputDeviceListFor(Phonon::Category category, HideAdvancedDevicesOverride override) const
 122 {
 123     //The devices need to be stored independently for every backend
 124     const QSettingsGroup backendConfig(&m_config, QLatin1String("AudioOutputDevice")); // + Factory::identifier());
 125     const QSettingsGroup generalGroup(&m_config, QLatin1String("General"));
 126     const bool hideAdvancedDevices = (override == FromSettings
 127             ? generalGroup.value(QLatin1String("HideAdvancedDevices"), true)
 128             : static_cast<bool>(override));
 129
 130     PlatformPlugin *platformPlugin = Factory::platformPlugin();
 131     BackendInterface *backendIface = qobject_cast<BackendInterface *>(Factory::backend());
 132
 133     QList<int> defaultList;
 134     if (platformPlugin) {
 135         // the platform plugin lists the audio devices for the platform
 136         // this list already is in default order (as defined by the platform plugin)
 137         defaultList = platformPlugin->objectDescriptionIndexes(Phonon::AudioOutputDeviceType);
 138         if (hideAdvancedDevices) {
 139             QMutableListIterator<int> it(defaultList);
 140             while (it.hasNext()) {
 141                 AudioOutputDevice objDesc = AudioOutputDevice::fromIndex(it.next());
 142                 const QVariant var = objDesc.property("isAdvanced");
 143                 if (var.isValid() && var.toBool()) {
 144                     it.remove();
 145                 }
 146             }
 147         }
 148     }
 149
 150     // lookup the available devices directly from the backend (mostly for virtual devices)
 151     if (backendIface) {
 152         // this list already is in default order (as defined by the backend)
 153         QList<int> list = backendIface->objectDescriptionIndexes(Phonon::AudioOutputDeviceType);
 154         if (hideAdvancedDevices || !defaultList.isEmpty()) {
 155             filter(AudioOutputDeviceType, backendIface, &list,
 156                     (hideAdvancedDevices ? FilterAdvancedDevices : 0)
 157                     // the platform plugin already provided the hardware devices
 158                     | (defaultList.isEmpty() ? 0 : FilterHardwareDevices)
 159                     );
 160         }
 161         defaultList += list;
 162     }
 163
 164     return listSortedByConfig(backendConfig, category, defaultList);
 165 }
 166
 167 int GlobalConfig::audioOutputDeviceFor(Phonon::Category category) const
 168 {
 169     QList<int> ret = audioOutputDeviceListFor(category);
 170     if (ret.isEmpty())
 171         return -1;
 172     return ret.first();
 173 }
 174
 175 QList<int> GlobalConfig::audioCaptureDeviceListFor(Phonon::Category category, HideAdvancedDevicesOverride override) const
 176 {
 177     //The devices need to be stored independently for every backend
 178     const QSettingsGroup backendConfig(&m_config, QLatin1String("AudioCaptureDevice")); // + Factory::identifier());
 179     const QSettingsGroup generalGroup(&m_config, QLatin1String("General"));
 180     const bool hideAdvancedDevices = (override == FromSettings
 181             ? generalGroup.value(QLatin1String("HideAdvancedDevices"), true)
 182             : static_cast<bool>(override));
 183
 184     PlatformPlugin *platformPlugin = Factory::platformPlugin();
 185     BackendInterface *backendIface = qobject_cast<BackendInterface *>(Factory::backend());
 186
 187     QList<int> defaultList;
 188     if (platformPlugin) {
 189         // the platform plugin lists the audio devices for the platform
 190         // this list already is in default order (as defined by the platform plugin)
 191         defaultList = platformPlugin->objectDescriptionIndexes(Phonon::AudioCaptureDeviceType);
 192         if (hideAdvancedDevices) {
 193             QMutableListIterator<int> it(defaultList);
 194             while (it.hasNext()) {
 195                 AudioCaptureDevice objDesc = AudioCaptureDevice::fromIndex(it.next());
 196                 const QVariant var = objDesc.property("isAdvanced");
 197                 if (var.isValid() && var.toBool()) {
 198                     it.remove();
 199                 }
 200             }
 201         }
 202     }
 203
 204     // lookup the available devices directly from the backend (mostly for virtual devices)
 205     if (backendIface) {
 206         // this list already is in default order (as defined by the backend)
 207         QList<int> list = backendIface->objectDescriptionIndexes(Phonon::AudioCaptureDeviceType);
 208         if (hideAdvancedDevices || !defaultList.isEmpty()) {
 209             filter(AudioCaptureDeviceType, backendIface, &list,
 210                     (hideAdvancedDevices ? FilterAdvancedDevices : 0)
 211                     // the platform plugin already provided the hardware devices
 212                     | (defaultList.isEmpty() ? 0 : FilterHardwareDevices)
 213                   );
 214         }
 215         defaultList += list;
 216     }
 217
 218     return listSortedByConfig(backendConfig, category, defaultList);
 219 }
 220
 221 int GlobalConfig::audioCaptureDeviceFor(Phonon::Category category) const
 222 {
 223     QList<int> ret = audioCaptureDeviceListFor(category);
 224     if (ret.isEmpty())
 225         return -1;
 226     return ret.first();
 227 }
 228
 229 } // namespace Phonon
 230
 231 QT_END_NAMESPACE
 232
 233 #include "moc_globalconfig_p.cpp"
 234
 235 // vim: sw=4 ts=4