FLACImportPlugin Class Reference

An ImportPlugin for FLAC data. More...

Inheritance diagram for FLACImportPlugin:

Collaboration diagram for FLACImportPlugin:

Public Member Functions
	FLACImportPlugin ()
	~FLACImportPlugin ()
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

An ImportPlugin for FLAC data.

Definition at line 98 of file ImportFLAC.cpp.

Constructor & Destructor Documentation

FLACImportPlugin()

FLACImportPlugin::FLACImportPlugin ( )

inline

Definition at line 101 of file ImportFLAC.cpp.

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

~FLACImportPlugin()

FLACImportPlugin::~FLACImportPlugin ( )

inline

Definition at line 106 of file ImportFLAC.cpp.

{ }

Member Function Documentation

GetPluginFormatDescription()

TranslatableString FLACImportPlugin::GetPluginFormatDescription ( )

overridevirtual

Implements ImportPlugin.

Definition at line 269 of file ImportFLAC.cpp.

{
    return DESC;
}

References DESC.

GetPluginStringID()

wxString FLACImportPlugin::GetPluginStringID ( )

inlineoverridevirtual

Implements ImportPlugin.

Definition at line 108 of file ImportFLAC.cpp.

{ return wxT("libflac"); }

References wxT().

Here is the call graph for this function:

Open()

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

overridevirtual

Implements ImportPlugin.

Definition at line 275 of file ImportFLAC.cpp.

{
   // First check if it really is a FLAC file
 
   int cnt;
   wxFile binaryFile;
   if (!binaryFile.Open(filename)) {
      return nullptr; // File not found
   }
 
   // FIXME: TRAP_ERR wxFILE ops in FLAC Import could fail.
   // Seek() return value is not examined, for example.
#ifdef USE_LIBID3TAG
   // Skip any ID3 tags that might be present
   id3_byte_t query[ID3_TAG_QUERYSIZE];
   cnt = binaryFile.Read(query, sizeof(query));
   cnt = id3_tag_query(query, cnt);
   binaryFile.Seek(cnt);
#endif
 
   char buf[5];
   cnt = binaryFile.Read(buf, 4);
   binaryFile.Close();
 
   if (cnt == wxInvalidOffset || strncmp(buf, FLAC_HEADER, 4) != 0) {
      // File is not a FLAC file
      return nullptr;
   }
 
   // Open the file for import
   auto handle = std::make_unique<FLACImportFileHandle>(filename);
 
   bool success = handle->Init();
   if (!success) {
      return nullptr;
   }
 
   // This std::move is needed to "upcast" the pointer type
   return std::move(handle);
}

References FLAC_HEADER.

---

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

• ImportFLAC.cpp