FFmpeg.cpp File Reference

#include "FFmpeg.h"
#include "FFmpegFunctions.h"
#include "ModuleConstants.h"
#include "FileNames.h"
#include "SelectFile.h"
#include "HelpSystem.h"
#include "AudacityMessageBox.h"
#include "ShuttleGui.h"
#include <wx/checkbox.h>
#include <wx/dynlib.h>
#include <wx/file.h>
#include <wx/log.h>
#include <wx/textctrl.h>

Include dependency graph for FFmpeg.cpp:

Go to the source code of this file.

Classes
class	FindFFmpegDialog
	Allows user to locate libav* libraries. More...

Macros
#define	DEFINE_FFMPEG_POINTERS
#define	ID_FFMPEG_BROWSE   5000
#define	ID_FFMPEG_DLOAD   5001

Functions
bool	LoadFFmpeg (bool showerror)
void	FFmpegStartup ()
TranslatableString	GetFFmpegVersion ()
bool	FindFFmpegLibs (wxWindow *parent)
DEFINE_VERSION_CHECK DLL_API int	ModuleDispatch (ModuleDispatchTypes type)

Variables
static BoolSetting	FFmpegEnabled { L"/FFmpeg/Enabled", false }
BoolSetting	FFmpegNotFoundDontShow { L"/FFmpeg/NotFoundDontShow", false }

Macro Definition Documentation

DEFINE_FFMPEG_POINTERS

#define DEFINE_FFMPEG_POINTERS

Definition at line 18 of file FFmpeg.cpp.

ID_FFMPEG_BROWSE

#define ID_FFMPEG_BROWSE   5000

Definition at line 101 of file FFmpeg.cpp.

ID_FFMPEG_DLOAD

#define ID_FFMPEG_DLOAD   5001

Definition at line 102 of file FFmpeg.cpp.

Function Documentation

FFmpegStartup()

void FFmpegStartup

(

)

Called during Audacity start-up to try and load the ffmpeg libraries

Definition at line 58 of file FFmpeg.cpp.

{
   bool enabled = FFmpegEnabled.Read();
   // 'false' means that no errors should be shown whatsoever
   if (!LoadFFmpeg(false))
   {
      if (enabled)
      {
         AudacityMessageBox(XO(
"FFmpeg was configured in Preferences and successfully loaded before, \
\nbut this time Audacity failed to load it at startup. \
\n\nYou may want to go back to Preferences > Libraries and re-configure it."),
            XO("FFmpeg startup failed"));
      }
   }
}

References AudacityMessageBox(), FFmpegEnabled, LoadFFmpeg(), Setting< T >::Read(), and XO().

Referenced by ModuleDispatch().

Here is the call graph for this function:

Here is the caller graph for this function:

FindFFmpegLibs()

bool FindFFmpegLibs

(

wxWindow *

parent

)

Definition at line 303 of file FFmpeg.cpp.

{
   wxString path;
 
#if defined(__WXMSW__)
   const wxString name = wxT("avformat.dll");
#elif defined(__WXMAC__)
   const wxString name = wxT("libavformat.dylib");
#else
   const wxString name = wxT("libavformat.so");
#endif
 
   wxLogMessage(wxT("Looking for FFmpeg libraries..."));
 
   auto searchPaths = FFmpegFunctions::GetSearchPaths(false);
 
   if (!searchPaths.empty())
      path = searchPaths.front();
 
   FindFFmpegDialog fd(parent, path, name);
 
   if (fd.ShowModal() == wxID_CANCEL) {
      wxLogMessage(wxT("User canceled the dialog. Failed to find FFmpeg libraries."));
      return false;
   }
 
   path = fd.GetLibPath();
 
   const wxFileName fileName(path);
 
   if (fileName.FileExists())
      path = fileName.GetPath();
 
   wxLogMessage(wxT("User-specified path = '%s'"), path);
 
   SettingTransaction transaction;
   AVFormatPath.Write(path);
 
   // Try to load FFmpeg from the user provided path
   if (!FFmpegFunctions::Load(true))
   {
      wxLogError(wxT("User-specified path does not contain FFmpeg libraries."));
      return false;
   }
 
   transaction.Commit();
 
   wxLogMessage(wxT("User-specified FFmpeg file exists. Success."));
 
   return true;
}

