FFmpeg
af_crystalizer.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 The FFmpeg Project
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
22 #include "libavutil/opt.h"
23 #include "avfilter.h"
24 #include "audio.h"
25 #include "formats.h"
26 
27 typedef struct CrystalizerContext {
28  const AVClass *class;
29  float mult;
30  int clip;
32  int (*filter)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
34 
35 #define OFFSET(x) offsetof(CrystalizerContext, x)
36 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
37 
38 static const AVOption crystalizer_options[] = {
39  { "i", "set intensity", OFFSET(mult), AV_OPT_TYPE_FLOAT, {.dbl=2.0}, 0, 10, A },
40  { "c", "enable clipping", OFFSET(clip), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, A },
41  { NULL }
42 };
43 
44 AVFILTER_DEFINE_CLASS(crystalizer);
45 
47 {
50  static const enum AVSampleFormat sample_fmts[] = {
54  };
55  int ret;
56 
57  formats = ff_make_format_list(sample_fmts);
58  if (!formats)
59  return AVERROR(ENOMEM);
60  ret = ff_set_common_formats(ctx, formats);
61  if (ret < 0)
62  return ret;
63 
64  layouts = ff_all_channel_counts();
65  if (!layouts)
66  return AVERROR(ENOMEM);
67 
68  ret = ff_set_common_channel_layouts(ctx, layouts);
69  if (ret < 0)
70  return ret;
71 
72  formats = ff_all_samplerates();
73  return ff_set_common_samplerates(ctx, formats);
74 }
75 
76 typedef struct ThreadData {
77  void **d;
78  void **p;
79  const void **s;
80  int nb_samples;
81  int channels;
82  float mult;
83  int clip;
84 } ThreadData;
85 
86 static int filter_flt(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
87 {
88  ThreadData *td = arg;
89  void **d = td->d;
90  void **p = td->p;
91  const void **s = td->s;
92  const int nb_samples = td->nb_samples;
93  const int channels = td->channels;
94  float mult = td->mult;
95  const int clip = td->clip;
96  const int start = (channels * jobnr) / nb_jobs;
97  const int end = (channels * (jobnr+1)) / nb_jobs;
98  float *prv = p[0];
99  int n, c;
100 
101  for (c = start; c < end; c++) {
102  const float *src = s[0];
103  float *dst = d[0];
104 
105  for (n = 0; n < nb_samples; n++) {
106  float current = src[c];
107  dst[c] = current + (current - prv[c]) * mult;
108  prv[c] = current;
109  if (clip) {
110  dst[c] = av_clipf(dst[c], -1, 1);
111  }
112 
113  dst += channels;
114  src += channels;
115  }
116  }
117 
118  return 0;
119 }
120 
121 static int filter_dbl(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
122 {
123  ThreadData *td = arg;
124  void **d = td->d;
125  void **p = td->p;
126  const void **s = td->s;
127  const int nb_samples = td->nb_samples;
128  const int channels = td->channels;
129  float mult = td->mult;
130  const int clip = td->clip;
131  const int start = (channels * jobnr) / nb_jobs;
132  const int end = (channels * (jobnr+1)) / nb_jobs;
133  double *prv = p[0];
134  int n, c;
135 
136  for (c = start; c < end; c++) {
137  const double *src = s[0];
138  double *dst = d[0];
139 
140  for (n = 0; n < nb_samples; n++) {
141  double current = src[c];
142 
143  dst[c] = current + (current - prv[c]) * mult;
144  prv[c] = current;
145  if (clip) {
146  dst[c] = av_clipd(dst[c], -1, 1);
147  }
148 
149  dst += channels;
150  src += channels;
151  }
152  }
153 
154  return 0;
155 }
156 
157 static int filter_fltp(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
158 {
159  ThreadData *td = arg;
160  void **d = td->d;
161  void **p = td->p;
162  const void **s = td->s;
163  const int nb_samples = td->nb_samples;
164  const int channels = td->channels;
165  float mult = td->mult;
166  const int clip = td->clip;
167  const int start = (channels * jobnr) / nb_jobs;
168  const int end = (channels * (jobnr+1)) / nb_jobs;
169  int n, c;
170 
171  for (c = start; c < end; c++) {
172  const float *src = s[c];
173  float *dst = d[c];
174  float *prv = p[c];
175 
176  for (n = 0; n < nb_samples; n++) {
177  float current = src[n];
178 
179  dst[n] = current + (current - prv[0]) * mult;
180  prv[0] = current;
181  if (clip) {
182  dst[n] = av_clipf(dst[n], -1, 1);
183  }
184  }
185  }
186 
187  return 0;
188 }
189 
190 static int filter_dblp(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
191 {
192  ThreadData *td = arg;
193  void **d = td->d;
194  void **p = td->p;
195  const void **s = td->s;
196  const int nb_samples = td->nb_samples;
197  const int channels = td->channels;
198  float mult = td->mult;
199  const int clip = td->clip;
200  const int start = (channels * jobnr) / nb_jobs;
201  const int end = (channels * (jobnr+1)) / nb_jobs;
202  int n, c;
203 
204  for (c = start; c < end; c++) {
205  const double *src = s[c];
206  double *dst = d[c];
207  double *prv = p[c];
208 
209  for (n = 0; n < nb_samples; n++) {
210  double current = src[n];
211 
212  dst[n] = current + (current - prv[0]) * mult;
213  prv[0] = current;
214  if (clip) {
215  dst[n] = av_clipd(dst[n], -1, 1);
216  }
217  }
218  }
219 
220  return 0;
221 }
222 
224 {
225  AVFilterContext *ctx = inlink->dst;
226  CrystalizerContext *s = ctx->priv;
227 
228  switch (inlink->format) {
229  case AV_SAMPLE_FMT_FLT: s->filter = filter_flt; break;
230  case AV_SAMPLE_FMT_DBL: s->filter = filter_dbl; break;
231  case AV_SAMPLE_FMT_FLTP: s->filter = filter_fltp; break;
232  case AV_SAMPLE_FMT_DBLP: s->filter = filter_dblp; break;
233  }
234 
235  return 0;
236 }
237 
239 {
240  AVFilterContext *ctx = inlink->dst;
241  AVFilterLink *outlink = ctx->outputs[0];
242  CrystalizerContext *s = ctx->priv;
243  AVFrame *out;
244  ThreadData td;
245 
246  if (!s->prev) {
247  s->prev = ff_get_audio_buffer(inlink, 1);
248  if (!s->prev) {
249  av_frame_free(&in);
250  return AVERROR(ENOMEM);
251  }
252  }
253 
254  if (av_frame_is_writable(in)) {
255  out = in;
256  } else {
257  out = ff_get_audio_buffer(outlink, in->nb_samples);
258  if (!out) {
259  av_frame_free(&in);
260  return AVERROR(ENOMEM);
261  }
262  av_frame_copy_props(out, in);
263  }
264 
265  td.d = (void **)out->extended_data;
266  td.s = (const void **)in->extended_data;
267  td.p = (void **)s->prev->extended_data;
268  td.nb_samples = in->nb_samples;
269  td.channels = in->channels;
270  td.mult = ctx->is_disabled ? 0.f : s->mult;
271  td.clip = s->clip;
272  ctx->internal->execute(ctx, s->filter, &td, NULL, FFMIN(inlink->channels,
274 
275  if (out != in)
276  av_frame_free(&in);
277 
278  return ff_filter_frame(outlink, out);
279 }
280 
282 {
283  CrystalizerContext *s = ctx->priv;
284 
285  av_frame_free(&s->prev);
286 }
287 
288 static const AVFilterPad inputs[] = {
289  {
290  .name = "default",
291  .type = AVMEDIA_TYPE_AUDIO,
292  .filter_frame = filter_frame,
293  .config_props = config_input,
294  },
295  { NULL }
296 };
297 
298 static const AVFilterPad outputs[] = {
299  {
300  .name = "default",
301  .type = AVMEDIA_TYPE_AUDIO,
302  },
303  { NULL }
304 };
305 
307  .name = "crystalizer",
308  .description = NULL_IF_CONFIG_SMALL("Simple expand audio dynamic range filter."),
309  .query_formats = query_formats,
310  .priv_size = sizeof(CrystalizerContext),
311  .priv_class = &crystalizer_class,
312  .uninit = uninit,
313  .inputs = inputs,
314  .outputs = outputs,
318 };
float, planar
Definition: samplefmt.h:69
#define NULL
Definition: coverity.c:32
int ff_set_common_channel_layouts(AVFilterContext *ctx, AVFilterChannelLayouts *layouts)
A helper for query_formats() which sets all links to the same list of channel layouts/sample rates...
Definition: formats.c:550
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
AVOption.
Definition: opt.h:246
static int filter_dblp(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
Main libavfilter public API header.
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
#define OFFSET(x)
double, planar
Definition: samplefmt.h:70
AVFILTER_DEFINE_CLASS(crystalizer)
int is_disabled
the enabled state from the last expression evaluation
Definition: avfilter.h:385
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:283
const char * name
Pad name.
Definition: internal.h:60
static int filter_dbl(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1075
#define av_cold
Definition: attributes.h:82
AVOptions.
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
channels
Definition: aptx.h:33
A filter pad used for either input or output.
Definition: internal.h:54
#define src
Definition: vp8dsp.c:254
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:569
#define td
Definition: regdef.h:70
static int filter_fltp(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
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
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:203
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
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:869
void * priv
private data for use by the filter
Definition: avfilter.h:353
#define AVFILTER_FLAG_SLICE_THREADS
The filter supports multithreading by splitting frames into multiple parts and processing them concur...
Definition: avfilter.h:116
const char * arg
Definition: jacosubdec.c:66
int channels
number of audio channels, only used for audio.
Definition: frame.h:601
audio channel layout utility functions
int ff_filter_get_nb_threads(AVFilterContext *ctx)
Get number of threads for current filter instance.
Definition: avfilter.c:784
#define FFMIN(a, b)
Definition: common.h:96
AVFormatContext * ctx
Definition: movenc.c:48
#define s(width, name)
Definition: cbs_vp9.c:257
#define A
A list of supported channel layouts.
Definition: formats.h:85
static int filter_flt(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:595
Used for passing data between threads.
Definition: dsddec.c:64
uint8_t pi<< 24) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_U8, uint8_t,(*(const uint8_t *) pi-0x80)*(1.0f/(1<< 7))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_U8, uint8_t,(*(const uint8_t *) pi-0x80)*(1.0/(1<< 7))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_S16, int16_t,(*(const int16_t *) pi >> 8)+0x80) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_S16, int16_t,*(const int16_t *) pi *(1.0f/(1<< 15))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_S16, int16_t,*(const int16_t *) pi *(1.0/(1<< 15))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_S32, int32_t,(*(const int32_t *) pi >> 24)+0x80) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_S32, int32_t,*(const int32_t *) pi *(1.0f/(1U<< 31))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_S32, int32_t,*(const int32_t *) pi *(1.0/(1U<< 31))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_FLT, float, av_clip_uint8(lrintf(*(const float *) pi *(1<< 7))+0x80)) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S16, int16_t, AV_SAMPLE_FMT_FLT, float, av_clip_int16(lrintf(*(const float *) pi *(1<< 15)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S32, int32_t, AV_SAMPLE_FMT_FLT, float, av_clipl_int32(llrintf(*(const float *) pi *(1U<< 31)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_DBL, double, av_clip_uint8(lrint(*(const double *) pi *(1<< 7))+0x80)) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S16, int16_t, AV_SAMPLE_FMT_DBL, double, av_clip_int16(lrint(*(const double *) pi *(1<< 15)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S32, int32_t, AV_SAMPLE_FMT_DBL, double, av_clipl_int32(llrint(*(const double *) pi *(1U<< 31))))#define SET_CONV_FUNC_GROUP(ofmt, ifmt) static void set_generic_function(AudioConvert *ac){}void ff_audio_convert_free(AudioConvert **ac){if(!*ac) return;ff_dither_free(&(*ac) ->dc);av_freep(ac);}AudioConvert *ff_audio_convert_alloc(AVAudioResampleContext *avr, enum AVSampleFormat out_fmt, enum AVSampleFormat in_fmt, int channels, int sample_rate, int apply_map){AudioConvert *ac;int in_planar, out_planar;ac=av_mallocz(sizeof(*ac));if(!ac) return NULL;ac->avr=avr;ac->out_fmt=out_fmt;ac->in_fmt=in_fmt;ac->channels=channels;ac->apply_map=apply_map;if(avr->dither_method!=AV_RESAMPLE_DITHER_NONE &&av_get_packed_sample_fmt(out_fmt)==AV_SAMPLE_FMT_S16 &&av_get_bytes_per_sample(in_fmt) > 2){ac->dc=ff_dither_alloc(avr, out_fmt, in_fmt, channels, sample_rate, apply_map);if(!ac->dc){av_free(ac);return NULL;}return ac;}in_planar=ff_sample_fmt_is_planar(in_fmt, channels);out_planar=ff_sample_fmt_is_planar(out_fmt, channels);if(in_planar==out_planar){ac->func_type=CONV_FUNC_TYPE_FLAT;ac->planes=in_planar?ac->channels:1;}else if(in_planar) ac->func_type=CONV_FUNC_TYPE_INTERLEAVE;else ac->func_type=CONV_FUNC_TYPE_DEINTERLEAVE;set_generic_function(ac);if(ARCH_AARCH64) ff_audio_convert_init_aarch64(ac);if(ARCH_ARM) ff_audio_convert_init_arm(ac);if(ARCH_X86) ff_audio_convert_init_x86(ac);return ac;}int ff_audio_convert(AudioConvert *ac, AudioData *out, AudioData *in){int use_generic=1;int len=in->nb_samples;int p;if(ac->dc){av_log(ac->avr, AV_LOG_TRACE,"%d samples - audio_convert: %s to %s (dithered)\n", len, av_get_sample_fmt_name(ac->in_fmt), av_get_sample_fmt_name(ac->out_fmt));return ff_convert_dither(ac-> in
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:144
int(* filter)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
const char * name
Filter name.
Definition: avfilter.h:148
#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:133
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:350
enum MovChannelLayoutTag * layouts
Definition: mov_chan.c:434
AVFilterFormats * ff_all_samplerates(void)
Definition: formats.c:394
#define flags(name, subs,...)
Definition: cbs_av1.c:564
AVFilterInternal * internal
An opaque struct for libavfilter internal use.
Definition: avfilter.h:378
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
int
static int query_formats(AVFilterContext *ctx)
static const AVFilterPad outputs[]
avfilter_execute_func * execute
Definition: internal.h:144
static const AVOption crystalizer_options[]
static const AVFilterPad inputs[]
static int config_input(AVFilterLink *inlink)
A list of supported formats for one end of a filter link.
Definition: formats.h:64
An instance of a filter.
Definition: avfilter.h:338
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:701
FILE * out
Definition: movenc.c:54
static int process_command(AVFilterContext *ctx, const char *cmd, const char *args, char *res, int res_len, int flags)
Definition: af_afftdn.c:1374
const void ** s
formats
Definition: signature.h:48
AVFilter ff_af_crystalizer
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
AVFilterChannelLayouts * ff_all_channel_counts(void)
Construct an AVFilterChannelLayouts coding for any channel layout, with known or unknown disposition...
Definition: formats.c:409
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:342
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:361
static av_cold void uninit(AVFilterContext *ctx)
int ff_set_common_samplerates(AVFilterContext *ctx, AVFilterFormats *samplerates)
Definition: formats.c:557
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:659