/*****************************************************************************
* dec.c : audio output API towards decoders
*****************************************************************************
- * Copyright (C) 2002-2007 the VideoLAN team
+ * Copyright (C) 2002-2007 VLC authors and VideoLAN
* $Id$
*
* Authors: Christophe Massiot <massiot@via.ecp.fr>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
#include <assert.h>
#include <vlc_common.h>
-
#include <vlc_aout.h>
#include <vlc_input.h>
+#include <vlc_atomic.h>
#include "aout_internal.h"
#include "libvlc.h"
+static int ReplayGainCallback (vlc_object_t *, char const *,
+ vlc_value_t, vlc_value_t, void *);
+
/**
* Creates an audio output
*/
return -1;
}
- aout_input_t *p_input = calloc( 1, sizeof(aout_input_t));
- if( !p_input )
- return -1;
-
- p_input->b_error = true;
-
- if( p_replay_gain )
- p_input->replay_gain = *p_replay_gain;
-
- /* We can only be called by the decoder, so no need to lock
- * p_input->lock. */
aout_owner_t *owner = aout_owner(p_aout);
+#ifdef RECYCLE
+ /* Calling decoder is responsible for serializing aout_DecNew() and
+ * aout_DecDelete(). So no need to lock to _read_ those properties. */
+ if (owner->module != NULL) /* <- output exists */
+ { /* Check if we can recycle the existing output and pipelines */
+ if (AOUT_FMTS_IDENTICAL(&owner->input_format, p_format))
+ return 0;
+
+ /* TODO? If the new input format is closer to the output format than
+ * the old input format was, then the output could be recycled. The
+ * input pipeline however would need to be restarted. */
+
+ /* No recycling: delete everything and restart from scratch */
+ aout_Shutdown (p_aout);
+ }
+#endif
+ int ret = -1;
+
+ /* TODO: reduce lock scope depending on decoder's real need */
aout_lock( p_aout );
- assert (owner->input == NULL);
+ assert (owner->module == NULL);
+ /* Create the audio output stream */
var_Destroy( p_aout, "audio-device" );
var_Destroy( p_aout, "audio-channels" );
- /* Recreate the output using the new format. */
owner->input_format = *p_format;
+ vlc_atomic_set (&owner->restart, 0);
if( aout_OutputNew( p_aout, p_format ) < 0 )
goto error;
+ /* Allocate a software mixer */
assert (owner->volume.mixer == NULL);
owner->volume.mixer = aout_MixerNew (p_aout, owner->mixer_format.i_format);
+ aout_ReplayGainInit (&owner->gain.data, p_replay_gain);
+ var_AddCallback (p_aout, "audio-replay-gain-mode",
+ ReplayGainCallback, owner);
+ var_TriggerCallback (p_aout, "audio-replay-gain-mode");
+
+ /* Create the audio filtering "input" pipeline */
date_Init (&owner->sync.date, owner->mixer_format.i_rate, 1);
date_Set (&owner->sync.date, VLC_TS_INVALID);
- owner->input = p_input;
- aout_InputNew( p_aout, p_format, p_input, p_request_vout );
- aout_unlock( p_aout );
- return 0;
+ assert (owner->input == NULL);
+ owner->input = aout_InputNew (p_aout, p_format, &owner->mixer_format,
+ p_request_vout);
+ if (owner->input == NULL)
+ aout_OutputDelete (p_aout);
+ else
+ ret = 0;
error:
aout_unlock( p_aout );
- free( p_input );
- return -1;
+ return ret;
}
-/*****************************************************************************
- * aout_DecDelete : delete a decoder
- *****************************************************************************/
-void aout_DecDelete( audio_output_t * p_aout )
+/**
+ * Stops all plugins involved in the audio output.
+ */
+void aout_Shutdown (audio_output_t *p_aout)
{
aout_owner_t *owner = aout_owner (p_aout);
aout_input_t *input;
aout_lock( p_aout );
/* Remove the input. */
input = owner->input;
- aout_InputDelete (p_aout, input);
+ if (likely(input != NULL))
+ aout_InputDelete (p_aout, input);
owner->input = NULL;
- aout_OutputDelete( p_aout );
mixer = owner->volume.mixer;
owner->volume.mixer = NULL;
+
+ var_DelCallback (p_aout, "audio-replay-gain-mode",
+ ReplayGainCallback, owner);
+
+ aout_OutputDelete( p_aout );
var_Destroy( p_aout, "audio-device" );
var_Destroy( p_aout, "audio-channels" );
free (input);
}
+/**
+ * Stops the decoded audio input.
+ * @note Due to output recycling, this function is esssentially a stub.
+ */
+void aout_DecDelete (audio_output_t *aout)
+{
+#ifdef RECYCLE
+ (void) aout;
+#else
+ aout_Shutdown (aout);
+#endif
+}
+
+#define AOUT_RESTART_OUTPUT 1
+#define AOUT_RESTART_INPUT 2
static void aout_CheckRestart (audio_output_t *aout)
{
aout_owner_t *owner = aout_owner (aout);
- aout_input_t *input = owner->input;
aout_assert_locked (aout);
- if (likely(!owner->need_restart))
+ int restart = vlc_atomic_swap (&owner->restart, 0);
+ if (likely(restart == 0))
return;
- owner->need_restart = false;
- /* Reinitializes the output */
- aout_InputDelete (aout, owner->input);
- aout_MixerDelete (owner->volume.mixer);
- owner->volume.mixer = NULL;
- aout_OutputDelete (aout);
+ assert (restart & AOUT_RESTART_INPUT);
+
+ const aout_request_vout_t request_vout = owner->input->request_vout;
+
+ if (likely(owner->input != NULL))
+ aout_InputDelete (aout, owner->input);
+ owner->input = NULL;
- if (aout_OutputNew (aout, &owner->input_format))
+ /* Reinitializes the output */
+ if (restart & AOUT_RESTART_OUTPUT)
{
- input->b_error = true;
- return; /* we are officially screwed */
+ aout_MixerDelete (owner->volume.mixer);
+ owner->volume.mixer = NULL;
+ aout_OutputDelete (aout);
+
+ if (aout_OutputNew (aout, &owner->input_format))
+ return; /* we are officially screwed */
+ owner->volume.mixer = aout_MixerNew (aout,
+ owner->mixer_format.i_format);
}
- owner->volume.mixer = aout_MixerNew (aout, owner->mixer_format.i_format);
+ owner->input = aout_InputNew (aout, &owner->input_format,
+ &owner->mixer_format, &request_vout);
+}
- if (aout_InputNew (aout, &owner->input_format, input, &input->request_vout))
- assert (input->b_error);
- else
- assert (!input->b_error);
+/**
+ * Marks the audio output for restart, to update any parameter of the output
+ * plug-in (e.g. output device or channel mapping).
+ */
+void aout_RequestRestart (audio_output_t *aout)
+{
+ aout_owner_t *owner = aout_owner (aout);
+
+ /* DO NOT remove AOUT_RESTART_INPUT. You need to change the atomic ops. */
+ vlc_atomic_set (&owner->restart, AOUT_RESTART_OUTPUT|AOUT_RESTART_INPUT);
+}
+
+/**
+ * This function will safely mark aout input to be restarted as soon as
+ * possible to take configuration changes into account
+ */
+void aout_InputRequestRestart (audio_output_t *aout)
+{
+ aout_owner_t *owner = aout_owner (aout);
+
+ vlc_atomic_compare_swap (&owner->restart, 0, AOUT_RESTART_INPUT);
}
int aout_DecPlay (audio_output_t *p_aout, block_t *p_buffer, int i_input_rate)
{
aout_owner_t *owner = aout_owner (p_aout);
- aout_input_t *p_input = owner->input;
+ aout_input_t *input;
assert( i_input_rate >= INPUT_RATE_DEFAULT / AOUT_MAX_INPUT_RATE &&
i_input_rate <= INPUT_RATE_DEFAULT * AOUT_MAX_INPUT_RATE );
/ owner->input_format.i_rate;
aout_lock( p_aout );
- if( p_input->b_error )
+ aout_CheckRestart( p_aout );
+
+ input = owner->input;
+ if (unlikely(input == NULL)) /* can happen due to restart */
{
aout_unlock( p_aout );
aout_BufferFree( p_buffer );
return -1;
}
- aout_CheckRestart( p_aout );
- aout_InputCheckAndRestart( p_aout, p_input );
-
/* Input */
- p_buffer = aout_InputPlay (p_aout, p_input, p_buffer, i_input_rate,
+ p_buffer = aout_InputPlay (p_aout, input, p_buffer, i_input_rate,
&owner->sync.date);
if( p_buffer != NULL )
{
date_Increment (&owner->sync.date, p_buffer->i_nb_samples);
/* Mixer */
- float amp = owner->volume.multiplier * p_input->multiplier;
- aout_MixerRun (owner->volume.mixer, p_buffer, amp);
+ if (owner->volume.mixer != NULL)
+ {
+ float amp = owner->volume.multiplier
+ * vlc_atomic_getf (&owner->gain.multiplier);
+ aout_MixerRun (owner->volume.mixer, p_buffer, amp);
+ }
/* Output */
aout_OutputPlay( p_aout, p_buffer );
int val;
aout_lock (aout);
- val = input->i_buffer_lost;
- input->i_buffer_lost = 0;
+ if (likely(input != NULL))
+ {
+ val = input->i_buffer_lost;
+ input->i_buffer_lost = 0;
+ }
+ else
+ val = 0; /* if aout_CheckRestart() failed */
aout_unlock (aout);
return val;
bool aout_DecIsEmpty (audio_output_t *aout)
{
aout_owner_t *owner = aout_owner (aout);
- mtime_t end_date;
+ mtime_t end_date, now = mdate ();
+ bool empty;
aout_lock (aout);
- /* FIXME: tell output to drain */
end_date = date_Get (&owner->sync.date);
+ empty = end_date == VLC_TS_INVALID || end_date <= now;
+ if (empty)
+ /* The last PTS has elapsed already. So the underlying audio output
+ * buffer should be empty or almost. Thus draining should be fast
+ * and will not block the caller too long. */
+ aout_OutputFlush (aout, true);
aout_unlock (aout);
- return end_date == VLC_TS_INVALID || end_date <= mdate();
+ return empty;
}
/**
date_Move (&owner->sync.date, delta);
}
}
+
+static int ReplayGainCallback (vlc_object_t *obj, char const *var,
+ vlc_value_t oldval, vlc_value_t val, void *data)
+{
+ aout_owner_t *owner = data;
+ float multiplier = aout_ReplayGainSelect (obj, val.psz_string,
+ &owner->gain.data);
+ vlc_atomic_setf (&owner->gain.multiplier, multiplier);
+ VLC_UNUSED(var); VLC_UNUSED(oldval);
+ return VLC_SUCCESS;
+}