1 /*****************************************************************************
2 * input.c : internal management of input streams for the audio output
3 *****************************************************************************
4 * Copyright (C) 2002-2004 VideoLAN
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 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 General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* calloc(), malloc(), free() */
31 #include <vlc/input.h> /* for input_thread_t and i_pts_delay */
37 #include "audio_output.h"
38 #include "aout_internal.h"
40 static int VisualizationCallback( vlc_object_t *, char const *,
41 vlc_value_t, vlc_value_t, void * );
42 static int EqualizerCallback( vlc_object_t *, char const *,
43 vlc_value_t, vlc_value_t, void * );
44 static aout_filter_t * allocateUserChannelMixer( aout_instance_t *,
45 audio_sample_format_t *,
46 audio_sample_format_t * );
48 /*****************************************************************************
49 * aout_InputNew : allocate a new input and rework the filter pipeline
50 *****************************************************************************/
51 int aout_InputNew( aout_instance_t * p_aout, aout_input_t * p_input )
53 audio_sample_format_t user_filter_format;
54 audio_sample_format_t intermediate_format;/* input of resampler */
55 vlc_value_t val, text;
57 aout_filter_t * p_user_channel_mixer;
59 aout_FormatPrint( p_aout, "input", &p_input->input );
62 aout_FifoInit( p_aout, &p_input->fifo, p_aout->mixer.mixer.i_rate );
63 p_input->p_first_byte_to_mix = NULL;
65 /* Prepare format structure */
66 memcpy( &intermediate_format, &p_aout->mixer.mixer,
67 sizeof(audio_sample_format_t) );
68 intermediate_format.i_rate = p_input->input.i_rate;
70 /* Try to use the channel mixer chosen by the user */
71 memcpy ( &user_filter_format, &intermediate_format,
72 sizeof(audio_sample_format_t) );
73 user_filter_format.i_physical_channels = p_input->input.i_physical_channels;
74 user_filter_format.i_original_channels = p_input->input.i_original_channels;
75 user_filter_format.i_bytes_per_frame = user_filter_format.i_bytes_per_frame
76 * aout_FormatNbChannels( &user_filter_format )
77 / aout_FormatNbChannels( &intermediate_format );
78 p_user_channel_mixer = allocateUserChannelMixer( p_aout, &user_filter_format,
79 &intermediate_format );
80 /* If it failed, let the main pipeline do channel mixing */
81 if ( ! p_user_channel_mixer )
83 memcpy ( &user_filter_format, &intermediate_format,
84 sizeof(audio_sample_format_t) );
88 if ( aout_FiltersCreatePipeline( p_aout, p_input->pp_filters,
89 &p_input->i_nb_filters,
94 msg_Err( p_aout, "couldn't set an input pipeline" );
96 aout_FifoDestroy( p_aout, &p_input->fifo );
101 /* Now add user filters */
102 if( var_Type( p_aout, "visual" ) == 0 )
105 var_Create( p_aout, "visual", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
106 text.psz_string = _("Visualizations");
107 var_Change( p_aout, "visual", VLC_VAR_SETTEXT, &text, NULL );
108 val.psz_string = ""; text.psz_string = _("Disable");
109 var_Change( p_aout, "visual", VLC_VAR_ADDCHOICE, &val, &text );
110 val.psz_string = "random"; text.psz_string = _("Random");
111 var_Change( p_aout, "visual", VLC_VAR_ADDCHOICE, &val, &text );
112 val.psz_string = "scope"; text.psz_string = _("Scope");
113 var_Change( p_aout, "visual", VLC_VAR_ADDCHOICE, &val, &text );
114 val.psz_string = "spectrum"; text.psz_string = _("Spectrum");
115 var_Change( p_aout, "visual", VLC_VAR_ADDCHOICE, &val, &text );
117 /* Look for goom plugin */
118 p_module = config_FindModule( VLC_OBJECT(p_aout), "goom" );
121 val.psz_string = "goom"; text.psz_string = _("Goom");
122 var_Change( p_aout, "visual", VLC_VAR_ADDCHOICE, &val, &text );
125 if( var_Get( p_aout, "effect-list", &val ) == VLC_SUCCESS )
127 var_Set( p_aout, "visual", val );
128 if( val.psz_string ) free( val.psz_string );
130 var_AddCallback( p_aout, "visual", VisualizationCallback, NULL );
133 if( var_Type( p_aout, "equalizer" ) == 0 )
135 module_config_t *p_config;
138 p_config = config_FindConfig( VLC_OBJECT(p_aout), "equalizer-preset" );
139 if( p_config && p_config->i_list )
141 var_Create( p_aout, "equalizer",
142 VLC_VAR_STRING | VLC_VAR_HASCHOICE );
143 text.psz_string = _("Equalizer");
144 var_Change( p_aout, "equalizer", VLC_VAR_SETTEXT, &text, NULL );
146 val.psz_string = ""; text.psz_string = _("Disable");
147 var_Change( p_aout, "equalizer", VLC_VAR_ADDCHOICE, &val, &text );
149 for( i = 0; i < p_config->i_list; i++ )
151 val.psz_string = p_config->ppsz_list[i];
152 text.psz_string = p_config->ppsz_list_text[i];
153 var_Change( p_aout, "equalizer", VLC_VAR_ADDCHOICE,
157 var_AddCallback( p_aout, "equalizer", EqualizerCallback, NULL );
161 if( var_Type( p_aout, "audio-filter" ) == 0 )
163 var_Create( p_aout, "audio-filter",
164 VLC_VAR_STRING | VLC_VAR_DOINHERIT );
165 text.psz_string = _("Audio filters");
166 var_Change( p_aout, "audio-filter", VLC_VAR_SETTEXT, &text, NULL );
169 var_Get( p_aout, "audio-filter", &val );
170 psz_filters = val.psz_string;
171 if( psz_filters && *psz_filters )
173 char *psz_parser = psz_filters;
176 while( psz_parser && *psz_parser )
178 aout_filter_t * p_filter;
180 if( p_input->i_nb_filters >= AOUT_MAX_FILTERS )
182 msg_Dbg( p_aout, "max filter reached (%d)", AOUT_MAX_FILTERS );
186 while( *psz_parser == ' ' && *psz_parser == ',' )
190 if( ( psz_next = strchr( psz_parser , ',' ) ) )
194 if( *psz_parser =='\0' )
199 msg_Dbg( p_aout, "user filter \"%s\"", psz_parser );
201 /* Create a VLC object */
202 p_filter = vlc_object_create( p_aout, sizeof(aout_filter_t) );
203 if( p_filter == NULL )
205 msg_Err( p_aout, "cannot add user filter %s (skipped)",
207 psz_parser = psz_next;
211 vlc_object_attach( p_filter , p_aout );
212 memcpy( &p_filter->input, &user_filter_format,
213 sizeof(audio_sample_format_t) );
214 memcpy( &p_filter->output, &user_filter_format,
215 sizeof(audio_sample_format_t) );
218 module_Need( p_filter,"audio filter", psz_parser, VLC_TRUE );
220 if( p_filter->p_module== NULL )
222 msg_Err( p_aout, "cannot add user filter %s (skipped)",
225 vlc_object_detach( p_filter );
226 vlc_object_destroy( p_filter );
227 psz_parser = psz_next;
231 p_filter->b_continuity = VLC_FALSE;
233 p_input->pp_filters[p_input->i_nb_filters++] = p_filter;
235 /* next filter if any */
236 psz_parser = psz_next;
239 if( psz_filters ) free( psz_filters );
241 /* Attach the user channel mixer */
242 if ( p_user_channel_mixer )
244 p_input->pp_filters[p_input->i_nb_filters++] = p_user_channel_mixer;
247 /* Prepare hints for the buffer allocator. */
248 p_input->input_alloc.i_alloc_type = AOUT_ALLOC_HEAP;
249 p_input->input_alloc.i_bytes_per_sec = -1;
251 if ( AOUT_FMT_NON_LINEAR( &p_aout->mixer.mixer ) )
253 p_input->i_nb_resamplers = 0;
257 /* Create resamplers. */
258 intermediate_format.i_rate = (__MAX(p_input->input.i_rate,
259 p_aout->mixer.mixer.i_rate)
260 * (100 + AOUT_MAX_RESAMPLING)) / 100;
261 if ( intermediate_format.i_rate == p_aout->mixer.mixer.i_rate )
263 /* Just in case... */
264 intermediate_format.i_rate++;
266 if ( aout_FiltersCreatePipeline( p_aout, p_input->pp_resamplers,
267 &p_input->i_nb_resamplers,
268 &intermediate_format,
269 &p_aout->mixer.mixer ) < 0 )
271 msg_Err( p_aout, "couldn't set a resampler pipeline" );
273 aout_FiltersDestroyPipeline( p_aout, p_input->pp_filters,
274 p_input->i_nb_filters );
275 aout_FifoDestroy( p_aout, &p_input->fifo );
276 var_Destroy( p_aout, "visual" );
277 p_input->b_error = 1;
282 aout_FiltersHintBuffers( p_aout, p_input->pp_resamplers,
283 p_input->i_nb_resamplers,
284 &p_input->input_alloc );
286 /* Setup the initial rate of the resampler */
287 p_input->pp_resamplers[0]->input.i_rate = p_input->input.i_rate;
289 p_input->i_resampling_type = AOUT_RESAMPLING_NONE;
291 p_input->input_alloc.i_alloc_type = AOUT_ALLOC_HEAP;
292 aout_FiltersHintBuffers( p_aout, p_input->pp_filters,
293 p_input->i_nb_filters,
294 &p_input->input_alloc );
296 /* i_bytes_per_sec is still == -1 if no filters */
297 p_input->input_alloc.i_bytes_per_sec = __MAX(
298 p_input->input_alloc.i_bytes_per_sec,
299 (int)(p_input->input.i_bytes_per_frame
300 * p_input->input.i_rate
301 / p_input->input.i_frame_length) );
302 /* Allocate in the heap, it is more convenient for the decoder. */
303 p_input->input_alloc.i_alloc_type = AOUT_ALLOC_HEAP;
305 p_input->b_error = VLC_FALSE;
306 p_input->b_restart = VLC_FALSE;
311 /*****************************************************************************
312 * aout_InputDelete : delete an input
313 *****************************************************************************
314 * This function must be entered with the mixer lock.
315 *****************************************************************************/
316 int aout_InputDelete( aout_instance_t * p_aout, aout_input_t * p_input )
318 if ( p_input->b_error ) return 0;
320 aout_FiltersDestroyPipeline( p_aout, p_input->pp_filters,
321 p_input->i_nb_filters );
322 aout_FiltersDestroyPipeline( p_aout, p_input->pp_resamplers,
323 p_input->i_nb_resamplers );
324 aout_FifoDestroy( p_aout, &p_input->fifo );
329 /*****************************************************************************
330 * aout_InputPlay : play a buffer
331 *****************************************************************************
332 * This function must be entered with the input lock.
333 *****************************************************************************/
334 int aout_InputPlay( aout_instance_t * p_aout, aout_input_t * p_input,
335 aout_buffer_t * p_buffer )
339 if( p_input->b_restart )
341 aout_fifo_t fifo, dummy_fifo;
342 byte_t *p_first_byte_to_mix;
344 vlc_mutex_lock( &p_aout->mixer_lock );
346 /* A little trick to avoid loosing our input fifo */
347 aout_FifoInit( p_aout, &dummy_fifo, p_aout->mixer.mixer.i_rate );
348 p_first_byte_to_mix = p_input->p_first_byte_to_mix;
349 fifo = p_input->fifo;
350 p_input->fifo = dummy_fifo;
351 aout_InputDelete( p_aout, p_input );
352 aout_InputNew( p_aout, p_input );
353 p_input->p_first_byte_to_mix = p_first_byte_to_mix;
354 p_input->fifo = fifo;
356 vlc_mutex_unlock( &p_aout->mixer_lock );
359 /* We don't care if someone changes the start date behind our back after
360 * this. We'll deal with that when pushing the buffer, and compensate
361 * with the next incoming buffer. */
362 vlc_mutex_lock( &p_aout->input_fifos_lock );
363 start_date = aout_FifoNextStart( p_aout, &p_input->fifo );
364 vlc_mutex_unlock( &p_aout->input_fifos_lock );
366 if ( start_date != 0 && start_date < mdate() )
368 /* The decoder is _very_ late. This can only happen if the user
369 * pauses the stream (or if the decoder is buggy, which cannot
371 msg_Warn( p_aout, "computed PTS is out of range ("I64Fd"), "
372 "clearing out", mdate() - start_date );
373 vlc_mutex_lock( &p_aout->input_fifos_lock );
374 aout_FifoSet( p_aout, &p_input->fifo, 0 );
375 p_input->p_first_byte_to_mix = NULL;
376 vlc_mutex_unlock( &p_aout->input_fifos_lock );
377 if ( p_input->i_resampling_type != AOUT_RESAMPLING_NONE )
378 msg_Warn( p_aout, "timing screwed, stopping resampling" );
379 p_input->i_resampling_type = AOUT_RESAMPLING_NONE;
380 if ( p_input->i_nb_resamplers != 0 )
382 p_input->pp_resamplers[0]->input.i_rate = p_input->input.i_rate;
383 p_input->pp_resamplers[0]->b_continuity = VLC_FALSE;
388 if ( p_buffer->start_date < mdate() + AOUT_MIN_PREPARE_TIME )
390 /* The decoder gives us f*cked up PTS. It's its business, but we
391 * can't present it anyway, so drop the buffer. */
392 msg_Warn( p_aout, "PTS is out of range ("I64Fd"), dropping buffer",
393 mdate() - p_buffer->start_date );
394 aout_BufferFree( p_buffer );
395 p_input->i_resampling_type = AOUT_RESAMPLING_NONE;
396 if ( p_input->i_nb_resamplers != 0 )
398 p_input->pp_resamplers[0]->input.i_rate = p_input->input.i_rate;
399 p_input->pp_resamplers[0]->b_continuity = VLC_FALSE;
404 if ( start_date == 0 ) start_date = p_buffer->start_date;
406 /* Run pre-filters. */
408 aout_FiltersPlay( p_aout, p_input->pp_filters, p_input->i_nb_filters,
411 /* Run the resampler if needed.
412 * We first need to calculate the output rate of this resampler. */
413 if ( ( p_input->i_resampling_type == AOUT_RESAMPLING_NONE ) &&
414 ( start_date < p_buffer->start_date - AOUT_PTS_TOLERANCE
415 || start_date > p_buffer->start_date + AOUT_PTS_TOLERANCE ) &&
416 p_input->i_nb_resamplers > 0 )
418 /* Can happen in several circumstances :
419 * 1. A problem at the input (clock drift)
420 * 2. A small pause triggered by the user
421 * 3. Some delay in the output stage, causing a loss of lip
423 * Solution : resample the buffer to avoid a scratch.
425 mtime_t drift = p_buffer->start_date - start_date;
427 p_input->i_resamp_start_date = mdate();
428 p_input->i_resamp_start_drift = (int)drift;
431 p_input->i_resampling_type = AOUT_RESAMPLING_DOWN;
433 p_input->i_resampling_type = AOUT_RESAMPLING_UP;
435 msg_Warn( p_aout, "buffer is "I64Fd" %s, triggering %ssampling",
436 drift > 0 ? drift : -drift,
437 drift > 0 ? "in advance" : "late",
438 drift > 0 ? "down" : "up");
441 if ( p_input->i_resampling_type != AOUT_RESAMPLING_NONE )
443 /* Resampling has been triggered previously (because of dates
444 * mismatch). We want the resampling to happen progressively so
445 * it isn't too audible to the listener. */
447 if( p_input->i_resampling_type == AOUT_RESAMPLING_UP )
449 p_input->pp_resamplers[0]->input.i_rate += 10; /* Hz */
453 p_input->pp_resamplers[0]->input.i_rate -= 10; /* Hz */
456 /* Check if everything is back to normal, in which case we can stop the
458 if( p_input->pp_resamplers[0]->input.i_rate ==
459 p_input->input.i_rate )
461 p_input->i_resampling_type = AOUT_RESAMPLING_NONE;
462 msg_Warn( p_aout, "resampling stopped after "I64Fi" usec",
463 mdate() - p_input->i_resamp_start_date );
465 else if( abs( (int)(p_buffer->start_date - start_date) ) <
466 abs( p_input->i_resamp_start_drift ) / 2 )
468 /* if we reduced the drift from half, then it is time to switch
469 * back the resampling direction. */
470 if( p_input->i_resampling_type == AOUT_RESAMPLING_UP )
471 p_input->i_resampling_type = AOUT_RESAMPLING_DOWN;
473 p_input->i_resampling_type = AOUT_RESAMPLING_UP;
474 p_input->i_resamp_start_drift = 0;
476 else if( p_input->i_resamp_start_drift &&
477 ( abs( (int)(p_buffer->start_date - start_date) ) >
478 abs( p_input->i_resamp_start_drift ) * 3 / 2 ) )
480 /* If the drift is increasing and not decreasing, than something
481 * is bad. We'd better stop the resampling right now. */
482 msg_Warn( p_aout, "timing screwed, stopping resampling" );
483 p_input->i_resampling_type = AOUT_RESAMPLING_NONE;
484 p_input->pp_resamplers[0]->input.i_rate = p_input->input.i_rate;
488 /* Adding the start date will be managed by aout_FifoPush(). */
489 p_buffer->end_date = start_date +
490 (p_buffer->end_date - p_buffer->start_date);
491 p_buffer->start_date = start_date;
493 /* Actually run the resampler now. */
494 if ( p_input->i_nb_resamplers > 0 )
496 aout_FiltersPlay( p_aout, p_input->pp_resamplers,
497 p_input->i_nb_resamplers,
501 vlc_mutex_lock( &p_aout->input_fifos_lock );
502 aout_FifoPush( p_aout, &p_input->fifo, p_buffer );
503 vlc_mutex_unlock( &p_aout->input_fifos_lock );
508 static int ChangeFiltersString( aout_instance_t * p_aout,
509 char *psz_name, vlc_bool_t b_add )
514 var_Get( p_aout, "audio-filter", &val );
516 if( !val.psz_string ) val.psz_string = strdup("");
518 psz_parser = strstr( val.psz_string, psz_name );
524 psz_parser = val.psz_string;
525 asprintf( &val.psz_string, (*val.psz_string) ? "%s,%s" : "%s%s",
526 val.psz_string, psz_name );
538 memmove( psz_parser, psz_parser + strlen(psz_name) +
539 (*(psz_parser + strlen(psz_name)) == ',' ? 1 : 0 ),
540 strlen(psz_parser + strlen(psz_name)) + 1 );
544 free( val.psz_string );
549 var_Set( p_aout, "audio-filter", val );
550 free( val.psz_string );
554 static int VisualizationCallback( vlc_object_t *p_this, char const *psz_cmd,
555 vlc_value_t oldval, vlc_value_t newval, void *p_data )
557 aout_instance_t *p_aout = (aout_instance_t *)p_this;
558 char *psz_mode = newval.psz_string;
562 if( !psz_mode || !*psz_mode )
564 ChangeFiltersString( p_aout, "goom", VLC_FALSE );
565 ChangeFiltersString( p_aout, "visual", VLC_FALSE );
569 if( !strcmp( "goom", psz_mode ) )
571 ChangeFiltersString( p_aout, "visual", VLC_FALSE );
572 ChangeFiltersString( p_aout, "goom", VLC_TRUE );
576 val.psz_string = psz_mode;
577 var_Create( p_aout, "effect-list", VLC_VAR_STRING );
578 var_Set( p_aout, "effect-list", val );
580 ChangeFiltersString( p_aout, "goom", VLC_FALSE );
581 ChangeFiltersString( p_aout, "visual", VLC_TRUE );
586 for( i = 0; i < p_aout->i_nb_inputs; i++ )
588 p_aout->pp_inputs[i]->b_restart = VLC_TRUE;
594 static int EqualizerCallback( vlc_object_t *p_this, char const *psz_cmd,
595 vlc_value_t oldval, vlc_value_t newval, void *p_data )
597 aout_instance_t *p_aout = (aout_instance_t *)p_this;
598 char *psz_mode = newval.psz_string;
603 if( !psz_mode || !*psz_mode )
605 i_ret = ChangeFiltersString( p_aout, "equalizer", VLC_FALSE );
609 val.psz_string = psz_mode;
610 var_Create( p_aout, "equalizer-preset", VLC_VAR_STRING );
611 var_Set( p_aout, "equalizer-preset", val );
612 i_ret = ChangeFiltersString( p_aout, "equalizer", VLC_TRUE );
619 for( i = 0; i < p_aout->i_nb_inputs; i++ )
621 p_aout->pp_inputs[i]->b_restart = VLC_TRUE;
628 static aout_filter_t * allocateUserChannelMixer( aout_instance_t * p_aout,
629 audio_sample_format_t * p_input_format,
630 audio_sample_format_t * p_output_format )
632 aout_filter_t * p_channel_mixer;
634 /* Retreive user preferred channel mixer */
635 char * psz_name = config_GetPsz( p_aout, "audio-channel-mixer" );
637 /* Not specified => let the main pipeline do the mixing */
638 if ( ! psz_name ) return NULL;
640 /* Debug information */
641 aout_FormatsPrint( p_aout, "channel mixer", p_input_format,
644 /* Create a VLC object */
645 p_channel_mixer = vlc_object_create( p_aout, sizeof(aout_filter_t) );
646 if( p_channel_mixer == NULL )
648 msg_Err( p_aout, "cannot add user channel mixer %s", psz_name );
651 vlc_object_attach( p_channel_mixer , p_aout );
653 /* Attach the suitable module */
654 memcpy( &p_channel_mixer->input, p_input_format,
655 sizeof(audio_sample_format_t) );
656 memcpy( &p_channel_mixer->output, p_output_format,
657 sizeof(audio_sample_format_t) );
658 p_channel_mixer->p_module =
659 module_Need( p_channel_mixer,"audio filter", psz_name, VLC_TRUE );
660 if( p_channel_mixer->p_module== NULL )
662 msg_Err( p_aout, "cannot add user channel mixer %s", psz_name );
663 vlc_object_detach( p_channel_mixer );
664 vlc_object_destroy( p_channel_mixer );
667 p_channel_mixer->b_continuity = VLC_FALSE;
670 return p_channel_mixer;