Klang C++ 0.7.15
Language Reference (draft)
Loading...
Searching...
No Matches
klang::interleaved::buffer< CHANNELS >

#include <klang.h>

Public Types

using signal = signals<CHANNELS>
 

Public Member Functions

 buffer (float *samples, int size)
 
 buffer (float *samples, int size, float initial)
 
 buffer (int size=1, float initial=0)
 
 buffer (const buffer &other)
 
 ~buffer ()
 
void rewind (int offset=0)
 
int offset () const
 
void clear ()
 
void clear (int count)
 
void set (float value=0)
 
signal & operator[] (int index)
 
const signal & operator[] (int index) const
 
signal operator[] (float offset) const
 
signal operator[] (float offset)
 
 operator signal & ()
 
 operator const signal & () const
 
bool finished () const
 
signal & operator++ (int)
 
signal & operator= (const signal &value)
 
signal & operator+= (const signal &value)
 
signal & operator*= (const signal &value)
 
buffer & operator= (const buffer &other)
 
buffer & operator<< (const signal &value)
 
float * data ()
 
const float * data () const
 

Public Attributes

const int size
 

Detailed Description

template<int CHANNELS = 2>
class klang::interleaved::buffer< CHANNELS >

Interleaved frames: L,R,L,R for two channels. Sizes and offsets are frames. A float-pointer constructor borrows host storage; the size constructor owns storage rounded up to a power of two. Copies borrow the same storage and rewind; the original owner must outlive them. Assignment copies audio. Owned integer indexing wraps at allocated frame capacity, like mono buffer. Example: interleaved::buffer<2> audio(hostSamples, frameCount);

Definition at line 2842 of file klang.h.

Member Typedef Documentation

◆ signal

template<int CHANNELS = 2>
using klang::interleaved::buffer< CHANNELS >::signal = signals<CHANNELS>

Definition at line 2844 of file klang.h.

Constructor & Destructor Documentation

◆ buffer() [1/4]

template<int CHANNELS = 2>
klang::interleaved::buffer< CHANNELS >::buffer ( float * samples,
int size )
inline

Definition at line 2868 of file klang.h.

2868 : samples(samples), size(size) {
2869 assert(size >= 0 && (samples || size == 0));
2870 rewind();
2871 }
void rewind(int offset=0)
Definition klang.h:2887

References klang::interleaved::buffer< CHANNELS >::rewind(), and klang::interleaved::buffer< CHANNELS >::size.

◆ buffer() [2/4]

template<int CHANNELS = 2>
klang::interleaved::buffer< CHANNELS >::buffer ( float * samples,
int size,
float initial )
inline

Definition at line 2872 of file klang.h.

2872 : buffer(samples, size) {
2873 set(initial);
2874 }
void set(float value=0)
Definition klang.h:2898
buffer(float *samples, int size)
Definition klang.h:2868

References klang::interleaved::buffer< CHANNELS >::set().

◆ buffer() [3/4]

template<int CHANNELS = 2>
klang::interleaved::buffer< CHANNELS >::buffer ( int size = 1,
float initial = 0 )
inline

Definition at line 2875 of file klang.h.

2876 : mask(capacity(size) - 1), owned(true),
2877 samples(reinterpret_cast<float*>(new signal[capacity(size)])), size(size) {
2878 assert(size >= 0);
2879 rewind();
2880 set(initial);
2881 }
signals< CHANNELS > signal
Definition klang.h:2844

References klang::interleaved::buffer< CHANNELS >::rewind(), klang::interleaved::buffer< CHANNELS >::set(), and klang::interleaved::buffer< CHANNELS >::size.

◆ buffer() [4/4]

template<int CHANNELS = 2>
klang::interleaved::buffer< CHANNELS >::buffer ( const buffer< CHANNELS > & other)
inline

Definition at line 2882 of file klang.h.

2883 : mask(other.mask), samples(other.samples), size(other.size) { rewind(); }

References klang::interleaved::buffer< CHANNELS >::rewind().

◆ ~buffer()

template<int CHANNELS = 2>
klang::interleaved::buffer< CHANNELS >::~buffer ( )
inline

Definition at line 2884 of file klang.h.

2884 {
2885 if (owned) delete[] reinterpret_cast<signal*>(samples);
2886 }

Member Function Documentation

◆ clear() [1/2]

◆ clear() [2/2]

template<int CHANNELS = 2>
void klang::interleaved::buffer< CHANNELS >::clear ( int count)
inline

Definition at line 2894 of file klang.h.

2894 {
2895 assert(count >= 0);
2896 if (count > 0 && size > 0) std::memset(samples, 0, sizeof(signal) * std::min(count, size));
2897 }

References klang::interleaved::buffer< CHANNELS >::size.

◆ data() [1/2]

template<int CHANNELS = 2>
float * klang::interleaved::buffer< CHANNELS >::data ( )
inline

Definition at line 2928 of file klang.h.

2928{ return samples; }

◆ data() [2/2]

template<int CHANNELS = 2>
const float * klang::interleaved::buffer< CHANNELS >::data ( ) const
inline

Definition at line 2929 of file klang.h.

2929{ return samples; }

◆ finished()

template<int CHANNELS = 2>
bool klang::interleaved::buffer< CHANNELS >::finished ( ) const
inline

Definition at line 2917 of file klang.h.

2917{ return ptr == end; }

◆ offset()

template<int CHANNELS = 2>
int klang::interleaved::buffer< CHANNELS >::offset ( ) const
inline

