SampleFormat.h File Reference

#include "MemoryX.h"
#include <cstdlib>

Include dependency graph for SampleFormat.h:

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

Go to the source code of this file.

Classes
class	SampleFormats
	Two sample formats, remembering format of original source and describing stored format. More...
class	SampleBuffer
class	GrowableSampleBuffer

Macros
#define	SAMPLE_SIZE(SampleFormat)   (static_cast<unsigned>(SampleFormat) >> 16)
#define	SAMPLE_SIZE_DISK(SampleFormat)
	Return the size on disk of one uncompressed sample (bytes) More...

Typedefs
using	samplePtr = char *
using	constSamplePtr = const char *
typedef enum FillFormat	fillFormat
using	Floats = ArrayOf< float >
using	FloatBuffers = ArraysOf< float >
using	Doubles = ArrayOf< double >

Enumerations
enum class	sampleFormat : unsigned {   int16Sample = 0x00020001 , int24Sample = 0x00040001 , floatSample = 0x0004000F , narrowestSampleFormat = int16Sample ,   widestSampleFormat = floatSample }
	The ordering of these values with operator < agrees with the order of increasing bit width. More...
enum class	FillFormat { fillZero = 0 , fillTwo = 2 }

Functions
MATH_API TranslatableString	GetSampleFormatStr (sampleFormat format)
bool	operator== (SampleFormats a, SampleFormats b)
bool	operator!= (SampleFormats a, SampleFormats b)
MATH_API void	SamplesToFloats (constSamplePtr src, sampleFormat srcFormat, float *dst, size_t len, size_t srcStride=1, size_t dstStride=1)
	Copy samples from any format into the widest format, which is 32 bit float, with no dithering. More...
MATH_API void	CopySamples (constSamplePtr src, sampleFormat srcFormat, samplePtr dst, sampleFormat dstFormat, size_t len, DitherType ditherType=gHighQualityDither, unsigned int srcStride=1, unsigned int dstStride=1)
	Copy samples from any format to any other format; apply dithering only if narrowing the format. More...
MATH_API void	ClearSamples (samplePtr buffer, sampleFormat format, size_t start, size_t len)
MATH_API void	ReverseSamples (samplePtr buffer, sampleFormat format, int start, int len)
MATH_API void	InitDitherers ()

Variables
MATH_API DitherType	gLowQualityDither
	These global variables are assigned at application startup or after change of preferences. More...
MATH_API DitherType	gHighQualityDither
constexpr sampleFormat	int16Sample = sampleFormat::int16Sample
constexpr sampleFormat	int24Sample = sampleFormat::int24Sample
constexpr sampleFormat	floatSample = sampleFormat::floatSample
constexpr sampleFormat	narrowestSampleFormat = sampleFormat::narrowestSampleFormat
constexpr sampleFormat	widestSampleFormat = sampleFormat::widestSampleFormat

Macro Definition Documentation

SAMPLE_SIZE

#define SAMPLE_SIZE

(

SampleFormat

)

(static_cast<unsigned>(SampleFormat) >> 16)

Definition at line 50 of file SampleFormat.h.

SAMPLE_SIZE_DISK

#define SAMPLE_SIZE_DISK

(

SampleFormat

)

Value:

   (((SampleFormat) == int24Sample) ? \
   size_t{ 3 } : SAMPLE_SIZE(SampleFormat) )

Return the size on disk of one uncompressed sample (bytes)

Definition at line 65 of file SampleFormat.h.

Typedef Documentation

constSamplePtr

using constSamplePtr = const char *

Definition at line 56 of file SampleFormat.h.

Doubles

using Doubles = ArrayOf<double>

Definition at line 253 of file SampleFormat.h.

fillFormat

typedef enum FillFormat fillFormat

FloatBuffers

using FloatBuffers = ArraysOf<float>

Definition at line 252 of file SampleFormat.h.

Floats

using Floats = ArrayOf<float>

Definition at line 251 of file SampleFormat.h.

samplePtr

using samplePtr = char *

Definition at line 55 of file SampleFormat.h.

Enumeration Type Documentation

FillFormat

enum class FillFormat

strong

Enumerator
fillZero
fillTwo

Definition at line 59 of file SampleFormat.h.

                              {
   fillZero = 0,
   fillTwo = 2
} fillFormat;

sampleFormat

enum class sampleFormat : unsigned

