src/encoder_nvenc.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Simple x264 Launcher
   3 // Copyright (C) 2004-2016 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 "encoder_nvenc.h"
  23
  24 //Internal
  25 #include "global.h"
  26 #include "model_options.h"
  27 #include "model_status.h"
  28 #include "mediainfo.h"
  29 #include "model_sysinfo.h"
  30 #include "model_clipInfo.h"
  31
  32 //MUtils
  33 #include <MUtils/Exception.h>
  34
  35 //Qt
  36 #include <QStringList>
  37 #include <QDir>
  38 #include <QRegExp>
  39 #include <QPair>
  40
  41 //x265 version info
  42 static const unsigned int VERSION_NVENCC_MINIMUM_VER = 206;
  43 static const unsigned int VERSION_NVENCC_MINIMUM_API = 60;
  44
  45 // ------------------------------------------------------------
  46 // Helper Macros
  47 // ------------------------------------------------------------
  48
  49 #define NVENCC_UPDATE_PROGRESS(X) do \
  50 { \
  51         bool ok = false; \
  52         unsigned int progressFrames = (X)->cap(1).toUInt(&ok); \
  53         double progress = 0.0; \
  54         setStatus(JobStatus_Running); \
  55         if(ok && (clipInfo.getFrameCount() > 0)) \
  56         { \
  57                 progress = (double(progressFrames) / double(clipInfo.getFrameCount())); \
  58                 if(!qFuzzyCompare(progress, last_progress)) \
  59                 { \
  60                         setProgress(floor(progress * 100.0)); \
  61                         size_estimate = qFuzzyIsNull(size_estimate) ? estimateSize(m_outputFile, progress) : ((0.667 * size_estimate) + (0.333 * estimateSize(m_outputFile, progress))); \
  62                         last_progress = progress; \
  63                 } \
  64         } \
  65         setDetails(tr("[%1] %2, est. file size %3").arg(QString().sprintf("%.1f%%", 100.0 * progress), line.mid(offset).trimmed(), sizeToString(qRound64(size_estimate)))); \
  66 } \
  67 while(0)
  68
  69 #define REMOVE_CUSTOM_ARG(LIST, ITER, FLAG, PARAM) do \
  70 { \
  71         if(ITER != LIST.end()) \
  72         { \
  73                 if((*ITER).compare(PARAM, Qt::CaseInsensitive) == 0) \
  74                 { \
  75                         log(tr("WARNING: Custom parameter \"" PARAM "\" will be ignored in Pipe'd mode!\n")); \
  76                         ITER = LIST.erase(ITER); \
  77                         if(ITER != LIST.end()) \
  78                         { \
  79                                 if(!((*ITER).startsWith("--", Qt::CaseInsensitive))) ITER = LIST.erase(ITER); \
  80                         } \
  81                         FLAG = true; \
  82                 } \
  83         } \
  84 } \
  85 while(0)
  86
  87 // ------------------------------------------------------------
  88 // Encoder Info
  89 // ------------------------------------------------------------
  90
  91 class NVEncEncoderInfo : public AbstractEncoderInfo
  92 {
  93 public:
  94         virtual QString getName(void) const
  95         {
  96                 return "NVEncC";
  97         }
  98
  99         virtual QList<ArchId> getArchitectures(void) const
 100         {
 101                 return QList<ArchId>()
 102                 << qMakePair(QString("32-Bit (x86)"), ARCH_TYPE_X86)
 103                 << qMakePair(QString("64-Bit (x64)"), ARCH_TYPE_X64);
 104         }
 105
 106         virtual QStringList getVariants(void) const
 107         {
 108                 return QStringList() << "AVC" << "HEVC";
 109         }
 110
 111         virtual QList<RCMode> getRCModes(void) const
 112         {
 113                 return QList<RCMode>()
 114                 << qMakePair(QString("CQP"),  RC_TYPE_QUANTIZER)
 115                 << qMakePair(QString("VBR"),  RC_TYPE_RATE_KBPS)
 116                 << qMakePair(QString("VBR2"), RC_TYPE_RATE_KBPS)
 117                 << qMakePair(QString("CBR"),  RC_TYPE_RATE_KBPS);
 118         }
 119
 120         virtual QStringList getTunings(void) const
 121         {
 122                 return QStringList();
 123         }
 124
 125         virtual QStringList getPresets(void) const
 126         {
 127                 return QStringList();
 128         }
 129
 130         virtual QStringList getProfiles(const quint32 &variant) const
 131         {
 132                 QStringList profiles;
 133                 switch(variant)
 134                 {
 135                         case 0: profiles << "baseline" << "main" << "high"; break;
 136                         case 1: profiles << "main";                         break;
 137                         default: MUTILS_THROW("Unknown encoder variant!");
 138                 }
 139                 return profiles;
 140         }
 141
 142         virtual QStringList supportedOutputFormats(void) const
 143         {
 144                 QStringList extLst;
 145                 extLst << "mp4" << "264" << "hevc";
 146                 return extLst;
 147         }
 148
 149         virtual bool isInputTypeSupported(const int format) const
 150         {
 151                 switch(format)
 152                 {
 153                 case MediaInfo::FILETYPE_YUV4MPEG2:
 154                         return true;
 155                 default:
 156                         return false;
 157                 }
 158         }
 159
 160         virtual QString getBinaryPath(const SysinfoModel *sysinfo, const quint32 &encArch, const quint32 &encVariant) const
 161         {
 162                 QString arch;
 163                 switch(encArch)
 164                 {
 165                         case 0: arch = "x86"; break;
 166                         case 1: arch = "x64"; break;
 167                         default: MUTILS_THROW("Unknown encoder arch!");
 168                 }
 169                 switch(encVariant)
 170                 {
 171                         case 0: break;
 172                         case 1: break;
 173                         default: MUTILS_THROW("Unknown encoder variant!");
 174                 }
 175                 return QString("%1/toolset/%2/nvencc_%2.exe").arg(sysinfo->getAppPath(), arch);
 176         }
 177
 178         virtual QStringList getDependencies(const SysinfoModel *sysinfo, const quint32 &encArch, const quint32 &encVariant) const
 179         {
 180                 QString arch;
 181                 switch (encArch)
 182                 {
 183                         case 0: arch = "x86"; break;
 184                         case 1: arch = "x64"; break;
 185                         default: MUTILS_THROW("Unknown encoder arch!");
 186                 }
 187                 switch (encVariant)
 188                 {
 189                         case 0: break;
 190                         case 1: break;
 191                         default: MUTILS_THROW("Unknown encoder variant!");
 192
 193                 }
 194                 return QStringList()
 195                 << QString("%1/toolset/%2/avcodec-57.dll"  ).arg(sysinfo->getAppPath(), arch)
 196                 << QString("%1/toolset/%2/avfilter-6.dll"  ).arg(sysinfo->getAppPath(), arch)
 197                 << QString("%1/toolset/%2/avformat-57.dll" ).arg(sysinfo->getAppPath(), arch)
 198                 << QString("%1/toolset/%2/avutil-55.dll"   ).arg(sysinfo->getAppPath(), arch)
 199                 << QString("%1/toolset/%2/swresample-2.dll").arg(sysinfo->getAppPath(), arch);
 200         }
 201
 202         virtual QString getHelpCommand(void) const
 203         {
 204                 return "--help";
 205         }
 206 };
 207
 208 static const NVEncEncoderInfo s_nvencEncoderInfo;
 209
 210 const AbstractEncoderInfo& NVEncEncoder::encoderInfo(void)
 211 {
 212         return s_nvencEncoderInfo;
 213 }
 214
 215 const AbstractEncoderInfo &NVEncEncoder::getEncoderInfo(void) const
 216 {
 217         return encoderInfo();
 218 }
 219
 220 // ------------------------------------------------------------
 221 // Constructor & Destructor
 222 // ------------------------------------------------------------
 223
 224 NVEncEncoder::NVEncEncoder(JobObject *jobObject, const OptionsModel *options, const SysinfoModel *const sysinfo, const PreferencesModel *const preferences, JobStatus &jobStatus, volatile bool *abort, volatile bool *pause, QSemaphore *semaphorePause, const QString &sourceFile, const QString &outputFile)
 225 :
 226         AbstractEncoder(jobObject, options, sysinfo, preferences, jobStatus, abort, pause, semaphorePause, sourceFile, outputFile)
 227 {
 228         if(options->encType() != OptionsModel::EncType_NVEnc)
 229         {
 230                 MUTILS_THROW("Invalid encoder type!");
 231         }
 232 }
 233
 234 NVEncEncoder::~NVEncEncoder(void)
 235 {
 236         /*Nothing to do here*/
 237 }
 238
 239 QString NVEncEncoder::getName(void) const
 240 {
 241         return s_nvencEncoderInfo.getFullName(m_options->encArch(), m_options->encVariant());
 242 }
 243
 244 // ------------------------------------------------------------
 245 // Check Version
 246 // ------------------------------------------------------------
 247
 248 void NVEncEncoder::checkVersion_init(QList<QRegExp*> &patterns, QStringList &cmdLine)
 249 {
 250         cmdLine << "--version";
 251         patterns << new QRegExp("\\bNVEncC\\s+\\(\\w+\\)\\s+(\\d)\\.(\\d+)\\s+by\\s+rigaya\\s+\\[NVENC\\s+API\\s+v(\\d+)\\.(\\d+)\\]", Qt::CaseInsensitive);
 252 }
 253
 254 void NVEncEncoder::checkVersion_parseLine(const QString &line, QList<QRegExp*> &patterns, unsigned int &core, unsigned int &build, bool &modified)
 255 {
 256         int offset = -1;
 257
 258         if((offset = patterns[0]->lastIndexIn(line)) >= 0)
 259         {
 260                 bool ok[4] = { false, false, false, false };
 261                 unsigned int temp[4];
 262                 temp[0] = patterns[0]->cap(1).toUInt(&ok[0]);
 263                 temp[1] = patterns[0]->cap(2).toUInt(&ok[1]);
 264                 temp[2] = patterns[0]->cap(2).toUInt(&ok[2]);
 265                 temp[3] = patterns[0]->cap(2).toUInt(&ok[3]);
 266                 if(ok[0] && ok[1])
 267                 {
 268                         core = (100 * temp[0]) + temp[1];
 269                 }
 270                 if (ok[2] && ok[3])
 271                 {
 272                         build = (10 * temp[2]) + temp[3];
 273                 }
 274         }
 275
 276         if(!line.isEmpty())
 277         {
 278                 log(line);
 279         }
 280 }
 281
 282 bool NVEncEncoder::checkVersion_succeeded(const int &exitCode)
 283 {
 284         return (exitCode == 0) || (exitCode == 1);
 285 }
 286
 287 QString NVEncEncoder::printVersion(const unsigned int &revision, const bool &modified)
 288 {
 289         unsigned int core, build;
 290         splitRevision(revision, core, build);
 291
 292         return tr("NVEncC version: %1.%2").arg(QString::number(core / 100), QString::number(core % 100).leftJustified(2, QLatin1Char('0')));
 293 }
 294
 295 bool NVEncEncoder::isVersionSupported(const unsigned int &revision, const bool &modified)
 296 {
 297         unsigned int core, build;
 298         splitRevision(revision, core, build);
 299
 300         if(core < VERSION_NVENCC_MINIMUM_VER)
 301         {
 302                 log(tr("\nERROR: Your version of NVEncC is too old! (Minimum required version is %1.%2)").arg(QString::number(VERSION_NVENCC_MINIMUM_VER / 100), QString::number(VERSION_NVENCC_MINIMUM_VER % 100)));
 303                 return false;
 304         }
 305         else if(core > VERSION_NVENCC_MINIMUM_VER)
 306         {
 307                 log(tr("\nWARNING: Your version of NVEncC is newer than the latest tested version, take care!"));
 308                 log(tr("This application works best with NVEncC version %1.%2. Newer versions may work or not.").arg(QString::number(VERSION_NVENCC_MINIMUM_VER / 100), QString::number(VERSION_NVENCC_MINIMUM_VER % 100)));
 309         }
 310
 311         if (build < VERSION_NVENCC_MINIMUM_API)
 312         {
 313                 log(tr("\nERROR: Your version of NVENC API is too old! (Minimum required version is %1.%2)").arg(QString::number(VERSION_NVENCC_MINIMUM_API / 10), QString::number(VERSION_NVENCC_MINIMUM_API % 10)));
 314                 return false;
 315         }
 316
 317         return true;
 318 }
 319
 320 // ------------------------------------------------------------
 321 // Encoding Functions
 322 // ------------------------------------------------------------
 323
 324 void NVEncEncoder::buildCommandLine(QStringList &cmdLine, const bool &usePipe, const ClipInfo &clipInfo, const QString &indexFile, const int &pass, const QString &passLogFile)
 325 {
 326         switch (m_options->encVariant())
 327         {
 328         case 0:
 329                 cmdLine << "--codec" << "avc";
 330                 break;
 331         case 1:
 332                 cmdLine << "--codec" << "hevc";
 333                 break;
 334         default:
 335                 MUTILS_THROW("Bad encoder variant !!!");
 336         }
 337
 338         switch(m_options->rcMode())
 339         {
 340         case 0:
 341                 cmdLine << "--cqp" << QString::number(qRound(m_options->quantizer()));
 342                 break;
 343         case 1:
 344                 cmdLine << "--vbr" << QString::number(m_options->bitrate());
 345                 break;
 346         case 2:
 347                 cmdLine << "--vbr2" << QString::number(m_options->bitrate());
 348                 break;
 349         case 3:
 350                 cmdLine << "--cbr" << QString::number(m_options->bitrate());
 351                 break;
 352         default:
 353                 MUTILS_THROW("Bad rate-control mode !!!");
 354         }
 355
 356         const QString profile = m_options->profile().simplified().toLower();
 357         if(!profile.isEmpty())
 358         {
 359                 if(profile.compare(QString::fromLatin1(OptionsModel::PROFILE_UNRESTRICTED), Qt::CaseInsensitive) != 0)
 360                 {
 361                         cmdLine << "--profile" << profile;
 362                 }
 363         }
 364
 365         if(!m_options->customEncParams().isEmpty())
 366         {
 367                 QStringList customArgs = splitParams(m_options->customEncParams(), m_sourceFile, m_outputFile);
 368                 if(usePipe)
 369                 {
 370                         QStringList::iterator i = customArgs.begin();
 371                         while(i != customArgs.end())
 372                         {
 373                                 bool bModified = false;
 374                                 REMOVE_CUSTOM_ARG(customArgs, i, bModified, "--fps");
 375                                 REMOVE_CUSTOM_ARG(customArgs, i, bModified, "--frames");
 376                                 if(!bModified) i++;
 377                         }
 378                 }
 379                 cmdLine.append(customArgs);
 380         }
 381
 382         cmdLine << "--output" << QDir::toNativeSeparators(m_outputFile);
 383
 384         if(usePipe)
 385         {
 386                 cmdLine << "--y4m" << "--input" << "-";
 387         }
 388         else
 389         {
 390                 cmdLine << "--input" << QDir::toNativeSeparators(m_sourceFile);
 391         }
 392 }
 393
 394 void NVEncEncoder::runEncodingPass_init(QList<QRegExp*> &patterns)
 395 {
 396         patterns << new QRegExp("^(\\d+) frames:");
 397         patterns << new QRegExp("Selected\\s+codec\\s+is\\s+not\\s+supported", Qt::CaseInsensitive);
 398         patterns << new QRegExp("nvEncodeAPI.dll\\s+does\\s+not\\s+exists\\s+in\\s+your\\s+system", Qt::CaseInsensitive);
 399 }
 400
 401 void NVEncEncoder::runEncodingPass_parseLine(const QString &line, QList<QRegExp*> &patterns, const ClipInfo &clipInfo, const int &pass, double &last_progress, double &size_estimate)
 402 {
 403         int offset = -1;
 404         if((offset = patterns[0]->lastIndexIn(line)) >= 0)
 405         {
 406                 NVENCC_UPDATE_PROGRESS(patterns[0]);
 407         }
 408         else if ((offset = patterns[1]->lastIndexIn(line)) >= 0)
 409         {
 410                 log(QString("ERROR: YOUR HARDWARE DOES *NOT* SUPPORT THE '%1' CODEC !!!\n").arg(s_nvencEncoderInfo.variantToString(m_options->encVariant())));
 411         }
 412         else if ((offset = patterns[2]->lastIndexIn(line)) >= 0)
 413         {
 414                 log("ERROR: NVIDIA ENCODER API (NVENCODEAPI.DLL) IS *NOT* AVAILABLE !!!\n");
 415         }
 416         else if(!line.isEmpty())
 417         {
 418                 log(line);
 419         }
 420 }