#include <SampleReader.h>

Inheritance diagram for Kwave::SampleReader:

Collaboration diagram for Kwave::SampleReader:

Signals
void	proceeded ()

void	output (Kwave::SampleArray data)

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

Public Member Functions
	SampleReader (Kwave::ReaderMode mode, Kwave::Stripe::List stripes)

virtual	~SampleReader () Q_DECL_OVERRIDE

void	reset ()

virtual void	goOn () Q_DECL_OVERRIDE

bool	eof () const

virtual bool	done () const Q_DECL_OVERRIDE

unsigned int	read (Kwave::SampleArray &buffer, unsigned int dstoff, unsigned int length)

void	minMax (sample_index_t first, sample_index_t last, sample_t &min, sample_t &max)

void	skip (sample_index_t count)

void	seek (sample_index_t pos)

sample_index_t	pos () const

sample_index_t	first () const

sample_index_t	last () const

SampleReader &	operator>> (sample_t &sample)

SampleReader &	operator>> (Kwave::SampleArray &sample)

Public Member Functions inherited from Kwave::SampleSource
	SampleSource (QObject *parent=Q_NULLPTR)

virtual	~SampleSource ()

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	fillBuffer ()

unsigned int	readSamples (sample_index_t offset, Kwave::SampleArray &buffer, unsigned int buf_offset, unsigned int length)

Private Attributes
Kwave::ReaderMode	m_mode

QList< Kwave::Stripe >	m_stripes

sample_index_t	m_src_position

sample_index_t	m_first

sample_index_t	m_last

Kwave::SampleArray	m_buffer

unsigned int	m_buffer_used

unsigned int	m_buffer_position

QTime	m_progress_time

sample_index_t	m_last_seek_pos

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

Detailed Description

Definition at line 39 of file SampleReader.h.

Constructor & Destructor Documentation

◆ SampleReader()

Kwave::SampleReader::SampleReader	(	Kwave::ReaderMode	mode,
		Kwave::Stripe::List	stripes
	)

Constructor. Creates a stream for reading samples from a track.

Parameters

mode	the reader mode, see Kwave::ReaderMode
stripes	list of stripes which contains the desired range

See also: InsertMode

Definition at line 35 of file SampleReader.cpp.

References m_progress_time.

     :m_mode(mode), m_stripes(stripes),
      m_src_position(stripes.left()), m_first(stripes.left()),
      m_last(stripes.right()), m_buffer(blockSize()),
      m_buffer_used(0), m_buffer_position(0),
      m_progress_time(), m_last_seek_pos(stripes.right())
 {
     m_progress_time.start();
 }

◆ ~SampleReader()

Kwave::SampleReader::~SampleReader ( )

virtual

Destructor

Definition at line 47 of file SampleReader.cpp.

48 {

49 }

Member Function Documentation

◆ done()

virtual bool Kwave::SampleReader::done ( ) const

inlinevirtual

Returns true if the end of the source has been reached, e.g. at EOF of an input stream.

Returns: true if it can produce more sample data, otherwise false

See also: eof()

Reimplemented from Kwave::SampleSource.

Definition at line 77 of file SampleReader.h.

77 { return eof(); }

Kwave::SampleReader::eof

bool eof() const

Definition: SampleReader.h:66

◆ eof()

bool Kwave::SampleReader::eof ( ) const

inline

Checks if the last read operation has reached the end of input

Definition at line 66 of file SampleReader.h.

Referenced by Kwave::AsciiEncoder::encode(), Kwave::WavEncoder::encode(), Kwave::MP3Encoder::encode(), Kwave::MultiTrackReader::eof(), fillBuffer(), Kwave::NormalizePlugin::getMaxPower(), Kwave::NormalizePlugin::getMaxPowerOfTrack(), Kwave::Writer::operator<<(), read(), and Kwave::PlaybackController::run_wrapper().

                                 {
             return (pos() > m_last);
         }

Here is the caller graph for this function:

◆ fillBuffer()

void Kwave::SampleReader::fillBuffer ( )

protected

Fills the sample buffer

Definition at line 75 of file SampleReader.cpp.

References eof(), Kwave::SampleArray::isEmpty(), m_buffer, m_buffer_position, m_buffer_used, m_last, m_progress_time, m_src_position, MIN_PROGRESS_INTERVAL, proceeded(), readSamples(), Kwave::SampleArray::size(), and Kwave::toUint().

