1 /*****************************************************************************
2 * common.c : audio output management of common data structures
3 *****************************************************************************
4 * Copyright (C) 2002-2004 VideoLAN
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 );
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('f','l','3','2'):
133 case VLC_FOURCC('f','i','3','2'):
137 case VLC_FOURCC('s','p','d','i'):
138 case VLC_FOURCC('a','5','2',' '):
139 case VLC_FOURCC('d','t','s',' '):
140 case VLC_FOURCC('m','p','g','a'):
141 case VLC_FOURCC('m','p','g','3'):
143 /* For these formats the caller has to indicate the parameters
148 p_format->i_bytes_per_frame = i_result * aout_FormatNbChannels( p_format );
149 p_format->i_frame_length = 1;
152 /*****************************************************************************
153 * aout_FormatPrintChannels : print a channel in a human-readable form
154 *****************************************************************************/
155 const char * aout_FormatPrintChannels( const audio_sample_format_t * p_format )
157 switch ( p_format->i_physical_channels & AOUT_CHAN_PHYSMASK )
159 case AOUT_CHAN_CENTER:
160 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
161 || (p_format->i_original_channels
162 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
164 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
167 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
168 if ( p_format->i_original_channels & AOUT_CHAN_REVERSESTEREO )
170 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
171 return "Dolby/Reverse";
172 return "Stereo/Reverse";
176 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
178 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
180 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
181 return "Stereo/Mono";
182 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
183 return "Stereo/Left";
184 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
185 return "Stereo/Right";
188 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
190 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
192 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
193 | AOUT_CHAN_REARCENTER:
195 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
196 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
198 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
199 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
202 case AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
203 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
204 || (p_format->i_original_channels
205 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
207 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
210 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE:
211 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
213 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
214 return "Dual-mono/LFE";
215 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
217 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
218 return "Stereo/Left/LFE";
219 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
220 return "Stereo/Right/LFE";
222 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
224 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER
227 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
228 | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE:
230 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
231 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
233 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
234 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
236 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
237 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
238 | AOUT_CHAN_MIDDLERIGHT:
240 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
241 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
242 | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE:
249 /*****************************************************************************
250 * aout_FormatPrint : print a format in a human-readable form
251 *****************************************************************************/
252 void aout_FormatPrint( aout_instance_t * p_aout, const char * psz_text,
253 const audio_sample_format_t * p_format )
255 msg_Dbg( p_aout, "%s '%4.4s' %d Hz %s frame=%d samples/%d bytes", psz_text,
256 (char *)&p_format->i_format, p_format->i_rate,
257 aout_FormatPrintChannels( p_format ),
258 p_format->i_frame_length, p_format->i_bytes_per_frame );
261 /*****************************************************************************
262 * aout_FormatsPrint : print two formats in a human-readable form
263 *****************************************************************************/
264 void aout_FormatsPrint( aout_instance_t * p_aout, const char * psz_text,
265 const audio_sample_format_t * p_format1,
266 const audio_sample_format_t * p_format2 )
268 msg_Dbg( p_aout, "%s '%4.4s'->'%4.4s' %d Hz->%d Hz %s->%s",
270 (char *)&p_format1->i_format, (char *)&p_format2->i_format,
271 p_format1->i_rate, p_format2->i_rate,
272 aout_FormatPrintChannels( p_format1 ),
273 aout_FormatPrintChannels( p_format2 ) );
278 * FIFO management (internal) - please understand that solving race conditions
279 * is _your_ job, ie. in the audio output you should own the mixer lock
280 * before calling any of these functions.
283 /*****************************************************************************
284 * aout_FifoInit : initialize the members of a FIFO
285 *****************************************************************************/
286 void aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
289 p_fifo->p_first = NULL;
290 p_fifo->pp_last = &p_fifo->p_first;
291 aout_DateInit( &p_fifo->end_date, i_rate );
294 /*****************************************************************************
295 * aout_FifoPush : push a packet into the FIFO
296 *****************************************************************************/
297 void aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
298 aout_buffer_t * p_buffer )
300 *p_fifo->pp_last = p_buffer;
301 p_fifo->pp_last = &p_buffer->p_next;
302 *p_fifo->pp_last = NULL;
303 /* Enforce the continuity of the stream. */
304 if ( aout_DateGet( &p_fifo->end_date ) )
306 p_buffer->start_date = aout_DateGet( &p_fifo->end_date );
307 p_buffer->end_date = aout_DateIncrement( &p_fifo->end_date,
308 p_buffer->i_nb_samples );
312 aout_DateSet( &p_fifo->end_date, p_buffer->end_date );
316 /*****************************************************************************
317 * aout_FifoSet : set end_date and trash all buffers (because they aren't
319 *****************************************************************************/
320 void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
323 aout_buffer_t * p_buffer;
325 aout_DateSet( &p_fifo->end_date, date );
326 p_buffer = p_fifo->p_first;
327 while ( p_buffer != NULL )
329 aout_buffer_t * p_next = p_buffer->p_next;
330 aout_BufferFree( p_buffer );
333 p_fifo->p_first = NULL;
334 p_fifo->pp_last = &p_fifo->p_first;
337 /*****************************************************************************
338 * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
339 *****************************************************************************/
340 void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
343 aout_buffer_t * p_buffer;
345 aout_DateMove( &p_fifo->end_date, difference );
346 p_buffer = p_fifo->p_first;
347 while ( p_buffer != NULL )
349 p_buffer->start_date += difference;
350 p_buffer->end_date += difference;
351 p_buffer = p_buffer->p_next;
355 /*****************************************************************************
356 * aout_FifoNextStart : return the current end_date
357 *****************************************************************************/
358 mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
360 return aout_DateGet( &p_fifo->end_date );
363 /*****************************************************************************
364 * aout_FifoFirstDate : return the playing date of the first buffer in the
366 *****************************************************************************/
367 mtime_t aout_FifoFirstDate( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
369 return p_fifo->p_first ? p_fifo->p_first->start_date : 0;
372 /*****************************************************************************
373 * aout_FifoPop : get the next buffer out of the FIFO
374 *****************************************************************************/
375 aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
377 aout_buffer_t * p_buffer;
379 p_buffer = p_fifo->p_first;
380 if ( p_buffer == NULL ) return NULL;
381 p_fifo->p_first = p_buffer->p_next;
382 if ( p_fifo->p_first == NULL )
384 p_fifo->pp_last = &p_fifo->p_first;
390 /*****************************************************************************
391 * aout_FifoDestroy : destroy a FIFO and its buffers
392 *****************************************************************************/
393 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
395 aout_buffer_t * p_buffer;
397 p_buffer = p_fifo->p_first;
398 while ( p_buffer != NULL )
400 aout_buffer_t * p_next = p_buffer->p_next;
401 aout_BufferFree( p_buffer );
405 p_fifo->p_first = NULL;
406 p_fifo->pp_last = &p_fifo->p_first;
411 * Date management (internal and external)
414 /*****************************************************************************
415 * aout_DateInit : set the divider of an audio_date_t
416 *****************************************************************************/
417 void aout_DateInit( audio_date_t * p_date, uint32_t i_divider )
420 p_date->i_divider = i_divider;
421 p_date->i_remainder = 0;
424 /*****************************************************************************
425 * aout_DateSet : set the date of an audio_date_t
426 *****************************************************************************/
427 void aout_DateSet( audio_date_t * p_date, mtime_t new_date )
429 p_date->date = new_date;
430 p_date->i_remainder = 0;
433 /*****************************************************************************
434 * aout_DateMove : move forwards or backwards the date of an audio_date_t
435 *****************************************************************************/
436 void aout_DateMove( audio_date_t * p_date, mtime_t difference )
438 p_date->date += difference;
441 /*****************************************************************************
442 * aout_DateGet : get the date of an audio_date_t
443 *****************************************************************************/
444 mtime_t aout_DateGet( const audio_date_t * p_date )
449 /*****************************************************************************
450 * aout_DateIncrement : increment the date and return the result, taking
451 * into account rounding errors
452 *****************************************************************************/
453 mtime_t aout_DateIncrement( audio_date_t * p_date, uint32_t i_nb_samples )
455 mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
456 p_date->date += i_dividend / p_date->i_divider;
457 p_date->i_remainder += (int)(i_dividend % p_date->i_divider);
458 if ( p_date->i_remainder >= p_date->i_divider )
460 /* This is Bresenham algorithm. */
462 p_date->i_remainder -= p_date->i_divider;
467 /*****************************************************************************
468 * aout_CheckChannelReorder : Check if we need to do some channel re-ordering
469 *****************************************************************************/
470 int aout_CheckChannelReorder( const uint32_t *pi_chan_order_in,
471 const uint32_t *pi_chan_order_out,
472 uint32_t i_channel_mask,
473 int i_channels, int *pi_chan_table )
475 vlc_bool_t b_chan_reorder = VLC_FALSE;
478 if( i_channels > AOUT_CHAN_MAX ) return VLC_FALSE;
480 for( i = 0, j = 0; pi_chan_order_in[i]; i++ )
482 if( !(i_channel_mask & pi_chan_order_in[i]) ) continue;
484 for( k = 0, l = 0; pi_chan_order_in[i] != pi_chan_order_out[k]; k++ )
486 if( i_channel_mask & pi_chan_order_out[k] ) l++;
489 pi_chan_table[j++] = l;
492 for( i = 0; i < i_channels; i++ )
494 if( pi_chan_table[i] != i ) b_chan_reorder = VLC_TRUE;
497 return b_chan_reorder;
500 /*****************************************************************************
501 * aout_ChannelReorder :
502 *****************************************************************************/
503 void aout_ChannelReorder( uint8_t *p_buf, int i_buffer,
504 int i_channels, const int *pi_chan_table,
505 int i_bits_per_sample )
507 uint8_t p_tmp[AOUT_CHAN_MAX * 4];
510 if( i_bits_per_sample == 8 )
512 for( i = 0; i < i_buffer / i_channels; i++ )
514 for( j = 0; j < i_channels; j++ )
516 p_tmp[pi_chan_table[j]] = p_buf[j];
519 memcpy( p_buf, p_tmp, i_channels );
523 else if( i_bits_per_sample == 16 )
525 for( i = 0; i < i_buffer / i_channels / 2; i++ )
527 for( j = 0; j < i_channels; j++ )
529 p_tmp[2 * pi_chan_table[j]] = p_buf[2 * j];
530 p_tmp[2 * pi_chan_table[j] + 1] = p_buf[2 * j + 1];
533 memcpy( p_buf, p_tmp, 2 * i_channels );
534 p_buf += 2 * i_channels;
537 else if( i_bits_per_sample == 24 )
539 for( i = 0; i < i_buffer / i_channels / 3; i++ )
541 for( j = 0; j < i_channels; j++ )
543 p_tmp[3 * pi_chan_table[j]] = p_buf[3 * j];
544 p_tmp[3 * pi_chan_table[j] + 1] = p_buf[3 * j + 1];
545 p_tmp[3 * pi_chan_table[j] + 2] = p_buf[3 * j + 2];
548 memcpy( p_buf, p_tmp, 3 * i_channels );
549 p_buf += 3 * i_channels;
552 else if( i_bits_per_sample == 32 )
554 for( i = 0; i < i_buffer / i_channels / 4; i++ )
556 for( j = 0; j < i_channels; j++ )
558 p_tmp[4 * pi_chan_table[j]] = p_buf[4 * j];
559 p_tmp[4 * pi_chan_table[j] + 1] = p_buf[4 * j + 1];
560 p_tmp[4 * pi_chan_table[j] + 2] = p_buf[4 * j + 2];
561 p_tmp[4 * pi_chan_table[j] + 3] = p_buf[4 * j + 3];
564 memcpy( p_buf, p_tmp, 4 * i_channels );
565 p_buf += 4 * i_channels;