strong

The ordering of these values with operator < agrees with the order of increasing bit width.

These values persist in saved project files, so must not be changed in later program versions

Enumerator
int16Sample
int24Sample
floatSample
narrowestSampleFormat	Two synonyms for previous values that might change if more values were added.
widestSampleFormat

Definition at line 30 of file SampleFormat.h.

                        : unsigned {
   int16Sample = 0x00020001,
   int24Sample = 0x00040001,
   floatSample = 0x0004000F,
 
   narrowestSampleFormat = int16Sample,
   widestSampleFormat = floatSample,
};

Function Documentation

ClearSamples()

MATH_API void ClearSamples	(	samplePtr	buffer,
		sampleFormat	format,
		size_t	start,
		size_t	len
	)

Definition at line 75 of file SampleFormat.cpp.

{
   auto size = SAMPLE_SIZE(format);
   memset(dst + start*size, 0, len*size);
}

References anonymous_namespace{ExportPCM.cpp}::format, SAMPLE_SIZE, and size.

Referenced by RingBuffer::Clear(), AudioIO::DrainRecordBuffers(), Sequence::Get(), WaveTrack::GetOne(), SampleBlock::GetSamples(), RingBuffer::Put(), and Sequence::SetSamples().

Here is the caller graph for this function:

CopySamples()

MATH_API void CopySamples	(	constSamplePtr	src,
		sampleFormat	srcFormat,
		samplePtr	dst,
		sampleFormat	dstFormat,
		size_t	len,
		DitherType	ditherType = gHighQualityDither,
		unsigned int	srcStride = 1,
		unsigned int	dstStride = 1
	)

Copy samples from any format to any other format; apply dithering only if narrowing the format.

Parameters

src	address of source samples
srcFormat	format of source samples, determines sizeof each one
dst	address of floating-point numbers
len	count of samples to copy
srcStride	how many samples to advance src after copying each one
dstString	how many samples to advance dst after copying each one
dstFormat	format of destination samples, determines sizeof each one
ditherType	choice of dithering algorithm to use if narrowing the format

Parameters

ditherType

default is loaded from a global variable

Definition at line 109 of file SampleFormat.cpp.

{
   gDitherAlgorithm.Apply(
      ditherType,
      src, srcFormat, dst, dstFormat, len, srcStride, dstStride);
}

References Dither::Apply(), and gDitherAlgorithm.

Referenced by AUPImportFileHandle::AddSamples(), Sequence::Append(), Sequence::ConvertToSampleFormat(), Sequence::DoAppend(), RingBuffer::Get(), SqliteSampleBlock::GetBlob(), PCMExportProcessor::Process(), Mixer::Process(), RingBuffer::Put(), SamplesToFloats(), and Sequence::SetSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSampleFormatStr()

MATH_API TranslatableString GetSampleFormatStr

(

sampleFormat

format

)

Definition at line 58 of file SampleFormat.cpp.

{
   switch(format) {
   case int16Sample:
      /* i18n-hint: Audio data bit depth (precision): 16-bit integers */
      return XO("16-bit PCM");
   case int24Sample:
      /* i18n-hint: Audio data bit depth (precision): 24-bit integers */
      return XO("24-bit PCM");
   case floatSample:
      /* i18n-hint: Audio data bit depth (precision): 32-bit floating point */
      return XO("32-bit float");
   }
   return XO("Unknown format"); // compiler food
}

References floatSample, anonymous_namespace{ExportPCM.cpp}::format, int16Sample, int24Sample, and XO().

Referenced by FormatMenuTable::OnFormatChange(), Sequence::Paste(), and anonymous_namespace{WaveTrackControls.cpp}::Status2DrawFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

InitDitherers()

MATH_API void InitDitherers

(

)

Definition at line 51 of file SampleFormat.cpp.

{
   // Read dither preferences
   gLowQualityDither = Dither::FastDitherChoice();
   gHighQualityDither = Dither::BestDitherChoice();
}

References Dither::BestDitherChoice(), Dither::FastDitherChoice(), gHighQualityDither, and gLowQualityDither.

Referenced by QualityPrefs::Commit(), and AudacityApp::InitPart2().

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

bool operator!= ( SampleFormats  a, SampleFormats  b  )

inline

Definition at line 113 of file SampleFormat.h.

{
   return !(a == b);
}

operator==()

