juce::AudioData Class Reference

This class a container which holds all the classes pertaining to the AudioData::Pointer audio sample format class. More...

#include "juce_AudioDataConverters.h"

Classes
class	Converter
	A base class for objects that are used to convert between two different sample formats. More...
class	ConverterInstance
	A class that converts between two templated AudioData::Pointer types, and which implements the AudioData::Converter interface. More...
struct	Format
	A struct that contains a SampleFormat and Endianness to be used with the source and destination types when calling the interleaveSamples() and deinterleaveSamples() helpers. More...
class	Pointer
	Used as a template parameter for AudioData::Pointer. More...

Public Types
template<typename... Format>
using	InterleavedSource = ChannelData< true, true, Format... >
	A sequence of interleaved samples used as the source for the deinterleaveSamples() method.
template<typename... Format>
using	InterleavedDest = ChannelData< true, false, Format... >
	A sequence of interleaved samples used as the destination for the interleaveSamples() method.
template<typename... Format>
using	NonInterleavedSource = ChannelData< false, true, Format... >
	A sequence of non-interleaved samples used as the source for the interleaveSamples() method.
template<typename... Format>
using	NonInterleavedDest = ChannelData< false, false, Format... >
	A sequence of non-interleaved samples used as the destination for the deinterleaveSamples() method.

Static Public Member Functions
template<typename... SourceFormat, typename... DestFormat>
static void	interleaveSamples (NonInterleavedSource< SourceFormat... > source, InterleavedDest< DestFormat... > dest, int numSamples)
	A helper function for converting a sequence of samples from a non-interleaved source to an interleaved destination.
template<typename... SourceFormat, typename... DestFormat>
static void	deinterleaveSamples (InterleavedSource< SourceFormat... > source, NonInterleavedDest< DestFormat... > dest, int numSamples)
	A helper function for converting a sequence of samples from an interleaved source to a non-interleaved destination.

Detailed Description

This class a container which holds all the classes pertaining to the AudioData::Pointer audio sample format class.

See also

AudioData::Pointer.

@tags{Audio}

Definition at line 35 of file juce_AudioDataConverters.h.

---

Class Documentation

juce::AudioData::Format

struct juce::AudioData::Format

template<typename DataFormatIn, typename EndiannessIn>
struct juce::AudioData::Format< DataFormatIn, EndiannessIn >

A struct that contains a SampleFormat and Endianness to be used with the source and destination types when calling the interleaveSamples() and deinterleaveSamples() helpers.

See also

interleaveSamples, deinterleaveSamples

Definition at line 653 of file juce_AudioDataConverters.h.

Class Members
typedef DataFormatIn	DataFormat
typedef EndiannessIn	Endianness

Member Typedef Documentation

InterleavedDest

template<typename... Format>

using juce::AudioData::InterleavedDest = ChannelData<true, false, Format...>

A sequence of interleaved samples used as the destination for the interleaveSamples() method.

Definition at line 699 of file juce_AudioDataConverters.h.

InterleavedSource

template<typename... Format>

using juce::AudioData::InterleavedSource = ChannelData<true, true, Format...>

A sequence of interleaved samples used as the source for the deinterleaveSamples() method.

Definition at line 697 of file juce_AudioDataConverters.h.

NonInterleavedDest

template<typename... Format>

using juce::AudioData::NonInterleavedDest = ChannelData<false, false, Format...>

A sequence of non-interleaved samples used as the destination for the deinterleaveSamples() method.

Definition at line 703 of file juce_AudioDataConverters.h.

NonInterleavedSource

template<typename... Format>

using juce::AudioData::NonInterleavedSource = ChannelData<false, true, Format...>

A sequence of non-interleaved samples used as the source for the interleaveSamples() method.

Definition at line 701 of file juce_AudioDataConverters.h.

Member Function Documentation

deinterleaveSamples()

template<typename... SourceFormat, typename... DestFormat>

static void juce::AudioData::deinterleaveSamples ( InterleavedSource< SourceFormat... >  source, NonInterleavedDest< DestFormat... >  dest, int  numSamples  )

static

A helper function for converting a sequence of samples from an interleaved source to a non-interleaved destination.

When calling this method you need to specify the source and destination data format and endianness from the AudioData SampleFormat and Endianness types and provide the data and number of channels for each. For example, to convert a floating-point stream of big endian samples to an non-interleaved, native endian stream of 16-bit integer samples you would do the following:

using SourceFormat = AudioData::Format<AudioData::Float32, AudioData::BigEndian>;
using DestFormat   = AudioData::Format<AudioData::Int16,   AudioData::NativeEndian>;
 
AudioData::deinterleaveSamples (AudioData::InterleavedSource<SourceFormat> { sourceData, numSourceChannels },
                                AudioData::NonInterleavedDest<DestFormat>  { destData,   numDestChannels },
                                numSamples);

Definition at line 767 of file juce_AudioDataConverters.h.

interleaveSamples()

template<typename... SourceFormat, typename... DestFormat>

static void juce::AudioData::interleaveSamples ( NonInterleavedSource< SourceFormat... >  source, InterleavedDest< DestFormat... >  dest, int  numSamples  )

static

A helper function for converting a sequence of samples from a non-interleaved source to an interleaved destination.

When calling this method you need to specify the source and destination data format and endianness from the AudioData SampleFormat and Endianness types and provide the data and number of channels for each. For example, to convert a floating-point stream of big endian samples to an interleaved, native endian stream of 16-bit integer samples you would do the following:

using SourceFormat = AudioData::Format<AudioData::Float32, AudioData::BigEndian>;
using DestFormat   = AudioData::Format<AudioData::Int16,   AudioData::NativeEndian>;
 
AudioData::interleaveSamples (AudioData::NonInterleavedSource<SourceFormat> { sourceData, numSourceChannels },
                              AudioData::InterleavedDest<DestFormat>        { destData,   numDestChannels },
                              numSamples);

Definition at line 723 of file juce_AudioDataConverters.h.

---

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

• juce_audio_basics/buffers/juce_AudioDataConverters.h