FFmpeg
af_asubboost.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
20 #include "libavutil/ffmath.h"
21 #include "libavutil/opt.h"
22 #include "avfilter.h"
23 #include "audio.h"
24 #include "formats.h"
25 
26 typedef struct ASubBoostContext {
27  const AVClass *class;
28 
29  double dry_gain;
30  double wet_gain;
31  double feedback;
32  double decay;
33  double delay;
34  double cutoff;
35  double slope;
36 
37  double a0, a1, a2;
38  double b0, b1, b2;
39 
40  int *write_pos;
42 
46 
48 {
51  static const enum AVSampleFormat sample_fmts[] = {
54  };
55  int ret;
56 
58  if (!formats)
59  return AVERROR(ENOMEM);
61  if (ret < 0)
62  return ret;
63 
65  if (!layouts)
66  return AVERROR(ENOMEM);
67 
69  if (ret < 0)
70  return ret;
71 
74 }
75 
77 {
78  ASubBoostContext *s = ctx->priv;
79  AVFilterLink *inlink = ctx->inputs[0];
80  double w0 = 2 * M_PI * s->cutoff / inlink->sample_rate;
81  double alpha = sin(w0) / 2 * sqrt(2. * (1. / s->slope - 1.) + 2.);
82 
83  s->a0 = 1 + alpha;
84  s->a1 = -2 * cos(w0);
85  s->a2 = 1 - alpha;
86  s->b0 = (1 - cos(w0)) / 2;
87  s->b1 = 1 - cos(w0);
88  s->b2 = (1 - cos(w0)) / 2;
89 
90  s->a1 /= s->a0;
91  s->a2 /= s->a0;
92  s->b0 /= s->a0;
93  s->b1 /= s->a0;
94  s->b2 /= s->a0;
95 
96  s->buffer_samples = inlink->sample_rate * s->delay / 1000;
97 
98  return 0;
99 }
100 
102 {
103  AVFilterContext *ctx = inlink->dst;
104  ASubBoostContext *s = ctx->priv;
105 
106  s->buffer = ff_get_audio_buffer(inlink, inlink->sample_rate / 10);
107  s->w = ff_get_audio_buffer(inlink, 2);
108  s->write_pos = av_calloc(inlink->channels, sizeof(*s->write_pos));
109  if (!s->buffer || !s->w || !s->write_pos)
110  return AVERROR(ENOMEM);
111 
112  return get_coeffs(ctx);
113 }
114 
115 typedef struct ThreadData {
116  AVFrame *in, *out;
117 } ThreadData;
118 
119 static int filter_channels(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
120 {
121  ASubBoostContext *s = ctx->priv;
122  ThreadData *td = arg;
123  AVFrame *out = td->out;
124  AVFrame *in = td->in;
125  const double mix = ctx->is_disabled ? 0. : 1.;
126  const double wet = ctx->is_disabled ? 1. : s->wet_gain;
127  const double dry = ctx->is_disabled ? 1. : s->dry_gain;
128  const double feedback = s->feedback, decay = s->decay;
129  const double b0 = s->b0;
130  const double b1 = s->b1;
131  const double b2 = s->b2;
132  const double a1 = -s->a1;
133  const double a2 = -s->a2;
134  const int start = (in->channels * jobnr) / nb_jobs;
135  const int end = (in->channels * (jobnr+1)) / nb_jobs;
136  const int buffer_samples = s->buffer_samples;
137 
138  for (int ch = start; ch < end; ch++) {
139  const double *src = (const double *)in->extended_data[ch];
140  double *dst = (double *)out->extended_data[ch];
141  double *buffer = (double *)s->buffer->extended_data[ch];
142  double *w = (double *)s->w->extended_data[ch];
143  int write_pos = s->write_pos[ch];
144 
145  for (int n = 0; n < in->nb_samples; n++) {
146  double out_sample;
147 
148  out_sample = src[n] * b0 + w[0];
149  w[0] = b1 * src[n] + w[1] + a1 * out_sample;
150  w[1] = b2 * src[n] + a2 * out_sample;
151 
152  buffer[write_pos] = buffer[write_pos] * decay + out_sample * feedback;
153  dst[n] = (src[n] * dry + buffer[write_pos] * mix) * wet;
154 
155  if (++write_pos >= buffer_samples)
156  write_pos = 0;
157  }
158 
159  s->write_pos[ch] = write_pos;
160  }
161 
162  return 0;
163 }
164 
166 {
167  AVFilterContext *ctx = inlink->dst;
168  AVFilterLink *outlink = ctx->outputs[0];
169  ThreadData td;
170  AVFrame *out;
171 
172  if (av_frame_is_writable(in)) {
173  out = in;
174  } else {
175  out = ff_get_audio_buffer(outlink, in->nb_samples);
176  if (!out) {
177  av_frame_free(&in);
178  return AVERROR(ENOMEM);
179  }
181  }
182 
183  td.in = in; td.out = out;
184  ctx->internal->execute(ctx, filter_channels, &td, NULL, FFMIN(inlink->channels,
186 
187  if (out != in)
188  av_frame_free(&in);
189  return ff_filter_frame(outlink, out);
190 }
191 
193 {
194  ASubBoostContext *s = ctx->priv;
195 
196  av_frame_free(&s->buffer);
197  av_frame_free(&s->w);
198  av_freep(&s->write_pos);
199 }
200 
201 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
202  char *res, int res_len, int flags)
203 {
204  int ret;
205 
206  ret = ff_filter_process_command(ctx, cmd, args, res, res_len, flags);
207  if (ret < 0)
208  return ret;
209 
210  return get_coeffs(ctx);
211 }
212 
213 #define OFFSET(x) offsetof(ASubBoostContext, x)
214 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
215 
216 static const AVOption asubboost_options[] = {
217  { "dry", "set dry gain", OFFSET(dry_gain), AV_OPT_TYPE_DOUBLE, {.dbl=0.7}, 0, 1, FLAGS },
218  { "wet", "set wet gain", OFFSET(wet_gain), AV_OPT_TYPE_DOUBLE, {.dbl=0.7}, 0, 1, FLAGS },
219  { "decay", "set decay", OFFSET(decay), AV_OPT_TYPE_DOUBLE, {.dbl=0.7}, 0, 1, FLAGS },
220  { "feedback", "set feedback", OFFSET(feedback), AV_OPT_TYPE_DOUBLE, {.dbl=0.9}, 0, 1, FLAGS },
221  { "cutoff", "set cutoff", OFFSET(cutoff), AV_OPT_TYPE_DOUBLE, {.dbl=100}, 50, 900, FLAGS },
222  { "slope", "set slope", OFFSET(slope), AV_OPT_TYPE_DOUBLE, {.dbl=0.5}, 0.0001, 1, FLAGS },
223  { "delay", "set delay", OFFSET(delay), AV_OPT_TYPE_DOUBLE, {.dbl=20}, 1, 100, FLAGS },
224  { NULL }
225 };
226 
227 AVFILTER_DEFINE_CLASS(asubboost);
228 
229 static const AVFilterPad inputs[] = {
230  {
231  .name = "default",
232  .type = AVMEDIA_TYPE_AUDIO,
233  .filter_frame = filter_frame,
234  .config_props = config_input,
235  },
236  { NULL }
237 };
238 
239 static const AVFilterPad outputs[] = {
240  {
241  .name = "default",
242  .type = AVMEDIA_TYPE_AUDIO,
243  },
244  { NULL }
245 };
246 
248  .name = "asubboost",
249  .description = NULL_IF_CONFIG_SMALL("Boost subwoofer frequencies."),
250  .query_formats = query_formats,
251  .priv_size = sizeof(ASubBoostContext),
252  .priv_class = &asubboost_class,
253  .uninit = uninit,
254  .inputs = inputs,
255  .outputs = outputs,
259 };
formats
formats
Definition: signature.h:48
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:86
AVFilterChannelLayouts
A list of supported channel layouts.
Definition: formats.h:86
td
#define td
Definition: regdef.h:70
mix
static int mix(int c0, int c1)
Definition: 4xm.c:716
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
ASubBoostContext::write_pos
int * write_pos
Definition: af_asubboost.c:40
ff_make_format_list
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:286
inputs
static const AVFilterPad inputs[]
Definition: af_asubboost.c:229
out
FILE * out
Definition: movenc.c:54
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:978
sample_fmts
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:953
layouts
enum MovChannelLayoutTag * layouts
Definition: mov_chan.c:434
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
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:111
ff_all_channel_counts
AVFilterChannelLayouts * ff_all_channel_counts(void)
Construct an AVFilterChannelLayouts coding for any channel layout, with known or unknown disposition.
Definition: formats.c:429
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
process_command
static int process_command(AVFilterContext *ctx, const char *cmd, const char *args, char *res, int res_len, int flags)
Definition: af_asubboost.c:201
w
uint8_t w
Definition: llviddspenc.c:39
AVOption
AVOption.
Definition: opt.h:248
ASubBoostContext::buffer_samples
int buffer_samples
Definition: af_asubboost.c:41
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:149
ThreadData::out
AVFrame * out
Definition: af_adeclick.c:502
AVFormatContext::internal
AVFormatInternal * internal
An opaque field for libavformat internal usage.
Definition: avformat.h:1577
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:65
formats.h
ASubBoostContext::b1
double b1
Definition: af_asubboost.c:38
ASubBoostContext::w
AVFrame * w
Definition: af_asubboost.c:43
b1
static double b1(void *priv, double x, double y)
Definition: vf_xfade.c:1665
config_input
static int config_input(AVFilterLink *inlink)
Definition: af_asubboost.c:101
outputs
static const AVFilterPad outputs[]
Definition: af_asubboost.c:239
ASubBoostContext::a2
double a2
Definition: af_asubboost.c:37
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: af_asubboost.c:47
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:54
a1
#define a1
Definition: regdef.h:47
av_cold
#define av_cold
Definition: attributes.h:90
ff_set_common_formats
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:580
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(asubboost)
ASubBoostContext
Definition: af_asubboost.c:26
s
#define s(width, name)
Definition: cbs_vp9.c:257
AVFrame::channels
int channels
number of audio channels, only used for audio.
Definition: frame.h:592
AV_OPT_TYPE_DOUBLE
@ AV_OPT_TYPE_DOUBLE
Definition: opt.h:227
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
ASubBoostContext::wet_gain
double wet_gain
Definition: af_asubboost.c:30
ctx
AVFormatContext * ctx
Definition: movenc.c:48
ASubBoostContext::feedback
double feedback
Definition: af_asubboost.c:31
arg
const char * arg
Definition: jacosubdec.c:67
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:67
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:536
ASubBoostContext::b2
double b2
Definition: af_asubboost.c:38
src
#define src
Definition: vp8dsp.c:255
ASubBoostContext::delay
double delay
Definition: af_asubboost.c:33
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: af_asubboost.c:165
FLAGS
#define FLAGS
Definition: af_asubboost.c:214
get_coeffs
static int get_coeffs(AVFilterContext *ctx)
Definition: af_asubboost.c:76
asubboost_options
static const AVOption asubboost_options[]
Definition: af_asubboost.c:216
ASubBoostContext::a0
double a0
Definition: af_asubboost.c:37
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:117
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:59
av_frame_is_writable
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:472
ff_filter_process_command
int ff_filter_process_command(AVFilterContext *ctx, const char *cmd, const char *arg, char *res, int res_len, int flags)
Generic processing of user supplied commands that are set in the same way as the filter options.
Definition: avfilter.c:842
b2
static double b2(void *priv, double x, double y)
Definition: vf_xfade.c:1666
FFMIN
#define FFMIN(a, b)
Definition: common.h:105
ASubBoostContext::b0
double b0
Definition: af_asubboost.c:38
ASubBoostContext::dry_gain
double dry_gain
Definition: af_asubboost.c:29
OFFSET
#define OFFSET(x)
Definition: af_asubboost.c:213
M_PI
#define M_PI
Definition: mathematics.h:52
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:369
ASubBoostContext::a1
double a1
Definition: af_asubboost.c:37
AVFrame::extended_data
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:350
a2
#define a2
Definition: regdef.h:48
ff_filter_get_nb_threads
int ff_filter_get_nb_threads(AVFilterContext *ctx)
Get number of threads for current filter instance.
Definition: avfilter.c:762
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
ThreadData
Used for passing data between threads.
Definition: dsddec.c:67
ASubBoostContext::decay
double decay
Definition: af_asubboost.c:32
ff_af_asubboost
const AVFilter ff_af_asubboost
Definition: af_asubboost.c:247
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
filter_channels
static int filter_channels(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
Definition: af_asubboost.c:119
AVFilter
Filter definition.
Definition: avfilter.h:145
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_asubboost.c:192
ret
ret
Definition: filter_design.txt:187
ff_all_samplerates
AVFilterFormats * ff_all_samplerates(void)
Definition: formats.c:414
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Non-inlined equivalent of av_mallocz_array().
Definition: mem.c:251
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
avfilter.h
AV_SAMPLE_FMT_DBLP
@ AV_SAMPLE_FMT_DBLP
double, planar
Definition: samplefmt.h:70
ffmath.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:333
AVFILTER_FLAG_SLICE_THREADS
#define AVFILTER_FLAG_SLICE_THREADS
The filter supports multithreading by splitting frames into multiple parts and processing them concur...
Definition: avfilter.h:117
audio.h
ThreadData::in
AVFrame * in
Definition: af_adenorm.c:223
alpha
static const int16_t alpha[]
Definition: ilbcdata.h:55
ASubBoostContext::buffer
AVFrame * buffer
Definition: af_asubboost.c:44
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
ASubBoostContext::slope
double slope
Definition: af_asubboost.c:35
AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL
#define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL
Same as AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, except that the filter will have its filter_frame() c...
Definition: avfilter.h:134
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
ff_set_common_samplerates
int ff_set_common_samplerates(AVFilterContext *ctx, AVFilterFormats *samplerates)
Definition: formats.c:568
b0
static double b0(void *priv, double x, double y)
Definition: vf_xfade.c:1664
ASubBoostContext::cutoff
double cutoff
Definition: af_asubboost.c:34
ff_set_common_channel_layouts
int ff_set_common_channel_layouts(AVFilterContext *ctx, AVFilterChannelLayouts *channel_layouts)
A helper for query_formats() which sets all links to the same list of channel layouts/sample rates.
Definition: formats.c:561