PCMImportPlugin Class Reference

An ImportPlugin for PCM data. More...

Inheritance diagram for PCMImportPlugin:

Collaboration diagram for PCMImportPlugin:

Public Member Functions
	PCMImportPlugin ()
	~PCMImportPlugin ()
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 PCM data.

Definition at line 59 of file ImportPCM.cpp.

Constructor & Destructor Documentation

PCMImportPlugin()

PCMImportPlugin::PCMImportPlugin ( )

inline

Definition at line 62 of file ImportPCM.cpp.

   :  ImportPlugin(sf_get_all_extensions())
   {
   }

~PCMImportPlugin()

PCMImportPlugin::~PCMImportPlugin ( )

inline

Definition at line 67 of file ImportPCM.cpp.

{ }

Member Function Documentation

GetPluginFormatDescription()

TranslatableString PCMImportPlugin::GetPluginFormatDescription ( )

overridevirtual

Implements ImportPlugin.

Definition at line 107 of file ImportPCM.cpp.

{
    return DESC;
}

References DESC.

GetPluginStringID()

wxString PCMImportPlugin::GetPluginStringID ( )

inlineoverridevirtual

Implements ImportPlugin.

Definition at line 69 of file ImportPCM.cpp.

{ return wxT("libsndfile"); }

References wxT().

Here is the call graph for this function:

Open()

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

overridevirtual

Implements ImportPlugin.

Definition at line 112 of file ImportPCM.cpp.

{
   SF_INFO info;
   wxFile f;   // will be closed when it goes out of scope
   SFFile file;
 
   memset(&info, 0, sizeof(info));
 
 
#ifdef __WXGTK__
   if (filename.Lower().EndsWith(wxT("mp3"))) {
      // There is a bug in libsndfile where mp3s with duplicated metadata tags
      // will crash libsndfile and thus audacity.
      // We have patched the lib-src version of libsndfile, but
      // for linux the user can build against the system libsndfile which
      // still has this bug.
      // This happens in sf_open_fd, which is the very first point of
      // interaction with libsndfile, so the only workaround is to hardcode
      // ImportPCM to not handle .mp3.  Of course, this will still fail for mp3s
      // that are mislabeled with a .wav or other extension.
      // So, in the future we may want to write a simple parser to detect mp3s here.
      return NULL;
   }
#endif
 
 
   if (f.Open(filename)) {
      // Even though there is an sf_open() that takes a filename, use the one that
      // takes a file descriptor since wxWidgets can open a file with a Unicode name and
      // libsndfile can't (under Windows).
      file.reset(SFCall<SNDFILE*>(sf_open_fd, f.fd(), SFM_READ, &info, TRUE));
   }
 
   // The file descriptor is now owned by "file", so we must tell "f" to leave
   // it alone.  The file descriptor is closed by the destructor of file even if an error
   // occurs.
   f.Detach();
 
   if (!file) {
      // TODO: Handle error
      //char str[1000];
      //sf_error_str((SNDFILE *)NULL, str, 1000);
 
      return nullptr;
   } else if (file &&
              (info.format & SF_FORMAT_TYPEMASK) == SF_FORMAT_OGG) {
      // mchinen 15.1.2012 - disallowing libsndfile to handle
      // ogg files because seeking is broken at this date (very slow,
      // seeks from beginning of file each seek).
      // This was said by Erik (libsndfile maintainer).
      // Note that this won't apply to our local libsndfile, so only
      // linux builds that use --with-libsndfile=system are affected,
      // as our local libsndfile doesn't do OGG.
      // In particular ubuntu 10.10 and 11.04 are known to be affected
      // When the bug is fixed, we can check version to avoid only
      // the broken builds.
 
      return nullptr;
   }
 
   // Success, so now transfer the duty to close the file from "file".
   return std::make_unique<PCMImportFileHandle>(filename, std::move(file), info);
}

References wxT().

Here is the call graph for this function:

---

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

• ImportPCM.cpp