Record-PulseAudio.cpp File Reference

#include "config.h"
#include <errno.h>
#include <signal.h>
#include <unistd.h>
#include <limits>
#include <pulse/thread-mainloop.h>
#include <QApplication>
#include <QCursor>
#include <QFileInfo>
#include <QLatin1Char>
#include <QLocale>
#include <QString>
#include <QVariant>
#include <QtGlobal>
#include <KLocalizedString>
#include <KUser>
#include "libkwave/Compression.h"
#include "libkwave/SampleFormat.h"
#include "libkwave/String.h"
#include "libkwave/Utils.h"
#include "libkwave/memcpy.h"
#include "Record-PulseAudio.h"

Include dependency graph for Record-PulseAudio.cpp:

Go to the source code of this file.

Macros
#define	ELEMENTS_OF(__array__)   (sizeof(__array__) / sizeof(__array__[0]))
#define	TIMEOUT_WAIT_DEVICE_SCAN   10000
#define	TIMEOUT_CONNECT_TO_SERVER   20000
#define	TIMEOUT_CONNECT_RECORD   10000
#define	TIMEOUT_DISCONNECT_STREAM   10000
#define	DBG_CASE(x)   case x: qDebug("RecordPulseAudio -> " #x ); break
#define	DBG_CASE(x)   case x: qDebug("RecordPulseAudio -> " #x ); break

Functions
static Kwave::SampleFormat::Format	sample_format_of (pa_sample_format_t fmt)
static Kwave::byte_order_t	endian_of (pa_sample_format_t fmt)
static Kwave::Compression::Type	compression_of (pa_sample_format_t fmt)
static int	bits_of (pa_sample_format_t fmt)
static int	poll_func (struct pollfd *ufds, unsigned long nfds, int timeout, void *userdata)

Variables
static const pa_sample_format_t	_known_formats []

Macro Definition Documentation

DBG_CASE [1/2]

#define DBG_CASE

(

x

)

