aacdec: print debug note when unexpected SCE/CPE is encountered
[ffmpeg.git] / libswresample / swresample.h
1 /*
2  * Copyright (C) 2011 Michael Niedermayer (michaelni@gmx.at)
3  *
4  * This file is part of libswresample
5  *
6  * libswresample 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  * libswresample 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 libswresample; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * libswresample public header
24  */
25
26 #ifndef SWR_H
27 #define SWR_H
28
29 #include <inttypes.h>
30 #include "libavutil/samplefmt.h"
31
32 #define LIBSWRESAMPLE_VERSION_MAJOR 0
33 #define LIBSWRESAMPLE_VERSION_MINOR 15
34 #define LIBSWRESAMPLE_VERSION_MICRO 100
35
36 #define LIBSWRESAMPLE_VERSION_INT  AV_VERSION_INT(LIBSWRESAMPLE_VERSION_MAJOR, \
37                                                   LIBSWRESAMPLE_VERSION_MINOR, \
38                                                   LIBSWRESAMPLE_VERSION_MICRO)
39
40 #if LIBSWRESAMPLE_VERSION_MAJOR < 1
41 #define SWR_CH_MAX 32   ///< Maximum number of channels
42 #endif
43
44 #define SWR_FLAG_RESAMPLE 1 ///< Force resampling even if equal sample rate
45 //TODO use int resample ?
46 //long term TODO can we enable this dynamically?
47
48 enum SwrDitherType {
49     SWR_DITHER_NONE = 0,
50     SWR_DITHER_RECTANGULAR,
51     SWR_DITHER_TRIANGULAR,
52     SWR_DITHER_TRIANGULAR_HIGHPASS,
53     SWR_DITHER_NB,              ///< not part of API/ABI
54 };
55
56 typedef struct SwrContext SwrContext;
57
58 /**
59  * Get the AVClass for swrContext. It can be used in combination with
60  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
61  *
62  * @see av_opt_find().
63  */
64 const AVClass *swr_get_class(void);
65
66 /**
67  * Allocate SwrContext.
68  *
69  * If you use this function you will need to set the parameters (manually or
70  * with swr_alloc_set_opts()) before calling swr_init().
71  *
72  * @see swr_alloc_set_opts(), swr_init(), swr_free()
73  * @return NULL on error, allocated context otherwise
74  */
75 struct SwrContext *swr_alloc(void);
76
77 /**
78  * Initialize context after user parameters have been set.
79  *
80  * @return AVERROR error code in case of failure.
81  */
82 int swr_init(struct SwrContext *s);
83
84 /**
85  * Allocate SwrContext if needed and set/reset common parameters.
86  *
87  * This function does not require s to be allocated with swr_alloc(). On the
88  * other hand, swr_alloc() can use swr_alloc_set_opts() to set the parameters
89  * on the allocated context.
90  *
91  * @param s               Swr context, can be NULL
92  * @param out_ch_layout   output channel layout (AV_CH_LAYOUT_*)
93  * @param out_sample_fmt  output sample format (AV_SAMPLE_FMT_*).
94  * @param out_sample_rate output sample rate (frequency in Hz)
95  * @param in_ch_layout    input channel layout (AV_CH_LAYOUT_*)
96  * @param in_sample_fmt   input sample format (AV_SAMPLE_FMT_*).
97  * @param in_sample_rate  input sample rate (frequency in Hz)
98  * @param log_offset      logging level offset
99  * @param log_ctx         parent logging context, can be NULL
100  *
101  * @see swr_init(), swr_free()
102  * @return NULL on error, allocated context otherwise
103  */
104 struct SwrContext *swr_alloc_set_opts(struct SwrContext *s,
105                                       int64_t out_ch_layout, enum AVSampleFormat out_sample_fmt, int out_sample_rate,
106                                       int64_t  in_ch_layout, enum AVSampleFormat  in_sample_fmt, int  in_sample_rate,
107                                       int log_offset, void *log_ctx);
108
109 /**
110  * Free the given SwrContext and set the pointer to NULL.
111  */
112 void swr_free(struct SwrContext **s);
113
114 /**
115  * Convert audio.
116  *
117  * in and in_count can be set to 0 to flush the last few samples out at the
118  * end.
119  *
120  * If more input is provided than output space then the input will be buffered.
121  * You can avoid this buffering by providing more output space than input.
122  * Convertion will run directly without copying whenever possible.
123  *
124  * @param s         allocated Swr context, with parameters set
125  * @param out       output buffers, only the first one need be set in case of packed audio
126  * @param out_count amount of space available for output in samples per channel
127  * @param in        input buffers, only the first one need to be set in case of packed audio
128  * @param in_count  number of input samples available in one channel
129  *
130  * @return number of samples output per channel, negative value on error
131  */
132 int swr_convert(struct SwrContext *s, uint8_t **out, int out_count,
133                                 const uint8_t **in , int in_count);
134
135 /**
136  * Convert the next timestamp from input to output
137  * timestampe are in 1/(in_sample_rate * out_sample_rate) units.
138  *
139  * @note There are 2 slightly differently behaving modes.
140  *       First is when automatic timestamp compensation is not used, (min_compensation >= FLT_MAX)
141  *              in this case timestamps will be passed through with delays compensated
142  *       Second is when automatic timestamp compensation is used, (min_compensation < FLT_MAX)
143  *              in this case the output timestamps will match output sample numbers
144  *
145  * @param pts   timstamp for the next input sample, INT64_MIN if unknown
146  * @returns the output timestamp for the next output sample
147  */
148 int64_t swr_next_pts(struct SwrContext *s, int64_t pts);
149
150 /**
151  * Activate resampling compensation.
152  */
153 int swr_set_compensation(struct SwrContext *s, int sample_delta, int compensation_distance);
154
155 /**
156  * Set a customized input channel mapping.
157  *
158  * @param s           allocated Swr context, not yet initialized
159  * @param channel_map customized input channel mapping (array of channel
160  *                    indexes, -1 for a muted channel)
161  * @return AVERROR error code in case of failure.
162  */
163 int swr_set_channel_mapping(struct SwrContext *s, const int *channel_map);
164
165 /**
166  * Set a customized remix matrix.
167  *
168  * @param s       allocated Swr context, not yet initialized
169  * @param matrix  remix coefficients; matrix[i + stride * o] is
170  *                the weight of input channel i in output channel o
171  * @param stride  offset between lines of the matrix
172  * @return  AVERROR error code in case of failure.
173  */
174 int swr_set_matrix(struct SwrContext *s, const double *matrix, int stride);
175
176 /**
177  * Drops the specified number of output samples.
178  */
179 int swr_drop_output(struct SwrContext *s, int count);
180
181 /**
182  * Injects the specified number of silence samples.
183  */
184 int swr_inject_silence(struct SwrContext *s, int count);
185
186 /**
187  * Gets the delay the next input sample will experience relative to the next output sample.
188  *
189  * Swresample can buffer data if more input has been provided than available
190  * output space, also converting between sample rates needs a delay.
191  * This function returns the sum of all such delays.
192  *
193  * @param s     swr context
194  * @param base  timebase in which the returned delay will be
195  *              if its set to 1 the returned delay is in seconds
196  *              if its set to 1000 the returned delay is in milli seconds
197  *              if its set to the input sample rate then the returned delay is in input samples
198  *              if its set to the output sample rate then the returned delay is in output samples
199  *              an exact rounding free delay can be found by using LCM(in_sample_rate, out_sample_rate)
200  * @returns     the delay in 1/base units.
201  */
202 int64_t swr_get_delay(struct SwrContext *s, int64_t base);
203
204 /**
205  * Return the LIBSWRESAMPLE_VERSION_INT constant.
206  */
207 unsigned swresample_version(void);
208
209 /**
210  * Return the swr build-time configuration.
211  */
212 const char *swresample_configuration(void);
213
214 /**
215  * Return the swr license.
216  */
217 const char *swresample_license(void);
218
219 #endif