FileFormats.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  FileFormats.h
 
  Dominic Mazzoni
 
**********************************************************************/
 
#ifndef __AUDACITY_FILE_FORMATS__
#define __AUDACITY_FILE_FORMATS__
 
 
 
#include "Identifier.h"
#include "SampleFormat.h"
 
#include <memory>
#include <sndfile.h>
 
class ChoiceSetting;
class wxString;
 
//
// enumerating headers
//
 
FILE_FORMATS_API
int sf_num_headers();
 
FILE_FORMATS_API
wxString sf_header_index_name(int format_num);
 
FILE_FORMATS_API
unsigned int sf_header_index_to_type(int format_num);
 
//
// enumerating encodings
//
FILE_FORMATS_API
int sf_num_encodings();
FILE_FORMATS_API
wxString sf_encoding_index_name(int encoding_num);
FILE_FORMATS_API
unsigned int sf_encoding_index_to_subtype(int encoding_num);
 
//
// getting info about an actual SF format
//
FILE_FORMATS_API
wxString sf_header_name(int format);
FILE_FORMATS_API
wxString sf_header_shortname(int format);
FILE_FORMATS_API
wxString sf_header_extension(int format);
wxString sf_encoding_name(int encoding_num);
 
//
// simple formats
//
 
int sf_num_simple_formats();
SF_FORMAT_INFO *sf_simple_format(int i);
 
//
// other utility functions
//
 
FILE_FORMATS_API
bool sf_subtype_more_than_16_bits(unsigned int format);
FILE_FORMATS_API
bool sf_subtype_is_integer(unsigned int format);
FILE_FORMATS_API
int sf_subtype_bytes_per_sample(unsigned int format);
 
FILE_FORMATS_API
sampleFormat sf_subtype_to_effective_format(unsigned int format);
 
FILE_FORMATS_API
extern FileExtensions sf_get_all_extensions();
 
wxString sf_normalize_name(const char *name);
 
 
// This function wrapper uses a mutex to serialize calls to the SndFile library.
// PRL: Keeping this in a comment, but with Unitary, the only remaining uses
// of libsndfile should be in import/export and so are on the main thread only
//extern std::mutex libSndFileMutex;
 
template<typename R, typename F, typename... Args>
inline R SFCall(F fun, Args&&... args)
{
   //std::lock_guard<std::mutex> guard{ libSndFileMutex };
   return fun(std::forward<Args>(args)...);
}
 
//RAII for SNDFILE*
struct FILE_FORMATS_API SFFileCloser { int operator () (SNDFILE*) const; };
struct SFFile : public std::unique_ptr<SNDFILE, ::SFFileCloser>
{
   SFFile() = default;
   SFFile( SFFile &&that )
   : std::unique_ptr<SNDFILE, ::SFFileCloser>( std::move( that ) )
   {}
 
   // Close explicitly, not ignoring return values.
   int close()
   {
      auto result = get_deleter() ( get() );
      release();
      return result;
   }
};
 
#endif