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
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 {
70  static const enum AVSampleFormat sample_fmts[] = {
73  };
74  int ret;
75 
77  if (!layouts)
78  return AVERROR(ENOMEM);
80  if (ret < 0)
81  return ret;
82 
84  if (!formats)
85  return AVERROR(ENOMEM);
87  if (ret < 0)
88  return ret;
89 
91  if (!formats)
92  return AVERROR(ENOMEM);
94 }
95 
97 {
98  AVFilterContext *ctx = inlink->dst;
100  unsigned min_size, new_size = 1;
101 
102  s->delay = (s->distance_m * 100. + s->distance_cm * 1. + s->distance_mm * .1) *
103  COMP_DELAY_SOUND_FRONT_DELAY(s->temp) * inlink->sample_rate;
104  min_size = inlink->sample_rate * COMP_DELAY_MAX_DELAY;
105 
106  while (new_size < min_size)
107  new_size <<= 1;
108 
109  s->delay_frame = av_frame_alloc();
110  if (!s->delay_frame)
111  return AVERROR(ENOMEM);
112 
113  s->buf_size = new_size;
114  s->delay_frame->format = inlink->format;
115  s->delay_frame->nb_samples = new_size;
116  s->delay_frame->channel_layout = inlink->channel_layout;
117 
118  return av_frame_get_buffer(s->delay_frame, 0);
119 }
120 
122 {
123  AVFilterContext *ctx = inlink->dst;
124  CompensationDelayContext *s = ctx->priv;
125  const unsigned b_mask = s->buf_size - 1;
126  const unsigned buf_size = s->buf_size;
127  const unsigned delay = s->delay;
128  const double dry = s->dry;
129  const double wet = s->wet;
130  unsigned r_ptr, w_ptr = 0;
131  AVFrame *out;
132  int n, ch;
133 
134  out = ff_get_audio_buffer(ctx->outputs[0], in->nb_samples);
135  if (!out) {
136  av_frame_free(&in);
137  return AVERROR(ENOMEM);
138  }
140 
141  for (ch = 0; ch < inlink->channels; ch++) {
142  const double *src = (const double *)in->extended_data[ch];
143  double *dst = (double *)out->extended_data[ch];
144  double *buffer = (double *)s->delay_frame->extended_data[ch];
145 
146  w_ptr = s->w_ptr;
147  r_ptr = (w_ptr + buf_size - delay) & b_mask;
148 
149  for (n = 0; n < in->nb_samples; n++) {
150  const double sample = src[n];
151 
152  buffer[w_ptr] = sample;
153  dst[n] = dry * sample + wet * buffer[r_ptr];
154  w_ptr = (w_ptr + 1) & b_mask;
155  r_ptr = (r_ptr + 1) & b_mask;
156  }
157  }
158  s->w_ptr = w_ptr;
159 
160  av_frame_free(&in);
161  return ff_filter_frame(ctx->outputs[0], out);
162 }
163 
165 {
166  CompensationDelayContext *s = ctx->priv;
167 
168  av_frame_free(&s->delay_frame);
169 }
170 
172  {
173  .name = "default",
174  .type = AVMEDIA_TYPE_AUDIO,
175  .config_props = config_input,
176  .filter_frame = filter_frame,
177  },
178  { NULL }
179 };
180 
182  {
183  .name = "default",
184  .type = AVMEDIA_TYPE_AUDIO,
185  },
186  { NULL }
187 };
188 
190  .name = "compensationdelay",
191  .description = NULL_IF_CONFIG_SMALL("Audio Compensation Delay Line."),
192  .query_formats = query_formats,
193  .priv_size = sizeof(CompensationDelayContext),
194  .priv_class = &compensationdelay_class,
195  .uninit = uninit,
198 };
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
config_input
static int config_input(AVFilterLink *inlink)
Definition: af_compensationdelay.c:96
AVFilterChannelLayouts
A list of supported channel layouts.
Definition: formats.h:85
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
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
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:246
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:948
ff_af_compensationdelay
const AVFilter ff_af_compensationdelay
Definition: af_compensationdelay.c:189
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:112
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
compensationdelay_inputs
static const AVFilterPad compensationdelay_inputs[]
Definition: af_compensationdelay.c:171
AVOption
AVOption.
Definition: opt.h:247
compensationdelay_options
static const AVOption compensationdelay_options[]
Definition: af_compensationdelay.c:45
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:149
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:64
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:54
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:99
av_cold
#define av_cold
Definition: attributes.h:90
inputs
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
Definition: filter_design.txt:243
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
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_OPT_TYPE_DOUBLE
@ AV_OPT_TYPE_DOUBLE
Definition: opt.h:226
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
CompensationDelayContext::distance_m
int distance_m
Definition: af_compensationdelay.c:32
outputs
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
CompensationDelayContext
Definition: af_compensationdelay.c:28
ctx
AVFormatContext * ctx
Definition: movenc.c:48
CompensationDelayContext::temp
int temp
Definition: af_compensationdelay.c:34
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: af_compensationdelay.c:121
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:537
CompensationDelayContext::dry
double dry
Definition: af_compensationdelay.c:33
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: af_compensationdelay.c:66
src
#define src
Definition: vp8dsp.c:255
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:116
compensationdelay_outputs
static const AVFilterPad compensationdelay_outputs[]
Definition: af_compensationdelay.c:181
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:59
sample
#define sample
Definition: flacdsp_template.c:44
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:369
AVFrame::extended_data
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:350
COMP_DELAY_SOUND_FRONT_DELAY
#define COMP_DELAY_SOUND_FRONT_DELAY(temp)
Definition: af_compensationdelay.c:62
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
CompensationDelayContext::wet
double wet
Definition: af_compensationdelay.c:33
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_compensationdelay.c:164
AVFilter
Filter definition.
Definition: avfilter.h:145
ret
ret
Definition: filter_design.txt:187
ff_all_samplerates
AVFilterFormats * ff_all_samplerates(void)
Definition: formats.c:414
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:224
avfilter.h
AV_SAMPLE_FMT_DBLP
@ AV_SAMPLE_FMT_DBLP
double, planar
Definition: samplefmt.h:70
temp
else temp
Definition: vf_mcdeint.c:259
AVFilterContext
An instance of a filter.
Definition: avfilter.h:333
audio.h
ff_set_common_samplerates
int ff_set_common_samplerates(AVFilterContext *ctx, AVFilterFormats *samplerates)
Definition: formats.c:568
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
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