Kwave::StreamWriter Class Reference

#include <StreamWriter.h>

Inheritance diagram for Kwave::StreamWriter:

Collaboration diagram for Kwave::StreamWriter:

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

Public Member Functions
	StreamWriter ()
virtual	~StreamWriter () Q_DECL_OVERRIDE
virtual bool	write (const Kwave::SampleArray &buffer, unsigned int &count) Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::Writer
	Writer ()
	Writer (Kwave::InsertMode mode, sample_index_t left=0, sample_index_t right=0)
virtual	~Writer () Q_DECL_OVERRIDE
virtual Writer &	operator<< (const Kwave::SampleArray &samples)
virtual Writer &	operator<< (const sample_t &sample)
Writer &	operator<< (Writer &(*modifier)(Writer &))
Writer &	operator<< (Kwave::SampleReader &reader)
bool	flush ()
virtual bool	eof () const
virtual bool	done () const Q_DECL_OVERRIDE
sample_index_t	first () const
sample_index_t	last () const
sample_index_t	position () const
Kwave::InsertMode	mode () const
Public Member Functions inherited from Kwave::SampleSink
	SampleSink (QObject *parent=Q_NULLPTR)
virtual	~SampleSink ()
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)

Additional Inherited Members
Public Slots inherited from Kwave::Writer
void	input (Kwave::SampleArray data)
Static Public Member Functions inherited from Kwave::StreamObject
static void	setInteractive (bool interactive)
Protected Attributes inherited from Kwave::Writer
sample_index_t	m_first
sample_index_t	m_last
Kwave::InsertMode	m_mode
sample_index_t	m_position
Kwave::SampleArray	m_buffer
unsigned int	m_buffer_size
unsigned int	m_buffer_used

Detailed Description

Input stream for transferring samples into a Track.

Warning

THIS CLASS IS NOT THREADSAFE! It is intended to be owned by and used from only one thread.

Definition at line 42 of file StreamWriter.h.

Constructor & Destructor Documentation

StreamWriter()

Kwave::StreamWriter::StreamWriter

(

)

Constructor

Definition at line 25 of file StreamWriter.cpp.

    :Kwave::Writer()
{
}

~StreamWriter()

Kwave::StreamWriter::~StreamWriter ( )

virtual

Destructor.

Definition at line 31 of file StreamWriter.cpp.

References Kwave::Writer::m_buffer_used.

{
    // If this assert gets hit, you deleted a writer without calling
    // flush() before. Flushing in the destructor is problematic and
    // might be too late when the derived classes' destructor was
    // already done and signal/slot connections were already released!
    Q_ASSERT(!m_buffer_used);
    if (m_buffer_used) qWarning("StreamWriter was not flushed!?");
}

Member Function Documentation

output

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

signal

emits a block with sine wave data

Referenced by write().

Here is the caller graph for this function:

write()

bool Kwave::StreamWriter::write ( const Kwave::SampleArray &  buffer, unsigned int &  count  )

virtual

Flush the content of a buffer. Normally the buffer is the internal intermediate buffer used for single-sample writes. When using block transfers, the internal buffer is bypassed and the written block is passed instead.

Parameters

buffer	reference to the buffer to be flushed
count	number of samples in the buffer to be flushed, will be internally set to zero if successful

Returns

true if successful, false if failed (e.g. out of memory)

Implements Kwave::Writer.

Definition at line 42 of file StreamWriter.cpp.

References output(), Kwave::SampleArray::resize(), and Kwave::SampleArray::size().

{
    // NOTE: even zero length input has to be passed, needed for flushing!

    if (count < buffer.size()) {
        // have to work with a resized copy - slow :-(
        Kwave::SampleArray data = buffer;
        if (!data.resize(count))
            return false; // out-of-memory ?

        // emit the resized copy
        emit output(data);
    } else {
        // directly emit the buffer - fast :-)
        emit output(buffer);
    }

    count = 0;
    return true;
}

Here is the call graph for this function:

---

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

• libkwave/StreamWriter.h
• libkwave/StreamWriter.cpp