lavf: fix a few typo in some comments.
[ffmpeg.git] / libswresample / 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 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 #ifndef SWR_AUDIOCONVERT_H
24 #define SWR_AUDIOCONVERT_H
25
26 /**
27  * @file
28  * Audio format conversion routines
29  */
30
31
32 #include "swresample_internal.h"
33 #include "libavutil/cpu.h"
34 #include "libavutil/audioconvert.h"
35
36
37 typedef void (conv_func_type)(uint8_t *po, const uint8_t *pi, int is, int os, uint8_t *end);
38 typedef void (simd_func_type)(uint8_t **dst, const uint8_t **src, int len);
39
40 typedef struct AudioConvert {
41     int channels;
42     conv_func_type *conv_f;
43     simd_func_type *simd_f;
44     const int *ch_map;
45     uint8_t silence[8]; ///< silence input sample
46 }AudioConvert;
47
48 /**
49  * Create an audio sample format converter context
50  * @param out_fmt Output sample format
51  * @param in_fmt Input sample format
52  * @param channels Number of channels
53  * @param flags See AV_CPU_FLAG_xx
54  * @param ch_map list of the channels id to pick from the source stream, NULL
55  *               if all channels must be selected
56  * @return NULL on error
57  */
58 AudioConvert *swri_audio_convert_alloc(enum AVSampleFormat out_fmt,
59                                        enum AVSampleFormat in_fmt,
60                                        int channels, const int *ch_map,
61                                        int flags);
62
63 /**
64  * Free audio sample format converter context.
65  * and set the pointer to NULL
66  */
67 void swri_audio_convert_free(AudioConvert **ctx);
68
69 /**
70  * Convert between audio sample formats
71  * @param[in] out array of output buffers for each channel. set to NULL to ignore processing of the given channel.
72  * @param[in] in array of input buffers for each channel
73  * @param len length of audio frame size (measured in samples)
74  */
75 int swri_audio_convert(AudioConvert *ctx, AudioData *out, AudioData *in, int len);
76
77 #endif /* AUDIOCONVERT_H */