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,
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 not set here */
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, 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",
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);
254 #define aout_FiltersPipelineCreate(obj,f,n,m,i,o) \
255 aout_FiltersPipelineCreate(VLC_OBJECT(obj),f,n,m,i,o)
258 * Filters an audio buffer through a chain of filters.
260 static block_t *aout_FiltersPipelinePlay(filter_t *const *filters,
261 unsigned count, block_t *block)
263 /* TODO: use filter chain */
264 for (unsigned i = 0; (i < count) && (block != NULL); i++)
266 filter_t *filter = filters[i];
268 /* Please note that p_block->i_nb_samples & i_buffer
269 * shall be set by the filter plug-in. */
270 block = filter->pf_audio_filter (filter, block);
277 filter_t *rate_filter; /**< The filter adjusting samples count
278 (either the scaletempo filter or a resampler) */
279 filter_t *resampler; /**< The resampler */
280 int resampling; /**< Current resampling (Hz) */
282 unsigned count; /**< Number of filters */
283 filter_t *tab[AOUT_MAX_FILTERS]; /**< Configured user filters
284 (e.g. equalization) and their conversions */
287 /** Callback for visualization selection */
288 static int VisualizationCallback (vlc_object_t *obj, const char *var,
289 vlc_value_t oldval, vlc_value_t newval,
292 const char *mode = newval.psz_string;
296 /* FIXME: This ugly hack enforced by visual effect-list, as is the need for
297 * separate "visual" (external) and "audio-visual" (internal) variables...
298 * The visual plugin should have one submodule per effect instead. */
299 if (strcasecmp (mode, "none") && strcasecmp (mode, "goom")
300 && strcasecmp (mode, "projectm") && strcasecmp (mode, "vsxu"))
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;
321 var_Create (obj, "equalizer-preset", VLC_VAR_STRING);
322 var_SetString (obj, "equalizer-preset", val);
325 if (aout_ChangeFilterString (obj, obj, "audio-filter", "equalizer", *val))
326 aout_InputRequestRestart ((audio_output_t *)obj); /* <- That sucks! */
328 (void) var; (void) oldval; (void) data;
332 vout_thread_t *aout_filter_RequestVout (filter_t *filter, vout_thread_t *vout,
335 /* NOTE: This only works from audio output.
336 * If you want to use visualization filters from another place, you will
337 * need to add a new pf_aout_request_vout callback or store a pointer
338 * to aout_request_vout_t inside filter_t (i.e. a level of indirection). */
339 aout_owner_t *owner = aout_owner ((audio_output_t *)filter->p_parent);
340 aout_request_vout_t *req = &owner->request_vout;
342 return req->pf_request_vout (req->p_private, vout, fmt,
343 owner->recycle_vout);
346 static int AppendFilter(vlc_object_t *obj, const char *type, const char *name,
347 aout_filters_t *restrict filters,
348 audio_sample_format_t *restrict infmt,
349 const audio_sample_format_t *restrict outfmt)
351 const unsigned max = sizeof (filters->tab) / sizeof (filters->tab[0]);
352 if (filters->count >= max)
354 msg_Err (obj, "maximum of %u filters reached", max);
358 filter_t *filter = CreateFilter (obj, type, name, infmt, outfmt);
361 msg_Err (obj, "cannot add user %s \"%s\" (skipped)", type, name);
365 /* convert to the filter input format if necessary */
366 if (aout_FiltersPipelineCreate (filter, filters->tab, &filters->count,
367 max - 1, infmt, &filter->fmt_in.audio))
369 msg_Err (filter, "cannot add user %s \"%s\" (skipped)", type, name);
370 module_unneed (filter, filter->p_module);
371 vlc_object_release (filter);
375 assert (filters->count < max);
376 filters->tab[filters->count] = filter;
378 *infmt = filter->fmt_out.audio;
384 * Sets up the audio filters.
386 aout_filters_t *aout_FiltersNew (audio_output_t *aout,
387 const audio_sample_format_t *restrict infmt,
388 const audio_sample_format_t *restrict outfmt,
389 const aout_request_vout_t *request_vout)
391 aout_filters_t *filters = malloc (sizeof (*filters));
392 if (unlikely(filters == NULL))
395 filters->rate_filter = NULL;
396 filters->resampler = NULL;
397 filters->resampling = 0;
400 aout_owner_t *owner = aout_owner (aout);
402 /* Prepare format structure */
403 aout_FormatPrint (aout, "input", infmt);
404 audio_sample_format_t input_format = *infmt;
405 audio_sample_format_t output_format = *outfmt;
407 /* Now add user filters */
408 var_AddCallback (aout, "visual", VisualizationCallback, NULL);
409 var_AddCallback (aout, "equalizer", EqualizerCallback, NULL);
411 if (!AOUT_FMT_LINEAR(outfmt))
412 { /* Non-linear output: just convert formats, no filters/visu */
413 if (!AOUT_FMTS_IDENTICAL(infmt, outfmt))
415 aout_FormatsPrint (aout, "pass-through:", infmt, outfmt);
416 filters->tab[0] = FindConverter(VLC_OBJECT(aout), infmt, outfmt);
417 if (filters->tab[0] == NULL)
419 msg_Err (aout, "cannot setup pass-through");
427 /* parse user filter lists */
428 if (var_InheritBool (aout, "audio-time-stretch"))
430 if (AppendFilter(VLC_OBJECT(aout), "audio filter", "scaletempo",
431 filters, &input_format, &output_format) == 0)
432 filters->rate_filter = filters->tab[filters->count - 1];
435 char *str = var_InheritString (aout, "audio-filter");
438 char *p = str, *name;
439 while ((name = strsep (&p, " :")) != NULL)
441 AppendFilter(VLC_OBJECT(aout), "audio filter", name, filters,
442 &input_format, &output_format);
447 char *visual = var_InheritString (aout, "audio-visual");
448 owner->request_vout = *request_vout;
449 owner->recycle_vout = visual != NULL;
450 if (visual != NULL && strcasecmp (visual, "none"))
452 AppendFilter(VLC_OBJECT(aout), "visualization", visual, filters,
453 &input_format, &output_format);
457 /* convert to the output format (minus resampling) if necessary */
458 output_format.i_rate = input_format.i_rate;
459 if (aout_FiltersPipelineCreate (aout, filters->tab, &filters->count,
460 AOUT_MAX_FILTERS, &input_format, &output_format))
462 msg_Err (aout, "cannot setup filtering pipeline");
465 input_format = output_format;
467 /* insert the resampler */
468 output_format.i_rate = outfmt->i_rate;
469 assert (AOUT_FMTS_IDENTICAL(&output_format, outfmt));
470 filters->resampler = FindResampler (VLC_OBJECT(aout), &input_format,
472 if (filters->resampler == NULL && input_format.i_rate != outfmt->i_rate)
474 msg_Err (aout, "cannot setup a resampler");
477 if (filters->rate_filter == NULL)
478 filters->rate_filter = filters->resampler;
483 aout_FiltersPipelineDestroy (filters->tab, filters->count);
484 var_DelCallback (aout, "equalizer", EqualizerCallback, NULL);
485 var_DelCallback (aout, "visual", VisualizationCallback, NULL);
491 * Destroys the audio filters.
493 void aout_FiltersDelete (audio_output_t *aout, aout_filters_t *filters)
495 aout_owner_t *owner = aout_owner (aout);
497 if (filters->resampler != NULL)
498 aout_FiltersPipelineDestroy (&filters->resampler, 1);
499 aout_FiltersPipelineDestroy (filters->tab, filters->count);
500 var_DelCallback (aout, "equalizer", EqualizerCallback, NULL);
501 var_DelCallback (aout, "visual", VisualizationCallback, NULL);
503 /* XXX We need to update recycle_vout before calling
504 * aout_FiltersPipelineDestroy().
505 * FIXME There may be a race condition if audio-visual is updated between
506 * aout_FiltersDestroy() and the next aout_FiltersNew().
508 char *visual = var_InheritString (aout, "audio-visual");
509 owner->recycle_vout = (visual != NULL) && *visual;
515 bool aout_FiltersAdjustResampling (aout_filters_t *filters, int adjust)
517 if (filters->resampler == NULL)
521 filters->resampling += adjust;
523 filters->resampling = 0;
524 return filters->resampling != 0;
527 block_t *aout_FiltersPlay (aout_filters_t *filters, block_t *block, int rate)
529 int nominal_rate = 0;
531 if (rate != INPUT_RATE_DEFAULT)
533 filter_t *rate_filter = filters->rate_filter;
535 if (rate_filter == NULL)
536 goto drop; /* Without linear, non-nominal rate is impossible. */
538 /* Override input rate */
539 nominal_rate = rate_filter->fmt_in.audio.i_rate;
540 rate_filter->fmt_in.audio.i_rate =
541 (nominal_rate * INPUT_RATE_DEFAULT) / rate;
544 block = aout_FiltersPipelinePlay (filters->tab, filters->count, block);
545 if (filters->resampler != NULL)
546 { /* NOTE: the resampler needs to run even if resampling is 0.
547 * The decoder and output rates can still be different. */
548 filters->resampler->fmt_in.audio.i_rate += filters->resampling;
549 block = aout_FiltersPipelinePlay (&filters->resampler, 1, block);
550 filters->resampler->fmt_in.audio.i_rate -= filters->resampling;
553 if (nominal_rate != 0)
554 { /* Restore input rate */
555 assert (filters->rate_filter != NULL);
556 filters->rate_filter->fmt_in.audio.i_rate = nominal_rate;
561 block_Release (block);