Kwave::SelectionTracker Class Reference

#include <SelectionTracker.h>

Inheritance diagram for Kwave::SelectionTracker:

Collaboration diagram for Kwave::SelectionTracker:

Classes
class	Undo

Signals
void	sigTrackInserted (const QUuid &uuid)
void	sigTrackDeleted (const QUuid &uuid)
void	sigOffsetChanged (sample_index_t offset)
void	sigLengthChanged (sample_index_t length)
void	sigInvalidated (const QUuid *track, sample_index_t first, sample_index_t last)

Public Member Functions
	SelectionTracker (Kwave::SignalManager *signal, sample_index_t offset, sample_index_t length, const QList< unsigned int > *tracks)
virtual	~SelectionTracker () Q_DECL_OVERRIDE
QList< QUuid >	allTracks ()
void	selectRange (QList< QUuid > tracks, sample_index_t offset, sample_index_t length)
sample_index_t	offset () const
sample_index_t	length () const
sample_index_t	first () const
sample_index_t	last () const

Protected Member Functions
virtual bool	saveUndoData (Kwave::UndoTransaction &undo) Q_DECL_OVERRIDE

Private Slots
void	slotTrackInserted (unsigned int index, Kwave::Track *track)
void	slotTrackDeleted (unsigned int index, Kwave::Track *track)
void	slotSamplesInserted (unsigned int track, sample_index_t offset, sample_index_t length)
void	slotSamplesDeleted (unsigned int track, sample_index_t offset, sample_index_t length)
void	slotSamplesModified (unsigned int track, sample_index_t offset, sample_index_t length)

Private Attributes
QPointer< Kwave::SignalManager >	m_signal
sample_index_t	m_offset
sample_index_t	m_length
QList< QUuid >	m_tracks
bool	m_selection_only
QMutex	m_lock

Additional Inherited Members
Private Member Functions inherited from Kwave::UndoHandler
	UndoHandler ()
virtual	~UndoHandler ()

Detailed Description

Definition at line 40 of file SelectionTracker.h.

Constructor & Destructor Documentation

SelectionTracker()

Kwave::SelectionTracker::SelectionTracker	(	Kwave::SignalManager *	signal,
		sample_index_t	offset,
		sample_index_t	length,
		const QList< unsigned int > *	tracks
	)

Constructor

Parameters

signal	the signal manager to track
offset	index of the first selected sample
length	number of selected samples
tracks	list of selected tracks or null pointer for "all"

Definition at line 28 of file SelectionTracker.cpp.

References Kwave::connect(), m_selection_only, m_signal, m_tracks, Kwave::UndoManager::registerHandler(), sigTrackDeleted(), sigTrackInserted(), slotSamplesDeleted(), slotSamplesInserted(), slotSamplesModified(), slotTrackDeleted(), slotTrackInserted(), and Kwave::SignalManager::undoManager().

    :m_signal(signal),
     m_offset(offset),
     m_length((length || !signal) ? length : signal->length()),
     m_tracks(),
     m_selection_only((length != 0)),
     m_lock(QMutex::Recursive)
{
    Q_ASSERT(signal);
    if (!signal) return;

    QObject::connect(
        signal, SIGNAL(sigTrackInserted(uint,Kwave::Track*)),
        this,   SLOT(slotTrackInserted(uint,Kwave::Track*)));
    connect(signal, SIGNAL(sigTrackDeleted(uint,Kwave::Track*)),
            this,   SLOT(slotTrackDeleted(uint,Kwave::Track*)));
    connect(
        signal,
        SIGNAL(sigSamplesDeleted(uint,sample_index_t,sample_index_t)),
        this,
        SLOT(slotSamplesDeleted(uint,sample_index_t,sample_index_t))
    );
    connect(
        signal,
        SIGNAL(sigSamplesInserted(uint,sample_index_t,sample_index_t)),
        this,
        SLOT(slotSamplesInserted(uint,sample_index_t,sample_index_t))
    );
    connect(
        signal,
        SIGNAL(sigSamplesModified(uint,sample_index_t,sample_index_t)),
        this,
        SLOT(slotSamplesModified(uint,sample_index_t,sample_index_t))
    );

    // register us at the undo manager
    Kwave::UndoManager &undo = signal->undoManager();
    undo.registerHandler(this);

    if (tracks && !tracks->isEmpty()) {
        // having a list of selected tracks
        foreach (unsigned int track, *tracks) {
            slotTrackInserted(track, Q_NULLPTR);
            if (m_selection_only)
                m_tracks.append(m_signal->uuidOfTrack(track));
        }
    } else {
        // take over all tracks from the signal manager
        foreach (unsigned int track, m_signal->allTracks()) {
            slotTrackInserted(track, Q_NULLPTR);
            if (m_selection_only)
                m_tracks.append(m_signal->uuidOfTrack(track));
        }
    }
}

