FFmpeg
af_bs2b.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 /**
20  * @file
21  * Bauer stereo-to-binaural filter
22  */
23 
24 #include <bs2b.h>
25 
27 #include "libavutil/common.h"
28 #include "libavutil/opt.h"
29 
30 #include "audio.h"
31 #include "avfilter.h"
32 #include "formats.h"
33 #include "internal.h"
34 
35 typedef void (*filter_func)(t_bs2bdp bs2bdp, uint8_t *sample, int n);
36 
37 typedef struct Bs2bContext {
38  const AVClass *class;
39 
40  int profile;
41  int fcut;
42  int feed;
43 
44  t_bs2bdp bs2bp;
45 
47 } Bs2bContext;
48 
49 #define OFFSET(x) offsetof(Bs2bContext, x)
50 #define A AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
51 
52 static const AVOption bs2b_options[] = {
53  { "profile", "Apply a pre-defined crossfeed level",
54  OFFSET(profile), AV_OPT_TYPE_INT, { .i64 = BS2B_DEFAULT_CLEVEL }, 0, INT_MAX, A, "profile" },
55  { "default", "default profile", 0, AV_OPT_TYPE_CONST, { .i64 = BS2B_DEFAULT_CLEVEL }, 0, 0, A, "profile" },
56  { "cmoy", "Chu Moy circuit", 0, AV_OPT_TYPE_CONST, { .i64 = BS2B_CMOY_CLEVEL }, 0, 0, A, "profile" },
57  { "jmeier", "Jan Meier circuit", 0, AV_OPT_TYPE_CONST, { .i64 = BS2B_JMEIER_CLEVEL }, 0, 0, A, "profile" },
58  { "fcut", "Set cut frequency (in Hz)",
59  OFFSET(fcut), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, BS2B_MAXFCUT, A },
60  { "feed", "Set feed level (in Hz)",
61  OFFSET(feed), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, BS2B_MAXFEED, A },
62  { NULL },
63 };
64 
66 
68 {
69  Bs2bContext *bs2b = ctx->priv;
70 
71  if (!(bs2b->bs2bp = bs2b_open()))
72  return AVERROR(ENOMEM);
73 
74  bs2b_set_level(bs2b->bs2bp, bs2b->profile);
75 
76  if (bs2b->fcut)
77  bs2b_set_level_fcut(bs2b->bs2bp, bs2b->fcut);
78 
79  if (bs2b->feed)
80  bs2b_set_level_feed(bs2b->bs2bp, bs2b->feed);
81 
82  return 0;
83 }
84 
86 {
87  Bs2bContext *bs2b = ctx->priv;
88 
89  if (bs2b->bs2bp)
90  bs2b_close(bs2b->bs2bp);
91 }
92 
94 {
96 
97  static const enum AVSampleFormat sample_fmts[] = {
104  };
105  int ret;
106 
108  return AVERROR(ENOMEM);
110  if (ret < 0)
111  return ret;
112 
114  if (ret < 0)
115  return ret;
116 
118 }
119 
121 {
122  int ret;
123  AVFrame *out_frame;
124 
125  Bs2bContext *bs2b = inlink->dst->priv;
126  AVFilterLink *outlink = inlink->dst->outputs[0];
127 
129  out_frame = frame;
130  } else {
131  out_frame = ff_get_audio_buffer(outlink, frame->nb_samples);
132  if (!out_frame) {
134  return AVERROR(ENOMEM);
135  }
136  av_frame_copy(out_frame, frame);
137  ret = av_frame_copy_props(out_frame, frame);
138  if (ret < 0) {
139  av_frame_free(&out_frame);
141  return ret;
142  }
143  }
144 
145  bs2b->filter(bs2b->bs2bp, out_frame->extended_data[0], out_frame->nb_samples);
146 
147  if (frame != out_frame)
149 
150  return ff_filter_frame(outlink, out_frame);
151 }
152 
153 static int config_output(AVFilterLink *outlink)
154 {
155  AVFilterContext *ctx = outlink->src;
156  Bs2bContext *bs2b = ctx->priv;
157  AVFilterLink *inlink = ctx->inputs[0];
158 
159  int srate = inlink->sample_rate;
160 
161  switch (inlink->format) {
162  case AV_SAMPLE_FMT_U8:
163  bs2b->filter = (filter_func) bs2b_cross_feed_u8;
164  break;
165  case AV_SAMPLE_FMT_S16:
166  bs2b->filter = (filter_func) bs2b_cross_feed_s16;
167  break;
168  case AV_SAMPLE_FMT_S32:
169  bs2b->filter = (filter_func) bs2b_cross_feed_s32;
170  break;
171  case AV_SAMPLE_FMT_FLT:
172  bs2b->filter = (filter_func) bs2b_cross_feed_f;
173  break;
174  case AV_SAMPLE_FMT_DBL:
175  bs2b->filter = (filter_func) bs2b_cross_feed_d;
176  break;
177  default:
178  return AVERROR_BUG;
179  }
180 
181  if ((srate < BS2B_MINSRATE) || (srate > BS2B_MAXSRATE))
182  return AVERROR(ENOSYS);
183 
184  bs2b_set_srate(bs2b->bs2bp, srate);
185 
186  return 0;
187 }
188 
189 static const AVFilterPad bs2b_inputs[] = {
190  {
191  .name = "default",
192  .type = AVMEDIA_TYPE_AUDIO,
193  .filter_frame = filter_frame,
194  },
195 };
196 
197 static const AVFilterPad bs2b_outputs[] = {
198  {
199  .name = "default",
200  .type = AVMEDIA_TYPE_AUDIO,
201  .config_props = config_output,
202  },
203 };
204 
206  .name = "bs2b",
207  .description = NULL_IF_CONFIG_SMALL("Bauer stereo-to-binaural filter."),
208  .priv_size = sizeof(Bs2bContext),
209  .priv_class = &bs2b_class,
210  .init = init,
211  .uninit = uninit,
215 };
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:88
AVFilterChannelLayouts
A list of supported channel layouts.
Definition: formats.h:85
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
Bs2bContext::feed
int feed
Definition: af_bs2b.c:42
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
sample_fmts
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:948
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
profile
mfxU16 profile
Definition: qsvenc.c:45
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
AVOption
AVOption.
Definition: opt.h:247
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:168
ff_set_common_all_samplerates
int ff_set_common_all_samplerates(AVFilterContext *ctx)
Equivalent to ff_set_common_samplerates(ctx, ff_all_samplerates())
Definition: formats.c:689
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
formats.h
Bs2bContext::bs2bp
t_bs2bdp bs2bp
Definition: af_bs2b.c:44
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: af_bs2b.c:93
Bs2bContext::profile
int profile
Definition: af_bs2b.c:40
AV_CH_LAYOUT_STEREO
#define AV_CH_LAYOUT_STEREO
Definition: channel_layout.h:91
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
av_cold
#define av_cold
Definition: attributes.h:90
bs2b_outputs
static const AVFilterPad bs2b_outputs[]
Definition: af_bs2b.c:197
ff_add_channel_layout
int ff_add_channel_layout(AVFilterChannelLayouts **l, uint64_t channel_layout)
Definition: formats.c:426
Bs2bContext
Definition: af_bs2b.c:37
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
ff_set_common_formats_from_list
int ff_set_common_formats_from_list(AVFilterContext *ctx, const int *fmts)
Equivalent to ff_set_common_formats(ctx, ff_make_format_list(fmts))
Definition: formats.c:705
Bs2bContext::fcut
int fcut
Definition: af_bs2b.c:41
ctx
AVFormatContext * ctx
Definition: movenc.c:48
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:191
feed
static void feed(AVFilterContext *ctx, int ch, const float *in_samples, float *out_samples, int diff_only, float *in_frame, float *out_dist_frame, float *windowed_frame, float *clipping_delta, float *spectrum_buf, float *mask_curve)
Definition: af_apsyclip.c:396
A
#define A
Definition: af_bs2b.c:50
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
init
static av_cold int init(AVFilterContext *ctx)
Definition: af_bs2b.c:67
config_output
static int config_output(AVFilterLink *outlink)
Definition: af_bs2b.c:153
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(bs2b)
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
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
Definition: af_bs2b.c:120
av_frame_copy
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:678
filter_func
void(* filter_func)(t_bs2bdp bs2bdp, uint8_t *sample, int n)
Definition: af_bs2b.c:35
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:473
internal.h
OFFSET
#define OFFSET(x)
Definition: af_bs2b.c:49
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:369
AV_SAMPLE_FMT_U8
@ AV_SAMPLE_FMT_U8
unsigned 8 bits
Definition: samplefmt.h:60
AVFrame::extended_data
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:350
common.h
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
AV_SAMPLE_FMT_S16
@ AV_SAMPLE_FMT_S16
signed 16 bits
Definition: samplefmt.h:61
bs2b_options
static const AVOption bs2b_options[]
Definition: af_bs2b.c:52
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
ff_af_bs2b
const AVFilter ff_af_bs2b
Definition: af_bs2b.c:205
AVFilter
Filter definition.
Definition: avfilter.h:149
ret
ret
Definition: filter_design.txt:187
frame
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 the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
Bs2bContext::filter
filter_func filter
Definition: af_bs2b.c:46
channel_layout.h
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
audio.h
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
AVERROR_BUG
#define AVERROR_BUG
Internal bug, also see AVERROR_BUG2.
Definition: error.h:52
AV_SAMPLE_FMT_DBL
@ AV_SAMPLE_FMT_DBL
double
Definition: samplefmt.h:64
AV_SAMPLE_FMT_S32
@ AV_SAMPLE_FMT_S32
signed 32 bits
Definition: samplefmt.h:62
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:233
AV_SAMPLE_FMT_FLT
@ AV_SAMPLE_FMT_FLT
float
Definition: samplefmt.h:63
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_bs2b.c:85
bs2b_inputs
static const AVFilterPad bs2b_inputs[]
Definition: af_bs2b.c:189
ff_set_common_channel_layouts
int ff_set_common_channel_layouts(AVFilterContext *ctx, AVFilterChannelLayouts *channel_layouts)
Helpers for query_formats() which set all free audio links to the same list of channel layouts/sample...
Definition: formats.c:658