Kwave::SampleBuffer Class Reference

#include <SampleBuffer.h>

Inheritance diagram for Kwave::SampleBuffer:

Collaboration diagram for Kwave::SampleBuffer:

Public Slots
virtual void	input (Kwave::SampleArray data)

Signals
void	output (Kwave::SampleArray data)
Signals inherited from Kwave::StreamObject
void	attributeChanged (const QVariant value)

Public Member Functions
	SampleBuffer (QObject *parent=Q_NULLPTR)
virtual	~SampleBuffer ()
virtual bool	isEmpty () const
virtual Kwave::SampleArray &	data ()
virtual const Kwave::SampleArray &	constData () const
virtual unsigned int	available () const
virtual const sample_t *	get (unsigned int len)
void	put (sample_t sample)
virtual void	finished ()
Public Member Functions inherited from Kwave::SampleSink
	SampleSink (QObject *parent=Q_NULLPTR)
virtual	~SampleSink ()
virtual bool	done () const
Public Member Functions inherited from Kwave::StreamObject
	StreamObject (QObject *parent=Q_NULLPTR)
virtual	~StreamObject ()
virtual unsigned int	tracks () const
virtual Kwave::StreamObject *	operator[] (unsigned int track)
virtual unsigned int	tracksOfPort (const char *port) const
virtual Kwave::StreamObject *	port (const char *port, unsigned int track)
virtual unsigned int	blockSize () const
void	setAttribute (const char *attribute, const QVariant &value)

Protected Member Functions
void	emitData (Kwave::SampleArray data)

Private Member Functions
void	enqueue (Kwave::SampleArray data)

Private Attributes
Kwave::SampleArray	m_data
unsigned int	m_offset
unsigned int	m_buffered
QSemaphore	m_sema

Friends
class	BufferJob

Additional Inherited Members
Static Public Member Functions inherited from Kwave::StreamObject
static void	setInteractive (bool interactive)

Detailed Description

Definition at line 33 of file SampleBuffer.h.

Constructor & Destructor Documentation

SampleBuffer()

Kwave::SampleBuffer::SampleBuffer

(

QObject *

parent = Q_NULLPTR

)

Constructor

Parameters

parent

a parent object, passed to QObject (optional)

Definition at line 28 of file SampleBuffer.cpp.

    :Kwave::SampleSink(parent),
     m_data(), m_offset(0), m_buffered(0), m_sema(1)
{
}

~SampleBuffer()

Kwave::SampleBuffer::~SampleBuffer ( )

virtual

Destructor

Definition at line 35 of file SampleBuffer.cpp.

References m_sema.

{
    m_sema.acquire();
}

Member Function Documentation

available()

unsigned int Kwave::SampleBuffer::available ( ) const

virtual

returns the number of samples that can be fetched with get()

Definition at line 59 of file SampleBuffer.cpp.

References m_data, m_offset, and Kwave::SampleArray::size().

Referenced by Kwave::OpusEncoder::fillInBuffer().

