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

   1 /*****************************************************************************
   2  * common.c : audio output management of common data structures
   3  *****************************************************************************
   4  * Copyright (C) 2002 VideoLAN
   5  * $Id: common.c,v 1.11 2002/12/07 23:50:30 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 #include "audio_output.h"
  33 #include "aout_internal.h"
  34
  35
  36 /*
  37  * Instances management (internal and external)
  38  */
  39
  40 /*****************************************************************************
  41  * aout_New: initialize aout structure
  42  *****************************************************************************/
  43 aout_instance_t * __aout_New( vlc_object_t * p_parent )
  44 {
  45     aout_instance_t * p_aout;
  46     vlc_value_t val;
  47
  48     /* Allocate descriptor. */
  49     p_aout = vlc_object_create( p_parent, VLC_OBJECT_AOUT );
  50     if( p_aout == NULL )
  51     {
  52         return NULL;
  53     }
  54
  55     /* Initialize members. */
  56     vlc_mutex_init( p_parent, &p_aout->input_fifos_lock );
  57     vlc_mutex_init( p_parent, &p_aout->mixer_lock );
  58     vlc_mutex_init( p_parent, &p_aout->output_fifo_lock );
  59     p_aout->i_nb_inputs = 0;
  60     p_aout->mixer.f_multiplier = 1.0;
  61     p_aout->mixer.b_error = 1;
  62     p_aout->output.b_starving = 1;
  63
  64     var_Create( p_aout, "intf-change", VLC_VAR_BOOL );
  65     val.b_bool = VLC_TRUE;
  66     var_Set( p_aout, "intf-change", val );
  67
  68     vlc_object_attach( p_aout, p_parent->p_vlc );
  69
  70     return p_aout;
  71 }
  72
  73 /*****************************************************************************
  74  * aout_Delete: destroy aout structure
  75  *****************************************************************************/
  76 void aout_Delete( aout_instance_t * p_aout )
  77 {
  78     var_Destroy( p_aout, "intf-change" );
  79
  80     vlc_mutex_destroy( &p_aout->input_fifos_lock );
  81     vlc_mutex_destroy( &p_aout->mixer_lock );
  82     vlc_mutex_destroy( &p_aout->output_fifo_lock );
  83
  84     /* Free structure. */
  85     vlc_object_destroy( p_aout );
  86 }
  87
  88
  89 /*
  90  * Formats management (internal and external)
  91  */
  92
  93 /*****************************************************************************
  94  * aout_FormatNbChannels : return the number of channels
  95  *****************************************************************************/
  96 unsigned int aout_FormatNbChannels( const audio_sample_format_t * p_format )
  97 {
  98     static const uint32_t pi_channels[] =
  99         { AOUT_CHAN_CENTER, AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
 100           AOUT_CHAN_REARCENTER, AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
 101           AOUT_CHAN_LFE };
 102     unsigned int i_nb = 0, i;
 103
 104     for ( i = 0; i < sizeof(pi_channels)/sizeof(uint32_t); i++ )
 105     {
 106         if ( p_format->i_physical_channels & pi_channels[i] ) i_nb++;
 107     }
 108
 109     return i_nb;
 110 }
 111
 112 /*****************************************************************************
 113  * aout_FormatPrepare : compute the number of bytes per frame & frame length
 114  *****************************************************************************/
 115 void aout_FormatPrepare( audio_sample_format_t * p_format )
 116 {
 117     int i_result;
 118
 119     switch ( p_format->i_format )
 120     {
 121     case VLC_FOURCC('u','8',' ',' '):
 122     case VLC_FOURCC('s','8',' ',' '):
 123         i_result = 1;
 124         break;
 125
 126     case VLC_FOURCC('u','1','6','l'):
 127     case VLC_FOURCC('s','1','6','l'):
 128     case VLC_FOURCC('u','1','6','b'):
 129     case VLC_FOURCC('s','1','6','b'):
 130         i_result = 2;
 131         break;
 132
 133     case VLC_FOURCC('f','l','3','2'):
 134     case VLC_FOURCC('f','i','3','2'):
 135         i_result = 4;
 136         break;
 137
 138     case VLC_FOURCC('s','p','d','i'):
 139     case VLC_FOURCC('a','5','2',' '):
 140     case VLC_FOURCC('d','t','s',' '):
 141     default:
 142         /* For these formats the caller has to indicate the parameters
 143          * by hand. */
 144         return;
 145     }
 146
 147     p_format->i_bytes_per_frame = i_result * aout_FormatNbChannels( p_format );
 148     p_format->i_frame_length = 1;
 149 }
 150
 151 /*****************************************************************************
 152  * aout_FormatPrintChannels : print a channel in a human-readable form
 153  *****************************************************************************/
 154 const char * aout_FormatPrintChannels( const audio_sample_format_t * p_format )
 155 {
 156     switch ( p_format->i_physical_channels & AOUT_CHAN_PHYSMASK )
 157     {
 158     case AOUT_CHAN_CENTER:
 159         if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
 160               || (p_format->i_original_channels
 161                    & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
 162             return "Mono";
 163         else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
 164             return "Left";
 165         return "Right";
 166     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
 167         if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
 168             return "Dolby";
 169         else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
 170             return "Dual-mono";
 171         else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
 172             return "Stereo/Left";
 173         else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
 174             return "Stereo/Right";
 175         return "Stereo";
 176     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
 177         return "3F";
 178     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
 179         return "2F1R";
 180     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 181           | AOUT_CHAN_REARCENTER:
 182         return "3F1R";
 183     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
 184           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
 185         return "2F2R";
 186     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 187           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
 188         return "3F2R";
 189
 190     case AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
 191         if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
 192               || (p_format->i_original_channels
 193                    & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
 194             return "Mono/LFE";
 195         else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
 196             return "Left/LFE";
 197         return "Right/LFE";
 198     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE:
 199         if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
 200             return "Dolby/LFE";
 201         else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
 202             return "Dual-mono/LFE";
 203         else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
 204             return "Stereo/Left/LFE";
 205         else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
 206             return "Stereo/Right/LFE";
 207          return "Stereo/LFE";
 208     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
 209         return "3F/LFE";
 210     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER
 211           | AOUT_CHAN_LFE:
 212         return "2F1R/LFE";
 213     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 214           | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE:
 215         return "3F1R/LFE";
 216     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
 217           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
 218         return "2F2R/LFE";
 219     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 220           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
 221         return "3F2R/LFE";
 222     }
 223
 224     return "ERROR";
 225 }
 226
 227 /*****************************************************************************
 228  * aout_FormatPrint : print a format in a human-readable form
 229  *****************************************************************************/
 230 void aout_FormatPrint( aout_instance_t * p_aout, const char * psz_text,
 231                        const audio_sample_format_t * p_format )
 232 {
 233     msg_Dbg( p_aout, "%s format='%4.4s' rate=%d channels=%s", psz_text,
 234              (char *)&p_format->i_format, p_format->i_rate,
 235              aout_FormatPrintChannels( p_format ) );
 236 }
 237
 238 /*****************************************************************************
 239  * aout_FormatsPrint : print two formats in a human-readable form
 240  *****************************************************************************/
 241 void aout_FormatsPrint( aout_instance_t * p_aout, const char * psz_text,
 242                         const audio_sample_format_t * p_format1,
 243                         const audio_sample_format_t * p_format2 )
 244 {
 245     msg_Dbg( p_aout, "%s format='%4.4s'->'%4.4s' rate=%d->%d channels=%s->%s",
 246              psz_text,
 247              (char *)&p_format1->i_format, (char *)&p_format2->i_format,
 248              p_format1->i_rate, p_format2->i_rate,
 249              aout_FormatPrintChannels( p_format1 ),
 250              aout_FormatPrintChannels( p_format2 ) );
 251 }
 252
 253
 254 /*
 255  * FIFO management (internal) - please understand that solving race conditions
 256  * is _your_ job, ie. in the audio output you should own the mixer lock
 257  * before calling any of these functions.
 258  */
 259
 260 /*****************************************************************************
 261  * aout_FifoInit : initialize the members of a FIFO
 262  *****************************************************************************/
 263 void aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
 264                     uint32_t i_rate )
 265 {
 266     p_fifo->p_first = NULL;
 267     p_fifo->pp_last = &p_fifo->p_first;
 268     aout_DateInit( &p_fifo->end_date, i_rate );
 269 }
 270
 271 /*****************************************************************************
 272  * aout_FifoPush : push a packet into the FIFO
 273  *****************************************************************************/
 274 void aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
 275                     aout_buffer_t * p_buffer )
 276 {
 277     *p_fifo->pp_last = p_buffer;
 278     p_fifo->pp_last = &p_buffer->p_next;
 279     *p_fifo->pp_last = NULL;
 280     /* Enforce the continuity of the stream. */
 281     if ( aout_DateGet( &p_fifo->end_date ) )
 282     {
 283         p_buffer->start_date = aout_DateGet( &p_fifo->end_date );
 284         p_buffer->end_date = aout_DateIncrement( &p_fifo->end_date,
 285                                                  p_buffer->i_nb_samples );
 286     }
 287     else
 288     {
 289         aout_DateSet( &p_fifo->end_date, p_buffer->end_date );
 290     }
 291 }
 292
 293 /*****************************************************************************
 294  * aout_FifoSet : set end_date and trash all buffers (because they aren't
 295  * properly dated)
 296  *****************************************************************************/
 297 void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
 298                    mtime_t date )
 299 {
 300     aout_buffer_t * p_buffer;
 301
 302     aout_DateSet( &p_fifo->end_date, date );
 303     p_buffer = p_fifo->p_first;
 304     while ( p_buffer != NULL )
 305     {
 306         aout_buffer_t * p_next = p_buffer->p_next;
 307         aout_BufferFree( p_buffer );
 308         p_buffer = p_next;
 309     }
 310     p_fifo->p_first = NULL;
 311     p_fifo->pp_last = &p_fifo->p_first;
 312 }
 313
 314 /*****************************************************************************
 315  * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
 316  *****************************************************************************/
 317 void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
 318                          mtime_t difference )
 319 {
 320     aout_buffer_t * p_buffer;
 321
 322     aout_DateMove( &p_fifo->end_date, difference );
 323     p_buffer = p_fifo->p_first;
 324     while ( p_buffer != NULL )
 325     {
 326         p_buffer->start_date += difference;
 327         p_buffer->end_date += difference;
 328         p_buffer = p_buffer->p_next;
 329     }
 330 }
 331
 332 /*****************************************************************************
 333  * aout_FifoNextStart : return the current end_date
 334  *****************************************************************************/
 335 mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
 336 {
 337     return aout_DateGet( &p_fifo->end_date );
 338 }
 339
 340 /*****************************************************************************
 341  * aout_FifoFirstDate : return the playing date of the first buffer in the
 342  * FIFO
 343  *****************************************************************************/
 344 mtime_t aout_FifoFirstDate( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
 345 {
 346     return p_fifo->p_first ?  p_fifo->p_first->start_date : 0;
 347 }
 348
 349 /*****************************************************************************
 350  * aout_FifoPop : get the next buffer out of the FIFO
 351  *****************************************************************************/
 352 aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
 353 {
 354     aout_buffer_t * p_buffer;
 355
 356     p_buffer = p_fifo->p_first;
 357     if ( p_buffer == NULL ) return NULL;
 358     p_fifo->p_first = p_buffer->p_next;
 359     if ( p_fifo->p_first == NULL )
 360     {
 361         p_fifo->pp_last = &p_fifo->p_first;
 362     }
 363
 364     return p_buffer;
 365 }
 366
 367 /*****************************************************************************
 368  * aout_FifoDestroy : destroy a FIFO and its buffers
 369  *****************************************************************************/
 370 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
 371 {
 372     aout_buffer_t * p_buffer;
 373
 374     p_buffer = p_fifo->p_first;
 375     while ( p_buffer != NULL )
 376     {
 377         aout_buffer_t * p_next = p_buffer->p_next;
 378         aout_BufferFree( p_buffer );
 379         p_buffer = p_next;
 380     }
 381 }
 382
 383
 384 /*
 385  * Date management (internal and external)
 386  */
 387
 388 /*****************************************************************************
 389  * aout_DateInit : set the divider of an audio_date_t
 390  *****************************************************************************/
 391 void aout_DateInit( audio_date_t * p_date, uint32_t i_divider )
 392 {
 393     p_date->date = 0;
 394     p_date->i_divider = i_divider;
 395     p_date->i_remainder = 0;
 396 }
 397
 398 /*****************************************************************************
 399  * aout_DateSet : set the date of an audio_date_t
 400  *****************************************************************************/
 401 void aout_DateSet( audio_date_t * p_date, mtime_t new_date )
 402 {
 403     p_date->date = new_date;
 404     p_date->i_remainder = 0;
 405 }
 406
 407 /*****************************************************************************
 408  * aout_DateMove : move forwards or backwards the date of an audio_date_t
 409  *****************************************************************************/
 410 void aout_DateMove( audio_date_t * p_date, mtime_t difference )
 411 {
 412     p_date->date += difference;
 413 }
 414
 415 /*****************************************************************************
 416  * aout_DateGet : get the date of an audio_date_t
 417  *****************************************************************************/
 418 mtime_t aout_DateGet( const audio_date_t * p_date )
 419 {
 420     return p_date->date;
 421 }
 422
 423 /*****************************************************************************
 424  * aout_DateIncrement : increment the date and return the result, taking
 425  * into account rounding errors
 426  *****************************************************************************/
 427 mtime_t aout_DateIncrement( audio_date_t * p_date, uint32_t i_nb_samples )
 428 {
 429     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
 430     p_date->date += i_dividend / p_date->i_divider;
 431     p_date->i_remainder += (int)(i_dividend % p_date->i_divider);
 432     if ( p_date->i_remainder >= p_date->i_divider )
 433     {
 434         /* This is Bresenham algorithm. */
 435         p_date->date++;
 436         p_date->i_remainder -= p_date->i_divider;
 437     }
 438     return p_date->date;
 439 }
 440