write_common.c File Reference

Detailed Description

common functions of para_audiod and para_write

Functions
const struct writer *	writer_get (int wid)
const char *	writer_name (int wid)
int	check_writer_arg_or_die (const char *wa, struct lls_parse_result **lprp)
void	register_writer_node (struct writer_node *wn, struct btr_node *parent, struct sched *s)
void	print_writer_helps (bool detailed)
int	get_btr_sample_rate (struct btr_node *btrn, int32_t *result)
int	get_btr_channels (struct btr_node *btrn, int32_t *result)
int	get_btr_sample_format (struct btr_node *btrn, int32_t *result)

Macros
#define	FOR_EACH_WRITER(i)

Function Documentation

writer_get()

const struct writer* writer_get

(

int

wid

)

Return the writer structure from a writer ID.

Parameters

wid	If non-positive, a pointer to the default writer is returned.

Returns

Pointer to a (constant) struct writer.

Referenced by register_writer_node().

writer_name()

const char* writer_name

(

int

wid

)

Return name of the writer identified by a writer ID.

Parameters

wid	If non-positive, the name of the default writer is returned.

Returns

The returned buffer must not be freed by the caller.

Referenced by register_writer_node().

check_writer_arg_or_die()

int check_writer_arg_or_die	(	const char *	wa,
		struct lls_parse_result **	lprp
	)

Check if the given string is a valid writer argument.

Parameters

wa	String of the form writer_name options.
lprp	Contains the parsed command line on success.

If the argument is NULL, the (configuration-dependent) default writer and no arguments are assumed. Otherwise, the function makes sure that the argument starts with the name of a supported writer and splits the remaining part of the argument. In the second step the thusly obtained arguments are passed to the configuration parser determined in the first step, returning the parse result via the second argument to the function.

Returns

On success, the positive writer ID is returned. Otherwise the function prints an error message and calls exit(3).

register_writer_node()

void register_writer_node	(	struct writer_node *	wn,
		struct btr_node *	parent,
		struct sched *	s
	)

Open a writer node and register the corresponding task.

Parameters

wn	The writer node to open.
parent	The parent btr node (the source for the writer node).
s	The scheduler instance to register the task to.

print_writer_helps()

void print_writer_helps

(

bool

detailed

)

Print the help text of all writers to stdout.

Parameters

detailed

Whether to print the short or the detailed help.

get_btr_sample_rate()

int get_btr_sample_rate	(	struct btr_node *	btrn,
		int32_t *	result
	)

Ask parent buffer tree nodes for the sample rate of the current stream.

Parameters

btrn	Where to start the search.
result	Filled in by this function.

Returns

Standard.

get_btr_channels()

int get_btr_channels	(	struct btr_node *	btrn,
		int32_t *	result
	)

Ask parent buffer tree nodes for the channel count of the current stream.

Parameters

btrn	See get_btr_sample_rate.
result	See get_btr_sample_rate.

Returns

Standard.

get_btr_sample_format()

int get_btr_sample_format	(	struct btr_node *	btrn,
		int32_t *	result
	)

Ask parent nodes for the number of bits per sample and the byte sex.

Parameters

btrn	See get_btr_sample_rate.
result	Contains the sample format as an enum sample_format type.

Returns

Standard.

Macro Definition Documentation

FOR_EACH_WRITER

#define FOR_EACH_WRITER

(

i

)