Kwave::MultiTrackReader Class Reference

#include <MultiTrackReader.h>

Inheritance diagram for Kwave::MultiTrackReader:

Collaboration diagram for Kwave::MultiTrackReader:

Public Slots
void	cancel ()
void	reset ()

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

Public Member Functions
	MultiTrackReader (Kwave::ReaderMode mode, Kwave::SignalManager &signal_manager, const QList< unsigned int > &track_list, sample_index_t first, sample_index_t last)
virtual	~MultiTrackReader () Q_DECL_OVERRIDE
virtual sample_index_t	first () const
virtual sample_index_t	last () const
virtual bool	eof () const
virtual bool	isEmpty () const
bool	isCanceled () const
virtual bool	insert (unsigned int track, Kwave::SampleReader *reader) Q_DECL_OVERRIDE
virtual void	skip (sample_index_t count)
virtual void	seek (sample_index_t pos)
Public Member Functions inherited from Kwave::MultiTrackSource< Kwave::SampleReader, false >
	MultiTrackSource (unsigned int tracks, QObject *parent=Q_NULLPTR)
virtual	~MultiTrackSource () Q_DECL_OVERRIDE
virtual void	goOn () Q_DECL_OVERRIDE
virtual bool	done () const Q_DECL_OVERRIDE
virtual unsigned int	tracks () const Q_DECL_OVERRIDE
virtual Kwave::SampleReader *	at (unsigned int track) const
virtual Kwave::SampleReader *	operator[] (unsigned int track) Q_DECL_OVERRIDE
virtual void	clear ()
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	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 Attributes
sample_index_t	m_first
sample_index_t	m_last
bool	m_canceled

Private Slots
void	proceeded ()

Private Member Functions
	MultiTrackReader ()

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

Detailed Description

A MultiTrackReader encapsulates a set of SampleReaders for easier use of multi-track signals.

Definition at line 40 of file MultiTrackReader.h.

Constructor & Destructor Documentation

MultiTrackReader() [1/2]

Kwave::MultiTrackReader::MultiTrackReader ( )

private

Default constructor

Definition at line 26 of file MultiTrackReader.cpp.

:Kwave::MultiTrackSource<Kwave::SampleReader, false>(0, Q_NULLPTR),
     m_first(0), m_last(0), m_canceled(false)
{
}

MultiTrackReader() [2/2]

Kwave::MultiTrackReader::MultiTrackReader	(	Kwave::ReaderMode	mode,
		Kwave::SignalManager &	signal_manager,
		const QList< unsigned int > &	track_list,
		sample_index_t	first,
		sample_index_t	last
	)

Constructor

Parameters

mode	a reader mode, see Kwave::ReaderMode
signal_manager	reference to a SignalManager
track_list	array of indices of tracks for writing
first	index of the first sample (left)
last	index of the last sample (right)

Definition at line 33 of file MultiTrackReader.cpp.

References insert(), Kwave::SignalManager::openReader(), and Kwave::MultiTrackSource< Kwave::SampleReader, false >::tracks().

    :Kwave::MultiTrackSource<Kwave::SampleReader, false>(0),
     m_first(first), m_last(last), m_canceled(false)
{
    unsigned int index = 0;

    foreach(unsigned int track, track_list) {
        Kwave::SampleReader *s = signal_manager.openReader(
            mode, track, first, last);
        if (!s) break;
        insert(index++, s);
        Q_ASSERT(index == tracks());
    }
}

Here is the call graph for this function:

~MultiTrackReader()

Kwave::MultiTrackReader::~MultiTrackReader ( )

virtual

Destructor

Definition at line 53 of file MultiTrackReader.cpp.

References Kwave::MultiTrackSource< Kwave::SampleReader, false >::clear().

{
    clear();
}

Here is the call graph for this function:

Member Function Documentation

cancel

void Kwave::MultiTrackReader::cancel ( )

slot

Can be connected to some progress dialog to cancel the current transfer.

Definition at line 151 of file MultiTrackReader.cpp.

References m_canceled.

{
    m_canceled = true;
}

eof()

bool Kwave::MultiTrackReader::eof ( ) const

virtual

Returns true if one of the readers has reached eof()

Definition at line 71 of file MultiTrackReader.cpp.

References Kwave::MultiTrackSource< Kwave::SampleReader, false >::at(), Kwave::SampleReader::eof(), and Kwave::MultiTrackSource< Kwave::SampleReader, false >::tracks().

Referenced by Kwave::VorbisEncoder::encode(), Kwave::OpusEncoder::fillInBuffer(), Kwave::NormalizePlugin::getMaxPower(), Kwave::SonagramPlugin::makeAllValid(), Kwave::SampleRatePlugin::run(), and Kwave::NormalizePlugin::run().

