1 /*****************************************************************************
2 * common.c : audio output management of common data structures
3 *****************************************************************************
4 * Copyright (C) 2002 VideoLAN
5 * $Id: common.c,v 1.16 2003/01/23 17:13:28 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_error = 1;
63 p_aout->output.b_starving = 1;
65 var_Create( p_aout, "intf-change", VLC_VAR_BOOL );
66 val.b_bool = VLC_TRUE;
67 var_Set( p_aout, "intf-change", val );
69 vlc_object_attach( p_aout, p_parent->p_vlc );
74 /*****************************************************************************
75 * aout_Delete: destroy aout structure
76 *****************************************************************************/
77 void aout_Delete( aout_instance_t * p_aout )
79 var_Destroy( p_aout, "intf-change" );
81 vlc_mutex_destroy( &p_aout->input_fifos_lock );
82 vlc_mutex_destroy( &p_aout->mixer_lock );
83 vlc_mutex_destroy( &p_aout->output_fifo_lock );
86 vlc_object_destroy( p_aout );
91 * Formats management (internal and external)
94 /*****************************************************************************
95 * aout_FormatNbChannels : return the number of channels
96 *****************************************************************************/
97 unsigned int aout_FormatNbChannels( const audio_sample_format_t * p_format )
99 static const uint32_t pi_channels[] =
100 { AOUT_CHAN_CENTER, AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
101 AOUT_CHAN_REARCENTER, AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
103 unsigned int i_nb = 0, i;
105 for ( i = 0; i < sizeof(pi_channels)/sizeof(uint32_t); i++ )
107 if ( p_format->i_physical_channels & pi_channels[i] ) i_nb++;
113 /*****************************************************************************
114 * aout_FormatPrepare : compute the number of bytes per frame & frame length
115 *****************************************************************************/
116 void aout_FormatPrepare( audio_sample_format_t * p_format )
120 switch ( p_format->i_format )
122 case VLC_FOURCC('u','8',' ',' '):
123 case VLC_FOURCC('s','8',' ',' '):
127 case VLC_FOURCC('u','1','6','l'):
128 case VLC_FOURCC('s','1','6','l'):
129 case VLC_FOURCC('u','1','6','b'):
130 case VLC_FOURCC('s','1','6','b'):
134 case VLC_FOURCC('f','l','3','2'):
135 case VLC_FOURCC('f','i','3','2'):
139 case VLC_FOURCC('s','p','d','i'):
140 case VLC_FOURCC('a','5','2',' '):
141 case VLC_FOURCC('d','t','s',' '):
142 case VLC_FOURCC('m','p','g','a'):
143 case VLC_FOURCC('m','p','g','3'):
145 /* For these formats the caller has to indicate the parameters
150 p_format->i_bytes_per_frame = i_result * aout_FormatNbChannels( p_format );
151 p_format->i_frame_length = 1;
154 /*****************************************************************************
155 * aout_FormatPrintChannels : print a channel in a human-readable form
156 *****************************************************************************/
157 const char * aout_FormatPrintChannels( const audio_sample_format_t * p_format )
159 switch ( p_format->i_physical_channels & AOUT_CHAN_PHYSMASK )
161 case AOUT_CHAN_CENTER:
162 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
163 || (p_format->i_original_channels
164 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
166 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
169 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
170 if ( p_format->i_original_channels & AOUT_CHAN_REVERSESTEREO )
172 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
173 return "Dolby/Reverse";
174 return "Stereo/Reverse";
178 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
180 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
182 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
183 return "Stereo/Mono";
184 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
185 return "Stereo/Left";
186 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
187 return "Stereo/Right";
190 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
192 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
194 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
195 | AOUT_CHAN_REARCENTER:
197 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
198 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
200 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
201 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
204 case AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
205 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
206 || (p_format->i_original_channels
207 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
209 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
212 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE:
213 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
215 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
216 return "Dual-mono/LFE";
217 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
219 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
220 return "Stereo/Left/LFE";
221 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
222 return "Stereo/Right/LFE";
224 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
226 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER
229 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
230 | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE:
232 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
233 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
235 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
236 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
243 /*****************************************************************************
244 * aout_FormatPrint : print a format in a human-readable form
245 *****************************************************************************/
246 void aout_FormatPrint( aout_instance_t * p_aout, const char * psz_text,
247 const audio_sample_format_t * p_format )
249 msg_Dbg( p_aout, "%s '%4.4s' %d Hz %s frame=%d samples/%d bytes", psz_text,
250 (char *)&p_format->i_format, p_format->i_rate,
251 aout_FormatPrintChannels( p_format ),
252 p_format->i_frame_length, p_format->i_bytes_per_frame );
255 /*****************************************************************************
256 * aout_FormatsPrint : print two formats in a human-readable form
257 *****************************************************************************/
258 void aout_FormatsPrint( aout_instance_t * p_aout, const char * psz_text,
259 const audio_sample_format_t * p_format1,
260 const audio_sample_format_t * p_format2 )
262 msg_Dbg( p_aout, "%s '%4.4s'->'%4.4s' %d Hz->%d Hz %s->%s",
264 (char *)&p_format1->i_format, (char *)&p_format2->i_format,
265 p_format1->i_rate, p_format2->i_rate,
266 aout_FormatPrintChannels( p_format1 ),
267 aout_FormatPrintChannels( p_format2 ) );
272 * FIFO management (internal) - please understand that solving race conditions
273 * is _your_ job, ie. in the audio output you should own the mixer lock
274 * before calling any of these functions.
277 /*****************************************************************************
278 * aout_FifoInit : initialize the members of a FIFO
279 *****************************************************************************/
280 void aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
283 p_fifo->p_first = NULL;
284 p_fifo->pp_last = &p_fifo->p_first;
285 aout_DateInit( &p_fifo->end_date, i_rate );
288 /*****************************************************************************
289 * aout_FifoPush : push a packet into the FIFO
290 *****************************************************************************/
291 void aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
292 aout_buffer_t * p_buffer )
294 *p_fifo->pp_last = p_buffer;
295 p_fifo->pp_last = &p_buffer->p_next;
296 *p_fifo->pp_last = NULL;
297 /* Enforce the continuity of the stream. */
298 if ( aout_DateGet( &p_fifo->end_date ) )
300 p_buffer->start_date = aout_DateGet( &p_fifo->end_date );
301 p_buffer->end_date = aout_DateIncrement( &p_fifo->end_date,
302 p_buffer->i_nb_samples );
306 aout_DateSet( &p_fifo->end_date, p_buffer->end_date );
310 /*****************************************************************************
311 * aout_FifoSet : set end_date and trash all buffers (because they aren't
313 *****************************************************************************/
314 void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
317 aout_buffer_t * p_buffer;
319 aout_DateSet( &p_fifo->end_date, date );
320 p_buffer = p_fifo->p_first;
321 while ( p_buffer != NULL )
323 aout_buffer_t * p_next = p_buffer->p_next;
324 aout_BufferFree( p_buffer );
327 p_fifo->p_first = NULL;
328 p_fifo->pp_last = &p_fifo->p_first;
331 /*****************************************************************************
332 * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
333 *****************************************************************************/
334 void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
337 aout_buffer_t * p_buffer;
339 aout_DateMove( &p_fifo->end_date, difference );
340 p_buffer = p_fifo->p_first;
341 while ( p_buffer != NULL )
343 p_buffer->start_date += difference;
344 p_buffer->end_date += difference;
345 p_buffer = p_buffer->p_next;
349 /*****************************************************************************
350 * aout_FifoNextStart : return the current end_date
351 *****************************************************************************/
352 mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
354 return aout_DateGet( &p_fifo->end_date );
357 /*****************************************************************************
358 * aout_FifoFirstDate : return the playing date of the first buffer in the
360 *****************************************************************************/
361 mtime_t aout_FifoFirstDate( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
363 return p_fifo->p_first ? p_fifo->p_first->start_date : 0;
366 /*****************************************************************************
367 * aout_FifoPop : get the next buffer out of the FIFO
368 *****************************************************************************/
369 aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
371 aout_buffer_t * p_buffer;
373 p_buffer = p_fifo->p_first;
374 if ( p_buffer == NULL ) return NULL;
375 p_fifo->p_first = p_buffer->p_next;
376 if ( p_fifo->p_first == NULL )
378 p_fifo->pp_last = &p_fifo->p_first;
384 /*****************************************************************************
385 * aout_FifoDestroy : destroy a FIFO and its buffers
386 *****************************************************************************/
387 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
389 aout_buffer_t * p_buffer;
391 p_buffer = p_fifo->p_first;
392 while ( p_buffer != NULL )
394 aout_buffer_t * p_next = p_buffer->p_next;
395 aout_BufferFree( p_buffer );
402 * Date management (internal and external)
405 /*****************************************************************************
406 * aout_DateInit : set the divider of an audio_date_t
407 *****************************************************************************/
408 void aout_DateInit( audio_date_t * p_date, uint32_t i_divider )
411 p_date->i_divider = i_divider;
412 p_date->i_remainder = 0;
415 /*****************************************************************************
416 * aout_DateSet : set the date of an audio_date_t
417 *****************************************************************************/
418 void aout_DateSet( audio_date_t * p_date, mtime_t new_date )
420 p_date->date = new_date;
421 p_date->i_remainder = 0;
424 /*****************************************************************************
425 * aout_DateMove : move forwards or backwards the date of an audio_date_t
426 *****************************************************************************/
427 void aout_DateMove( audio_date_t * p_date, mtime_t difference )
429 p_date->date += difference;
432 /*****************************************************************************
433 * aout_DateGet : get the date of an audio_date_t
434 *****************************************************************************/
435 mtime_t aout_DateGet( const audio_date_t * p_date )
440 /*****************************************************************************
441 * aout_DateIncrement : increment the date and return the result, taking
442 * into account rounding errors
443 *****************************************************************************/
444 mtime_t aout_DateIncrement( audio_date_t * p_date, uint32_t i_nb_samples )
446 mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
447 p_date->date += i_dividend / p_date->i_divider;
448 p_date->i_remainder += (int)(i_dividend % p_date->i_divider);
449 if ( p_date->i_remainder >= p_date->i_divider )
451 /* This is Bresenham algorithm. */
453 p_date->i_remainder -= p_date->i_divider;