Here is the call graph for this function:

~SelectionTracker()

Kwave::SelectionTracker::~SelectionTracker ( )

virtual

Destructor

Definition at line 88 of file SelectionTracker.cpp.

References m_signal, and Kwave::UndoManager::unregisterHandler().

{
    // unregister us from the undo manager (if it still exists)
    if (m_signal) {
        Kwave::UndoManager &undo = m_signal->undoManager();
        undo.unregisterHandler(this);
    }
}

Here is the call graph for this function:

Member Function Documentation

allTracks()

QList< QUuid > Kwave::SelectionTracker::allTracks

(

)

Returns all currently selected tracks

Definition at line 98 of file SelectionTracker.cpp.

References m_tracks.

Referenced by Kwave::OverViewCache::getMinMax(), Kwave::SonagramPlugin::makeAllValid(), and Kwave::OverViewCache::OverViewCache().

{
    return m_tracks;
}

Here is the caller graph for this function:

first()

sample_index_t Kwave::SelectionTracker::first ( ) const

inline

Returns the start of the selected range

See also

offset()

Returns

the first sample index

Definition at line 92 of file SelectionTracker.h.

Referenced by Kwave::SonagramPlugin::makeAllValid().

{ return m_offset; }

Here is the caller graph for this function:

last()

sample_index_t Kwave::SelectionTracker::last ( ) const

inline

Returns the end of the selected range

Returns

the last sample index

Definition at line 98 of file SelectionTracker.h.

Referenced by Kwave::OverViewCache::getMinMax(), and Kwave::SonagramPlugin::makeAllValid().

                                    {
            return m_offset + ((m_length) ? (m_length - 1) : 0);
        }

Here is the caller graph for this function:

length()

sample_index_t Kwave::SelectionTracker::length ( ) const

inline

Returns the length of the selected range

Returns

number of selected samples

Definition at line 85 of file SelectionTracker.h.

Referenced by Kwave::OverViewCache::getMinMax(), Kwave::SonagramPlugin::makeAllValid(), Kwave::OverViewCache::scaleDown(), Kwave::OverViewCache::scaleUp(), selectRange(), slotSamplesDeleted(), slotSamplesInserted(), and Kwave::OverViewCache::slotTrackInserted().

{ return m_length; }

Here is the caller graph for this function:

offset()

sample_index_t Kwave::SelectionTracker::offset ( ) const

inline

Returns the start of the selected range

Returns

the first sample index

Definition at line 79 of file SelectionTracker.h.

Referenced by Kwave::OverViewCache::getMinMax(), selectRange(), Kwave::OverViewCache::slotInvalidated(), Kwave::SonagramPlugin::slotInvalidated(), slotSamplesDeleted(), and slotSamplesModified().

{ return m_offset; }

Here is the caller graph for this function:

saveUndoData()

bool Kwave::SelectionTracker::saveUndoData ( Kwave::UndoTransaction &  undo )

protectedvirtual

Called by an undo manager to notify us that it is time to save data for undo.

Parameters

undo	an undo transaction to append some undo data

Return values

true	if successful
false	if saving undo data failed, e.g. out of memory or aborted

Implements Kwave::UndoHandler.

Definition at line 104 of file SelectionTracker.cpp.

References m_selection_only, m_signal, and Kwave::UndoAction::store().

{
    // shortcut: we only have to do something when we are in
    //           "selection only" mode
    if (!m_selection_only)
        return true;

    Q_ASSERT(!m_signal.isNull());
    if (m_signal.isNull())
        return false; // should never happen

    Kwave::UndoAction *action =
        new(std::nothrow) Kwave::SelectionTracker::Undo(this);
    Q_ASSERT(action);
    if (!action) return false;

    if (action->store(*m_signal)) {
        undo.append(action);
    } else {
        // out of memory
        delete action;
        return false;
    }

    return true;
}

Here is the call graph for this function:

selectRange()

void Kwave::SelectionTracker::selectRange	(	QList< QUuid >	tracks,
		sample_index_t	offset,
		sample_index_t	length
	)

changes the selected range covered by the cache

used during undo/redo

Parameters

tracks	list of selected tracks
offset	index of the first selected sample
length	number of selected samples

Definition at line 321 of file SelectionTracker.cpp.

