ExportFFmpeg Class Reference

Controlling class for FFmpeg exporting. Creates the options dialog of the appropriate type, adds tags and invokes the export function. More...

Inheritance diagram for ExportFFmpeg:

Collaboration diagram for ExportFFmpeg:

Public Member Functions
	ExportFFmpeg ()
	~ExportFFmpeg () override
std::unique_ptr< ExportOptionsEditor >	CreateOptionsEditor (int format, ExportOptionsEditor::Listener *listener) const override
	Creates format-dependent options editor, that is used to create a valid set of parameters to be used in exporting. More...
int	GetFormatCount () const override
FormatInfo	GetFormatInfo (int index) const override
	Returns FormatInfo structure for given index if it's valid, or a default one. FormatInfo::format isn't guaranteed to be unique. More...
bool	CheckFileName (wxFileName &filename, int format=0) const override
	Callback, called from GetFilename. More...
std::unique_ptr< ExportProcessor >	CreateProcessor (int format) const override
Public Member Functions inherited from ExportPlugin
	ExportPlugin ()
virtual	~ExportPlugin ()
virtual int	GetFormatCount () const =0
virtual FormatInfo	GetFormatInfo (int index) const =0
	Returns FormatInfo structure for given index if it's valid, or a default one. FormatInfo::format isn't guaranteed to be unique. More...
virtual std::unique_ptr< ExportOptionsEditor >	CreateOptionsEditor (int formatIndex, ExportOptionsEditor::Listener *listener) const =0
	Creates format-dependent options editor, that is used to create a valid set of parameters to be used in exporting. More...
virtual std::vector< std::string >	GetMimeTypes (int formatIndex) const
virtual bool	ParseConfig (int formatIndex, const rapidjson::Value &config, ExportProcessor::Parameters &parameters) const
	Attempt to parse configuration JSON object and produce a suitable set of parameters. Configuration is format dependent. More...
virtual bool	CheckFileName (wxFileName &filename, int format=0) const
virtual std::unique_ptr< ExportProcessor >	CreateProcessor (int format) const =0

Private Attributes
std::shared_ptr< FFmpegFunctions >	mFFmpeg
std::vector< FormatInfo >	mFormatInfos

Detailed Description

Controlling class for FFmpeg exporting. Creates the options dialog of the appropriate type, adds tags and invokes the export function.

Definition at line 691 of file ExportFFmpeg.cpp.

Constructor & Destructor Documentation

ExportFFmpeg()

ExportFFmpeg::ExportFFmpeg

(

)

Definition at line 738 of file ExportFFmpeg.cpp.

{
   mFFmpeg = FFmpegFunctions::Load();
 
   int avfver = mFFmpeg ? mFFmpeg->AVFormatVersion.GetIntVersion() : 0;
 
   int newfmt;
   // Adds export types from the export type list
   for (newfmt = 0; newfmt < FMT_LAST; newfmt++)
   {
      wxString shortname(ExportFFmpegOptions::fmts[newfmt].shortname);
      // Don't hide export types when there's no av-libs, and don't hide FMT_OTHER
      if (newfmt < FMT_OTHER && mFFmpeg)
      {
         // Format/Codec support is compiled in?
         auto avoformat = mFFmpeg->GuessOutputFormat(shortname.mb_str(), nullptr, nullptr);
         auto avcodec = mFFmpeg->CreateEncoder(mFFmpeg->GetAVCodecID(ExportFFmpegOptions::fmts[newfmt].codecid));
 
         if (avoformat == NULL || avcodec == NULL)
         {
            ExportFFmpegOptions::fmts[newfmt].compiledIn = false;
            continue;
         }
      }
      FormatInfo formatInfo {};
      formatInfo.format = ExportFFmpegOptions::fmts[newfmt].name;
      formatInfo.extensions.push_back(ExportFFmpegOptions::fmts[newfmt].extension);
      // For some types add other extensions
      switch(newfmt)
      {
      case FMT_M4A:
         formatInfo.extensions.push_back(wxT("3gp"));
         formatInfo.extensions.push_back(wxT("m4r"));
         formatInfo.extensions.push_back(wxT("mp4"));
         break;
      case FMT_WMA2:
         formatInfo.extensions.push_back(wxT("asf"));
         formatInfo.extensions.push_back(wxT("wmv"));
         break;
      default:
         break;
      }
      formatInfo.maxChannels = ExportFFmpegOptions::fmts[newfmt].maxchannels;
      formatInfo.description = ExportFFmpegOptions::fmts[newfmt].description;
 
      const int canmeta = ExportFFmpegOptions::fmts[newfmt].canmetadata;
      formatInfo.canMetaData = canmeta && (canmeta == AV_CANMETA || canmeta <= avfver);
      
      mFormatInfos.push_back(std::move(formatInfo));
   }
}

References AV_CANMETA, ExposedFormat::canmetadata, ExposedFormat::codecid, ExposedFormat::compiledIn, ExposedFormat::description, anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, FMT_LAST, FMT_M4A, FMT_OTHER, FMT_WMA2, ExportFFmpegOptions::fmts, FormatInfo::format, FFmpegFunctions::Load(), ExposedFormat::maxchannels, mFFmpeg, mFormatInfos, ExposedFormat::name, and wxT().

Here is the call graph for this function:

~ExportFFmpeg()

ExportFFmpeg::~ExportFFmpeg ( )

overridedefault

Member Function Documentation

CheckFileName()

