#include "Identifier.h"
#include "SampleFormat.h"
#include <memory>
#include "sndfile.h"

Include dependency graph for FileFormats.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	SFFileCloser

struct	SFFile

Functions
AUDACITY_DLL_API int	sf_num_headers ()
	Get the number of container formats supported by libsndfile. More...

AUDACITY_DLL_API wxString	sf_header_index_name (int format_num)
	Get the name of a container format from libsndfile. More...

AUDACITY_DLL_API unsigned int	sf_header_index_to_type (int format_num)

AUDACITY_DLL_API int	sf_num_encodings ()
	Get the number of data encodings libsndfile supports (in any container or none. More...

AUDACITY_DLL_API wxString	sf_encoding_index_name (int encoding_num)
	Get the string name of the data encoding of the requested format. More...

AUDACITY_DLL_API unsigned int	sf_encoding_index_to_subtype (int encoding_num)

AUDACITY_DLL_API wxString	sf_header_name (int format)
	Get the string name of the specified container format. More...

AUDACITY_DLL_API wxString	sf_header_shortname (int format)
	Get an abbreviated form of the string name of the specified format. More...

AUDACITY_DLL_API wxString	sf_header_extension (int format)
	Get the most common file extension for the given format. More...

wxString	sf_encoding_name (int encoding_num)
	Get the string name of the specified data encoding. More...

int	sf_num_simple_formats ()

SF_FORMAT_INFO *	sf_simple_format (int i)

AUDACITY_DLL_API bool	sf_subtype_more_than_16_bits (unsigned int format)

AUDACITY_DLL_API bool	sf_subtype_is_integer (unsigned int format)

AUDACITY_DLL_API int	sf_subtype_bytes_per_sample (unsigned int format)

AUDACITY_DLL_API sampleFormat	sf_subtype_to_effective_format (unsigned int format)
	Choose the narrowest value in the sampleFormat enumeration for a given libsndfile format. More...

AUDACITY_DLL_API FileExtensions	sf_get_all_extensions ()

wxString	sf_normalize_name (const char *name)

template<typename R , typename F , typename... Args>
R	SFCall (F fun, Args &&... args)

Variables
ChoiceSetting	FileFormatsCopyOrEditSetting

ChoiceSetting	FileFormatsSaveWithDependenciesSetting

Function Documentation

◆ sf_encoding_index_name()

AUDACITY_DLL_API wxString sf_encoding_index_name ( int encoding_num )

Get the string name of the data encoding of the requested format.

uses SFC_GET_FORMAT_SUBTYPE

Definition at line 83 of file FileFormats.cpp.

{
   SF_FORMAT_INFO format_info ;
 
   memset(&format_info, 0, sizeof(format_info));
   format_info.format = i;
   sf_command (NULL, SFC_GET_FORMAT_SUBTYPE,
               &format_info, sizeof (format_info));
   return sf_normalize_name(format_info.name);
}

References sf_normalize_name().

Referenced by ExportPCMOptions::GetEncodings(), and ImportRawDialog::ImportRawDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sf_encoding_index_to_subtype()

AUDACITY_DLL_API unsigned int sf_encoding_index_to_subtype ( int encoding_num )

Definition at line 94 of file FileFormats.cpp.

{
   SF_FORMAT_INFO format_info ;
 
   memset(&format_info, 0, sizeof(format_info));
   format_info.format = i;
   sf_command (NULL, SFC_GET_FORMAT_SUBTYPE,
               &format_info, sizeof (format_info));
 
   return format_info.format & SF_FORMAT_SUBMASK;
}

Referenced by ExportPCMOptions::GetEncodings(), ImportRawDialog::ImportRawDialog(), ExportPCMOptions::OnEncodingChoice(), and ExportPCMOptions::~ExportPCMOptions().

Here is the caller graph for this function:

◆ sf_encoding_name()

wxString sf_encoding_name ( int encoding_num )

Get the string name of the specified data encoding.

AND encoding_num with SF_FORMAT_SUBMASK to get only the data encoding and then use SFC_GET_FORMAT_INFO to get the description

Parameters

encoding_num the libsndfile encoding to get the name for (only the data encoding is used)

Definition at line 156 of file FileFormats.cpp.

{
   SF_FORMAT_INFO format_info;
 
   memset(&format_info, 0, sizeof(format_info));
   format_info.format = (encoding & SF_FORMAT_SUBMASK);
   sf_command(NULL, SFC_GET_FORMAT_INFO, &format_info, sizeof(format_info));
 
   return sf_normalize_name(format_info.name);
}

References sf_normalize_name().

Here is the call graph for this function:

◆ sf_get_all_extensions()

AUDACITY_DLL_API FileExtensions sf_get_all_extensions ( )

Definition at line 240 of file FileFormats.cpp.

{
   FileExtensions exts;
   SF_FORMAT_INFO format_info;
   int count, k;
 
   memset(&format_info, 0, sizeof(format_info));
 
   sf_command(NULL, SFC_GET_FORMAT_MAJOR_COUNT,
              &count, sizeof(count));
 
   for(k=0; k<count; k++) {
      format_info.format = k;
      sf_command(NULL, SFC_GET_FORMAT_MAJOR,
                 &format_info, sizeof (format_info)) ;
 
      exts.push_back(LAT1CTOWX(format_info.extension));
   }
 
   // Some other extensions that are often sound files
   // but aren't included by libsndfile
 
   exts.insert( exts.end(), {
      wxT("aif") , // AIFF file with a DOS-style extension
      wxT("ircam") ,
      wxT("snd") ,
      wxT("svx") ,
      wxT("svx8") ,
      wxT("sv16") ,
   } );
 
   return exts;
}

References exts, and LAT1CTOWX.

Referenced by ExportPCM::ExportPCM().

Here is the caller graph for this function:

◆ sf_header_extension()

AUDACITY_DLL_API wxString sf_header_extension ( int format )

Get the most common file extension for the given format.

AND the given format with SF_FORMAT_TYPEMASK to get just the container format, then retrieve the most common extension using SFC_GET_FORMAT_INFO.

Parameters

format the libsndfile format to get the name for (only the container part is used)

Definition at line 145 of file FileFormats.cpp.

{
   SF_FORMAT_INFO format_info;
 
   memset(&format_info, 0, sizeof(format_info));
   format_info.format = (format & SF_FORMAT_TYPEMASK);
   sf_command(NULL, SFC_GET_FORMAT_INFO, &format_info, sizeof(format_info));
 
   return LAT1CTOWX(format_info.extension);
}

References format, and LAT1CTOWX.

Referenced by ExportPCM::ExportPCM(), ExportPCM::GetExtension(), and ExportPCMOptions::SendSuffixEvent().

Here is the caller graph for this function:

◆ sf_header_index_name()

AUDACITY_DLL_API wxString sf_header_index_name ( int format_num )

Get the name of a container format from libsndfile.

Uses SFC_GET_FORMAT_MAJOR in the sf_command() interface. Resulting C string from libsndfile is converted to a wxString

Parameters

format_num The libsndfile format number for the container format required

Definition at line 46 of file FileFormats.cpp.

{
   SF_FORMAT_INFO format_info;
 
   memset(&format_info, 0, sizeof(format_info));
   format_info.format = format;
   sf_command(NULL, SFC_GET_FORMAT_MAJOR,
              &format_info, sizeof (format_info)) ;
 
   return LAT1CTOWX(format_info.name);
}

References format, and LAT1CTOWX.

Referenced by ExportPCMOptions::GetTypes().

Here is the caller graph for this function:

◆ sf_header_index_to_type()

AUDACITY_DLL_API unsigned int sf_header_index_to_type ( int format_num )

Definition at line 58 of file FileFormats.cpp.

{
   SF_FORMAT_INFO format_info ;
 
   memset(&format_info, 0, sizeof(format_info));
   format_info.format = i;
   sf_command (NULL, SFC_GET_FORMAT_MAJOR,
               &format_info, sizeof (format_info));
 
   return format_info.format & SF_FORMAT_TYPEMASK;
}

Referenced by ExportPCMOptions::GetTypes(), and ExportPCMOptions::OnHeaderChoice().

Here is the caller graph for this function:

◆ sf_header_name()

AUDACITY_DLL_API wxString sf_header_name ( int format )

Get the string name of the specified container format.

AND format with SF_FORMAT_TYPEMASK to get only the container format and then use SFC_GET_FORMAT_INFO to get the description

Parameters

format the libsndfile format to get the name for (only the container part is used)

Definition at line 110 of file FileFormats.cpp.

{
   SF_FORMAT_INFO format_info;
 
   memset(&format_info, 0, sizeof(format_info));
   format_info.format = (format & SF_FORMAT_TYPEMASK);
   sf_command(NULL, SFC_GET_FORMAT_INFO, &format_info, sizeof(format_info));
 
   return LAT1CTOWX(format_info.name);
}

References format, and LAT1CTOWX.

Referenced by ExportPCM::Export(), and PCMImportFileHandle::GetFileDescription().

Here is the caller graph for this function:

◆ sf_header_shortname()

AUDACITY_DLL_API wxString sf_header_shortname ( int format )

Get an abbreviated form of the string name of the specified format.

Do sf_header_name() then truncate the string at the first space in the name to get just the first word of the format name.

Parameters

format the libsndfile format to get the name for (only the container part is used)

Definition at line 121 of file FileFormats.cpp.

{
   SF_FORMAT_INFO format_info;
   int i;
   wxString s;
 
   memset(&format_info, 0, sizeof(format_info));
   format_info.format = (format & SF_FORMAT_TYPEMASK);
   sf_command(NULL, SFC_GET_FORMAT_INFO, &format_info, sizeof(format_info));
 
   MallocString<> tmp { strdup( format_info.name ) };
   i = 0;
   while(tmp[i]) {
      if (tmp[i]==' ')
         tmp[i] = 0;
      else
         i++;
   }
 
   s = LAT1CTOWX(tmp.get());
 
   return s;
}

References format, and LAT1CTOWX.

Referenced by ExportPCM::GetFormat(), LoadEncoding(), and SaveEncoding().

Here is the caller graph for this function:

◆ sf_normalize_name()

wxString sf_normalize_name ( const char * name )

Definition at line 274 of file FileFormats.cpp.

{
   wxString n = LAT1CTOWX(name);
 
   n.Replace(wxT("8 bit"), wxT("8-bit"));
   n.Replace(wxT("16 bit"), wxT("16-bit"));
   n.Replace(wxT("24 bit"), wxT("24-bit"));
   n.Replace(wxT("32 bit"), wxT("32-bit"));
   n.Replace(wxT("64 bit"), wxT("64-bit"));
 
   return n;
}

References LAT1CTOWX, name, and wxT().

Referenced by sf_encoding_index_name(), and sf_encoding_name().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sf_num_encodings()

AUDACITY_DLL_API int sf_num_encodings ( )

Get the number of data encodings libsndfile supports (in any container or none.

Definition at line 74 of file FileFormats.cpp.

{
   int count ;
 
   sf_command (NULL, SFC_GET_FORMAT_SUBTYPE_COUNT, &count, sizeof (int)) ;
 
   return count;
}

Referenced by ExportPCMOptions::GetEncodings(), and ImportRawDialog::ImportRawDialog().

Here is the caller graph for this function:

◆ sf_num_headers()

AUDACITY_DLL_API int sf_num_headers ( )

Get the number of container formats supported by libsndfile.

Uses SFC_GET_FORMAT_MAJOR_COUNT in sf_command interface

Definition at line 36 of file FileFormats.cpp.

{
   int count;
 
   sf_command(NULL, SFC_GET_FORMAT_MAJOR_COUNT,
              &count, sizeof(count));
 
   return count;
}

Referenced by ExportPCMOptions::GetTypes().

Here is the caller graph for this function:

◆ sf_num_simple_formats()

int sf_num_simple_formats ( )

Definition at line 167 of file FileFormats.cpp.

{
   int count ;
 
   sf_command (NULL, SFC_GET_SIMPLE_FORMAT_COUNT, &count, sizeof (int)) ;
 
   return count;
}

◆ sf_simple_format()

SF_FORMAT_INFO * sf_simple_format ( int i )

Definition at line 178 of file FileFormats.cpp.

{
   memset(&g_format_info, 0, sizeof(g_format_info));
 
   g_format_info.format = i;
   sf_command (NULL, SFC_GET_SIMPLE_FORMAT,
               &g_format_info, sizeof(g_format_info));
 
   return &g_format_info;
}

References g_format_info.

◆ sf_subtype_bytes_per_sample()

AUDACITY_DLL_API int sf_subtype_bytes_per_sample ( unsigned int format )

Definition at line 206 of file FileFormats.cpp.

                                                    {
   unsigned int subtype = format & SF_FORMAT_SUBMASK;
   if( subtype == SF_FORMAT_PCM_S8 )
      return 1;
   if( subtype == SF_FORMAT_PCM_U8 )
      return 1;
   if( subtype == SF_FORMAT_PCM_16 )
      return 2;
   if( subtype == SF_FORMAT_PCM_24 )
      return 3;
   if( subtype == SF_FORMAT_PCM_32 )
      return 4;
   if( subtype == SF_FORMAT_FLOAT )
      return 4;
   if( subtype == SF_FORMAT_DOUBLE )
      return 8;
 
   // might be different to 2, but this is good enough for 
   // WAV and AIFF file size error trapping.
   return 2;
}

References format.

Referenced by ExportPCM::Export().

Here is the caller graph for this function:

◆ sf_subtype_is_integer()

AUDACITY_DLL_API bool sf_subtype_is_integer ( unsigned int format )

Definition at line 198 of file FileFormats.cpp.

{
   unsigned int subtype = format & SF_FORMAT_SUBMASK;
   return (subtype == SF_FORMAT_PCM_16 ||
           subtype == SF_FORMAT_PCM_24 ||
           subtype == SF_FORMAT_PCM_32);
}

References format.

Referenced by AUPImportFileHandle::AddSamples(), and ExportPCM::Export().

Here is the caller graph for this function:

◆ sf_subtype_more_than_16_bits()

AUDACITY_DLL_API bool sf_subtype_more_than_16_bits ( unsigned int format )

Definition at line 189 of file FileFormats.cpp.

{
   unsigned int subtype = format & SF_FORMAT_SUBMASK;
   return (subtype == SF_FORMAT_FLOAT ||
           subtype == SF_FORMAT_DOUBLE ||
           subtype == SF_FORMAT_PCM_24 ||
           subtype == SF_FORMAT_PCM_32);
}

References format.

Referenced by AUPImportFileHandle::AddSamples(), ExportPCM::Export(), and sf_subtype_to_effective_format().

Here is the caller graph for this function:

◆ sf_subtype_to_effective_format()

AUDACITY_DLL_API sampleFormat sf_subtype_to_effective_format ( unsigned int format )

Choose the narrowest value in the sampleFormat enumeration for a given libsndfile format.

Definition at line 228 of file FileFormats.cpp.

{
   unsigned int subtype = format & SF_FORMAT_SUBMASK;
   if (subtype == SF_FORMAT_PCM_24)
      return int24Sample;
   else if (sf_subtype_more_than_16_bits(format))
      return widestSampleFormat;
   else
      return int16Sample;
}

References format, int16Sample, int24Sample, sf_subtype_more_than_16_bits(), and widestSampleFormat.

Referenced by ImportRaw(), and PCMImportFileHandle::PCMImportFileHandle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SFCall()

template<typename R , typename F , typename... Args>

R SFCall	(	F	fun,
		Args &&...	args
	)

inline

Definition at line 134 of file FileFormats.h.

{
   //std::lock_guard<std::mutex> guard{ libSndFileMutex };
   return fun(std::forward<Args>(args)...);
}

Variable Documentation

◆ FileFormatsCopyOrEditSetting

ChoiceSetting FileFormatsCopyOrEditSetting

extern

Definition at line 352 of file FileFormats.cpp.

◆ FileFormatsSaveWithDependenciesSetting

ChoiceSetting FileFormatsSaveWithDependenciesSetting

extern

Definition at line 367 of file FileFormats.cpp.

Referenced by DependencyDialog::SaveFutureActionChoice().

Classes

Functions

Variables

Function Documentation

◆ sf_encoding_index_name()

◆ sf_encoding_index_to_subtype()

◆ sf_encoding_name()

◆ sf_get_all_extensions()

◆ sf_header_extension()

◆ sf_header_index_name()

◆ sf_header_index_to_type()

◆ sf_header_name()

◆ sf_header_shortname()

◆ sf_normalize_name()

◆ sf_num_encodings()

◆ sf_num_headers()

◆ sf_num_simple_formats()

◆ sf_simple_format()

◆ sf_subtype_bytes_per_sample()

◆ sf_subtype_is_integer()

◆ sf_subtype_more_than_16_bits()

◆ sf_subtype_to_effective_format()

◆ SFCall()

Variable Documentation

◆ FileFormatsCopyOrEditSetting

◆ FileFormatsSaveWithDependenciesSetting