git.sesse.net Git - ffmpeg/blob - 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 "libavutil/log.h"
  36 #include "libavformat/timefilter.h"
  37 #include "avdevice.h"
  38
  39 /* XXX: we make the assumption that the soundcard accepts this format */
  40 /* XXX: find better solution with "preinit" method, needed also in
  41         other formats */
  42 #define DEFAULT_CODEC_ID AV_NE(CODEC_ID_PCM_S16BE, CODEC_ID_PCM_S16LE)
  43
  44 typedef void (*ff_reorder_func)(const void *, void *, int);
  45
  46 typedef struct {
  47     AVClass *class;
  48     snd_pcm_t *h;
  49     int frame_size;  ///< bytes per sample * channels
  50     int period_size; ///< preferred size for reads and writes, in frames
  51     int sample_rate; ///< sample rate set by user
  52     int channels;    ///< number of channels set by user
  53     TimeFilter *timefilter;
  54     void (*reorder_func)(const void *, void *, int);
  55     void *reorder_buf;
  56     int reorder_buf_size; ///< in frames
  57 } AlsaData;
  58
  59 /**
  60  * Open an ALSA PCM.
  61  *
  62  * @param s media file handle
  63  * @param mode either SND_PCM_STREAM_CAPTURE or SND_PCM_STREAM_PLAYBACK
  64  * @param sample_rate in: requested sample rate;
  65  *                    out: actually selected sample rate
  66  * @param channels number of channels
  67  * @param codec_id in: requested CodecID or CODEC_ID_NONE;
  68  *                 out: actually selected CodecID, changed only if
  69  *                 CODEC_ID_NONE was requested
  70  *
  71  * @return 0 if OK, AVERROR_xxx on error
  72  */
  73 int ff_alsa_open(AVFormatContext *s, snd_pcm_stream_t mode,
  74                  unsigned int *sample_rate,
  75                  int channels, enum CodecID *codec_id);
  76
  77 /**
  78  * Close the ALSA PCM.
  79  *
  80  * @param s1 media file handle
  81  *
  82  * @return 0
  83  */
  84 int ff_alsa_close(AVFormatContext *s1);
  85
  86 /**
  87  * Try to recover from ALSA buffer underrun.
  88  *
  89  * @param s1 media file handle
  90  * @param err error code reported by the previous ALSA call
  91  *
  92  * @return 0 if OK, AVERROR_xxx on error
  93  */
  94 int ff_alsa_xrun_recover(AVFormatContext *s1, int err);
  95
  96 int ff_alsa_extend_reorder_buf(AlsaData *s, int size);
  97
  98 #endif /* AVDEVICE_ALSA_AUDIO_H */