src/Model_Settings.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // LameXP - Audio Encoder Front-End
   3 // Copyright (C) 2004-2011 LoRd_MuldeR <MuldeR2@GMX.de>
   4 //
   5 // This program is free software; you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation; either version 2 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License along
  16 // with this program; if not, write to the Free Software Foundation, Inc.,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 // http://www.gnu.org/licenses/gpl-2.0.txt
  20 ///////////////////////////////////////////////////////////////////////////////
  21
  22 #include "Model_Settings.h"
  23
  24 #include "Global.h"
  25
  26 #include <QSettings>
  27 #include <QDesktopServices>
  28 #include <QApplication>
  29 #include <QString>
  30 #include <QFileInfo>
  31 #include <QDir>
  32 #include <QStringList>
  33 #include <QLocale>
  34 #include <QRegExp>
  35
  36
  37 ////////////////////////////////////////////////////////////
  38 //Macros
  39 ////////////////////////////////////////////////////////////
  40
  41 #define LAMEXP_MAKE_OPTION_I(OPT,DEF) \
  42 int SettingsModel::OPT(void) { return m_settings->value(g_settingsId_##OPT, DEF).toInt(); } \
  43 void SettingsModel::OPT(int value) { m_settings->setValue(g_settingsId_##OPT, value); } \
  44 int SettingsModel::OPT##Default(void) { return DEF; }
  45
  46 #define LAMEXP_MAKE_OPTION_S(OPT,DEF) \
  47 QString SettingsModel::OPT(void) { return m_settings->value(g_settingsId_##OPT, DEF).toString().trimmed(); } \
  48 void SettingsModel::OPT(const QString &value) { m_settings->setValue(g_settingsId_##OPT, value); } \
  49 QString SettingsModel::OPT##Default(void) { return DEF; }
  50
  51 #define LAMEXP_MAKE_OPTION_B(OPT,DEF) \
  52 bool SettingsModel::OPT(void) { return m_settings->value(g_settingsId_##OPT, DEF).toBool(); } \
  53 void SettingsModel::OPT(bool value) { m_settings->setValue(g_settingsId_##OPT, value); } \
  54 bool SettingsModel::OPT##Default(void) { return DEF; }
  55
  56 #define LAMEXP_MAKE_OPTION_U(OPT,DEF) \
  57 unsigned int SettingsModel::OPT(void) { return m_settings->value(g_settingsId_##OPT, DEF).toUInt(); } \
  58 void SettingsModel::OPT(unsigned int value) { m_settings->setValue(g_settingsId_##OPT, value); } \
  59 unsigned int SettingsModel::OPT##Default(void) { return DEF; }
  60
  61 #define LAMEXP_MAKE_ID(DEC,STR) static const char *g_settingsId_##DEC = STR
  62 #define REMOVE_GROUP(OBJ,ID) OBJ->beginGroup(ID); OBJ->remove(""); OBJ->endGroup();
  63
  64 ////////////////////////////////////////////////////////////
  65 //Constants
  66 ////////////////////////////////////////////////////////////
  67
  68 //Setting ID's
  69 LAMEXP_MAKE_ID(versionNumber, "VersionNumber");
  70 LAMEXP_MAKE_ID(licenseAccepted, "LicenseAccepted");
  71 LAMEXP_MAKE_ID(interfaceStyle, "InterfaceStyle");
  72 LAMEXP_MAKE_ID(compressionEncoder, "Compression/Encoder");
  73 LAMEXP_MAKE_ID(compressionRCMode, "Compression/RCMode");
  74 LAMEXP_MAKE_ID(compressionBitrate, "Compression/Bitrate");
  75 LAMEXP_MAKE_ID(outputDir, "OutputDirectory/SelectedPath");
  76 LAMEXP_MAKE_ID(outputToSourceDir, "OutputDirectory/OutputToSourceFolder");
  77 LAMEXP_MAKE_ID(prependRelativeSourcePath, "OutputDirectory/PrependRelativeSourcePath");
  78 LAMEXP_MAKE_ID(favoriteOutputFolders, "OutputDirectory/Favorites");
  79 LAMEXP_MAKE_ID(mostRecentInputPath, "InputDirectory/MostRecentPath");
  80 LAMEXP_MAKE_ID(writeMetaTags, "Flags/WriteMetaTags");
  81 LAMEXP_MAKE_ID(createPlaylist, "Flags/AutoCreatePlaylist");
  82 LAMEXP_MAKE_ID(autoUpdateLastCheck, "AutoUpdate/LastCheck");
  83 LAMEXP_MAKE_ID(autoUpdateEnabled, "AutoUpdate/Enabled");
  84 LAMEXP_MAKE_ID(autoUpdateCheckBeta, "AutoUpdate/CheckForBetaVersions");
  85 LAMEXP_MAKE_ID(soundsEnabled, "Flags/EnableSounds");
  86 LAMEXP_MAKE_ID(neroAacNotificationsEnabled, "Flags/EnableNeroAacNotifications");
  87 LAMEXP_MAKE_ID(antivirNotificationsEnabled, "Flags/EnableAntivirusNotifications");
  88 LAMEXP_MAKE_ID(dropBoxWidgetEnabled, "Flags/EnableDropBoxWidget");
  89 LAMEXP_MAKE_ID(shellIntegrationEnabled, "Flags/EnableShellIntegration");
  90 LAMEXP_MAKE_ID(currentLanguage, "Localization/Language");
  91 LAMEXP_MAKE_ID(lameAlgoQuality, "AdvancedOptions/LAME/AlgorithmQuality");
  92 LAMEXP_MAKE_ID(lameChannelMode, "AdvancedOptions/LAME/ChannelMode");
  93 LAMEXP_MAKE_ID(forceStereoDownmix, "AdvancedOptions/StereoDownmix/Force");
  94 LAMEXP_MAKE_ID(bitrateManagementEnabled, "AdvancedOptions/BitrateManagement/Enabled");
  95 LAMEXP_MAKE_ID(bitrateManagementMinRate, "AdvancedOptions/BitrateManagement/MinRate");
  96 LAMEXP_MAKE_ID(bitrateManagementMaxRate, "AdvancedOptions/BitrateManagement/MaxRate");
  97 LAMEXP_MAKE_ID(aftenAudioCodingMode, "AdvancedOptions/Aften/AudioCodingMode");
  98 LAMEXP_MAKE_ID(aftenDynamicRangeCompression, "AdvancedOptions/Aften/DynamicRangeCompression");
  99 LAMEXP_MAKE_ID(aftenFastBitAllocation, "AdvancedOptions/Aften/FastBitAllocation");
 100 LAMEXP_MAKE_ID(aftenExponentSearchSize, "AdvancedOptions/Aften/ExponentSearchSize");
 101 LAMEXP_MAKE_ID(samplingRate, "AdvancedOptions/Common/Resampling");
 102 LAMEXP_MAKE_ID(neroAACEnable2Pass, "AdvancedOptions/AACEnc/Enable2Pass");
 103 LAMEXP_MAKE_ID(aacEncProfile, "AdvancedOptions/AACEnc/ForceProfile");
 104 LAMEXP_MAKE_ID(normalizationFilterEnabled, "AdvancedOptions/VolumeNormalization/Enabled");
 105 LAMEXP_MAKE_ID(normalizationFilterMaxVolume, "AdvancedOptions/VolumeNormalization/MaxVolume");
 106 LAMEXP_MAKE_ID(normalizationFilterEqualizationMode, "AdvancedOptions/VolumeNormalization/EqualizationMode");
 107 LAMEXP_MAKE_ID(toneAdjustBass, "AdvancedOptions/ToneAdjustment/Bass");
 108 LAMEXP_MAKE_ID(toneAdjustTreble, "AdvancedOptions/ToneAdjustment/Treble");
 109 LAMEXP_MAKE_ID(customParametersLAME, "AdvancedOptions/CustomParameters/LAME");
 110 LAMEXP_MAKE_ID(customParametersOggEnc, "AdvancedOptions/CustomParameters/OggEnc");
 111 LAMEXP_MAKE_ID(customParametersAacEnc, "AdvancedOptions/CustomParameters/AacEnc");
 112 LAMEXP_MAKE_ID(customParametersAften, "AdvancedOptions/CustomParameters/Aften");
 113 LAMEXP_MAKE_ID(customParametersFLAC, "AdvancedOptions/CustomParameters/FLAC");
 114 LAMEXP_MAKE_ID(renameOutputFilesEnabled, "AdvancedOptions/RenameOutputFiles/Enabled");
 115 LAMEXP_MAKE_ID(renameOutputFilesPattern, "AdvancedOptions/RenameOutputFiles/Pattern");
 116 LAMEXP_MAKE_ID(metaInfoPosition, "MetaInformation/PlaylistPosition");
 117 LAMEXP_MAKE_ID(maximumInstances, "AdvancedOptions/Threading/MaximumInstances");
 118 LAMEXP_MAKE_ID(customTempPath, "AdvancedOptions/TempDirectory/CustomPath");
 119 LAMEXP_MAKE_ID(customTempPathEnabled, "AdvancedOptions/TempDirectory/UseCustomPath");
 120 LAMEXP_MAKE_ID(slowStartup, "Flags/SlowStartupDetected");
 121
 122 //LUT
 123 const int SettingsModel::mp3Bitrates[15] = {32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, -1};
 124 const int SettingsModel::ac3Bitrates[20] = {32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 384, 448, 512, 576, 640, -1};
 125 const int SettingsModel::samplingRates[8] = {0, 16000, 22050, 24000, 32000, 44100, 48000, -1};
 126
 127 ////////////////////////////////////////////////////////////
 128 // Constructor
 129 ////////////////////////////////////////////////////////////
 130
 131 SettingsModel::SettingsModel(void)
 132 :
 133         m_defaultLanguage(NULL)
 134 {
 135         QString configPath = "LameXP.ini";
 136
 137         if(!lamexp_portable_mode())
 138         {
 139                 QString dataPath = initDirectory(QDesktopServices::storageLocation(QDesktopServices::DataLocation));
 140                 if(!dataPath.isEmpty())
 141                 {
 142                         configPath = QString("%1/config.ini").arg(QDir(dataPath).canonicalPath());
 143                 }
 144                 else
 145                 {
 146                         qWarning("SettingsModel: DataLocation could not be initialized!");
 147                         dataPath = initDirectory(QDesktopServices::storageLocation(QDesktopServices::HomeLocation));
 148                         if(!dataPath.isEmpty())
 149                         {
 150                                 configPath = QString("%1/LameXP.ini").arg(QDir(dataPath).canonicalPath());
 151                         }
 152                 }
 153         }
 154         else
 155         {
 156                 qDebug("LameXP is running in \"portable\" mode -> config in application dir!\n");
 157                 QString appPath = QFileInfo(QApplication::applicationFilePath()).canonicalFilePath();
 158                 if(appPath.isEmpty())
 159                 {
 160                         appPath = QFileInfo(QApplication::applicationFilePath()).absoluteFilePath();
 161                 }
 162                 if(QFileInfo(appPath).exists() && QFileInfo(appPath).isFile())
 163                 {
 164                         configPath = QString("%1/%2.ini").arg(QFileInfo(appPath).absolutePath(), QFileInfo(appPath).completeBaseName());
 165                 }
 166         }
 167
 168         m_settings = new QSettings(configPath, QSettings::IniFormat);
 169         const QString groupKey = QString().sprintf("LameXP_%u%02u%05u", lamexp_version_major(), lamexp_version_minor(), lamexp_version_build());
 170         QStringList childGroups = m_settings->childGroups();
 171
 172         while(!childGroups.isEmpty())
 173         {
 174                 QString current = childGroups.takeFirst();
 175                 QRegExp filter("^LameXP_(\\d+)(\\d\\d)(\\d\\d\\d\\d\\d)$");
 176                 if(filter.indexIn(current) >= 0)
 177                 {
 178                         bool ok = false;
 179                         unsigned int temp = filter.cap(3).toUInt(&ok) + 10;
 180                         if(ok && (temp >= lamexp_version_build()))
 181                         {
 182                                 continue;
 183                         }
 184                 }
 185                 qWarning("Deleting obsolete group from config: %s", current.toUtf8().constData());
 186                 REMOVE_GROUP(m_settings, current);
 187         }
 188
 189         m_settings->beginGroup(groupKey);
 190         m_settings->setValue(g_settingsId_versionNumber, QApplication::applicationVersion());
 191         m_settings->sync();
 192 }
 193
 194 ////////////////////////////////////////////////////////////
 195 // Destructor
 196 ////////////////////////////////////////////////////////////
 197
 198 SettingsModel::~SettingsModel(void)
 199 {
 200         LAMEXP_DELETE(m_settings);
 201         LAMEXP_DELETE(m_defaultLanguage);
 202 }
 203
 204 ////////////////////////////////////////////////////////////
 205 // Public Functions
 206 ////////////////////////////////////////////////////////////
 207
 208 void SettingsModel::validate(void)
 209 {
 210         if(this->compressionEncoder() < SettingsModel::MP3Encoder || this->compressionEncoder() > SettingsModel::PCMEncoder)
 211         {
 212                 this->compressionEncoder(SettingsModel::MP3Encoder);
 213         }
 214
 215         if(this->compressionRCMode() < SettingsModel::VBRMode || this->compressionRCMode() > SettingsModel::CBRMode)
 216         {
 217                 this->compressionEncoder(SettingsModel::VBRMode);
 218         }
 219
 220         if(!(lamexp_check_tool("neroAacEnc.exe") && lamexp_check_tool("neroAacDec.exe") && lamexp_check_tool("neroAacTag.exe")))
 221         {
 222                 if(!(lamexp_check_tool("fhgaacenc.exe") && lamexp_check_tool("enc_fhgaac.dll")))
 223                 {
 224                         if(this->compressionEncoder() == SettingsModel::AACEncoder)
 225                         {
 226                                 qWarning("AAC encoder selected, but not available any more. Reverting to MP3!");
 227                                 this->compressionEncoder(SettingsModel::MP3Encoder);
 228                         }
 229                 }
 230         }
 231
 232         if(this->outputDir().isEmpty() || !QFileInfo(this->outputDir()).isDir())
 233         {
 234                 QString musicLocation = QDesktopServices::storageLocation(QDesktopServices::MusicLocation);
 235                 this->outputDir(musicLocation.isEmpty() ? QDesktopServices::storageLocation(QDesktopServices::HomeLocation) : musicLocation);
 236         }
 237
 238         if(this->mostRecentInputPath().isEmpty() || !QFileInfo(this->mostRecentInputPath()).isDir())
 239         {
 240                 QString musicLocation = QDesktopServices::storageLocation(QDesktopServices::MusicLocation);
 241                 this->outputDir(musicLocation.isEmpty() ? QDesktopServices::storageLocation(QDesktopServices::HomeLocation) : musicLocation);
 242         }
 243
 244         if(!lamexp_query_translations().contains(this->currentLanguage(), Qt::CaseInsensitive))
 245         {
 246                 qWarning("Current language \"%s\" is unknown, reverting to default language!", this->currentLanguage().toLatin1().constData());
 247                 this->currentLanguage(defaultLanguage());
 248         }
 249 }
 250
 251 ////////////////////////////////////////////////////////////
 252 // Private Functions
 253 ////////////////////////////////////////////////////////////
 254
 255 QString SettingsModel::defaultLanguage(void)
 256 {
 257         if(m_defaultLanguage)
 258         {
 259                 return *m_defaultLanguage;
 260         }
 261
 262         //Check if we can use the default translation
 263         QLocale systemLanguage= QLocale::system();
 264         if(systemLanguage.language() == QLocale::English || systemLanguage.language() == QLocale::C)
 265         {
 266                 m_defaultLanguage = new QString(LAMEXP_DEFAULT_LANGID);
 267                 return LAMEXP_DEFAULT_LANGID;
 268         }
 269
 270         //Try to find a suitable translation for the user's system language
 271         QStringList languages = lamexp_query_translations();
 272         while(!languages.isEmpty())
 273         {
 274                 QString currentLangId = languages.takeFirst();
 275                 if(lamexp_translation_sysid(currentLangId) == systemLanguage.language())
 276                 {
 277                         m_defaultLanguage = new QString(currentLangId);
 278                         return currentLangId;
 279                 }
 280         }
 281
 282         //Fall back to the default translation
 283         m_defaultLanguage = new QString(LAMEXP_DEFAULT_LANGID);
 284         return LAMEXP_DEFAULT_LANGID;
 285 }
 286
 287 QString SettingsModel::initDirectory(const QString &path)
 288 {
 289         if(path.isEmpty())
 290         {
 291                 return QString();
 292         }
 293
 294         if(!QDir(path).exists())
 295         {
 296                 for(int i = 0; i < 32; i++)
 297                 {
 298                         if(QDir(path).mkpath(".")) break;
 299                         Sleep(1);
 300                 }
 301         }
 302
 303         if(!QDir(path).exists())
 304         {
 305                 return QString();
 306         }
 307
 308         return QDir(path).canonicalPath();
 309 }
 310
 311 ////////////////////////////////////////////////////////////
 312 // Getter and Setter
 313 ////////////////////////////////////////////////////////////
 314
 315 LAMEXP_MAKE_OPTION_I(licenseAccepted, 0)
 316 LAMEXP_MAKE_OPTION_I(interfaceStyle, 0)
 317 LAMEXP_MAKE_OPTION_I(compressionEncoder, 0)
 318 LAMEXP_MAKE_OPTION_I(compressionRCMode, 0)
 319 LAMEXP_MAKE_OPTION_I(compressionBitrate, 7)
 320 LAMEXP_MAKE_OPTION_S(outputDir, QDesktopServices::storageLocation(QDesktopServices::MusicLocation))
 321 LAMEXP_MAKE_OPTION_B(outputToSourceDir, false)
 322 LAMEXP_MAKE_OPTION_B(prependRelativeSourcePath, false)
 323 LAMEXP_MAKE_OPTION_S(favoriteOutputFolders, QString());
 324 LAMEXP_MAKE_OPTION_B(writeMetaTags, true)
 325 LAMEXP_MAKE_OPTION_B(createPlaylist, true)
 326 LAMEXP_MAKE_OPTION_S(autoUpdateLastCheck, "Never")
 327 LAMEXP_MAKE_OPTION_B(autoUpdateEnabled, true)
 328 LAMEXP_MAKE_OPTION_B(autoUpdateCheckBeta, false)
 329 LAMEXP_MAKE_OPTION_B(soundsEnabled, true)
 330 LAMEXP_MAKE_OPTION_B(neroAacNotificationsEnabled, true)
 331 LAMEXP_MAKE_OPTION_B(antivirNotificationsEnabled, true)
 332 LAMEXP_MAKE_OPTION_B(dropBoxWidgetEnabled, true)
 333 LAMEXP_MAKE_OPTION_B(shellIntegrationEnabled, !lamexp_portable_mode())
 334 LAMEXP_MAKE_OPTION_S(currentLanguage, defaultLanguage())
 335 LAMEXP_MAKE_OPTION_I(lameAlgoQuality, 3)
 336 LAMEXP_MAKE_OPTION_I(lameChannelMode, 0)
 337 LAMEXP_MAKE_OPTION_B(forceStereoDownmix, false)
 338 LAMEXP_MAKE_OPTION_B(bitrateManagementEnabled, false)
 339 LAMEXP_MAKE_OPTION_I(bitrateManagementMinRate, 32)
 340 LAMEXP_MAKE_OPTION_I(bitrateManagementMaxRate, 500)
 341 LAMEXP_MAKE_OPTION_I(samplingRate, 0)
 342 LAMEXP_MAKE_OPTION_B(neroAACEnable2Pass, true)
 343 LAMEXP_MAKE_OPTION_I(aacEncProfile, 0)
 344 LAMEXP_MAKE_OPTION_I(aftenAudioCodingMode, 0);
 345 LAMEXP_MAKE_OPTION_I(aftenDynamicRangeCompression, 5);
 346 LAMEXP_MAKE_OPTION_B(aftenFastBitAllocation, false);
 347 LAMEXP_MAKE_OPTION_I(aftenExponentSearchSize, 8);
 348 LAMEXP_MAKE_OPTION_B(normalizationFilterEnabled, false)
 349 LAMEXP_MAKE_OPTION_I(normalizationFilterMaxVolume, -50)
 350 LAMEXP_MAKE_OPTION_I(normalizationFilterEqualizationMode, 0);
 351 LAMEXP_MAKE_OPTION_I(toneAdjustBass, 0)
 352 LAMEXP_MAKE_OPTION_I(toneAdjustTreble, 0)
 353 LAMEXP_MAKE_OPTION_S(customParametersLAME, QString());
 354 LAMEXP_MAKE_OPTION_S(customParametersOggEnc, QString());
 355 LAMEXP_MAKE_OPTION_S(customParametersAacEnc, QString());
 356 LAMEXP_MAKE_OPTION_S(customParametersAften, QString());
 357 LAMEXP_MAKE_OPTION_S(customParametersFLAC, QString());
 358 LAMEXP_MAKE_OPTION_B(renameOutputFilesEnabled, false);
 359 LAMEXP_MAKE_OPTION_S(renameOutputFilesPattern, "[<TrackNo>] <Artist> - <Title>");
 360 LAMEXP_MAKE_OPTION_U(metaInfoPosition, UINT_MAX);
 361 LAMEXP_MAKE_OPTION_U(maximumInstances, 0);
 362 LAMEXP_MAKE_OPTION_S(customTempPath, QDesktopServices::storageLocation(QDesktopServices::TempLocation));
 363 LAMEXP_MAKE_OPTION_B(customTempPathEnabled, false);
 364 LAMEXP_MAKE_OPTION_B(slowStartup, false);
 365 LAMEXP_MAKE_OPTION_S(mostRecentInputPath, QDesktopServices::storageLocation(QDesktopServices::MusicLocation));