]> git.sesse.net Git - vlc/blobdiff - src/audio_output/dec.c
aout: lack of software mixer is non fatal
[vlc] / src / audio_output / dec.c
index 7814be5dd8df12622813b40b3d90cf2dcfbc729b..f60fa4d81fa645ae588b056e800b5dab54cba67d 100644 (file)
 # include "config.h"
 #endif
 
-#include <vlc_common.h>
+#include <assert.h>
 
-#ifdef HAVE_ALLOCA_H
-#   include <alloca.h>
-#endif
+#include <vlc_common.h>
 
 #include <vlc_aout.h>
 #include <vlc_input.h>
 
 #include "aout_internal.h"
+#include "libvlc.h"
 
-/** FIXME: Ugly but needed to access the counters */
-#include "input/input_internal.h"
-
-/*****************************************************************************
- * aout_DecNew : create a decoder
- *****************************************************************************/
-static aout_input_t * DecNew( vlc_object_t * p_this, aout_instance_t * p_aout,
-                              audio_sample_format_t *p_format,
-                              audio_replay_gain_t *p_replay_gain )
+/**
+ * Creates an audio output
+ */
+int aout_DecNew( audio_output_t *p_aout,
+                 const audio_sample_format_t *p_format,
+                 const audio_replay_gain_t *p_replay_gain,
+                 const aout_request_vout_t *p_request_vout )
 {
-    aout_input_t * p_input;
-    input_thread_t * p_input_thread;
-
     /* Sanitize audio format */
     if( p_format->i_channels > 32 )
     {
         msg_Err( p_aout, "too many audio channels (%u)",
                  p_format->i_channels );
-        return NULL;
+        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" );
+        return -1;
     }
 
     if( p_format->i_rate > 192000 )
     {
         msg_Err( p_aout, "excessive audio sample frequency (%u)",
                  p_format->i_rate );
-        return NULL;
+        return -1;
     }
-
-    /* We can only be called by the decoder, so no need to lock
-     * p_input->lock. */
-    vlc_mutex_lock( &p_aout->mixer_lock );
-
-    if ( p_aout->i_nb_inputs >= AOUT_MAX_INPUTS )
+    if( p_format->i_rate < 4000 )
     {
-        msg_Err( p_aout, "too many inputs already (%d)", p_aout->i_nb_inputs );
-        goto error;
+        msg_Err( p_aout, "too low audio sample frequency (%u)",
+                 p_format->i_rate );
+        return -1;
     }
 
-    p_input = malloc(sizeof(aout_input_t));
-    if ( p_input == NULL )
-        goto error;
-    memset( p_input, 0, sizeof(aout_input_t) );
-
-    vlc_mutex_init( &p_input->lock );
-
-    p_input->b_changed = 0;
-    p_input->b_error = 1;
+    aout_input_t *p_input = calloc( 1, sizeof(aout_input_t));
+    if( !p_input )
+        return -1;
 
-    aout_FormatPrepare( p_format );
+    p_input->b_error = true;
 
     memcpy( &p_input->input, p_format,
             sizeof(audio_sample_format_t) );
     if( p_replay_gain )
         p_input->replay_gain = *p_replay_gain;
 
-    p_aout->pp_inputs[p_aout->i_nb_inputs] = p_input;
-    p_aout->i_nb_inputs++;
+    /* We can only be called by the decoder, so no need to lock
+     * p_input->lock. */
+    aout_owner_t *owner = aout_owner(p_aout);
+    aout_lock( p_aout );
+    assert (owner->input == NULL);
 
-    if ( p_aout->mixer.b_error )
-    {
-        int i;
-
-        var_Destroy( p_aout, "audio-device" );
-        var_Destroy( p_aout, "audio-channels" );
-
-        /* Recreate the output using the new format. */
-        if ( aout_OutputNew( p_aout, p_format ) < 0 )
-        {
-            for ( i = 0; i < p_aout->i_nb_inputs - 1; i++ )
-            {
-                vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
-                aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
-                vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
-            }
-            vlc_mutex_unlock( &p_aout->mixer_lock );
-            return p_input;
-        }
-
-        /* Create other input streams. */
-        for ( i = 0; i < p_aout->i_nb_inputs - 1; i++ )
-        {
-            vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
-            aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
-            aout_InputNew( p_aout, p_aout->pp_inputs[i] );
-            vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
-        }
-    }
-    else
-    {
-        aout_MixerDelete( p_aout );
-    }
+    var_Destroy( p_aout, "audio-device" );
+    var_Destroy( p_aout, "audio-channels" );
 
-    if ( aout_MixerNew( p_aout ) == -1 )
-    {
-        aout_OutputDelete( p_aout );
+    /* Recreate the output using the new format. */
+    if( aout_OutputNew( p_aout, p_format ) < 0 )
         goto error;
-    }
 
-    aout_InputNew( p_aout, p_input );
+    assert (owner->volume.mixer == NULL);
+    owner->volume.mixer = aout_MixerNew (p_aout, owner->mixer_format.i_format);
 
-    vlc_mutex_unlock( &p_aout->mixer_lock );
-    p_input->i_desync = var_CreateGetInteger( p_this, "audio-desync" ) * 1000;
-
-    p_input_thread = (input_thread_t *)vlc_object_find( p_this,
-                                           VLC_OBJECT_INPUT, FIND_PARENT );
-    if( p_input_thread )
-    {
-        p_input->i_pts_delay = p_input_thread->i_pts_delay;
-        p_input->i_pts_delay += p_input->i_desync;
-        p_input->p_input_thread = p_input_thread;
-        vlc_object_release( p_input_thread );
-    }
-    else
-    {
-        p_input->i_pts_delay = DEFAULT_PTS_DELAY;
-        p_input->i_pts_delay += p_input->i_desync;
-        p_input->p_input_thread = NULL;
-    }
-
-    return p_input;
+    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_input, p_request_vout );
+    aout_unlock( p_aout );
+    return 0;
 error:
