FFmpegExportProcessor Class Reference

Inheritance diagram for FFmpegExportProcessor:

Collaboration diagram for FFmpegExportProcessor:

Public Member Functions
	FFmpegExportProcessor (std::shared_ptr< FFmpegFunctions > ffmpeg, int format)
bool	Initialize (AudacityProject &project, const Parameters &parameters, const wxFileNameWrapper &filename, double t0, double t1, bool selectedOnly, double sampleRate, unsigned channels, MixerOptions::Downmix *mixerSpec, const Tags *tags) override
	Called before start processing. More...
ExportResult	Process (ExportProcessorDelegate &delegate) override
Public Member Functions inherited from ExportProcessor
	ExportProcessor (const ExportProcessor &)=delete
ExportProcessor &	operator= (const ExportProcessor &)=delete
	ExportProcessor ()=default
virtual	~ExportProcessor ()
virtual bool	Initialize (AudacityProject &project, const Parameters &parameters, const wxFileNameWrapper &filename, double t0, double t1, bool selectedOnly, double rate, unsigned channels, MixerOptions::Downmix *mixerSpec=nullptr, const Tags *tags=nullptr)=0
	Called before start processing. More...
virtual ExportResult	Process (ExportProcessorDelegate &delegate)=0

Private Attributes
std::shared_ptr< FFmpegFunctions >	mFFmpeg
struct {
int   subformat
TranslatableString   status
double   t0
double   t1
std::unique_ptr< Mixer >   mixer
std::unique_ptr< FFmpegExporter >   exporter
}	context

Additional Inherited Members
Public Types inherited from ExportProcessor
using	Parameters = std::vector< std::tuple< ExportOptionID, ExportValue > >

Detailed Description

Definition at line 662 of file ExportFFmpeg.cpp.

Constructor & Destructor Documentation

FFmpegExportProcessor()

FFmpegExportProcessor::FFmpegExportProcessor	(	std::shared_ptr< FFmpegFunctions >	ffmpeg,
		int	format
	)

Definition at line 1589 of file ExportFFmpeg.cpp.

   : mFFmpeg(std::move(ffmpeg))
{
   context.subformat = subformat;
}

References context, and subformat.

Member Function Documentation

Initialize()

bool FFmpegExportProcessor::Initialize ( AudacityProject &  project, const Parameters &  parameters, const wxFileNameWrapper &  filename, double  t0, double  t1, bool  selectedOnly, double  rate, unsigned  channels, MixerOptions::Downmix *  mixerSpec, const Tags *  tags  )

overridevirtual

Called before start processing.

Parameters

project	Processor may access project data, take care to exclude any data race
parameters	A format-dependent set of parameters used in exporting
selectedOnly	Set to true if all tracks should be mixed, to false if only the selected tracks should be mixed and exported.
tags	A Tags object that will over-ride the one in *project and be used to tag the file that is exported. @retern Implementations may simply return false without any error reporting. This is to temporarily preserve old behavior, which is to be removed in the nearest future.

Implements ExportProcessor.

Definition at line 1595 of file ExportFFmpeg.cpp.

