Kwave::Stripe::MappedArray Class Reference

Inheritance diagram for Kwave::Stripe::MappedArray:

Collaboration diagram for Kwave::Stripe::MappedArray:

Public Member Functions
	MappedArray (Stripe &stripe)
virtual	~MappedArray ()
unsigned int	copy (unsigned int dst, unsigned int src, unsigned int cnt)
unsigned int	read (Kwave::SampleArray &buffer, unsigned int dstoff, unsigned int offset, unsigned int length)
Public Member Functions inherited from Kwave::SampleArray
	SampleArray ()
	SampleArray (unsigned int size)
virtual	~SampleArray ()
const sample_t *	constData () const
sample_t *	data ()
void	setRawData (sample_t *data, unsigned int size)
void	resetRawData ()
void	fill (sample_t value)
sample_t &	operator[] (unsigned int index)
const sample_t &	operator[] (unsigned int index) const
bool	resize (unsigned int size) Q_REQUIRED_RESULT
unsigned int	size () const
bool	isEmpty () const

Private Attributes
Stripe &	m_stripe
sample_t *	m_storage
unsigned int	m_length

Detailed Description

Wrapper for mapping the storage into memory and accessing it like a normal QMemArray<sample_t>. Should be used like a guard, internally uses a MapStorageGuard.

Definition at line 247 of file Stripe.h.

Constructor & Destructor Documentation

MappedArray()

Kwave::Stripe::MappedArray::MappedArray ( Stripe &  stripe )

explicit

Constructor

Parameters

stripe

should be *this of the stripe

Definition at line 32 of file Stripe.cpp.

References m_length, m_storage, m_stripe, Kwave::Stripe::mapStorage(), and Kwave::SampleArray::setRawData().

    :m_stripe(stripe), m_storage(Q_NULLPTR), m_length(stripe.length())
{
    m_storage = m_stripe.mapStorage();
    if (!m_storage) m_length = 0;
    if (m_length) setRawData(m_storage, m_length);
}

Here is the call graph for this function:

~MappedArray()

Kwave::Stripe::MappedArray::~MappedArray ( )

virtual

Destructor

Definition at line 41 of file Stripe.cpp.

References m_length, m_storage, m_stripe, Kwave::SampleArray::resetRawData(), and Kwave::Stripe::unmapStorage().

{
    if (m_length) resetRawData();
    if (m_storage) m_stripe.unmapStorage();
}

Here is the call graph for this function:

Member Function Documentation

copy()

unsigned int Kwave::Stripe::MappedArray::copy	(	unsigned int	dst,
		unsigned int	src,
		unsigned int	cnt
	)

Copy a portion of samples to another location, within the same storage.

Parameters

dst	destination index [samples]
src	source index [samples]
cnt	number of samples

Returns

cnt if succeeded or zero if the mapping has failed

Note

this is optimized for speed, no range checks!

Definition at line 48 of file Stripe.cpp.

References m_length, and m_storage.

Referenced by Kwave::Stripe::deleteRange().

{
//  qDebug("    Stripe::MappedArray::copy(%u, %u, %u)", dst, src, cnt);
    if (!m_length) return 0;

#ifdef STRICTLY_QT
    unsigned int rest = cnt;
    while (rest--) {
        (*this)[dst++] = (*this)[src++];
    }
#else
    sample_t *_samples = m_storage;
    if (!_samples) return 0;
    // no MEMCPY here !
    memmove(&(_samples[dst]), &(_samples[src]), cnt * sizeof(sample_t));
#endif

    return cnt;
}

Here is the caller graph for this function:

read()

unsigned int Kwave::Stripe::MappedArray::read	(	Kwave::SampleArray &	buffer,
		unsigned int	dstoff,
		unsigned int	offset,
		unsigned int	length
	)

Read a portion of samples into an array of samples.

Parameters

buffer	array for samples to be read (destination)
dstoff	offset within the destination buffer
offset	the offset within the stripe (source)
length	number of samples to read

Returns

length if succeeded or zero if the mapping has failed

Warning

this method is intended to be used only internally and lacks any error-checking in order to be fast!

Definition at line 71 of file Stripe.cpp.

References Kwave::Stripe::length(), m_length, m_storage, and MEMCPY.

{
//  qDebug("    Stripe::MappedArray::read(..., %u, %u, %u)", dstoff,
//         offset, length);
    if (!m_length) return 0;

#ifdef STRICTLY_QT
    unsigned int cnt = length;
    while (cnt--) {
        buffer[dstoff++] = (*this)[offset++];
    }
#else
    sample_t *_samples = m_storage;
    if (!_samples) return 0;
    MEMCPY(&(buffer[dstoff]), &(_samples[offset]), length * sizeof(sample_t));

#endif
    return length;
}

Here is the call graph for this function:

Member Data Documentation

m_length

unsigned int Kwave::Stripe::MappedArray::m_length

private

length in samples

Definition at line 295 of file Stripe.h.

Referenced by copy(), MappedArray(), read(), and ~MappedArray().

m_storage

sample_t* Kwave::Stripe::MappedArray::m_storage

private

pointer to the memory used for storage

Definition at line 292 of file Stripe.h.

Referenced by copy(), MappedArray(), read(), and ~MappedArray().

m_stripe

Stripe& Kwave::Stripe::MappedArray::m_stripe

private

stripe which gets it's storage mapped

Definition at line 289 of file Stripe.h.

Referenced by MappedArray(), and ~MappedArray().

---

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

• libkwave/Stripe.h
• libkwave/Stripe.cpp