#include <MultiTrackSource.h>

Inheritance diagram for Kwave::MultiTrackSource< SOURCE, INITIALIZE >:

Collaboration diagram for Kwave::MultiTrackSource< SOURCE, INITIALIZE >:

Public Member Functions
	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 SOURCE *	at (unsigned int track) const

virtual SOURCE *	operator[] (unsigned int track) Q_DECL_OVERRIDE

virtual bool	insert (unsigned int track, SOURCE *source)

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)

Private Member Functions
void	runSource (SOURCE *src)

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

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

Detailed Description

template<class SOURCE, const bool INITIALIZE>
class Kwave::MultiTrackSource< SOURCE, INITIALIZE >

Template for easier handling of Kwave::SampleSource objects that consist of multiple independent tracks.

Definition at line 40 of file MultiTrackSource.h.

Constructor & Destructor Documentation

◆ MultiTrackSource()

template<class SOURCE, const bool INITIALIZE>

Kwave::MultiTrackSource< SOURCE, INITIALIZE >::MultiTrackSource	(	unsigned int	tracks,
		QObject *	parent = `Q_NULLPTR`
	)

inline

Default constructor, which does no initialization of the objects themselfes. If you want to use this, you should derive from this class, create all objects manually and "insert" them from the constructor.

Parameters

tracks	number of tracks
parent	a parent object, passed to QObject (optional)

Definition at line 53 of file MultiTrackSource.h.

             :Kwave::SampleSource(parent),
              QList<SOURCE *>()
         {
             Q_UNUSED(tracks);
             Q_ASSERT(INITIALIZE || (tracks == 0));
             Q_ASSERT(QList<SOURCE *>::size() == static_cast<int>(tracks));
         }

◆ ~MultiTrackSource()

template<class SOURCE, const bool INITIALIZE>

virtual Kwave::MultiTrackSource< SOURCE, INITIALIZE >::~MultiTrackSource ( )

inlinevirtual

Destructor

Reimplemented in Kwave::MultiTrackSource< SOURCE, true >.

Definition at line 63 of file MultiTrackSource.h.

         {
             clear();
         }

Member Function Documentation

◆ at()

template<class SOURCE, const bool INITIALIZE>

virtual SOURCE* Kwave::MultiTrackSource< SOURCE, INITIALIZE >::at ( unsigned int track ) const

inlinevirtual

Returns the source that corresponds to one specific track if the object has multiple tracks. For single-track objects it returns "this" for the first index and 0 for all others

Definition at line 110 of file MultiTrackSource.h.

                                                             {
             return QList<SOURCE *>::at(track);
         }

◆ clear()

template<class SOURCE, const bool INITIALIZE>

virtual void Kwave::MultiTrackSource< SOURCE, INITIALIZE >::clear ( )

inlinevirtual

Remove all tracks / sources

Definition at line 134 of file MultiTrackSource.h.

                                     {
             while (!QList<SOURCE *>::isEmpty())
                 delete QList<SOURCE *>::takeLast();
         }

◆ done()

template<class SOURCE, const bool INITIALIZE>

virtual bool Kwave::MultiTrackSource< SOURCE, INITIALIZE >::done ( ) const

inlinevirtual

Returns true when all sources are done

Reimplemented from Kwave::SampleSource.

Definition at line 89 of file MultiTrackSource.h.

Referenced by Kwave::VolumePlugin::run(), Kwave::AmplifyFreePlugin::run(), and Kwave::FilterPlugin::run().

         {
             foreach (SOURCE *src, static_cast< QList<SOURCE *> >(*this))
                 if (src && !src->done()) return false;
             return true;
         }

Here is the caller graph for this function:

◆ goOn()

template<class SOURCE, const bool INITIALIZE>

virtual void Kwave::MultiTrackSource< SOURCE, INITIALIZE >::goOn ( )

inlinevirtual

Calls goOn() for each track.

See also: Kwave::SampleSource::goOn()

Implements Kwave::SampleSource.

Definition at line 72 of file MultiTrackSource.h.

Referenced by Kwave::OpusEncoder::fillInBuffer(), Kwave::SampleRatePlugin::run(), Kwave::VolumePlugin::run(), Kwave::AmplifyFreePlugin::run(), Kwave::NormalizePlugin::run(), Kwave::PlayBackPlugin::run(), and Kwave::FilterPlugin::run().

         {
             QFutureSynchronizer<void> synchronizer;
 
             foreach (SOURCE *src, static_cast< QList<SOURCE *> >(*this)) {
                 if (!src) continue;
                 synchronizer.addFuture(QtConcurrent::run(
                     this,
                     &Kwave::MultiTrackSource<SOURCE, INITIALIZE>::runSource,
                     src)
                 );
             }
 
             synchronizer.waitForFinished();
         }

Here is the caller graph for this function:

◆ insert()

template<class SOURCE, const bool INITIALIZE>

virtual bool Kwave::MultiTrackSource< SOURCE, INITIALIZE >::insert	(	unsigned int	track,
		SOURCE *	source
	)

inlinevirtual

Insert a new track with a source.

Parameters

track	index of the track [0...N-1]
source	pointer to a Kwave::SampleSource

Returns: true if successful, false if failed

Reimplemented in Kwave::MultiTrackReader.

Definition at line 128 of file MultiTrackSource.h.

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

                                                                        {
             QList<SOURCE *>::insert(track, source);
             return (at(track) == source);
         }

Here is the caller graph for this function:

◆ operator[]()

template<class SOURCE, const bool INITIALIZE>

virtual SOURCE* Kwave::MultiTrackSource< SOURCE, INITIALIZE >::operator[] ( unsigned int track )

inlinevirtual

See also: the Kwave::MultiTrackSource.at()...

Reimplemented from Kwave::StreamObject.

Definition at line 115 of file MultiTrackSource.h.

         {
             return at(track);
         }

◆ runSource()

template<class SOURCE, const bool INITIALIZE>

void Kwave::MultiTrackSource< SOURCE, INITIALIZE >::runSource ( SOURCE * src )

inlineprivate

little wrapper for calling goOn() of a source in a worker thread

Definition at line 142 of file MultiTrackSource.h.

                                     {
             src->goOn();
         }

◆ tracks()

template<class SOURCE, const bool INITIALIZE>

virtual unsigned int Kwave::MultiTrackSource< SOURCE, INITIALIZE >::tracks ( ) const

inlinevirtual

Returns the number of tracks that the source provides

Returns: number of tracks

Reimplemented from Kwave::StreamObject.

Definition at line 100 of file MultiTrackSource.h.

Referenced by Kwave::WavEncoder::encode(), Kwave::MimeData::encode(), Kwave::MP3Encoder::encode(), Kwave::Drag::encode(), Kwave::NormalizePlugin::getMaxPower(), Kwave::ReversePlugin::run(), and Kwave::DebugPlugin::run().

         {
             return QList<SOURCE *>::size();
         }

Here is the caller graph for this function:

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

libkwave/MultiTrackSource.h

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

template<class SOURCE, const bool INITIALIZE> class Kwave::MultiTrackSource< SOURCE, INITIALIZE >

Constructor & Destructor Documentation

◆ MultiTrackSource()

◆ ~MultiTrackSource()

Member Function Documentation

◆ at()

◆ clear()

◆ done()

◆ goOn()

◆ insert()

◆ operator[]()

◆ runSource()

◆ tracks()

template<class SOURCE, const bool INITIALIZE>
class Kwave::MultiTrackSource< SOURCE, INITIALIZE >