src/model_options.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Simple x264 Launcher
   3 // Copyright (C) 2004-2023 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_options.h"
  23
  24 //Internal
  25 #include "global.h"
  26 #include "model_sysinfo.h"
  27
  28 //Mutils
  29 #include <MUtils/Global.h>
  30
  31 //Qt
  32 #include <QDesktopServices>
  33 #include <QSettings>
  34 #include <QStringList>
  35 #include <QApplication>
  36
  37 #define COMPARE_VAL(OTHER, NAME) ((this->NAME) == (OTHER->NAME))
  38 #define COMPARE_STR(OTHER, NAME) ((this->NAME).compare((model->NAME), Qt::CaseInsensitive) == 0)
  39 #define ASSIGN_FROM(OTHER, NAME) ((this->NAME) = (OTHER.NAME))
  40
  41 //Template keys
  42 static const char *KEY_ENCODER_TYPE    = "encoder_type";
  43 static const char *KEY_ENCODER_ARCH    = "encoder_arch";
  44 static const char *KEY_ENCODER_VARIANT = "encoder_variant";
  45 static const char *KEY_RATECTRL_MODE   = "rate_control_mode";
  46 static const char *KEY_TARGET_BITRATE  = "target_bitrate";
  47 static const char *KEY_TARGET_QUANT    = "target_quantizer";
  48 static const char *KEY_PRESET_NAME     = "preset_name";
  49 static const char *KEY_TUNING_NAME     = "tuning_name";
  50 static const char *KEY_PROFILE_NAME    = "profile_name";
  51 static const char *KEY_CUSTOM_ENCODER  = "custom_params_encoder";
  52 static const char *KEY_CUSTOM_AVS2YUV  = "custom_params_avs2yuv";
  53
  54 const char *const OptionsModel::SETTING_UNSPECIFIED   = "<None>";
  55 const char *const OptionsModel::PROFILE_UNRESTRICTED = "<Unrestricted>";
  56
  57 OptionsModel::OptionsModel(const SysinfoModel *sysinfo)
  58 {
  59         m_encoderType = EncType_X264;
  60         m_encoderArch = sysinfo->getCPUFeatures(SysinfoModel::CPUFeatures_X64) ? 0 : 1;
  61         m_encoderVariant = 0;
  62         m_rcMode = 0;
  63         m_bitrate = 1200;
  64         m_quantizer = 22;
  65         m_preset = "Medium";
  66         m_tune = QString::fromLatin1(OptionsModel::SETTING_UNSPECIFIED);
  67         m_profile = QString::fromLatin1(OptionsModel::PROFILE_UNRESTRICTED);
  68         m_custom_encoder = QString();
  69         m_custom_avs2yuv = QString();
  70 }
  71
  72 OptionsModel::OptionsModel(const OptionsModel &rhs)
  73 {
  74         ASSIGN_FROM(rhs, m_encoderType);
  75         ASSIGN_FROM(rhs, m_encoderArch);
  76         ASSIGN_FROM(rhs, m_encoderVariant);
  77         ASSIGN_FROM(rhs, m_rcMode);
  78         ASSIGN_FROM(rhs, m_bitrate);
  79         ASSIGN_FROM(rhs, m_quantizer);
  80         ASSIGN_FROM(rhs, m_preset);
  81         ASSIGN_FROM(rhs, m_tune);
  82         ASSIGN_FROM(rhs, m_profile);
  83         ASSIGN_FROM(rhs, m_custom_encoder);
  84         ASSIGN_FROM(rhs, m_custom_avs2yuv);
  85 }
  86
  87 OptionsModel::~OptionsModel(void)
  88 {
  89 }
  90
  91 bool OptionsModel::equals(const OptionsModel *model)
  92 {
  93         bool equal = true;
  94
  95         equal = equal && COMPARE_VAL(model, m_encoderType);
  96         equal = equal && COMPARE_VAL(model, m_encoderArch);
  97         equal = equal && COMPARE_VAL(model, m_encoderVariant);
  98         equal = equal && COMPARE_VAL(model, m_rcMode);
  99         equal = equal && COMPARE_VAL(model, m_bitrate);
 100         equal = equal && COMPARE_VAL(model, m_quantizer);
 101         equal = equal && COMPARE_STR(model, m_preset);
 102         equal = equal && COMPARE_STR(model, m_tune);
 103         equal = equal && COMPARE_STR(model, m_profile);
 104         equal = equal && COMPARE_STR(model, m_custom_encoder);
 105         equal = equal && COMPARE_STR(model, m_custom_avs2yuv);
 106
 107         return equal;
 108 }
 109
 110 bool OptionsModel::saveTemplate(const OptionsModel *model, const QString &name)
 111 {
 112         const QString templateName = name.simplified();
 113         const QString appDir = x264_data_path();
 114
 115         if(templateName.contains('\\') || templateName.contains('/'))
 116         {
 117                 return false;
 118         }
 119
 120         QSettings settings(QString("%1/templates.ini").arg(appDir), QSettings::IniFormat);
 121         settings.beginGroup(templateName);
 122
 123         const bool okay = saveOptions(model, settings);
 124
 125         settings.endGroup();
 126         settings.sync();
 127
 128         return okay;
 129 }
 130
 131 bool OptionsModel::loadTemplate(OptionsModel *model, const QString &name)
 132 {
 133         const QString appDir = x264_data_path();
 134
 135         if(name.contains('\\') || name.contains('/'))
 136         {
 137                 return false;
 138         }
 139
 140         QSettings settings(QString("%1/templates.ini").arg(appDir), QSettings::IniFormat);
 141
 142         settings.beginGroup(name);
 143         const bool okay = loadOptions(model, settings);
 144         settings.endGroup();
 145
 146         return okay;
 147 }
 148
 149 QMap<QString, OptionsModel*> OptionsModel::loadAllTemplates(const SysinfoModel *sysinfo)
 150 {
 151         QMap<QString, OptionsModel*> list;
 152         const QString appDir = x264_data_path();
 153         QSettings settings(QString("%1/templates.ini").arg(appDir), QSettings::IniFormat);
 154         QStringList allTemplates = settings.childGroups();
 155
 156         while(!allTemplates.isEmpty())
 157         {
 158                 QString name = allTemplates.takeFirst();
 159                 if(!(name.contains('<') || name.contains('>') || name.contains('\\') || name.contains('/')))
 160                 {
 161                         OptionsModel *options = new OptionsModel(sysinfo);
 162                         if(loadTemplate(options, name))
 163                         {
 164                                 list.insert(name, options);
 165                                 continue;
 166                         }
 167                         MUTILS_DELETE(options);
 168                 }
 169         }
 170
 171         return list;
 172 }
 173
 174 bool OptionsModel::templateExists(const QString &name)
 175 {
 176         const QString appDir = x264_data_path();
 177         QSettings settings(QString("%1/templates.ini").arg(appDir), QSettings::IniFormat);
 178         QStringList allGroups = settings.childGroups();
 179         return allGroups.contains(name, Qt::CaseInsensitive);
 180 }
 181
 182 bool OptionsModel::deleteTemplate(const QString &name)
 183 {
 184         const QString appDir = x264_data_path();
 185         QSettings settings(QString("%1/templates.ini").arg(appDir), QSettings::IniFormat);
 186
 187         if(settings.childGroups().contains(name, Qt::CaseInsensitive))
 188         {
 189                 settings.remove(name);
 190                 return true;
 191         }
 192
 193         return false;
 194 }
 195
 196 bool OptionsModel::saveOptions(const OptionsModel *model, QSettings &settingsFile)
 197 {
 198         settingsFile.setValue(KEY_ENCODER_TYPE,    model->m_encoderType);
 199         settingsFile.setValue(KEY_ENCODER_ARCH,    model->m_encoderArch);
 200         settingsFile.setValue(KEY_ENCODER_VARIANT, model->m_encoderVariant);
 201         settingsFile.setValue(KEY_RATECTRL_MODE,   model->m_rcMode);
 202         settingsFile.setValue(KEY_TARGET_BITRATE,  model->m_bitrate);
 203         settingsFile.setValue(KEY_TARGET_QUANT,    model->m_quantizer);
 204         settingsFile.setValue(KEY_PRESET_NAME,     model->m_preset);
 205         settingsFile.setValue(KEY_TUNING_NAME,     model->m_tune);
 206         settingsFile.setValue(KEY_PROFILE_NAME,    model->m_profile);
 207         settingsFile.setValue(KEY_CUSTOM_ENCODER,  model->m_custom_encoder);
 208         settingsFile.setValue(KEY_CUSTOM_AVS2YUV,  model->m_custom_avs2yuv);
 209
 210         return true;
 211 }
 212
 213 bool OptionsModel::loadOptions(OptionsModel *model, QSettings &settingsFile)
 214 {
 215         fixTemplate(settingsFile); /*for backward compatibility*/
 216
 217         bool complete = true;
 218         if(!settingsFile.contains(KEY_ENCODER_TYPE))    complete = false;
 219         if(!settingsFile.contains(KEY_ENCODER_ARCH))    complete = false;
 220         if(!settingsFile.contains(KEY_ENCODER_VARIANT)) complete = false;
 221         if(!settingsFile.contains(KEY_RATECTRL_MODE))   complete = false;
 222         if(!settingsFile.contains(KEY_TARGET_BITRATE))  complete = false;
 223         if(!settingsFile.contains(KEY_TARGET_QUANT))    complete = false;
 224         if(!settingsFile.contains(KEY_PRESET_NAME))     complete = false;
 225         if(!settingsFile.contains(KEY_TUNING_NAME))     complete = false;
 226         if(!settingsFile.contains(KEY_PROFILE_NAME))    complete = false;
 227         if(!settingsFile.contains(KEY_CUSTOM_ENCODER))  complete = false;
 228         if(!settingsFile.contains(KEY_CUSTOM_AVS2YUV))  complete = false;
 229
 230         if(complete)
 231         {
 232                 model->setEncType        (settingsFile.value(KEY_ENCODER_TYPE,    model->m_encoderType)   .toInt());
 233                 model->setEncArch        (settingsFile.value(KEY_ENCODER_ARCH,    model->m_encoderArch)   .toInt());
 234                 model->setEncVariant     (settingsFile.value(KEY_ENCODER_VARIANT, model->m_encoderVariant).toInt());
 235                 model->setRCMode         (settingsFile.value(KEY_RATECTRL_MODE,   model->m_rcMode)        .toInt());
 236                 model->setBitrate        (settingsFile.value(KEY_TARGET_BITRATE,  model->m_bitrate)       .toUInt());
 237                 model->setQuantizer      (settingsFile.value(KEY_TARGET_QUANT,    model->m_quantizer)     .toDouble());
 238                 model->setPreset         (settingsFile.value(KEY_PRESET_NAME,     model->m_preset)        .toString());
 239                 model->setTune           (settingsFile.value(KEY_TUNING_NAME,     model->m_tune)          .toString());
 240                 model->setProfile        (settingsFile.value(KEY_PROFILE_NAME,    model->m_profile)       .toString());
 241                 model->setCustomEncParams(settingsFile.value(KEY_CUSTOM_ENCODER,  model->m_custom_encoder).toString());
 242                 model->setCustomAvs2YUV  (settingsFile.value(KEY_CUSTOM_AVS2YUV,  model->m_custom_avs2yuv).toString());
 243         }
 244
 245         return complete;
 246 }
 247
 248 void OptionsModel::fixTemplate(QSettings &settingsFile)
 249 {
 250         if(!(settingsFile.contains(KEY_ENCODER_TYPE) || settingsFile.contains(KEY_ENCODER_ARCH) || settingsFile.contains(KEY_ENCODER_VARIANT)))
 251         {
 252                 settingsFile.setValue(KEY_ENCODER_TYPE,    0);
 253                 settingsFile.setValue(KEY_ENCODER_ARCH,    0);
 254                 settingsFile.setValue(KEY_ENCODER_VARIANT, 0);
 255         }
 256
 257         static const char *legacyKey[] = { "custom_params", "custom_params_x264", NULL };
 258         for(int i = 0; legacyKey[i]; i++)
 259         {
 260                 if(settingsFile.contains(legacyKey[i]))
 261                 {
 262                         settingsFile.setValue(KEY_CUSTOM_ENCODER, settingsFile.value(legacyKey[i]));
 263                         settingsFile.remove(legacyKey[i]);
 264                 }
 265         }
 266
 267         if(settingsFile.value(KEY_PROFILE_NAME).toString().compare("auto", Qt::CaseInsensitive) == 0)
 268         {
 269                 settingsFile.setValue(KEY_PROFILE_NAME, QString::fromLatin1(OptionsModel::PROFILE_UNRESTRICTED));
 270         }
 271         if(settingsFile.value(KEY_TUNING_NAME).toString().compare("none", Qt::CaseInsensitive) == 0)
 272         {
 273                 settingsFile.setValue(KEY_TUNING_NAME, QString::fromLatin1(OptionsModel::SETTING_UNSPECIFIED));
 274         }
 275 }