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