Kwave::Signal Class Reference

#include <Signal.h>

Inheritance diagram for Kwave::Signal:

Collaboration diagram for Kwave::Signal:

Signals
void	sigTrackInserted (unsigned int index, Kwave::Track *track)
void	sigTrackDeleted (unsigned int index, Kwave::Track *track)
void	sigTrackSelectionChanged (bool enabled)
void	sigSamplesInserted (unsigned int track, sample_index_t offset, sample_index_t length)
void	sigSamplesDeleted (unsigned int track, sample_index_t offset, sample_index_t length)
void	sigSamplesModified (unsigned int track, sample_index_t offset, sample_index_t length)

Public Member Functions
	Signal ()
	Signal (unsigned int tracks, sample_index_t length)
virtual	~Signal ()
void	close ()
Kwave::Track *	insertTrack (unsigned int index, sample_index_t length, QUuid *uuid)
Kwave::Track *	appendTrack (sample_index_t length, QUuid *uuid)
void	deleteTrack (unsigned int index)
QList< unsigned int >	allTracks ()
Kwave::Writer *	openWriter (Kwave::InsertMode mode, unsigned int track, sample_index_t left=0, sample_index_t right=0)
Kwave::SampleReader *	openReader (Kwave::ReaderMode mode, unsigned int track, sample_index_t left=0, sample_index_t right=SAMPLE_INDEX_MAX)
Kwave::Stripe::List	stripes (unsigned int track, sample_index_t left=0, sample_index_t right=SAMPLE_INDEX_MAX)
bool	mergeStripes (const Kwave::Stripe::List &stripes, unsigned int track)
unsigned int	tracks ()
void	deleteRange (unsigned int track, sample_index_t offset, sample_index_t length)
void	insertSpace (unsigned int track, sample_index_t offset, sample_index_t length)
sample_index_t	length ()
bool	trackSelected (unsigned int track)
void	selectTrack (unsigned int track, bool select)
QUuid	uuidOfTrack (unsigned int track)

Private Slots
void	slotSamplesInserted (Kwave::Track *src, sample_index_t offset, sample_index_t length)
void	slotSamplesDeleted (Kwave::Track *src, sample_index_t offset, sample_index_t length)
void	slotSamplesModified (Kwave::Track *src, sample_index_t offset, sample_index_t length)

Private Member Functions
unsigned int	trackIndex (const Kwave::Track *track)

Private Attributes
QList< Kwave::Track * >	m_tracks
QReadWriteLock	m_lock_tracks

Detailed Description

Definition at line 46 of file Signal.h.

Constructor & Destructor Documentation

Signal() [1/2]

Kwave::Signal::Signal

(

)

Default Constructor. Creates an empty signal with zero-length and no tracks

Definition at line 40 of file Signal.cpp.

    :m_tracks(), m_lock_tracks()
{
}

Signal() [2/2]

Kwave::Signal::Signal	(	unsigned int	tracks,
		sample_index_t	length
	)

Constructor. Creates an empty signal with a specified number of tracks and length. Each track will contain only one stripe.

Definition at line 46 of file Signal.cpp.

References appendTrack().

    :m_tracks(), m_lock_tracks()
{
    while (tracks--) {
        appendTrack(length, Q_NULLPTR);
    }
}

Here is the call graph for this function:

~Signal()

Kwave::Signal::~Signal ( )

virtual

Destructor.

Definition at line 55 of file Signal.cpp.

References close().

{
    close();
}

Here is the call graph for this function:

Member Function Documentation

allTracks()

QList< unsigned int > Kwave::Signal::allTracks

(

)

Returns an array of indices of all present tracks.

Definition at line 206 of file Signal.cpp.

References tracks().

Referenced by Kwave::SignalManager::allTracks().

{
    unsigned int track;
    unsigned int tracks = this->tracks();
    QList<unsigned int> list;

    for (track=0; track < tracks; track++) {
        list.append(track);
    }

    return list;
}