References length(), m_length, m_lock, m_offset, m_selection_only, m_signal, m_tracks, offset(), SAMPLE_INDEX_MAX, sigInvalidated(), sigLengthChanged(), sigOffsetChanged(), sigTrackDeleted(), and sigTrackInserted().

{
    QMutexLocker lock(&m_lock);

    // remove deleted tracks
    foreach (const QUuid &uuid, m_tracks) {
        if (!tracks.contains(uuid)) {
            m_tracks.removeAll(uuid);
            emit sigTrackDeleted(uuid);
        }
    }

    // add new tracks
    foreach (const QUuid &uuid, tracks) {
        if (!m_tracks.contains(uuid)) {
            m_tracks.append(uuid);
            emit sigTrackInserted(uuid);
        }
    }

    // track signal length changes when tracks were inserted
    if (!m_selection_only) {
        sample_index_t new_len = m_signal->length();
        if (m_length != new_len) {
            m_length = new_len;
            emit sigLengthChanged(m_length);
        }

        return; // nothing more to do in this mode
    }

    if ((offset == m_offset) && (length == m_length))
        return; // no change, nothing to do

    if (!length)
        return; // makes no sense

    // remember the old settings
    const sample_index_t old_ofs = m_offset;
    const sample_index_t old_len = m_length;

    // take over the new selection
    if (m_length != length) {
        m_length = length;
        emit sigLengthChanged(m_length);
    }
    if (offset != old_ofs) {
        // offset has changed -> invalidate all
        m_offset = offset;
        emit sigOffsetChanged(m_offset);
        emit sigInvalidated(Q_NULLPTR, m_offset, SAMPLE_INDEX_MAX);
    } else if (length > old_len) {
        // length has changed and increased -> invalidate new area
        emit sigInvalidated(Q_NULLPTR, m_offset + old_len - 1, SAMPLE_INDEX_MAX);
    } else if (length < old_len) {
        // length was reduced -> invalidate shrinked area at end
        emit sigInvalidated(Q_NULLPTR, m_offset + length - 1, SAMPLE_INDEX_MAX);
    }
}

Here is the call graph for this function:

sigInvalidated

void Kwave::SelectionTracker::sigInvalidated ( const QUuid *  track, sample_index_t  first, sample_index_t  last  )

signal

signals that a range of samples has become invalid

Parameters

track	UUID of the track or null for "all tracks"
first	index of the first invalidated sample
last	index of the last invalidated sample

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

Here is the caller graph for this function:

sigLengthChanged

void Kwave::SelectionTracker::sigLengthChanged ( sample_index_t  length )

signal

signals that the length of the selection has changed

Parameters

length

new length of the selection [samples]

Referenced by selectRange(), slotSamplesDeleted(), slotSamplesInserted(), slotTrackDeleted(), and slotTrackInserted().

Here is the caller graph for this function:

sigOffsetChanged

void Kwave::SelectionTracker::sigOffsetChanged ( sample_index_t  offset )

signal

signals that the offset of the selection has changed

Parameters

offset

new index of the selected area [samples]

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

Here is the caller graph for this function:

sigTrackDeleted

void Kwave::SelectionTracker::sigTrackDeleted ( const QUuid &  uuid )

signal

Signals that a track has been deleted.

Parameters

uuid	unique ID of the track

Referenced by SelectionTracker(), selectRange(), and slotTrackDeleted().

Here is the caller graph for this function:

sigTrackInserted

void Kwave::SelectionTracker::sigTrackInserted ( const QUuid &  uuid )

signal

Signals that a track has been inserted.

Parameters

uuid	unique ID of the track

Referenced by SelectionTracker(), selectRange(), and slotTrackInserted().

Here is the caller graph for this function:

slotSamplesDeleted

void Kwave::SelectionTracker::slotSamplesDeleted ( unsigned int  track, sample_index_t  offset, sample_index_t  length  )

privateslot

Connected to the signal's sigSamplesDeleted.

Parameters

track	index of the source track [0...tracks-1]
offset	position from which the data was removed
length	number of samples deleted

See also

Signal::sigSamplesDeleted

Definition at line 233 of file SelectionTracker.cpp.

References length(), m_length, m_lock, m_offset, m_signal, m_tracks, offset(), SAMPLE_INDEX_MAX, sigInvalidated(), sigLengthChanged(), and sigOffsetChanged().

Referenced by SelectionTracker().