-    vlc_mutex_unlock( &p_aout->mixer_lock );
-    return NULL;
-}
-
-aout_input_t * __aout_DecNew( vlc_object_t * p_this,
-                              aout_instance_t ** pp_aout,
-                              audio_sample_format_t * p_format,
-                              audio_replay_gain_t *p_replay_gain )
-{
-    aout_instance_t *p_aout = *pp_aout;
-    if ( p_aout == NULL )
-    {
-        msg_Dbg( p_this, "no aout present, spawning one" );
-        p_aout = aout_New( p_this );
-
-        /* Everything failed, I'm a loser, I just wanna die */
-        if( p_aout == NULL )
-            return NULL;
-
-        vlc_object_attach( p_aout, p_this );
-        *pp_aout = p_aout;
-    }
-
-    return DecNew( p_this, p_aout, p_format, p_replay_gain );
+    aout_unlock( p_aout );
+    free( p_input );
+    return -1;
 }
 
 /*****************************************************************************
  * aout_DecDelete : delete a decoder
  *****************************************************************************/
-int aout_DecDelete( aout_instance_t * p_aout, aout_input_t * p_input )
+void aout_DecDelete( audio_output_t * p_aout )
 {
-    int i_input;
-
-    /* This function can only be called by the decoder itself, so no need
-     * to lock p_input->lock. */
-    vlc_mutex_lock( &p_aout->mixer_lock );
-
-    for ( i_input = 0; i_input < p_aout->i_nb_inputs; i_input++ )
-    {
-        if ( p_aout->pp_inputs[i_input] == p_input )
-        {
-            break;
-        }
-    }
+    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);
+    owner->input = NULL;
+
+    aout_OutputDelete( p_aout );
+    mixer = owner->volume.mixer;
+    owner->volume.mixer = NULL;
+    var_Destroy( p_aout, "audio-device" );
+    var_Destroy( p_aout, "audio-channels" );
+
+    aout_unlock( p_aout );
+
+    aout_MixerDelete (mixer);
+    free (input);
+}
 