Definition at line 2892 of file klang.h.

2892{ return samples ? int(ptr - reinterpret_cast<signal*>(samples)) : 0; }

Referenced by klang::interleaved::buffer< CHANNELS >::operator[](), klang::interleaved::buffer< CHANNELS >::operator[](), and klang::interleaved::buffer< CHANNELS >::rewind().

◆ operator const signal &()

template<int CHANNELS = 2>
klang::interleaved::buffer< CHANNELS >::operator const signal & ( ) const
inline

Definition at line 2916 of file klang.h.

2916{ return *ptr; }

◆ operator signal &()

template<int CHANNELS = 2>
klang::interleaved::buffer< CHANNELS >::operator signal & ( )
inline

Definition at line 2915 of file klang.h.

2915{ return *ptr; }

◆ operator*=()

template<int CHANNELS = 2>
signal & klang::interleaved::buffer< CHANNELS >::operator*= ( const signal & value)
inline

Definition at line 2921 of file klang.h.

2921{ return *ptr *= value; }

◆ operator++()

template<int CHANNELS = 2>
signal & klang::interleaved::buffer< CHANNELS >::operator++ ( int )
inline

Definition at line 2918 of file klang.h.

2918{ return *ptr++; }

◆ operator+=()

template<int CHANNELS = 2>
signal & klang::interleaved::buffer< CHANNELS >::operator+= ( const signal & value)
inline

Definition at line 2920 of file klang.h.

2920{ return *ptr += value; }

◆ operator<<()

template<int CHANNELS = 2>
buffer & klang::interleaved::buffer< CHANNELS >::operator<< ( const signal & value)
inline

Definition at line 2927 of file klang.h.

2927{ *ptr = value; return *this; }

◆ operator=() [1/2]

template<int CHANNELS = 2>
buffer & klang::interleaved::buffer< CHANNELS >::operator= ( const buffer< CHANNELS > & other)
inline

Definition at line 2922 of file klang.h.

2922 {
2923 if (size > 0 && other.size > 0)
2924 std::memmove(samples, other.samples, std::min(size, other.size) * sizeof(signal));
2925 return *this;
2926 }

References klang::interleaved::buffer< CHANNELS >::size.

◆ operator=() [2/2]

template<int CHANNELS = 2>
signal & klang::interleaved::buffer< CHANNELS >::operator= ( const signal & value)
inline

Definition at line 2919 of file klang.h.

2919{ return *ptr = value; }

◆ operator[]() [1/4]

template<int CHANNELS = 2>
signal klang::interleaved::buffer< CHANNELS >::operator[] ( float offset)
inline

Definition at line 2914 of file klang.h.

2914{ return static_cast<const buffer&>(*this)[offset]; }

References klang::interleaved::buffer< CHANNELS >::offset().

◆ operator[]() [2/4]

template<int CHANNELS = 2>
signal klang::interleaved::buffer< CHANNELS >::operator[] ( float offset) const
inline

Definition at line 2908 of file klang.h.

2908 {
2909 const float whole = std::floor(offset);
2910 const float fraction = offset - whole;
2911 const int i = int(whole), j = i == size - 1 ? 0 : i + 1;
2912 return (*this)[i] * (1.f - fraction) + (*this)[j] * fraction;
2913 }

References klang::interleaved::buffer< CHANNELS >::offset(), and klang::interleaved::buffer< CHANNELS >::size.

◆ operator[]() [3/4]

template<int CHANNELS = 2>
signal & klang::interleaved::buffer< CHANNELS >::operator[] ( int index)
inline

Definition at line 2902 of file klang.h.

2902 {
2903 return reinterpret_cast<signal*>(samples)[static_cast<unsigned int>(index) & mask];
2904 }

◆ operator[]() [4/4]

template<int CHANNELS = 2>
const signal & klang::interleaved::buffer< CHANNELS >::operator[] ( int index) const
inline

Definition at line 2905 of file klang.h.

2905 {
2906 return reinterpret_cast<const signal*>(samples)[static_cast<unsigned int>(index) & mask];
2907 }

◆ rewind()

template<int CHANNELS = 2>
void klang::interleaved::buffer< CHANNELS >::rewind ( int offset = 0)
inline

Definition at line 2887 of file klang.h.

2887 {
2888 assert(offset >= 0 && offset <= size);
2889 ptr = samples ? reinterpret_cast<signal*>(samples) + offset : nullptr;
2890 end = samples ? reinterpret_cast<signal*>(samples) + size : nullptr;
2891 }

References klang::interleaved::buffer< CHANNELS >::offset(), and klang::interleaved::buffer< CHANNELS >::size.

Referenced by klang::interleaved::buffer< CHANNELS >::buffer(), klang::interleaved::buffer< CHANNELS >::buffer(), and klang::interleaved::buffer< CHANNELS >::buffer().

◆ set()

template<int CHANNELS = 2>
void klang::interleaved::buffer< CHANNELS >::set ( float value = 0)
inline

Definition at line 2898 of file klang.h.

2898 {
2899 if (value == 0) clear();
2900 else for (size_t i = 0; i < size_t(size) * CHANNELS; ++i) samples[i] = value;
2901 }

References klang::interleaved::buffer< CHANNELS >::clear(), and klang::interleaved::buffer< CHANNELS >::size.

Referenced by klang::interleaved::buffer< CHANNELS >::buffer(), and klang::interleaved::buffer< CHANNELS >::buffer().

Member Data Documentation

◆ size