git.sesse.net Git - vlc/blob - src/audio_output/dec.c

   1 /*****************************************************************************
   2  * dec.c : audio output API towards decoders
   3  *****************************************************************************
   4  * Copyright (C) 2002-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *
   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.
  13  *
  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.
  18  *
  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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <assert.h>
  32
  33 #include <vlc_common.h>
  34
  35 #include <vlc_aout.h>
  36 #include <vlc_input.h>
  37
  38 #include "aout_internal.h"
  39 #include "libvlc.h"
  40
  41 /**
  42  * Creates an audio output
  43  */
  44 int aout_DecNew( audio_output_t *p_aout,
  45                  const audio_sample_format_t *p_format,
  46                  const audio_replay_gain_t *p_replay_gain,
  47                  const aout_request_vout_t *p_request_vout )
  48 {
  49     /* Sanitize audio format */
  50     if( p_format->i_channels > 32 )
  51     {
  52         msg_Err( p_aout, "too many audio channels (%u)",
  53                  p_format->i_channels );
  54         return -1;
  55     }
  56     if( p_format->i_channels <= 0 )
  57     {
  58         msg_Err( p_aout, "no audio channels" );
  59         return -1;
  60     }
  61     if( p_format->i_channels != aout_FormatNbChannels( p_format ) )
  62     {
  63         msg_Err( p_aout, "incompatible audio channels count with layout mask" );
  64         return -1;
  65     }
  66
  67     if( p_format->i_rate > 192000 )
  68     {
  69         msg_Err( p_aout, "excessive audio sample frequency (%u)",
  70                  p_format->i_rate );
  71         return -1;
  72     }
  73     if( p_format->i_rate < 4000 )
  74     {
  75         msg_Err( p_aout, "too low audio sample frequency (%u)",
  76                  p_format->i_rate );
  77         return -1;
  78     }
  79
  80     aout_input_t *p_input = calloc( 1, sizeof(aout_input_t));
  81     if( !p_input )
  82         return -1;
  83
  84     p_input->b_error = true;
  85
  86     if( p_replay_gain )
  87         p_input->replay_gain = *p_replay_gain;
  88
  89     /* We can only be called by the decoder, so no need to lock
  90      * p_input->lock. */
  91     aout_owner_t *owner = aout_owner(p_aout);
  92     aout_lock( p_aout );
  93     assert (owner->input == NULL);
  94
  95     var_Destroy( p_aout, "audio-device" );
  96     var_Destroy( p_aout, "audio-channels" );
  97
  98     /* Recreate the output using the new format. */
  99     owner->input_format = *p_format;
 100     if( aout_OutputNew( p_aout, p_format ) < 0 )
 101         goto error;
 102
 103     assert (owner->volume.mixer == NULL);
 104     owner->volume.mixer = aout_MixerNew (p_aout, owner->mixer_format.i_format);
 105
 106     date_Init (&owner->sync.date, owner->mixer_format.i_rate, 1);
 107     date_Set (&owner->sync.date, VLC_TS_INVALID);
 108
 109     owner->input = p_input;
 110     aout_InputNew( p_aout, p_format, p_input, p_request_vout );
 111     aout_unlock( p_aout );
 112     return 0;
 113 error:
 114     aout_unlock( p_aout );
 115     free( p_input );
 116     return -1;
 117 }
 118
 119 /*****************************************************************************
 120  * aout_DecDelete : delete a decoder
 121  *****************************************************************************/
 122 void aout_DecDelete( audio_output_t * p_aout )
 123 {
 124     aout_owner_t *owner = aout_owner (p_aout);
 125     aout_input_t *input;
 126     struct audio_mixer *mixer;
 127
 128     aout_lock( p_aout );
 129     /* Remove the input. */
 130     input = owner->input;
 131     aout_InputDelete (p_aout, input);
 132     owner->input = NULL;
 133
 134     aout_OutputDelete( p_aout );
 135     mixer = owner->volume.mixer;
 136     owner->volume.mixer = NULL;
 137     var_Destroy( p_aout, "audio-device" );
 138     var_Destroy( p_aout, "audio-channels" );
 139
 140     aout_unlock( p_aout );
 141
 142     aout_MixerDelete (mixer);
 143     free (input);
 144 }
 145
 146 static void aout_CheckRestart (audio_output_t *aout)
 147 {
 148     aout_owner_t *owner = aout_owner (aout);
 149     aout_input_t *input = owner->input;
 150
 151     aout_assert_locked (aout);
 152
 153     if (likely(!owner->need_restart))
 154         return;
 155     owner->need_restart = false;
 156
 157     /* Reinitializes the output */
 158     aout_InputDelete (aout, owner->input);
 159     aout_MixerDelete (owner->volume.mixer);
 160     owner->volume.mixer = NULL;
 161     aout_OutputDelete (aout);
 162
 163     if (aout_OutputNew (aout, &owner->input_format))
 164     {
 165         input->b_error = true;
 166         return; /* we are officially screwed */
 167     }
 168
 169     owner->volume.mixer = aout_MixerNew (aout, owner->mixer_format.i_format);
 170
 171     if (aout_InputNew (aout, &owner->input_format, input, &input->request_vout))
 172         assert (input->b_error);
 173     else
 174         assert (!input->b_error);
 175 }
 176
 177
 178 /*
 179  * Buffer management
 180  */
 181
 182 /*****************************************************************************
 183  * aout_DecNewBuffer : ask for a new empty buffer
 184  *****************************************************************************/
 185 block_t *aout_DecNewBuffer (audio_output_t *aout, size_t samples)
 186 {
 187     /* NOTE: the caller is responsible for serializing input change */
 188     aout_owner_t *owner = aout_owner (aout);
 189
 190     size_t length = samples * owner->input_format.i_bytes_per_frame
 191                             / owner->input_format.i_frame_length;
 192     block_t *block = block_Alloc( length );
 193     if( likely(block != NULL) )
 194     {
 195         block->i_nb_samples = samples;
 196         block->i_pts = block->i_length = 0;
 197     }
 198     return block;
 199 }
 200
 201 /*****************************************************************************
 202  * aout_DecDeleteBuffer : destroy an undecoded buffer
 203  *****************************************************************************/
 204 void aout_DecDeleteBuffer (audio_output_t *aout, block_t *block)
 205 {
 206     (void) aout;
 207     aout_BufferFree (block);
 208 }
 209
 210 /*****************************************************************************
 211  * aout_DecPlay : filter & mix the decoded buffer
 212  *****************************************************************************/
 213 int aout_DecPlay (audio_output_t *p_aout, block_t *p_buffer, int i_input_rate)
 214 {
 215     aout_owner_t *owner = aout_owner (p_aout);
 216     aout_input_t *p_input = owner->input;
 217
 218     assert( i_input_rate >= INPUT_RATE_DEFAULT / AOUT_MAX_INPUT_RATE &&
 219             i_input_rate <= INPUT_RATE_DEFAULT * AOUT_MAX_INPUT_RATE );
 220     assert( p_buffer->i_pts > 0 );
 221
 222     p_buffer->i_length = (mtime_t)p_buffer->i_nb_samples * 1000000
 223                                 / owner->input_format.i_rate;
 224
 225     aout_lock( p_aout );
 226     if( p_input->b_error )
 227     {
 228         aout_unlock( p_aout );
 229         aout_BufferFree( p_buffer );
 230         return -1;
 231     }
 232
 233     aout_CheckRestart( p_aout );
 234     aout_InputCheckAndRestart( p_aout, p_input );
 235
 236     /* Input */
 237     p_buffer = aout_InputPlay (p_aout, p_input, p_buffer, i_input_rate,
 238                                &owner->sync.date);
 239     if( p_buffer != NULL )
 240     {
 241         date_Increment (&owner->sync.date, p_buffer->i_nb_samples);
 242
 243         /* Mixer */
 244         float amp = owner->volume.multiplier * p_input->multiplier;
 245         aout_MixerRun (owner->volume.mixer, p_buffer, amp);
 246
 247         /* Output */
 248         aout_OutputPlay( p_aout, p_buffer );
 249     }
 250
 251     aout_unlock( p_aout );
 252     return 0;
 253 }
 254
 255 int aout_DecGetResetLost (audio_output_t *aout)
 256 {
 257     aout_owner_t *owner = aout_owner (aout);
 258     aout_input_t *input = owner->input;
 259     int val;
 260
 261     aout_lock (aout);
 262     val = input->i_buffer_lost;
 263     input->i_buffer_lost = 0;
 264     aout_unlock (aout);
 265
 266     return val;
 267 }
 268
 269 void aout_DecChangePause (audio_output_t *aout, bool paused, mtime_t date)
 270 {
 271     aout_owner_t *owner = aout_owner (aout);
 272
 273     aout_lock (aout);
 274     /* XXX: Should the date be offset by the pause duration instead? */
 275     date_Set (&owner->sync.date, VLC_TS_INVALID);
 276     aout_OutputPause (aout, paused, date);
 277     aout_unlock (aout);
 278 }
 279
 280 void aout_DecFlush (audio_output_t *aout)
 281 {
 282     aout_owner_t *owner = aout_owner (aout);
 283
 284     aout_lock (aout);
 285     date_Set (&owner->sync.date, VLC_TS_INVALID);
 286     aout_OutputFlush (aout, false);
 287     aout_unlock (aout);
 288 }
 289
 290 bool aout_DecIsEmpty (audio_output_t *aout)
 291 {
 292     aout_owner_t *owner = aout_owner (aout);
 293     mtime_t end_date;
 294
 295     aout_lock (aout);
 296     /* FIXME: tell output to drain */
 297     end_date = date_Get (&owner->sync.date);
 298     aout_unlock (aout);
 299     return end_date == VLC_TS_INVALID || end_date <= mdate();
 300 }
 301
 302 /**
 303  * Notifies the audio input of the drift from the requested audio
 304  * playback timestamp (@ref block_t.i_pts) to the anticipated playback time
 305  * as reported by the audio output hardware.
 306  * Depending on the drift amplitude, the input core may ignore the drift
 307  * trigger upsampling or downsampling, or even discard samples.
 308  * Future VLC versions may instead adjust the input decoding speed.
 309  *
 310  * The audio output plugin is responsible for estimating the ideal current
 311  * playback time defined as follows:
 312  *  ideal time = buffer timestamp - (output latency + pending buffer duration)
 313  *
 314  * Practically, this is the PTS (block_t.i_pts) of the current buffer minus
 315  * the latency reported by the output programming interface.
 316  * Computing the estimated drift directly would probably be more intuitive.
 317  * However the use of an absolute time value does not introduce extra
 318  * measurement errors due to the CPU scheduling jitter and clock resolution.
 319  * Furthermore, the ideal while it is an abstract value, is easy for most
 320  * audio output plugins to compute.
 321  * The following definition is equivalent but depends on the clock time:
 322  *  ideal time = real time + drift
 323
 324  * @note If aout_LatencyReport() is never called, the core will assume that
 325  * there is no drift.
 326  *
 327  * @param ideal estimated ideal time as defined above.
 328  */
 329 void aout_TimeReport (audio_output_t *aout, mtime_t ideal)
 330 {
 331     mtime_t delta = mdate() - ideal /* = -drift */;
 332
 333     aout_assert_locked (aout);
 334     if (delta < -AOUT_MAX_PTS_ADVANCE || +AOUT_MAX_PTS_DELAY < delta)
 335     {
 336         aout_owner_t *owner = aout_owner (aout);
 337
 338         msg_Warn (aout, "not synchronized (%"PRId64" us), resampling",
 339                   delta);
 340         if (date_Get (&owner->sync.date) != VLC_TS_INVALID)
 341             date_Move (&owner->sync.date, delta);
 342     }
 343 }