FFmpegImportPlugin Class Reference

An ImportPlugin for FFmpeg data. More...

Inheritance diagram for FFmpegImportPlugin:

Collaboration diagram for FFmpegImportPlugin:

Public Member Functions
	FFmpegImportPlugin ()
	~FFmpegImportPlugin ()
wxString	GetPluginStringID () override
TranslatableString	GetPluginFormatDescription () override
TranslatableString	FailureHint () const override
	User visible message suggesting what to do when a file type isn't recognized; default empty string. More...
std::unique_ptr< ImportFileHandle >	Open (const FilePath &Filename, AudacityProject *) override
	! Probes the file and opens it if appropriate More...
Public Member Functions inherited from ImportPlugin
virtual wxString	GetPluginStringID ()=0
virtual TranslatableString	GetPluginFormatDescription ()=0
virtual FileExtensions	GetSupportedExtensions ()
virtual TranslatableString	FailureHint () const
	User visible message suggesting what to do when a file type isn't recognized; default empty string. More...
bool	SupportsExtension (const FileExtension &extension)
virtual std::unique_ptr< ImportFileHandle >	Open (const FilePath &Filename, AudacityProject *)=0
virtual	~ImportPlugin ()

Additional Inherited Members
Protected Member Functions inherited from ImportPlugin
	ImportPlugin (FileExtensions supportedExtensions)
Protected Attributes inherited from ImportPlugin
const FileExtensions	mExtensions

Detailed Description

An ImportPlugin for FFmpeg data.

A representative of FFmpeg loader in the Audacity import plugin list

Definition at line 154 of file ImportFFmpeg.cpp.

Constructor & Destructor Documentation

FFmpegImportPlugin()

FFmpegImportPlugin::FFmpegImportPlugin ( )

inline

Definition at line 157 of file ImportFFmpeg.cpp.

                       :
      ImportPlugin( FileExtensions( exts.begin(), exts.end() ) )
   {
   }

~FFmpegImportPlugin()

FFmpegImportPlugin::~FFmpegImportPlugin ( )

inline

Definition at line 162 of file ImportFFmpeg.cpp.

{ }

Member Function Documentation

FailureHint()

TranslatableString FFmpegImportPlugin::FailureHint ( ) const

inlineoverridevirtual

User visible message suggesting what to do when a file type isn't recognized; default empty string.

Should end with one newline if not empty

Reimplemented from ImportPlugin.

Definition at line 167 of file ImportFFmpeg.cpp.

   {
      return !FFmpegFunctions::Load()
         ? XO("Try installing FFmpeg.\n") : TranslatableString{};
   }

References FFmpegFunctions::Load(), and XO().

Here is the call graph for this function:

GetPluginFormatDescription()

TranslatableString FFmpegImportPlugin::GetPluginFormatDescription ( )

overridevirtual

Implements ImportPlugin.

Definition at line 280 of file ImportFFmpeg.cpp.

{
   return DESC;
}

References DESC.

GetPluginStringID()

wxString FFmpegImportPlugin::GetPluginStringID ( )

inlineoverridevirtual

Implements ImportPlugin.

Definition at line 164 of file ImportFFmpeg.cpp.

{ return wxT("libav"); }

References wxT().

Here is the call graph for this function:

Open()

std::unique_ptr< ImportFileHandle > FFmpegImportPlugin::Open ( const FilePath &  Filename, AudacityProject *    )

overridevirtual

! Probes the file and opens it if appropriate

Implements ImportPlugin.

Definition at line 285 of file ImportFFmpeg.cpp.

{
   auto ffmpeg = FFmpegFunctions::Load();
 
   //Check if we're loading explicitly supported format
   wxString extension = filename.AfterLast(wxT('.'));
   if (SupportsExtension(extension))
   {
      //Audacity is trying to load something that is declared as
      //officially supported by this plugin.
      //If we don't have FFmpeg configured - tell the user about it.
      //Since this will be happening often, use disableable "FFmpeg not found" dialog
      //insdead of usual AudacityMessageBox()
      bool newsession = NewImportingSession.Read();
      if (!ffmpeg)
      {
         auto dontShowDlg = FFmpegNotFoundDontShow.Read();
         if (dontShowDlg == 0 && newsession)
         {
            NewImportingSession.Write(false);
            gPrefs->Flush();
            FFmpegNotFoundDialog{ nullptr }.ShowModal();
 
            ffmpeg = FFmpegFunctions::Load();
         }
      }
   }
   if (!ffmpeg)
   {
      return nullptr;
   }
 
   // Construct the handle only after any reloading of ffmpeg functions
   auto handle = std::make_unique<FFmpegImportFileHandle>(filename);
 
   // Open the file for import
   bool success = handle->Init();
 
   if (!success) {
      return nullptr;
   }
 
   return handle;
}

References anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, FFmpegNotFoundDontShow, audacity::BasicSettings::Flush(), gPrefs, FFmpegFunctions::Load(), NewImportingSession, Setting< T >::Read(), ImportPlugin::SupportsExtension(), Setting< T >::Write(), and wxT().

Here is the call graph for this function:

---

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

• ImportFFmpeg.cpp