Kwave::Stripe::StripeStorage Class Reference

Inheritance diagram for Kwave::Stripe::StripeStorage:

Collaboration diagram for Kwave::Stripe::StripeStorage:

Public Member Functions
	StripeStorage ()
	StripeStorage (const StripeStorage &other)
virtual	~StripeStorage ()
sample_t *	map ()
void	unmap ()
int	mapCount () const

Public Attributes
sample_index_t	m_start
unsigned int	m_length
Kwave::Handle	m_storage

Private Attributes
QMutex	m_lock
int	m_map_count
sample_t *	m_mapped_storage

Detailed Description

Definition at line 308 of file Stripe.h.

Constructor & Destructor Documentation

StripeStorage() [1/2]

Kwave::Stripe::StripeStorage::StripeStorage

(

)

default constructor

Definition at line 94 of file Stripe.cpp.

    :QSharedData(), m_start(0), m_length(0), m_storage(0), m_lock(),
     m_map_count(0), m_mapped_storage(Q_NULLPTR)
{
}

StripeStorage() [2/2]

Kwave::Stripe::StripeStorage::StripeStorage

(

const StripeStorage &

other

)

copy constructor

Definition at line 101 of file Stripe.cpp.

References Kwave::MemoryManager::allocate(), Kwave::MemoryManager::instance(), m_length, m_storage, Kwave::MemoryManager::map(), Kwave::Stripe::read(), Kwave::MemoryManager::readFrom(), Kwave::toUint(), Kwave::MemoryManager::unmap(), and Kwave::MemoryManager::writeTo().

    :QSharedData(other), m_start(other.m_start), m_length(other.m_length),
     m_storage(0), m_lock(), m_map_count(0), m_mapped_storage(Q_NULLPTR)
{
//     qDebug("StripeStorage(%p) - DEEP COPY %u,%u from %p",
//      static_cast<void *>(this),
//      m_start, m_length,
//      static_cast<const void *>(&other)
//     );

    if (other.m_storage) {
        // allocate memory for the copy
        Kwave::MemoryManager &mem = Kwave::MemoryManager::instance();
        m_storage = mem.allocate(m_length * sizeof(sample_t));
        if (!m_storage) {
            // allocation failed
            qWarning("StripeStorage: DEEP COPY (%u) FAILED - OOM!", m_length);
            m_length = 0;
            return;
        }

        // copy the data from the original
        Q_ASSERT(m_storage);
        void *original = mem.map(other.m_storage);
        if (original) {
            mem.writeTo(m_storage, 0, original, m_length * sizeof(sample_t));
            mem.unmap(other.m_storage);
        } else {
            qWarning("StripeStorage: DEEP COPY (%u) MMAP FAILED - "
                     "FALLING BACK TO SLOW COPY!", m_length);
            // fall back to slow copy algorithm
            char buf[256]; // use a small buffer on the stack
            unsigned int remaining = m_length;
            unsigned int ofs       = 0;

            while (remaining) {
                unsigned int len =  qMin(remaining, Kwave::toUint(sizeof(buf)));
                unsigned int read = mem.readFrom(other.m_storage, ofs,
                                                 &buf[0], len);
                Q_ASSERT(read == len);
                if (read != len) break;
                unsigned int written = mem.writeTo(m_storage, ofs,
                                                   &buf[0], len);
                Q_ASSERT(written == len);
                if (written != len) break;
                remaining -= len;
                ofs       += len;
            }
            if (remaining) {
                qWarning("StripeStorage: DEEP COPY (%u) FAILED - DATA LOST!",
                         m_length);
            }
        }
    }
}

Here is the call graph for this function:

~StripeStorage()

Kwave::Stripe::StripeStorage::~StripeStorage ( )

virtual

destructor

Definition at line 192 of file Stripe.cpp.

References Kwave::MemoryManager::free(), Kwave::MemoryManager::instance(), m_map_count, m_mapped_storage, and m_storage.

{
    Q_ASSERT(!m_map_count);
    Q_ASSERT(!m_mapped_storage);
    if (m_storage) {
        Kwave::MemoryManager &mem = Kwave::MemoryManager::instance();
        mem.free(m_storage);
    }
}

Here is the call graph for this function:

Member Function Documentation

map()

sample_t * Kwave::Stripe::StripeStorage::map

(

)

maps the storage into memory

Definition at line 158 of file Stripe.cpp.

References Kwave::MemoryManager::instance(), m_lock, m_map_count, m_mapped_storage, m_storage, and Kwave::MemoryManager::map().

{
    QMutexLocker lock(&m_lock);

    if (!m_storage) return Q_NULLPTR;

    if (!m_map_count) {
        Kwave::MemoryManager &mem = Kwave::MemoryManager::instance();
        m_mapped_storage = reinterpret_cast<sample_t *>(
            mem.map(m_storage));
    }

    if (m_mapped_storage) m_map_count++;

    return m_mapped_storage;
}

Here is the call graph for this function:

mapCount()

int Kwave::Stripe::StripeStorage::mapCount ( ) const

inline

returns the map count

Definition at line 327 of file Stripe.h.

{ return m_map_count; }

unmap()

void Kwave::Stripe::StripeStorage::unmap

(

)

unmaps the storage from memory

Definition at line 176 of file Stripe.cpp.

References Kwave::MemoryManager::instance(), m_lock, m_map_count, m_mapped_storage, m_storage, and Kwave::MemoryManager::unmap().

{
    QMutexLocker lock(&m_lock);

    Q_ASSERT(m_map_count);
    if (!m_map_count) return;

    m_map_count--;
    if (!m_map_count) {
        Kwave::MemoryManager &mem = Kwave::MemoryManager::instance();
        mem.unmap(m_storage);
        m_mapped_storage = Q_NULLPTR;
    }
}

Here is the call graph for this function:

Member Data Documentation

m_length

unsigned int Kwave::Stripe::StripeStorage::m_length

number of samples

Definition at line 335 of file Stripe.h.

Referenced by StripeStorage().

m_lock

QMutex Kwave::Stripe::StripeStorage::m_lock

private

mutex for locking map/unmap

Definition at line 343 of file Stripe.h.

Referenced by map(), and unmap().

m_map_count

int Kwave::Stripe::StripeStorage::m_map_count

private

usage count of mapped storage

Definition at line 346 of file Stripe.h.

Referenced by map(), unmap(), and ~StripeStorage().

m_mapped_storage

sample_t* Kwave::Stripe::StripeStorage::m_mapped_storage

private

mapped storage

Definition at line 349 of file Stripe.h.

Referenced by map(), unmap(), and ~StripeStorage().

m_start

sample_index_t Kwave::Stripe::StripeStorage::m_start

start position within the track

Definition at line 332 of file Stripe.h.

m_storage

Kwave::Handle Kwave::Stripe::StripeStorage::m_storage

pointer/handle to a storage object

Definition at line 338 of file Stripe.h.

Referenced by map(), StripeStorage(), unmap(), and ~StripeStorage().

---

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

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