Here is the call graph for this function:

Here is the caller graph for this function:

appendTrack()

Kwave::Track * Kwave::Signal::appendTrack	(	sample_index_t	length,
		QUuid *	uuid
	)

Appends a new track to the end of the tracks list, shortcut for insertTrack(tracks()-1, length)

See also

insertTrack

Parameters

length	number of samples of the new track (zero is allowed)
uuid	pointer to a unique ID (optional, can be null)

Definition at line 113 of file Signal.cpp.

References insertTrack(), and tracks().

Referenced by Kwave::SignalManager::insertTrack(), Kwave::SignalManager::loadFile(), Kwave::SignalManager::newSignal(), and Signal().

{
    return insertTrack(tracks(), length, uuid);
}

Here is the call graph for this function:

Here is the caller graph for this function:

close()

void Kwave::Signal::close

(

)

Closes the signal by removing all tracks.

Definition at line 61 of file Signal.cpp.

References deleteTrack(), and tracks().

Referenced by Kwave::SignalManager::close(), Kwave::SignalManager::loadFile(), and ~Signal().

{
    unsigned int count;
    while ((count = tracks()))
        deleteTrack(count - 1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

deleteRange()

void Kwave::Signal::deleteRange	(	unsigned int	track,
		sample_index_t	offset,
		sample_index_t	length
	)

Deletes a range of samples

Parameters

track	index of the track
offset	index of the first sample
length	number of samples

Definition at line 220 of file Signal.cpp.

References Kwave::Track::deleteRange(), m_lock_tracks, m_tracks, and Kwave::toInt().

Referenced by Kwave::SignalManager::deleteRange(), and Kwave::SignalManager::executeCommand().

{
    QReadLocker lock(&m_lock_tracks);

    Q_ASSERT(Kwave::toInt(track) < m_tracks.count());
    if (Kwave::toInt(track) >= m_tracks.count())
        return; // track does not exist !

    Kwave::Track *t = m_tracks.at(track);
    Q_ASSERT(t);
    if (t) t->deleteRange(offset, length);
}

Here is the call graph for this function:

Here is the caller graph for this function:

deleteTrack()

void Kwave::Signal::deleteTrack

(

unsigned int

index

)

Deletes a track.

Parameters

index

the index of the track to be deleted [0...tracks()-1]

Definition at line 119 of file Signal.cpp.

References m_lock_tracks, m_tracks, sigTrackDeleted(), and Kwave::toInt().

Referenced by close(), Kwave::SignalManager::deleteTrack(), and Kwave::UndoInsertTrack::undo().

{
    // remove the track from the list but do not delete it
    Kwave::Track *t = Q_NULLPTR;
    {
        QWriteLocker lock(&m_lock_tracks);
        if (Kwave::toInt(index) > m_tracks.count())
            return; // bail out if not in range

        t = m_tracks.at(index);
        m_tracks.removeAt(index);
    }

    // now emit a signal that the track has been deleted. Maybe
    // someone is still using a reference to it, so we have not
    // deleted it yet - still only unlinked from the track list!
    emit sigTrackDeleted(index, t);

    // as everybody now knows that the track is gone, we can safely
    // delete it now.
    if (t) delete t;
}

Here is the call graph for this function:

Here is the caller graph for this function:

insertSpace()

void Kwave::Signal::insertSpace	(	unsigned int	track,
		sample_index_t	offset,
		sample_index_t	length
	)

Inserts some space at a given position

Parameters

track	index of the track
offset	index of the first sample
length	number of samples

Definition at line 236 of file Signal.cpp.

References Kwave::Track::insertSpace(), m_lock_tracks, m_tracks, and Kwave::toInt().

Referenced by Kwave::SignalManager::insertSpace().

{
    QReadLocker lock(&m_lock_tracks);

    Q_ASSERT(Kwave::toInt(track) < m_tracks.count());
    if (Kwave::toInt(track) >= m_tracks.count())
        return; // track does not exist !

    Kwave::Track *t = m_tracks.at(track);
    Q_ASSERT(t);
    if (t) t->insertSpace(offset, length);
}

Here is the call graph for this function:

Here is the caller graph for this function:

insertTrack()

Kwave::Track * Kwave::Signal::insertTrack	(	unsigned int	index,
		sample_index_t	length,
		QUuid *	uuid
	)

Inserts a new track to into the track list or appends it to the end.

Parameters

index	the position where to insert [0...tracks()]. If the position is at or after the last track, the new track will be appended to the end.
length	number of samples of the new track (zero is allowed)
uuid	pointer to a unique ID (optional, can be null)

Returns

pointer to the created track. If the length is omitted or zero, the track will have zero length.

Definition at line 69 of file Signal.cpp.

References Kwave::connect(), m_lock_tracks, m_tracks, sigSamplesDeleted(), sigSamplesInserted(), sigSamplesModified(), sigTrackInserted(), sigTrackSelectionChanged(), slotSamplesDeleted(), slotSamplesInserted(), slotSamplesModified(), and Kwave::toInt().

Referenced by appendTrack(), Kwave::SignalManager::insertTrack(), and Kwave::UndoDeleteTrack::undo().

{
    Kwave::Track *t = Q_NULLPTR;
    {
        QWriteLocker lock(&m_lock_tracks);

        t = new(std::nothrow) Kwave::Track(length, uuid);
        Q_ASSERT(t);
        if (!t) return Q_NULLPTR;

        // clip the track index
        if (Kwave::toInt(index) > m_tracks.count())
            index = m_tracks.count();

        // insert / append to the list
        m_tracks.insert(index, t);

        // connect to the new track's signals
        connect(t, SIGNAL(sigSamplesDeleted(Kwave::Track *, sample_index_t,
            sample_index_t)),
            this, SLOT(slotSamplesDeleted(Kwave::Track *, sample_index_t,
            sample_index_t)));
        connect(t, SIGNAL(sigSamplesInserted(Kwave::Track *, sample_index_t,
            sample_index_t)),
            this, SLOT(slotSamplesInserted(Kwave::Track *, sample_index_t,
            sample_index_t)));
        connect(t, SIGNAL(sigSamplesModified(Kwave::Track *, sample_index_t,
            sample_index_t)),
            this, SLOT(slotSamplesModified(Kwave::Track *, sample_index_t,
            sample_index_t)));

        connect(t, SIGNAL(sigSelectionChanged(bool)),
            this, SIGNAL(sigTrackSelectionChanged(bool)));
    }

    // track has been inserted
    emit sigTrackInserted(index, t);
    return t;
}

Here is the call graph for this function:

Here is the caller graph for this function:

length()

sample_index_t Kwave::Signal::length

(

)

Returns the length of the signal. This is determined by searching for the highest sample position of all tracks.

Definition at line 258 of file Signal.cpp.

References Kwave::Track::length(), m_lock_tracks, and m_tracks.

Referenced by Kwave::UndoInsertTrack::redoSize(), Kwave::SignalManager::slotSamplesDeleted(), and Kwave::SignalManager::slotSamplesInserted().

{
    QReadLocker lock(&m_lock_tracks);

    sample_index_t max = 0;
    foreach (Kwave::Track *track, m_tracks) {
        if (!track) continue;
        sample_index_t len = track->length();
        if (len > max) max = len;
    }
    return max;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mergeStripes()

bool Kwave::Signal::mergeStripes	(	const Kwave::Stripe::List &	stripes,
		unsigned int	track
	)

Merge a list of stripes into the signal.

Parameters

stripes	list of stripes
track	index of the track

Returns

true if succeeded, false if failed

Definition at line 190 of file Signal.cpp.

References m_lock_tracks, m_tracks, Kwave::Track::mergeStripes(), and Kwave::toInt().

Referenced by Kwave::SignalManager::mergeStripes().

{
    QReadLocker lock(&m_lock_tracks);

    if (Kwave::toInt(track) >= m_tracks.count())
        return false;

    Kwave::Track *t = m_tracks.at(track);
    Q_ASSERT(t);
    if (!t) return false;

    return t->mergeStripes(stripes);
}

Here is the call graph for this function:

Here is the caller graph for this function:

openReader()

Kwave::SampleReader * Kwave::Signal::openReader	(	Kwave::ReaderMode	mode,
		unsigned int	track,
		sample_index_t	left = 0,
		sample_index_t	right = SAMPLE_INDEX_MAX
	)

Opens a stream for reading samples. If the last position is omitted, the value UINT_MAX will be used.

Parameters

mode	a reader mode, see Kwave::ReaderMode
track	index of the track
left	first offset to be read (default = 0)
right	last position to read (default = UINT_MAX)

Returns

a SampleReader or null if the track does not exist

Definition at line 159 of file Signal.cpp.

References m_lock_tracks, m_tracks, Kwave::Track::openReader(), and Kwave::toInt().

{
    QReadLocker lock(&m_lock_tracks);

    if (Kwave::toInt(track) >= m_tracks.count())
        return Q_NULLPTR; // track does not exist !

    Kwave::Track *t = m_tracks.at(track);
    Q_ASSERT(t);
    return (t) ? t->openReader(mode, left, right) : Q_NULLPTR;
}

Here is the call graph for this function:

openWriter()

Kwave::Writer * Kwave::Signal::openWriter	(	Kwave::InsertMode	mode,
		unsigned int	track,
		sample_index_t	left = 0,
		sample_index_t	right = 0
	)

Opens an output stream for a track, starting at a specified sample position.

Parameters

mode	specifies where and how to insert
track	index of the track
left	start of the input (only useful in insert and overwrite mode)
right	end of the input (only useful with overwrite mode)

Returns

a Writer or null pointer if the track does not exist

See also

InsertMode

Definition at line 143 of file Signal.cpp.

References m_lock_tracks, m_tracks, Kwave::Track::openWriter(), and Kwave::toInt().

{
    QReadLocker lock(&m_lock_tracks);

    Q_ASSERT(Kwave::toInt(track) < m_tracks.count());
    if (Kwave::toInt(track) >= m_tracks.count()) {
        return Q_NULLPTR; // track does not exist !
    }

    Kwave::Track *t = m_tracks.at(track);
    Q_ASSERT(t);
    return (t) ? t->openWriter(mode, left, right) : Q_NULLPTR;
}

Here is the call graph for this function:

selectTrack()

void Kwave::Signal::selectTrack	(	unsigned int	track,
		bool	select
	)

Sets the "selected" flag of a track.

Parameters

track	index of the track [0...tracks-1]
select	true if the track should be selected, false for de-selecting

Definition at line 283 of file Signal.cpp.

References m_lock_tracks, m_tracks, and Kwave::toInt().

Referenced by Kwave::SignalManager::selectTrack(), and Kwave::SignalManager::selectTracks().

{
    QReadLocker lock(&m_lock_tracks);

    Q_ASSERT(Kwave::toInt(track) < m_tracks.count());
    if (Kwave::toInt(track) >= m_tracks.count()) return;
    Q_ASSERT(m_tracks.at(track));
    if (!m_tracks.at(track)) return;

    m_tracks.at(track)->select(select);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sigSamplesDeleted

void Kwave::Signal::sigSamplesDeleted ( unsigned int  track, sample_index_t  offset, sample_index_t  length  )

signal

Emitted if samples have been removed from a track.

Parameters

track	index of the track
offset	position from which the data was removed
length	number of samples deleted

Referenced by insertTrack(), and slotSamplesDeleted().

Here is the caller graph for this function:

sigSamplesInserted

void Kwave::Signal::sigSamplesInserted ( unsigned int  track, sample_index_t  offset, sample_index_t  length  )

signal

Emitted if samples have been inserted into a track. This implies a modification of the inserted data, so no extra sigSamplesModified is emitted.

Parameters

track	index of the track
offset	position from which the data was inserted
length	number of samples inserted

See also

sigSamplesModified

Referenced by insertTrack(), and slotSamplesInserted().

Here is the caller graph for this function:

sigSamplesModified

void Kwave::Signal::sigSamplesModified ( unsigned int  track, sample_index_t  offset, sample_index_t  length  )

signal

Emitted if samples within a track have been modified.

Parameters

track	index of the track
offset	position from which the data was modified
length	number of samples modified

Referenced by insertTrack(), and slotSamplesModified().

Here is the caller graph for this function:

sigTrackDeleted

void Kwave::Signal::sigTrackDeleted ( unsigned int  index, Kwave::Track *  track  )

signal

Signals that a track has been deleted.

Parameters

index	position of the deleted track [0...tracks()-1]
track	reference to the deleted track

Referenced by deleteTrack().

Here is the caller graph for this function:

sigTrackInserted

void Kwave::Signal::sigTrackInserted ( unsigned int  index, Kwave::Track *  track  )

signal

Signals that a track has been inserted.

Parameters

index	position of the new track [0...tracks()-1]
track	reference to the new track

Referenced by insertTrack().

Here is the caller graph for this function:

sigTrackSelectionChanged

void Kwave::Signal::sigTrackSelectionChanged ( bool  enabled )

signal

Signals that the selection of one of the tracks has changed

Parameters

enabled

state of the track, true=selected

Referenced by insertTrack().

Here is the caller graph for this function:

slotSamplesDeleted

void Kwave::Signal::slotSamplesDeleted ( Kwave::Track *  src, sample_index_t  offset, sample_index_t  length  )

privateslot

Connected to each track's sigSamplesDeleted.

Parameters

src	source track
offset	position from which the data was removed
length	number of samples deleted

See also

Track::sigSamplesDeleted

Definition at line 585 of file Signal.cpp.

References sigSamplesDeleted(), and trackIndex().

Referenced by insertTrack().

{
    unsigned int track = trackIndex(src);
    emit sigSamplesDeleted(track, offset, length);
}

Here is the call graph for this function:

Here is the caller graph for this function:

slotSamplesInserted

void Kwave::Signal::slotSamplesInserted ( Kwave::Track *  src, sample_index_t  offset, sample_index_t  length  )

privateslot

Connected to each track's sigSamplesInserted.

Parameters

src	source track
offset	position from which the data was inserted
length	number of samples inserted

See also

Track::sigSamplesInserted

Definition at line 576 of file Signal.cpp.

References sigSamplesInserted(), and trackIndex().

Referenced by insertTrack().

{
    unsigned int track = trackIndex(src);
    emit sigSamplesInserted(track, offset, length);
}

Here is the call graph for this function:

Here is the caller graph for this function:

slotSamplesModified

void Kwave::Signal::slotSamplesModified ( Kwave::Track *  src, sample_index_t  offset, sample_index_t  length  )

privateslot

Connected to each track's sigSamplesModified

Parameters

src	source track
offset	position from which the data was modified
length	number of samples modified

See also

Track::sigSamplesModified

Definition at line 594 of file Signal.cpp.

References sigSamplesModified(), and trackIndex().

Referenced by insertTrack().

{
    unsigned int track = trackIndex(src);
    emit sigSamplesModified(track, offset, length);
}

Here is the call graph for this function:

Here is the caller graph for this function:

stripes()

Kwave::Stripe::List Kwave::Signal::stripes	(	unsigned int	track,
		sample_index_t	left = 0,
		sample_index_t	right = SAMPLE_INDEX_MAX
	)

Get a list of stripes that matches a given range of samples

Parameters

track	index of the track
left	offset of the first sample
right	offset of the last sample

Returns

a list of stripes that cover the given range between left and right

Definition at line 175 of file Signal.cpp.

References m_lock_tracks, m_tracks, Kwave::Track::stripes(), and Kwave::toInt().

Referenced by Kwave::SignalManager::stripes().

{
    QReadLocker lock(&m_lock_tracks);

    if (Kwave::toInt(track) < m_tracks.count()) {
        Kwave::Track *t = m_tracks.at(track);
        Q_ASSERT(t);
        if (t) return t->stripes(left, right);
    }
    return Kwave::Stripe::List(); // track does not exist !
}

Here is the call graph for this function:

Here is the caller graph for this function:

trackIndex()

unsigned int Kwave::Signal::trackIndex ( const Kwave::Track *  track )

private

Looks up the index of a track in the track list

Parameters

track

reference to the trac to be looked up

Returns

index of the track [0...tracks()-1] or tracks() if not found

Todo:

needs to be ported to fftw, moved to a plugin and re-activated

Definition at line 567 of file Signal.cpp.

References m_lock_tracks, and m_tracks.

Referenced by slotSamplesDeleted(), slotSamplesInserted(), and slotSamplesModified().

{
    QReadLocker lock(&m_lock_tracks);

    int index = m_tracks.indexOf(const_cast<Kwave::Track *>(track));
    return (index >= 0) ? index : m_tracks.count();
}

Here is the caller graph for this function:

tracks()

unsigned int Kwave::Signal::tracks

(

)

Returns the number of tracks.

Definition at line 251 of file Signal.cpp.

References m_lock_tracks, and m_tracks.

Referenced by allTracks(), appendTrack(), and close().

{
    QReadLocker lock(&m_lock_tracks);
    return m_tracks.count();
}

Here is the caller graph for this function:

trackSelected()

bool Kwave::Signal::trackSelected

(

unsigned int

track

)

Queries if a track is selected. If the index of the track is out of range, the return value will be false.

Definition at line 272 of file Signal.cpp.

References m_lock_tracks, m_tracks, and Kwave::toInt().

Referenced by Kwave::SignalManager::selectedTracks(), Kwave::SignalManager::selectTrack(), and Kwave::SignalManager::selectTracks().

{
    QReadLocker lock(&m_lock_tracks);

    if (Kwave::toInt(track) >= m_tracks.count()) return false;
    if (!m_tracks.at(track)) return false;

    return m_tracks.at(track)->selected();
}

Here is the call graph for this function:

Here is the caller graph for this function:

uuidOfTrack()

QUuid Kwave::Signal::uuidOfTrack

(

unsigned int

track

)

Returns the uuid of a track

Parameters

track

index of the track [0...tracks-1]

Returns

the QUuid of the track or a "null" uuid if the track does not exist

Definition at line 296 of file Signal.cpp.

References m_lock_tracks, m_tracks, and Kwave::toInt().

{
    QReadLocker lock(&m_lock_tracks);

    if (Kwave::toInt(track) >= m_tracks.count()) return QUuid();
    Q_ASSERT(m_tracks.at(track));
    if (!m_tracks.at(track)) return QUuid();

    return m_tracks.at(track)->uuid();
}

Here is the call graph for this function:

Member Data Documentation

m_lock_tracks

QReadWriteLock Kwave::Signal::m_lock_tracks

private

mutex for access to the track list

Definition at line 316 of file Signal.h.

Referenced by deleteRange(), deleteTrack(), insertSpace(), insertTrack(), length(), mergeStripes(), openReader(), openWriter(), selectTrack(), stripes(), trackIndex(), tracks(), trackSelected(), and uuidOfTrack().

m_tracks

QList<Kwave::Track *> Kwave::Signal::m_tracks

private

list of tracks

Definition at line 313 of file Signal.h.

Referenced by deleteRange(), deleteTrack(), insertSpace(), insertTrack(), length(), mergeStripes(), openReader(), openWriter(), selectTrack(), stripes(), trackIndex(), tracks(), trackSelected(), and uuidOfTrack().

---

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

• libkwave/Signal.h
• libkwave/Signal.cpp