Kwave::StreamObject Class Reference

#include <StreamObject.h>

Inheritance diagram for Kwave::StreamObject:

Collaboration diagram for Kwave::StreamObject:

Signals
void	attributeChanged (const QVariant value)

Public Member Functions
	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)

Static Public Member Functions
static void	setInteractive (bool interactive)

Private Attributes
QMutex	m_lock_set_attribute

Static Private Attributes
static bool	m_interactive = false

Detailed Description

Definition at line 32 of file StreamObject.h.

Constructor & Destructor Documentation

StreamObject()

Kwave::StreamObject::StreamObject ( QObject *  parent = Q_NULLPTR )

explicit

Constructor

Parameters

parent

a parent object, passed to QObject (optional)

Definition at line 29 of file StreamObject.cpp.

    :QObject(Q_NULLPTR /*parent*/), m_lock_set_attribute(QMutex::Recursive)
{
    Q_UNUSED(parent);
}

~StreamObject()

Kwave::StreamObject::~StreamObject ( )

virtual

Destructor

Definition at line 36 of file StreamObject.cpp.

{
}

Member Function Documentation

attributeChanged

void Kwave::StreamObject::attributeChanged ( const QVariant  value )

signal

Emitted by setAttribute and connected to the corresponding slot.

Referenced by setAttribute().

Here is the caller graph for this function:

blockSize()

unsigned int Kwave::StreamObject::blockSize ( ) const

virtual

Returns the block size used for producing data.

Returns

currently 32k [samples]

Definition at line 65 of file StreamObject.cpp.

References m_interactive.

Referenced by Kwave::FlacEncoder::encode(), Kwave::SampleBuffer::finished(), Kwave::RecordPlugin::flushPrerecordingQueue(), Kwave::NormalizePlugin::getMaxPowerOfTrack(), Kwave::CurveStreamAdapter::goOn(), Kwave::SampleReader::goOn(), Kwave::Mul::multiply(), Kwave::SampleBuffer::put(), Kwave::ReversePlugin::run(), Kwave::PlayBackPlugin::run(), and Kwave::Delay::setDelay().

{
    return (m_interactive) ? 8*1024 : 512*1024;
}

Here is the caller graph for this function:

operator[]()

virtual Kwave::StreamObject* Kwave::StreamObject::operator[] ( unsigned int  track )

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

Parameters

track

index of the track

Returns

a stream object or NULL

Reimplemented in Kwave::MultiTrackSource< SOURCE, INITIALIZE >, Kwave::MultiTrackSource< Kwave::SampleReader, false >, Kwave::MultiTrackSource< SOURCE, false >, Kwave::MultiTrackSink< SINK, INITIALIZE >, Kwave::MultiTrackSink< Kwave::Writer, false >, Kwave::MultiTrackSink< Kwave::PlaybackSink, false >, Kwave::MultiTrackSink< Kwave::SampleBuffer, true >, and Kwave::MultiTrackSink< SINK, false >.

Definition at line 59 of file StreamObject.h.

        {
            return (track == 0) ? this : Q_NULLPTR;
        }

port()

virtual Kwave::StreamObject* Kwave::StreamObject::port ( const char *  port, unsigned int  track  )

inlinevirtual

Returns an indexed port, identified by name

Parameters

port	name of the port (name of signal or slot)
track	index of the track

Returns

the corresponding stream object

Reimplemented in Kwave::ChannelMixer.

Definition at line 84 of file StreamObject.h.

Referenced by Kwave::_connect_one_by_one().

        {
            Q_UNUSED(port);
            return (*this)[track];
        }

Here is the caller graph for this function:

setAttribute()

void Kwave::StreamObject::setAttribute	(	const char *	attribute,
		const QVariant &	value
	)

Sets an attribute of a Kwave::StreamObject.

Parameters

attribute	name of the attribute, with the signature of a Qt SLOT(<name>(QVariant value))
value	the new value of the attribute, stored in a QVariant