case x: qDebug("RecordPulseAudio -> " #x ); break

Referenced by Kwave::RecordPulseAudio::notifyContext(), and Kwave::RecordPulseAudio::notifyStreamState().

DBG_CASE [2/2]

#define DBG_CASE

(

x

)

case x: qDebug("RecordPulseAudio -> " #x ); break

ELEMENTS_OF

#define ELEMENTS_OF

(

__array__

)

(sizeof(__array__) / sizeof(__array__[0]))

helper macro: returns the number of elements in an array

Definition at line 50 of file Record-PulseAudio.cpp.

Referenced by Kwave::RecordPulseAudio::detectSampleRates(), and Kwave::RecordPulseAudio::detectSupportedFormats().

TIMEOUT_CONNECT_RECORD

#define TIMEOUT_CONNECT_RECORD   10000

timeout to wait for record [ms]

See also

open()

Definition at line 68 of file Record-PulseAudio.cpp.

Referenced by Kwave::RecordPulseAudio::initialize().

TIMEOUT_CONNECT_TO_SERVER

#define TIMEOUT_CONNECT_TO_SERVER   20000

timeout to wait for the connection to the server [ms]

See also

connectToServer()

Definition at line 62 of file Record-PulseAudio.cpp.

Referenced by Kwave::RecordPulseAudio::connectToServer().

TIMEOUT_DISCONNECT_STREAM

#define TIMEOUT_DISCONNECT_STREAM   10000

timeout to wait for disconnecting the recording stream [ms]

See also

close()

Definition at line 74 of file Record-PulseAudio.cpp.

Referenced by Kwave::RecordPulseAudio::close().

TIMEOUT_WAIT_DEVICE_SCAN

#define TIMEOUT_WAIT_DEVICE_SCAN   10000

timeout for the device scan [ms]

See also

scanDevices()

Definition at line 56 of file Record-PulseAudio.cpp.

Referenced by Kwave::RecordPulseAudio::scanDevices().

Function Documentation

bits_of()

static int bits_of ( pa_sample_format_t  fmt )

static

Definition at line 166 of file Record-PulseAudio.cpp.

Referenced by Kwave::RecordPulseAudio::detectSampleFormats(), Kwave::RecordPulseAudio::detectSupportedFormats(), Kwave::RecordPulseAudio::mode2format(), and Kwave::RecordPulseAudio::supportedBits().

{
    int bits = 0;
    switch (fmt) {
        case PA_SAMPLE_ULAW:    /* FALLTHROUGH */
        case PA_SAMPLE_ALAW:    /* FALLTHROUGH */
        case PA_SAMPLE_U8:
            bits = 8;
            break;
        case PA_SAMPLE_S16LE:    /* FALLTHROUGH */
        case PA_SAMPLE_S16BE:
            bits = 16;
            break;
        case PA_SAMPLE_S24LE:    /* FALLTHROUGH */
        case PA_SAMPLE_S24BE:    /* FALLTHROUGH */
        case PA_SAMPLE_S24_32LE: /* FALLTHROUGH */
        case PA_SAMPLE_S24_32BE:
            bits = 24;
            break;
        case PA_SAMPLE_S32LE:     /* FALLTHROUGH */
        case PA_SAMPLE_S32BE:     /* FALLTHROUGH */
        case PA_SAMPLE_FLOAT32LE: /* FALLTHROUGH */
        case PA_SAMPLE_FLOAT32BE:
            bits = 32;
            break;
        default:
            bits = 0;
            break;
    }
    return bits;
}

Here is the caller graph for this function:

compression_of()

static Kwave::Compression::Type compression_of ( pa_sample_format_t  fmt )

static

Definition at line 148 of file Record-PulseAudio.cpp.

References Kwave::Compression::G711_ALAW, Kwave::Compression::G711_ULAW, and Kwave::Compression::NONE.

Referenced by Kwave::RecordPulseAudio::detectCompressions(), Kwave::RecordPulseAudio::detectSampleFormats(), Kwave::RecordPulseAudio::detectSupportedFormats(), Kwave::RecordPulseAudio::mode2format(), and Kwave::RecordPulseAudio::supportedBits().

{
    Kwave::Compression::Type compression = Kwave::Compression::NONE;
    switch (fmt) {
        case PA_SAMPLE_ULAW:
            compression = Kwave::Compression::G711_ULAW;
            break;
        case PA_SAMPLE_ALAW:
            compression = Kwave::Compression::G711_ALAW;
            break;
        default:
            compression = Kwave::Compression::NONE;
            break;
    }
    return compression;
}

Here is the caller graph for this function:

endian_of()

static Kwave::byte_order_t endian_of ( pa_sample_format_t  fmt )

static

find out the endianness of an PulseAudio format

Definition at line 138 of file Record-PulseAudio.cpp.

References Kwave::BigEndian, Kwave::CpuEndian, and Kwave::LittleEndian.

Referenced by Kwave::RecordPulseAudio::detectSupportedFormats(), and Kwave::RecordPulseAudio::endianness().

{
    if (pa_sample_format_is_le(fmt) == 1)
        return Kwave::LittleEndian;
    if (pa_sample_format_is_be(fmt) == 1)
        return Kwave::BigEndian;
    return Kwave::CpuEndian;
}

Here is the caller graph for this function:

poll_func()

static int poll_func ( struct pollfd *  ufds, unsigned long  nfds, int  timeout, void *  userdata  )

static

Definition at line 862 of file Record-PulseAudio.cpp.

References Kwave::RecordPulseAudio::mainloopPoll().

Referenced by Kwave::RecordPulseAudio::connectToServer().

{
    Kwave::RecordPulseAudio *dev =
        static_cast<Kwave::RecordPulseAudio *>(userdata);
    Q_ASSERT(dev);
    if (!dev) return -1;

    return dev->mainloopPoll(ufds, nfds, timeout);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sample_format_of()

static Kwave::SampleFormat::Format sample_format_of ( pa_sample_format_t  fmt )

static

find out the SampleFormat of an PulseAudio format

Definition at line 118 of file Record-PulseAudio.cpp.

References Kwave::SampleFormat::Float, Kwave::SampleFormat::Signed, Kwave::SampleFormat::Unknown, and Kwave::SampleFormat::Unsigned.

Referenced by Kwave::RecordPulseAudio::detectSampleFormats(), Kwave::RecordPulseAudio::detectSupportedFormats(), and Kwave::RecordPulseAudio::mode2format().

{
    Kwave::SampleFormat::Format sampleFormat = Kwave::SampleFormat::Unknown;
    switch (fmt) {
        case PA_SAMPLE_FLOAT32LE: /* FALLTHROUGH */
        case PA_SAMPLE_FLOAT32BE:
            sampleFormat = Kwave::SampleFormat::Float;
            break;
        case PA_SAMPLE_U8:
            sampleFormat = Kwave::SampleFormat::Unsigned;
            break;
        default:
            sampleFormat = Kwave::SampleFormat::Signed;
            break;
    }
    return sampleFormat;
}

Here is the caller graph for this function:

Variable Documentation

_known_formats

const pa_sample_format_t _known_formats[]

static

Initial value:

=
{
    
    PA_SAMPLE_U8,

    
    PA_SAMPLE_S16LE, PA_SAMPLE_S16BE,

    
    PA_SAMPLE_S24LE, PA_SAMPLE_S24BE,

    
    PA_SAMPLE_S24_32LE, PA_SAMPLE_S24_32BE,

    
    PA_SAMPLE_S32LE, PA_SAMPLE_S32BE,

    
    PA_SAMPLE_FLOAT32LE, PA_SAMPLE_FLOAT32BE,

    
    PA_SAMPLE_ULAW,

    
    PA_SAMPLE_ALAW
}

Global list of all known sample formats.

Note

this list should be sorted so that the most preferable formats come first in the list. When searching for a format that matches a given set of parameters, the first entry is taken.

The sort order should be:

• compression: none -> ulaw -> alaw -> adpcm -> mpeg ...
• bits per sample: ascending
• sample format: signed -> unsigned -> float -> double ...
• endianness: cpu -> little -> big
• bytes per sample: ascending

Definition at line 89 of file Record-PulseAudio.cpp.

Referenced by Kwave::RecordPulseAudio::detectSupportedFormats().