FFmpeg
af_compensationdelay.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2001-2010 Krzysztof Foltman, Markus Schmidt, Thor Harald Johansen, Vladimir Sadovnikov and others
3  * Copyright (c) 2015 Paul B Mahol
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 #include "libavutil/opt.h"
23 #include "libavutil/samplefmt.h"
24 #include "avfilter.h"
25 #include "audio.h"
26 #include "internal.h"
27 
28 typedef struct CompensationDelayContext {
29  const AVClass *class;
33  double dry, wet;
34  int temp;
35 
36  unsigned delay;
37  unsigned w_ptr;
38  unsigned buf_size;
41 
42 #define OFFSET(x) offsetof(CompensationDelayContext, x)
43 #define A (AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM)
44 
46  { "mm", "set mm distance", OFFSET(distance_mm), AV_OPT_TYPE_INT, {.i64=0}, 0, 10, A },
47  { "cm", "set cm distance", OFFSET(distance_cm), AV_OPT_TYPE_INT, {.i64=0}, 0, 100, A },
48  { "m", "set meter distance", OFFSET(distance_m), AV_OPT_TYPE_INT, {.i64=0}, 0, 100, A },
49  { "dry", "set dry amount", OFFSET(dry), AV_OPT_TYPE_DOUBLE, {.dbl=0}, 0, 1, A },
50  { "wet", "set wet amount", OFFSET(wet), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0, 1, A },
51  { "temp", "set temperature °C", OFFSET(temp), AV_OPT_TYPE_INT, {.i64=20}, -50, 50, A },
52  { NULL }
53 };
54 
55 AVFILTER_DEFINE_CLASS(compensationdelay);
56 
57 // The maximum distance for options
58 #define COMP_DELAY_MAX_DISTANCE (100.0 * 100.0 + 100.0 * 1.0 + 1.0)
59 // The actual speed of sound in normal conditions
60 #define COMP_DELAY_SOUND_SPEED_KM_H(temp) 1.85325 * (643.95 * sqrt(((temp + 273.15) / 273.15)))
61 #define COMP_DELAY_SOUND_SPEED_CM_S(temp) (COMP_DELAY_SOUND_SPEED_KM_H(temp) * (1000.0 * 100.0) /* cm/km */ / (60.0 * 60.0) /* s/h */)
62 #define COMP_DELAY_SOUND_FRONT_DELAY(temp) (1.0 / COMP_DELAY_SOUND_SPEED_CM_S(temp))
63 // The maximum delay may be reached by this filter
64 #define COMP_DELAY_MAX_DELAY (COMP_DELAY_MAX_DISTANCE * COMP_DELAY_SOUND_FRONT_DELAY(50))
65 
67 {
68  AVFilterContext *ctx = inlink->dst;
70  unsigned min_size, new_size = 1;
71  int ret;
72 
73  s->delay = (s->distance_m * 100. + s->distance_cm * 1. + s->distance_mm * .1) *
74  COMP_DELAY_SOUND_FRONT_DELAY(s->temp) * inlink->sample_rate;
75  min_size = inlink->sample_rate * COMP_DELAY_MAX_DELAY;
76 
77  while (new_size < min_size)
78  new_size <<= 1;
79 
80  s->delay_frame = av_frame_alloc();
81  if (!s->delay_frame)
82  return AVERROR(ENOMEM);
83 
84  s->buf_size = new_size;
85  s->delay_frame->format = inlink->format;
86  s->delay_frame->nb_samples = new_size;
87 #if FF_API_OLD_CHANNEL_LAYOUT
89  s->delay_frame->channel_layout = inlink->channel_layout;
90  s->delay_frame->channels = inlink->ch_layout.nb_channels;
92 #endif
93  if ((ret = av_channel_layout_copy(&s->delay_frame->ch_layout, &inlink->ch_layout)) < 0)
94  return ret;
95 
96  return av_frame_get_buffer(s->delay_frame, 0);
97 }
98 
100 {
101  AVFilterContext *ctx = inlink->dst;
102  AVFilterLink *outlink = ctx->outputs[0];
103  CompensationDelayContext *s = ctx->priv;
104  const unsigned b_mask = s->buf_size - 1;
105  const unsigned buf_size = s->buf_size;
106  const unsigned delay = s->delay;
107  const double dry = s->dry;
108  const double wet = s->wet;
109  unsigned r_ptr, w_ptr = 0;
110  AVFrame *out;
111  int n, ch;
112 
113  out = ff_get_audio_buffer(outlink, in->nb_samples);
114  if (!out) {
115  av_frame_free(&in);
116  return AVERROR(ENOMEM);
117  }
119 
120  for (ch = 0; ch < inlink->ch_layout.nb_channels; ch++) {
121  const double *src = (const double *)in->extended_data[ch];
122  double *dst = (double *)out->extended_data[ch];
123  double *buffer = (double *)s->delay_frame->extended_data[ch];
124 
125  w_ptr = s->w_ptr;
126  r_ptr = (w_ptr + buf_size - delay) & b_mask;
127 
128  for (n = 0; n < in->nb_samples; n++) {
129  const double sample = src[n];
130 
131  buffer[w_ptr] = sample;
132  dst[n] = dry * sample + wet * buffer[r_ptr];
133  w_ptr = (w_ptr + 1) & b_mask;
134  r_ptr = (r_ptr + 1) & b_mask;
135  }
136  }
137  s->w_ptr = w_ptr;
138 
139  if (ctx->is_disabled) {
140  av_frame_free(&out);
141  return ff_filter_frame(outlink, in);
142  }
143 
144  av_frame_free(&in);
145  return ff_filter_frame(outlink, out);
146 }
147 
148 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
149  char *res, int res_len, int flags)
150 {
151  CompensationDelayContext *s = ctx->priv;
152  AVFilterLink *outlink = ctx->outputs[0];
153  int ret;
154 
155  ret = ff_filter_process_command(ctx, cmd, args, res, res_len, flags);
156  if (ret < 0)
157  return ret;
158 
159  s->delay = (s->distance_m * 100. + s->distance_cm * 1. + s->distance_mm * .1) *
160  COMP_DELAY_SOUND_FRONT_DELAY(s->temp) * outlink->sample_rate;
161 
162  return 0;
163 }
164 
166 {
167  CompensationDelayContext *s = ctx->priv;
168 
169  av_frame_free(&s->delay_frame);
170 }
171 
173  {
174  .name = "default",
175  .type = AVMEDIA_TYPE_AUDIO,
176  .config_props = config_input,
177  .filter_frame = filter_frame,
178  },
179 };
180 
182  {
183  .name = "default",
184  .type = AVMEDIA_TYPE_AUDIO,
185  },
186 };
187 
189  .name = "compensationdelay",
190  .description = NULL_IF_CONFIG_SMALL("Audio Compensation Delay Line."),
191  .priv_size = sizeof(CompensationDelayContext),
192  .priv_class = &compensationdelay_class,
193  .uninit = uninit,
197  .process_command = process_command,
199 };
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:100
FF_ENABLE_DEPRECATION_WARNINGS
#define FF_ENABLE_DEPRECATION_WARNINGS
Definition: internal.h:82
config_input
static int config_input(AVFilterLink *inlink)
Definition: af_compensationdelay.c:66
CompensationDelayContext::distance_mm
int distance_mm
Definition: af_compensationdelay.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
A
#define A
Definition: af_compensationdelay.c:43
out
FILE * out
Definition: movenc.c:54
av_frame_get_buffer
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
Definition: frame.c:259
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1009
ff_af_compensationdelay
const AVFilter ff_af_compensationdelay
Definition: af_compensationdelay.c:188
FILTER_SINGLE_SAMPLEFMT
#define FILTER_SINGLE_SAMPLEFMT(sample_fmt_)
Definition: internal.h:183
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:116
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
compensationdelay_inputs
static const AVFilterPad compensationdelay_inputs[]
Definition: af_compensationdelay.c:172
AVOption
AVOption.
Definition: opt.h:251
compensationdelay_options
static const AVOption compensationdelay_options[]
Definition: af_compensationdelay.c:45
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:175
COMP_DELAY_MAX_DELAY
#define COMP_DELAY_MAX_DELAY
Definition: af_compensationdelay.c:64
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(compensationdelay)
CompensationDelayContext::delay
unsigned delay
Definition: af_compensationdelay.c:36
samplefmt.h
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:49
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:104
av_cold
#define av_cold
Definition: attributes.h:90
s
#define s(width, name)
Definition: cbs_vp9.c:256
AV_OPT_TYPE_DOUBLE
@ AV_OPT_TYPE_DOUBLE
Definition: opt.h:227
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
CompensationDelayContext::distance_m
int distance_m
Definition: af_compensationdelay.c:32
CompensationDelayContext
Definition: af_compensationdelay.c:28
ctx
AVFormatContext * ctx
Definition: movenc.c:48
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:190
CompensationDelayContext::temp
int temp
Definition: af_compensationdelay.c:34
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: af_compensationdelay.c:99
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
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:603
CompensationDelayContext::dry
double dry
Definition: af_compensationdelay.c:33
CompensationDelayContext::delay_frame
AVFrame * delay_frame
Definition: af_compensationdelay.c:39
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:115
compensationdelay_outputs
static const AVFilterPad compensationdelay_outputs[]
Definition: af_compensationdelay.c:181
sample
#define sample
Definition: flacdsp_template.c:44
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:873
CompensationDelayContext::w_ptr
unsigned w_ptr
Definition: af_compensationdelay.c:37
internal.h
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:405
AVFrame::extended_data
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:386
COMP_DELAY_SOUND_FRONT_DELAY
#define COMP_DELAY_SOUND_FRONT_DELAY(temp)
Definition: af_compensationdelay.c:62
CompensationDelayContext::wet
double wet
Definition: af_compensationdelay.c:33
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:55
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_compensationdelay.c:165
AVFilter
Filter definition.
Definition: avfilter.h:171
ret
ret
Definition: filter_design.txt:187
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
Definition: opt.h:225
avfilter.h
AV_SAMPLE_FMT_DBLP
@ AV_SAMPLE_FMT_DBLP
double, planar
Definition: samplefmt.h:67
temp
else temp
Definition: vf_mcdeint.c:248
AVFilterContext
An instance of a filter.
Definition: avfilter.h:415
av_channel_layout_copy
int av_channel_layout_copy(AVChannelLayout *dst, const AVChannelLayout *src)
Make a copy of a channel layout.
Definition: channel_layout.c:639
FF_DISABLE_DEPRECATION_WARNINGS
#define FF_DISABLE_DEPRECATION_WARNINGS
Definition: internal.h:81
audio.h
process_command
static int process_command(AVFilterContext *ctx, const char *cmd, const char *args, char *res, int res_len, int flags)
Definition: af_compensationdelay.c:148
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:191
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
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:160
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
CompensationDelayContext::distance_cm
int distance_cm
Definition: af_compensationdelay.c:31
CompensationDelayContext::buf_size
unsigned buf_size
Definition: af_compensationdelay.c:38
OFFSET
#define OFFSET(x)
Definition: af_compensationdelay.c:42