3 * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 #ifndef AVUTIL_AUDIO_FIFO_H
28 #define AVUTIL_AUDIO_FIFO_H
32 #include "samplefmt.h"
35 * @addtogroup lavu_audio
38 * @defgroup lavu_audiofifo Audio FIFO Buffer
43 * Context for an Audio FIFO Buffer.
45 * - Operates at the sample level rather than the byte level.
46 * - Supports multiple channels with either planar or packed sample format.
47 * - Automatic reallocation when writing to a full buffer.
49 typedef struct AVAudioFifo AVAudioFifo;
52 * Free an AVAudioFifo.
54 * @param af AVAudioFifo to free
56 void av_audio_fifo_free(AVAudioFifo *af);
59 * Allocate an AVAudioFifo.
61 * @param sample_fmt sample format
62 * @param channels number of channels
63 * @param nb_samples initial allocation size, in samples
64 * @return newly allocated AVAudioFifo, or NULL on error
66 AVAudioFifo *av_audio_fifo_alloc(enum AVSampleFormat sample_fmt, int channels,
70 * Reallocate an AVAudioFifo.
72 * @param af AVAudioFifo to reallocate
73 * @param nb_samples new allocation size, in samples
74 * @return 0 if OK, or negative AVERROR code on failure
76 int av_audio_fifo_realloc(AVAudioFifo *af, int nb_samples);
79 * Write data to an AVAudioFifo.
81 * The AVAudioFifo will be reallocated automatically if the available space
82 * is less than nb_samples.
84 * @see enum AVSampleFormat
85 * The documentation for AVSampleFormat describes the data layout.
87 * @param af AVAudioFifo to write to
88 * @param data audio data plane pointers
89 * @param nb_samples number of samples to write
90 * @return number of samples actually written, or negative AVERROR
91 * code on failure. If successful, the number of samples
92 * actually written will always be nb_samples.
94 int av_audio_fifo_write(AVAudioFifo *af, void **data, int nb_samples);
97 * Read data from an AVAudioFifo.
99 * @see enum AVSampleFormat
100 * The documentation for AVSampleFormat describes the data layout.
102 * @param af AVAudioFifo to read from
103 * @param data audio data plane pointers
104 * @param nb_samples number of samples to read
105 * @return number of samples actually read, or negative AVERROR code
106 * on failure. The number of samples actually read will not
107 * be greater than nb_samples, and will only be less than
108 * nb_samples if av_audio_fifo_size is less than nb_samples.
110 int av_audio_fifo_read(AVAudioFifo *af, void **data, int nb_samples);
113 * Drain data from an AVAudioFifo.
115 * Removes the data without reading it.
117 * @param af AVAudioFifo to drain
118 * @param nb_samples number of samples to drain
119 * @return 0 if OK, or negative AVERROR code on failure
121 int av_audio_fifo_drain(AVAudioFifo *af, int nb_samples);
124 * Reset the AVAudioFifo buffer.
126 * This empties all data in the buffer.
128 * @param af AVAudioFifo to reset
130 void av_audio_fifo_reset(AVAudioFifo *af);
133 * Get the current number of samples in the AVAudioFifo available for reading.
135 * @param af the AVAudioFifo to query
136 * @return number of samples available for reading
138 int av_audio_fifo_size(AVAudioFifo *af);
141 * Get the current number of samples in the AVAudioFifo available for writing.
143 * @param af the AVAudioFifo to query
144 * @return number of samples available for writing
146 int av_audio_fifo_space(AVAudioFifo *af);
153 #endif /* AVUTIL_AUDIO_FIFO_H */