#include <vlc_common.h>
#include <vlc_aout.h>
#include <vlc_input.h>
-#include <vlc_atomic.h>
#include "aout_internal.h"
#include "libvlc.h"
}
aout_owner_t *owner = aout_owner(p_aout);
- int ret = 0;
/* TODO: reduce lock scope depending on decoder's real need */
- aout_lock( p_aout );
+ aout_OutputLock (p_aout);
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 )
+
+ atomic_store (&owner->restart, 0);
+ owner->input_format = *p_format;
+ owner->mixer_format = owner->input_format;
+ owner->request_vout = *p_request_vout;
+
+ if (aout_OutputNew (p_aout, &owner->mixer_format))
goto error;
aout_volume_SetFormat (owner->volume, owner->mixer_format.i_format);
/* Create the audio filtering "input" pipeline */
- if (aout_FiltersNew (p_aout, p_format, &owner->mixer_format,
- p_request_vout))
+ owner->filters = aout_FiltersNew (p_aout, p_format, &owner->mixer_format,
+ &owner->request_vout);
+ if (owner->filters == NULL)
{
aout_OutputDelete (p_aout);
error:
aout_volume_Delete (owner->volume);
- ret = -1;
- goto error;
+ aout_OutputUnlock (p_aout);
+ return -1;
}
- date_Init (&owner->sync.date, owner->mixer_format.i_rate, 1);
- date_Set (&owner->sync.date, VLC_TS_INVALID);
+ owner->sync.end = VLC_TS_INVALID;
owner->sync.resamp_type = AOUT_RESAMPLING_NONE;
+ owner->sync.discontinuity = true;
+ aout_OutputUnlock (p_aout);
- owner->buffers_lost = 0;
-
- aout_unlock( p_aout );
- return ret;
+ atomic_init (&owner->buffers_lost, 0);
+ return 0;
}
/**
* Stops all plugins involved in the audio output.
*/
-void aout_DecDelete (audio_output_t *p_aout)
+void aout_DecDelete (audio_output_t *aout)
{
- aout_owner_t *owner = aout_owner (p_aout);
+ aout_owner_t *owner = aout_owner (aout);
- aout_lock( p_aout );
- aout_FiltersDelete (p_aout);
- aout_OutputDelete( p_aout );
+ aout_OutputLock (aout);
+ if (owner->mixer_format.i_format)
+ {
+ aout_FiltersDelete (aout, owner->filters);
+ aout_OutputDelete (aout);
+ }
aout_volume_Delete (owner->volume);
-
- var_Destroy( p_aout, "stereo-mode" );
-
- aout_unlock( p_aout );
+ aout_OutputUnlock (aout);
+ var_Destroy (aout, "stereo-mode");
}
-#define AOUT_RESTART_OUTPUT 1
-#define AOUT_RESTART_INPUT 2
-static int aout_CheckRestart (audio_output_t *aout)
+static int aout_CheckReady (audio_output_t *aout)
{
aout_owner_t *owner = aout_owner (aout);
- aout_assert_locked (aout);
-
- int restart = vlc_atomic_swap (&owner->restart, 0);
- if (likely(restart == 0))
- return 0;
-
- assert (restart & AOUT_RESTART_INPUT);
-
- const aout_request_vout_t request_vout = owner->request_vout;
-
- aout_FiltersDelete (aout);
-
- /* Reinitializes the output */
- if (restart & AOUT_RESTART_OUTPUT)
+ int restart = atomic_exchange (&owner->restart, 0);
+ if (unlikely(restart))
{
- aout_OutputDelete (aout);
- if (aout_OutputNew (aout, &owner->input_format))
- abort (); /* FIXME we are officially screwed */
- aout_volume_SetFormat (owner->volume, owner->mixer_format.i_format);
- }
+ if (owner->mixer_format.i_format)
+ aout_FiltersDelete (aout, owner->filters);
+
+ if (restart & AOUT_RESTART_OUTPUT)
+ { /* Reinitializes the output */
+ msg_Dbg (aout, "restarting output...");
+ if (owner->mixer_format.i_format)
+ aout_OutputDelete (aout);
+ owner->mixer_format = owner->input_format;
+ if (aout_OutputNew (aout, &owner->mixer_format))
+ owner->mixer_format.i_format = 0;
+ aout_volume_SetFormat (owner->volume,
+ owner->mixer_format.i_format);
+ }
- owner->sync.resamp_type = AOUT_RESAMPLING_NONE;
+ msg_Dbg (aout, "restarting filters...");
+ owner->sync.end = VLC_TS_INVALID;
+ owner->sync.resamp_type = AOUT_RESAMPLING_NONE;
- if (aout_FiltersNew (aout, &owner->input_format, &owner->mixer_format,
- &request_vout))
- {
- abort (); /* FIXME */
+ if (owner->mixer_format.i_format)
+ {
+ owner->filters = aout_FiltersNew (aout, &owner->input_format,
+ &owner->mixer_format,
+ &owner->request_vout);
+ if (owner->filters == NULL)
+ {
+ aout_OutputDelete (aout);
+ owner->mixer_format.i_format = 0;
+ }
+ }
+ /* TODO: This would be a good time to call clean up any video output
+ * left over by an audio visualization:
+ input_resource_TerminatVout(MAGIC HERE); */
}
- return 0;
+ return (owner->mixer_format.i_format) ? 0 : -1;
}
/**
* Marks the audio output for restart, to update any parameter of the output
* plug-in (e.g. output device or channel mapping).
*/
-static void aout_RequestRestart (audio_output_t *aout)
+void aout_RequestRestart (audio_output_t *aout, unsigned mode)
{
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);
+ atomic_fetch_or (&owner->restart, mode);
+ msg_Dbg (aout, "restart requested (%u)", mode);
}
-int aout_ChannelsRestart (vlc_object_t *obj, const char *varname,
- vlc_value_t oldval, vlc_value_t newval, void *data)
+/*
+ * Buffer management
+ */
+
+static void aout_StopResampling (audio_output_t *aout)
{
- audio_output_t *aout = (audio_output_t *)obj;
- (void)oldval; (void)newval; (void)data;
+ aout_owner_t *owner = aout_owner (aout);
- 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;
+ owner->sync.resamp_type = AOUT_RESAMPLING_NONE;
+ aout_FiltersAdjustResampling (owner->filters, 0);
}
-/**
- * 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)
+static void aout_DecSilence (audio_output_t *aout, mtime_t length, mtime_t pts)
{
aout_owner_t *owner = aout_owner (aout);
+ const audio_sample_format_t *fmt = &owner->mixer_format;
+ size_t frames = (fmt->i_rate * length) / CLOCK_FREQ;
+ block_t *block;
- vlc_atomic_compare_swap (&owner->restart, 0, AOUT_RESTART_INPUT);
+ if (AOUT_FMT_SPDIF(fmt))
+ block = block_Alloc (4 * frames);
+ else
+ block = block_Alloc (frames * fmt->i_bytes_per_frame);
+ if (unlikely(block == NULL))
+ return; /* uho! */
+
+ msg_Dbg (aout, "inserting %zu zeroes", frames);
+ memset (block->p_buffer, 0, block->i_buffer);
+ block->i_nb_samples = frames;
+ block->i_pts = pts;
+ block->i_dts = pts;
+ block->i_length = length;
+ aout_OutputPlay (aout, block);
}
-
-/*
- * Buffer management
- */
-
-/*****************************************************************************
- * aout_DecNewBuffer : ask for a new empty buffer
- *****************************************************************************/
-block_t *aout_DecNewBuffer (audio_output_t *aout, size_t samples)
+static void aout_DecSynchronize (audio_output_t *aout, mtime_t dec_pts,
+ int input_rate)
{
- /* NOTE: the caller is responsible for serializing input change */
aout_owner_t *owner = aout_owner (aout);
+ mtime_t drift;
+
+ /**
+ * Depending on the drift between the actual and intended playback times,
+ * the audio core may ignore the drift, trigger upsampling or downsampling,
+ * insert silence or even discard samples.
+ * Future VLC versions may instead adjust the input rate.
+ *
+ * The audio output plugin is responsible for estimating its actual
+ * playback time, or rather the estimated time when the next sample will
+ * be played. (The actual playback time is always the current time, that is
+ * to say mdate(). It is not an useful statistic.)
+ *
+ * Most audio output plugins can estimate the delay until playback of
+ * the next sample to be written to the buffer, or equally the time until
+ * all samples in the buffer will have been played. Then:
+ * pts = mdate() + delay
+ */
+ if (aout_OutputTimeGet (aout, &drift) != 0)
+ return; /* nothing can be done if timing is unknown */
+ drift += mdate () - dec_pts;
+
+ /* Late audio output.
+ * This can happen due to insufficient caching, scheduling jitter
+ * or bug in the decoder. Ideally, the output would seek backward. But that
+ * is not portable, not supported by some hardware and often unsafe/buggy
+ * where supported. The other alternative is to flush the buffers
+ * completely. */
+ if (drift > (owner->sync.discontinuity ? 0
+ : +3 * input_rate * AOUT_MAX_PTS_DELAY / INPUT_RATE_DEFAULT))
+ {
+ if (!owner->sync.discontinuity)
+ msg_Warn (aout, "playback way too late (%"PRId64"): "
+ "flushing buffers", drift);
+ else
+ msg_Dbg (aout, "playback too late (%"PRId64"): "
+ "flushing buffers", drift);
+ aout_OutputFlush (aout, false);
+
+ aout_StopResampling (aout);
+ owner->sync.end = VLC_TS_INVALID;
+ owner->sync.discontinuity = true;
- size_t length = samples * owner->input_format.i_bytes_per_frame
- / owner->input_format.i_frame_length;
- block_t *block = block_Alloc( length );
- if( likely(block != NULL) )
+ /* Now the output might be too early... Recheck. */
+ if (aout_OutputTimeGet (aout, &drift) != 0)
+ return; /* nothing can be done if timing is unknown */
+ drift += mdate () - dec_pts;
+ }
+
+ /* Early audio output.
+ * This is rare except at startup when the buffers are still empty. */
+ if (drift < (owner->sync.discontinuity ? 0
+ : -3 * input_rate * AOUT_MAX_PTS_ADVANCE / INPUT_RATE_DEFAULT))
{
- block->i_nb_samples = samples;
- block->i_pts = block->i_length = 0;
+ if (!owner->sync.discontinuity)
+ msg_Warn (aout, "playback way too early (%"PRId64"): "
+ "playing silence", drift);
+ aout_DecSilence (aout, -drift, dec_pts);
+
+ aout_StopResampling (aout);
+ owner->sync.discontinuity = true;
+ drift = 0;
}
- return block;
-}
-/*****************************************************************************
- * aout_DecDeleteBuffer : destroy an undecoded buffer
- *****************************************************************************/
-void aout_DecDeleteBuffer (audio_output_t *aout, block_t *block)
-{
- (void) aout;
- block_Release (block);
-}
+ /* Resampling */
+ if (drift > +AOUT_MAX_PTS_DELAY
+ && owner->sync.resamp_type != AOUT_RESAMPLING_UP)
+ {
+ msg_Warn (aout, "playback too late (%"PRId64"): up-sampling",
+ drift);
+ owner->sync.resamp_type = AOUT_RESAMPLING_UP;
+ owner->sync.resamp_start_drift = +drift;
+ }
+ if (drift < -AOUT_MAX_PTS_ADVANCE
+ && owner->sync.resamp_type != AOUT_RESAMPLING_DOWN)
+ {
+ msg_Warn (aout, "playback too early (%"PRId64"): down-sampling",
+ drift);
+ owner->sync.resamp_type = AOUT_RESAMPLING_DOWN;
+ owner->sync.resamp_start_drift = -drift;
+ }
-static void aout_StopResampling (audio_output_t *aout)
-{
- aout_owner_t *owner = aout_owner (aout);
+ if (owner->sync.resamp_type == AOUT_RESAMPLING_NONE)
+ return; /* Everything is fine. Nothing to do. */
- owner->sync.resamp_type = AOUT_RESAMPLING_NONE;
- aout_FiltersAdjustResampling (aout, 0);
+ if (llabs (drift) > 2 * owner->sync.resamp_start_drift)
+ { /* If the drift is ever increasing, then something is seriously wrong.
+ * Cease resampling and hope for the best. */
+ msg_Warn (aout, "timing screwed (drift: %"PRId64" us): "
+ "stopping resampling", drift);
+ aout_StopResampling (aout);
+ return;
+ }
+
+ /* Resampling has been triggered earlier. This checks if it needs to be
+ * increased or decreased. Resampling rate changes must be kept slow for
+ * the comfort of listeners. */
+ int adj = (owner->sync.resamp_type == AOUT_RESAMPLING_UP) ? +2 : -2;
+
+ if (2 * llabs (drift) <= owner->sync.resamp_start_drift)
+ /* If the drift has been reduced from more than half its initial
+ * value, then it is time to switch back the resampling direction. */
+ adj *= -1;
+
+ if (!aout_FiltersAdjustResampling (owner->filters, adj))
+ { /* Everything is back to normal: stop resampling. */
+ owner->sync.resamp_type = AOUT_RESAMPLING_NONE;
+ msg_Dbg (aout, "resampling stopped (drift: %"PRId64" us)", drift);
+ }
}
/*****************************************************************************
block->i_length = CLOCK_FREQ * block->i_nb_samples
/ owner->input_format.i_rate;
- aout_lock (aout);
- if (unlikely(aout_CheckRestart (aout)))
+ aout_OutputLock (aout);
+ if (unlikely(aout_CheckReady (aout)))
goto drop; /* Pipeline is unrecoverably broken :-( */
- /* We don't care if someone changes the start date behind our back after
- * this. We'll deal with that when pushing the buffer, and compensate
- * with the next incoming buffer. */
- mtime_t start_date = date_Get (&owner->sync.date);
- const mtime_t now = mdate ();
-
- if (start_date != VLC_TS_INVALID && start_date < now)
- { /* The decoder is _very_ late. This can only happen if the user
- * pauses the stream (or if the decoder is buggy, which cannot
- * happen :). */
- msg_Warn (aout, "computed PTS is out of range (%"PRId64"), "
- "clearing out", now - start_date);
- aout_OutputFlush (aout, false);
- if (owner->sync.resamp_type != AOUT_RESAMPLING_NONE)
- msg_Warn (aout, "timing screwed, stopping resampling");
- aout_StopResampling (aout);
- block->i_flags |= BLOCK_FLAG_DISCONTINUITY;
- start_date = VLC_TS_INVALID;
- }
-
- if (block->i_pts < now + AOUT_MIN_PREPARE_TIME)
- { /* The decoder gives us f*cked up PTS. It's its business, but we
- * can't present it anyway, so drop the buffer. */
- msg_Warn (aout, "PTS is out of range (%"PRId64"), dropping buffer",
- now - block->i_pts);
- aout_StopResampling (aout);
+ const mtime_t now = mdate (), advance = block->i_pts - now;
+ if (advance < -AOUT_MAX_PTS_DELAY)
+ { /* Late buffer can be caused by bugs in the decoder, by scheduling
+ * latency spikes (excessive load, SIGSTOP, etc.) or if buffering is
+ * insufficient. We assume the PTS is wrong and play the buffer anyway:
+ * Hopefully video has encountered a similar PTS problem as audio. */
+ msg_Warn (aout, "buffer too late (%"PRId64" us): dropped", advance);
goto drop;
}
-
- /* If the audio drift is too big then it's not worth trying to resample
- * the audio. */
- if (start_date == VLC_TS_INVALID)
- {
- start_date = block->i_pts;
- date_Set (&owner->sync.date, start_date);
- }
-
- mtime_t drift = start_date - block->i_pts;
- if (drift < -input_rate * 3 * AOUT_MAX_PTS_ADVANCE / INPUT_RATE_DEFAULT)
- {
- msg_Warn (aout, "buffer way too early (%"PRId64"), clearing queue",
- drift);
- aout_OutputFlush (aout, false);
- if (owner->sync.resamp_type != AOUT_RESAMPLING_NONE)
- msg_Warn (aout, "timing screwed, stopping resampling");
- aout_StopResampling (aout);
- block->i_flags |= BLOCK_FLAG_DISCONTINUITY;
- start_date = block->i_pts;
- date_Set (&owner->sync.date, start_date);
- drift = 0;
- }
- else
- if (drift > +input_rate * 3 * AOUT_MAX_PTS_DELAY / INPUT_RATE_DEFAULT)
- {
- msg_Warn (aout, "buffer way too late (%"PRId64"), dropping buffer",
- drift);
+ if (advance > AOUT_MAX_ADVANCE_TIME)
+ { /* Early buffers can only be caused by bugs in the decoder. */
+ msg_Err (aout, "buffer too early (%"PRId64" us): dropped", advance);
goto drop;
}
+ if (block->i_flags & BLOCK_FLAG_DISCONTINUITY)
+ owner->sync.discontinuity = true;
- block = aout_FiltersPlay (aout, block, input_rate);
+ block = aout_FiltersPlay (owner->filters, block, input_rate);
if (block == NULL)
- {
- owner->buffers_lost++;
- goto out;
- }
-
- /* Adjust the resampler if needed.
- * We first need to calculate the output rate of this resampler. */
- if ((owner->sync.resamp_type == AOUT_RESAMPLING_NONE)
- && (drift < -AOUT_MAX_PTS_ADVANCE || drift > +AOUT_MAX_PTS_DELAY))
- { /* Can happen in several circumstances :
- * 1. A problem at the input (clock drift)
- * 2. A small pause triggered by the user
- * 3. Some delay in the output stage, causing a loss of lip
- * synchronization
- * Solution : resample the buffer to avoid a scratch.
- */
- owner->sync.resamp_start_drift = (int)-drift;
- owner->sync.resamp_type = (drift < 0) ? AOUT_RESAMPLING_DOWN
- : AOUT_RESAMPLING_UP;
- msg_Warn (aout, (drift < 0)
- ? "buffer too early (%"PRId64"), down-sampling"
- : "buffer too late (%"PRId64"), up-sampling", drift);
- }
- if (owner->sync.resamp_type != AOUT_RESAMPLING_NONE)
- { /* Resampling has been triggered previously (because of dates
- * mismatch). We want the resampling to happen progressively so
- * it isn't too audible to the listener. */
- const int adjust = (owner->sync.resamp_type == AOUT_RESAMPLING_UP)
- ? +2 : -2;
- /* Check if everything is back to normal, then stop resampling. */
- if (!aout_FiltersAdjustResampling (aout, adjust))
- {
- owner->sync.resamp_type = AOUT_RESAMPLING_NONE;
- msg_Warn (aout, "resampling stopped (drift: %"PRIi64")",
- block->i_pts - start_date);
- }
- else if (abs ((int)(block->i_pts - start_date))
- < abs (owner->sync.resamp_start_drift) / 2)
- { /* If we reduced the drift from half, then it is time to switch
- * back the resampling direction. */
- if (owner->sync.resamp_type == AOUT_RESAMPLING_UP)
- owner->sync.resamp_type = AOUT_RESAMPLING_DOWN;
- else
- owner->sync.resamp_type = AOUT_RESAMPLING_UP;
- owner->sync.resamp_start_drift = 0;
- }
- else if (owner->sync.resamp_start_drift
- && (abs ((int)(block->i_pts - start_date))
- > abs (owner->sync.resamp_start_drift) * 3 / 2))
- { /* If the drift is increasing and not decreasing, than something
- * is bad. We'd better stop the resampling right now. */
- msg_Warn (aout, "timing screwed, stopping resampling");
- aout_StopResampling (aout);
- block->i_flags |= BLOCK_FLAG_DISCONTINUITY;
- }
- }
-
- block->i_pts = start_date;
- date_Increment (&owner->sync.date, block->i_nb_samples);
+ goto lost;
/* Software volume */
aout_volume_Amplify (owner->volume, block);
+ /* Drift correction */
+ aout_DecSynchronize (aout, block->i_pts, input_rate);
+
/* Output */
+ owner->sync.end = block->i_pts + block->i_length + 1;
+ owner->sync.discontinuity = false;
aout_OutputPlay (aout, block);
out:
- aout_unlock (aout);
+ aout_OutputUnlock (aout);
return 0;
drop:
+ owner->sync.discontinuity = true;
block_Release (block);
- owner->buffers_lost++;
+lost:
+ atomic_fetch_add(&owner->buffers_lost, 1);
goto out;
}
int aout_DecGetResetLost (audio_output_t *aout)
{
aout_owner_t *owner = aout_owner (aout);
- unsigned val;
-
- aout_lock (aout);
- val = owner->buffers_lost;
- owner->buffers_lost = 0;
- aout_unlock (aout);
-
- return val;
+ return atomic_exchange(&owner->buffers_lost, 0);
}
void aout_DecChangePause (audio_output_t *aout, bool paused, mtime_t date)
{
aout_owner_t *owner = aout_owner (aout);
- 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);
+ aout_OutputLock (aout);
+ if (owner->sync.end != VLC_TS_INVALID)
+ {
+ if (paused)
+ owner->sync.end -= date;
+ else
+ owner->sync.end += date;
+ }
+ if (owner->mixer_format.i_format)
+ aout_OutputPause (aout, paused, date);
+ aout_OutputUnlock (aout);
}
void aout_DecFlush (audio_output_t *aout)
{
aout_owner_t *owner = aout_owner (aout);
- aout_lock (aout);
- date_Set (&owner->sync.date, VLC_TS_INVALID);
- aout_OutputFlush (aout, false);
- aout_unlock (aout);
+ aout_OutputLock (aout);
+ owner->sync.end = VLC_TS_INVALID;
+ if (owner->mixer_format.i_format)
+ aout_OutputFlush (aout, false);
+ aout_OutputUnlock (aout);
}
bool aout_DecIsEmpty (audio_output_t *aout)
{
aout_owner_t *owner = aout_owner (aout);
- mtime_t end_date, now = mdate ();
- bool empty;
+ mtime_t now = mdate ();
+ bool empty = true;
- aout_lock (aout);
- end_date = date_Get (&owner->sync.date);
- empty = end_date == VLC_TS_INVALID || end_date <= now;
- if (empty)
+ aout_OutputLock (aout);
+ if (owner->sync.end != VLC_TS_INVALID)
+ empty = owner->sync.end <= now;
+ if (empty && owner->mixer_format.i_format)
/* 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);
+ aout_OutputUnlock (aout);
return empty;
}