src/Encoder_Opus.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // LameXP - Audio Encoder Front-End
   3 // Copyright (C) 2004-2015 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, but always including the *additional*
   9 // restrictions defined in the "License.txt" file.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License along
  17 // with this program; if not, write to the Free Software Foundation, Inc.,
  18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 //
  20 // http://www.gnu.org/licenses/gpl-2.0.txt
  21 ///////////////////////////////////////////////////////////////////////////////
  22
  23 #include "Encoder_Opus.h"
  24
  25 #include "Global.h"
  26 #include "Model_Settings.h"
  27
  28 #include <QProcess>
  29 #include <QDir>
  30 #include <QUUid>
  31
  32 ///////////////////////////////////////////////////////////////////////////////
  33 // Encoder Info
  34 ///////////////////////////////////////////////////////////////////////////////
  35
  36 class OpusEncoderInfo : public AbstractEncoderInfo
  37 {
  38         virtual bool isModeSupported(int mode) const
  39         {
  40                 switch(mode)
  41                 {
  42                 case SettingsModel::VBRMode:
  43                 case SettingsModel::ABRMode:
  44                 case SettingsModel::CBRMode:
  45                         return true;
  46                         break;
  47                 default:
  48                         MUTILS_THROW("Bad RC mode specified!");
  49                 }
  50         }
  51
  52         virtual int valueCount(int mode) const
  53         {
  54                 switch(mode)
  55                 {
  56                 case SettingsModel::VBRMode:
  57                 case SettingsModel::ABRMode:
  58                 case SettingsModel::CBRMode:
  59                         return 32;
  60                         break;
  61                 default:
  62                         MUTILS_THROW("Bad RC mode specified!");
  63                 }
  64         }
  65
  66         virtual int valueAt(int mode, int index) const
  67         {
  68                 switch(mode)
  69                 {
  70                 case SettingsModel::VBRMode:
  71                 case SettingsModel::ABRMode:
  72                 case SettingsModel::CBRMode:
  73                         return qBound(8, (index + 1) * 8, 256);
  74                         break;
  75                 default:
  76                         MUTILS_THROW("Bad RC mode specified!");
  77                 }
  78         }
  79
  80         virtual int valueType(int mode) const
  81         {
  82                 switch(mode)
  83                 {
  84                 case SettingsModel::VBRMode:
  85                 case SettingsModel::ABRMode:
  86                         return TYPE_APPROX_BITRATE;
  87                         break;
  88                 case SettingsModel::CBRMode:
  89                         return TYPE_BITRATE;
  90                         break;
  91                 default:
  92                         MUTILS_THROW("Bad RC mode specified!");
  93                 }
  94         }
  95
  96         virtual const char *description(void) const
  97         {
  98                 static const char* s_description = "Opus-Tools OpusEnc (libopus)";
  99                 return s_description;
 100         }
 101
 102         virtual const char *extension(void) const
 103         {
 104                 static const char* s_extension = "opus";
 105                 return s_extension;
 106         }
 107 }
 108 static const g_opusEncoderInfo;
 109
 110 ///////////////////////////////////////////////////////////////////////////////
 111 // Encoder implementation
 112 ///////////////////////////////////////////////////////////////////////////////
 113
 114 OpusEncoder::OpusEncoder(void)
 115 :
 116         m_binary(lamexp_tools_lookup("opusenc.exe"))
 117 {
 118         if(m_binary.isEmpty())
 119         {
 120                 MUTILS_THROW("Error initializing Opus encoder. Tool 'opusenc.exe' is not registred!");
 121         }
 122
 123         m_configOptimizeFor = 0;
 124         m_configEncodeComplexity = 10;
 125         m_configFrameSize = 3;
 126 }
 127
 128 OpusEncoder::~OpusEncoder(void)
 129 {
 130 }
 131
 132 bool OpusEncoder::encode(const QString &sourceFile, const AudioFileModel_MetaInfo &metaInfo, const unsigned int duration, const QString &outputFile, volatile bool *abortFlag)
 133 {
 134         QProcess process;
 135         QStringList args;
 136
 137         switch(m_configRCMode)
 138         {
 139         case SettingsModel::VBRMode:
 140                 args << "--vbr";
 141                 break;
 142         case SettingsModel::ABRMode:
 143                 args << "--cvbr";
 144                 break;
 145         case SettingsModel::CBRMode:
 146                 args << "--hard-cbr";
 147                 break;
 148         default:
 149                 MUTILS_THROW("Bad rate-control mode!");
 150                 break;
 151         }
 152
 153         args << "--comp" << QString::number(m_configEncodeComplexity);
 154
 155         switch(m_configFrameSize)
 156         {
 157         case 0:
 158                 args << "--framesize" << "2.5";
 159                 break;
 160         case 1:
 161                 args << "--framesize" << "5";
 162                 break;
 163         case 2:
 164                 args << "--framesize" << "10";
 165                 break;
 166         case 3:
 167                 args << "--framesize" << "20";
 168                 break;
 169         case 4:
 170                 args << "--framesize" << "40";
 171                 break;
 172         case 5:
 173                 args << "--framesize" << "60";
 174                 break;
 175         }
 176
 177         args << QString("--bitrate") << QString::number(qBound(8, (m_configBitrate + 1) * 8, 256));
 178
 179         if(!metaInfo.title().isEmpty())   args << "--title"   << cleanTag(metaInfo.title());
 180         if(!metaInfo.artist().isEmpty())  args << "--artist"  << cleanTag(metaInfo.artist());
 181         if(!metaInfo.album().isEmpty())   args << "--album"   << cleanTag(metaInfo.album());
 182         if(!metaInfo.genre().isEmpty())   args << "--genre"   << cleanTag(metaInfo.genre());
 183         if(metaInfo.year())               args << "--date"    << QString::number(metaInfo.year());
 184         if(metaInfo.position())           args << "--comment" << QString("tracknumber=%1").arg(QString::number(metaInfo.position()));
 185         if(!metaInfo.comment().isEmpty()) args << "--comment" << QString("comment=%1").arg(cleanTag(metaInfo.comment()));
 186         if(!metaInfo.cover().isEmpty())   args << "--picture" << QDir::toNativeSeparators(metaInfo.cover());
 187
 188
 189         if(!m_configCustomParams.isEmpty()) args << m_configCustomParams.split(" ", QString::SkipEmptyParts);
 190
 191         args << QDir::toNativeSeparators(sourceFile);
 192         args << QDir::toNativeSeparators(outputFile);
 193
 194         if(!startProcess(process, m_binary, args))
 195         {
 196                 return false;
 197         }
 198
 199         bool bTimeout = false;
 200         bool bAborted = false;
 201         int prevProgress = -1;
 202
 203         QRegExp regExp("\\((\\d+)%\\)");
 204
 205         while(process.state() != QProcess::NotRunning)
 206         {
 207                 if(*abortFlag)
 208                 {
 209                         process.kill();
 210                         bAborted = true;
 211                         emit messageLogged("\nABORTED BY USER !!!");
 212                         break;
 213                 }
 214                 process.waitForReadyRead(m_processTimeoutInterval);
 215                 if(!process.bytesAvailable() && process.state() == QProcess::Running)
 216                 {
 217                         process.kill();
 218                         qWarning("Opus process timed out <-- killing!");
 219                         emit messageLogged("\nPROCESS TIMEOUT !!!");
 220                         bTimeout = true;
 221                         break;
 222                 }
 223                 while(process.bytesAvailable() > 0)
 224                 {
 225                         QByteArray line = process.readLine();
 226                         QString text = QString::fromUtf8(line.constData()).simplified();
 227                         if(regExp.lastIndexIn(text) >= 0)
 228                         {
 229                                 bool ok = false;
 230                                 int progress = regExp.cap(1).toInt(&ok);
 231                                 if(ok && (progress > prevProgress))
 232                                 {
 233                                         emit statusUpdated(progress);
 234                                         prevProgress = qMin(progress + 2, 99);
 235                                 }
 236                         }
 237                         else if(!text.isEmpty())
 238                         {
 239                                 emit messageLogged(text);
 240                         }
 241                 }
 242         }
 243
 244         process.waitForFinished();
 245         if(process.state() != QProcess::NotRunning)
 246         {
 247                 process.kill();
 248                 process.waitForFinished(-1);
 249         }
 250
 251         emit statusUpdated(100);
 252         emit messageLogged(QString().sprintf("\nExited with code: 0x%04X", process.exitCode()));
 253
 254         if(bTimeout || bAborted || process.exitCode() != EXIT_SUCCESS)
 255         {
 256                 return false;
 257         }
 258
 259         return true;
 260 }
 261
 262 void OpusEncoder::setOptimizeFor(int optimizeFor)
 263 {
 264         m_configOptimizeFor = qBound(0, optimizeFor, 2);
 265 }
 266
 267 void OpusEncoder::setEncodeComplexity(int complexity)
 268 {
 269         m_configEncodeComplexity = qBound(0, complexity, 10);
 270 }
 271
 272 void OpusEncoder::setFrameSize(int frameSize)
 273 {
 274         m_configFrameSize = qBound(0, frameSize, 5);
 275 }
 276
 277 bool OpusEncoder::isFormatSupported(const QString &containerType, const QString &containerProfile, const QString &formatType, const QString &formatProfile, const QString &formatVersion)
 278 {
 279         if(containerType.compare("Wave", Qt::CaseInsensitive) == 0)
 280         {
 281                 if(formatType.compare("PCM", Qt::CaseInsensitive) == 0)
 282                 {
 283                         return true;
 284                 }
 285         }
 286
 287         return false;
 288 }
 289
 290 const unsigned int *OpusEncoder::supportedChannelCount(void)
 291 {
 292         return NULL;
 293 }
 294
 295 const unsigned int *OpusEncoder::supportedBitdepths(void)
 296 {
 297         static const unsigned int supportedBPS[] = {8, 16, 24, AudioFileModel::BITDEPTH_IEEE_FLOAT32, NULL};
 298         return supportedBPS;
 299 }
 300
 301 const bool OpusEncoder::needsTimingInfo(void)
 302 {
 303         return true;
 304 }
 305
 306 const AbstractEncoderInfo *OpusEncoder::getEncoderInfo(void)
 307 {
 308         return &g_opusEncoderInfo;
 309 }