Referenced by operator>>().

 {
     Q_ASSERT(m_buffer_position >= m_buffer_used);
     m_buffer_used = 0;
     m_buffer_position = 0;
     if (eof()) return;
     if (m_buffer.isEmpty()) return; // we had a OOM before?
 
     unsigned int rest = m_buffer.size();/* - m_buffer_used (is 0) */
     if (m_src_position + rest > m_last)
         rest = Kwave::toUint(m_last - m_src_position + 1);
     Q_ASSERT(rest <= m_buffer.size());
     if (rest > m_buffer.size()) rest = m_buffer.size();
     Q_ASSERT(rest);
 
     unsigned int len = readSamples(m_src_position, m_buffer, 0, rest);
     Q_ASSERT(len == rest);
     m_buffer_used  += len;
 
     // inform others that we proceeded
     if (m_progress_time.elapsed() > MIN_PROGRESS_INTERVAL) {
         m_progress_time.restart();
         emit proceeded();
         QApplication::sendPostedEvents();
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ first()

sample_index_t Kwave::SampleReader::first ( ) const

inline

Returns the position of the first sample

Definition at line 116 of file SampleReader.h.

Referenced by Kwave::MultiTrackReader::proceeded().

                                             {
             return m_first;
         }

Here is the caller graph for this function:

◆ goOn()

void Kwave::SampleReader::goOn ( )

virtual

Each KwaveSampleSource has to derive this method for producing sample data. It then should emit a signal like this: "output(SampleArray &data)"

Implements Kwave::SampleSource.

Definition at line 305 of file SampleReader.cpp.

References Kwave::StreamObject::blockSize(), and output().

 {
     Kwave::SampleArray buffer(blockSize());
     (*this) >> buffer;
     emit output(buffer);
 }

Here is the call graph for this function:

◆ last()

sample_index_t Kwave::SampleReader::last ( ) const

inline

Returns the position of the last sample

Definition at line 121 of file SampleReader.h.

Referenced by Kwave::MultiTrackReader::proceeded().

                                            {
             return m_last;
         }

Here is the caller graph for this function:

◆ minMax()

void Kwave::SampleReader::minMax	(	sample_index_t	first,
		sample_index_t	last,
		sample_t &	min,
		sample_t &	max
	)

Returns the minimum and maximum sample value within a range of samples.

Parameters

first	index of the first sample
last	index of the last sample
min	receives the lowest value or 0 if no samples are in range
max	receives the highest value or 0 if no samples are in range

Note: min and max do not need to be initialized

Definition at line 103 of file SampleReader.cpp.

References Kwave::Stripe::end(), Kwave::Stripe::length(), m_stripes, Kwave::Stripe::minMax(), SAMPLE_MAX, SAMPLE_MIN, Kwave::Stripe::start(), and Kwave::toUint().

Referenced by Kwave::OverViewCache::getMinMax(), and Kwave::TrackPixmap::validateBuffer().

 {
     bool empty = true;
     min = SAMPLE_MAX;
     max = SAMPLE_MIN;
 
     foreach (Kwave::Stripe s, m_stripes) {
         if (!s.length()) continue;
         sample_index_t start = s.start();
         sample_index_t end   = s.end();
 
         if (end < first) continue; // not yet in range
         if (start > last)  break;  // done
 
         // overlap -> not empty
         empty = false;
 
         // get min/max from the stripe
         unsigned int s1 = Kwave::toUint(
             (first > start) ? (first - start) : 0);
         unsigned int s2 = Kwave::toUint(
             (last < end) ? (last - start) : (end - start));
         s.minMax(s1, s2, min, max);
     }
 
     // special case: no signal in that range -> set to zero
     if (empty) {
         min = 0;
         max = 0;
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator>>() [1/2]

Kwave::SampleReader & Kwave::SampleReader::operator>> ( sample_t & sample )

Reads one single sample.

Definition at line 278 of file SampleReader.cpp.

References fillBuffer(), m_buffer, m_buffer_position, and m_buffer_used.

 {
     // get new buffer if end of last buffer reached
     if (m_buffer_position >= m_buffer_used) fillBuffer();
     const Kwave::SampleArray &buffer = m_buffer;
     sample = (m_buffer_position < m_buffer_used) ?
               buffer[m_buffer_position++] : 0;
     return *this;
 }

Here is the call graph for this function:

◆ operator>>() [2/2]

Kwave::SampleReader & Kwave::SampleReader::operator>> ( Kwave::SampleArray & sample )

Reads a full buffer of samples. If the buffer cannot be filled, it will be shrinked to the number of samples that were really read.

Definition at line 289 of file SampleReader.cpp.

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

 {
     unsigned int size = buffer.size();
     unsigned int count = read(buffer, 0, size);
     if (count != size) {
         bool ok = buffer.resize(count);
         Q_ASSERT(ok); // shrinking should always be possible
         if (!ok) {
             qWarning("Kwave::SampleReader::operator >> - OOM?");
         }
     }
     return *this;
 }

Here is the call graph for this function:

◆ output

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

signal

Interface for the signal/slot based streaming API.

Parameters

data	sample data that has been read

Referenced by goOn().

Here is the caller graph for this function:

◆ pos()

sample_index_t Kwave::SampleReader::pos ( ) const

inline

Returns the current read position.

Definition at line 111 of file SampleReader.h.

Referenced by Kwave::MultiTrackReader::proceeded(), and seek().

                                           {
             return (m_src_position + m_buffer_position - m_buffer_used);
         }

Here is the caller graph for this function:

◆ proceeded

void Kwave::SampleReader::proceeded ( )

signal

Emitted when the internal buffer is filled or the reader is closed

Referenced by fillBuffer(), read(), and reset().

Here is the caller graph for this function:

◆ read()

unsigned int Kwave::SampleReader::read	(	Kwave::SampleArray &	buffer,
		unsigned int	dstoff,
		unsigned int	length
	)

Reads samples into a buffer.

Parameters

buffer	the destination buffer to receive the samples
dstoff	offset within the destination buffer
length	number of samples to read

Returns: number of read samples

Definition at line 137 of file SampleReader.cpp.

References eof(), m_buffer, m_buffer_position, m_buffer_used, m_last, m_progress_time, m_src_position, MEMCPY, MIN_PROGRESS_INTERVAL, proceeded(), readSamples(), Kwave::SampleArray::size(), and Kwave::toUint().

Referenced by Kwave::NormalizePlugin::getMaxPowerOfTrack(), Kwave::Writer::operator<<(), operator>>(), and Kwave::TrackPixmap::validateBuffer().

 {
     if (eof() || !length) return 0; // already done or nothing to do
 
     // just a sanity check
     Q_ASSERT(buffer.size());
     Q_ASSERT(dstoff < buffer.size());
     if (dstoff >= buffer.size()) return 0;
 
     unsigned int count = 0;
     unsigned int rest = length;
     if (dstoff + rest > buffer.size()) rest = buffer.size() - dstoff;
     Q_ASSERT(rest);
     if (!rest) return 0;
 
     // first try to read from the current buffer
     if (m_buffer_position < m_buffer_used) {
         unsigned int cnt = rest;
         unsigned int src = m_buffer_position;
         unsigned int dst = dstoff;
 
         if (m_buffer_position + cnt > m_buffer_used)
             cnt = m_buffer_used - m_buffer_position;
 
         m_buffer_position += cnt;
         count  += cnt;
         rest   -= cnt;
         dstoff += cnt;
         qDebug("filling from buffer dstoff=%u, cnt=%u",dstoff,cnt);
 #ifdef STRICTLY_QT
         while (cnt--) {
             buffer[dst++] = m_buffer[src++];
         }
 #else
         const Kwave::SampleArray &in = m_buffer;
         MEMCPY(&(buffer[dst]), &(in[src]), cnt * sizeof(sample_t));
 #endif
 
         if (m_buffer_position >= m_buffer_used) {
             // buffer is empty now
             m_buffer_position = m_buffer_used = 0;
         }
 
         if (!rest) {
             // inform others that we proceeded
             if (m_progress_time.elapsed() > MIN_PROGRESS_INTERVAL) {
                 m_progress_time.restart();
                 emit proceeded();
                 QApplication::sendPostedEvents();
             }
             return count; // done
         }
     }
 
     // take the rest directly out of the stripe(s)
     if (m_src_position + rest > (m_last + 1)) // clip to end of reader range
         rest = Kwave::toUint((m_last + 1) - m_src_position);
     if (dstoff + rest > buffer.size()) // clip to end of buffer
         rest = buffer.size() - dstoff;
     Q_ASSERT(dstoff + rest <= buffer.size());
     unsigned int len = readSamples(m_src_position, buffer, dstoff, rest);
     Q_ASSERT(len == rest);
     count += len;
 
     // inform others that we proceeded
     if (m_progress_time.elapsed() > MIN_PROGRESS_INTERVAL) {
         m_progress_time.restart();
         emit proceeded();
         QApplication::sendPostedEvents();
     }
     return count;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSamples()

unsigned int Kwave::SampleReader::readSamples	(	sample_index_t	offset,
		Kwave::SampleArray &	buffer,
		unsigned int	buf_offset,
		unsigned int	length
	)

protected

Read a block of samples, with padding if necessary.

Parameters

offset	position where to start the read operation
buffer	receives the samples
buf_offset	offset within the buffer
length	number of samples to read

Returns: number of read samples

Definition at line 313 of file SampleReader.cpp.

References Kwave::Stripe::end(), Kwave::Stripe::length(), m_mode, m_src_position, m_stripes, padBuffer(), Kwave::Stripe::read(), Kwave::SinglePassForward, Kwave::SampleArray::size(), Kwave::Stripe::start(), and Kwave::toUint().

Referenced by fillBuffer(), and read().

 {
     Q_ASSERT(length);
     if (!length) return 0; // nothing to do !?
     Q_ASSERT(buf_offset + length <= buffer.size());
 
     unsigned int   rest  = length;
     sample_index_t left  = offset;
     sample_index_t right = offset + length - 1;
 
     foreach (Kwave::Stripe s, m_stripes) {
         if (!s.length()) continue;
         sample_index_t start = s.start();
         sample_index_t end   = s.end();
 
         if (left < start) {
             // gap before the stripe -> pad
             sample_index_t pad = Kwave::toUint(start - left);
             if (pad > rest) pad = rest;
             padBuffer(buffer, buf_offset, Kwave::toUint(pad));
             buf_offset += pad;
             rest       -= pad;
             left       += pad;
             if (!rest) break;
         }
 
         if (start > right) break; // done, we are after the range
 
         if (left <= end) {
             // some kind of overlap
             Q_ASSERT(left >= start);
             unsigned int ofs = Kwave::toUint(left - start);
             unsigned int len = Kwave::toUint(end - left + 1);
             if (len > rest) len = rest;
             unsigned int count = s.read(buffer, buf_offset, ofs, len);
             Q_ASSERT(count == len);
             buf_offset += count;
             rest       -= count;
             left       += count;
             if (!rest) break;
         }
     }
 
     // pad at the end
     if (rest) padBuffer(buffer, buf_offset, rest);
 
     m_src_position += length;
 
     // if this reader is of "single pass forward only" type: remove all
     // stripes that we have passed -> there is no way back!
     if (m_mode == Kwave::SinglePassForward) {
         while (!m_stripes.isEmpty() &&
                (m_stripes.first().end() < m_src_position))
         {
             m_stripes.removeFirst();
         }
     }
 
     return length;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

void Kwave::SampleReader::reset ( )

Resets the stream to it's start

Definition at line 52 of file SampleReader.cpp.

References m_buffer_position, m_buffer_used, m_first, m_src_position, and proceeded().

Referenced by Kwave::MultiTrackReader::reset().

 {
     m_src_position = m_first;
     m_buffer_used = 0;
     m_buffer_position = 0;
 
     emit proceeded();
 }

Here is the caller graph for this function:

◆ seek()

void Kwave::SampleReader::seek ( sample_index_t pos )

Seeks to a given position

Definition at line 237 of file SampleReader.cpp.

References m_buffer_position, m_buffer_used, m_last_seek_pos, m_mode, m_src_position, m_stripes, pos(), Kwave::SinglePassReverse, and skip().

Referenced by Kwave::ReversePlugin::reverseSlice(), Kwave::MultiTrackReader::seek(), and Kwave::TrackPixmap::validateBuffer().

 {
     const sample_index_t current_pos = m_src_position +
         m_buffer_position - m_buffer_used;
 
     if (pos == current_pos) return; // nothing to do
 
     if (pos < current_pos) {
         // if we are in SinglePassReverse mode, discard all stripes
         // that we already have passed, up to the end
         if (m_mode == Kwave::SinglePassReverse) {
             while (!m_stripes.isEmpty() &&
                 (m_stripes.last().start() > m_last_seek_pos))
             {
 //              qDebug("SampleReader: removing stripe [%9u ... %9u] (end=%9u)",
 //                      m_stripes.last().start(),
 //                      m_stripes.last().end(),
 //                      m_last_seek_pos);
                 m_stripes.removeLast();
             }
         }
 
         // seek backwards
         const sample_index_t count = current_pos - pos;
         if (count <= m_buffer_position) {
             // go back within the buffer
             m_buffer_position -= count;
         } else {
             // skip out of the buffer
             m_src_position = pos;
             m_buffer_position = m_buffer_used = 0;
         }
     } else {
         // seek forward
         skip(pos - current_pos);
     }
 
     m_last_seek_pos = m_src_position;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ skip()

void Kwave::SampleReader::skip ( sample_index_t count )

Skips a number of samples.

Definition at line 213 of file SampleReader.cpp.

References m_buffer_position, m_buffer_used, m_mode, m_src_position, m_stripes, and Kwave::SinglePassForward.

Referenced by seek(), and Kwave::MultiTrackReader::skip().

 {
     if (m_buffer_position + count < m_buffer_used) {
         // skip within the buffer
         m_buffer_position += count;
     } else {
         // skip out of the buffer
         count -= m_buffer_used;
         m_src_position += count;
         m_buffer_position = m_buffer_used = 0;
     }
 
     // if this reader is of "single pass forward only" type: remove all
     // stripes that we have passed -> there is no way back!
     if (m_mode == Kwave::SinglePassForward) {
         while (!m_stripes.isEmpty() &&
                (m_stripes.first().end() < m_src_position))
         {
             m_stripes.removeFirst();
         }
     }
 }

Here is the caller graph for this function:

Member Data Documentation

◆ m_buffer

Kwave::SampleArray Kwave::SampleReader::m_buffer

private

intermediate buffer for the input data

Definition at line 190 of file SampleReader.h.

Referenced by fillBuffer(), operator>>(), and read().

◆ m_buffer_position

unsigned int Kwave::SampleReader::m_buffer_position

private

read position within the buffer

Definition at line 196 of file SampleReader.h.

Referenced by fillBuffer(), operator>>(), read(), reset(), seek(), and skip().

◆ m_buffer_used

unsigned int Kwave::SampleReader::m_buffer_used

private

number of used elements in the buffer

Definition at line 193 of file SampleReader.h.

Referenced by fillBuffer(), operator>>(), read(), reset(), seek(), and skip().

◆ m_first

sample_index_t Kwave::SampleReader::m_first

private

first sample index

Definition at line 184 of file SampleReader.h.

Referenced by reset().

◆ m_last

sample_index_t Kwave::SampleReader::m_last

private

last sample index

Definition at line 187 of file SampleReader.h.

Referenced by fillBuffer(), and read().

◆ m_last_seek_pos

sample_index_t Kwave::SampleReader::m_last_seek_pos

private

last seek position, needed in SinglePassReverse mode

Definition at line 202 of file SampleReader.h.

Referenced by seek().

◆ m_mode

Kwave::ReaderMode Kwave::SampleReader::m_mode

private

operation mode of the reader, see Kwave::ReaderMode

Definition at line 170 of file SampleReader.h.

Referenced by readSamples(), seek(), and skip().

◆ m_progress_time

QTime Kwave::SampleReader::m_progress_time

private

timer for limiting the number of progress signals per second

Definition at line 199 of file SampleReader.h.

Referenced by fillBuffer(), read(), and SampleReader().

◆ m_src_position

sample_index_t Kwave::SampleReader::m_src_position

private

Current sample position, related to the source of the samples. Does not reflect the position of the next sample to be read out due to internal buffering.

See also: pos() for the output position

Definition at line 181 of file SampleReader.h.

Referenced by fillBuffer(), read(), readSamples(), reset(), seek(), and skip().

◆ m_stripes

QList<Kwave::Stripe> Kwave::SampleReader::m_stripes

private

list of stipes in range

Definition at line 173 of file SampleReader.h.

Referenced by minMax(), readSamples(), seek(), and skip().

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

libkwave/SampleReader.h
libkwave/SampleReader.cpp

Signals

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SampleReader()

◆ ~SampleReader()

Member Function Documentation

◆ done()

◆ eof()

◆ fillBuffer()

◆ first()

◆ goOn()

◆ last()

◆ minMax()

◆ operator>>() [1/2]

◆ operator>>() [2/2]

◆ output

◆ pos()

◆ proceeded

◆ read()

◆ readSamples()

◆ reset()

◆ seek()

◆ skip()

Member Data Documentation

◆ m_buffer

◆ m_buffer_position

◆ m_buffer_used

◆ m_first

◆ m_last

◆ m_last_seek_pos

◆ m_mode

◆ m_progress_time

◆ m_src_position

◆ m_stripes