FFmpeg
af_deesser.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 Chris Johnson
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in all
12  * copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  * SOFTWARE.
21  */
22 
24 #include "libavutil/mem.h"
25 #include "libavutil/opt.h"
26 #include "avfilter.h"
27 #include "audio.h"
28 #include "filters.h"
29 
30 typedef struct DeesserChannel {
31  double s1, s2, s3;
32  double m1, m2;
33  double ratioA, ratioB;
35  int flip;
37 
38 typedef struct DeesserContext {
39  const AVClass *class;
40 
41  double intensity;
42  double max;
43  double frequency;
44  int mode;
45 
48 
49 enum OutModes {
54 };
55 
56 #define OFFSET(x) offsetof(DeesserContext, x)
57 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
58 
59 static const AVOption deesser_options[] = {
60  { "i", "set intensity", OFFSET(intensity), AV_OPT_TYPE_DOUBLE, {.dbl=0.0}, 0.0, 1.0, A },
61  { "m", "set max deessing", OFFSET(max), AV_OPT_TYPE_DOUBLE, {.dbl=0.5}, 0.0, 1.0, A },
62  { "f", "set frequency", OFFSET(frequency), AV_OPT_TYPE_DOUBLE, {.dbl=0.5}, 0.0, 1.0, A },
63  { "s", "set output mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=OUT_MODE}, 0, NB_MODES-1, A, .unit = "mode" },
64  { "i", "input", 0, AV_OPT_TYPE_CONST, {.i64=IN_MODE}, 0, 0, A, .unit = "mode" },
65  { "o", "output", 0, AV_OPT_TYPE_CONST, {.i64=OUT_MODE}, 0, 0, A, .unit = "mode" },
66  { "e", "ess", 0, AV_OPT_TYPE_CONST, {.i64=ESS_MODE}, 0, 0, A, .unit = "mode" },
67  { NULL }
68 };
69 
70 AVFILTER_DEFINE_CLASS(deesser);
71 
73 {
74  AVFilterContext *ctx = inlink->dst;
75  DeesserContext *s = ctx->priv;
76 
77  s->chan = av_calloc(inlink->ch_layout.nb_channels, sizeof(*s->chan));
78  if (!s->chan)
79  return AVERROR(ENOMEM);
80 
81  for (int i = 0; i < inlink->ch_layout.nb_channels; i++) {
82  DeesserChannel *chan = &s->chan[i];
83 
84  chan->ratioA = chan->ratioB = 1.0;
85  }
86 
87  return 0;
88 }
89 
91 {
92  AVFilterContext *ctx = inlink->dst;
93  AVFilterLink *outlink = ctx->outputs[0];
94  DeesserContext *s = ctx->priv;
95  AVFrame *out;
96 
97  if (av_frame_is_writable(in)) {
98  out = in;
99  } else {
100  out = ff_get_audio_buffer(outlink, in->nb_samples);
101  if (!out) {
102  av_frame_free(&in);
103  return AVERROR(ENOMEM);
104  }
106  }
107 
108  for (int ch = 0; ch < inlink->ch_layout.nb_channels; ch++) {
109  DeesserChannel *dec = &s->chan[ch];
110  double *src = (double *)in->extended_data[ch];
111  double *dst = (double *)out->extended_data[ch];
112  double overallscale = inlink->sample_rate < 44100 ? 44100.0 / inlink->sample_rate : inlink->sample_rate / 44100.0;
113  double intensity = pow(s->intensity, 5) * (8192 / overallscale);
114  double maxdess = 1.0 / pow(10.0, ((s->max - 1.0) * 48.0) / 20);
115  double iirAmount = pow(s->frequency, 2) / overallscale;
116  double offset;
117  double sense;
118  double recovery;
119  double attackspeed;
120 
121  for (int i = 0; i < in->nb_samples; i++) {
122  double sample = src[i];
123 
124  dec->s3 = dec->s2;
125  dec->s2 = dec->s1;
126  dec->s1 = sample;
127  dec->m1 = (dec->s1 - dec->s2) * ((dec->s1 - dec->s2) / 1.3);
128  dec->m2 = (dec->s2 - dec->s3) * ((dec->s1 - dec->s2) / 1.3);
129  sense = (dec->m1 - dec->m2) * ((dec->m1 - dec->m2) / 1.3);
130  attackspeed = 7.0 + sense * 1024;
131 
132  sense = 1.0 + intensity * intensity * sense;
133  sense = FFMIN(sense, intensity);
134  recovery = 1.0 + (0.01 / sense);
135 
136  offset = 1.0 - fabs(sample);
137 
138  if (dec->flip) {
139  dec->iirSampleA = (dec->iirSampleA * (1.0 - (offset * iirAmount))) +
140  (sample * (offset * iirAmount));
141  if (dec->ratioA < sense) {
142  dec->ratioA = ((dec->ratioA * attackspeed) + sense) / (attackspeed + 1.0);
143  } else {
144  dec->ratioA = 1.0 + ((dec->ratioA - 1.0) / recovery);
145  }
146 
147  dec->ratioA = FFMIN(dec->ratioA, maxdess);
148  sample = dec->iirSampleA + ((sample - dec->iirSampleA) / dec->ratioA);
149  } else {
150  dec->iirSampleB = (dec->iirSampleB * (1.0 - (offset * iirAmount))) +
151  (sample * (offset * iirAmount));
152  if (dec->ratioB < sense) {
153  dec->ratioB = ((dec->ratioB * attackspeed) + sense) / (attackspeed + 1.0);
154  } else {
155  dec->ratioB = 1.0 + ((dec->ratioB - 1.0) / recovery);
156  }
157 
158  dec->ratioB = FFMIN(dec->ratioB, maxdess);
159  sample = dec->iirSampleB + ((sample - dec->iirSampleB) / dec->ratioB);
160  }
161 
162  dec->flip = !dec->flip;
163 
164  if (ctx->is_disabled)
165  sample = src[i];
166 
167  switch (s->mode) {
168  case IN_MODE: dst[i] = src[i]; break;
169  case OUT_MODE: dst[i] = sample; break;
170  case ESS_MODE: dst[i] = src[i] - sample; break;
171  }
172  }
173  }
174 
175  if (out != in)
176  av_frame_free(&in);
177 
178  return ff_filter_frame(outlink, out);
179 }
180 
182 {
183  DeesserContext *s = ctx->priv;
184 
185  av_freep(&s->chan);
186 }
187 
188 static const AVFilterPad inputs[] = {
189  {
190  .name = "default",
191  .type = AVMEDIA_TYPE_AUDIO,
192  .filter_frame = filter_frame,
193  .config_props = config_input,
194  },
195 };
196 
198  .name = "deesser",
199  .description = NULL_IF_CONFIG_SMALL("Apply de-essing to the audio."),
200  .priv_size = sizeof(DeesserContext),
201  .priv_class = &deesser_class,
202  .uninit = uninit,
207 };
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
DeesserChannel::s1
double s1
Definition: af_deesser.c:31
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
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1061
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:162
OutModes
OutModes
Definition: af_aap.c:32
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: filters.h:262
config_input
static int config_input(AVFilterLink *inlink)
Definition: af_deesser.c:72
mode
Definition: swscale.c:52
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:389
AVOption
AVOption.
Definition: opt.h:429
max
#define max(a, b)
Definition: cuda_runtime.h:33
DeesserChannel::ratioB
double ratioB
Definition: af_deesser.c:33
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_deesser.c:181
NB_MODES
@ NB_MODES
Definition: af_deesser.c:53
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:205
DeesserContext::max
double max
Definition: af_deesser.c:42
DeesserChannel::m1
double m1
Definition: af_deesser.c:32
IN_MODE
@ IN_MODE
Definition: af_deesser.c:50
DeesserContext::frequency
double frequency
Definition: af_deesser.c:43
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: af_deesser.c:90
DeesserChannel::s2
double s2
Definition: af_deesser.c:31
DeesserChannel::m2
double m2
Definition: af_deesser.c:32
DeesserContext::mode
int mode
Definition: af_deesser.c:44
AVFilterPad
A filter pad used for either input or output.
Definition: filters.h:38
av_cold
#define av_cold
Definition: attributes.h:90
inputs
static const AVFilterPad inputs[]
Definition: af_deesser.c:188
DeesserChannel::iirSampleB
double iirSampleB
Definition: af_deesser.c:34
DeesserChannel::ratioA
double ratioA
Definition: af_deesser.c:33
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
A
#define A
Definition: af_deesser.c:57
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
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:75
fabs
static __device__ float fabs(float a)
Definition: cuda_runtime.h:182
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:725
deesser_options
static const AVOption deesser_options[]
Definition: af_deesser.c:59
DeesserChannel::flip
int flip
Definition: af_deesser.c:35
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
DeesserContext::chan
DeesserChannel * chan
Definition: af_deesser.c:46
FILTER_SINGLE_SAMPLEFMT
#define FILTER_SINGLE_SAMPLEFMT(sample_fmt_)
Definition: filters.h:255
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
dst
uint8_t ptrdiff_t const uint8_t ptrdiff_t int intptr_t intptr_t int int16_t * dst
Definition: dsp.h:83
sample
#define sample
Definition: flacdsp_template.c:44
av_frame_is_writable
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:661
offset
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf offset
Definition: writing_filters.txt:86
DeesserChannel::iirSampleA
double iirSampleA
Definition: af_deesser.c:34
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:469
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
AVFrame::extended_data
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:450
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
AVFilterPad::name
const char * name
Pad name.
Definition: filters.h:44
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:264
OFFSET
#define OFFSET(x)
Definition: af_deesser.c:56
AVFilter
Filter definition.
Definition: avfilter.h:201
DeesserChannel::s3
double s3
Definition: af_deesser.c:31
ff_af_deesser
const AVFilter ff_af_deesser
Definition: af_deesser.c:197
channel_layout.h
OUT_MODE
@ OUT_MODE
Definition: af_deesser.c:51
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Underlying C type is int.
Definition: opt.h:259
avfilter.h
AV_SAMPLE_FMT_DBLP
@ AV_SAMPLE_FMT_DBLP
double, planar
Definition: samplefmt.h:67
AVFilterContext
An instance of a filter.
Definition: avfilter.h:457
mem.h
audio.h
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(deesser)
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
ESS_MODE
@ ESS_MODE
Definition: af_deesser.c:52
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:190
DeesserContext::intensity
double intensity
Definition: af_deesser.c:41
DeesserContext
Definition: af_deesser.c:38
DeesserChannel
Definition: af_deesser.c:30
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Special option type for declaring named constants.
Definition: opt.h:299
src
#define src
Definition: vp8dsp.c:248