986eecc7f9dd676ff37cba1a01421a1cccc7dcc0
[ffmpeg.git] / libswresample / swresample_internal.h
1 /*
2  * Copyright (C) 2011-2013 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 #ifndef SWR_INTERNAL_H
22 #define SWR_INTERNAL_H
23
24 #include "swresample.h"
25 #include "libavutil/channel_layout.h"
26 #include "config.h"
27
28 #define SQRT3_2      1.22474487139158904909  /* sqrt(3/2) */
29
30 #define NS_TAPS 20
31
32 #if ARCH_X86_64
33 typedef int64_t integer;
34 #else
35 typedef int integer;
36 #endif
37
38 typedef void (mix_1_1_func_type)(void *out, const void *in, void *coeffp, integer index, integer len);
39 typedef void (mix_2_1_func_type)(void *out, const void *in1, const void *in2, void *coeffp, integer index1, integer index2, integer len);
40
41 typedef void (mix_any_func_type)(uint8_t **out, const uint8_t **in1, void *coeffp, integer len);
42
43 typedef struct AudioData{
44     uint8_t *ch[SWR_CH_MAX];    ///< samples buffer per channel
45     uint8_t *data;              ///< samples buffer
46     int ch_count;               ///< number of channels
47     int bps;                    ///< bytes per sample
48     int count;                  ///< number of samples
49     int planar;                 ///< 1 if planar audio, 0 otherwise
50     enum AVSampleFormat fmt;    ///< sample format
51 } AudioData;
52
53 struct SwrContext {
54     const AVClass *av_class;                        ///< AVClass used for AVOption and av_log()
55     int log_level_offset;                           ///< logging level offset
56     void *log_ctx;                                  ///< parent logging context
57     enum AVSampleFormat  in_sample_fmt;             ///< input sample format
58     enum AVSampleFormat int_sample_fmt;             ///< internal sample format (AV_SAMPLE_FMT_FLTP or AV_SAMPLE_FMT_S16P)
59     enum AVSampleFormat out_sample_fmt;             ///< output sample format
60     int64_t  in_ch_layout;                          ///< input channel layout
61     int64_t out_ch_layout;                          ///< output channel layout
62     int      in_sample_rate;                        ///< input sample rate
63     int     out_sample_rate;                        ///< output sample rate
64     int flags;                                      ///< miscellaneous flags such as SWR_FLAG_RESAMPLE
65     float slev;                                     ///< surround mixing level
66     float clev;                                     ///< center mixing level
67     float lfe_mix_level;                            ///< LFE mixing level
68     float rematrix_volume;                          ///< rematrixing volume coefficient
69     enum AVMatrixEncoding matrix_encoding;          /**< matrixed stereo encoding */
70     const int *channel_map;                         ///< channel index (or -1 if muted channel) map
71     int used_ch_count;                              ///< number of used input channels (mapped channel count if channel_map, otherwise in.ch_count)
72     enum SwrEngine engine;
73     enum SwrDitherType dither_method;
74     int dither_pos;
75     float dither_scale;
76     int ns_taps;                                    ///< Noise shaping dither taps
77     float ns_scale;                                 ///< Noise shaping dither scale
78     float ns_scale_1;                               ///< Noise shaping dither scale^-1
79     int ns_pos;                                     ///< Noise shaping dither position
80     float ns_coeffs[NS_TAPS];                       ///< Noise shaping filter coefficients
81     float ns_errors[SWR_CH_MAX][2*NS_TAPS];
82
83     int filter_size;                                /**< length of each FIR filter in the resampling filterbank relative to the cutoff frequency */
84     int phase_shift;                                /**< log2 of the number of entries in the resampling polyphase filterbank */
85     int linear_interp;                              /**< if 1 then the resampling FIR filter will be linearly interpolated */
86     double cutoff;                                  /**< resampling cutoff frequency (swr: 6dB point; soxr: 0dB point). 1.0 corresponds to half the output sample rate */
87     enum SwrFilterType filter_type;                 /**< swr resampling filter type */
88     int kaiser_beta;                                /**< swr beta value for Kaiser window (only applicable if filter_type == AV_FILTER_TYPE_KAISER) */
89     double precision;                               /**< soxr resampling precision (in bits) */
90     int cheby;                                      /**< soxr: if 1 then passband rolloff will be none (Chebyshev) & irrational ratio approximation precision will be higher */
91
92     float min_compensation;                         ///< swr minimum below which no compensation will happen
93     float min_hard_compensation;                    ///< swr minimum below which no silence inject / sample drop will happen
94     float soft_compensation_duration;               ///< swr duration over which soft compensation is applied
95     float max_soft_compensation;                    ///< swr maximum soft compensation in seconds over soft_compensation_duration
96     float async;                                    ///< swr simple 1 parameter async, similar to ffmpegs -async
97
98     int resample_first;                             ///< 1 if resampling must come first, 0 if rematrixing
99     int rematrix;                                   ///< flag to indicate if rematrixing is needed (basically if input and output layouts mismatch)
100     int rematrix_custom;                            ///< flag to indicate that a custom matrix has been defined
101
102     AudioData in;                                   ///< input audio data
103     AudioData postin;                               ///< post-input audio data: used for rematrix/resample
104     AudioData midbuf;                               ///< intermediate audio data (postin/preout)
105     AudioData preout;                               ///< pre-output audio data: used for rematrix/resample
106     AudioData out;                                  ///< converted output audio data
107     AudioData in_buffer;                            ///< cached audio data (convert and resample purpose)
108     AudioData dither;                               ///< noise used for dithering
109     int in_buffer_index;                            ///< cached buffer position
110     int in_buffer_count;                            ///< cached buffer length
111     int resample_in_constraint;                     ///< 1 if the input end was reach before the output end, 0 otherwise
112     int flushed;                                    ///< 1 if data is to be flushed and no further input is expected
113     int64_t outpts;                                 ///< output PTS
114     int drop_output;                                ///< number of output samples to drop
115
116     struct AudioConvert *in_convert;                ///< input conversion context
117     struct AudioConvert *out_convert;               ///< output conversion context
118     struct AudioConvert *full_convert;              ///< full conversion context (single conversion for input and output)
119     struct ResampleContext *resample;               ///< resampling context
120     struct Resampler const *resampler;              ///< resampler virtual function table
121
122     float matrix[SWR_CH_MAX][SWR_CH_MAX];           ///< floating point rematrixing coefficients
123     uint8_t *native_matrix;
124     uint8_t *native_one;
125     uint8_t *native_simd_matrix;
126     int32_t matrix32[SWR_CH_MAX][SWR_CH_MAX];       ///< 17.15 fixed point rematrixing coefficients
127     uint8_t matrix_ch[SWR_CH_MAX][SWR_CH_MAX+1];    ///< Lists of input channels per output channel that have non zero rematrixing coefficients
128     mix_1_1_func_type *mix_1_1_f;
129     mix_1_1_func_type *mix_1_1_simd;
130
131     mix_2_1_func_type *mix_2_1_f;
132     mix_2_1_func_type *mix_2_1_simd;
133
134     mix_any_func_type *mix_any_f;
135
136     /* TODO: callbacks for ASM optimizations */
137 };
138
139 typedef struct ResampleContext * (* resample_init_func)(struct ResampleContext *c, int out_rate, int in_rate, int filter_size, int phase_shift, int linear,
140                                     double cutoff, enum AVSampleFormat format, enum SwrFilterType filter_type, int kaiser_beta, double precision, int cheby);
141 typedef void    (* resample_free_func)(struct ResampleContext **c);
142 typedef int     (* multiple_resample_func)(struct ResampleContext *c, AudioData *dst, int dst_size, AudioData *src, int src_size, int *consumed);
143 typedef int     (* resample_flush_func)(struct SwrContext *c);
144 typedef int     (* set_compensation_func)(struct ResampleContext *c, int sample_delta, int compensation_distance);
145 typedef int64_t (* get_delay_func)(struct SwrContext *s, int64_t base);
146
147 struct Resampler {
148   resample_init_func            init;
149   resample_free_func            free;
150   multiple_resample_func        multiple_resample;
151   resample_flush_func           flush;
152   set_compensation_func         set_compensation;
153   get_delay_func                get_delay;
154 };
155
156 extern struct Resampler const swri_resampler;
157
158 int swri_realloc_audio(AudioData *a, int count);
159 int swri_resample_int16(struct ResampleContext *c, int16_t *dst, const int16_t *src, int *consumed, int src_size, int dst_size, int update_ctx);
160 int swri_resample_int32(struct ResampleContext *c, int32_t *dst, const int32_t *src, int *consumed, int src_size, int dst_size, int update_ctx);
161 int swri_resample_float(struct ResampleContext *c, float   *dst, const float   *src, int *consumed, int src_size, int dst_size, int update_ctx);
162 int swri_resample_double(struct ResampleContext *c,double  *dst, const double  *src, int *consumed, int src_size, int dst_size, int update_ctx);
163
164 void swri_noise_shaping_int16 (SwrContext *s, AudioData *srcs, AudioData *noises, int count);
165 void swri_noise_shaping_int32 (SwrContext *s, AudioData *srcs, AudioData *noises, int count);
166 void swri_noise_shaping_float (SwrContext *s, AudioData *srcs, AudioData *noises, int count);
167 void swri_noise_shaping_double(SwrContext *s, AudioData *srcs, AudioData *noises, int count);
168
169 int swri_rematrix_init(SwrContext *s);
170 void swri_rematrix_free(SwrContext *s);
171 int swri_rematrix(SwrContext *s, AudioData *out, AudioData *in, int len, int mustcopy);
172 void swri_rematrix_init_x86(struct SwrContext *s);
173
174 void swri_get_dither(SwrContext *s, void *dst, int len, unsigned seed, enum AVSampleFormat out_fmt, enum AVSampleFormat in_fmt);
175
176 void swri_audio_convert_init_arm(struct AudioConvert *ac,
177                                  enum AVSampleFormat out_fmt,
178                                  enum AVSampleFormat in_fmt,
179                                  int channels);
180 void swri_audio_convert_init_x86(struct AudioConvert *ac,
181                                  enum AVSampleFormat out_fmt,
182                                  enum AVSampleFormat in_fmt,
183                                  int channels);
184 #endif