1 /*****************************************************************************
2 * common.c : audio output management of common data structures
3 *****************************************************************************
4 * Copyright (C) 2002 VideoLAN
5 * $Id: common.c,v 1.13 2003/01/15 10:58:48 massiot Exp $
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* calloc(), malloc(), free() */
32 #include "audio_output.h"
33 #include "aout_internal.h"
37 * Instances management (internal and external)
40 /*****************************************************************************
41 * aout_New: initialize aout structure
42 *****************************************************************************/
43 aout_instance_t * __aout_New( vlc_object_t * p_parent )
45 aout_instance_t * p_aout;
48 /* Allocate descriptor. */
49 p_aout = vlc_object_create( p_parent, VLC_OBJECT_AOUT );
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;
64 var_Create( p_aout, "intf-change", VLC_VAR_BOOL );
65 val.b_bool = VLC_TRUE;
66 var_Set( p_aout, "intf-change", val );
68 vlc_object_attach( p_aout, p_parent->p_vlc );
73 /*****************************************************************************
74 * aout_Delete: destroy aout structure
75 *****************************************************************************/
76 void aout_Delete( aout_instance_t * p_aout )
78 var_Destroy( p_aout, "intf-change" );
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 );
85 vlc_object_destroy( p_aout );
90 * Formats management (internal and external)
93 /*****************************************************************************
94 * aout_FormatNbChannels : return the number of channels
95 *****************************************************************************/
96 unsigned int aout_FormatNbChannels( const audio_sample_format_t * p_format )
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,
102 unsigned int i_nb = 0, i;
104 for ( i = 0; i < sizeof(pi_channels)/sizeof(uint32_t); i++ )
106 if ( p_format->i_physical_channels & pi_channels[i] ) i_nb++;
112 /*****************************************************************************
113 * aout_FormatPrepare : compute the number of bytes per frame & frame length
114 *****************************************************************************/
115 void aout_FormatPrepare( audio_sample_format_t * p_format )
119 switch ( p_format->i_format )
121 case VLC_FOURCC('u','8',' ',' '):
122 case VLC_FOURCC('s','8',' ',' '):
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'):
133 case VLC_FOURCC('f','l','3','2'):
134 case VLC_FOURCC('f','i','3','2'):
138 case VLC_FOURCC('s','p','d','i'):
139 case VLC_FOURCC('a','5','2',' '):
140 case VLC_FOURCC('d','t','s',' '):
141 case VLC_FOURCC('m','p','g','a'):
142 case VLC_FOURCC('m','p','g','3'):
144 /* For these formats the caller has to indicate the parameters
149 p_format->i_bytes_per_frame = i_result * aout_FormatNbChannels( p_format );
150 p_format->i_frame_length = 1;
153 /*****************************************************************************
154 * aout_FormatPrintChannels : print a channel in a human-readable form
155 *****************************************************************************/
156 const char * aout_FormatPrintChannels( const audio_sample_format_t * p_format )
158 switch ( p_format->i_physical_channels & AOUT_CHAN_PHYSMASK )
160 case AOUT_CHAN_CENTER:
161 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
162 || (p_format->i_original_channels
163 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
165 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
168 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
169 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
171 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
173 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
175 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
176 return "Stereo/Left";
177 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
178 return "Stereo/Right";
180 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
182 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
184 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
185 | AOUT_CHAN_REARCENTER:
187 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
188 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
190 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
191 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
194 case AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
195 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
196 || (p_format->i_original_channels
197 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
199 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
202 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE:
203 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
205 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
206 return "Dual-mono/LFE";
207 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
209 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
210 return "Stereo/Left/LFE";
211 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
212 return "Stereo/Right/LFE";
214 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
216 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER
219 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
220 | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE:
222 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
223 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
225 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
226 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
233 /*****************************************************************************
234 * aout_FormatPrint : print a format in a human-readable form
235 *****************************************************************************/
236 void aout_FormatPrint( aout_instance_t * p_aout, const char * psz_text,
237 const audio_sample_format_t * p_format )
239 msg_Dbg( p_aout, "%s '%4.4s' %d Hz %s frame=%d samples/%d bytes", psz_text,
240 (char *)&p_format->i_format, p_format->i_rate,
241 aout_FormatPrintChannels( p_format ),
242 p_format->i_frame_length, p_format->i_bytes_per_frame );
245 /*****************************************************************************
246 * aout_FormatsPrint : print two formats in a human-readable form
247 *****************************************************************************/
248 void aout_FormatsPrint( aout_instance_t * p_aout, const char * psz_text,
249 const audio_sample_format_t * p_format1,
250 const audio_sample_format_t * p_format2 )
252 msg_Dbg( p_aout, "%s '%4.4s'->'%4.4s' %d Hz->%d Hz %s->%s",
254 (char *)&p_format1->i_format, (char *)&p_format2->i_format,
255 p_format1->i_rate, p_format2->i_rate,
256 aout_FormatPrintChannels( p_format1 ),
257 aout_FormatPrintChannels( p_format2 ) );
262 * FIFO management (internal) - please understand that solving race conditions
263 * is _your_ job, ie. in the audio output you should own the mixer lock
264 * before calling any of these functions.
267 /*****************************************************************************
268 * aout_FifoInit : initialize the members of a FIFO
269 *****************************************************************************/
270 void aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
273 p_fifo->p_first = NULL;
274 p_fifo->pp_last = &p_fifo->p_first;
275 aout_DateInit( &p_fifo->end_date, i_rate );
278 /*****************************************************************************
279 * aout_FifoPush : push a packet into the FIFO
280 *****************************************************************************/
281 void aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
282 aout_buffer_t * p_buffer )
284 *p_fifo->pp_last = p_buffer;
285 p_fifo->pp_last = &p_buffer->p_next;
286 *p_fifo->pp_last = NULL;
287 /* Enforce the continuity of the stream. */
288 if ( aout_DateGet( &p_fifo->end_date ) )
290 p_buffer->start_date = aout_DateGet( &p_fifo->end_date );
291 p_buffer->end_date = aout_DateIncrement( &p_fifo->end_date,
292 p_buffer->i_nb_samples );
296 aout_DateSet( &p_fifo->end_date, p_buffer->end_date );
300 /*****************************************************************************
301 * aout_FifoSet : set end_date and trash all buffers (because they aren't
303 *****************************************************************************/
304 void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
307 aout_buffer_t * p_buffer;
309 aout_DateSet( &p_fifo->end_date, date );
310 p_buffer = p_fifo->p_first;
311 while ( p_buffer != NULL )
313 aout_buffer_t * p_next = p_buffer->p_next;
314 aout_BufferFree( p_buffer );
317 p_fifo->p_first = NULL;
318 p_fifo->pp_last = &p_fifo->p_first;
321 /*****************************************************************************
322 * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
323 *****************************************************************************/
324 void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
327 aout_buffer_t * p_buffer;
329 aout_DateMove( &p_fifo->end_date, difference );
330 p_buffer = p_fifo->p_first;
331 while ( p_buffer != NULL )
333 p_buffer->start_date += difference;
334 p_buffer->end_date += difference;
335 p_buffer = p_buffer->p_next;
339 /*****************************************************************************
340 * aout_FifoNextStart : return the current end_date
341 *****************************************************************************/
342 mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
344 return aout_DateGet( &p_fifo->end_date );
347 /*****************************************************************************
348 * aout_FifoFirstDate : return the playing date of the first buffer in the
350 *****************************************************************************/
351 mtime_t aout_FifoFirstDate( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
353 return p_fifo->p_first ? p_fifo->p_first->start_date : 0;
356 /*****************************************************************************
357 * aout_FifoPop : get the next buffer out of the FIFO
358 *****************************************************************************/
359 aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
361 aout_buffer_t * p_buffer;
363 p_buffer = p_fifo->p_first;
364 if ( p_buffer == NULL ) return NULL;
365 p_fifo->p_first = p_buffer->p_next;
366 if ( p_fifo->p_first == NULL )
368 p_fifo->pp_last = &p_fifo->p_first;
374 /*****************************************************************************
375 * aout_FifoDestroy : destroy a FIFO and its buffers
376 *****************************************************************************/
377 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
379 aout_buffer_t * p_buffer;
381 p_buffer = p_fifo->p_first;
382 while ( p_buffer != NULL )
384 aout_buffer_t * p_next = p_buffer->p_next;
385 aout_BufferFree( p_buffer );
392 * Date management (internal and external)
395 /*****************************************************************************
396 * aout_DateInit : set the divider of an audio_date_t
397 *****************************************************************************/
398 void aout_DateInit( audio_date_t * p_date, uint32_t i_divider )
401 p_date->i_divider = i_divider;
402 p_date->i_remainder = 0;
405 /*****************************************************************************
406 * aout_DateSet : set the date of an audio_date_t
407 *****************************************************************************/
408 void aout_DateSet( audio_date_t * p_date, mtime_t new_date )
410 p_date->date = new_date;
411 p_date->i_remainder = 0;
414 /*****************************************************************************
415 * aout_DateMove : move forwards or backwards the date of an audio_date_t
416 *****************************************************************************/
417 void aout_DateMove( audio_date_t * p_date, mtime_t difference )
419 p_date->date += difference;
422 /*****************************************************************************
423 * aout_DateGet : get the date of an audio_date_t
424 *****************************************************************************/
425 mtime_t aout_DateGet( const audio_date_t * p_date )
430 /*****************************************************************************
431 * aout_DateIncrement : increment the date and return the result, taking
432 * into account rounding errors
433 *****************************************************************************/
434 mtime_t aout_DateIncrement( audio_date_t * p_date, uint32_t i_nb_samples )
436 mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
437 p_date->date += i_dividend / p_date->i_divider;
438 p_date->i_remainder += (int)(i_dividend % p_date->i_divider);
439 if ( p_date->i_remainder >= p_date->i_divider )
441 /* This is Bresenham algorithm. */
443 p_date->i_remainder -= p_date->i_divider;