xref: /third_party/alsa-lib/include/output.h (revision d5ac70f0)
1/**
2 * \file include/output.h
3 * \brief Application interface library for the ALSA driver
4 * \author Jaroslav Kysela <perex@perex.cz>
5 * \author Abramo Bagnara <abramo@alsa-project.org>
6 * \author Takashi Iwai <tiwai@suse.de>
7 * \date 1998-2001
8 *
9 * Application interface library for the ALSA driver
10 */
11/*
12 *   This library is free software; you can redistribute it and/or modify
13 *   it under the terms of the GNU Lesser General Public License as
14 *   published by the Free Software Foundation; either version 2.1 of
15 *   the License, or (at your option) any later version.
16 *
17 *   This program is distributed in the hope that it will be useful,
18 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
19 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 *   GNU Lesser General Public License for more details.
21 *
22 *   You should have received a copy of the GNU Lesser General Public
23 *   License along with this library; if not, write to the Free Software
24 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
25 *
26 */
27
28#ifndef __ALSA_OUTPUT_H
29#define __ALSA_OUTPUT_H
30
31#include <stdarg.h>
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37/**
38 *  \defgroup Output Output Interface
39 *
40 *  The output functions present an interface similar to the stdio functions
41 *  on top of different underlying output destinations.
42 *
43 *  Many PCM debugging functions (\c snd_pcm_xxx_dump_xxx) use such an output
44 *  handle to be able to write not only to the screen but also to other
45 *  destinations, e.g. to files or to memory buffers.
46 *
47 *  \{
48 */
49
50/**
51 * \brief Internal structure for an output object.
52 *
53 * The ALSA library uses a pointer to this structure as a handle to an
54 * output object. Applications don't access its contents directly.
55 */
56typedef struct _snd_output snd_output_t;
57
58/** Output type. */
59typedef enum _snd_output_type {
60	/** Output to a stdio stream. */
61	SND_OUTPUT_STDIO,
62	/** Output to a memory buffer. */
63	SND_OUTPUT_BUFFER
64} snd_output_type_t;
65
66int snd_output_stdio_open(snd_output_t **outputp, const char *file, const char *mode);
67int snd_output_stdio_attach(snd_output_t **outputp, FILE *fp, int _close);
68int snd_output_buffer_open(snd_output_t **outputp);
69size_t snd_output_buffer_string(snd_output_t *output, char **buf);
70size_t snd_output_buffer_steal(snd_output_t *output, char **buf);
71int snd_output_close(snd_output_t *output);
72int snd_output_printf(snd_output_t *output, const char *format, ...)
73#ifndef DOC_HIDDEN
74	__attribute__ ((format (printf, 2, 3)))
75#endif
76	;
77int snd_output_vprintf(snd_output_t *output, const char *format, va_list args);
78int snd_output_puts(snd_output_t *output, const char *str);
79int snd_output_putc(snd_output_t *output, int c);
80int snd_output_flush(snd_output_t *output);
81
82/** \} */
83
84#ifdef __cplusplus
85}
86#endif
87
88#endif /* __ALSA_OUTPUT_H */
89
90