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

   1 /*****************************************************************************
   2  * audio_output.c : audio output instance miscellaneous functions
   3  *****************************************************************************
   4  * Copyright (C) 2002 VideoLAN
   5  * $Id: audio_output.c,v 1.100 2002/08/30 22:22:24 massiot Exp $
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <stdlib.h>                            /* calloc(), malloc(), free() */
  28 #include <string.h>
  29
  30 #include <vlc/vlc.h>
  31
  32 #ifdef HAVE_ALLOCA_H
  33 #   include <alloca.h>
  34 #endif
  35
  36 #include "audio_output.h"
  37 #include "aout_internal.h"
  38
  39 /*
  40  * Instances management (see also input.c:aout_InputNew())
  41  */
  42
  43 /*****************************************************************************
  44  * aout_NewInstance: initialize aout structure
  45  *****************************************************************************/
  46 aout_instance_t * __aout_NewInstance( vlc_object_t * p_parent )
  47 {
  48     aout_instance_t * p_aout;
  49
  50     /* Allocate descriptor. */
  51     p_aout = vlc_object_create( p_parent, VLC_OBJECT_AOUT );
  52     if( p_aout == NULL )
  53     {
  54         return NULL;
  55     }
  56
  57     /* Initialize members. */
  58     vlc_mutex_init( p_parent, &p_aout->input_fifos_lock );
  59     vlc_mutex_init( p_parent, &p_aout->mixer_lock );
  60     vlc_mutex_init( p_parent, &p_aout->output_fifo_lock );
  61     p_aout->i_nb_inputs = 0;
  62
  63     vlc_object_attach( p_aout, p_parent->p_vlc );
  64
  65     return p_aout;
  66 }
  67
  68 /*****************************************************************************
  69  * aout_DeleteInstance: destroy aout structure
  70  *****************************************************************************/
  71 void aout_DeleteInstance( aout_instance_t * p_aout )
  72 {
  73     vlc_mutex_destroy( &p_aout->input_fifos_lock );
  74     vlc_mutex_destroy( &p_aout->mixer_lock );
  75     vlc_mutex_destroy( &p_aout->output_fifo_lock );
  76
  77     /* Free structure. */
  78     vlc_object_destroy( p_aout );
  79 }
  80
  81
  82 /*
  83  * Buffer management (interface to the decoders)
  84  */
  85
  86 /*****************************************************************************
  87  * aout_BufferNew : ask for a new empty buffer
  88  *****************************************************************************/
  89 aout_buffer_t * aout_BufferNew( aout_instance_t * p_aout,
  90                                 aout_input_t * p_input,
  91                                 size_t i_nb_samples )
  92 {
  93     aout_buffer_t * p_buffer;
  94     mtime_t duration = (1000000 * (mtime_t)i_nb_samples)
  95                         / p_input->input.i_rate;
  96
  97     /* This necessarily allocates in the heap. */
  98     aout_BufferAlloc( &p_input->input_alloc, duration, NULL, p_buffer );
  99     p_buffer->i_nb_samples = i_nb_samples;
 100     p_buffer->i_nb_bytes = i_nb_samples * p_input->input.i_bytes_per_frame
 101                               / p_input->input.i_frame_length;
 102
 103     if ( p_buffer == NULL )
 104     {
 105         msg_Err( p_aout, "NULL buffer !" );
 106     }
 107     else
 108     {
 109         p_buffer->start_date = p_buffer->end_date = 0;
 110     }
 111
 112     return p_buffer;
 113 }
 114
 115 /*****************************************************************************
 116  * aout_BufferDelete : destroy an undecoded buffer
 117  *****************************************************************************/
 118 void aout_BufferDelete( aout_instance_t * p_aout, aout_input_t * p_input,
 119                         aout_buffer_t * p_buffer )
 120 {
 121     aout_BufferFree( p_buffer );
 122 }
 123
 124 /*****************************************************************************
 125  * aout_BufferPlay : filter & mix the decoded buffer
 126  *****************************************************************************/
 127 void aout_BufferPlay( aout_instance_t * p_aout, aout_input_t * p_input,
 128                       aout_buffer_t * p_buffer )
 129 {
 130     if ( p_buffer->start_date == 0 )
 131     {
 132         msg_Warn( p_aout, "non-dated buffer received" );
 133         aout_BufferFree( p_buffer );
 134     }
 135     else
 136     {
 137         p_buffer->end_date = p_buffer->start_date
 138                                 + (mtime_t)(p_buffer->i_nb_samples * 1000000)
 139                                     / p_input->input.i_rate;
 140     }
 141
 142     /* If the buffer is too early, wait a while. */
 143     mwait( p_buffer->start_date - AOUT_MAX_PREPARE_TIME );
 144
 145     aout_InputPlay( p_aout, p_input, p_buffer );
 146
 147     /* Run the mixer if it is able to run. */
 148     aout_MixerRun( p_aout );
 149 }
 150
 151
 152 /*
 153  * Formats management (internal)
 154  */
 155
 156 /*****************************************************************************
 157  * aout_FormatPrepare : compute the number of bytes per frame & frame length
 158  *****************************************************************************/
 159 void aout_FormatPrepare( audio_sample_format_t * p_format )
 160 {
 161     int i_result;
 162
 163     switch ( p_format->i_format )
 164     {
 165     case AOUT_FMT_U8:
 166     case AOUT_FMT_S8:
 167         i_result = 1;
 168         break;
 169
 170     case AOUT_FMT_U16_LE:
 171     case AOUT_FMT_U16_BE:
 172     case AOUT_FMT_S16_LE:
 173     case AOUT_FMT_S16_BE:
 174         i_result = 2;
 175         break;
 176
 177     case AOUT_FMT_FLOAT32:
 178     case AOUT_FMT_FIXED32:
 179         i_result = 4;
 180         break;
 181
 182     case AOUT_FMT_SPDIF:
 183     case AOUT_FMT_A52:
 184     case AOUT_FMT_DTS:
 185         /* For these formats the caller has to indicate the parameters
 186          * by hand. */
 187         return;
 188
 189     default:
 190         i_result = 0; /* will segfault much sooner... */
 191     }
 192
 193     p_format->i_bytes_per_frame = i_result * p_format->i_channels;
 194     p_format->i_frame_length = 1;
 195 }
 196
 197
 198 /*
 199  * FIFO management (internal) - please understand that solving race conditions
 200  * is _your_ job, ie. in the audio output you should own the mixer lock
 201  * before calling any of these functions.
 202  */
 203
 204 /*****************************************************************************
 205  * aout_FifoInit : initialize the members of a FIFO
 206  *****************************************************************************/
 207 void aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
 208                     u32 i_rate )
 209 {
 210     p_fifo->p_first = NULL;
 211     p_fifo->pp_last = &p_fifo->p_first;
 212     aout_DateInit( &p_fifo->end_date, i_rate );
 213 }
 214
 215 /*****************************************************************************
 216  * aout_FifoPush : push a packet into the FIFO
 217  *****************************************************************************/
 218 void aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
 219                     aout_buffer_t * p_buffer )
 220 {
 221     *p_fifo->pp_last = p_buffer;
 222     p_fifo->pp_last = &p_buffer->p_next;
 223     *p_fifo->pp_last = NULL;
 224     /* Enforce the continuity of the stream. */
 225     if ( aout_DateGet( &p_fifo->end_date ) )
 226     {
 227         p_buffer->start_date = aout_DateGet( &p_fifo->end_date );
 228         p_buffer->end_date = aout_DateIncrement( &p_fifo->end_date,
 229                                                  p_buffer->i_nb_samples );
 230     }
 231     else
 232     {
 233         aout_DateSet( &p_fifo->end_date, p_buffer->end_date );
 234     }
 235 }
 236
 237 /*****************************************************************************
 238  * aout_FifoSet : set end_date and trash all buffers (because they aren't
 239  * properly dated)
 240  *****************************************************************************/
 241 void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
 242                    mtime_t date )
 243 {
 244     aout_buffer_t * p_buffer;
 245
 246     aout_DateSet( &p_fifo->end_date, date );
 247     p_buffer = p_fifo->p_first;
 248     while ( p_buffer != NULL )
 249     {
 250         aout_buffer_t * p_next = p_buffer->p_next;
 251         aout_BufferFree( p_buffer );
 252         p_buffer = p_next;
 253     }
 254     p_fifo->p_first = NULL;
 255     p_fifo->pp_last = &p_fifo->p_first;
 256 }
 257
 258 /*****************************************************************************
 259  * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
 260  *****************************************************************************/
 261 void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
 262                          mtime_t difference )
 263 {
 264     aout_buffer_t * p_buffer;
 265
 266     aout_DateMove( &p_fifo->end_date, difference );
 267     p_buffer = p_fifo->p_first;
 268     while ( p_buffer != NULL )
 269     {
 270         p_buffer->start_date += difference;
 271         p_buffer->end_date += difference;
 272         p_buffer = p_buffer->p_next;
 273     }
 274 }
 275
 276 /*****************************************************************************
 277  * aout_FifoNextStart : return the current end_date
 278  *****************************************************************************/
 279 mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
 280 {
 281     return aout_DateGet( &p_fifo->end_date );
 282 }
 283
 284 /*****************************************************************************
 285  * aout_FifoPop : get the next buffer out of the FIFO
 286  *****************************************************************************/
 287 aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
 288 {
 289     aout_buffer_t * p_buffer;
 290     p_buffer = p_fifo->p_first;
 291     if ( p_buffer == NULL ) return NULL;
 292     p_fifo->p_first = p_buffer->p_next;
 293     if ( p_fifo->p_first == NULL )
 294     {
 295         p_fifo->pp_last = &p_fifo->p_first;
 296     }
 297
 298     return p_buffer;
 299 }
 300
 301 /*****************************************************************************
 302  * aout_FifoDestroy : destroy a FIFO and its buffers
 303  *****************************************************************************/
 304 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
 305 {
 306     aout_buffer_t * p_buffer;
 307
 308     p_buffer = p_fifo->p_first;
 309     while ( p_buffer != NULL )
 310     {
 311         aout_buffer_t * p_next = p_buffer->p_next;
 312         aout_BufferFree( p_buffer );
 313         p_buffer = p_next;
 314     }
 315 }
 316
 317
 318 /*
 319  * Date management (internal and external)
 320  */
 321
 322 /*****************************************************************************
 323  * aout_DateInit : set the divider of an audio_date_t
 324  *****************************************************************************/
 325 void aout_DateInit( audio_date_t * p_date, u32 i_divider )
 326 {
 327     p_date->date = 0;
 328     p_date->i_divider = i_divider;
 329     p_date->i_remainder = 0;
 330 }
 331
 332 /*****************************************************************************
 333  * aout_DateSet : set the date of an audio_date_t
 334  *****************************************************************************/
 335 void aout_DateSet( audio_date_t * p_date, mtime_t new_date )
 336 {
 337     p_date->date = new_date;
 338     p_date->i_remainder = 0;
 339 }
 340
 341 /*****************************************************************************
 342  * aout_DateMove : move forwards or backwards the date of an audio_date_t
 343  *****************************************************************************/
 344 void aout_DateMove( audio_date_t * p_date, mtime_t difference )
 345 {
 346     p_date->date += difference;
 347 }
 348
 349 /*****************************************************************************
 350  * aout_DateGet : get the date of an audio_date_t
 351  *****************************************************************************/
 352 mtime_t aout_DateGet( const audio_date_t * p_date )
 353 {
 354     return p_date->date;
 355 }
 356
 357 /*****************************************************************************
 358  * aout_DateIncrement : increment the date and return the result, taking
 359  * into account rounding errors
 360  *****************************************************************************/
 361 mtime_t aout_DateIncrement( audio_date_t * p_date, u32 i_nb_samples )
 362 {
 363     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
 364     p_date->date += i_dividend / p_date->i_divider;
 365     p_date->i_remainder += i_dividend % p_date->i_divider;
 366     if ( p_date->i_remainder >= p_date->i_divider )
 367     {
 368         /* This is Bresenham algorithm. */
 369         p_date->date++;
 370         p_date->i_remainder -= p_date->i_divider;
 371     }
 372     return p_date->date;
 373 }
 374