OggImportPlugin Class Reference

Inheritance diagram for OggImportPlugin:

Collaboration diagram for OggImportPlugin:

Public Member Functions
	OggImportPlugin ()
	~OggImportPlugin ()
wxString	GetPluginStringID () override
TranslatableString	GetPluginFormatDescription () override
std::unique_ptr< ImportFileHandle >	Open (const FilePath &Filename, AudacityProject *) override
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

Definition at line 56 of file ImportOGG.cpp.

Constructor & Destructor Documentation

OggImportPlugin()

OggImportPlugin::OggImportPlugin ( )

inline

Definition at line 59 of file ImportOGG.cpp.

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

~OggImportPlugin()

OggImportPlugin::~OggImportPlugin ( )

inline

Definition at line 64 of file ImportOGG.cpp.

{ }

Member Function Documentation

GetPluginFormatDescription()

TranslatableString OggImportPlugin::GetPluginFormatDescription ( )

overridevirtual

Implements ImportPlugin.

Definition at line 138 of file ImportOGG.cpp.

{
    return DESC;
}

References DESC.

GetPluginStringID()

wxString OggImportPlugin::GetPluginStringID ( )

inlineoverridevirtual

Implements ImportPlugin.

Definition at line 66 of file ImportOGG.cpp.

{ return wxT("liboggvorbis"); }

References wxT().

Here is the call graph for this function:

Open()

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

overridevirtual

Implements ImportPlugin.

Definition at line 143 of file ImportOGG.cpp.

{
   // Suppress some compiler warnings about unused global variables in the library header
   wxUnusedVar(OV_CALLBACKS_DEFAULT);
   wxUnusedVar(OV_CALLBACKS_NOCLOSE);
   wxUnusedVar(OV_CALLBACKS_STREAMONLY);
   wxUnusedVar(OV_CALLBACKS_STREAMONLY_NOCLOSE);
 
   auto vorbisFile = std::make_unique<OggVorbis_File>();
   auto file = std::make_unique<wxFFile>(filename, wxT("rb"));
 
   if (!file->IsOpened()) {
      // No need for a message box, it's done automatically (but how?)
      return nullptr;
   }
 
   int err = ov_open(file->fp(), vorbisFile.get(), NULL, 0);
 
   if (err < 0) {
      TranslatableString message;
 
      switch (err) {
         case OV_EREAD:
            message = XO("Media read error");
            break;
         case OV_ENOTVORBIS:
            message = XO("Not an Ogg Vorbis file");
            break;
         case OV_EVERSION:
            message = XO("Vorbis version mismatch");
            break;
         case OV_EBADHEADER:
            message = XO("Invalid Vorbis bitstream header");
            break;
         case OV_EFAULT:
            message = XO("Internal logic fault");
            break;
      }
 
      // what to do with message?
      return nullptr;
   }
 
   return std::make_unique<OggImportFileHandle>(filename, std::move(file), std::move(vorbisFile));
}

References wxT(), and XO().

Here is the call graph for this function:

---

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

• ImportOGG.cpp