Kwave::SampleEncoderLinear Class Reference

#include <SampleEncoderLinear.h>

Inheritance diagram for Kwave::SampleEncoderLinear:

Collaboration diagram for Kwave::SampleEncoderLinear:

Public Member Functions
	SampleEncoderLinear (Kwave::SampleFormat::Format sample_format, unsigned int bits_per_sample, Kwave::byte_order_t endianness)
virtual	~SampleEncoderLinear () Q_DECL_OVERRIDE
virtual void	encode (const Kwave::SampleArray &samples, unsigned int count, QByteArray &raw_data) Q_DECL_OVERRIDE
virtual unsigned int	rawBytesPerSample () Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::SampleEncoder
	SampleEncoder ()
virtual	~SampleEncoder ()

Private Attributes
unsigned int	m_bytes_per_sample
void(*	m_encoder )(const sample_t *, quint8 *, unsigned int)

Detailed Description

Definition at line 31 of file SampleEncoderLinear.h.

Constructor & Destructor Documentation

SampleEncoderLinear()

Kwave::SampleEncoderLinear::SampleEncoderLinear	(	Kwave::SampleFormat::Format	sample_format,
		unsigned int	bits_per_sample,
		Kwave::byte_order_t	endianness
	)

Constructor

Parameters

sample_format	index of the sample format (signed/unsigned)
bits_per_sample	number of bits per sample in the raw data
endianness	either SOURCE_LITTLE_ENDIAN or SOURCE_BIG_ENDIAN

Definition at line 108 of file SampleEncoderLinear.cpp.

References Kwave::BigEndian, Kwave::CpuEndian, encode_NULL(), Kwave::LittleEndian, m_bytes_per_sample, m_encoder, MAKE_ENCODER, Kwave::SampleFormat::Signed, Kwave::UnknownEndian, and Kwave::SampleFormat::Unsigned.

    :SampleEncoder(),
     m_bytes_per_sample((bits_per_sample + 7) >> 3),
     m_encoder(encode_NULL)
{
    // sanity checks: we support only signed/unsigned and big/little endian
    Q_ASSERT((sample_format == Kwave::SampleFormat::Signed) ||
             (sample_format == Kwave::SampleFormat::Unsigned));
    if ((sample_format != Kwave::SampleFormat::Signed) &&
        (sample_format != Kwave::SampleFormat::Unsigned)) return;

    // allow unknown endianness only with 8 bits
    Q_ASSERT((endianness != Kwave::UnknownEndian) || (m_bytes_per_sample == 1));
    if ( (endianness == Kwave::UnknownEndian) &&
         (m_bytes_per_sample != 1) ) return;

    // map cpu endianness to little or big
#if Q_BYTE_ORDER == Q_BIG_ENDIAN
    if (endianness == Kwave::CpuEndian) endianness = Kwave::BigEndian;
#else
    if (endianness == Kwave::CpuEndian) endianness = Kwave::LittleEndian;
#endif

//     qDebug("SampleEncoderLinear::SampleEncoderLinear(fmt=%s, "
//            "%u bit [%u bytes], endian=%s)",
//            (sample_format == Kwave::SampleFormat::Signed) ?
//             "signed" : "unsigned",
//            bits_per_sample, m_bytes_per_sample,
//            (endianness == Kwave::BigEndian) ? "BE" : "LE");

    switch (bits_per_sample) {
        case 8:
            MAKE_ENCODER(8);
            break;
        case 16:
            MAKE_ENCODER(16);
            break;
        case 18:
            MAKE_ENCODER(18);
            break;
        case 20:
            MAKE_ENCODER(20);
            break;
        case 24:
            MAKE_ENCODER(24);
            break;
        case 32:
            MAKE_ENCODER(32);
            break;
    }

    Q_ASSERT(m_encoder != encode_NULL);
}

Here is the call graph for this function:

~SampleEncoderLinear()

Kwave::SampleEncoderLinear::~SampleEncoderLinear ( )

virtual

Destructor

Definition at line 167 of file SampleEncoderLinear.cpp.

{
}

Member Function Documentation

encode()

void Kwave::SampleEncoderLinear::encode ( const Kwave::SampleArray &  samples, unsigned int  count, QByteArray &  raw_data  )

virtual

Encodes a buffer with samples into a buffer with raw data.

Parameters

samples	array with samples
count	number of samples
raw_data	array with raw encoded audio data

Implements Kwave::SampleEncoder.

Definition at line 172 of file SampleEncoderLinear.cpp.

References Kwave::SampleArray::constData(), m_bytes_per_sample, m_encoder, and Kwave::toUint().

{
    Q_ASSERT(m_encoder);
    if (!m_encoder) return;

    Q_ASSERT(count * m_bytes_per_sample <= Kwave::toUint(raw_data.size()));
    if (count * m_bytes_per_sample > Kwave::toUint(raw_data.size())) return;

    const sample_t *src = samples.constData();
    quint8 *dst = reinterpret_cast<quint8 *>(raw_data.data());

    m_encoder(src, dst, count);
}

Here is the call graph for this function:

rawBytesPerSample()

unsigned int Kwave::SampleEncoderLinear::rawBytesPerSample ( )

virtual

Returns the number of bytes per sample in raw (encoded) form

Implements Kwave::SampleEncoder.

Definition at line 189 of file SampleEncoderLinear.cpp.

References m_bytes_per_sample.

{
    return m_bytes_per_sample;
}

Member Data Documentation

m_bytes_per_sample

unsigned int Kwave::SampleEncoderLinear::m_bytes_per_sample

private

number of bytes per raw sample

Definition at line 64 of file SampleEncoderLinear.h.

Referenced by encode(), rawBytesPerSample(), and SampleEncoderLinear().

m_encoder

void(* Kwave::SampleEncoderLinear::m_encoder) (const sample_t *, quint8 *, unsigned int)

private

optimized function used for encoding the given format

Definition at line 67 of file SampleEncoderLinear.h.

Referenced by encode(), and SampleEncoderLinear().

---

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

• libkwave/SampleEncoderLinear.h
• libkwave/SampleEncoderLinear.cpp