-    if ( i_input == p_aout->i_nb_inputs )
-    {
-        msg_Err( p_aout, "cannot find an input to delete" );
-        return -1;
-    }
+static void aout_CheckRestart (audio_output_t *aout)
+{
+    aout_owner_t *owner = aout_owner (aout);
+    aout_input_t *input = owner->input;
 
-    /* Remove the input from the list. */
-    memmove( &p_aout->pp_inputs[i_input], &p_aout->pp_inputs[i_input + 1],
-             (AOUT_MAX_INPUTS - i_input - 1) * sizeof(aout_input_t *) );
-    p_aout->i_nb_inputs--;
+    aout_assert_locked (aout);
 
-    aout_InputDelete( p_aout, p_input );
+    if (likely(!owner->need_restart))
+        return;
+    owner->need_restart = false;
 
-    vlc_mutex_destroy( &p_input->lock );
-    free( p_input );
+    /* Reinitializes the output */
+    aout_InputDelete (aout, owner->input);
+    aout_MixerDelete (owner->volume.mixer);
+    owner->volume.mixer = NULL;
+    aout_OutputDelete (aout);
 
-    if ( !p_aout->i_nb_inputs )
+    if (aout_OutputNew (aout, &input->input))
     {
-        aout_OutputDelete( p_aout );
-        aout_MixerDelete( p_aout );
-        if ( var_Type( p_aout, "audio-device" ) != 0 )
-        {
-            var_Destroy( p_aout, "audio-device" );
-        }
-        if ( var_Type( p_aout, "audio-channels" ) != 0 )
-        {
-            var_Destroy( p_aout, "audio-channels" );
-        }
+        input->b_error = true;
+        return; /* we are officially screwed */
     }
 
-    vlc_mutex_unlock( &p_aout->mixer_lock );
+    owner->volume.mixer = aout_MixerNew (aout, owner->mixer_format.i_format);
 
-    return 0;
+    if (aout_InputNew (aout, input, &input->request_vout))
+        assert (input->b_error);
+    else
+        assert (!input->b_error);
 }
 
 
@@ -249,152 +183,163 @@ int aout_DecDelete( aout_instance_t * p_aout, aout_input_t * p_input )
 /*****************************************************************************
  * aout_DecNewBuffer : ask for a new empty buffer
  *****************************************************************************/
-aout_buffer_t * aout_DecNewBuffer( aout_input_t * p_input,
-                                   size_t i_nb_samples )
+block_t *aout_DecNewBuffer (audio_output_t *aout, size_t samples)
 {
-    aout_buffer_t * p_buffer;
-    mtime_t duration;
-
-    vlc_mutex_lock( &p_input->lock );
-
-    if ( p_input->b_error )
+    /* NOTE: the caller is responsible for serializing input change */
+    aout_owner_t *owner = aout_owner (aout);
+    aout_input_t *input = owner->input;
+
+    size_t length = samples * input->input.i_bytes_per_frame
+                            / input->input.i_frame_length;
+    block_t *block = block_Alloc( length );
+    if( likely(block != NULL) )
     {
-        vlc_mutex_unlock( &p_input->lock );
-        return NULL;
+        block->i_nb_samples = samples;
+        block->i_pts = block->i_length = 0;
     }
-
-    duration = (1000000 * (mtime_t)i_nb_samples) / p_input->input.i_rate;
-
-    /* This necessarily allocates in the heap. */
-    aout_BufferAlloc( &p_input->input_alloc, duration, NULL, p_buffer );
-    if( p_buffer != NULL )
-        p_buffer->i_nb_bytes = i_nb_samples * p_input->input.i_bytes_per_frame
-                                  / p_input->input.i_frame_length;
-
-    /* Suppose the decoder doesn't have more than one buffered buffer */
-    p_input->b_changed = 0;
-
-    vlc_mutex_unlock( &p_input->lock );
-
-    if( p_buffer == NULL )
-        return NULL;
-
-    p_buffer->i_nb_samples = i_nb_samples;
-    p_buffer->start_date = p_buffer->end_date = 0;
-    return p_buffer;
+    return block;
 }
 
 /*****************************************************************************
  * aout_DecDeleteBuffer : destroy an undecoded buffer
  *****************************************************************************/
