sample.h

Go to the documentation of this file.

#ifndef foosamplehfoo
#define foosamplehfoo

/***
  This file is part of PulseAudio.

  Copyright 2004-2006 Lennart Poettering
  Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB

  PulseAudio is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2.1 of the License,
  or (at your option) any later version.

  PulseAudio is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
***/

#include <inttypes.h>
#include <sys/types.h>
#include <sys/param.h>

#include <pulse/gccmacro.h>
#include <pulse/cdecl.h>
#include <pulse/version.h>

PA_C_DECL_BEGIN

#if !defined(WORDS_BIGENDIAN)

#if defined(__BYTE_ORDER)
#if __BYTE_ORDER == __BIG_ENDIAN
#define WORDS_BIGENDIAN
#endif
#endif

/* On Sparc, WORDS_BIGENDIAN needs to be set if _BIG_ENDIAN is defined. */
#if defined(__sparc__) && defined(_BIG_ENDIAN)
#define WORDS_BIGENDIAN
#endif

#endif

#define PA_CHANNELS_MAX 32U

#define PA_RATE_MAX (48000U*8U)

typedef enum pa_sample_format {
    PA_SAMPLE_U8,
    PA_SAMPLE_ALAW,
    PA_SAMPLE_ULAW,
    PA_SAMPLE_S16LE,
    PA_SAMPLE_S16BE,
    PA_SAMPLE_FLOAT32LE,
    PA_SAMPLE_FLOAT32BE,
    PA_SAMPLE_S32LE,
    PA_SAMPLE_S32BE,
    PA_SAMPLE_S24LE,
    PA_SAMPLE_S24BE,
    PA_SAMPLE_S24_32LE,
    PA_SAMPLE_S24_32BE,
    PA_SAMPLE_MAX,
    PA_SAMPLE_INVALID = -1
} pa_sample_format_t;

#ifdef WORDS_BIGENDIAN

#define PA_SAMPLE_S16NE PA_SAMPLE_S16BE

#define PA_SAMPLE_FLOAT32NE PA_SAMPLE_FLOAT32BE

#define PA_SAMPLE_S32NE PA_SAMPLE_S32BE

#define PA_SAMPLE_S24NE PA_SAMPLE_S24BE

#define PA_SAMPLE_S24_32NE PA_SAMPLE_S24_32BE

#define PA_SAMPLE_S16RE PA_SAMPLE_S16LE

#define PA_SAMPLE_FLOAT32RE PA_SAMPLE_FLOAT32LE

#define PA_SAMPLE_S32RE PA_SAMPLE_S32LE

#define PA_SAMPLE_S24RE PA_SAMPLE_S24LE

#define PA_SAMPLE_S24_32RE PA_SAMPLE_S24_32LE
#else

#define PA_SAMPLE_S16NE PA_SAMPLE_S16LE

#define PA_SAMPLE_FLOAT32NE PA_SAMPLE_FLOAT32LE

#define PA_SAMPLE_S32NE PA_SAMPLE_S32LE

#define PA_SAMPLE_S24NE PA_SAMPLE_S24LE

#define PA_SAMPLE_S24_32NE PA_SAMPLE_S24_32LE

#define PA_SAMPLE_S16RE PA_SAMPLE_S16BE

#define PA_SAMPLE_FLOAT32RE PA_SAMPLE_FLOAT32BE

#define PA_SAMPLE_S32RE PA_SAMPLE_S32BE

#define PA_SAMPLE_S24RE PA_SAMPLE_S24BE

#define PA_SAMPLE_S24_32RE PA_SAMPLE_S24_32BE
#endif

#define PA_SAMPLE_FLOAT32 PA_SAMPLE_FLOAT32NE

/* Allow clients to check with #ifdef for these sample formats */
#define PA_SAMPLE_U8 PA_SAMPLE_U8
#define PA_SAMPLE_ALAW PA_SAMPLE_ALAW
#define PA_SAMPLE_ULAW PA_SAMPLE_ULAW
#define PA_SAMPLE_S16LE PA_SAMPLE_S16LE
#define PA_SAMPLE_S16BE PA_SAMPLE_S16BE
#define PA_SAMPLE_FLOAT32LE PA_SAMPLE_FLOAT32LE
#define PA_SAMPLE_FLOAT32BE PA_SAMPLE_FLOAT32BE
#define PA_SAMPLE_S32LE PA_SAMPLE_S32LE
#define PA_SAMPLE_S32BE PA_SAMPLE_S32BE
#define PA_SAMPLE_S24LE PA_SAMPLE_S24LE
#define PA_SAMPLE_S24BE PA_SAMPLE_S24BE
#define PA_SAMPLE_S24_32LE PA_SAMPLE_S24_32LE
#define PA_SAMPLE_S24_32BE PA_SAMPLE_S24_32BE

typedef struct pa_sample_spec {
    pa_sample_format_t format;
    uint32_t rate;
    uint8_t channels;
} pa_sample_spec;

typedef uint64_t pa_usec_t;

size_t pa_bytes_per_second(const pa_sample_spec *spec) PA_GCC_PURE;

size_t pa_frame_size(const pa_sample_spec *spec) PA_GCC_PURE;

size_t pa_sample_size(const pa_sample_spec *spec) PA_GCC_PURE;

size_t pa_sample_size_of_format(pa_sample_format_t f) PA_GCC_PURE;

pa_usec_t pa_bytes_to_usec(uint64_t length, const pa_sample_spec *spec) PA_GCC_PURE;

size_t pa_usec_to_bytes(pa_usec_t t, const pa_sample_spec *spec) PA_GCC_PURE;

pa_sample_spec* pa_sample_spec_init(pa_sample_spec *spec);

int pa_sample_format_valid(unsigned format) PA_GCC_PURE;

int pa_sample_rate_valid(uint32_t rate) PA_GCC_PURE;

int pa_channels_valid(uint8_t channels) PA_GCC_PURE;

int pa_sample_spec_valid(const pa_sample_spec *spec) PA_GCC_PURE;

int pa_sample_spec_equal(const pa_sample_spec*a, const pa_sample_spec*b) PA_GCC_PURE;

const char *pa_sample_format_to_string(pa_sample_format_t f) PA_GCC_PURE;

pa_sample_format_t pa_parse_sample_format(const char *format) PA_GCC_PURE;

#define PA_SAMPLE_SPEC_SNPRINT_MAX 32

char* pa_sample_spec_snprint(char *s, size_t l, const pa_sample_spec *spec);

#define PA_BYTES_SNPRINT_MAX 11

char* pa_bytes_snprint(char *s, size_t l, unsigned v);

int pa_sample_format_is_le(pa_sample_format_t f) PA_GCC_PURE;

int pa_sample_format_is_be(pa_sample_format_t f) PA_GCC_PURE;

#ifdef WORDS_BIGENDIAN
#define pa_sample_format_is_ne(f) pa_sample_format_is_be(f)
#define pa_sample_format_is_re(f) pa_sample_format_is_le(f)
#else

#define pa_sample_format_is_ne(f) pa_sample_format_is_le(f)

#define pa_sample_format_is_re(f) pa_sample_format_is_be(f)
#endif

PA_C_DECL_END

#endif