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/opt.h"
25 #include "avfilter.h"
26 #include "audio.h"
27 
28 typedef struct DeesserChannel {
29  double s1, s2, s3;
30  double m1, m2;
31  double ratioA, ratioB;
33  int flip;
35 
36 typedef struct DeesserContext {
37  const AVClass *class;
38 
39  double intensity;
40  double max;
41  double frequency;
42  int mode;
43 
46 
47 enum OutModes {
52 };
53 
54 #define OFFSET(x) offsetof(DeesserContext, x)
55 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
56 
57 static const AVOption deesser_options[] = {
58  { "i", "set intensity", OFFSET(intensity), AV_OPT_TYPE_DOUBLE, {.dbl=0.0}, 0.0, 1.0, A },
59  { "m", "set max deessing", OFFSET(max), AV_OPT_TYPE_DOUBLE, {.dbl=0.5}, 0.0, 1.0, A },
60  { "f", "set frequency", OFFSET(frequency), AV_OPT_TYPE_DOUBLE, {.dbl=0.5}, 0.0, 1.0, A },
61  { "s", "set output mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=OUT_MODE}, 0, NB_MODES-1, A, .unit = "mode" },
62  { "i", "input", 0, AV_OPT_TYPE_CONST, {.i64=IN_MODE}, 0, 0, A, .unit = "mode" },
63  { "o", "output", 0, AV_OPT_TYPE_CONST, {.i64=OUT_MODE}, 0, 0, A, .unit = "mode" },
64  { "e", "ess", 0, AV_OPT_TYPE_CONST, {.i64=ESS_MODE}, 0, 0, A, .unit = "mode" },
65  { NULL }
66 };
67 
68 AVFILTER_DEFINE_CLASS(deesser);
69 
71 {
72  AVFilterContext *ctx = inlink->dst;
73  DeesserContext *s = ctx->priv;
74 
75  s->chan = av_calloc(inlink->ch_layout.nb_channels, sizeof(*s->chan));
76  if (!s->chan)
77  return AVERROR(ENOMEM);
78 
79  for (int i = 0; i < inlink->ch_layout.nb_channels; i++) {
80  DeesserChannel *chan = &s->chan[i];
81 
82  chan->ratioA = chan->ratioB = 1.0;
83  }
84 
85  return 0;
86 }
87 
89 {
90  AVFilterContext *ctx = inlink->dst;
91  AVFilterLink *outlink = ctx->outputs[0];
92  DeesserContext *s = ctx->priv;
93  AVFrame *out;
94 
95  if (av_frame_is_writable(in)) {
96  out = in;
97  } else {
98  out = ff_get_audio_buffer(outlink, in->nb_samples);
99  if (!out) {
100  av_frame_free(&in);
101  return AVERROR(ENOMEM);
102  }
104  }
105 
106  for (int ch = 0; ch < inlink->ch_layout.nb_channels; ch++) {
107  DeesserChannel *dec = &s->chan[ch];
108  double *src = (double *)in->extended_data[ch];
109  double *dst = (double *)out->extended_data[ch];
110  double overallscale = inlink->sample_rate < 44100 ? 44100.0 / inlink->sample_rate : inlink->sample_rate / 44100.0;
111  double intensity = pow(s->intensity, 5) * (8192 / overallscale);
112  double maxdess = 1.0 / pow(10.0, ((s->max - 1.0) * 48.0) / 20);
113  double iirAmount = pow(s->frequency, 2) / overallscale;
114  double offset;
115  double sense;
116  double recovery;
117  double attackspeed;
118 
119  for (int i = 0; i < in->nb_samples; i++) {
120  double sample = src[i];
121 
122  dec->s3 = dec->s2;
123  dec->s2 = dec->s1;
124  dec->s1 = sample;
125  dec->m1 = (dec->s1 - dec->s2) * ((dec->s1 - dec->s2) / 1.3);
126  dec->m2 = (dec->s2 - dec->s3) * ((dec->s1 - dec->s2) / 1.3);
127  sense = (dec->m1 - dec->m2) * ((dec->m1 - dec->m2) / 1.3);
128  attackspeed = 7.0 + sense * 1024;
129 
130  sense = 1.0 + intensity * intensity * sense;
131  sense = FFMIN(sense, intensity);
132  recovery = 1.0 + (0.01 / sense);
133 
134  offset = 1.0 - fabs(sample);
135 
136  if (dec->flip) {
137  dec->iirSampleA = (dec->iirSampleA * (1.0 - (offset * iirAmount))) +
138  (sample * (offset * iirAmount));
139  if (dec->ratioA < sense) {
140  dec->ratioA = ((dec->ratioA * attackspeed) + sense) / (attackspeed + 1.0);
141  } else {
142  dec->ratioA = 1.0 + ((dec->ratioA - 1.0) / recovery);
143  }
144 
145  dec->ratioA = FFMIN(dec->ratioA, maxdess);
146  sample = dec->iirSampleA + ((sample - dec->iirSampleA) / dec->ratioA);
147  } else {
148  dec->iirSampleB = (dec->iirSampleB * (1.0 - (offset * iirAmount))) +
149  (sample * (offset * iirAmount));
150  if (dec->ratioB < sense) {
151  dec->ratioB = ((dec->ratioB * attackspeed) + sense) / (attackspeed + 1.0);
152  } else {
153  dec->ratioB = 1.0 + ((dec->ratioB - 1.0) / recovery);
154  }
155 
156  dec->ratioB = FFMIN(dec->ratioB, maxdess);
157  sample = dec->iirSampleB + ((sample - dec->iirSampleB) / dec->ratioB);
158  }
159 
160  dec->flip = !dec->flip;
161 
162  if (ctx->is_disabled)
163  sample = src[i];
164 
165  switch (s->mode) {
166  case IN_MODE: dst[i] = src[i]; break;
167  case OUT_MODE: dst[i] = sample; break;
168  case ESS_MODE: dst[i] = src[i] - sample; break;
169  }
170  }
171  }
172 
173  if (out != in)
174  av_frame_free(&in);
175 
176  return ff_filter_frame(outlink, out);
177 }
178 
180 {
181  DeesserContext *s = ctx->priv;
182 
183  av_freep(&s->chan);
184 }
185 
186 static const AVFilterPad inputs[] = {
187  {
188  .name = "default",
189  .type = AVMEDIA_TYPE_AUDIO,
190  .filter_frame = filter_frame,
191  .config_props = config_input,
192  },
193 };
194 
196  .name = "deesser",
197  .description = NULL_IF_CONFIG_SMALL("Apply de-essing to the audio."),
198  .priv_size = sizeof(DeesserContext),
199  .priv_class = &deesser_class,
200  .uninit = uninit,
205 };
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:97
DeesserChannel::s1
double s1
Definition: af_deesser.c:29
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:54
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
FILTER_SINGLE_SAMPLEFMT
#define FILTER_SINGLE_SAMPLEFMT(sample_fmt_)
Definition: internal.h:175
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:160
OutModes
OutModes
Definition: af_aap.c:32
config_input
static int config_input(AVFilterLink *inlink)
Definition: af_deesser.c:70
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:375
AVOption
AVOption.
Definition: opt.h:346
max
#define max(a, b)
Definition: cuda_runtime.h:33
DeesserChannel::ratioB
double ratioB
Definition: af_deesser.c:31
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_deesser.c:179
NB_MODES
@ NB_MODES
Definition: af_deesser.c:51
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:170
DeesserContext::max
double max
Definition: af_deesser.c:40
DeesserChannel::m1
double m1
Definition: af_deesser.c:30
IN_MODE
@ IN_MODE
Definition: af_deesser.c:48
DeesserContext::frequency
double frequency
Definition: af_deesser.c:41
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: af_deesser.c:88
DeesserChannel::s2
double s2
Definition: af_deesser.c:29
DeesserChannel::m2
double m2
Definition: af_deesser.c:30
DeesserContext::mode
int mode
Definition: af_deesser.c:42
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:33
av_cold
#define av_cold
Definition: attributes.h:90
inputs
static const AVFilterPad inputs[]
Definition: af_deesser.c:186
DeesserChannel::iirSampleB
double iirSampleB
Definition: af_deesser.c:32
DeesserChannel::ratioA
double ratioA
Definition: af_deesser.c:31
s
#define s(width, name)
Definition: cbs_vp9.c:198
AV_OPT_TYPE_DOUBLE
@ AV_OPT_TYPE_DOUBLE
Definition: opt.h:237
A
#define A
Definition: af_deesser.c:55
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
ctx
AVFormatContext * ctx
Definition: movenc.c:48
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:182
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
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:709
deesser_options
static const AVOption deesser_options[]
Definition: af_deesser.c:57
DeesserChannel::flip
int flip
Definition: af_deesser.c:33
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:33
DeesserContext::chan
DeesserChannel * chan
Definition: af_deesser.c:44
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:106
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:645
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:32
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:455
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:255
AVFrame::extended_data
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:436
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:39
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:262
OFFSET
#define OFFSET(x)
Definition: af_deesser.c:54
AVFilter
Filter definition.
Definition: avfilter.h:166
DeesserChannel::s3
double s3
Definition: af_deesser.c:29
ff_af_deesser
const AVFilter ff_af_deesser
Definition: af_deesser.c:195
channel_layout.h
OUT_MODE
@ OUT_MODE
Definition: af_deesser.c:49
mode
mode
Definition: ebur128.h:83
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:235
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:407
audio.h
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(deesser)
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:183
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
ESS_MODE
@ ESS_MODE
Definition: af_deesser.c:50
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:155
DeesserContext::intensity
double intensity
Definition: af_deesser.c:39
DeesserContext
Definition: af_deesser.c:36
DeesserChannel
Definition: af_deesser.c:28
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:244