{
    const unsigned int c = tracks();
    for (unsigned int r = 0; r < c; r++) {
        Kwave::SampleReader *reader = at(r);
        Q_ASSERT(reader);
        if (!reader) continue;
        if (!reader->eof()) return false;
    }
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

first()

sample_index_t Kwave::MultiTrackReader::first ( ) const

virtual

Returns the offset of the reader, as passed to the constructor as "first"

Definition at line 59 of file MultiTrackReader.cpp.

References m_first.

Referenced by Kwave::MimeData::encode(), and Kwave::MP3Encoder::encode().

{
    return m_first;
}

Here is the caller graph for this function:

insert()

bool Kwave::MultiTrackReader::insert ( unsigned int  track, Kwave::SampleReader *  reader  )

virtual

See also

QList::insert()

Reimplemented from Kwave::MultiTrackSource< Kwave::SampleReader, false >.

Definition at line 114 of file MultiTrackReader.cpp.

References Kwave::connect(), Kwave::MultiTrackSource< SOURCE, INITIALIZE >::insert(), and proceeded().

Referenced by MultiTrackReader().

{
    if (reader) {
        connect(
            reader, SIGNAL(proceeded()),
            this, SLOT(proceeded()),
            Qt::DirectConnection
        );
    }
    return Kwave::MultiTrackSource<Kwave::SampleReader, false>::insert(
        track, reader);
}

Here is the call graph for this function:

Here is the caller graph for this function:

isCanceled()

bool Kwave::MultiTrackReader::isCanceled ( ) const

inline

returns true if the transfer has been canceled

Definition at line 89 of file MultiTrackReader.h.

Referenced by Kwave::AsciiEncoder::encode(), Kwave::WavEncoder::encode(), Kwave::MP3Encoder::encode(), Kwave::FlacEncoder::encode(), Kwave::VorbisEncoder::encode(), and Kwave::OpusEncoder::encode().

{ return m_canceled; }

Here is the caller graph for this function:

isEmpty()

virtual bool Kwave::MultiTrackReader::isEmpty ( ) const

inlinevirtual

See also

QList::isEmpty()

Definition at line 83 of file MultiTrackReader.h.

Referenced by Kwave::OverViewCache::getMinMax().

                                            {
            return
                (Kwave::MultiTrackSource<Kwave::SampleReader, false>::tracks() < 1);
        }

Here is the caller graph for this function:

last()

sample_index_t Kwave::MultiTrackReader::last ( ) const

virtual

Returns the last sample offset of the reader, as passed to the constructor as "last"

Definition at line 65 of file MultiTrackReader.cpp.

References m_last.

Referenced by Kwave::MimeData::encode(), and Kwave::MP3Encoder::encode().

{
    return m_last;
}

Here is the caller graph for this function:

proceeded

void Kwave::MultiTrackReader::proceeded ( )

privateslot

Connected to each SampleReader to get informed about their progress.

Definition at line 84 of file MultiTrackReader.cpp.

References Kwave::MultiTrackSource< Kwave::SampleReader, false >::at(), Kwave::SampleReader::first(), Kwave::SampleReader::last(), Kwave::SampleReader::pos(), progress(), and Kwave::MultiTrackSource< Kwave::SampleReader, false >::tracks().

Referenced by insert().

{
    qreal sum = 0;
    qreal total = 0;
    unsigned int track;
    const unsigned int n_tracks = tracks();
    for (track = 0; track < n_tracks; ++track) {
        Kwave::SampleReader *r = at(track);
        if (r) {
            sum   += (r->pos() - r->first());
            total += (r->last() - r->first() + 1);
        }
    }

    emit progress(qreal(100.0) * sum / total);
}

Here is the call graph for this function:

Here is the caller graph for this function:

progress

void Kwave::MultiTrackReader::progress ( qreal  percent )

signal

Emits the current progress in percent [0...100].

Referenced by proceeded(), and reset().

Here is the caller graph for this function:

reset

void Kwave::MultiTrackReader::reset ( )

slot

Resets all readers to zero

Definition at line 102 of file MultiTrackReader.cpp.

References Kwave::MultiTrackSource< Kwave::SampleReader, false >::at(), progress(), Kwave::SampleReader::reset(), and Kwave::MultiTrackSource< Kwave::SampleReader, false >::tracks().

Referenced by Kwave::FilterPlugin::run(), and Kwave::PlaybackController::run_wrapper().

{
    unsigned int track;
    const unsigned int n_tracks = tracks();
    for (track=0; track < n_tracks; ++track) {
        Kwave::SampleReader *r = at(track);
        if (r) r->reset();
    }
    emit progress(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

seek()

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

virtual

Seeks to a given position

Definition at line 140 of file MultiTrackReader.cpp.

References Kwave::MultiTrackSource< Kwave::SampleReader, false >::at(), Kwave::SampleReader::seek(), and Kwave::MultiTrackSource< Kwave::SampleReader, false >::tracks().

Referenced by Kwave::SonagramPlugin::makeAllValid(), and Kwave::PlaybackController::run_wrapper().

{
    unsigned int track;
    const unsigned int n_tracks = tracks();
    for (track=0; track < n_tracks; ++track) {
        Kwave::SampleReader *r = at(track);
        if (r) r->seek(pos);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

skip()

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

virtual

Skips a number of samples.

Definition at line 129 of file MultiTrackReader.cpp.

References Kwave::MultiTrackSource< Kwave::SampleReader, false >::at(), Kwave::SampleReader::skip(), and Kwave::MultiTrackSource< Kwave::SampleReader, false >::tracks().

Referenced by Kwave::PlaybackController::run_wrapper().

{
    unsigned int track;
    const unsigned int n_tracks = tracks();
    for (track=0; track < n_tracks; ++track) {
        Kwave::SampleReader *r = at(track);
        if (r) r->skip(count);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_canceled

bool Kwave::MultiTrackReader::m_canceled

protected

Initialized as false, will be true if the transfer has been canceled

Definition at line 138 of file MultiTrackReader.h.

Referenced by cancel().

m_first

sample_index_t Kwave::MultiTrackReader::m_first

protected

index of the first sample to read

Definition at line 129 of file MultiTrackReader.h.

Referenced by first().

m_last

sample_index_t Kwave::MultiTrackReader::m_last

protected

index of the last sample to read

Definition at line 132 of file MultiTrackReader.h.

Referenced by last().

---

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

• libkwave/MultiTrackReader.h
• libkwave/MultiTrackReader.cpp