Loading...
Searching...
No Matches
Classes | Public Types | Static Public Member Functions | List of all members
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.

Member Typedef Documentation

◆ InterleavedSource

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

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

◆ InterleavedDest

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

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

◆ NonInterleavedSource

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

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

◆ NonInterleavedDest

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

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

Member Function Documentation

◆ interleaveSamples()

template<typename... SourceFormat, typename... DestFormat>
static void 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:

AudioData::InterleavedDest<DestFormat> { destData, numDestChannels },
numSamples);
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 interleave...
Definition juce_AudioDataConverters.h:726
ChannelData< true, false, Format... > InterleavedDest
A sequence of interleaved samples used as the destination for the interleaveSamples() method.
Definition juce_AudioDataConverters.h:702
ChannelData< false, true, Format... > NonInterleavedSource
A sequence of non-interleaved samples used as the source for the interleaveSamples() method.
Definition juce_AudioDataConverters.h:704
A struct that contains a SampleFormat and Endianness to be used with the source and destination types...
Definition juce_AudioDataConverters.h:657

References addBytesToPointer().

◆ deinterleaveSamples()

template<typename... SourceFormat, typename... DestFormat>
static void 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:

AudioData::NonInterleavedDest<DestFormat> { destData, numDestChannels },
numSamples);
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-interleave...
Definition juce_AudioDataConverters.h:770
ChannelData< false, false, Format... > NonInterleavedDest
A sequence of non-interleaved samples used as the destination for the deinterleaveSamples() method.
Definition juce_AudioDataConverters.h:706
ChannelData< true, true, Format... > InterleavedSource
A sequence of interleaved samples used as the source for the deinterleaveSamples() method.
Definition juce_AudioDataConverters.h:700

References addBytesToPointer().


The documentation for this class was generated from the following file:
linkedin facebook pinterest youtube rss twitter instagram facebook-blank rss-blank linkedin-blank pinterest youtube twitter instagram