Klang C++ 0.7.15
Language Reference (draft)
Loading...
Searching...
No Matches
klang::Stereo::buffer

Language Guide / Signal Flow

stereo::buffer

klang::Stereo::buffer

A non-interleaved view of a stereo audio block.

A stereo::buffer borrows two klang::buffer objects, one per channel. The samples are stored separately by channel. Keep the channel buffers and their backing storage alive while the view is in use. Use left and right to access the current samples, then advance the stereo cursor once to move both channels together.

Example ยท Set the gain of each channel

while (!block.finished()) {
    block.left *= 0.5;
    block.right *= 0.25;
    block++;
}

See also buffer.

Stereo audio buffer. More...

#include <klang.h>

Public Types

typedef Stereo::signal signal
 

Public Member Functions

 buffer (const buffer &buffer)
 
 buffer (mono::buffer &left, mono::buffer &right)
 
 operator const signal () const
 
 operator frame ()
 
bool finished () const
 
frame operator++ (int)
 
frame operator= (const signal &in)
 
buffer & operator= (const buffer &in)
 
buffer & operator+= (const signal &in)
 
buffer & operator= (const frame &in)
 
buffer & operator+= (const frame &in)
 
buffer & operator*= (const frame &in)
 
buffer & operator= (const mono::signal in)
 
buffer & operator+= (const mono::signal in)
 
buffer & operator*= (const mono::signal in)
 
frame operator[] (int index)
 
signal operator[] (int index) const
 
mono::buffer & channel (int index)
 
void clear ()
 
void clear (int size)
 
void rewind ()
 

Public Attributes

mono::buffer & left
 
mono::buffer & right
 

Detailed Description

Definition at line 5934 of file klang.h.

Member Typedef Documentation

◆ signal

Constructor & Destructor Documentation

◆ buffer() [1/2]

klang::Stereo::buffer::buffer ( const buffer & buffer)
inline

Definition at line 5938 of file klang.h.

5938: left(buffer.left), right(buffer.right) { rewind(); }
buffer(const buffer &buffer)
Definition klang.h:5938
mono::buffer & left
Definition klang.h:5936
mono::buffer & right
Definition klang.h:5936

Referenced by klang::Stereo::Delay< SIZE >::tap().

◆ buffer() [2/2]

klang::Stereo::buffer::buffer ( mono::buffer & left,
mono::buffer & right )
inline

Definition at line 5939 of file klang.h.

5939: left(left), right(right) { rewind(); }

Member Function Documentation

◆ channel()

mono::buffer & klang::Stereo::buffer::channel ( int index)
inline

Definition at line 5978 of file klang.h.

5978 {
5979 return index == 1 ? right : left;
5980 }

◆ clear() [1/2]

void klang::Stereo::buffer::clear ( )
inline

Definition at line 5982 of file klang.h.

5982 {
5983 left.clear();
5984 right.clear();
5985 }
void clear()
Definition klang.h:2673

References klang::buffer::clear().

◆ clear() [2/2]

void klang::Stereo::buffer::clear ( int size)
inline

Definition at line 5987 of file klang.h.

5987 {
5988 left.clear(size);
5989 right.clear(size);
5990 }

References klang::buffer::clear().

◆ finished()

bool klang::Stereo::buffer::finished ( ) const
inline

◆ operator const signal()

klang::Stereo::buffer::operator const signal ( ) const
inline

Definition at line 5941 of file klang.h.

5941{ return { left, right }; }

◆ operator frame()

klang::Stereo::buffer::operator frame ( )
inline

Definition at line 5942 of file klang.h.

5942{ return { left, right }; }

◆ operator*=() [1/2]

buffer & klang::Stereo::buffer::operator*= ( const frame & in)
inline

Definition at line 5964 of file klang.h.

5964{ left *= in.l; right *= in.r; return *this; }

References klang::Stereo::frame::l, and klang::Stereo::frame::r.

◆ operator*=() [2/2]

buffer & klang::Stereo::buffer::operator*= ( const mono::signal in)
inline

Definition at line 5968 of file klang.h.

5968{ left *= in; right *= in; return *this; }

◆ operator++()

frame klang::Stereo::buffer::operator++ ( int )
inline

Definition at line 5944 of file klang.h.

5944{ return { left++, right++ }; }

◆ operator+=() [1/3]

buffer & klang::Stereo::buffer::operator+= ( const frame & in)
inline

Definition at line 5963 of file klang.h.

5963{ left += in.l; right += in.r; return *this; }

References klang::Stereo::frame::l, and klang::Stereo::frame::r.

◆ operator+=() [2/3]

buffer & klang::Stereo::buffer::operator+= ( const mono::signal in)
inline

Definition at line 5967 of file klang.h.

5967{ left += in; right += in; return *this; }

◆ operator+=() [3/3]

buffer & klang::Stereo::buffer::operator+= ( const signal & in)
inline

Definition at line 5956 of file klang.h.

5956 {
5957 left += in.l;
5958 right += in.r;
5959 return *this;
5960 }

◆ operator=() [1/4]

buffer & klang::Stereo::buffer::operator= ( const buffer & in)
inline

Definition at line 5950 of file klang.h.

5950 {
5951 left = in.left;
5952 right = in.right;
5953 return *this;
5954 }

References left, and right.

◆ operator=() [2/4]

buffer & klang::Stereo::buffer::operator= ( const frame & in)
inline

Definition at line 5962 of file klang.h.

5962{ left = in.l; right = in.r; return *this; }

References klang::Stereo::frame::l, and klang::Stereo::frame::r.

◆ operator=() [3/4]

buffer & klang::Stereo::buffer::operator= ( const mono::signal in)
inline

Definition at line 5966 of file klang.h.

5966{ left = in; right = in; return *this; }

◆ operator=() [4/4]

frame klang::Stereo::buffer::operator= ( const signal & in)
inline

Definition at line 5946 of file klang.h.

5946 {
5947 return { left = in.l, right = in.r };
5948 }

◆ operator[]() [1/2]

frame klang::Stereo::buffer::operator[] ( int index)
inline

Definition at line 5970 of file klang.h.

5970 {
5971 return { left[index], right[index] };
5972 }

◆ operator[]() [2/2]

signal klang::Stereo::buffer::operator[] ( int index) const
inline

Definition at line 5974 of file klang.h.

5974 {
5975 return { left[index], right[index] };
5976 }

◆ rewind()

void klang::Stereo::buffer::rewind ( )
inline

Definition at line 5992 of file klang.h.

5992 {
5993 left.rewind();
5994 right.rewind();
5995 }
void rewind(int offset=0)
Definition klang.h:2665

References klang::buffer::rewind().

Member Data Documentation

◆ left

mono::buffer& klang::Stereo::buffer::left

Definition at line 5936 of file klang.h.

Referenced by operator=(), and klang::Stereo::Mono::Note::process().

◆ right

mono::buffer & klang::Stereo::buffer::right

Definition at line 5936 of file klang.h.

Referenced by operator=(), and klang::Stereo::Mono::Note::process().