References AVFormatPath, SettingTransaction::Commit(), FindFFmpegDialog::GetLibPath(), FFmpegFunctions::GetSearchPaths(), FFmpegFunctions::Load(), name, Setting< T >::Write(), and wxT().

Referenced by anonymous_namespace{ExportFFmpeg.cpp}::ExportOptionsFFmpegCustomEditor::CheckFFmpeg(), ExportFFmpeg::CheckFileName(), and anonymous_namespace{FFmpegPrefs.cpp}::OnFFmpegFindButton().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFFmpegVersion()

TranslatableString GetFFmpegVersion

(

)

Definition at line 75 of file FFmpeg.cpp.

{
   auto ffmpeg = FFmpegFunctions::Load();
 
   if (ffmpeg)
   {
      return Verbatim(
         wxString::Format(
            wxT("F(%d.%d.%d),C(%d.%d.%d),U(%d.%d.%d)"),
            ffmpeg->AVFormatVersion.Major, ffmpeg->AVFormatVersion.Minor, ffmpeg->AVFormatVersion.Micro,
            ffmpeg->AVCodecVersion.Major, ffmpeg->AVCodecVersion.Minor, ffmpeg->AVCodecVersion.Micro,
            ffmpeg->AVUtilVersion.Major, ffmpeg->AVUtilVersion.Minor, ffmpeg->AVUtilVersion.Micro
       ));
   }
 
   return XO("FFmpeg library not found");
}

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

Referenced by anonymous_namespace{FFmpegPrefs.cpp}::SetFFmpegVersionText().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadFFmpeg()

bool LoadFFmpeg

(

bool

showerror

)

Definition at line 39 of file FFmpeg.cpp.

{
   auto ffmpeg = FFmpegFunctions::Load();
 
   if (!ffmpeg)
   {
      FFmpegEnabled.Write(false);
      gPrefs->Flush();
      return false;
   }
   else
   {
      FFmpegEnabled.Write(true);
      gPrefs->Flush();
      return true;
   }
}

References FFmpegEnabled, audacity::BasicSettings::Flush(), gPrefs, FFmpegFunctions::Load(), and Setting< T >::Write().

Referenced by anonymous_namespace{ExportFFmpeg.cpp}::ExportOptionsFFmpegCustomEditor::CheckFFmpeg(), ExportFFmpeg::CheckFileName(), FFmpegStartup(), and anonymous_namespace{FFmpegPrefs.cpp}::OnFFmpegFindButton().

Here is the call graph for this function:

Here is the caller graph for this function:

ModuleDispatch()

int ModuleDispatch

(

ModuleDispatchTypes

type

)

Definition at line 359 of file FFmpeg.cpp.

{
   if(type == ModuleInitialize)
      FFmpegStartup();
   return 1;
}

References FFmpegStartup(), and ModuleInitialize.

Here is the call graph for this function:

Variable Documentation

FFmpegEnabled

BoolSetting FFmpegEnabled { L"/FFmpeg/Enabled", false }

static

Definition at line 37 of file FFmpeg.cpp.

Referenced by FFmpegStartup(), and LoadFFmpeg().

FFmpegNotFoundDontShow

BoolSetting FFmpegNotFoundDontShow { L"/FFmpeg/NotFoundDontShow", false }

Definition at line 355 of file FFmpeg.cpp.

Referenced by FFmpegNotFoundDialog::OnOk(), FFmpegImportPlugin::Open(), and FFmpegNotFoundDialog::PopulateOrExchange().