{
   context.t0 = t0;
   context.t1 = t1;
   
   if (!FFmpegFunctions::Load())
   {
      throw ExportException(_("Properly configured FFmpeg is required to proceed.\nYou can configure it at Preferences > Libraries."));
   }
   // subformat index may not correspond directly to fmts[] index, convert it
   const auto adjustedFormatIndex = AdjustFormatIndex(context.subformat);
   if (channels > ExportFFmpegOptions::fmts[adjustedFormatIndex].maxchannels)
   {
      throw ExportException(XO("Attempted to export %d channels, but maximum number of channels for selected output format is %d")
         .Format(
            channels,
            ExportFFmpegOptions::fmts[adjustedFormatIndex].maxchannels )
         .Translation());
   }
 
   const auto &tracks = TrackList::Get( project );
   bool ret = true;
 
   if (adjustedFormatIndex >= FMT_LAST) {
      // TODO: more precise message
      throw ExportErrorException("FFmpeg:996");
   }
 
   wxString shortname(ExportFFmpegOptions::fmts[adjustedFormatIndex].shortname);
   if (adjustedFormatIndex == FMT_OTHER)
      shortname = ExportPluginHelpers::GetParameterValue<std::string>(parameters, FEFormatID, "matroska");
 
   context.exporter = std::make_unique<FFmpegExporter>(mFFmpeg, fName, channels, adjustedFormatIndex);
 
   ret = context.exporter->Init(shortname.mb_str(), &project, static_cast<int>(sampleRate), metadata, parameters);
   
   if (!ret) {
      // TODO: more precise message
      throw ExportErrorException("FFmpeg:1008");
   }
 
   context.mixer = context.exporter->CreateMixer(tracks, selectionOnly,
      t0, t1,
      mixerSpec);
 
   context.status = selectionOnly
         ? XO("Exporting selected audio as %s")
              .Format( ExportFFmpegOptions::fmts[adjustedFormatIndex].description )
         : XO("Exporting the audio as %s")
              .Format( ExportFFmpegOptions::fmts[adjustedFormatIndex].description );
 
   return true;
}

References _, AdjustFormatIndex(), context, FMT_LAST, FMT_OTHER, ExportFFmpegOptions::fmts, TrackList::Get(), FFmpegFunctions::Load(), mFFmpeg, project, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, t0, t1, tracks, and XO().

Here is the call graph for this function:

Process()

ExportResult FFmpegExportProcessor::Process ( ExportProcessorDelegate &  delegate )

overridevirtual

Implements ExportProcessor.

Definition at line 1655 of file ExportFFmpeg.cpp.

{
   delegate.SetStatusString(context.status);
   auto exportResult = ExportResult::Success;
   {
      while (exportResult == ExportResult::Success) {
         auto pcmNumSamples = context.mixer->Process();
         if (pcmNumSamples == 0)
            break;
 
         short *pcmBuffer = (short *)context.mixer->GetBuffer();
 
         if (!context.exporter->EncodeAudioFrame(pcmBuffer, pcmNumSamples))
            // All errors should already have been reported.
            return ExportResult::Error;
 
         if(exportResult == ExportResult::Success)
            exportResult = ExportPluginHelpers::UpdateProgress(
               delegate, *context.mixer, context.t0, context.t1);
      }
   }
 
   if ( exportResult != ExportResult::Cancelled )
      if ( !context.exporter->Finalize() ) // Finalize makes its own messages
         return ExportResult::Error;
   return exportResult;
}

References Cancelled, context, Error, ExportProcessorDelegate::SetStatusString(), Success, and ExportPluginHelpers::UpdateProgress().

Here is the call graph for this function:

Member Data Documentation

struct { ... } FFmpegExportProcessor::context

Referenced by FFmpegExportProcessor(), Initialize(), and Process().

exporter

std::unique_ptr<FFmpegExporter> FFmpegExportProcessor::exporter

Definition at line 673 of file ExportFFmpeg.cpp.

mFFmpeg

std::shared_ptr<FFmpegFunctions> FFmpegExportProcessor::mFFmpeg

private

Definition at line 664 of file ExportFFmpeg.cpp.

Referenced by Initialize().

mixer

std::unique_ptr<Mixer> FFmpegExportProcessor::mixer

Definition at line 672 of file ExportFFmpeg.cpp.

status

TranslatableString FFmpegExportProcessor::status

Definition at line 669 of file ExportFFmpeg.cpp.

subformat

int FFmpegExportProcessor::subformat

Definition at line 668 of file ExportFFmpeg.cpp.

Referenced by FFmpegExportProcessor().

t0

double FFmpegExportProcessor::t0

Definition at line 670 of file ExportFFmpeg.cpp.

Referenced by Initialize().

t1

double FFmpegExportProcessor::t1

Definition at line 671 of file ExportFFmpeg.cpp.

Referenced by Initialize().

---

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

• ExportFFmpeg.cpp