SampleFormat.h File Reference

#include "MemoryX.h"
#include <wx/defs.h>
#include "audacity/Types.h"

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	SampleBuffer
class	GrowableSampleBuffer

Macros
#define	SAMPLE_SIZE_DISK(SampleFormat)
	Return the size on disk of one uncompressed sample (bytes) More...

Typedefs
using	Floats = ArrayOf< float >
using	FloatBuffers = ArraysOf< float >
using	Doubles = ArrayOf< double >

Enumerations
enum	fillFormat { fillZero = 0, fillTwo = 2 }

Functions
AUDACITY_DLL_API TranslatableString	GetSampleFormatStr (sampleFormat format)
AUDACITY_DLL_API void	CopySamples (constSamplePtr src, sampleFormat srcFormat, samplePtr dst, sampleFormat dstFormat, unsigned int len, bool highQuality=true, unsigned int srcStride=1, unsigned int dstStride=1)
AUDACITY_DLL_API void	CopySamplesNoDither (samplePtr src, sampleFormat srcFormat, samplePtr dst, sampleFormat dstFormat, unsigned int len, unsigned int srcStride=1, unsigned int dstStride=1)
AUDACITY_DLL_API void	ClearSamples (samplePtr buffer, sampleFormat format, size_t start, size_t len)
AUDACITY_DLL_API void	ReverseSamples (samplePtr buffer, sampleFormat format, int start, int len)
AUDACITY_DLL_API void	InitDitherers ()

Macro Definition Documentation

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 44 of file SampleFormat.h.

Typedef Documentation

Doubles

using Doubles = ArrayOf<double>

Definition at line 161 of file SampleFormat.h.

FloatBuffers

using FloatBuffers = ArraysOf<float>

Definition at line 160 of file SampleFormat.h.

Floats

using Floats = ArrayOf<float>

Definition at line 159 of file SampleFormat.h.

Enumeration Type Documentation

fillFormat

enum fillFormat

Enumerator
fillZero
fillTwo

Definition at line 38 of file SampleFormat.h.

             {
   fillZero = 0,
   fillTwo = 2
}fillFormat;

Function Documentation

ClearSamples()

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

Definition at line 77 of file SampleFormat.cpp.

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

References format, and SAMPLE_SIZE.

Referenced by RingBuffer::Clear(), AudioIO::FillBuffers(), Sequence::Get(), WaveTrack::Get(), SampleBlock::GetSamples(), RingBuffer::Put(), ODDecodeBlockFile::Read256(), ODPCMAliasBlockFile::Read256(), ODDecodeBlockFile::Read64K(), ODPCMAliasBlockFile::Read64K(), ODDecodeBlockFile::ReadData(), SilentBlockFile::ReadData(), and Sequence::SetSamples().

Here is the caller graph for this function:

CopySamples()

AUDACITY_DLL_API void CopySamples	(	constSamplePtr	src,
		sampleFormat	srcFormat,
		samplePtr	dst,
		sampleFormat	dstFormat,
		unsigned int	len,
		bool	highQuality = true,
		unsigned int	srcStride = 1,
		unsigned int	dstStride = 1
	)

Definition at line 102 of file SampleFormat.cpp.

{
   gDitherAlgorithm.Apply(
      highQuality ? gHighQualityDither : gLowQualityDither,
      src, srcFormat, dst, dstFormat, len, srcStride, dstStride);
}

References Dither::Apply(), gDitherAlgorithm, gHighQualityDither, and gLowQualityDither.

Referenced by AUPImportFileHandle::AddSamples(), WaveClip::Append(), AudioIoCallback::AudioCallback(), ODDecodeBlockFile::CalcSummary(), ODPCMAliasBlockFile::CalcSummary(), SqliteSampleBlock::CalcSummary(), ComputeLegacySummaryInfo(), Sequence::ConvertToSampleFormat(), Sequence::DoAppend(), DoSoftwarePlaythrough(), ExportPCM::Export(), RingBuffer::Get(), SqliteSampleBlock::GetBlob(), NyquistEffect::GetCallback(), WaveClip::GetWaveDisplay(), Mixer::Process(), RingBuffer::Put(), and Sequence::SetSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

CopySamplesNoDither()

AUDACITY_DLL_API void CopySamplesNoDither	(	samplePtr	src,
		sampleFormat	srcFormat,
		samplePtr	dst,
		sampleFormat	dstFormat,
		unsigned int	len,
		unsigned int	srcStride = 1,
		unsigned int	dstStride = 1
	)

Definition at line 114 of file SampleFormat.cpp.

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

References Dither::Apply(), gDitherAlgorithm, and none.

Referenced by ExportPCM::Export().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSampleFormatStr()

AUDACITY_DLL_API TranslatableString GetSampleFormatStr

(

sampleFormat

format

)

Definition at line 60 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, format, int16Sample, int24Sample, and XO.

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

Here is the caller graph for this function:

InitDitherers()

AUDACITY_DLL_API void InitDitherers

(

)

Definition at line 53 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:

ReverseSamples()

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

Definition at line 84 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, format, and SAMPLE_SIZE.

Referenced by Mixer::MixSameRate(), and Mixer::MixVariableRates().

Here is the caller graph for this function: