FFmpeg
af_haas.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2001-2010 Vladimir Sadovnikov
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #include "libavutil/channel_layout.h"
22 #include "libavutil/mem.h"
23 #include "libavutil/opt.h"
24 #include "avfilter.h"
25 #include "audio.h"
26 #include "filters.h"
27 #include "formats.h"
28 
29 #define MAX_HAAS_DELAY 40
30 
31 typedef struct HaasContext {
32  const AVClass *class;
33 
34  int par_m_source;
35  double par_delay0;
36  double par_delay1;
37  int par_phase0;
38  int par_phase1;
39  int par_middle_phase;
40  double par_side_gain;
41  double par_gain0;
42  double par_gain1;
43  double par_balance0;
44  double par_balance1;
45  double level_in;
46  double level_out;
47 
48  double *buffer;
49  size_t buffer_size;
50  uint32_t write_ptr;
51  uint32_t delay[2];
52  double balance_l[2];
53  double balance_r[2];
54  double phase0;
55  double phase1;
56 } HaasContext;
57 
58 #define OFFSET(x) offsetof(HaasContext, x)
59 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
60 
61 static const AVOption haas_options[] = {
62  { "level_in", "set level in", OFFSET(level_in), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.015625, 64, A },
63  { "level_out", "set level out", OFFSET(level_out), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.015625, 64, A },
64  { "side_gain", "set side gain", OFFSET(par_side_gain), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.015625, 64, A },
65  { "middle_source", "set middle source", OFFSET(par_m_source), AV_OPT_TYPE_INT, {.i64=2}, 0, 3, A, .unit = "source" },
66  { "left", 0, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, A, .unit = "source" },
67  { "right", 0, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, A, .unit = "source" },
68  { "mid", "L+R", 0, AV_OPT_TYPE_CONST, {.i64=2}, 0, 0, A, .unit = "source" },
69  { "side", "L-R", 0, AV_OPT_TYPE_CONST, {.i64=3}, 0, 0, A, .unit = "source" },
70  { "middle_phase", "set middle phase", OFFSET(par_middle_phase), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, A },
71  { "left_delay", "set left delay", OFFSET(par_delay0), AV_OPT_TYPE_DOUBLE, {.dbl=2.05}, 0, MAX_HAAS_DELAY, A },
72  { "left_balance", "set left balance", OFFSET(par_balance0), AV_OPT_TYPE_DOUBLE, {.dbl=-1.0}, -1, 1, A },
73  { "left_gain", "set left gain", OFFSET(par_gain0), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.015625, 64, A },
74  { "left_phase", "set left phase", OFFSET(par_phase0), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, A },
75  { "right_delay", "set right delay", OFFSET(par_delay1), AV_OPT_TYPE_DOUBLE, {.dbl=2.12}, 0, MAX_HAAS_DELAY, A },
76  { "right_balance", "set right balance", OFFSET(par_balance1), AV_OPT_TYPE_DOUBLE, {.dbl=1}, -1, 1, A },
77  { "right_gain", "set right gain", OFFSET(par_gain1), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.015625, 64, A },
78  { "right_phase", "set right phase", OFFSET(par_phase1), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, A },
79  { NULL }
80 };
81 
82 AVFILTER_DEFINE_CLASS(haas);
83 
84 static int query_formats(const AVFilterContext *ctx,
85  AVFilterFormatsConfig **cfg_in,
86  AVFilterFormatsConfig **cfg_out)
87 {
88  static const enum AVSampleFormat formats[] = {
89  AV_SAMPLE_FMT_DBL,
90  AV_SAMPLE_FMT_NONE,
91  };
92  static const AVChannelLayout layouts[] = {
93  AV_CHANNEL_LAYOUT_STEREO,
94  { .nb_channels = 0 },
95  };
96  int ret;
97 
98  ret = ff_set_common_formats_from_list2(ctx, cfg_in, cfg_out, formats);
99  if (ret < 0)
100  return ret;
101 
102  ret = ff_set_common_channel_layouts_from_list2(ctx, cfg_in, cfg_out, layouts);
103  if (ret < 0)
104  return ret;
105 
106  return 0;
107 }
108 
109 static int config_input(AVFilterLink *inlink)
110 {
111  AVFilterContext *ctx = inlink->dst;
112  HaasContext *s = ctx->priv;
113  size_t min_buf_size = (size_t)(inlink->sample_rate * MAX_HAAS_DELAY * 0.001);
114  size_t new_buf_size = 1;
115 
116  while (new_buf_size < min_buf_size)
117  new_buf_size <<= 1;
118 
119  av_freep(&s->buffer);
120  s->buffer = av_calloc(new_buf_size, sizeof(*s->buffer));
121  if (!s->buffer)
122  return AVERROR(ENOMEM);
123 
124  s->buffer_size = new_buf_size;
125  s->write_ptr = 0;
126 
127  s->delay[0] = (uint32_t)(s->par_delay0 * 0.001 * inlink->sample_rate);
128  s->delay[1] = (uint32_t)(s->par_delay1 * 0.001 * inlink->sample_rate);
129 
130  s->phase0 = s->par_phase0 ? 1.0 : -1.0;
131  s->phase1 = s->par_phase1 ? 1.0 : -1.0;
132 
133  s->balance_l[0] = (s->par_balance0 + 1) / 2 * s->par_gain0 * s->phase0;
134  s->balance_r[0] = (1.0 - (s->par_balance0 + 1) / 2) * (s->par_gain0) * s->phase0;
135  s->balance_l[1] = (s->par_balance1 + 1) / 2 * s->par_gain1 * s->phase1;
136  s->balance_r[1] = (1.0 - (s->par_balance1 + 1) / 2) * (s->par_gain1) * s->phase1;
137 
138  return 0;
139 }
140 
141 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
142 {
143  AVFilterContext *ctx = inlink->dst;
144  AVFilterLink *outlink = ctx->outputs[0];
145  HaasContext *s = ctx->priv;
146  const double *src = (const double *)in->data[0];
147  const double level_in = s->level_in;
148  const double level_out = s->level_out;
149  const uint32_t mask = s->buffer_size - 1;
150  double *buffer = s->buffer;
151  AVFrame *out;
152  double *dst;
153  int n;
154 
155  if (av_frame_is_writable(in)) {
156  out = in;
157  } else {
158  out = ff_get_audio_buffer(outlink, in->nb_samples);
159  if (!out) {
160  av_frame_free(&in);
161  return AVERROR(ENOMEM);
162  }
163  av_frame_copy_props(out, in);
164  }
165  dst = (double *)out->data[0];
166 
167  for (n = 0; n < in->nb_samples; n++, src += 2, dst += 2) {
168  double mid, side[2], side_l, side_r;
169  uint32_t s0_ptr, s1_ptr;
170 
171  switch (s->par_m_source) {
172  case 0: mid = src[0]; break;
173  case 1: mid = src[1]; break;
174  case 2: mid = (src[0] + src[1]) * 0.5; break;
175  case 3: mid = (src[0] - src[1]) * 0.5; break;
176  }
177 
178  mid *= level_in;
179 
180  buffer[s->write_ptr] = mid;
181 
182  s0_ptr = (s->write_ptr + s->buffer_size - s->delay[0]) & mask;
183  s1_ptr = (s->write_ptr + s->buffer_size - s->delay[1]) & mask;
184 
185  if (s->par_middle_phase)
186  mid = -mid;
187 
188  side[0] = buffer[s0_ptr] * s->par_side_gain;
189  side[1] = buffer[s1_ptr] * s->par_side_gain;
190  side_l = side[0] * s->balance_l[0] - side[1] * s->balance_l[1];
191  side_r = side[1] * s->balance_r[1] - side[0] * s->balance_r[0];
192 
193  dst[0] = (mid + side_l) * level_out;
194  dst[1] = (mid + side_r) * level_out;
195 
196  s->write_ptr = (s->write_ptr + 1) & mask;
197  }
198 
199  if (out != in)
200  av_frame_free(&in);
201  return ff_filter_frame(outlink, out);
202 }
203 
204 static av_cold void uninit(AVFilterContext *ctx)
205 {
206  HaasContext *s = ctx->priv;
207 
208  av_freep(&s->buffer);
209  s->buffer_size = 0;
210 }
211 
212 static const AVFilterPad inputs[] = {
213  {
214  .name = "default",
215  .type = AVMEDIA_TYPE_AUDIO,
216  .filter_frame = filter_frame,
217  .config_props = config_input,
218  },
219 };
220 
221 const AVFilter ff_af_haas = {
222  .name = "haas",
223  .description = NULL_IF_CONFIG_SMALL("Apply Haas Stereo Enhancer."),
224  .priv_size = sizeof(HaasContext),
225  .priv_class = &haas_class,
226  .uninit = uninit,
227  FILTER_INPUTS(inputs),
228  FILTER_OUTPUTS(ff_audio_default_filterpad),
229  FILTER_QUERY_FUNC2(query_formats),
230 };
formats
formats
Definition: signature.h:47
HaasContext::par_delay0
double par_delay0
Definition: af_haas.c:35
ff_get_audio_buffer
AVFrame * ff_get_audio_buffer(AVFilterLink *link, int nb_samples)
Request an audio samples buffer with a specific set of permissions.
Definition: audio.c:98
config_input
static int config_input(AVFilterLink *inlink)
Definition: af_haas.c:109
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
out
FILE * out
Definition: movenc.c:55
AV_CHANNEL_LAYOUT_STEREO
#define AV_CHANNEL_LAYOUT_STEREO
Definition: channel_layout.h:387
HaasContext::level_out
double level_out
Definition: af_haas.c:46
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1062
layouts
enum MovChannelLayoutTag * layouts
Definition: mov_chan.c:335
A
#define A
Definition: af_haas.c:59
HaasContext::par_delay1
double par_delay1
Definition: af_haas.c:36
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
HaasContext::buffer
double * buffer
Definition: af_haas.c:48
mask
int mask
Definition: mediacodecdec_common.c:154
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:162
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: filters.h:262
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:389
AVOption
AVOption.
Definition: opt.h:429
HaasContext::balance_l
double balance_l[2]
Definition: af_haas.c:52
ff_set_common_channel_layouts_from_list2
int ff_set_common_channel_layouts_from_list2(const AVFilterContext *ctx, AVFilterFormatsConfig **cfg_in, AVFilterFormatsConfig **cfg_out, const AVChannelLayout *fmts)
Definition: formats.c:920
OFFSET
#define OFFSET(x)
Definition: af_haas.c:58
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: af_haas.c:141
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:205
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:410
formats.h
HaasContext::write_ptr
uint32_t write_ptr
Definition: af_haas.c:50
MAX_HAAS_DELAY
#define MAX_HAAS_DELAY
Definition: af_haas.c:29
AVFilterPad
A filter pad used for either input or output.
Definition: filters.h:38
av_cold
#define av_cold
Definition: attributes.h:90
s
#define s(width, name)
Definition: cbs_vp9.c:198
AV_OPT_TYPE_DOUBLE
@ AV_OPT_TYPE_DOUBLE
Underlying C type is double.
Definition: opt.h:267
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
filters.h
ctx
AVFormatContext * ctx
Definition: movenc.c:49
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: filters.h:263
if
if(ret)
Definition: filter_design.txt:179
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:75
NULL
#define NULL
Definition: coverity.c:32
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:713
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(haas)
HaasContext::par_middle_phase
int par_middle_phase
Definition: af_haas.c:39
ff_audio_default_filterpad
const AVFilterPad ff_audio_default_filterpad[1]
An AVFilterPad array whose only entry has name "default" and is of type AVMEDIA_TYPE_AUDIO.
Definition: audio.c:34
HaasContext::par_m_source
int par_m_source
Definition: af_haas.c:34
HaasContext::par_phase1
int par_phase1
Definition: af_haas.c:38
AVFilterFormatsConfig
Lists of formats / etc.
Definition: avfilter.h:111
ff_af_haas
const AVFilter ff_af_haas
Definition: af_haas.c:221
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:94
AVChannelLayout
An AVChannelLayout holds information about the channel layout of audio data.
Definition: channel_layout.h:311
dst
uint8_t ptrdiff_t const uint8_t ptrdiff_t int intptr_t intptr_t int int16_t * dst
Definition: dsp.h:83
for
for(k=2;k<=8;++k)
Definition: h264pred_template.c:425
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:56
av_frame_is_writable
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:649
HaasContext::par_balance1
double par_balance1
Definition: af_haas.c:44
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:469
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:55
FILTER_QUERY_FUNC2
#define FILTER_QUERY_FUNC2(func)
Definition: filters.h:239
HaasContext::delay
uint32_t delay[2]
Definition: af_haas.c:51
AVFilterPad::name
const char * name
Pad name.
Definition: filters.h:44
HaasContext::phase0
double phase0
Definition: af_haas.c:54
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:264
AVFilter
Filter definition.
Definition: avfilter.h:201
query_formats
static int query_formats(const AVFilterContext *ctx, AVFilterFormatsConfig **cfg_in, AVFilterFormatsConfig **cfg_out)
Definition: af_haas.c:84
HaasContext::par_side_gain
double par_side_gain
Definition: af_haas.c:40
ret
ret
Definition: filter_design.txt:187
HaasContext::par_balance0
double par_balance0
Definition: af_haas.c:43
ff_set_common_formats_from_list2
int ff_set_common_formats_from_list2(const AVFilterContext *ctx, AVFilterFormatsConfig **cfg_in, AVFilterFormatsConfig **cfg_out, const int *fmts)
Definition: formats.c:1016
channel_layout.h
buffer
the frame and frame reference mechanism is intended to as much as expensive copies of that data while still allowing the filters to produce correct results The data is stored in buffers represented by AVFrame structures Several references can point to the same frame buffer
Definition: filter_design.txt:49
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Underlying C type is int.
Definition: opt.h:259
avfilter.h
HaasContext::balance_r
double balance_r[2]
Definition: af_haas.c:53
HaasContext::par_gain0
double par_gain0
Definition: af_haas.c:41
AVFilterContext
An instance of a filter.
Definition: avfilter.h:457
mem.h
audio.h
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_haas.c:204
inputs
static const AVFilterPad inputs[]
Definition: af_haas.c:212
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Underlying C type is int.
Definition: opt.h:327
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
HaasContext::phase1
double phase1
Definition: af_haas.c:55
HaasContext::par_phase0
int par_phase0
Definition: af_haas.c:37
haas_options
static const AVOption haas_options[]
Definition: af_haas.c:61
HaasContext
Definition: af_haas.c:31
HaasContext::buffer_size
size_t buffer_size
Definition: af_haas.c:49
AV_SAMPLE_FMT_DBL
@ AV_SAMPLE_FMT_DBL
double
Definition: samplefmt.h:61
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Special option type for declaring named constants.
Definition: opt.h:299
HaasContext::par_gain1
double par_gain1
Definition: af_haas.c:42
HaasContext::level_in
double level_in
Definition: af_haas.c:45
src
#define src
Definition: vp8dsp.c:248
Generated on Thu Nov 7 2024 19:22:17 for FFmpeg by   doxygen 1.8.17