h264: print error on unsupported seperate color planes
[ffmpeg.git] / libavresample / audio_convert.h
1 /*
2  * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVRESAMPLE_AUDIO_CONVERT_H
22 #define AVRESAMPLE_AUDIO_CONVERT_H
23
24 #include "libavutil/samplefmt.h"
25 #include "avresample.h"
26 #include "audio_data.h"
27
28 typedef struct AudioConvert AudioConvert;
29
30 /**
31  * Set conversion function if the parameters match.
32  *
33  * This compares the parameters of the conversion function to the parameters
34  * in the AudioConvert context. If the parameters do not match, no changes are
35  * made to the active functions. If the parameters do match and the alignment
36  * is not constrained, the function is set as the generic conversion function.
37  * If the parameters match and the alignment is constrained, the function is
38  * set as the optimized conversion function.
39  *
40  * @param ac             AudioConvert context
41  * @param out_fmt        output sample format
42  * @param in_fmt         input sample format
43  * @param channels       number of channels, or 0 for any number of channels
44  * @param ptr_align      buffer pointer alignment, in bytes
45  * @param sample_align   buffer size alignment, in samples
46  * @param descr          function type description (e.g. "C" or "SSE")
47  * @param conv           conversion function pointer
48  */
49 void ff_audio_convert_set_func(AudioConvert *ac, enum AVSampleFormat out_fmt,
50                                enum AVSampleFormat in_fmt, int channels,
51                                int ptr_align, int samples_align,
52                                const char *descr, void *conv);
53
54 /**
55  * Allocate and initialize AudioConvert context for sample format conversion.
56  *
57  * @param avr      AVAudioResampleContext
58  * @param out_fmt  output sample format
59  * @param in_fmt   input sample format
60  * @param channels number of channels
61  * @return         newly-allocated AudioConvert context
62  */
63 AudioConvert *ff_audio_convert_alloc(AVAudioResampleContext *avr,
64                                      enum AVSampleFormat out_fmt,
65                                      enum AVSampleFormat in_fmt,
66                                      int channels);
67
68 /**
69  * Convert audio data from one sample format to another.
70  *
71  * For each call, the alignment of the input and output AudioData buffers are
72  * examined to determine whether to use the generic or optimized conversion
73  * function (when available).
74  *
75  * @param ac     AudioConvert context
76  * @param out    output audio data
77  * @param in     input audio data
78  * @param len    number of samples to convert
79  * @return       0 on success, negative AVERROR code on failure
80  */
81 int ff_audio_convert(AudioConvert *ac, AudioData *out, AudioData *in, int len);
82
83 /* arch-specific initialization functions */
84
85 void ff_audio_convert_init_x86(AudioConvert *ac);
86
87 #endif /* AVRESAMPLE_AUDIO_CONVERT_H */