bcb35190ff1e19bfefb6e971616739512841f5bb
[ffmpeg.git] / libavfilter / af_sofalizer.c
1 /*****************************************************************************
2  * sofalizer.c : SOFAlizer filter for virtual binaural acoustics
3  *****************************************************************************
4  * Copyright (C) 2013-2015 Andreas Fuchs, Wolfgang Hrauda,
5  *                         Acoustics Research Institute (ARI), Vienna, Austria
6  *
7  * Authors: Andreas Fuchs <andi.fuchs.mail@gmail.com>
8  *          Wolfgang Hrauda <wolfgang.hrauda@gmx.at>
9  *
10  * SOFAlizer project coordinator at ARI, main developer of SOFA:
11  *          Piotr Majdak <piotr@majdak.at>
12  *
13  * This program is free software; you can redistribute it and/or modify it
14  * under the terms of the GNU Lesser General Public License as published by
15  * the Free Software Foundation; either version 2.1 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU Lesser General Public License for more details.
22  *
23  * You should have received a copy of the GNU Lesser General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26  *****************************************************************************/
27
28 #include <math.h>
29 #include <netcdf.h>
30
31 #include "libavutil/float_dsp.h"
32 #include "libavutil/opt.h"
33 #include "avfilter.h"
34 #include "internal.h"
35 #include "audio.h"
36
37 typedef struct NCSofa {  /* contains data of one SOFA file */
38     int ncid;            /* netCDF ID of the opened SOFA file */
39     int n_samples;       /* length of one impulse response (IR) */
40     int m_dim;           /* number of measurement positions */
41     int *data_delay;     /* broadband delay of each IR */
42                          /* all measurement positions for each receiver (i.e. ear): */
43     float *sp_a;         /* azimuth angles */
44     float *sp_e;         /* elevation angles */
45     float *sp_r;         /* radii */
46                          /* data at each measurement position for each receiver: */
47     float *data_ir;      /* IRs (time-domain) */
48 } NCSofa;
49
50 typedef struct SOFAlizerContext {
51     const AVClass *class;
52
53     char *filename;             /* name of SOFA file */
54     NCSofa sofa;                /* contains data of the SOFA file */
55
56     int sample_rate;            /* sample rate from SOFA file */
57     float *speaker_azim;        /* azimuth of the virtual loudspeakers */
58     float *speaker_elev;        /* elevation of the virtual loudspeakers */
59     float gain_lfe;             /* gain applied to LFE channel */
60     int lfe_channel;            /* LFE channel position in channel layout */
61
62     int n_conv;                 /* number of channels to convolute */
63
64                                 /* buffer variables (for convolution) */
65     float *ringbuffer[2];       /* buffers input samples, length of one buffer: */
66                                 /* no. input ch. (incl. LFE) x buffer_length */
67     int write[2];               /* current write position to ringbuffer */
68     int buffer_length;          /* is: longest IR plus max. delay in all SOFA files */
69                                 /* then choose next power of 2 */
70
71                                 /* netCDF variables */
72     int *delay[2];              /* broadband delay for each channel/IR to be convolved */
73
74     float *data_ir[2];          /* IRs for all channels to be convolved */
75                                 /* (this excludes the LFE) */
76     float *temp_src[2];
77
78                          /* control variables */
79     float gain;          /* filter gain (in dB) */
80     float rotation;      /* rotation of virtual loudspeakers (in degrees)  */
81     float elevation;     /* elevation of virtual loudspeakers (in deg.) */
82     float radius;        /* distance virtual loudspeakers to listener (in metres) */
83
84     AVFloatDSPContext *fdsp;
85 } SOFAlizerContext;
86
87 static int close_sofa(struct NCSofa *sofa)
88 {
89     av_freep(&sofa->data_delay);
90     av_freep(&sofa->sp_a);
91     av_freep(&sofa->sp_e);
92     av_freep(&sofa->sp_r);
93     av_freep(&sofa->data_ir);
94     nc_close(sofa->ncid);
95     sofa->ncid = 0;
96
97     return 0;
98 }
99
100 static int load_sofa(AVFilterContext *ctx, char *filename, int *samplingrate)
101 {
102     struct SOFAlizerContext *s = ctx->priv;
103     /* variables associated with content of SOFA file: */
104     int ncid, n_dims, n_vars, n_gatts, n_unlim_dim_id, status;
105     char data_delay_dim_name[NC_MAX_NAME];
106     float *sp_a, *sp_e, *sp_r, *data_ir;
107     char *sofa_conventions;
108     char dim_name[NC_MAX_NAME];   /* names of netCDF dimensions */
109     size_t *dim_length;           /* lengths of netCDF dimensions */
110     char *text;
111     unsigned int sample_rate;
112     int data_delay_dim_id[2];
113     int samplingrate_id;
114     int data_delay_id;
115     int n_samples;
116     int m_dim_id = -1;
117     int n_dim_id = -1;
118     int data_ir_id;
119     size_t att_len;
120     int m_dim;
121     int *data_delay;
122     int sp_id;
123     int i, ret;
124
125     s->sofa.ncid = 0;
126     status = nc_open(filename, NC_NOWRITE, &ncid); /* open SOFA file read-only */
127     if (status != NC_NOERR) {
128         av_log(ctx, AV_LOG_ERROR, "Can't find SOFA-file '%s'\n", filename);
129         return AVERROR(EINVAL);
130     }
131
132     /* get number of dimensions, vars, global attributes and Id of unlimited dimensions: */
133     nc_inq(ncid, &n_dims, &n_vars, &n_gatts, &n_unlim_dim_id);
134
135     /* -- get number of measurements ("M") and length of one IR ("N") -- */
136     dim_length = av_malloc_array(n_dims, sizeof(*dim_length));
137     if (!dim_length) {
138         nc_close(ncid);
139         return AVERROR(ENOMEM);
140     }
141
142     for (i = 0; i < n_dims; i++) { /* go through all dimensions of file */
143         nc_inq_dim(ncid, i, (char *)&dim_name, &dim_length[i]); /* get dimensions */
144         if (!strncmp("M", (const char *)&dim_name, 1)) /* get ID of dimension "M" */
145             m_dim_id = i;
146         if (!strncmp("N", (const char *)&dim_name, 1)) /* get ID of dimension "N" */
147             n_dim_id = i;
148     }
149
150     if ((m_dim_id == -1) || (n_dim_id == -1)) { /* dimension "M" or "N" couldn't be found */
151         av_log(ctx, AV_LOG_ERROR, "Can't find required dimensions in SOFA file.\n");
152         av_freep(&dim_length);
153         nc_close(ncid);
154         return AVERROR(EINVAL);
155     }
156
157     n_samples = dim_length[n_dim_id]; /* get length of one IR */
158     m_dim     = dim_length[m_dim_id]; /* get number of measurements */
159
160     av_freep(&dim_length);
161
162     /* -- check file type -- */
163     /* get length of attritube "Conventions" */
164     status = nc_inq_attlen(ncid, NC_GLOBAL, "Conventions", &att_len);
165     if (status != NC_NOERR) {
166         av_log(ctx, AV_LOG_ERROR, "Can't get length of attribute \"Conventions\".\n");
167         nc_close(ncid);
168         return AVERROR_INVALIDDATA;
169     }
170
171     /* check whether file is SOFA file */
172     text = av_malloc(att_len + 1);
173     if (!text) {
174         nc_close(ncid);
175         return AVERROR(ENOMEM);
176     }
177
178     nc_get_att_text(ncid, NC_GLOBAL, "Conventions", text);
179     *(text + att_len) = 0;
180     if (strncmp("SOFA", text, 4)) {
181         av_log(ctx, AV_LOG_ERROR, "Not a SOFA file!\n");
182         av_freep(&text);
183         nc_close(ncid);
184         return AVERROR(EINVAL);
185     }
186     av_freep(&text);
187
188     status = nc_inq_attlen(ncid, NC_GLOBAL, "License", &att_len);
189     if (status == NC_NOERR) {
190         text = av_malloc(att_len + 1);
191         if (text) {
192             nc_get_att_text(ncid, NC_GLOBAL, "License", text);
193             *(text + att_len) = 0;
194             av_log(ctx, AV_LOG_INFO, "SOFA file License: %s\n", text);
195             av_freep(&text);
196         }
197     }
198
199     status = nc_inq_attlen(ncid, NC_GLOBAL, "SourceDescription", &att_len);
200     if (status == NC_NOERR) {
201         text = av_malloc(att_len + 1);
202         if (text) {
203             nc_get_att_text(ncid, NC_GLOBAL, "SourceDescription", text);
204             *(text + att_len) = 0;
205             av_log(ctx, AV_LOG_INFO, "SOFA file SourceDescription: %s\n", text);
206             av_freep(&text);
207         }
208     }
209
210     status = nc_inq_attlen(ncid, NC_GLOBAL, "Comment", &att_len);
211     if (status == NC_NOERR) {
212         text = av_malloc(att_len + 1);
213         if (text) {
214             nc_get_att_text(ncid, NC_GLOBAL, "Comment", text);
215             *(text + att_len) = 0;
216             av_log(ctx, AV_LOG_INFO, "SOFA file Comment: %s\n", text);
217             av_freep(&text);
218         }
219     }
220
221     status = nc_inq_attlen(ncid, NC_GLOBAL, "SOFAConventions", &att_len);
222     if (status != NC_NOERR) {
223         av_log(ctx, AV_LOG_ERROR, "Can't get length of attribute \"SOFAConventions\".\n");
224         nc_close(ncid);
225         return AVERROR_INVALIDDATA;
226     }
227
228     sofa_conventions = av_malloc(att_len + 1);
229     if (!sofa_conventions) {
230         nc_close(ncid);
231         return AVERROR(ENOMEM);
232     }
233
234     nc_get_att_text(ncid, NC_GLOBAL, "SOFAConventions", sofa_conventions);
235     *(sofa_conventions + att_len) = 0;
236     if (strncmp("SimpleFreeFieldHRIR", sofa_conventions, att_len)) {
237         av_log(ctx, AV_LOG_ERROR, "Not a SimpleFreeFieldHRIR file!\n");
238         av_freep(&sofa_conventions);
239         nc_close(ncid);
240         return AVERROR(EINVAL);
241     }
242     av_freep(&sofa_conventions);
243
244     /* -- get sampling rate of HRTFs -- */
245     /* read ID, then value */
246     status  = nc_inq_varid(ncid, "Data.SamplingRate", &samplingrate_id);
247     status += nc_get_var_uint(ncid, samplingrate_id, &sample_rate);
248     if (status != NC_NOERR) {
249         av_log(ctx, AV_LOG_ERROR, "Couldn't read Data.SamplingRate.\n");
250         nc_close(ncid);
251         return AVERROR(EINVAL);
252     }
253     *samplingrate = sample_rate; /* remember sampling rate */
254
255     /* -- allocate memory for one value for each measurement position: -- */
256     sp_a = s->sofa.sp_a = av_malloc_array(m_dim, sizeof(float));
257     sp_e = s->sofa.sp_e = av_malloc_array(m_dim, sizeof(float));
258     sp_r = s->sofa.sp_r = av_malloc_array(m_dim, sizeof(float));
259     /* delay and IR values required for each ear and measurement position: */
260     data_delay = s->sofa.data_delay = av_calloc(m_dim, 2 * sizeof(int));
261     data_ir = s->sofa.data_ir = av_malloc_array(m_dim * n_samples, sizeof(float) * 2);
262     s->temp_src[0] = av_calloc(FFALIGN(n_samples, 16), sizeof(float));
263     s->temp_src[1] = av_calloc(FFALIGN(n_samples, 16), sizeof(float));
264
265     if (!data_delay || !sp_a || !sp_e || !sp_r || !data_ir ||
266         !s->temp_src[0] || !s->temp_src[1]) {
267         /* if memory could not be allocated */
268         close_sofa(&s->sofa);
269         return AVERROR(ENOMEM);
270     }
271
272     /* get impulse responses (HRTFs): */
273     /* get corresponding ID */
274     status = nc_inq_varid(ncid, "Data.IR", &data_ir_id);
275     status += nc_get_var_float(ncid, data_ir_id, data_ir); /* read and store IRs */
276     if (status != NC_NOERR) {
277         av_log(ctx, AV_LOG_ERROR, "Couldn't read Data.IR!\n");
278         ret = AVERROR(EINVAL);
279         goto error;
280     }
281
282     /* get source positions of the HRTFs in the SOFA file: */
283     status  = nc_inq_varid(ncid, "SourcePosition", &sp_id); /* get corresponding ID */
284     status += nc_get_vara_float(ncid, sp_id, (size_t[2]){ 0, 0 } ,
285                 (size_t[2]){ m_dim, 1}, sp_a); /* read & store azimuth angles */
286     status += nc_get_vara_float(ncid, sp_id, (size_t[2]){ 0, 1 } ,
287                 (size_t[2]){ m_dim, 1}, sp_e); /* read & store elevation angles */
288     status += nc_get_vara_float(ncid, sp_id, (size_t[2]){ 0, 2 } ,
289                 (size_t[2]){ m_dim, 1}, sp_r); /* read & store radii */
290     if (status != NC_NOERR) { /* if any source position variable coudn't be read */
291         av_log(ctx, AV_LOG_ERROR, "Couldn't read SourcePosition.\n");
292         ret = AVERROR(EINVAL);
293         goto error;
294     }
295
296     /* read Data.Delay, check for errors and fit it to data_delay */
297     status  = nc_inq_varid(ncid, "Data.Delay", &data_delay_id);
298     status += nc_inq_vardimid(ncid, data_delay_id, &data_delay_dim_id[0]);
299     status += nc_inq_dimname(ncid, data_delay_dim_id[0], data_delay_dim_name);
300     if (status != NC_NOERR) {
301         av_log(ctx, AV_LOG_ERROR, "Couldn't read Data.Delay.\n");
302         ret = AVERROR(EINVAL);
303         goto error;
304     }
305
306     /* Data.Delay dimension check */
307     /* dimension of Data.Delay is [I R]: */
308     if (!strncmp(data_delay_dim_name, "I", 2)) {
309         /* check 2 characters to assure string is 0-terminated after "I" */
310         int delay[2]; /* delays get from SOFA file: */
311
312         av_log(ctx, AV_LOG_DEBUG, "Data.Delay has dimension [I R]\n");
313         status = nc_get_var_int(ncid, data_delay_id, &delay[0]);
314         if (status != NC_NOERR) {
315             av_log(ctx, AV_LOG_ERROR, "Couldn't read Data.Delay\n");
316             ret = AVERROR(EINVAL);
317             goto error;
318         }
319         int *data_delay_r = data_delay + m_dim;
320         for (i = 0; i < m_dim; i++) { /* extend given dimension [I R] to [M R] */
321             /* assign constant delay value for all measurements to data_delay fields */
322             data_delay[i]   = delay[0];
323             data_delay_r[i] = delay[1];
324         }
325         /* dimension of Data.Delay is [M R] */
326     } else if (!strncmp(data_delay_dim_name, "M", 2)) {
327         av_log(ctx, AV_LOG_ERROR, "Data.Delay in dimension [M R]\n");
328         /* get delays from SOFA file: */
329         status = nc_get_var_int(ncid, data_delay_id, data_delay);
330         if (status != NC_NOERR) {
331             av_log(ctx, AV_LOG_ERROR, "Couldn't read Data.Delay\n");
332             ret = AVERROR(EINVAL);
333             goto error;
334         }
335     } else { /* dimension of Data.Delay is neither [I R] nor [M R] */
336         av_log(ctx, AV_LOG_ERROR, "Data.Delay does not have the required dimensions [I R] or [M R].\n");
337         ret = AVERROR(EINVAL);
338         goto error;
339     }
340
341     /* save information in SOFA struct: */
342     s->sofa.m_dim = m_dim; /* no. measurement positions */
343     s->sofa.n_samples = n_samples; /* length on one IR */
344     s->sofa.ncid = ncid; /* netCDF ID of SOFA file */
345     nc_close(ncid); /* close SOFA file */
346
347     return 0;
348
349 error:
350     close_sofa(&s->sofa);
351     return ret;
352 }
353
354 static int get_speaker_pos(AVFilterContext *ctx,
355                            float *speaker_azim, float *speaker_elev)
356 {
357     struct SOFAlizerContext *s = ctx->priv;
358     uint64_t channels_layout = ctx->inputs[0]->channel_layout;
359     float azim[10] = { 0 };
360     float elev[10] = { 0 };
361     int n_conv = ctx->inputs[0]->channels; /* get no. input channels */
362
363     s->lfe_channel = -1;
364
365     /* set speaker positions according to input channel configuration: */
366     switch (channels_layout) {
367     case AV_CH_LAYOUT_MONO:
368                             azim[0] = 0;
369                             break;
370     case AV_CH_LAYOUT_2POINT1:
371                             s->lfe_channel = 2;
372     case AV_CH_LAYOUT_STEREO:
373                             azim[0] = 30;
374                             azim[1] = 330;
375                             break;
376     case AV_CH_LAYOUT_3POINT1:
377                             s->lfe_channel = 3;
378     case AV_CH_LAYOUT_SURROUND:
379                             azim[0] = 30;
380                             azim[1] = 330;
381                             azim[2] = 0;
382                             break;
383     case AV_CH_LAYOUT_2_1:
384                             azim[0] = 30;
385                             azim[1] = 330;
386                             azim[2] = 180;
387                             break;
388     case AV_CH_LAYOUT_2_2:
389                             azim[0] = 30;
390                             azim[1] = 330;
391                             azim[2] = 90;
392                             azim[3] = 270;
393                             break;
394     case AV_CH_LAYOUT_QUAD:
395                             azim[0] = 30;
396                             azim[1] = 330;
397                             azim[2] = 120;
398                             azim[3] = 240;
399                             break;
400     case AV_CH_LAYOUT_4POINT1:
401                             s->lfe_channel = 3;
402                             azim[0] = 30;
403                             azim[1] = 330;
404                             azim[2] = 0;
405                             azim[4] = 180;
406                             break;
407     case AV_CH_LAYOUT_4POINT0:
408                             azim[0] = 30;
409                             azim[1] = 330;
410                             azim[2] = 0;
411                             azim[3] = 180;
412                             break;
413     case AV_CH_LAYOUT_5POINT1:
414                             s->lfe_channel = 3;
415                             azim[0] = 30;
416                             azim[1] = 330;
417                             azim[2] = 0;
418                             azim[4] = 90;
419                             azim[5] = 270;
420                             break;
421     case AV_CH_LAYOUT_5POINT0:
422                             azim[0] = 30;
423                             azim[1] = 330;
424                             azim[2] = 0;
425                             azim[3] = 90;
426                             azim[4] = 270;
427                             break;
428     case AV_CH_LAYOUT_5POINT1_BACK:
429                             s->lfe_channel = 3;
430                             azim[0] = 30;
431                             azim[1] = 330;
432                             azim[2] = 0;
433                             azim[4] = 120;
434                             azim[5] = 240;
435                             break;
436     case AV_CH_LAYOUT_5POINT0_BACK:
437                             azim[0] = 30;
438                             azim[1] = 330;
439                             azim[2] = 0;
440                             azim[3] = 120;
441                             azim[4] = 240;
442                             break;
443     case AV_CH_LAYOUT_6POINT1:
444                             s->lfe_channel = 3;
445                             azim[0] = 30;
446                             azim[1] = 330;
447                             azim[2] = 0;
448                             azim[4] = 180;
449                             azim[5] = 90;
450                             azim[6] = 270;
451                             break;
452     case AV_CH_LAYOUT_6POINT0:
453                             azim[0] = 30;
454                             azim[1] = 330;
455                             azim[2] = 0;
456                             azim[3] = 180;
457                             azim[4] = 90;
458                             azim[5] = 270;
459                             break;
460     case AV_CH_LAYOUT_6POINT1_BACK:
461                             s->lfe_channel = 3;
462                             azim[0] = 30;
463                             azim[1] = 330;
464                             azim[2] = 0;
465                             azim[4] = 120;
466                             azim[5] = 240;
467                             azim[6] = 180;
468                             break;
469     case AV_CH_LAYOUT_HEXAGONAL:
470                             azim[0] = 30;
471                             azim[1] = 330;
472                             azim[2] = 0;
473                             azim[3] = 120;
474                             azim[4] = 240;
475                             azim[5] = 180;
476                             break;
477     case AV_CH_LAYOUT_7POINT1:
478                             s->lfe_channel = 3;
479                             azim[0] = 30;
480                             azim[1] = 330;
481                             azim[2] = 0;
482                             azim[4] = 150;
483                             azim[5] = 210;
484                             azim[6] = 90;
485                             azim[7] = 270;
486                             break;
487     case AV_CH_LAYOUT_7POINT0:
488                             azim[0] = 30;
489                             azim[1] = 330;
490                             azim[2] = 0;
491                             azim[3] = 150;
492                             azim[4] = 210;
493                             azim[5] = 90;
494                             azim[6] = 270;
495                             break;
496     case AV_CH_LAYOUT_OCTAGONAL:
497                             azim[0] = 30;
498                             azim[1] = 330;
499                             azim[2] = 0;
500                             azim[3] = 150;
501                             azim[4] = 210;
502                             azim[5] = 180;
503                             azim[6] = 90;
504                             azim[7] = 270;
505                             break;
506     default:
507                             return -1;
508     }
509
510     memcpy(speaker_azim, azim, n_conv * sizeof(float));
511     memcpy(speaker_elev, elev, n_conv * sizeof(float));
512
513     return 0;
514
515 }
516
517 static int max_delay(struct NCSofa *sofa)
518 {
519     int i, max = 0;
520
521     for (i = 0; i < sofa->m_dim * 2; i++) {
522         /* search maximum delay in given SOFA file */
523         max = FFMAX(max, sofa->data_delay[i]);
524     }
525
526     return max;
527 }
528
529 static int find_m(SOFAlizerContext *s, int azim, int elev, float radius)
530 {
531     /* get source positions and M of currently selected SOFA file */
532     float *sp_a = s->sofa.sp_a; /* azimuth angle */
533     float *sp_e = s->sofa.sp_e; /* elevation angle */
534     float *sp_r = s->sofa.sp_r; /* radius */
535     int m_dim = s->sofa.m_dim; /* no. measurements */
536     int best_id = 0; /* index m currently closest to desired source pos. */
537     float delta = 1000; /* offset between desired and currently best pos. */
538     float current;
539     int i;
540
541     for (i = 0; i < m_dim; i++) {
542         /* search through all measurements in currently selected SOFA file */
543         /* distance of current to desired source position: */
544         current = fabs(sp_a[i] - azim) +
545                   fabs(sp_e[i] - elev) +
546                   fabs(sp_r[i] - radius);
547         if (current <= delta) {
548             /* if current distance is smaller than smallest distance so far */
549             delta = current;
550             best_id = i; /* remember index */
551         }
552     }
553
554     return best_id;
555 }
556
557 static int compensate_volume(AVFilterContext *ctx)
558 {
559     struct SOFAlizerContext *s = ctx->priv;
560     float compensate;
561     float energy = 0;
562     float *ir;
563     int m, j;
564
565     if (s->sofa.ncid) {
566         /* find IR at front center position in the SOFA file (IR closest to 0°,0°,1m) */
567         struct NCSofa *sofa = &s->sofa;
568         m = find_m(s, 0, 0, 1);
569         /* get energy of that IR and compensate volume */
570         ir = sofa->data_ir + 2 * m * sofa->n_samples;
571         for (j = 0; j < sofa->n_samples; j++) {
572             energy += *(ir + j) * *(ir + j);
573         }
574         compensate = 256 / (sofa->n_samples * sqrt(energy));
575         av_log(ctx, AV_LOG_DEBUG, "Compensate-factor: %f\n", compensate);
576         ir = sofa->data_ir;
577         for (j = 0; j < sofa->n_samples * sofa->m_dim * 2; j++) {
578             ir[j] *= compensate; /* apply volume compensation to IRs */
579         }
580     }
581
582     return 0;
583 }
584
585 typedef struct ThreadData {
586     AVFrame *in, *out;
587     int *write;
588     int **delay;
589     float **ir;
590     int *n_clippings;
591     float **ringbuffer;
592     float **temp_src;
593 } ThreadData;
594
595 static int sofalizer_convolute(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
596 {
597     SOFAlizerContext *s = ctx->priv;
598     ThreadData *td = arg;
599     AVFrame *in = td->in, *out = td->out;
600     int offset = jobnr;
601     int *write = &td->write[jobnr];
602     const int *const delay = td->delay[jobnr];
603     const float *const ir = td->ir[jobnr];
604     int *n_clippings = &td->n_clippings[jobnr];
605     float *ringbuffer = td->ringbuffer[jobnr];
606     float *temp_src = td->temp_src[jobnr];
607     const int n_samples = s->sofa.n_samples; /* length of one IR */
608     const float *src = (const float *)in->data[0]; /* get pointer to audio input buffer */
609     float *dst = (float *)out->data[0]; /* get pointer to audio output buffer */
610     const int in_channels = s->n_conv; /* number of input channels */
611     /* ring buffer length is: longest IR plus max. delay -> next power of 2 */
612     const int buffer_length = s->buffer_length;
613     /* -1 for AND instead of MODULO (applied to powers of 2): */
614     const uint32_t modulo = (uint32_t)buffer_length - 1;
615     float *buffer[10]; /* holds ringbuffer for each input channel */
616     int wr = *write;
617     int read;
618     int i, l;
619
620     dst += offset;
621     for (l = 0; l < in_channels; l++) {
622         /* get starting address of ringbuffer for each input channel */
623         buffer[l] = ringbuffer + l * buffer_length;
624     }
625
626     for (i = 0; i < in->nb_samples; i++) {
627         const float *temp_ir = ir; /* using same set of IRs for each sample */
628
629         *dst = 0;
630         for (l = 0; l < in_channels; l++) {
631             /* write current input sample to ringbuffer (for each channel) */
632             *(buffer[l] + wr) = src[l];
633         }
634
635         /* loop goes through all channels to be convolved */
636         for (l = 0; l < in_channels; l++) {
637             const float *const bptr = buffer[l];
638
639             if (l == s->lfe_channel) {
640                 /* LFE is an input channel but requires no convolution */
641                 /* apply gain to LFE signal and add to output buffer */
642                 *dst += *(buffer[s->lfe_channel] + wr) * s->gain_lfe;
643                 temp_ir += n_samples;
644                 continue;
645             }
646
647             /* current read position in ringbuffer: input sample write position
648              * - delay for l-th ch. + diff. betw. IR length and buffer length
649              * (mod buffer length) */
650             read = (wr - *(delay + l) - (n_samples - 1) + buffer_length) & modulo;
651
652             if (read + n_samples < buffer_length) {
653                 memcpy(temp_src, bptr + read, n_samples * sizeof(*temp_src));
654             } else {
655                 int len = FFMIN(n_samples - (read % n_samples), buffer_length - read);
656
657                 memcpy(temp_src, bptr + read, len * sizeof(*temp_src));
658                 memcpy(temp_src + len, bptr, (n_samples - len) * sizeof(*temp_src));
659             }
660
661             /* multiply signal and IR, and add up the results */
662             dst[0] += s->fdsp->scalarproduct_float(temp_ir, temp_src, n_samples);
663             temp_ir += n_samples;
664         }
665
666         /* clippings counter */
667         if (fabs(*dst) > 1)
668             *n_clippings += 1;
669
670         /* move output buffer pointer by +2 to get to next sample of processed channel: */
671         dst += 2;
672         src += in_channels;
673         wr   = (wr + 1) & modulo; /* update ringbuffer write position */
674     }
675
676     *write = wr; /* remember write position in ringbuffer for next call */
677
678     return 0;
679 }
680
681 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
682 {
683     AVFilterContext *ctx = inlink->dst;
684     SOFAlizerContext *s = ctx->priv;
685     AVFilterLink *outlink = ctx->outputs[0];
686     int n_clippings[2] = { 0 };
687     ThreadData td;
688     AVFrame *out;
689
690     out = ff_get_audio_buffer(outlink, in->nb_samples);
691     if (!out) {
692         av_frame_free(&in);
693         return AVERROR(ENOMEM);
694     }
695     av_frame_copy_props(out, in);
696
697     td.in = in; td.out = out; td.write = s->write;
698     td.delay = s->delay; td.ir = s->data_ir; td.n_clippings = n_clippings;
699     td.ringbuffer = s->ringbuffer; td.temp_src = s->temp_src;
700
701     ctx->internal->execute(ctx, sofalizer_convolute, &td, NULL, 2);
702     emms_c();
703
704     /* display error message if clipping occured */
705     if (n_clippings[0] + n_clippings[1] > 0) {
706         av_log(ctx, AV_LOG_WARNING, "%d of %d samples clipped. Please reduce gain.\n",
707                n_clippings[0] + n_clippings[1], out->nb_samples * 2);
708     }
709
710     av_frame_free(&in);
711     return ff_filter_frame(outlink, out);
712 }
713
714 static int query_formats(AVFilterContext *ctx)
715 {
716     struct SOFAlizerContext *s = ctx->priv;
717     AVFilterFormats *formats = NULL;
718     AVFilterChannelLayouts *layouts = NULL;
719     int ret, sample_rates[] = { 48000, -1 };
720     static const uint64_t channel_layouts[] = { AV_CH_LAYOUT_MONO,
721                                                 AV_CH_LAYOUT_STEREO,
722                                                 AV_CH_LAYOUT_2POINT1,
723                                                 AV_CH_LAYOUT_SURROUND,
724                                                 AV_CH_LAYOUT_2_1,
725                                                 AV_CH_LAYOUT_4POINT0,
726                                                 AV_CH_LAYOUT_QUAD,
727                                                 AV_CH_LAYOUT_2_2,
728                                                 AV_CH_LAYOUT_3POINT1,
729                                                 AV_CH_LAYOUT_5POINT0_BACK,
730                                                 AV_CH_LAYOUT_5POINT0,
731                                                 AV_CH_LAYOUT_4POINT1,
732                                                 AV_CH_LAYOUT_5POINT1_BACK,
733                                                 AV_CH_LAYOUT_5POINT1,
734                                                 AV_CH_LAYOUT_6POINT0,
735                                                 AV_CH_LAYOUT_HEXAGONAL,
736                                                 AV_CH_LAYOUT_6POINT1,
737                                                 AV_CH_LAYOUT_6POINT1_BACK,
738                                                 AV_CH_LAYOUT_7POINT0,
739                                                 AV_CH_LAYOUT_7POINT1,
740                                                 AV_CH_LAYOUT_OCTAGONAL,
741                                                 0, };
742
743     ret = ff_add_format(&formats, AV_SAMPLE_FMT_FLT);
744     if (ret)
745         return ret;
746     ret = ff_set_common_formats(ctx, formats);
747     if (ret)
748         return ret;
749
750     layouts = ff_make_formatu64_list(channel_layouts);
751     if (!layouts)
752         return AVERROR(ENOMEM);
753
754     ret = ff_channel_layouts_ref(layouts, &ctx->inputs[0]->out_channel_layouts);
755     if (ret)
756         return ret;
757
758     layouts = NULL;
759     ret = ff_add_channel_layout(&layouts, AV_CH_LAYOUT_STEREO);
760     if (ret)
761         return ret;
762
763     ret = ff_channel_layouts_ref(layouts, &ctx->outputs[0]->in_channel_layouts);
764     if (ret)
765         return ret;
766
767     sample_rates[0] = s->sample_rate;
768     formats = ff_make_format_list(sample_rates);
769     if (!formats)
770         return AVERROR(ENOMEM);
771     return ff_set_common_samplerates(ctx, formats);
772 }
773
774 static int load_data(AVFilterContext *ctx, int azim, int elev, float radius)
775 {
776     struct SOFAlizerContext *s = ctx->priv;
777     const int n_samples = s->sofa.n_samples;
778     int n_conv = s->n_conv; /* no. channels to convolve */
779     int delay_l[10]; /* broadband delay for each IR */
780     int delay_r[10];
781     int nb_input_channels = ctx->inputs[0]->channels; /* no. input channels */
782     float gain_lin = expf((s->gain - 3 * nb_input_channels) / 20 * M_LN10); /* gain - 3dB/channel */
783     float *data_ir_l = NULL;
784     float *data_ir_r = NULL;
785     int offset = 0; /* used for faster pointer arithmetics in for-loop */
786     int m[10]; /* measurement index m of IR closest to required source positions */
787     int i, j, azim_orig = azim, elev_orig = elev;
788
789     if (!s->sofa.ncid) { /* if an invalid SOFA file has been selected */
790         av_log(ctx, AV_LOG_ERROR, "Selected SOFA file is invalid. Please select valid SOFA file.\n");
791         return AVERROR_INVALIDDATA;
792     }
793
794     /* get temporary IR for L and R channel */
795     data_ir_l = av_malloc_array(n_conv * n_samples, sizeof(*data_ir_l));
796     data_ir_r = av_malloc_array(n_conv * n_samples, sizeof(*data_ir_r));
797     if (!data_ir_r || !data_ir_l) {
798         av_free(data_ir_l);
799         av_free(data_ir_r);
800         return AVERROR(ENOMEM);
801     }
802
803     for (i = 0; i < s->n_conv; i++) {
804         /* load and store IRs and corresponding delays */
805         azim = (int)(s->speaker_azim[i] + azim_orig) % 360;
806         elev = (int)(s->speaker_elev[i] + elev_orig) % 90;
807         /* get id of IR closest to desired position */
808         m[i] = find_m(s, azim, elev, radius);
809
810         /* load the delays associated with the current IRs */
811         delay_l[i] = *(s->sofa.data_delay + 2 * m[i]);
812         delay_r[i] = *(s->sofa.data_delay + 2 * m[i] + 1);
813
814         offset = i * n_samples; /* no. samples already written */
815         for (j = 0; j < n_samples; j++) {
816             /* load reversed IRs of the specified source position
817              * sample-by-sample for left and right ear; and apply gain */
818             *(data_ir_l + offset + j) = /* left channel */
819             *(s->sofa.data_ir + 2 * m[i] * n_samples + n_samples - 1 - j) * gain_lin;
820             *(data_ir_r + offset + j) = /* right channel */
821             *(s->sofa.data_ir + 2 * m[i] * n_samples + n_samples - 1 - j  + n_samples) * gain_lin;
822         }
823
824         av_log(ctx, AV_LOG_DEBUG, "Index: %d, Azimuth: %f, Elevation: %f, Radius: %f of SOFA file.\n",
825                m[i], *(s->sofa.sp_a + m[i]), *(s->sofa.sp_e + m[i]), *(s->sofa.sp_r + m[i]));
826     }
827
828     /* copy IRs and delays to allocated memory in the SOFAlizerContext struct: */
829     memcpy(s->data_ir[0], data_ir_l, sizeof(float) * n_conv * n_samples);
830     memcpy(s->data_ir[1], data_ir_r, sizeof(float) * n_conv * n_samples);
831
832     av_free(data_ir_l); /* free temporary IR memory */
833     av_free(data_ir_r);
834
835     memcpy(s->delay[0], &delay_l[0], sizeof(int) * s->n_conv);
836     memcpy(s->delay[1], &delay_r[0], sizeof(int) * s->n_conv);
837
838     return 0;
839 }
840
841 static av_cold int init(AVFilterContext *ctx)
842 {
843     SOFAlizerContext *s = ctx->priv;
844     int ret;
845
846     /* load SOFA file, */
847     /* initialize file IDs to 0 before attempting to load SOFA files,
848      * this assures that in case of error, only the memory of already
849      * loaded files is free'd */
850     s->sofa.ncid = 0;
851     ret = load_sofa(ctx, s->filename, &s->sample_rate);
852     if (ret) {
853         /* file loading error */
854         av_log(ctx, AV_LOG_ERROR, "Error while loading SOFA file: '%s'\n", s->filename);
855     } else { /* no file loading error, resampling not required */
856         av_log(ctx, AV_LOG_DEBUG, "File '%s' loaded.\n", s->filename);
857     }
858
859     if (ret) {
860         av_log(ctx, AV_LOG_ERROR, "No valid SOFA file could be loaded. Please specify valid SOFA file.\n");
861         return ret;
862     }
863
864     s->fdsp = avpriv_float_dsp_alloc(0);
865     if (!s->fdsp)
866         return AVERROR(ENOMEM);
867
868     return 0;
869 }
870
871 static inline unsigned clz(unsigned x)
872 {
873     unsigned i = sizeof(x) * 8;
874
875     while (x) {
876         x >>= 1;
877         i--;
878     }
879
880     return i;
881 }
882
883 static int config_input(AVFilterLink *inlink)
884 {
885     AVFilterContext *ctx = inlink->dst;
886     SOFAlizerContext *s = ctx->priv;
887     int nb_input_channels = inlink->channels; /* no. input channels */
888     int n_max_ir = 0;
889     int n_current;
890     int n_max = 0;
891     int ret;
892
893     /* gain -3 dB per channel, -6 dB to get LFE on a similar level */
894     s->gain_lfe = expf((s->gain - 3 * inlink->channels - 6) / 20 * M_LN10);
895
896     s->n_conv = nb_input_channels;
897
898     /* get size of ringbuffer (longest IR plus max. delay) */
899     /* then choose next power of 2 for performance optimization */
900     n_current = s->sofa.n_samples + max_delay(&s->sofa);
901     if (n_current > n_max) {
902         /* length of longest IR plus max. delay (in all SOFA files) */
903         n_max = n_current;
904         /* length of longest IR (without delay, in all SOFA files) */
905         n_max_ir = s->sofa.n_samples;
906     }
907     /* buffer length is longest IR plus max. delay -> next power of 2
908        (32 - count leading zeros gives required exponent)  */
909     s->buffer_length = exp2(32 - clz((uint32_t)n_max));
910
911     /* Allocate memory for the impulse responses, delays and the ringbuffers */
912     /* size: (longest IR) * (number of channels to convolute) */
913     s->data_ir[0] = av_malloc_array(n_max_ir, sizeof(float) * s->n_conv);
914     s->data_ir[1] = av_malloc_array(n_max_ir, sizeof(float) * s->n_conv);
915     /* length:  number of channels to convolute */
916     s->delay[0] = av_malloc_array(s->n_conv, sizeof(float));
917     s->delay[1] = av_malloc_array(s->n_conv, sizeof(float));
918     /* length: (buffer length) * (number of input channels),
919      * OR: buffer length (if frequency domain processing)
920      * calloc zero-initializes the buffer */
921     s->ringbuffer[0] = av_calloc(s->buffer_length, sizeof(float) * nb_input_channels);
922     s->ringbuffer[1] = av_calloc(s->buffer_length, sizeof(float) * nb_input_channels);
923     /* length: number of channels to convolute */
924     s->speaker_azim = av_calloc(s->n_conv, sizeof(*s->speaker_azim));
925     s->speaker_elev = av_calloc(s->n_conv, sizeof(*s->speaker_elev));
926
927     /* memory allocation failed: */
928     if (!s->data_ir[0] || !s->data_ir[1] || !s->delay[1] ||
929         !s->delay[0] || !s->ringbuffer[0] || !s->ringbuffer[1] ||
930         !s->speaker_azim || !s->speaker_elev)
931         return AVERROR(ENOMEM);
932
933     compensate_volume(ctx);
934
935     /* get speaker positions */
936     if ((ret = get_speaker_pos(ctx, s->speaker_azim, s->speaker_elev)) < 0) {
937         av_log(ctx, AV_LOG_ERROR, "Couldn't get speaker positions. Input channel configuration not supported.\n");
938         return ret;
939     }
940     /* load IRs to data_ir[0] and data_ir[1] for required directions */
941     /* only load IRs if time-domain convolution is used. */
942     if ((ret = load_data(ctx, s->rotation, s->elevation, s->radius)) < 0)
943         return ret;
944
945     av_log(ctx, AV_LOG_DEBUG, "Samplerate: %d Channels to convolute: %d, Length of ringbuffer: %d x %d\n",
946         inlink->sample_rate, s->n_conv, nb_input_channels, s->buffer_length);
947
948     return 0;
949 }
950
951 static av_cold void uninit(AVFilterContext *ctx)
952 {
953     SOFAlizerContext *s = ctx->priv;
954
955     if (s->sofa.ncid) {
956         av_freep(&s->sofa.sp_a);
957         av_freep(&s->sofa.sp_e);
958         av_freep(&s->sofa.sp_r);
959         av_freep(&s->sofa.data_delay);
960         av_freep(&s->sofa.data_ir);
961     }
962     av_freep(&s->delay[0]);
963     av_freep(&s->delay[1]);
964     av_freep(&s->data_ir[0]);
965     av_freep(&s->data_ir[1]);
966     av_freep(&s->ringbuffer[0]);
967     av_freep(&s->ringbuffer[1]);
968     av_freep(&s->speaker_azim);
969     av_freep(&s->speaker_elev);
970     av_freep(&s->temp_src[0]);
971     av_freep(&s->temp_src[1]);
972     av_freep(&s->fdsp);
973 }
974
975 #define OFFSET(x) offsetof(SOFAlizerContext, x)
976 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
977
978 static const AVOption sofalizer_options[] = {
979     { "sofa",      "sofa filename",  OFFSET(filename),  AV_OPT_TYPE_STRING, {.str=NULL},            .flags = FLAGS },
980     { "gain",      "set gain in dB", OFFSET(gain),      AV_OPT_TYPE_FLOAT,  {.dbl=0},     -20,  40, .flags = FLAGS },
981     { "rotation",  "set rotation"  , OFFSET(rotation),  AV_OPT_TYPE_FLOAT,  {.dbl=0},    -360, 360, .flags = FLAGS },
982     { "elevation", "set elevation",  OFFSET(elevation), AV_OPT_TYPE_FLOAT,  {.dbl=0},     -90,  90, .flags = FLAGS },
983     { "radius",    "set radius",     OFFSET(radius),    AV_OPT_TYPE_FLOAT,  {.dbl=1},       0,   3, .flags = FLAGS },
984     { NULL }
985 };
986
987 AVFILTER_DEFINE_CLASS(sofalizer);
988
989 static const AVFilterPad inputs[] = {
990     {
991         .name         = "default",
992         .type         = AVMEDIA_TYPE_AUDIO,
993         .config_props = config_input,
994         .filter_frame = filter_frame,
995     },
996     { NULL }
997 };
998
999 static const AVFilterPad outputs[] = {
1000     {
1001         .name = "default",
1002         .type = AVMEDIA_TYPE_AUDIO,
1003     },
1004     { NULL }
1005 };
1006
1007 AVFilter ff_af_sofalizer = {
1008     .name          = "sofalizer",
1009     .description   = NULL_IF_CONFIG_SMALL("SOFAlizer (Spatially Oriented Format for Acoustics)."),
1010     .priv_size     = sizeof(SOFAlizerContext),
1011     .priv_class    = &sofalizer_class,
1012     .init          = init,
1013     .uninit        = uninit,
1014     .query_formats = query_formats,
1015     .inputs        = inputs,
1016     .outputs       = outputs,
1017     .flags         = AVFILTER_FLAG_SLICE_THREADS,
1018 };