bool operator== ( SampleFormats  a, SampleFormats  b  )

inline

Definition at line 107 of file SampleFormat.h.

{
   return a.Effective() == b.Effective() &&
      a.Stored() == b.Stored();
}

References SampleFormats::Effective(), and SampleFormats::Stored().

Here is the call graph for this function:

ReverseSamples()

MATH_API void ReverseSamples	(	samplePtr	buffer,
		sampleFormat	format,
		int	start,
		int	len
	)

Definition at line 82 of file SampleFormat.cpp.

{
   auto size = SAMPLE_SIZE(format);
   samplePtr first = dst + start * size;
   samplePtr last = dst + (start + len - 1) * size;
   enum : size_t { fixedSize = SAMPLE_SIZE(floatSample) };
   wxASSERT(static_cast<size_t>(size) <= fixedSize);
   char temp[fixedSize];
   while (first < last) {
      memcpy(temp, first, size);
      memcpy(first, last, size);
      memcpy(last, temp, size);
      first += size;
      last -= size;
   }
}

References floatSample, anonymous_namespace{ExportPCM.cpp}::format, SAMPLE_SIZE, and size.

Referenced by WaveTrack::GetOne(), and ClipTimeAndPitchSource::Pull().

Here is the caller graph for this function:

SamplesToFloats()

MATH_API void SamplesToFloats	(	constSamplePtr	src,
		sampleFormat	srcFormat,
		float *	dst,
		size_t	len,
		size_t	srcStride = 1,
		size_t	dstStride = 1
	)

Copy samples from any format into the widest format, which is 32 bit float, with no dithering.

Parameters

src	address of source samples
srcFormat	format of source samples, determines sizeof each one
dst	address of floating-point numbers
len	count of samples to copy
srcStride	how many samples to advance src after copying each one
dstString	how many samples to advance dst after copying each one

Definition at line 100 of file SampleFormat.cpp.

{
   CopySamples( src, srcFormat,
      reinterpret_cast<samplePtr>(dst), floatSample, len,
      DitherType::none,
      srcStride, dstStride);
}

References CopySamples(), floatSample, and none.

Referenced by AudioIoCallback::AudioCallback(), SqliteSampleBlock::CalcSummary(), DoSoftwarePlaythrough(), and WaveClipWaveformCache::GetWaveDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

floatSample

constexpr sampleFormat floatSample = sampleFormat::floatSample

constexpr

Definition at line 43 of file SampleFormat.h.

Referenced by AudacityToPortAudioSampleFormat(), DITHER(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), EffectPreview(), GetSampleFormatStr(), GetWaveDisplay(), FormatMenuTable::IdOfFormat(), anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle::Import(), ImportRaw(), ReverseSamples(), SamplesToFloats(), anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle::SetupOutputFormat(), anonymous_namespace{WaveTrackControls.cpp}::Status2DrawFunction(), and TEST_CASE().

gHighQualityDither

MATH_API DitherType gHighQualityDither

Definition at line 23 of file SampleFormat.h.

gLowQualityDither

MATH_API DitherType gLowQualityDither

extern

These global variables are assigned at application startup or after change of preferences.

Definition at line 47 of file SampleFormat.cpp.

Referenced by InitDitherers(), and Mixer::Process().

int16Sample

constexpr sampleFormat int16Sample = sampleFormat::int16Sample

constexpr

Definition at line 41 of file SampleFormat.h.

Referenced by AudacityToPortAudioSampleFormat(), DITHER(), GetSampleFormatStr(), FormatMenuTable::IdOfFormat(), ImportRaw(), and sf_subtype_to_effective_format().

int24Sample

constexpr sampleFormat int24Sample = sampleFormat::int24Sample

constexpr

Definition at line 42 of file SampleFormat.h.

Referenced by AudacityToPortAudioSampleFormat(), DITHER(), GetSampleFormatStr(), FormatMenuTable::IdOfFormat(), and sf_subtype_to_effective_format().

narrowestSampleFormat

constexpr sampleFormat narrowestSampleFormat = sampleFormat::narrowestSampleFormat

constexpr

Definition at line 44 of file SampleFormat.h.

widestSampleFormat

constexpr sampleFormat widestSampleFormat = sampleFormat::widestSampleFormat

constexpr

Definition at line 45 of file SampleFormat.h.

Referenced by sf_subtype_to_effective_format().