-void aout_DecDeleteBuffer( aout_instance_t * p_aout, aout_input_t * p_input,
-                           aout_buffer_t * p_buffer )
+void aout_DecDeleteBuffer (audio_output_t *aout, block_t *block)
 {
-    (void)p_aout; (void)p_input;
-    aout_BufferFree( p_buffer );
+    (void) aout;
+    aout_BufferFree (block);
 }
 
 /*****************************************************************************
  * aout_DecPlay : filter & mix the decoded buffer
  *****************************************************************************/
-int aout_DecPlay( aout_instance_t * p_aout, aout_input_t * p_input,
-                  aout_buffer_t * p_buffer, int i_input_rate )
+int aout_DecPlay (audio_output_t *p_aout, block_t *p_buffer, int i_input_rate)
 {
-    if ( p_buffer->start_date == 0 )
+    aout_owner_t *owner = aout_owner (p_aout);
+    aout_input_t *p_input = owner->input;
+
+    assert( i_input_rate >= INPUT_RATE_DEFAULT / AOUT_MAX_INPUT_RATE &&
+            i_input_rate <= INPUT_RATE_DEFAULT * AOUT_MAX_INPUT_RATE );
+    assert( p_buffer->i_pts > 0 );
+
+    p_buffer->i_length = (mtime_t)p_buffer->i_nb_samples * 1000000
+                                / p_input->input.i_rate;
+
+    aout_lock( p_aout );
+    if( p_input->b_error )
     {
-        msg_Warn( p_aout, "non-dated buffer received" );
+        aout_unlock( p_aout );
         aout_BufferFree( p_buffer );
         return -1;
     }
 
-#ifndef FIXME
-    /* This hack for #transcode{acodec=...}:display to work -- Courmisch */
-    if( i_input_rate == 0 )
-        i_input_rate = INPUT_RATE_DEFAULT;
-#endif
-    if( i_input_rate > INPUT_RATE_DEFAULT * AOUT_MAX_INPUT_RATE ||
-        i_input_rate < INPUT_RATE_DEFAULT / AOUT_MAX_INPUT_RATE )
+    aout_CheckRestart( p_aout );
+    aout_InputCheckAndRestart( p_aout, p_input );
+
+    /* Input */
+    p_buffer = aout_InputPlay (p_aout, p_input, p_buffer, i_input_rate,
+                               &owner->sync.date);
+    if( p_buffer != NULL )
     {
-        aout_BufferFree( p_buffer );
-        return 0;
-    }
+        date_Increment (&owner->sync.date, p_buffer->i_nb_samples);
 
-    /* Apply the desynchronisation requested by the user */
-    p_buffer->start_date += p_input->i_desync;
-    p_buffer->end_date += p_input->i_desync;
+        /* Mixer */
+        float amp = owner->volume.multiplier * p_input->multiplier;
+        aout_MixerRun (owner->volume.mixer, p_buffer, amp);
 
-    if ( p_buffer->start_date > mdate() + p_input->i_pts_delay +
-         AOUT_MAX_ADVANCE_TIME )
-    {
-        msg_Warn( p_aout, "received buffer in the future (%"PRId64")",
-                  p_buffer->start_date - mdate());
-        if( p_input->p_input_thread )
-        {
-            vlc_mutex_lock( &p_input->p_input_thread->p->counters.counters_lock);
-            stats_UpdateInteger( p_aout,
-                           p_input->p_input_thread->p->counters.p_lost_abuffers,
-                           1, NULL );
-            vlc_mutex_unlock( &p_input->p_input_thread->p->counters.counters_lock);
-        }
-        aout_BufferFree( p_buffer );
-        return -1;
+        /* Output */
+        aout_OutputPlay( p_aout, p_buffer );
     }
 
-    p_buffer->end_date = p_buffer->start_date
-                            + (mtime_t)p_buffer->i_nb_samples * 1000000
-                                / p_input->input.i_rate;
+    aout_unlock( p_aout );
+    return 0;
+}
 
