1 /*****************************************************************************
2 * common.c : audio output management of common data structures
3 *****************************************************************************
4 * Copyright (C) 2002-2005 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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 );
72 /*****************************************************************************
73 * aout_Delete: destroy aout structure
74 *****************************************************************************/
75 void aout_Delete( aout_instance_t * p_aout )
77 var_Destroy( p_aout, "intf-change" );
79 vlc_mutex_destroy( &p_aout->input_fifos_lock );
80 vlc_mutex_destroy( &p_aout->mixer_lock );
81 vlc_mutex_destroy( &p_aout->output_fifo_lock );
84 vlc_object_destroy( p_aout );
89 * Formats management (internal and external)
92 /*****************************************************************************
93 * aout_FormatNbChannels : return the number of channels
94 *****************************************************************************/
95 unsigned int aout_FormatNbChannels( const audio_sample_format_t * p_format )
97 static const uint32_t pi_channels[] =
98 { AOUT_CHAN_CENTER, AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
99 AOUT_CHAN_REARCENTER, AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
100 AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT, AOUT_CHAN_LFE };
101 unsigned int i_nb = 0, i;
103 for ( i = 0; i < sizeof(pi_channels)/sizeof(uint32_t); i++ )
105 if ( p_format->i_physical_channels & pi_channels[i] ) i_nb++;
111 /*****************************************************************************
112 * aout_FormatPrepare : compute the number of bytes per frame & frame length
113 *****************************************************************************/
114 void aout_FormatPrepare( audio_sample_format_t * p_format )
118 switch ( p_format->i_format )
120 case VLC_FOURCC('u','8',' ',' '):
121 case VLC_FOURCC('s','8',' ',' '):
125 case VLC_FOURCC('u','1','6','l'):
126 case VLC_FOURCC('s','1','6','l'):
127 case VLC_FOURCC('u','1','6','b'):
128 case VLC_FOURCC('s','1','6','b'):
132 case VLC_FOURCC('u','2','4','l'):
133 case VLC_FOURCC('s','2','4','l'):
134 case VLC_FOURCC('u','2','4','b'):
135 case VLC_FOURCC('s','2','4','b'):
139 case VLC_FOURCC('f','l','3','2'):
140 case VLC_FOURCC('f','i','3','2'):
144 case VLC_FOURCC('s','p','d','i'):
145 case VLC_FOURCC('s','p','d','b'): /* Big endian spdif output */
146 case VLC_FOURCC('a','5','2',' '):
147 case VLC_FOURCC('d','t','s',' '):
148 case VLC_FOURCC('m','p','g','a'):
149 case VLC_FOURCC('m','p','g','3'):
151 /* For these formats the caller has to indicate the parameters
156 p_format->i_bytes_per_frame = i_result * aout_FormatNbChannels( p_format );
157 p_format->i_frame_length = 1;
160 /*****************************************************************************
161 * aout_FormatPrintChannels : print a channel in a human-readable form
162 *****************************************************************************/
163 const char * aout_FormatPrintChannels( const audio_sample_format_t * p_format )
165 switch ( p_format->i_physical_channels & AOUT_CHAN_PHYSMASK )
167 case AOUT_CHAN_CENTER:
168 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
169 || (p_format->i_original_channels
170 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
172 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
175 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
176 if ( p_format->i_original_channels & AOUT_CHAN_REVERSESTEREO )
178 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
179 return "Dolby/Reverse";
180 return "Stereo/Reverse";
184 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
186 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
188 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
189 return "Stereo/Mono";
190 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
191 return "Stereo/Left";
192 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
193 return "Stereo/Right";
196 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
198 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
200 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
201 | AOUT_CHAN_REARCENTER:
203 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
204 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
206 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
207 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
210 case AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
211 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
212 || (p_format->i_original_channels
213 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
215 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
218 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE:
219 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
221 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
222 return "Dual-mono/LFE";
223 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
225 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
226 return "Stereo/Left/LFE";
227 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
228 return "Stereo/Right/LFE";
230 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
232 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER
235 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
236 | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE:
238 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
239 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
241 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
242 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
244 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
245 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
246 | AOUT_CHAN_MIDDLERIGHT:
248 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
249 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
250 | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE:
257 /*****************************************************************************
258 * aout_FormatPrint : print a format in a human-readable form
259 *****************************************************************************/
260 void aout_FormatPrint( aout_instance_t * p_aout, const char * psz_text,
261 const audio_sample_format_t * p_format )
263 msg_Dbg( p_aout, "%s '%4.4s' %d Hz %s frame=%d samples/%d bytes", psz_text,
264 (char *)&p_format->i_format, p_format->i_rate,
265 aout_FormatPrintChannels( p_format ),
266 p_format->i_frame_length, p_format->i_bytes_per_frame );
269 /*****************************************************************************
270 * aout_FormatsPrint : print two formats in a human-readable form
271 *****************************************************************************/
272 void aout_FormatsPrint( aout_instance_t * p_aout, const char * psz_text,
273 const audio_sample_format_t * p_format1,
274 const audio_sample_format_t * p_format2 )
276 msg_Dbg( p_aout, "%s '%4.4s'->'%4.4s' %d Hz->%d Hz %s->%s",
278 (char *)&p_format1->i_format, (char *)&p_format2->i_format,
279 p_format1->i_rate, p_format2->i_rate,
280 aout_FormatPrintChannels( p_format1 ),
281 aout_FormatPrintChannels( p_format2 ) );
286 * FIFO management (internal) - please understand that solving race conditions
287 * is _your_ job, ie. in the audio output you should own the mixer lock
288 * before calling any of these functions.
291 /*****************************************************************************
292 * aout_FifoInit : initialize the members of a FIFO
293 *****************************************************************************/
294 void aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
299 msg_Err( p_aout, "initialising fifo with zero divider" );
302 p_fifo->p_first = NULL;
303 p_fifo->pp_last = &p_fifo->p_first;
304 aout_DateInit( &p_fifo->end_date, i_rate );
307 /*****************************************************************************
308 * aout_FifoPush : push a packet into the FIFO
309 *****************************************************************************/
310 void aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
311 aout_buffer_t * p_buffer )
313 *p_fifo->pp_last = p_buffer;
314 p_fifo->pp_last = &p_buffer->p_next;
315 *p_fifo->pp_last = NULL;
316 /* Enforce the continuity of the stream. */
317 if ( aout_DateGet( &p_fifo->end_date ) )
319 p_buffer->start_date = aout_DateGet( &p_fifo->end_date );
320 p_buffer->end_date = aout_DateIncrement( &p_fifo->end_date,
321 p_buffer->i_nb_samples );
325 aout_DateSet( &p_fifo->end_date, p_buffer->end_date );
329 /*****************************************************************************
330 * aout_FifoSet : set end_date and trash all buffers (because they aren't
332 *****************************************************************************/
333 void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
336 aout_buffer_t * p_buffer;
338 aout_DateSet( &p_fifo->end_date, date );
339 p_buffer = p_fifo->p_first;
340 while ( p_buffer != NULL )
342 aout_buffer_t * p_next = p_buffer->p_next;
343 aout_BufferFree( p_buffer );
346 p_fifo->p_first = NULL;
347 p_fifo->pp_last = &p_fifo->p_first;
350 /*****************************************************************************
351 * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
352 *****************************************************************************/
353 void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
356 aout_buffer_t * p_buffer;
358 aout_DateMove( &p_fifo->end_date, difference );
359 p_buffer = p_fifo->p_first;
360 while ( p_buffer != NULL )
362 p_buffer->start_date += difference;
363 p_buffer->end_date += difference;
364 p_buffer = p_buffer->p_next;
368 /*****************************************************************************
369 * aout_FifoNextStart : return the current end_date
370 *****************************************************************************/
371 mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
373 return aout_DateGet( &p_fifo->end_date );
376 /*****************************************************************************
377 * aout_FifoFirstDate : return the playing date of the first buffer in the
379 *****************************************************************************/
380 mtime_t aout_FifoFirstDate( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
382 return p_fifo->p_first ? p_fifo->p_first->start_date : 0;
385 /*****************************************************************************
386 * aout_FifoPop : get the next buffer out of the FIFO
387 *****************************************************************************/
388 aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
390 aout_buffer_t * p_buffer;
392 p_buffer = p_fifo->p_first;
393 if ( p_buffer == NULL ) return NULL;
394 p_fifo->p_first = p_buffer->p_next;
395 if ( p_fifo->p_first == NULL )
397 p_fifo->pp_last = &p_fifo->p_first;
403 /*****************************************************************************
404 * aout_FifoDestroy : destroy a FIFO and its buffers
405 *****************************************************************************/
406 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
408 aout_buffer_t * p_buffer;
410 p_buffer = p_fifo->p_first;
411 while ( p_buffer != NULL )
413 aout_buffer_t * p_next = p_buffer->p_next;
414 aout_BufferFree( p_buffer );
418 p_fifo->p_first = NULL;
419 p_fifo->pp_last = &p_fifo->p_first;
424 * Date management (internal and external)
427 /*****************************************************************************
428 * aout_DateInit : set the divider of an audio_date_t
429 *****************************************************************************/
430 void aout_DateInit( audio_date_t * p_date, uint32_t i_divider )
433 p_date->i_divider = i_divider;
434 p_date->i_remainder = 0;
437 /*****************************************************************************
438 * aout_DateSet : set the date of an audio_date_t
439 *****************************************************************************/
440 void aout_DateSet( audio_date_t * p_date, mtime_t new_date )
442 p_date->date = new_date;
443 p_date->i_remainder = 0;
446 /*****************************************************************************
447 * aout_DateMove : move forwards or backwards the date of an audio_date_t
448 *****************************************************************************/
449 void aout_DateMove( audio_date_t * p_date, mtime_t difference )
451 p_date->date += difference;
454 /*****************************************************************************
455 * aout_DateGet : get the date of an audio_date_t
456 *****************************************************************************/
457 mtime_t aout_DateGet( const audio_date_t * p_date )
462 /*****************************************************************************
463 * aout_DateIncrement : increment the date and return the result, taking
464 * into account rounding errors
465 *****************************************************************************/
466 mtime_t aout_DateIncrement( audio_date_t * p_date, uint32_t i_nb_samples )
468 mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
469 p_date->date += i_dividend / p_date->i_divider;
470 p_date->i_remainder += (int)(i_dividend % p_date->i_divider);
471 if ( p_date->i_remainder >= p_date->i_divider )
473 /* This is Bresenham algorithm. */
475 p_date->i_remainder -= p_date->i_divider;
480 /*****************************************************************************
481 * aout_CheckChannelReorder : Check if we need to do some channel re-ordering
482 *****************************************************************************/
483 int aout_CheckChannelReorder( const uint32_t *pi_chan_order_in,
484 const uint32_t *pi_chan_order_out,
485 uint32_t i_channel_mask,
486 int i_channels, int *pi_chan_table )
488 vlc_bool_t b_chan_reorder = VLC_FALSE;
491 if( i_channels > AOUT_CHAN_MAX ) return VLC_FALSE;
493 for( i = 0, j = 0; pi_chan_order_in[i]; i++ )
495 if( !(i_channel_mask & pi_chan_order_in[i]) ) continue;
497 for( k = 0, l = 0; pi_chan_order_in[i] != pi_chan_order_out[k]; k++ )
499 if( i_channel_mask & pi_chan_order_out[k] ) l++;
502 pi_chan_table[j++] = l;
505 for( i = 0; i < i_channels; i++ )
507 if( pi_chan_table[i] != i ) b_chan_reorder = VLC_TRUE;
510 return b_chan_reorder;
513 /*****************************************************************************
514 * aout_ChannelReorder :
515 *****************************************************************************/
516 void aout_ChannelReorder( uint8_t *p_buf, int i_buffer,
517 int i_channels, const int *pi_chan_table,
518 int i_bits_per_sample )
520 uint8_t p_tmp[AOUT_CHAN_MAX * 4];
523 if( i_bits_per_sample == 8 )
525 for( i = 0; i < i_buffer / i_channels; i++ )
527 for( j = 0; j < i_channels; j++ )
529 p_tmp[pi_chan_table[j]] = p_buf[j];
532 memcpy( p_buf, p_tmp, i_channels );
536 else if( i_bits_per_sample == 16 )
538 for( i = 0; i < i_buffer / i_channels / 2; i++ )
540 for( j = 0; j < i_channels; j++ )
542 p_tmp[2 * pi_chan_table[j]] = p_buf[2 * j];
543 p_tmp[2 * pi_chan_table[j] + 1] = p_buf[2 * j + 1];
546 memcpy( p_buf, p_tmp, 2 * i_channels );
547 p_buf += 2 * i_channels;
550 else if( i_bits_per_sample == 24 )
552 for( i = 0; i < i_buffer / i_channels / 3; i++ )
554 for( j = 0; j < i_channels; j++ )
556 p_tmp[3 * pi_chan_table[j]] = p_buf[3 * j];
557 p_tmp[3 * pi_chan_table[j] + 1] = p_buf[3 * j + 1];
558 p_tmp[3 * pi_chan_table[j] + 2] = p_buf[3 * j + 2];
561 memcpy( p_buf, p_tmp, 3 * i_channels );
562 p_buf += 3 * i_channels;
565 else if( i_bits_per_sample == 32 )
567 for( i = 0; i < i_buffer / i_channels / 4; i++ )
569 for( j = 0; j < i_channels; j++ )
571 p_tmp[4 * pi_chan_table[j]] = p_buf[4 * j];
572 p_tmp[4 * pi_chan_table[j] + 1] = p_buf[4 * j + 1];
573 p_tmp[4 * pi_chan_table[j] + 2] = p_buf[4 * j + 2];
574 p_tmp[4 * pi_chan_table[j] + 3] = p_buf[4 * j + 3];
577 memcpy( p_buf, p_tmp, 4 * i_channels );
578 p_buf += 4 * i_channels;