{
    QMutexLocker lock(&m_lock);

    Q_ASSERT(!m_signal.isNull());
    if (m_signal.isNull()) return;

    const QUuid uuid = m_signal->uuidOfTrack(track);
    if (!m_tracks.contains(uuid))
        return; // track not selected

    if (!length)
        return; // nothing to do

    if (offset >= (m_offset + m_length))
        return; // right of us

    // NOTE: adjust offsets/lengths only for the first selected track
    const bool is_first = (uuid == m_tracks.first());

    if ((offset + length - 1) < m_offset) {
        // left of us, no overlap
        if (is_first) {
            m_offset -= length;
            emit sigOffsetChanged(m_offset);
        }
        return;
    }

    // determine shift and number of deleted samples
    sample_index_t first_del = offset;
    sample_index_t last_del  = offset + length - 1;
    sample_index_t shift = (first_del < m_offset) ? (m_offset - first_del) : 0;
    sample_index_t left  = qMax(first_del, m_offset);
    sample_index_t right = qMin(last_del,  m_offset + m_length - 1);
    sample_index_t deleted_samples = right - left + 1;

    // adjust the start of the selection
    if (is_first && shift) {
        m_offset -= shift;
        left      = m_offset;
        emit sigOffsetChanged(m_offset);
    }

    // adjust the length of the selection
    if (is_first && deleted_samples) {
        m_length -= deleted_samples;
        emit sigLengthChanged(m_length);
    }

    // in our range -> invalidate all samples from offset to end of file
    emit sigInvalidated(&uuid, left, SAMPLE_INDEX_MAX);
}

Here is the call graph for this function:

Here is the caller graph for this function:

slotSamplesInserted

void Kwave::SelectionTracker::slotSamplesInserted ( unsigned int  track, sample_index_t  offset, sample_index_t  length  )

privateslot

Connected to the signal's sigSamplesInserted.

Parameters

track	index of the source track [0...tracks-1]
offset	position from which the data was inserted
length	number of samples inserted

See also

Signal::sigSamplesInserted

Definition at line 189 of file SelectionTracker.cpp.

References length(), m_length, m_lock, m_offset, m_selection_only, m_signal, m_tracks, SAMPLE_INDEX_MAX, sigInvalidated(), sigLengthChanged(), and sigOffsetChanged().

Referenced by SelectionTracker().

{
    QMutexLocker lock(&m_lock);

    Q_ASSERT(!m_signal.isNull());
    if (m_signal.isNull()) return;

    const QUuid uuid = m_signal->uuidOfTrack(track);
    if (!m_tracks.contains(uuid))
        return; // track not selected

    if (!length)
        return; // nothing to do

    // NOTE: adjust offsets/lengths only for the first selected track
    const bool is_first = (uuid == m_tracks.first());

    if (m_selection_only) {
        if (offset >= (m_offset + m_length))
            return; // right of us

        if (offset < m_offset) {
            // left of us, no overlap
            if (is_first) {
                m_offset += length;
                emit sigOffsetChanged(m_offset);
            }
            return;
        }
    }

    // in our range -> increase length and invalidate all
    // samples from offset to end of file
    if (is_first) {
        m_length += length;
        emit sigLengthChanged(m_length);
    }

    emit sigInvalidated(&uuid, offset, SAMPLE_INDEX_MAX);
}

Here is the call graph for this function:

Here is the caller graph for this function:

slotSamplesModified

void Kwave::SelectionTracker::slotSamplesModified ( unsigned int  track, sample_index_t  offset, sample_index_t  length  )

privateslot

Connected to the signal's sigSamplesModified

Parameters

track	index of the source track [0...tracks-1]
offset	position from which the data was modified
length	number of samples modified

See also

Signal::sigSamplesModified

Definition at line 290 of file SelectionTracker.cpp.

References m_length, m_lock, m_offset, m_signal, m_tracks, offset(), and sigInvalidated().

Referenced by SelectionTracker().

{
    QMutexLocker lock(&m_lock);

    if (!length) return; // nothing to do

    Q_ASSERT(!m_signal.isNull());
    if (m_signal.isNull()) return;

    const QUuid uuid = m_signal->uuidOfTrack(track);
    if (!m_tracks.contains(uuid))
        return; // track not selected

    if (offset >= (m_offset + m_length))
        return; // right out of our range -> out of interest

    if (offset + length < m_offset)
        return; // completely left from us -> out of interest

    // overlapping
    sample_index_t first_mod = offset;
    sample_index_t last_mod  = offset + length - 1;
    sample_index_t left  = qMax(first_mod, m_offset);
    sample_index_t right = qMin(last_mod,  m_offset + m_length - 1);

    emit sigInvalidated(&uuid, left, right);
}

Here is the call graph for this function:

Here is the caller graph for this function:

slotTrackDeleted

