Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavfilter / af_earwax.c
1 /*
2  * Copyright (c) 2011 Mina Nagy Zaki
3  * Copyright (c) 2000 Edward Beingessner And Sundry Contributors.
4  * This source code is freely redistributable and may be used for any purpose.
5  * This copyright notice must be maintained.  Edward Beingessner And Sundry
6  * Contributors are not responsible for the consequences of using this
7  * software.
8  *
9  * This file is part of FFmpeg.
10  *
11  * FFmpeg is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * FFmpeg is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with FFmpeg; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24  */
25
26 /**
27  * @file
28  * Stereo Widening Effect. Adds audio cues to move stereo image in
29  * front of the listener. Adapted from the libsox earwax effect.
30  */
31
32 #include "libavutil/audioconvert.h"
33 #include "avfilter.h"
34 #include "audio.h"
35
36 #define NUMTAPS 64
37
38 static const int8_t filt[NUMTAPS] = {
39 /* 30°  330° */
40     4,   -6,     /* 32 tap stereo FIR filter. */
41     4,  -11,     /* One side filters as if the */
42    -1,   -5,     /* signal was from 30 degrees */
43     3,    3,     /* from the ear, the other as */
44    -2,    5,     /* if 330 degrees. */
45    -5,    0,
46     9,    1,
47     6,    3,     /*                         Input                         */
48    -4,   -1,     /*                   Left         Right                  */
49    -5,   -3,     /*                __________   __________                */
50    -2,   -5,     /*               |          | |          |               */
51    -7,    1,     /*           .---|  Hh,0(f) | |  Hh,0(f) |---.           */
52     6,   -7,     /*          /    |__________| |__________|    \          */
53    30,  -29,     /*         /                \ /                \         */
54    12,   -3,     /*        /                  X                  \        */
55   -11,    4,     /*       /                  / \                  \       */
56    -3,    7,     /*  ____V_____   __________V   V__________   _____V____  */
57   -20,   23,     /* |          | |          |   |          | |          | */
58     2,    0,     /* | Hh,30(f) | | Hh,330(f)|   | Hh,330(f)| | Hh,30(f) | */
59     1,   -6,     /* |__________| |__________|   |__________| |__________| */
60   -14,   -5,     /*      \     ___      /           \      ___     /      */
61    15,  -18,     /*       \   /   \    /    _____    \    /   \   /       */
62     6,    7,     /*        `->| + |<--'    /     \    `-->| + |<-'        */
63    15,  -10,     /*           \___/      _/       \_      \___/           */
64   -14,   22,     /*               \     / \       / \     /               */
65    -7,   -2,     /*                `--->| |       | |<---'                */
66    -4,    9,     /*                     \_/       \_/                     */
67     6,  -12,     /*                                                       */
68     6,   -6,     /*                       Headphones                      */
69     0,  -11,
70     0,   -5,
71     4,    0};
72
73 typedef struct {
74     int16_t taps[NUMTAPS * 2];
75 } EarwaxContext;
76
77 static int query_formats(AVFilterContext *ctx)
78 {
79     AVFilterFormats *formats = NULL;
80     avfilter_add_format(&formats, AV_SAMPLE_FMT_S16);
81     avfilter_set_common_sample_formats(ctx, formats);
82     formats = NULL;
83     avfilter_add_format(&formats, AV_CH_LAYOUT_STEREO);
84     avfilter_set_common_channel_layouts(ctx, formats);
85     formats = NULL;
86     avfilter_add_format(&formats, AVFILTER_PACKED);
87     avfilter_set_common_packing_formats(ctx, formats);
88
89     return 0;
90 }
91
92 static int config_input(AVFilterLink *inlink)
93 {
94     if (inlink->sample_rate != 44100) {
95         av_log(inlink->dst, AV_LOG_ERROR,
96                "The earwax filter only works for 44.1kHz audio. Insert "
97                "a resample filter before this\n");
98         return AVERROR(EINVAL);
99     }
100     return 0;
101 }
102
103 //FIXME: replace with DSPContext.scalarproduct_int16
104 static inline int16_t *scalarproduct(const int16_t *in, const int16_t *endin, int16_t *out)
105 {
106     int32_t sample;
107     int16_t j;
108
109     while (in < endin) {
110         sample = 32;
111         for (j = 0; j < NUMTAPS; j++)
112             sample += in[j] * filt[j];
113         *out = sample >> 6;
114         out++;
115         in++;
116     }
117
118     return out;
119 }
120
121 static void filter_samples(AVFilterLink *inlink, AVFilterBufferRef *insamples)
122 {
123     AVFilterLink *outlink = inlink->dst->outputs[0];
124     int16_t *taps, *endin, *in, *out;
125     AVFilterBufferRef *outsamples =
126         ff_get_audio_buffer(inlink, AV_PERM_WRITE,
127                                   insamples->audio->nb_samples);
128     avfilter_copy_buffer_ref_props(outsamples, insamples);
129
130     taps  = ((EarwaxContext *)inlink->dst->priv)->taps;
131     out   = (int16_t *)outsamples->data[0];
132     in    = (int16_t *)insamples ->data[0];
133
134     // copy part of new input and process with saved input
135     memcpy(taps+NUMTAPS, in, NUMTAPS * sizeof(*taps));
136     out   = scalarproduct(taps, taps + NUMTAPS, out);
137
138     // process current input
139     endin = in + insamples->audio->nb_samples * 2 - NUMTAPS;
140     out   = scalarproduct(in, endin, out);
141
142     // save part of input for next round
143     memcpy(taps, endin, NUMTAPS * sizeof(*taps));
144
145     ff_filter_samples(outlink, outsamples);
146     avfilter_unref_buffer(insamples);
147 }
148
149 AVFilter avfilter_af_earwax = {
150     .name           = "earwax",
151     .description    = NULL_IF_CONFIG_SMALL("Widen the stereo image."),
152     .query_formats  = query_formats,
153     .priv_size      = sizeof(EarwaxContext),
154     .inputs  = (const AVFilterPad[])  {{  .name     = "default",
155                                     .type           = AVMEDIA_TYPE_AUDIO,
156                                     .filter_samples = filter_samples,
157                                     .config_props   = config_input,
158                                     .min_perms      = AV_PERM_READ, },
159                                  {  .name = NULL}},
160
161     .outputs = (const AVFilterPad[])  {{  .name     = "default",
162                                     .type           = AVMEDIA_TYPE_AUDIO, },
163                                  {  .name = NULL}},
164 };