Definition at line 41 of file StreamObject.cpp.

References attributeChanged(), Kwave::connect(), m_lock_set_attribute, and tracks().

Referenced by Kwave::MimeData::decode(), Kwave::OpusDecoder::open(), Kwave::SampleRatePlugin::run(), Kwave::PlayBackPlugin::run(), Kwave::OpusEncoder::setupCodingRate(), Kwave::NoisePlugin::updateFilter(), Kwave::BandPassPlugin::updateFilter(), Kwave::PitchShiftPlugin::updateFilter(), Kwave::NotchFilterPlugin::updateFilter(), and Kwave::LowPassPlugin::updateFilter().

{
    QMutexLocker lock(&m_lock_set_attribute);

    for (unsigned int track = 0; track < tracks(); track++) {
        Kwave::StreamObject *obj = (*this)[track];
        if (!obj) continue;

        // temporary establish a signal->slot connection
        QObject::connect(this, SIGNAL(attributeChanged(QVariant)),
                         obj, attribute,
                         Qt::DirectConnection);

        // emit the new value through our own signal
        emit attributeChanged(value);

        // remove the temporary signal->slot connection
        QObject::disconnect(this, SIGNAL(attributeChanged(QVariant)),
                            obj, attribute);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

setInteractive()

void Kwave::StreamObject::setInteractive ( bool  interactive )

static

Switch interactive mode on or off. In interactive mode we use a smaller block size for creating objects to get better response time to parameter changes. In non-interactive mode the block size is higher for better performance.

Definition at line 71 of file StreamObject.cpp.

References m_interactive.

Referenced by Kwave::FilterPlugin::run(), and Kwave::PlayBackPlugin::testPlayBack().

{
    m_interactive = interactive;
}

Here is the caller graph for this function:

tracks()

virtual unsigned int Kwave::StreamObject::tracks ( ) const

inlinevirtual

Returns the default number of tracks that the source provides

Returns

number of tracks, default is 1

Reimplemented in Kwave::MultiTrackSource< SOURCE, INITIALIZE >, Kwave::MultiTrackSource< Kwave::SampleReader, false >, Kwave::MultiTrackSource< SOURCE, false >, Kwave::MultiTrackSink< SINK, INITIALIZE >, Kwave::MultiTrackSink< Kwave::Writer, false >, Kwave::MultiTrackSink< Kwave::PlaybackSink, false >, Kwave::MultiTrackSink< Kwave::SampleBuffer, true >, and Kwave::MultiTrackSink< SINK, false >.

Definition at line 50 of file StreamObject.h.

Referenced by setAttribute().

{ return 1; }

Here is the caller graph for this function:

tracksOfPort()

virtual unsigned int Kwave::StreamObject::tracksOfPort ( const char *  port ) const

inlinevirtual

Returns the number of tracks of a input or output port. Can be overwritten for objects that have a different count of inputs and outputs.

Parameters

port	name of the port (name of signal or slot)

Returns

number of tracks of a input or output, default is the same as tracks()

Reimplemented in Kwave::ChannelMixer.

Definition at line 72 of file StreamObject.h.

Referenced by Kwave::connect().

        {
            Q_UNUSED(port);
            return tracks();
        }

Here is the caller graph for this function:

Member Data Documentation

m_interactive

bool Kwave::StreamObject::m_interactive = false

staticprivate

interactive mode: if enabled, use smaller block size

interactive mode

Definition at line 127 of file StreamObject.h.

Referenced by blockSize(), and setInteractive().

m_lock_set_attribute

QMutex Kwave::StreamObject::m_lock_set_attribute

private

Mutex for locking access to setAttribute (recursive)

Definition at line 124 of file StreamObject.h.

Referenced by setAttribute().

---

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

• libkwave/modules/StreamObject.h
• libkwave/modules/StreamObject.cpp