-    vlc_mutex_lock( &p_input->lock );
+int aout_DecGetResetLost (audio_output_t *aout)
+{
+    aout_owner_t *owner = aout_owner (aout);
+    aout_input_t *input = owner->input;
+    int val;
 
-    if ( p_input->b_error )
-    {
-        vlc_mutex_unlock( &p_input->lock );
-        aout_BufferFree( p_buffer );
-        return -1;
-    }
+    aout_lock (aout);
+    val = input->i_buffer_lost;
+    input->i_buffer_lost = 0;
+    aout_unlock (aout);
 
-    if ( p_input->b_changed )
-    {
-        /* Maybe the allocation size has changed. Re-allocate a buffer. */
-        aout_buffer_t * p_new_buffer;
-        mtime_t duration = (1000000 * (mtime_t)p_buffer->i_nb_samples)
-                            / p_input->input.i_rate;
-
-        aout_BufferAlloc( &p_input->input_alloc, duration, NULL, p_new_buffer );
-        vlc_memcpy( p_new_buffer->p_buffer, p_buffer->p_buffer,
-                    p_buffer->i_nb_bytes );
-        p_new_buffer->i_nb_samples = p_buffer->i_nb_samples;
-        p_new_buffer->i_nb_bytes = p_buffer->i_nb_bytes;
-        p_new_buffer->start_date = p_buffer->start_date;
-        p_new_buffer->end_date = p_buffer->end_date;
-        aout_BufferFree( p_buffer );
-        p_buffer = p_new_buffer;
-        p_input->b_changed = 0;
-    }
+    return val;
+}
 
-    /* If the buffer is too early, wait a while. */
-    mwait( p_buffer->start_date - AOUT_MAX_PREPARE_TIME );
+void aout_DecChangePause (audio_output_t *aout, bool paused, mtime_t date)
+{
+    aout_owner_t *owner = aout_owner (aout);
 
-    if ( aout_InputPlay( p_aout, p_input, p_buffer, i_input_rate ) == -1 )
-    {
-        vlc_mutex_unlock( &p_input->lock );
-        return -1;
-    }
+    aout_lock (aout);
+    /* XXX: Should the date be offset by the pause duration instead? */
+    date_Set (&owner->sync.date, VLC_TS_INVALID);
+    aout_OutputPause (aout, paused, date);
+    aout_unlock (aout);
+}
 
-    vlc_mutex_unlock( &p_input->lock );
+void aout_DecFlush (audio_output_t *aout)
+{
+    aout_owner_t *owner = aout_owner (aout);
 
-    /* Run the mixer if it is able to run. */
-    vlc_mutex_lock( &p_aout->mixer_lock );
-    aout_MixerRun( p_aout );
-    if( p_input->p_input_thread )
+    aout_lock (aout);
+    date_Set (&owner->sync.date, VLC_TS_INVALID);
+    aout_OutputFlush (aout, false);
+    aout_unlock (aout);
+}
+
+bool aout_DecIsEmpty (audio_output_t *aout)
+{
+    aout_owner_t *owner = aout_owner (aout);
+    mtime_t end_date;
+
+    aout_lock (aout);
+    /* FIXME: tell output to drain */
+    end_date = date_Get (&owner->sync.date);
+    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)
     {
-        vlc_mutex_lock( &p_input->p_input_thread->p->counters.counters_lock);
-        stats_UpdateInteger( p_aout,
-                             p_input->p_input_thread->p->counters.p_played_abuffers,
-                             1, NULL );
-        vlc_mutex_unlock( &p_input->p_input_thread->p->counters.counters_lock);
-    }
-    vlc_mutex_unlock( &p_aout->mixer_lock );
+        aout_owner_t *owner = aout_owner (aout);
 
-    return 0;
+        msg_Warn (aout, "not synchronized (%"PRId64" us), resampling",
+                  delta);
+        if (date_Get (&owner->sync.date) != VLC_TS_INVALID)
+            date_Move (&owner->sync.date, delta);
+    }
 }