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 #include "formats.h"
28 
29 typedef struct DeesserChannel {
30  double s1, s2, s3;
31  double m1, m2;
32  double ratioA, ratioB;
34  int flip;
36 
37 typedef struct DeesserContext {
38  const AVClass *class;
39 
40  double intensity;
41  double max;
42  double frequency;
43  int mode;
44 
47 
48 enum OutModes {
53 };
54 
55 #define OFFSET(x) offsetof(DeesserContext, x)
56 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
57 
58 static const AVOption deesser_options[] = {
59  { "i", "set intensity", OFFSET(intensity), AV_OPT_TYPE_DOUBLE, {.dbl=0.0}, 0.0, 1.0, A },
60  { "m", "set max deessing", OFFSET(max), AV_OPT_TYPE_DOUBLE, {.dbl=0.5}, 0.0, 1.0, A },
61  { "f", "set frequency", OFFSET(frequency), AV_OPT_TYPE_DOUBLE, {.dbl=0.5}, 0.0, 1.0, A },
62  { "s", "set output mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=OUT_MODE}, 0, NB_MODES-1, A, "mode" },
63  { "i", "input", 0, AV_OPT_TYPE_CONST, {.i64=IN_MODE}, 0, 0, A, "mode" },
64  { "o", "output", 0, AV_OPT_TYPE_CONST, {.i64=OUT_MODE}, 0, 0, A, "mode" },
65  { "e", "ess", 0, AV_OPT_TYPE_CONST, {.i64=ESS_MODE}, 0, 0, A, "mode" },
66  { NULL }
67 };
68 
69 AVFILTER_DEFINE_CLASS(deesser);
70 
72 {
75  static const enum AVSampleFormat sample_fmts[] = {
78  };
79  int ret;
80 
82  if (!formats)
83  return AVERROR(ENOMEM);
85  if (ret < 0)
86  return ret;
87 
89  if (!layouts)
90  return AVERROR(ENOMEM);
91 
93  if (ret < 0)
94  return ret;
95 
98 }
99 
101 {
102  AVFilterContext *ctx = inlink->dst;
103  DeesserContext *s = ctx->priv;
104 
105  s->chan = av_calloc(inlink->channels, sizeof(*s->chan));
106  if (!s->chan)
107  return AVERROR(ENOMEM);
108 
109  for (int i = 0; i < inlink->channels; i++) {
110  DeesserChannel *chan = &s->chan[i];
111 
112  chan->ratioA = chan->ratioB = 1.0;
113  }
114 
115  return 0;
116 }
117 
119 {
120  AVFilterContext *ctx = inlink->dst;
121  AVFilterLink *outlink = ctx->outputs[0];
122  DeesserContext *s = ctx->priv;
123  AVFrame *out;
124 
125  if (av_frame_is_writable(in)) {
126  out = in;
127  } else {
128  out = ff_get_audio_buffer(outlink, in->nb_samples);
129  if (!out) {
130  av_frame_free(&in);
131  return AVERROR(ENOMEM);
132  }
134  }
135 
136  for (int ch = 0; ch < inlink->channels; ch++) {
137  DeesserChannel *dec = &s->chan[ch];
138  double *src = (double *)in->extended_data[ch];
139  double *dst = (double *)out->extended_data[ch];
140  double overallscale = inlink->sample_rate < 44100 ? 44100.0 / inlink->sample_rate : inlink->sample_rate / 44100.0;
141  double intensity = pow(s->intensity, 5) * (8192 / overallscale);
142  double maxdess = 1.0 / pow(10.0, ((s->max - 1.0) * 48.0) / 20);
143  double iirAmount = pow(s->frequency, 2) / overallscale;
144  double offset;
145  double sense;
146  double recovery;
147  double attackspeed;
148 
149  for (int i = 0; i < in->nb_samples; i++) {
150  double sample = src[i];
151 
152  dec->s3 = dec->s2;
153  dec->s2 = dec->s1;
154  dec->s1 = sample;
155  dec->m1 = (dec->s1 - dec->s2) * ((dec->s1 - dec->s2) / 1.3);
156  dec->m2 = (dec->s2 - dec->s3) * ((dec->s1 - dec->s2) / 1.3);
157  sense = (dec->m1 - dec->m2) * ((dec->m1 - dec->m2) / 1.3);
158  attackspeed = 7.0 + sense * 1024;
159 
160  sense = 1.0 + intensity * intensity * sense;
161  sense = FFMIN(sense, intensity);
162  recovery = 1.0 + (0.01 / sense);
163 
164  offset = 1.0 - fabs(sample);
165 
166  if (dec->flip) {
167  dec->iirSampleA = (dec->iirSampleA * (1.0 - (offset * iirAmount))) +
168  (sample * (offset * iirAmount));
169  if (dec->ratioA < sense) {
170  dec->ratioA = ((dec->ratioA * attackspeed) + sense) / (attackspeed + 1.0);
171  } else {
172  dec->ratioA = 1.0 + ((dec->ratioA - 1.0) / recovery);
173  }
174 
175  dec->ratioA = FFMIN(dec->ratioA, maxdess);
176  sample = dec->iirSampleA + ((sample - dec->iirSampleA) / dec->ratioA);
177  } else {
178  dec->iirSampleB = (dec->iirSampleB * (1.0 - (offset * iirAmount))) +
179  (sample * (offset * iirAmount));
180  if (dec->ratioB < sense) {
181  dec->ratioB = ((dec->ratioB * attackspeed) + sense) / (attackspeed + 1.0);
182  } else {
183  dec->ratioB = 1.0 + ((dec->ratioB - 1.0) / recovery);
184  }
185 
186  dec->ratioB = FFMIN(dec->ratioB, maxdess);
187  sample = dec->iirSampleB + ((sample - dec->iirSampleB) / dec->ratioB);
188  }
189 
190  dec->flip = !dec->flip;
191 
192  if (ctx->is_disabled)
193  sample = src[i];
194 
195  switch (s->mode) {
196  case IN_MODE: dst[i] = src[i]; break;
197  case OUT_MODE: dst[i] = sample; break;
198  case ESS_MODE: dst[i] = src[i] - sample; break;
199  }
200  }
201  }
202 
203  if (out != in)
204  av_frame_free(&in);
205 
206  return ff_filter_frame(outlink, out);
207 }
208 
210 {
211  DeesserContext *s = ctx->priv;
212 
213  av_freep(&s->chan);
214 }
215 
216 static const AVFilterPad inputs[] = {
217  {
218  .name = "default",
219  .type = AVMEDIA_TYPE_AUDIO,
220  .filter_frame = filter_frame,
221  .config_props = config_input,
222  },
223  { NULL }
224 };
225 
226 static const AVFilterPad outputs[] = {
227  {
228  .name = "default",
229  .type = AVMEDIA_TYPE_AUDIO,
230  },
231  { NULL }
232 };
233 
235  .name = "deesser",
236  .description = NULL_IF_CONFIG_SMALL("Apply de-essing to the audio."),
237  .query_formats = query_formats,
238  .priv_size = sizeof(DeesserContext),
239  .priv_class = &deesser_class,
240  .uninit = uninit,
241  .inputs = inputs,
242  .outputs = outputs,
244 };
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
DeesserChannel::s1
double s1
Definition: af_deesser.c:30
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
ff_make_format_list
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:286
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
config_input
static int config_input(AVFilterLink *inlink)
Definition: af_deesser.c:100
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
AVOption
AVOption.
Definition: opt.h:248
max
#define max(a, b)
Definition: cuda_runtime.h:33
DeesserChannel::ratioB
double ratioB
Definition: af_deesser.c:32
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_deesser.c:209
NB_MODES
@ NB_MODES
Definition: af_deesser.c:52
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:149
DeesserContext::max
double max
Definition: af_deesser.c:41
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: af_deesser.c:71
DeesserChannel::m1
double m1
Definition: af_deesser.c:31
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:65
formats.h
IN_MODE
@ IN_MODE
Definition: af_deesser.c:49
DeesserContext::frequency
double frequency
Definition: af_deesser.c:42
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: af_deesser.c:118
DeesserChannel::s2
double s2
Definition: af_deesser.c:30
DeesserChannel::m2
double m2
Definition: af_deesser.c:31
DeesserContext::mode
int mode
Definition: af_deesser.c:43
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:54
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
inputs
static const AVFilterPad inputs[]
Definition: af_deesser.c:216
DeesserChannel::iirSampleB
double iirSampleB
Definition: af_deesser.c:33
DeesserChannel::ratioA
double ratioA
Definition: af_deesser.c:32
s
#define s(width, name)
Definition: cbs_vp9.c:257
outputs
static const AVFilterPad outputs[]
Definition: af_deesser.c:226
AV_OPT_TYPE_DOUBLE
@ AV_OPT_TYPE_DOUBLE
Definition: opt.h:227
A
#define A
Definition: af_deesser.c:56
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:67
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:536
deesser_options
static const AVOption deesser_options[]
Definition: af_deesser.c:58
DeesserChannel::flip
int flip
Definition: af_deesser.c:34
src
#define src
Definition: vp8dsp.c:255
DeesserContext::chan
DeesserChannel * chan
Definition: af_deesser.c:45
OutModes
OutModes
Definition: af_afftdn.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
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:472
FFMIN
#define FFMIN(a, b)
Definition: common.h:105
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:33
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:369
i
int i
Definition: input.c:407
AVFrame::extended_data
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:350
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
OFFSET
#define OFFSET(x)
Definition: af_deesser.c:55
AVFilter
Filter definition.
Definition: avfilter.h:145
ret
ret
Definition: filter_design.txt:187
DeesserChannel::s3
double s3
Definition: af_deesser.c:30
ff_af_deesser
const AVFilter ff_af_deesser
Definition: af_deesser.c:234
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:252
channel_layout.h
OUT_MODE
@ OUT_MODE
Definition: af_deesser.c:50
mode
mode
Definition: ebur128.h:83
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
avfilter.h
AV_SAMPLE_FMT_DBLP
@ AV_SAMPLE_FMT_DBLP
double, planar
Definition: samplefmt.h:70
AVFilterContext
An instance of a filter.
Definition: avfilter.h:333
audio.h
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(deesser)
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
ESS_MODE
@ ESS_MODE
Definition: af_deesser.c:51
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
DeesserContext::intensity
double intensity
Definition: af_deesser.c:40
DeesserContext
Definition: af_deesser.c:37
ff_set_common_samplerates
int ff_set_common_samplerates(AVFilterContext *ctx, AVFilterFormats *samplerates)
Definition: formats.c:568
DeesserChannel
Definition: af_deesser.c:29
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:234
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