1 /*****************************************************************************
2 * common.c : audio output management of common data structures
3 *****************************************************************************
4 * Copyright (C) 2002-2007 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 *****************************************************************************/
33 #include <vlc_common.h>
35 #include "aout_internal.h"
39 * Instances management (internal and external)
42 #define AOUT_ASSERT_FIFO_LOCKED aout_assert_fifo_locked(p_aout, p_fifo)
43 static inline void aout_assert_fifo_locked( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
49 if( p_fifo == &p_aout->output.fifo )
50 vlc_assert_locked( &p_aout->output_fifo_lock );
54 for( i = 0; i < p_aout->i_nb_inputs; i++ )
56 if( p_fifo == &p_aout->pp_inputs[i]->mixer.fifo)
58 vlc_assert_locked( &p_aout->input_fifos_lock );
62 if( i == p_aout->i_nb_inputs )
63 vlc_assert_locked( &p_aout->mixer_lock );
72 static void aout_Destructor( vlc_object_t * p_this );
74 /*****************************************************************************
75 * aout_New: initialize aout structure
76 *****************************************************************************/
77 aout_instance_t * __aout_New( vlc_object_t * p_parent )
79 aout_instance_t * p_aout;
82 /* Allocate descriptor. */
83 p_aout = vlc_object_create( p_parent, VLC_OBJECT_AOUT );
89 /* Initialize members. */
90 vlc_mutex_init( &p_aout->input_fifos_lock );
91 vlc_mutex_init( &p_aout->mixer_lock );
92 vlc_mutex_init( &p_aout->output_fifo_lock );
93 p_aout->i_nb_inputs = 0;
94 p_aout->mixer_multiplier = 1.0;
95 p_aout->p_mixer = NULL;
96 p_aout->output.b_error = 1;
97 p_aout->output.b_starving = 1;
99 var_Create( p_aout, "intf-change", VLC_VAR_BOOL );
101 var_Set( p_aout, "intf-change", val );
103 vlc_object_set_destructor( p_aout, aout_Destructor );
108 /*****************************************************************************
109 * aout_Destructor: destroy aout structure
110 *****************************************************************************/
111 static void aout_Destructor( vlc_object_t * p_this )
113 aout_instance_t * p_aout = (aout_instance_t *)p_this;
114 vlc_mutex_destroy( &p_aout->input_fifos_lock );
115 vlc_mutex_destroy( &p_aout->mixer_lock );
116 vlc_mutex_destroy( &p_aout->output_fifo_lock );
121 * Formats management (internal and external)
124 /*****************************************************************************
125 * aout_FormatNbChannels : return the number of channels
126 *****************************************************************************/
127 unsigned int aout_FormatNbChannels( const audio_sample_format_t * p_format )
129 static const uint32_t pi_channels[] =
130 { AOUT_CHAN_CENTER, AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
131 AOUT_CHAN_REARCENTER, AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
132 AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT, AOUT_CHAN_LFE };
133 unsigned int i_nb = 0, i;
135 for ( i = 0; i < sizeof(pi_channels)/sizeof(uint32_t); i++ )
137 if ( p_format->i_physical_channels & pi_channels[i] ) i_nb++;
143 /*****************************************************************************
144 * aout_BitsPerSample : get the number of bits per sample
145 *****************************************************************************/
146 unsigned int aout_BitsPerSample( vlc_fourcc_t i_format )
176 /* For these formats the caller has to indicate the parameters
182 /*****************************************************************************
183 * aout_FormatPrepare : compute the number of bytes per frame & frame length
184 *****************************************************************************/
185 void aout_FormatPrepare( audio_sample_format_t * p_format )
187 p_format->i_bitspersample = aout_BitsPerSample( p_format->i_format );
188 if( p_format->i_bitspersample > 0 )
190 p_format->i_bytes_per_frame = ( p_format->i_bitspersample / 8 )
191 * aout_FormatNbChannels( p_format );
192 p_format->i_frame_length = 1;
196 /*****************************************************************************
197 * aout_FormatPrintChannels : print a channel in a human-readable form
198 *****************************************************************************/
199 const char * aout_FormatPrintChannels( const audio_sample_format_t * p_format )
201 switch ( p_format->i_physical_channels & AOUT_CHAN_PHYSMASK )
204 case AOUT_CHAN_RIGHT:
205 case AOUT_CHAN_CENTER:
206 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
207 || (p_format->i_original_channels
208 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
210 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
213 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
214 if ( p_format->i_original_channels & AOUT_CHAN_REVERSESTEREO )
216 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
217 return "Dolby/Reverse";
218 return "Stereo/Reverse";
222 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
224 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
226 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
227 return "Stereo/Mono";
228 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
229 return "Stereo/Left";
230 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
231 return "Stereo/Right";
234 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
236 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
238 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
239 | AOUT_CHAN_REARCENTER:
241 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
242 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
244 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
245 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT:
247 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
248 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
250 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
251 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT:
254 case AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
255 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
256 || (p_format->i_original_channels
257 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
259 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
262 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE:
263 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
265 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
266 return "Dual-mono/LFE";
267 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
269 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
270 return "Stereo/Left/LFE";
271 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
272 return "Stereo/Right/LFE";
274 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
276 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER
279 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
280 | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE:
282 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
283 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
285 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
286 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE:
288 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
289 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
291 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
292 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE:
294 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
295 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
296 | AOUT_CHAN_MIDDLERIGHT:
298 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
299 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
300 | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE:
307 /*****************************************************************************
308 * aout_FormatPrint : print a format in a human-readable form
309 *****************************************************************************/
310 void aout_FormatPrint( aout_instance_t * p_aout, const char * psz_text,
311 const audio_sample_format_t * p_format )
313 msg_Dbg( p_aout, "%s '%4.4s' %d Hz %s frame=%d samples/%d bytes", psz_text,
314 (char *)&p_format->i_format, p_format->i_rate,
315 aout_FormatPrintChannels( p_format ),
316 p_format->i_frame_length, p_format->i_bytes_per_frame );
319 /*****************************************************************************
320 * aout_FormatsPrint : print two formats in a human-readable form
321 *****************************************************************************/
322 void aout_FormatsPrint( aout_instance_t * p_aout, const char * psz_text,
323 const audio_sample_format_t * p_format1,
324 const audio_sample_format_t * p_format2 )
326 msg_Dbg( p_aout, "%s '%4.4s'->'%4.4s' %d Hz->%d Hz %s->%s",
328 (char *)&p_format1->i_format, (char *)&p_format2->i_format,
329 p_format1->i_rate, p_format2->i_rate,
330 aout_FormatPrintChannels( p_format1 ),
331 aout_FormatPrintChannels( p_format2 ) );
336 * FIFO management (internal) - please understand that solving race conditions
337 * is _your_ job, ie. in the audio output you should own the mixer lock
338 * before calling any of these functions.
341 /*****************************************************************************
342 * aout_FifoInit : initialize the members of a FIFO
343 *****************************************************************************/
344 void aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
347 AOUT_ASSERT_FIFO_LOCKED;
351 msg_Err( p_aout, "initialising fifo with zero divider" );
354 p_fifo->p_first = NULL;
355 p_fifo->pp_last = &p_fifo->p_first;
356 date_Init( &p_fifo->end_date, i_rate, 1 );
359 /*****************************************************************************
360 * aout_FifoPush : push a packet into the FIFO
361 *****************************************************************************/
362 void aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
363 aout_buffer_t * p_buffer )
366 AOUT_ASSERT_FIFO_LOCKED;
368 *p_fifo->pp_last = p_buffer;
369 p_fifo->pp_last = &p_buffer->p_next;
370 *p_fifo->pp_last = NULL;
371 /* Enforce the continuity of the stream. */
372 if ( date_Get( &p_fifo->end_date ) )
374 p_buffer->start_date = date_Get( &p_fifo->end_date );
375 p_buffer->end_date = date_Increment( &p_fifo->end_date,
376 p_buffer->i_nb_samples );
380 date_Set( &p_fifo->end_date, p_buffer->end_date );
384 /*****************************************************************************
385 * aout_FifoSet : set end_date and trash all buffers (because they aren't
387 *****************************************************************************/
388 void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
391 aout_buffer_t * p_buffer;
393 AOUT_ASSERT_FIFO_LOCKED;
395 date_Set( &p_fifo->end_date, date );
396 p_buffer = p_fifo->p_first;
397 while ( p_buffer != NULL )
399 aout_buffer_t * p_next = p_buffer->p_next;
400 aout_BufferFree( p_buffer );
403 p_fifo->p_first = NULL;
404 p_fifo->pp_last = &p_fifo->p_first;
407 /*****************************************************************************
408 * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
409 *****************************************************************************/
410 void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
413 aout_buffer_t * p_buffer;
415 AOUT_ASSERT_FIFO_LOCKED;
417 date_Move( &p_fifo->end_date, difference );
418 p_buffer = p_fifo->p_first;
419 while ( p_buffer != NULL )
421 p_buffer->start_date += difference;
422 p_buffer->end_date += difference;
423 p_buffer = p_buffer->p_next;
427 /*****************************************************************************
428 * aout_FifoNextStart : return the current end_date
429 *****************************************************************************/
430 mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
433 AOUT_ASSERT_FIFO_LOCKED;
434 return date_Get( &p_fifo->end_date );
437 /*****************************************************************************
438 * aout_FifoFirstDate : return the playing date of the first buffer in the
440 *****************************************************************************/
441 mtime_t aout_FifoFirstDate( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
444 AOUT_ASSERT_FIFO_LOCKED;
445 return p_fifo->p_first ? p_fifo->p_first->start_date : 0;
448 /*****************************************************************************
449 * aout_FifoPop : get the next buffer out of the FIFO
450 *****************************************************************************/
451 aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
453 aout_buffer_t * p_buffer;
455 AOUT_ASSERT_FIFO_LOCKED;
457 p_buffer = p_fifo->p_first;
458 if ( p_buffer == NULL ) return NULL;
459 p_fifo->p_first = p_buffer->p_next;
460 if ( p_fifo->p_first == NULL )
462 p_fifo->pp_last = &p_fifo->p_first;
468 /*****************************************************************************
469 * aout_FifoDestroy : destroy a FIFO and its buffers
470 *****************************************************************************/
471 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
473 aout_buffer_t * p_buffer;
475 AOUT_ASSERT_FIFO_LOCKED;
477 p_buffer = p_fifo->p_first;
478 while ( p_buffer != NULL )
480 aout_buffer_t * p_next = p_buffer->p_next;
481 aout_BufferFree( p_buffer );
485 p_fifo->p_first = NULL;
486 p_fifo->pp_last = &p_fifo->p_first;
489 /*****************************************************************************
490 * aout_CheckChannelReorder : Check if we need to do some channel re-ordering
491 *****************************************************************************/
492 int aout_CheckChannelReorder( const uint32_t *pi_chan_order_in,
493 const uint32_t *pi_chan_order_out,
494 uint32_t i_channel_mask,
495 int i_channels, int *pi_chan_table )
497 bool b_chan_reorder = false;
500 if( i_channels > AOUT_CHAN_MAX )
503 if( pi_chan_order_in == NULL )
504 pi_chan_order_in = pi_vlc_chan_order_wg4;
505 if( pi_chan_order_out == NULL )
506 pi_chan_order_out = pi_vlc_chan_order_wg4;
508 for( i = 0, j = 0; pi_chan_order_in[i]; i++ )
510 if( !(i_channel_mask & pi_chan_order_in[i]) ) continue;
512 for( k = 0, l = 0; pi_chan_order_in[i] != pi_chan_order_out[k]; k++ )
514 if( i_channel_mask & pi_chan_order_out[k] ) l++;
517 pi_chan_table[j++] = l;
520 for( i = 0; i < i_channels; i++ )
522 if( pi_chan_table[i] != i ) b_chan_reorder = true;
525 return b_chan_reorder;
528 /*****************************************************************************
529 * aout_ChannelReorder :
530 *****************************************************************************/
531 void aout_ChannelReorder( uint8_t *p_buf, int i_buffer,
532 int i_channels, const int *pi_chan_table,
533 int i_bits_per_sample )
535 uint8_t p_tmp[AOUT_CHAN_MAX * 4];
538 if( i_bits_per_sample == 8 )
540 for( i = 0; i < i_buffer / i_channels; i++ )
542 for( j = 0; j < i_channels; j++ )
544 p_tmp[pi_chan_table[j]] = p_buf[j];
547 memcpy( p_buf, p_tmp, i_channels );
551 else if( i_bits_per_sample == 16 )
553 for( i = 0; i < i_buffer / i_channels / 2; i++ )
555 for( j = 0; j < i_channels; j++ )
557 p_tmp[2 * pi_chan_table[j]] = p_buf[2 * j];
558 p_tmp[2 * pi_chan_table[j] + 1] = p_buf[2 * j + 1];
561 memcpy( p_buf, p_tmp, 2 * i_channels );
562 p_buf += 2 * i_channels;
565 else if( i_bits_per_sample == 24 )
567 for( i = 0; i < i_buffer / i_channels / 3; i++ )
569 for( j = 0; j < i_channels; j++ )
571 p_tmp[3 * pi_chan_table[j]] = p_buf[3 * j];
572 p_tmp[3 * pi_chan_table[j] + 1] = p_buf[3 * j + 1];
573 p_tmp[3 * pi_chan_table[j] + 2] = p_buf[3 * j + 2];
576 memcpy( p_buf, p_tmp, 3 * i_channels );
577 p_buf += 3 * i_channels;
580 else if( i_bits_per_sample == 32 )
582 for( i = 0; i < i_buffer / i_channels / 4; i++ )
584 for( j = 0; j < i_channels; j++ )
586 p_tmp[4 * pi_chan_table[j]] = p_buf[4 * j];
587 p_tmp[4 * pi_chan_table[j] + 1] = p_buf[4 * j + 1];
588 p_tmp[4 * pi_chan_table[j] + 2] = p_buf[4 * j + 2];
589 p_tmp[4 * pi_chan_table[j] + 3] = p_buf[4 * j + 3];
592 memcpy( p_buf, p_tmp, 4 * i_channels );
593 p_buf += 4 * i_channels;
598 /*****************************************************************************
599 * aout_ChannelExtract:
600 *****************************************************************************/
601 static inline void ExtractChannel( uint8_t *pi_dst, int i_dst_channels,
602 const uint8_t *pi_src, int i_src_channels,
604 const int *pi_selection, int i_bytes )
606 for( int i = 0; i < i_sample_count; i++ )
608 for( int j = 0; j < i_dst_channels; j++ )
609 memcpy( &pi_dst[j * i_bytes], &pi_src[pi_selection[j] * i_bytes], i_bytes );
610 pi_dst += i_dst_channels * i_bytes;
611 pi_src += i_src_channels * i_bytes;
615 void aout_ChannelExtract( void *p_dst, int i_dst_channels,
616 const void *p_src, int i_src_channels,
617 int i_sample_count, const int *pi_selection, int i_bits_per_sample )
619 /* It does not work in place */
620 assert( p_dst != p_src );
622 /* Force the compiler to inline for the specific cases so it can optimize */
623 if( i_bits_per_sample == 8 )
624 ExtractChannel( p_dst, i_dst_channels, p_src, i_src_channels, i_sample_count, pi_selection, 1 );
625 else if( i_bits_per_sample == 16 )
626 ExtractChannel( p_dst, i_dst_channels, p_src, i_src_channels, i_sample_count, pi_selection, 2 );
627 else if( i_bits_per_sample == 24 )
628 ExtractChannel( p_dst, i_dst_channels, p_src, i_src_channels, i_sample_count, pi_selection, 3 );
629 else if( i_bits_per_sample == 32 )
630 ExtractChannel( p_dst, i_dst_channels, p_src, i_src_channels, i_sample_count, pi_selection, 4 );
631 else if( i_bits_per_sample == 64 )
632 ExtractChannel( p_dst, i_dst_channels, p_src, i_src_channels, i_sample_count, pi_selection, 8 );
635 bool aout_CheckChannelExtraction( int *pi_selection,
636 uint32_t *pi_layout, int *pi_channels,
637 const uint32_t pi_order_dst[AOUT_CHAN_MAX],
638 const uint32_t *pi_order_src, int i_channels )
640 const uint32_t pi_order_dual_mono[] = { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT };
641 uint32_t i_layout = 0;
643 int pi_index[AOUT_CHAN_MAX];
647 pi_order_dst = pi_vlc_chan_order_wg4;
649 /* Detect special dual mono case */
650 if( i_channels == 2 &&
651 pi_order_src[0] == AOUT_CHAN_CENTER && pi_order_src[1] == AOUT_CHAN_CENTER )
653 i_layout |= AOUT_CHAN_DUALMONO;
654 pi_order_src = pi_order_dual_mono;
658 for( int i = 0; i < i_channels; i++ )
660 /* Ignore unknown or duplicated channels or not present in output */
661 if( !pi_order_src[i] || (i_layout & pi_order_src[i]) )
664 for( int j = 0; j < AOUT_CHAN_MAX; j++ )
666 if( pi_order_dst[j] == pi_order_src[i] )
668 assert( i_out < AOUT_CHAN_MAX );
669 pi_index[i_out++] = i;
670 i_layout |= pi_order_src[i];
677 for( int i = 0, j = 0; i < AOUT_CHAN_MAX; i++ )
679 for( int k = 0; k < i_out; k++ )
681 if( pi_order_dst[i] == pi_order_src[pi_index[k]] )
683 pi_selection[j++] = pi_index[k];
689 *pi_layout = i_layout;
690 *pi_channels = i_out;
692 for( int i = 0; i < i_out; i++ )
694 if( pi_selection[i] != i )
697 return i_out == i_channels;
700 /*****************************************************************************
702 *****************************************************************************/
704 aout_buffer_t *aout_BufferAlloc(aout_alloc_t *allocation, mtime_t microseconds,
705 aout_buffer_t *old_buffer)
707 if ( !allocation->b_alloc )
712 aout_buffer_t *buffer;
715 i_alloc_size = (int)( (uint64_t)allocation->i_bytes_per_sec
716 * (microseconds) / 1000000 + 1 );
718 buffer = malloc( i_alloc_size + sizeof(aout_buffer_t) );
722 buffer->b_alloc = true;
723 buffer->i_size = i_alloc_size;
724 buffer->p_buffer = (uint8_t *)buffer + sizeof(aout_buffer_t);
725 buffer->b_discontinuity = false;
729 buffer->start_date = old_buffer->start_date;
730 buffer->end_date = old_buffer->end_date;