bool ExportFFmpeg::CheckFileName ( wxFileName &  filename, int  format = 0  ) const

overridevirtual

Callback, called from GetFilename.

Reimplemented from ExportPlugin.

Definition at line 836 of file ExportFFmpeg.cpp.

{
   bool result = true;
 
   // Show "Locate FFmpeg" dialog
   mFFmpeg = FFmpegFunctions::Load();
   if (!mFFmpeg)
   {
      FindFFmpegLibs();
      mFFmpeg = FFmpegFunctions::Load();
 
      return LoadFFmpeg(true);
   }
 
   return result;
}

References FindFFmpegLibs(), FFmpegFunctions::Load(), LoadFFmpeg(), and mFFmpeg.

Here is the call graph for this function:

CreateOptionsEditor()

std::unique_ptr< ExportOptionsEditor > ExportFFmpeg::CreateOptionsEditor ( int  formatIndex, ExportOptionsEditor::Listener *  listener  ) const

overridevirtual

Creates format-dependent options editor, that is used to create a valid set of parameters to be used in exporting.

Parameters

listener

Option listener object that could be used by the editor to report on option changes.

Implements ExportPlugin.

Definition at line 793 of file ExportFFmpeg.cpp.

{
   switch(AdjustFormatIndex(format))
   {
   case FMT_M4A:
      return std::make_unique<PlainExportOptionsEditor>(AACOptions, listener);
   case FMT_AC3:
      return std::make_unique<PlainExportOptionsEditor>(
         AC3Options,
         ToSampleRateList(iAC3SampleRates),
         listener);
   case FMT_AMRNB:
      return std::make_unique<PlainExportOptionsEditor>(
         AMRNBOptions,
         ExportOptionsEditor::SampleRateList {8000},
         listener);
#ifdef SHOW_FFMPEG_OPUS_EXPORT
   case FMT_OPUS:
      return std::make_unique<PlainExportOptionsEditor>(OPUSOptions, listener);
#endif
   case FMT_WMA2:
      return std::make_unique<PlainExportOptionsEditor>(
         WMAOptions,
         ToSampleRateList(iWMASampleRates),
         listener);
   case FMT_OTHER:
      return std::make_unique<ExportOptionsFFmpegCustomEditor>(listener);
   }
   return {};
}

References anonymous_namespace{ExportFFmpeg.cpp}::AACOptions, anonymous_namespace{ExportFFmpeg.cpp}::AC3Options, AdjustFormatIndex(), anonymous_namespace{ExportFFmpeg.cpp}::AMRNBOptions, FMT_AC3, FMT_AMRNB, FMT_M4A, FMT_OTHER, FMT_WMA2, anonymous_namespace{ExportPCM.cpp}::format, anonymous_namespace{ExportFFmpeg.cpp}::iAC3SampleRates, anonymous_namespace{ExportFFmpeg.cpp}::iWMASampleRates, anonymous_namespace{ExportOpus.cpp}::OPUSOptions, anonymous_namespace{ExportFFmpeg.cpp}::ToSampleRateList(), and anonymous_namespace{ExportFFmpeg.cpp}::WMAOptions.

Here is the call graph for this function:

CreateProcessor()

std::unique_ptr< ExportProcessor > ExportFFmpeg::CreateProcessor ( int  format ) const

overridevirtual

Parameters

format

Control which of the multiple formats this exporter is capable of exporting should be used. Used where a single export plug-in handles a number of related formats, but they have separate entries in the Format drop-down list box. For example, the options to export to "Other PCM", "AIFF 16 Bit" and "WAV 16 Bit" are all the same libsndfile export plug-in, but with subformat set to 0, 1, and 2 respectively.

Implements ExportPlugin.

Definition at line 853 of file ExportFFmpeg.cpp.

{
   return std::make_unique<FFmpegExportProcessor>(mFFmpeg, format);
}

References anonymous_namespace{ExportPCM.cpp}::format, and mFFmpeg.

GetFormatCount()

int ExportFFmpeg::GetFormatCount ( ) const

overridevirtual

Implements ExportPlugin.

Definition at line 824 of file ExportFFmpeg.cpp.

{
   return static_cast<int>(mFormatInfos.size());
}

References mFormatInfos.

GetFormatInfo()

FormatInfo ExportFFmpeg::GetFormatInfo ( int  index ) const

overridevirtual

Returns FormatInfo structure for given index if it's valid, or a default one. FormatInfo::format isn't guaranteed to be unique.

Parameters

index

Should not exceed the number of formats provided by GetFormatCount()

Implements ExportPlugin.

Definition at line 829 of file ExportFFmpeg.cpp.

{
   if(index >= 0 && index < mFormatInfos.size())
      return mFormatInfos[index];
   return mFormatInfos[FMT_OTHER];
}

References FMT_OTHER, and mFormatInfos.

Member Data Documentation

mFFmpeg

std::shared_ptr<FFmpegFunctions> ExportFFmpeg::mFFmpeg

mutableprivate

Definition at line 710 of file ExportFFmpeg.cpp.

Referenced by CheckFileName(), CreateProcessor(), and ExportFFmpeg().

mFormatInfos

std::vector<FormatInfo> ExportFFmpeg::mFormatInfos

private

Definition at line 712 of file ExportFFmpeg.cpp.

Referenced by ExportFFmpeg(), GetFormatCount(), and GetFormatInfo().

---

The documentation for this class was generated from the following file:

• ExportFFmpeg.cpp