Added "custom parameters" options for Opus. Also added a "help" button for all "custo...
[LameXP.git] / src / Model_Settings.cpp
blobac10e7ddebae2c3456e630cbf73cc878e613d18a
1 ///////////////////////////////////////////////////////////////////////////////
2 // LameXP - Audio Encoder Front-End
3 // Copyright (C) 2004-2012 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.
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.
19 // http://www.gnu.org/licenses/gpl-2.0.txt
20 ///////////////////////////////////////////////////////////////////////////////
22 #include "Model_Settings.h"
24 #include "Global.h"
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>
37 ////////////////////////////////////////////////////////////
38 //Macros
39 ////////////////////////////////////////////////////////////
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; }
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; }
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; }
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; }
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();
64 ////////////////////////////////////////////////////////////
65 //Constants
66 ////////////////////////////////////////////////////////////
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(opusOptimizeFor, "AdvancedOptions/Opus/OptimizeForSignalType");
105 LAMEXP_MAKE_ID(opusComplexity, "AdvancedOptions/Opus/EncodingComplexity");
106 LAMEXP_MAKE_ID(opusFramesize, "AdvancedOptions/Opus/FrameSize");
107 LAMEXP_MAKE_ID(opusExpAnalysis, "AdvancedOptions/Opus/EnableExpAnalysis");
108 LAMEXP_MAKE_ID(normalizationFilterEnabled, "AdvancedOptions/VolumeNormalization/Enabled");
109 LAMEXP_MAKE_ID(normalizationFilterMaxVolume, "AdvancedOptions/VolumeNormalization/MaxVolume");
110 LAMEXP_MAKE_ID(normalizationFilterEqualizationMode, "AdvancedOptions/VolumeNormalization/EqualizationMode");
111 LAMEXP_MAKE_ID(toneAdjustBass, "AdvancedOptions/ToneAdjustment/Bass");
112 LAMEXP_MAKE_ID(toneAdjustTreble, "AdvancedOptions/ToneAdjustment/Treble");
113 LAMEXP_MAKE_ID(customParametersLAME, "AdvancedOptions/CustomParameters/LAME");
114 LAMEXP_MAKE_ID(customParametersOggEnc, "AdvancedOptions/CustomParameters/OggEnc");
115 LAMEXP_MAKE_ID(customParametersAacEnc, "AdvancedOptions/CustomParameters/AacEnc");
116 LAMEXP_MAKE_ID(customParametersAften, "AdvancedOptions/CustomParameters/Aften");
117 LAMEXP_MAKE_ID(customParametersFLAC, "AdvancedOptions/CustomParameters/FLAC");
118 LAMEXP_MAKE_ID(customParametersOpus, "AdvancedOptions/CustomParameters/OpusEnc");
119 LAMEXP_MAKE_ID(renameOutputFilesEnabled, "AdvancedOptions/RenameOutputFiles/Enabled");
120 LAMEXP_MAKE_ID(renameOutputFilesPattern, "AdvancedOptions/RenameOutputFiles/Pattern");
121 LAMEXP_MAKE_ID(hibernateComputer, "AdvancedOptions/HibernateComputerOnShutdown");
122 LAMEXP_MAKE_ID(metaInfoPosition, "MetaInformation/PlaylistPosition");
123 LAMEXP_MAKE_ID(maximumInstances, "AdvancedOptions/Threading/MaximumInstances");
124 LAMEXP_MAKE_ID(customTempPath, "AdvancedOptions/TempDirectory/CustomPath");
125 LAMEXP_MAKE_ID(customTempPathEnabled, "AdvancedOptions/TempDirectory/UseCustomPath");
126 LAMEXP_MAKE_ID(slowStartup, "Flags/SlowStartupDetected");
128 //LUT
129 const int SettingsModel::mp3Bitrates[15] = {32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, -1};
130 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};
131 const int SettingsModel::samplingRates[8] = {0, 16000, 22050, 24000, 32000, 44100, 48000, -1};
133 ////////////////////////////////////////////////////////////
134 // Constructor
135 ////////////////////////////////////////////////////////////
137 SettingsModel::SettingsModel(void)
139 m_defaultLanguage(NULL)
141 QString configPath = "LameXP.ini";
143 if(!lamexp_portable_mode())
145 QString dataPath = initDirectory(QDesktopServices::storageLocation(QDesktopServices::DataLocation));
146 if(!dataPath.isEmpty())
148 configPath = QString("%1/config.ini").arg(QDir(dataPath).canonicalPath());
150 else
152 qWarning("SettingsModel: DataLocation could not be initialized!");
153 dataPath = initDirectory(QDesktopServices::storageLocation(QDesktopServices::HomeLocation));
154 if(!dataPath.isEmpty())
156 configPath = QString("%1/LameXP.ini").arg(QDir(dataPath).canonicalPath());
160 else
162 qDebug("LameXP is running in \"portable\" mode -> config in application dir!\n");
163 QString appPath = QFileInfo(QApplication::applicationFilePath()).canonicalFilePath();
164 if(appPath.isEmpty())
166 appPath = QFileInfo(QApplication::applicationFilePath()).absoluteFilePath();
168 if(QFileInfo(appPath).exists() && QFileInfo(appPath).isFile())
170 configPath = QString("%1/%2.ini").arg(QFileInfo(appPath).absolutePath(), QFileInfo(appPath).completeBaseName());
174 m_settings = new QSettings(configPath, QSettings::IniFormat);
175 const QString groupKey = QString().sprintf("LameXP_%u%02u%05u", lamexp_version_major(), lamexp_version_minor(), lamexp_version_build());
176 QStringList childGroups = m_settings->childGroups();
178 while(!childGroups.isEmpty())
180 QString current = childGroups.takeFirst();
181 QRegExp filter("^LameXP_(\\d+)(\\d\\d)(\\d\\d\\d\\d\\d)$");
182 if(filter.indexIn(current) >= 0)
184 bool ok = false;
185 unsigned int temp = filter.cap(3).toUInt(&ok) + 10;
186 if(ok && (temp >= lamexp_version_build()))
188 continue;
191 qWarning("Deleting obsolete group from config: %s", current.toUtf8().constData());
192 REMOVE_GROUP(m_settings, current);
195 m_settings->beginGroup(groupKey);
196 m_settings->setValue(g_settingsId_versionNumber, QApplication::applicationVersion());
197 m_settings->sync();
200 ////////////////////////////////////////////////////////////
201 // Destructor
202 ////////////////////////////////////////////////////////////
204 SettingsModel::~SettingsModel(void)
206 LAMEXP_DELETE(m_settings);
207 LAMEXP_DELETE(m_defaultLanguage);
210 ////////////////////////////////////////////////////////////
211 // Public Functions
212 ////////////////////////////////////////////////////////////
214 void SettingsModel::validate(void)
216 if(this->compressionEncoder() < SettingsModel::MP3Encoder || this->compressionEncoder() > SettingsModel::PCMEncoder)
218 this->compressionEncoder(SettingsModel::MP3Encoder);
221 if(this->compressionRCMode() < SettingsModel::VBRMode || this->compressionRCMode() > SettingsModel::CBRMode)
223 this->compressionEncoder(SettingsModel::VBRMode);
226 if(!(lamexp_check_tool("neroAacEnc.exe") && lamexp_check_tool("neroAacDec.exe") && lamexp_check_tool("neroAacTag.exe")))
228 if(!(lamexp_check_tool("fhgaacenc.exe") && lamexp_check_tool("enc_fhgaac.dll")))
230 if(!(lamexp_check_tool("qaac.exe") && lamexp_check_tool("libsoxrate.dll")))
232 if(this->compressionEncoder() == SettingsModel::AACEncoder)
234 qWarning("AAC encoder selected, but not available any more. Reverting to MP3!");
235 this->compressionEncoder(SettingsModel::MP3Encoder);
241 if(this->outputDir().isEmpty() || !QFileInfo(this->outputDir()).isDir())
243 QString musicLocation = QDesktopServices::storageLocation(QDesktopServices::MusicLocation);
244 this->outputDir(musicLocation.isEmpty() ? QDesktopServices::storageLocation(QDesktopServices::HomeLocation) : musicLocation);
247 if(this->mostRecentInputPath().isEmpty() || !QFileInfo(this->mostRecentInputPath()).isDir())
249 QString musicLocation = QDesktopServices::storageLocation(QDesktopServices::MusicLocation);
250 this->outputDir(musicLocation.isEmpty() ? QDesktopServices::storageLocation(QDesktopServices::HomeLocation) : musicLocation);
253 if(!lamexp_query_translations().contains(this->currentLanguage(), Qt::CaseInsensitive))
255 qWarning("Current language \"%s\" is unknown, reverting to default language!", this->currentLanguage().toLatin1().constData());
256 this->currentLanguage(defaultLanguage());
259 if(this->hibernateComputer())
261 if(!lamexp_is_hibernation_supported())
263 this->hibernateComputer(false);
268 ////////////////////////////////////////////////////////////
269 // Private Functions
270 ////////////////////////////////////////////////////////////
272 QString SettingsModel::defaultLanguage(void)
274 if(m_defaultLanguage)
276 return *m_defaultLanguage;
279 //Detect system langauge
280 QLocale systemLanguage= QLocale::system();
281 qDebug("[Locale]");
282 qDebug("Language: %s (%d)", QLocale::languageToString(systemLanguage.language()).toUtf8().constData(), systemLanguage.language());
283 qDebug("Country is: %s (%d)", QLocale::countryToString(systemLanguage.country()).toUtf8().constData(), systemLanguage.country());
284 qDebug("Script is: %s (%d)\n", QLocale::scriptToString(systemLanguage.script()).toUtf8().constData(), systemLanguage.script());
286 //Check if we can use the default translation
287 if(systemLanguage.language() == QLocale::English /*|| systemLanguage.language() == QLocale::C*/)
289 m_defaultLanguage = new QString(LAMEXP_DEFAULT_LANGID);
290 return LAMEXP_DEFAULT_LANGID;
293 //Try to find a suitable translation for the user's system language *and* country
294 QStringList languages = lamexp_query_translations();
295 while(!languages.isEmpty())
297 QString currentLangId = languages.takeFirst();
298 if(lamexp_translation_sysid(currentLangId) == systemLanguage.language())
300 if(lamexp_translation_country(currentLangId) == systemLanguage.country())
302 m_defaultLanguage = new QString(currentLangId);
303 return currentLangId;
308 //Try to find a suitable translation for the user's system language
309 languages = lamexp_query_translations();
310 while(!languages.isEmpty())
312 QString currentLangId = languages.takeFirst();
313 if(lamexp_translation_sysid(currentLangId) == systemLanguage.language())
315 m_defaultLanguage = new QString(currentLangId);
316 return currentLangId;
320 //Fall back to the default translation
321 m_defaultLanguage = new QString(LAMEXP_DEFAULT_LANGID);
322 return LAMEXP_DEFAULT_LANGID;
325 QString SettingsModel::initDirectory(const QString &path)
327 if(path.isEmpty())
329 return QString();
332 if(!QDir(path).exists())
334 for(int i = 0; i < 32; i++)
336 if(QDir(path).mkpath(".")) break;
337 Sleep(1);
341 if(!QDir(path).exists())
343 return QString();
346 return QDir(path).canonicalPath();
349 ////////////////////////////////////////////////////////////
350 // Getter and Setter
351 ////////////////////////////////////////////////////////////
353 LAMEXP_MAKE_OPTION_I(licenseAccepted, 0)
354 LAMEXP_MAKE_OPTION_I(interfaceStyle, 0)
355 LAMEXP_MAKE_OPTION_I(compressionEncoder, 0)
356 LAMEXP_MAKE_OPTION_I(compressionRCMode, 0)
357 LAMEXP_MAKE_OPTION_I(compressionBitrate, 7)
358 LAMEXP_MAKE_OPTION_S(outputDir, QDesktopServices::storageLocation(QDesktopServices::MusicLocation))
359 LAMEXP_MAKE_OPTION_B(outputToSourceDir, false)
360 LAMEXP_MAKE_OPTION_B(prependRelativeSourcePath, false)
361 LAMEXP_MAKE_OPTION_S(favoriteOutputFolders, QString());
362 LAMEXP_MAKE_OPTION_B(writeMetaTags, true)
363 LAMEXP_MAKE_OPTION_B(createPlaylist, true)
364 LAMEXP_MAKE_OPTION_S(autoUpdateLastCheck, "Never")
365 LAMEXP_MAKE_OPTION_B(autoUpdateEnabled, true)
366 LAMEXP_MAKE_OPTION_B(autoUpdateCheckBeta, false)
367 LAMEXP_MAKE_OPTION_B(soundsEnabled, true)
368 LAMEXP_MAKE_OPTION_B(neroAacNotificationsEnabled, true)
369 LAMEXP_MAKE_OPTION_B(antivirNotificationsEnabled, true)
370 LAMEXP_MAKE_OPTION_B(dropBoxWidgetEnabled, true)
371 LAMEXP_MAKE_OPTION_B(shellIntegrationEnabled, !lamexp_portable_mode())
372 LAMEXP_MAKE_OPTION_S(currentLanguage, defaultLanguage())
373 LAMEXP_MAKE_OPTION_I(lameAlgoQuality, 3)
374 LAMEXP_MAKE_OPTION_I(lameChannelMode, 0)
375 LAMEXP_MAKE_OPTION_B(forceStereoDownmix, false)
376 LAMEXP_MAKE_OPTION_B(bitrateManagementEnabled, false)
377 LAMEXP_MAKE_OPTION_I(bitrateManagementMinRate, 32)
378 LAMEXP_MAKE_OPTION_I(bitrateManagementMaxRate, 500)
379 LAMEXP_MAKE_OPTION_I(samplingRate, 0)
380 LAMEXP_MAKE_OPTION_B(neroAACEnable2Pass, true)
381 LAMEXP_MAKE_OPTION_I(aacEncProfile, 0)
382 LAMEXP_MAKE_OPTION_I(aftenAudioCodingMode, 0);
383 LAMEXP_MAKE_OPTION_I(aftenDynamicRangeCompression, 5);
384 LAMEXP_MAKE_OPTION_B(aftenFastBitAllocation, false);
385 LAMEXP_MAKE_OPTION_I(aftenExponentSearchSize, 8);
386 LAMEXP_MAKE_OPTION_I(opusOptimizeFor, 0);
387 LAMEXP_MAKE_OPTION_I(opusComplexity, 10);
388 LAMEXP_MAKE_OPTION_I(opusFramesize, 3);
389 LAMEXP_MAKE_OPTION_B(opusExpAnalysis, true);
390 LAMEXP_MAKE_OPTION_B(normalizationFilterEnabled, false)
391 LAMEXP_MAKE_OPTION_I(normalizationFilterMaxVolume, -50)
392 LAMEXP_MAKE_OPTION_I(normalizationFilterEqualizationMode, 0);
393 LAMEXP_MAKE_OPTION_I(toneAdjustBass, 0)
394 LAMEXP_MAKE_OPTION_I(toneAdjustTreble, 0)
395 LAMEXP_MAKE_OPTION_S(customParametersLAME, QString());
396 LAMEXP_MAKE_OPTION_S(customParametersOggEnc, QString());
397 LAMEXP_MAKE_OPTION_S(customParametersAacEnc, QString());
398 LAMEXP_MAKE_OPTION_S(customParametersAften, QString());
399 LAMEXP_MAKE_OPTION_S(customParametersFLAC, QString());
400 LAMEXP_MAKE_OPTION_S(customParametersOpus, QString());
401 LAMEXP_MAKE_OPTION_B(renameOutputFilesEnabled, false);
402 LAMEXP_MAKE_OPTION_S(renameOutputFilesPattern, "[<TrackNo>] <Artist> - <Title>");
403 LAMEXP_MAKE_OPTION_U(metaInfoPosition, UINT_MAX);
404 LAMEXP_MAKE_OPTION_U(maximumInstances, 0);
405 LAMEXP_MAKE_OPTION_S(customTempPath, QDesktopServices::storageLocation(QDesktopServices::TempLocation));
406 LAMEXP_MAKE_OPTION_B(customTempPathEnabled, false);
407 LAMEXP_MAKE_OPTION_B(slowStartup, false);
408 LAMEXP_MAKE_OPTION_S(mostRecentInputPath, QDesktopServices::storageLocation(QDesktopServices::MusicLocation));
409 LAMEXP_MAKE_OPTION_B(hibernateComputer, false);