1 /*****************************************************************************
2 * filters.c : audio output filters management
3 *****************************************************************************
4 * Copyright (C) 2002-2007 VLC authors and VideoLAN
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_dialog.h>
36 #include <vlc_modules.h>
38 #include <vlc_filter.h>
39 #include <vlc_vout.h> /* for vout_Request */
40 #include <vlc_input.h>
43 #include "aout_internal.h"
45 static filter_t *CreateFilter (vlc_object_t *obj, const char *type,
46 const char *name, filter_owner_sys_t *owner,
47 const audio_sample_format_t *infmt,
48 const audio_sample_format_t *outfmt)
50 filter_t *filter = vlc_custom_create (obj, sizeof (*filter), type);
51 if (unlikely(filter == NULL))
54 filter->p_owner = owner;
55 filter->fmt_in.audio = *infmt;
56 filter->fmt_in.i_codec = infmt->i_format;
57 filter->fmt_out.audio = *outfmt;
58 filter->fmt_out.i_codec = outfmt->i_format;
59 filter->p_module = module_need (filter, type, name, false);
60 if (filter->p_module == NULL)
62 /* If probing failed, formats shall not have been modified. */
63 assert (AOUT_FMTS_IDENTICAL(&filter->fmt_in.audio, infmt));
64 assert (AOUT_FMTS_IDENTICAL(&filter->fmt_out.audio, outfmt));
65 vlc_object_release (filter);
69 assert (filter->pf_audio_filter != NULL);
73 static filter_t *FindConverter (vlc_object_t *obj,
74 const audio_sample_format_t *infmt,
75 const audio_sample_format_t *outfmt)
77 return CreateFilter (obj, "audio converter", NULL, NULL, infmt, outfmt);
80 static filter_t *FindResampler (vlc_object_t *obj,
81 const audio_sample_format_t *infmt,
82 const audio_sample_format_t *outfmt)
84 return CreateFilter (obj, "audio resampler", "$audio-resampler", NULL,
89 * Destroys a chain of audio filters.
91 static void aout_FiltersPipelineDestroy(filter_t *const *filters, unsigned n)
93 for( unsigned i = 0; i < n; i++ )
95 filter_t *p_filter = filters[i];
97 module_unneed( p_filter, p_filter->p_module );
98 vlc_object_release( p_filter );
102 static filter_t *TryFormat (vlc_object_t *obj, vlc_fourcc_t codec,
103 audio_sample_format_t *restrict fmt)
105 audio_sample_format_t output = *fmt;
107 assert (codec != fmt->i_format);
108 output.i_format = codec;
109 aout_FormatPrepare (&output);
111 filter_t *filter = FindConverter (obj, fmt, &output);
118 * Allocates audio format conversion filters
119 * @param obj parent VLC object for new filters
120 * @param filters table of filters [IN/OUT]
121 * @param count pointer to the number of filters in the table [IN/OUT]
122 * @param max size of filters table [IN]
123 * @param infmt input audio format
124 * @param outfmt output audio format
125 * @return 0 on success, -1 on failure
127 static int aout_FiltersPipelineCreate(vlc_object_t *obj, filter_t **filters,
128 unsigned *count, unsigned max,
129 const audio_sample_format_t *restrict infmt,
130 const audio_sample_format_t *restrict outfmt)
132 aout_FormatsPrint (obj, "conversion:", infmt, outfmt);
136 /* There is a lot of second guessing on what the conversion plugins can
137 * and cannot do. This seems hardly avoidable, the conversion problem need
138 * to be reduced somehow. */
139 audio_sample_format_t input = *infmt;
142 /* Encapsulate or decode non-linear formats */
143 if (!AOUT_FMT_LINEAR(infmt) && infmt->i_format != outfmt->i_format)
148 filter_t *f = TryFormat (obj, VLC_CODEC_S32N, &input);
150 f = TryFormat (obj, VLC_CODEC_FL32, &input);
153 msg_Err (obj, "cannot find %s for conversion pipeline",
160 assert (AOUT_FMT_LINEAR(&input));
163 if (infmt->i_physical_channels != outfmt->i_physical_channels
164 || infmt->i_original_channels != outfmt->i_original_channels)
165 { /* Remixing currently requires FL32... TODO: S16N */
166 if (input.i_format != VLC_CODEC_FL32)
171 filter_t *f = TryFormat (obj, VLC_CODEC_FL32, &input);
174 msg_Err (obj, "cannot find %s for conversion pipeline",
175 "pre-mix converter");
185 audio_sample_format_t output;
186 output.i_format = input.i_format;
187 output.i_rate = input.i_rate;
188 output.i_physical_channels = outfmt->i_physical_channels;
189 output.i_original_channels = outfmt->i_original_channels;
190 aout_FormatPrepare (&output);
192 filter_t *f = FindConverter (obj, &input, &output);
195 msg_Err (obj, "cannot find %s for conversion pipeline",
205 if (input.i_rate != outfmt->i_rate)
206 { /* Resampling works with any linear format, but may be ugly. */
210 audio_sample_format_t output = input;
211 output.i_rate = outfmt->i_rate;
213 filter_t *f = FindConverter (obj, &input, &output);
216 msg_Err (obj, "cannot find %s for conversion pipeline",
226 if (input.i_format != outfmt->i_format)
231 filter_t *f = TryFormat (obj, outfmt->i_format, &input);
234 msg_Err (obj, "cannot find %s for conversion pipeline",
235 "post-mix converter");
241 msg_Dbg (obj, "conversion pipeline complete");
246 msg_Err (obj, "maximum of %u conversion filters reached", max);
247 dialog_Fatal (obj, _("Audio filtering failed"),
248 _("The maximum number of filters (%u) was reached."), max);
250 aout_FiltersPipelineDestroy (filters, n);
255 * Filters an audio buffer through a chain of filters.
257 static block_t *aout_FiltersPipelinePlay(filter_t *const *filters,
258 unsigned count, block_t *block)
260 /* TODO: use filter chain */
261 for (unsigned i = 0; (i < count) && (block != NULL); i++)
263 filter_t *filter = filters[i];
265 /* Please note that p_block->i_nb_samples & i_buffer
266 * shall be set by the filter plug-in. */
267 block = filter->pf_audio_filter (filter, block);
272 #define AOUT_MAX_FILTERS 10
276 filter_t *rate_filter; /**< The filter adjusting samples count
277 (either the scaletempo filter or a resampler) */
278 filter_t *resampler; /**< The resampler */
279 int resampling; /**< Current resampling (Hz) */
281 unsigned count; /**< Number of filters */
282 filter_t *tab[AOUT_MAX_FILTERS]; /**< Configured user filters
283 (e.g. equalization) and their conversions */
286 /** Callback for visualization selection */
287 static int VisualizationCallback (vlc_object_t *obj, const char *var,
288 vlc_value_t oldval, vlc_value_t newval,
291 const char *mode = newval.psz_string;
295 /* FIXME: This ugly hack enforced by visual effect-list, as is the need for
296 * separate "visual" (external) and "audio-visual" (internal) variables...
297 * The visual plugin should have one submodule per effect instead. */
298 if (strcasecmp (mode, "none") && strcasecmp (mode, "goom")
299 && strcasecmp (mode, "projectm") && strcasecmp (mode, "vsxu")
300 && strcasecmp (mode, "glspectrum"))
302 var_Create (obj, "effect-list", VLC_VAR_STRING);
303 var_SetString (obj, "effect-list", mode);
307 var_SetString (obj, "audio-visual", mode);
308 aout_InputRequestRestart ((audio_output_t *)obj);
309 (void) var; (void) oldval; (void) data;
313 static int EqualizerCallback (vlc_object_t *obj, const char *var,
314 vlc_value_t oldval, vlc_value_t newval,
317 const char *val = newval.psz_string;
319 if (aout_ChangeFilterString (obj, obj, "audio-filter", "equalizer", *val))
320 aout_InputRequestRestart ((audio_output_t *)obj); /* <- That sucks! */
322 (void) var; (void) oldval; (void) data;
326 vout_thread_t *aout_filter_RequestVout (filter_t *filter, vout_thread_t *vout,
329 /* NOTE: This only works from aout_filters_t.
330 * If you want to use visualization filters from another place, you will
331 * need to add a new pf_aout_request_vout callback or store a pointer
332 * to aout_request_vout_t inside filter_t (i.e. a level of indirection). */
333 const aout_request_vout_t *req = (void *)filter->p_owner;
334 char *visual = var_InheritString (filter->p_parent, "audio-visual");
335 /* NOTE: Disable recycling to always close the filter vout because OpenGL
336 * visualizations do not use this function to ask for a context. */
337 bool recycle = false;
340 return req->pf_request_vout (req->p_private, vout, fmt, recycle);
343 static int AppendFilter(vlc_object_t *obj, const char *type, const char *name,
344 aout_filters_t *restrict filters, const void *owner,
345 audio_sample_format_t *restrict infmt,
346 const audio_sample_format_t *restrict outfmt)
348 const unsigned max = sizeof (filters->tab) / sizeof (filters->tab[0]);
349 if (filters->count >= max)
351 msg_Err (obj, "maximum of %u filters reached", max);
355 filter_t *filter = CreateFilter (obj, type, name,
356 (void *)owner, infmt, outfmt);
359 msg_Err (obj, "cannot add user %s \"%s\" (skipped)", type, name);
363 /* convert to the filter input format if necessary */
364 if (aout_FiltersPipelineCreate (obj, filters->tab, &filters->count,
365 max - 1, infmt, &filter->fmt_in.audio))
367 msg_Err (filter, "cannot add user %s \"%s\" (skipped)", type, name);
368 module_unneed (filter, filter->p_module);
369 vlc_object_release (filter);
373 assert (filters->count < max);
374 filters->tab[filters->count] = filter;
376 *infmt = filter->fmt_out.audio;
380 #undef aout_FiltersNew
382 * Sets a chain of audio filters up.
383 * \param obj parent object for the filters
384 * \param infmt chain input format [IN]
385 * \param outfmt chain output format [IN]
386 * \param request_vout visualization video output request callback
387 * \return a filters chain or NULL on failure
390 * *request_vout (if not NULL) must remain valid until aout_FiltersDelete().
393 * If request_vout is non NULL, obj is assumed to be an audio_output_t pointer.
395 aout_filters_t *aout_FiltersNew (vlc_object_t *obj,
396 const audio_sample_format_t *restrict infmt,
397 const audio_sample_format_t *restrict outfmt,
398 const aout_request_vout_t *request_vout)
400 aout_filters_t *filters = malloc (sizeof (*filters));
401 if (unlikely(filters == NULL))
404 filters->rate_filter = NULL;
405 filters->resampler = NULL;
406 filters->resampling = 0;
409 /* Prepare format structure */
410 aout_FormatPrint (obj, "input", infmt);
411 audio_sample_format_t input_format = *infmt;
412 audio_sample_format_t output_format = *outfmt;
414 /* Callbacks (before reading values and also before return statement) */
415 if (request_vout != NULL)
417 var_AddCallback (obj, "equalizer-bands", EqualizerCallback, NULL);
418 var_AddCallback (obj, "visual", VisualizationCallback, NULL);
420 var_TriggerCallback( obj, "equalizer-bands" );
423 /* Now add user filters */
424 if (!AOUT_FMT_LINEAR(outfmt))
425 { /* Non-linear output: just convert formats, no filters/visu */
426 if (!AOUT_FMTS_IDENTICAL(infmt, outfmt))
428 aout_FormatsPrint (obj, "pass-through:", infmt, outfmt);
429 filters->tab[0] = FindConverter(obj, infmt, outfmt);
430 if (filters->tab[0] == NULL)
432 msg_Err (obj, "cannot setup pass-through");
440 /* parse user filter lists */
441 if (var_InheritBool (obj, "audio-time-stretch"))
443 if (AppendFilter(obj, "audio filter", "scaletempo",
444 filters, NULL, &input_format, &output_format) == 0)
445 filters->rate_filter = filters->tab[filters->count - 1];
448 char *str = var_InheritString (obj, "audio-filter");
451 char *p = str, *name;
452 while ((name = strsep (&p, " :")) != NULL)
454 AppendFilter(obj, "audio filter", name, filters,
455 NULL, &input_format, &output_format);
460 if (request_vout != NULL)
462 char *visual = var_InheritString (obj, "audio-visual");
463 if (visual != NULL && strcasecmp (visual, "none"))
464 AppendFilter(obj, "visualization", visual, filters,
465 request_vout, &input_format, &output_format);
469 /* convert to the output format (minus resampling) if necessary */
470 output_format.i_rate = input_format.i_rate;
471 if (aout_FiltersPipelineCreate (obj, filters->tab, &filters->count,
472 AOUT_MAX_FILTERS, &input_format, &output_format))
474 msg_Err (obj, "cannot setup filtering pipeline");
477 input_format = output_format;
479 /* insert the resampler */
480 output_format.i_rate = outfmt->i_rate;
481 assert (AOUT_FMTS_IDENTICAL(&output_format, outfmt));
482 filters->resampler = FindResampler (obj, &input_format,
484 if (filters->resampler == NULL && input_format.i_rate != outfmt->i_rate)
486 msg_Err (obj, "cannot setup a resampler");
489 if (filters->rate_filter == NULL)
490 filters->rate_filter = filters->resampler;
495 aout_FiltersPipelineDestroy (filters->tab, filters->count);
496 var_DelCallback (obj, "equalizer-bands", EqualizerCallback, NULL);
497 var_DelCallback (obj, "visual", VisualizationCallback, NULL);
502 #undef aout_FiltersDelete
504 * Destroys a chain of audio filters.
505 * \param obj object used with aout_FiltersNew()
506 * \param filters chain to be destroyed
508 * obj must be NULL iff request_vout was NULL in aout_FiltersNew()
509 * (this implies obj is an audio_output_t pointer if non NULL).
511 void aout_FiltersDelete (vlc_object_t *obj, aout_filters_t *filters)
513 if (filters->resampler != NULL)
514 aout_FiltersPipelineDestroy (&filters->resampler, 1);
515 aout_FiltersPipelineDestroy (filters->tab, filters->count);
518 var_DelCallback (obj, "equalizer-bands", EqualizerCallback, NULL);
519 var_DelCallback (obj, "visual", VisualizationCallback, NULL);
524 bool aout_FiltersAdjustResampling (aout_filters_t *filters, int adjust)
526 if (filters->resampler == NULL)
530 filters->resampling += adjust;
532 filters->resampling = 0;
533 return filters->resampling != 0;
536 block_t *aout_FiltersPlay (aout_filters_t *filters, block_t *block, int rate)
538 int nominal_rate = 0;
540 if (rate != INPUT_RATE_DEFAULT)
542 filter_t *rate_filter = filters->rate_filter;
544 if (rate_filter == NULL)
545 goto drop; /* Without linear, non-nominal rate is impossible. */
547 /* Override input rate */
548 nominal_rate = rate_filter->fmt_in.audio.i_rate;
549 rate_filter->fmt_in.audio.i_rate =
550 (nominal_rate * INPUT_RATE_DEFAULT) / rate;
553 block = aout_FiltersPipelinePlay (filters->tab, filters->count, block);
554 if (filters->resampler != NULL)
555 { /* NOTE: the resampler needs to run even if resampling is 0.
556 * The decoder and output rates can still be different. */
557 filters->resampler->fmt_in.audio.i_rate += filters->resampling;
558 block = aout_FiltersPipelinePlay (&filters->resampler, 1, block);
559 filters->resampler->fmt_in.audio.i_rate -= filters->resampling;
562 if (nominal_rate != 0)
563 { /* Restore input rate */
564 assert (filters->rate_filter != NULL);
565 filters->rate_filter->fmt_in.audio.i_rate = nominal_rate;
570 block_Release (block);