{
    unsigned int size = m_data.size();
    return (size > m_offset) ? (size - m_offset) : 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

constData()

const Kwave::SampleArray & Kwave::SampleBuffer::constData ( ) const

virtual

returns a const reference to the sample data

Definition at line 53 of file SampleBuffer.cpp.

References m_data.

Referenced by Kwave::ChannelMixer::mix().

{
    return m_data;
}

Here is the caller graph for this function:

data()

Kwave::SampleArray & Kwave::SampleBuffer::data ( )

virtual

returns a reference to the sample data

Definition at line 47 of file SampleBuffer.cpp.

References m_data.

Referenced by input(), and Kwave::ChannelMixer::mix().

{
    return m_data;
}

Here is the caller graph for this function:

emitData()

void Kwave::SampleBuffer::emitData ( Kwave::SampleArray  data )

protected

Emit data from this object, used from a buffer thread

Parameters

data	a sample array to emit

Definition at line 140 of file SampleBuffer.cpp.

References m_sema, and output().

Referenced by enqueue().

{
    // NOTE: this signal could be connected to a slot that blocks for a while
    emit output(data);
    m_sema.release();
}

Here is the caller graph for this function:

enqueue()

void Kwave::SampleBuffer::enqueue ( Kwave::SampleArray  data )

private

enqueue some data

Definition at line 133 of file SampleBuffer.cpp.

References emitData(), and m_sema.

Referenced by finished(), and input().

{
    m_sema.acquire();
    QtConcurrent::run(this, &Kwave::SampleBuffer::emitData, data);
}

Here is the call graph for this function:

Here is the caller graph for this function:

finished()

void Kwave::SampleBuffer::finished ( )

virtual

emit the sample data stored in m_data

Definition at line 101 of file SampleBuffer.cpp.

References Kwave::StreamObject::blockSize(), enqueue(), m_buffered, m_data, Kwave::SampleArray::resize(), and Kwave::SampleArray::size().

Referenced by Kwave::OpusDecoder::close(), Kwave::ChannelMixer::mix(), and put().

{
    bool ok = true;

    if (m_buffered && (m_data.size() != m_buffered))
        ok &= m_data.resize(m_buffered);

    enqueue(m_data);
    m_buffered = 0;
    ok &= m_data.resize(Kwave::StreamObject::blockSize());
    Q_ASSERT(ok);
}

Here is the call graph for this function:

Here is the caller graph for this function:

get()

const sample_t * Kwave::SampleBuffer::get ( unsigned int  len )

virtual

returns a pointer to the raw data and advances the internal offset afterwards

Parameters

len	maximum number of samples to get

Returns

pointer to the raw data in the buffer

Definition at line 66 of file SampleBuffer.cpp.

References Kwave::SampleArray::constData(), m_data, m_offset, and Kwave::SampleArray::size().

Referenced by Kwave::OpusEncoder::fillInBuffer().

{
    const unsigned int size = m_data.size();
    if (m_offset > size) return Q_NULLPTR; // already reached EOF

    // limit read length to the size of the buffer
    if (len > size) len = size;

    // get a pointer to the raw data
    const sample_t *raw = m_data.constData() + m_offset;

    // advance the offset
    m_offset += len;

    return raw;
}

Here is the call graph for this function:

Here is the caller graph for this function:

input

void Kwave::SampleBuffer::input ( Kwave::SampleArray  data )

virtualslot

slot for taking input data, stores it into m_data

Definition at line 115 of file SampleBuffer.cpp.

References data(), enqueue(), m_buffered, m_data, m_offset, Kwave::SampleArray::resize(), and Kwave::SampleArray::size().

{
    // if we have buffered data, flush that first
    if (m_buffered) {
        bool ok = m_data.resize(m_buffered);
        Q_ASSERT(ok);
        Q_UNUSED(ok);
        m_buffered = 0;
        enqueue(m_data);
    }

    // take over the input array directly
    m_data     = data;
    m_offset   = 0;
    m_buffered = data.size();
}

Here is the call graph for this function:

isEmpty()

bool Kwave::SampleBuffer::isEmpty ( ) const

virtual

returns true if no sample data is present

Definition at line 41 of file SampleBuffer.cpp.

References Kwave::SampleArray::isEmpty(), and m_data.

{
    return m_data.isEmpty();
}

Here is the call graph for this function:

output

void Kwave::SampleBuffer::output ( Kwave::SampleArray  data )

signal

emits the data received via input()

Referenced by emitData().

Here is the caller graph for this function:

put()

void Kwave::SampleBuffer::put

(

sample_t

sample

)

Appends one samples to the buffer. If the buffer is full afterwards, the buffer will be emitted.

Parameters

sample

a single sample

Definition at line 84 of file SampleBuffer.cpp.

References Kwave::StreamObject::blockSize(), finished(), m_buffered, m_data, and Kwave::SampleArray::resize().

Referenced by Kwave::OpusDecoder::decode().

{
    const unsigned int block_size = Kwave::StreamObject::blockSize();

    if (m_buffered >= block_size) finished();

    // initial fill of the buffer?
    bool ok = m_data.resize(block_size);
    Q_ASSERT(ok);
    Q_UNUSED(ok);

    m_data[m_buffered++] = sample;
    if (m_buffered >= block_size) finished();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

BufferJob

friend class BufferJob

friend

Definition at line 85 of file SampleBuffer.h.

Member Data Documentation

m_buffered

unsigned int Kwave::SampleBuffer::m_buffered

private

number of samples buffered, e.g. through put()

Definition at line 112 of file SampleBuffer.h.

Referenced by finished(), input(), and put().

m_data

Kwave::SampleArray Kwave::SampleBuffer::m_data

private

array with sample data

Definition at line 106 of file SampleBuffer.h.

Referenced by available(), constData(), data(), finished(), get(), input(), isEmpty(), and put().

m_offset

unsigned int Kwave::SampleBuffer::m_offset

private

offset within the data, for reading

Definition at line 109 of file SampleBuffer.h.

Referenced by available(), get(), and input().

m_sema

QSemaphore Kwave::SampleBuffer::m_sema

private

semaphore for limiting queue depth to 1

Definition at line 115 of file SampleBuffer.h.

Referenced by emitData(), enqueue(), and ~SampleBuffer().

---

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

• libkwave/modules/SampleBuffer.h
• libkwave/modules/SampleBuffer.cpp