Add a flag to disable side data merging.
[ffmpeg.git] / libavdevice / alsa-audio.h
1 /*
2  * ALSA input and output
3  * Copyright (c) 2007 Luca Abeni ( lucabe72 email it )
4  * Copyright (c) 2007 Benoit Fouet ( benoit fouet free fr )
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * ALSA input and output: definitions and structures
26  * @author Luca Abeni ( lucabe72 email it )
27  * @author Benoit Fouet ( benoit fouet free fr )
28  */
29
30 #ifndef AVDEVICE_ALSA_AUDIO_H
31 #define AVDEVICE_ALSA_AUDIO_H
32
33 #include <alsa/asoundlib.h>
34 #include "config.h"
35 #include "libavformat/avformat.h"
36
37 /* XXX: we make the assumption that the soundcard accepts this format */
38 /* XXX: find better solution with "preinit" method, needed also in
39         other formats */
40 #define DEFAULT_CODEC_ID AV_NE(CODEC_ID_PCM_S16BE, CODEC_ID_PCM_S16LE)
41
42 typedef void (*ff_reorder_func)(const void *, void *, int);
43
44 typedef struct {
45     snd_pcm_t *h;
46     int frame_size;  ///< preferred size for reads and writes
47     int period_size; ///< bytes per sample * channels
48     ff_reorder_func reorder_func;
49     void *reorder_buf;
50     int reorder_buf_size; ///< in frames
51 } AlsaData;
52
53 /**
54  * Open an ALSA PCM.
55  *
56  * @param s media file handle
57  * @param mode either SND_PCM_STREAM_CAPTURE or SND_PCM_STREAM_PLAYBACK
58  * @param sample_rate in: requested sample rate;
59  *                    out: actually selected sample rate
60  * @param channels number of channels
61  * @param codec_id in: requested CodecID or CODEC_ID_NONE;
62  *                 out: actually selected CodecID, changed only if
63  *                 CODEC_ID_NONE was requested
64  *
65  * @return 0 if OK, AVERROR_xxx on error
66  */
67 int ff_alsa_open(AVFormatContext *s, snd_pcm_stream_t mode,
68                  unsigned int *sample_rate,
69                  int channels, enum CodecID *codec_id);
70
71 /**
72  * Close the ALSA PCM.
73  *
74  * @param s1 media file handle
75  *
76  * @return 0
77  */
78 int ff_alsa_close(AVFormatContext *s1);
79
80 /**
81  * Try to recover from ALSA buffer underrun.
82  *
83  * @param s1 media file handle
84  * @param err error code reported by the previous ALSA call
85  *
86  * @return 0 if OK, AVERROR_xxx on error
87  */
88 int ff_alsa_xrun_recover(AVFormatContext *s1, int err);
89
90 int ff_alsa_extend_reorder_buf(AlsaData *s, int size);
91
92 #endif /* AVDEVICE_ALSA_AUDIO_H */