src/Encoder_Abstract.h

   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 #pragma once
  24
  25 //Internal
  26 #include "Global.h"
  27 #include "Tool_Abstract.h"
  28 #include "Model_AudioFile.h"
  29
  30 //MUtils
  31 #include <MUtils/Exception.h>
  32
  33 class QProcess;
  34 class QStringList;
  35 class QMutex;
  36
  37 class AbstractEncoderInfo
  38 {
  39 public:
  40         typedef enum
  41         {
  42                 TYPE_BITRATE = 0,
  43                 TYPE_APPROX_BITRATE = 1,
  44                 TYPE_QUALITY_LEVEL_INT = 2,
  45                 TYPE_QUALITY_LEVEL_FLT = 3,
  46                 TYPE_COMPRESSION_LEVEL = 4,
  47                 TYPE_UNCOMPRESSED = 5
  48         }
  49         value_type_t;
  50
  51         virtual bool isModeSupported(int mode)   const = 0;     //Returns whether the encoder does support the current RC mode
  52         virtual int valueCount(int mode)         const = 0;     //The number of bitrate/quality values for current RC mode
  53         virtual int valueAt(int mode, int index) const = 0;     //The bitrate/quality value at 'index' for the current RC mode
  54         virtual int valueType(int mode)          const = 0;     //The display type of the values for the current RC mode
  55         virtual const char* description(void)    const = 0;     //Description of the encoder that can be displayed to the user
  56         virtual const char* extension(void)      const = 0;     //The default file extension for files created by this encoder
  57 };
  58
  59 class AbstractEncoder : public AbstractTool
  60 {
  61         Q_OBJECT
  62
  63 public:
  64         AbstractEncoder(void);
  65         virtual ~AbstractEncoder(void);
  66
  67         //Internal encoder API
  68         virtual bool encode(const QString &sourceFile, const AudioFileModel_MetaInfo &metaInfo, const unsigned int duration, const QString &outputFile, volatile bool *abortFlag) = 0;
  69         virtual bool isFormatSupported(const QString &containerType, const QString &containerProfile, const QString &formatType, const QString &formatProfile, const QString &formatVersion) = 0;
  70         virtual const unsigned int *supportedSamplerates(void);
  71         virtual const unsigned int *supportedChannelCount(void);
  72         virtual const unsigned int *supportedBitdepths(void);
  73         virtual const bool needsTimingInfo(void);
  74
  75         //Common setter methods
  76         virtual void setBitrate(int bitrate);
  77         virtual void setRCMode(int mode);
  78         virtual void setCustomParams(const QString &customParams);
  79
  80         //Encoder info
  81         virtual const AbstractEncoderInfo *toEncoderInfo(void) const = 0;
  82         static const AbstractEncoderInfo *getEncoderInfo(void)
  83         {
  84                 MUTILS_THROW("This method shall be re-implemented in derived classes!");
  85                 return NULL;
  86         }
  87
  88 protected:
  89         int m_configBitrate;                    //Bitrate *or* VBR-quality-level
  90         int m_configRCMode;                             //Rate-control mode
  91         QString m_configCustomParams;   //Custom parameters, if any
  92
  93         //Helper functions
  94         bool isUnicode(const QString &text);
  95         QString cleanTag(const QString &text);
  96 };