Format Mask Functions

Overview

See the PCM (digital audio) interface page for more details. More…

// global functions

size_t
snd_pcm_format_mask_sizeof(void);

int
snd_pcm_format_mask_malloc(snd_pcm_format_mask_t** ptr);

void
snd_pcm_format_mask_free(snd_pcm_format_mask_t* obj);

void
snd_pcm_format_mask_copy(
    snd_pcm_format_mask_t* dst,
    const snd_pcm_format_mask_t* src
);

void
snd_pcm_format_mask_none(snd_pcm_format_mask_t* mask);

void
snd_pcm_format_mask_any(snd_pcm_format_mask_t* mask);

int
snd_pcm_format_mask_test(
    const snd_pcm_format_mask_t* mask,
    snd_pcm_format_t val
);

int
snd_pcm_format_mask_empty(const snd_pcm_format_mask_t* mask);

void
snd_pcm_format_mask_set(
    snd_pcm_format_mask_t* mask,
    snd_pcm_format_t val
);

void
snd_pcm_format_mask_reset(
    snd_pcm_format_mask_t* mask,
    snd_pcm_format_t val
);

// macros

#define snd_pcm_format_mask_alloca(ptr)

Detailed Documentation

See the PCM (digital audio) interface page for more details.

Global Functions

size_t
snd_pcm_format_mask_sizeof(void)

get size of snd_pcm_format_mask_t

Returns:

size in bytes

int
snd_pcm_format_mask_malloc(snd_pcm_format_mask_t** ptr)

allocate an empty snd_pcm_format_mask_t using standard malloc

Parameters:

ptr	returned pointer

Returns:

0 on success otherwise negative error code

void
snd_pcm_format_mask_free(snd_pcm_format_mask_t* obj)

frees a previously allocated snd_pcm_format_mask_t

Parameters:

obj	pointer to object to free

void
snd_pcm_format_mask_copy(
    snd_pcm_format_mask_t* dst,
    const snd_pcm_format_mask_t* src
)

copy one snd_pcm_format_mask_t to another

Parameters:

dst	pointer to destination
src	pointer to source

void
snd_pcm_format_mask_none(snd_pcm_format_mask_t* mask)

reset all bits in a snd_pcm_format_mask_t

Parameters:

mask	pointer to mask

void
snd_pcm_format_mask_any(snd_pcm_format_mask_t* mask)

set all bits in a snd_pcm_format_mask_t

Parameters:

mask	pointer to mask

int
snd_pcm_format_mask_test(
    const snd_pcm_format_mask_t* mask,
    snd_pcm_format_t val
)

test the presence of a format in a snd_pcm_format_mask_t

Parameters:

mask	pointer to mask
val	format

int
snd_pcm_format_mask_empty(const snd_pcm_format_mask_t* mask)

test, if given a snd_pcm_format_mask_t is empty

Parameters:

mask	pointer to mask
0	not empty
1	empty

void
snd_pcm_format_mask_set(
    snd_pcm_format_mask_t* mask,
    snd_pcm_format_t val
)

make a format present in a snd_pcm_format_mask_t

Parameters:

mask	pointer to mask
val	format

void
snd_pcm_format_mask_reset(
    snd_pcm_format_mask_t* mask,
    snd_pcm_format_t val
)

make a format missing from a snd_pcm_format_mask_t

Parameters:

mask	pointer to mask
val	format

Macros

#define snd_pcm_format_mask_alloca(ptr)

allocate an empty snd_pcm_format_mask_t using standard alloca

Parameters:

ptr	returned pointer