]> git.sesse.net Git - vlc/blobdiff - src/audio_output/dec.c
aout: partly rewrite and move filters initialization code
[vlc] / src / audio_output / dec.c
index 502997fe28be7bb81dc8c5ce022096a742c087d0..124eb31a390fed87292130ec93bda978110a8b30 100644 (file)
@@ -1,24 +1,24 @@
 /*****************************************************************************
  * 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.
  *****************************************************************************/
 
 /*****************************************************************************
@@ -38,9 +38,6 @@
 #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
  */
@@ -50,17 +47,6 @@ int aout_DecNew( audio_output_t *p_aout,
                  const aout_request_vout_t *p_request_vout )
 {
     /* Sanitize audio format */
-    if( p_format->i_channels > 32 )
-    {
-        msg_Err( p_aout, "too many audio channels (%u)",
-                 p_format->i_channels );
-        return -1;
-    }
-    if( p_format->i_channels <= 0 )
-    {
-        msg_Err( p_aout, "no audio channels" );
-        return -1;
-    }
     if( p_format->i_channels != aout_FormatNbChannels( p_format ) )
     {
         msg_Err( p_aout, "incompatible audio channels count with layout mask" );
@@ -81,45 +67,20 @@ int aout_DecNew( audio_output_t *p_aout,
     }
 
     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;
+    int ret = 0;
 
     /* TODO: reduce lock scope depending on decoder's real need */
     aout_lock( p_aout );
-    assert (owner->module == NULL);
 
-    /* Create the audio output stream */
-    var_Destroy( p_aout, "audio-device" );
-    var_Destroy( p_aout, "audio-channels" );
+    var_Destroy( p_aout, "stereo-mode" );
 
+    /* Create the audio output stream */
     owner->input_format = *p_format;
     vlc_atomic_set (&owner->restart, 0);
+    owner->volume = aout_volume_New (p_aout, p_replay_gain);
     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");
+    aout_volume_SetFormat (owner->volume, owner->mixer_format.i_format);
 
     /* Create the audio filtering "input" pipeline */
     date_Init (&owner->sync.date, owner->mixer_format.i_rate, 1);
@@ -129,10 +90,12 @@ int aout_DecNew( audio_output_t *p_aout,
     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_volume_Delete (owner->volume);
+        ret = -1;
+    }
     aout_unlock( p_aout );
     return ret;
 }
@@ -140,50 +103,27 @@ error:
 /**
  * Stops all plugins involved in the audio output.
  */
-void aout_Shutdown (audio_output_t *p_aout)
+void aout_DecDelete (audio_output_t *p_aout)
 {
     aout_owner_t *owner = aout_owner (p_aout);
     aout_input_t *input;
-    struct audio_mixer *mixer;
 
     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;
 
-    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" );
+    aout_volume_Delete (owner->volume);
 
-    aout_unlock( p_aout );
+    var_Destroy( p_aout, "stereo-mode" );
 
-    aout_MixerDelete (mixer);
+    aout_unlock( p_aout );
     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)
-{
-    aout_owner_t *owner = aout_owner (aout);
-
-    assert (owner->module != NULL);
-#ifdef RECYCLE
-    (void) owner;
-#else
-    aout_Shutdown (aout);
-#endif
-}
-
 #define AOUT_RESTART_OUTPUT 1
 #define AOUT_RESTART_INPUT  2
 static void aout_CheckRestart (audio_output_t *aout)
@@ -198,22 +138,22 @@ static void aout_CheckRestart (audio_output_t *aout)
 
     assert (restart & AOUT_RESTART_INPUT);
 
-    const aout_request_vout_t request_vout = owner->input->request_vout;
+    const aout_request_vout_t request_vout = owner->request_vout;
 
-    aout_InputDelete (aout, owner->input);
+    if (likely(owner->input != NULL))
+        aout_InputDelete (aout, owner->input);
     owner->input = NULL;
 
     /* Reinitializes the output */
     if (restart & AOUT_RESTART_OUTPUT)
     {
-        aout_MixerDelete (owner->volume.mixer);
-        owner->volume.mixer = NULL;
         aout_OutputDelete (aout);
-
         if (aout_OutputNew (aout, &owner->input_format))
+        {
+            aout_volume_Delete (owner->volume);
             return; /* we are officially screwed */
-        owner->volume.mixer = aout_MixerNew (aout,
-                                             owner->mixer_format.i_format);
+        }
+        aout_volume_SetFormat (owner->volume, owner->mixer_format.i_format);
     }
 
     owner->input = aout_InputNew (aout, &owner->input_format,
@@ -224,7 +164,7 @@ static void aout_CheckRestart (audio_output_t *aout)
  * 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)
+static void aout_RequestRestart (audio_output_t *aout)
 {
     aout_owner_t *owner = aout_owner (aout);
 
@@ -232,6 +172,22 @@ void aout_RequestRestart (audio_output_t *aout)
     vlc_atomic_set (&owner->restart, AOUT_RESTART_OUTPUT|AOUT_RESTART_INPUT);
 }
 
+int aout_ChannelsRestart (vlc_object_t *obj, const char *varname,
+                          vlc_value_t oldval, vlc_value_t newval, void *data)
+{
+    audio_output_t *aout = (audio_output_t *)obj;
+    (void)oldval; (void)newval; (void)data;
+
+    if (!strcmp (varname, "audio-device"))
+    {
+        /* This is supposed to be a significant change and supposes
+         * rebuilding the channel choices. */
+        var_Destroy (aout, "stereo-mode");
+    }
+    aout_RequestRestart (aout);
+    return 0;
+}
+
 /**
  * This function will safely mark aout input to be restarted as soon as
  * possible to take configuration changes into account
@@ -273,7 +229,7 @@ block_t *aout_DecNewBuffer (audio_output_t *aout, size_t samples)
 void aout_DecDeleteBuffer (audio_output_t *aout, block_t *block)
 {
     (void) aout;
-    aout_BufferFree (block);
+    block_Release (block);
 }
 
 /*****************************************************************************
@@ -282,7 +238,7 @@ void aout_DecDeleteBuffer (audio_output_t *aout, block_t *block)
 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 );
@@ -292,29 +248,25 @@ int aout_DecPlay (audio_output_t *p_aout, block_t *p_buffer, int i_input_rate)
                                 / owner->input_format.i_rate;
 
     aout_lock( p_aout );
-    if (unlikely(p_input == NULL)) /* can happen due to restart */
+    aout_CheckRestart( p_aout );
+
+    input = owner->input;
+    if (unlikely(input == NULL)) /* can happen due to restart */
     {
         aout_unlock( p_aout );
-        aout_BufferFree( p_buffer );
+        block_Release( p_buffer );
         return -1;
     }
 
-    aout_CheckRestart( p_aout );
-
     /* 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 */
-        if (owner->volume.mixer != NULL)
-        {
-            float amp = owner->volume.multiplier
-                      * vlc_atomic_getf (&owner->gain.multiplier);
-            aout_MixerRun (owner->volume.mixer, p_buffer, amp);
-        }
+        aout_volume_Amplify (owner->volume, p_buffer);
 
         /* Output */
         aout_OutputPlay( p_aout, p_buffer );
@@ -331,8 +283,13 @@ int aout_DecGetResetLost (audio_output_t *aout)
     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;
@@ -362,65 +319,17 @@ void aout_DecFlush (audio_output_t *aout)
 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();
-}
-
-/**
- * Notifies the audio input of the drift from the requested audio
- * playback timestamp (@ref block_t.i_pts) to the anticipated playback time
- * as reported by the audio output hardware.
- * Depending on the drift amplitude, the input core may ignore the drift
- * trigger upsampling or downsampling, or even discard samples.
- * Future VLC versions may instead adjust the input decoding speed.
- *
- * The audio output plugin is responsible for estimating the ideal current
- * playback time defined as follows:
- *  ideal time = buffer timestamp - (output latency + pending buffer duration)
- *
- * Practically, this is the PTS (block_t.i_pts) of the current buffer minus
- * the latency reported by the output programming interface.
- * Computing the estimated drift directly would probably be more intuitive.
- * However the use of an absolute time value does not introduce extra
- * measurement errors due to the CPU scheduling jitter and clock resolution.
- * Furthermore, the ideal while it is an abstract value, is easy for most
- * audio output plugins to compute.
- * The following definition is equivalent but depends on the clock time:
- *  ideal time = real time + drift
-
- * @note If aout_LatencyReport() is never called, the core will assume that
- * there is no drift.
- *
- * @param ideal estimated ideal time as defined above.
- */
-void aout_TimeReport (audio_output_t *aout, mtime_t ideal)
-{
-    mtime_t delta = mdate() - ideal /* = -drift */;
-
-    aout_assert_locked (aout);
-    if (delta < -AOUT_MAX_PTS_ADVANCE || +AOUT_MAX_PTS_DELAY < delta)
-    {
-        aout_owner_t *owner = aout_owner (aout);
-
-        msg_Warn (aout, "not synchronized (%"PRId64" us), resampling",
-                  delta);
-        if (date_Get (&owner->sync.date) != VLC_TS_INVALID)
-            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;
+    return empty;
 }