]> git.sesse.net Git - ffmpeg/blob - libavcodec/audioconvert.h
parser: Move Doxygen documentation to the header files
[ffmpeg] / libavcodec / audioconvert.h
1 /*
2  * audio conversion
3  * Copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
4  * Copyright (c) 2008 Peter Ross
5  *
6  * This file is part of Libav.
7  *
8  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #ifndef AVCODEC_AUDIOCONVERT_H
24 #define AVCODEC_AUDIOCONVERT_H
25
26 /**
27  * @file
28  * Audio format conversion routines
29  */
30
31
32 #include "libavutil/cpu.h"
33 #include "avcodec.h"
34 #include "libavutil/audioconvert.h"
35
36 struct AVAudioConvert;
37 typedef struct AVAudioConvert AVAudioConvert;
38
39 /**
40  * Create an audio sample format converter context
41  * @param out_fmt Output sample format
42  * @param out_channels Number of output channels
43  * @param in_fmt Input sample format
44  * @param in_channels Number of input channels
45  * @param[in] matrix Channel mixing matrix (of dimension in_channel*out_channels). Set to NULL to ignore.
46  * @param flags See AV_CPU_FLAG_xx
47  * @return NULL on error
48  */
49 AVAudioConvert *av_audio_convert_alloc(enum AVSampleFormat out_fmt, int out_channels,
50                                        enum AVSampleFormat in_fmt, int in_channels,
51                                        const float *matrix, int flags);
52
53 /**
54  * Free audio sample format converter context
55  */
56 void av_audio_convert_free(AVAudioConvert *ctx);
57
58 /**
59  * Convert between audio sample formats
60  * @param[in] out array of output buffers for each channel. set to NULL to ignore processing of the given channel.
61  * @param[in] out_stride distance between consecutive output samples (measured in bytes)
62  * @param[in] in array of input buffers for each channel
63  * @param[in] in_stride distance between consecutive input samples (measured in bytes)
64  * @param len length of audio frame size (measured in samples)
65  */
66 int av_audio_convert(AVAudioConvert *ctx,
67                            void * const out[6], const int out_stride[6],
68                      const void * const  in[6], const int  in_stride[6], int len);
69
70 #endif /* AVCODEC_AUDIOCONVERT_H */