void Kwave::SelectionTracker::slotTrackDeleted ( unsigned int  index, Kwave::Track *  track  )

privateslot

Connected to the signal's sigTrackInserted.

Parameters

index	the index of the inserted track
track	pointer to the track instance

See also

Signal::sigTrackDeleted

Definition at line 159 of file SelectionTracker.cpp.

References m_length, m_lock, m_selection_only, m_signal, m_tracks, sigLengthChanged(), sigTrackDeleted(), and Kwave::Track::uuid().

Referenced by SelectionTracker().

{
    QMutexLocker lock(&m_lock);

    Q_UNUSED(index);

    Q_ASSERT(track);
    if (!track) return;

    const QUuid &uuid = track->uuid();
    Q_ASSERT(!uuid.isNull());
    if (!m_tracks.contains(uuid))
        return; // track not selected

    // track signal length changes when tracks were inserted
    if (!m_selection_only) {
        sample_index_t new_len = m_signal->length();
        if (m_length != new_len) {
            m_length = new_len;
            emit sigLengthChanged(m_length);
        }
    }

    // one of our selected tracks was deleted
    m_tracks.removeAll(uuid);
    emit sigTrackDeleted(uuid);
}

Here is the call graph for this function:

Here is the caller graph for this function:

slotTrackInserted

void Kwave::SelectionTracker::slotTrackInserted ( unsigned int  index, Kwave::Track *  track  )

privateslot

Connected to the signal's sigTrackInserted.

Parameters

index	the index [0...tracks()-1] of the inserted track
track	pointer to the track instance

See also

Signal::sigTrackInserted

Definition at line 132 of file SelectionTracker.cpp.

References m_length, m_lock, m_selection_only, m_signal, m_tracks, sigLengthChanged(), sigTrackInserted(), and Kwave::Track::uuid().

Referenced by SelectionTracker().

{
    QMutexLocker lock(&m_lock);

    if (m_selection_only)
        return; // in "selection only" mode we are not interested in this

    Q_ASSERT(track || !m_signal.isNull());
    if (!track && m_signal.isNull()) return;

    const QUuid &uuid = (track) ? track->uuid() : m_signal->uuidOfTrack(index);
    Q_ASSERT(!uuid.isNull());

    // track signal length changes when tracks were inserted
    sample_index_t new_len = m_signal->length();
    if (m_length != new_len) {
        m_length = new_len;
        emit sigLengthChanged(m_length);
    }

    // a new track has been inserted
    m_tracks.append(uuid);
    emit sigTrackInserted(uuid);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_length

sample_index_t Kwave::SelectionTracker::m_length

private

length of the source in samples, or zero for "whole signal"

Definition at line 301 of file SelectionTracker.h.

Referenced by selectRange(), slotSamplesDeleted(), slotSamplesInserted(), slotSamplesModified(), slotTrackDeleted(), and slotTrackInserted().

m_lock

QMutex Kwave::SelectionTracker::m_lock

private

mutex for threadsafe access to the selection

Definition at line 310 of file SelectionTracker.h.

Referenced by selectRange(), slotSamplesDeleted(), slotSamplesInserted(), slotSamplesModified(), slotTrackDeleted(), and slotTrackInserted().

m_offset

sample_index_t Kwave::SelectionTracker::m_offset

private

first sample index in the source

Definition at line 298 of file SelectionTracker.h.

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

m_selection_only

bool Kwave::SelectionTracker::m_selection_only

private

if true, track the selection only, otherwise the whole signal

Definition at line 307 of file SelectionTracker.h.

Referenced by saveUndoData(), SelectionTracker(), selectRange(), slotSamplesInserted(), slotTrackDeleted(), and slotTrackInserted().

m_signal

QPointer<Kwave::SignalManager> Kwave::SelectionTracker::m_signal

private

signal with the data to be shown

Definition at line 295 of file SelectionTracker.h.

Referenced by saveUndoData(), SelectionTracker(), selectRange(), slotSamplesDeleted(), slotSamplesInserted(), slotSamplesModified(), slotTrackDeleted(), slotTrackInserted(), and ~SelectionTracker().

m_tracks

QList<QUuid> Kwave::SelectionTracker::m_tracks

private

list of currently selected source tracks

Definition at line 304 of file SelectionTracker.h.

Referenced by allTracks(), SelectionTracker(), selectRange(), slotSamplesDeleted(), slotSamplesInserted(), slotSamplesModified(), slotTrackDeleted(), and slotTrackInserted().

---

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

• libgui/SelectionTracker.h
• libgui/SelectionTracker.cpp