1 /*****************************************************************************
2 * common.c : audio output management of common data structures
3 *****************************************************************************
4 * Copyright (C) 2002-2007 VLC authors and VideoLAN
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
31 #include <vlc_common.h>
33 #include "aout_internal.h"
36 * Formats management (internal and external)
39 /*****************************************************************************
40 * aout_BitsPerSample : get the number of bits per sample
41 *****************************************************************************/
42 unsigned int aout_BitsPerSample( vlc_fourcc_t i_format )
44 switch( vlc_fourcc_GetCodec( AUDIO_ES, i_format ) )
64 case VLC_CODEC_S24L32:
65 case VLC_CODEC_S24B32:
79 /* For these formats the caller has to indicate the parameters
85 /*****************************************************************************
86 * aout_FormatPrepare : compute the number of bytes per frame & frame length
87 *****************************************************************************/
88 void aout_FormatPrepare( audio_sample_format_t * p_format )
90 p_format->i_channels = aout_FormatNbChannels( p_format );
91 p_format->i_bitspersample = aout_BitsPerSample( p_format->i_format );
92 if( p_format->i_bitspersample > 0 )
94 p_format->i_bytes_per_frame = ( p_format->i_bitspersample / 8 )
95 * aout_FormatNbChannels( p_format );
96 p_format->i_frame_length = 1;
100 /*****************************************************************************
101 * aout_FormatPrintChannels : print a channel in a human-readable form
102 *****************************************************************************/
103 const char * aout_FormatPrintChannels( const audio_sample_format_t * p_format )
105 switch ( p_format->i_physical_channels )
108 case AOUT_CHAN_RIGHT:
109 case AOUT_CHAN_CENTER:
110 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
111 || (p_format->i_original_channels
112 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
114 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
117 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
118 if ( p_format->i_original_channels & AOUT_CHAN_REVERSESTEREO )
120 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
121 return "Dolby/Reverse";
122 return "Stereo/Reverse";
126 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
128 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
130 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
131 return "Stereo/Mono";
132 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
133 return "Stereo/Left";
134 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
135 return "Stereo/Right";
138 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
140 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
142 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
143 | AOUT_CHAN_REARCENTER:
145 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
146 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
148 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
149 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT:
151 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
152 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
154 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
155 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT:
158 case AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
159 if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
160 || (p_format->i_original_channels
161 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
163 else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
166 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE:
167 if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
169 else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
170 return "Dual-mono/LFE";
171 else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
173 else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
174 return "Stereo/Left/LFE";
175 else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
176 return "Stereo/Right/LFE";
178 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
180 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER
183 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
184 | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE:
186 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
187 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
189 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
190 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE:
192 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
193 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
195 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
196 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE:
198 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
199 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
200 | AOUT_CHAN_MIDDLERIGHT:
202 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
203 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
204 | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE:
206 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
207 | AOUT_CHAN_REARCENTER | AOUT_CHAN_MIDDLELEFT
208 | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE:
215 #undef aout_FormatPrint
217 * Prints an audio sample format in a human-readable form.
219 void aout_FormatPrint( vlc_object_t *obj, const char *psz_text,
220 const audio_sample_format_t *p_format )
222 msg_Dbg( obj, "%s '%4.4s' %d Hz %s frame=%d samples/%d bytes", psz_text,
223 (char *)&p_format->i_format, p_format->i_rate,
224 aout_FormatPrintChannels( p_format ),
225 p_format->i_frame_length, p_format->i_bytes_per_frame );
228 #undef aout_FormatsPrint
230 * Prints two formats in a human-readable form
232 void aout_FormatsPrint( vlc_object_t *obj, const char * psz_text,
233 const audio_sample_format_t * p_format1,
234 const audio_sample_format_t * p_format2 )
236 msg_Dbg( obj, "%s '%4.4s'->'%4.4s' %d Hz->%d Hz %s->%s",
238 (char *)&p_format1->i_format, (char *)&p_format2->i_format,
239 p_format1->i_rate, p_format2->i_rate,
240 aout_FormatPrintChannels( p_format1 ),
241 aout_FormatPrintChannels( p_format2 ) );
244 /*****************************************************************************
245 * aout_CheckChannelReorder : Check if we need to do some channel re-ordering
246 *****************************************************************************/
247 unsigned aout_CheckChannelReorder( const uint32_t *chans_in,
248 const uint32_t *chans_out,
249 uint32_t mask, uint8_t *restrict table )
251 unsigned channels = 0;
253 if( chans_in == NULL )
254 chans_in = pi_vlc_chan_order_wg4;
255 if( chans_out == NULL )
256 chans_out = pi_vlc_chan_order_wg4;
258 for( unsigned i = 0; chans_in[i]; i++ )
260 const uint32_t chan = chans_in[i];
265 for( unsigned j = 0; chan != chans_out[j]; j++ )
266 if( mask & chans_out[j] )
269 table[channels++] = index;
272 for( unsigned i = 0; i < channels; i++ )
279 * Reorders audio samples within a block of linear audio interleaved samples.
280 * \param ptr start address of the block of samples
281 * \param bytes size of the block in bytes (must be a multiple of the product of the
282 * channels count and the sample size)
283 * \param channels channels count (also length of the chans_table table)
284 * \param chans_table permutation table to reorder the channels
285 * (usually computed by aout_CheckChannelReorder())
286 * \param fourcc sample format (must be a linear sample format)
287 * \note The samples must be naturally aligned in memory.
289 void aout_ChannelReorder( void *ptr, size_t bytes, unsigned channels,
290 const uint8_t *restrict chans_table, vlc_fourcc_t fourcc )
292 assert( channels != 0 );
293 assert( channels <= AOUT_CHAN_MAX );
295 /* The audio formats supported in audio output are inlined. For other formats (used in
296 * demuxers and muxers), memcpy() is used to avoid breaking type punning. */
301 const size_t frames = (bytes / 4) / channels;
304 for( size_t i = 0; i < frames; i++ )
306 float tmp[AOUT_CHAN_MAX];
308 for( size_t j = 0; j < channels; j++ )
309 tmp[chans_table[j]] = buf[j];
310 memcpy( buf, tmp, 4 * channels );
318 const size_t frames = (bytes / 2) / channels;
321 for( size_t i = 0; i < frames; i++ )
323 int16_t tmp[AOUT_CHAN_MAX];
325 for( size_t j = 0; j < channels; j++ )
326 tmp[chans_table[j]] = buf[j];
327 memcpy( buf, tmp, 2 * channels );
335 const size_t frames = (bytes / 8) / channels;
338 for( size_t i = 0; i < frames; i++ )
340 double tmp[AOUT_CHAN_MAX];
342 for( size_t j = 0; j < channels; j++ )
343 tmp[chans_table[j]] = buf[j];
344 memcpy( buf, tmp, 8 * channels );
352 const size_t frames = (bytes / 4) / channels;
355 for( size_t i = 0; i < frames; i++ )
357 int32_t tmp[AOUT_CHAN_MAX];
359 for( size_t j = 0; j < channels; j++ )
360 tmp[chans_table[j]] = buf[j];
361 memcpy( buf, tmp, 4 * channels );
369 const size_t frames = bytes / channels;
372 for( size_t i = 0; i < frames; i++ )
374 uint8_t tmp[AOUT_CHAN_MAX];
376 for( size_t j = 0; j < channels; j++ )
377 tmp[chans_table[j]] = buf[j];
378 memcpy( buf, tmp, channels );
386 unsigned size = aout_BitsPerSample( fourcc ) / 8;
387 const size_t frames = bytes / size;
388 unsigned char *buf = ptr;
390 assert( bytes != 0 );
391 for( size_t i = 0; i < frames; i++ )
393 unsigned char tmp[AOUT_CHAN_MAX * bytes];
395 for( size_t j = 0; j < channels; j++ )
396 memcpy( tmp + size * chans_table[j], buf + size * j, size );
397 memcpy( buf, tmp, size * channels );
398 buf += size * channels;
405 /*****************************************************************************
406 * aout_ChannelExtract:
407 *****************************************************************************/
408 static inline void ExtractChannel( uint8_t *pi_dst, int i_dst_channels,
409 const uint8_t *pi_src, int i_src_channels,
411 const int *pi_selection, int i_bytes )
413 for( int i = 0; i < i_sample_count; i++ )
415 for( int j = 0; j < i_dst_channels; j++ )
416 memcpy( &pi_dst[j * i_bytes], &pi_src[pi_selection[j] * i_bytes], i_bytes );
417 pi_dst += i_dst_channels * i_bytes;
418 pi_src += i_src_channels * i_bytes;
422 void aout_ChannelExtract( void *p_dst, int i_dst_channels,
423 const void *p_src, int i_src_channels,
424 int i_sample_count, const int *pi_selection, int i_bits_per_sample )
426 /* It does not work in place */
427 assert( p_dst != p_src );
429 /* Force the compiler to inline for the specific cases so it can optimize */
430 if( i_bits_per_sample == 8 )
431 ExtractChannel( p_dst, i_dst_channels, p_src, i_src_channels, i_sample_count, pi_selection, 1 );
432 else if( i_bits_per_sample == 16 )
433 ExtractChannel( p_dst, i_dst_channels, p_src, i_src_channels, i_sample_count, pi_selection, 2 );
434 else if( i_bits_per_sample == 32 )
435 ExtractChannel( p_dst, i_dst_channels, p_src, i_src_channels, i_sample_count, pi_selection, 4 );
436 else if( i_bits_per_sample == 64 )
437 ExtractChannel( p_dst, i_dst_channels, p_src, i_src_channels, i_sample_count, pi_selection, 8 );
440 bool aout_CheckChannelExtraction( int *pi_selection,
441 uint32_t *pi_layout, int *pi_channels,
442 const uint32_t pi_order_dst[AOUT_CHAN_MAX],
443 const uint32_t *pi_order_src, int i_channels )
445 const uint32_t pi_order_dual_mono[] = { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT };
446 uint32_t i_layout = 0;
448 int pi_index[AOUT_CHAN_MAX];
452 pi_order_dst = pi_vlc_chan_order_wg4;
454 /* Detect special dual mono case */
455 if( i_channels == 2 &&
456 pi_order_src[0] == AOUT_CHAN_CENTER && pi_order_src[1] == AOUT_CHAN_CENTER )
458 i_layout |= AOUT_CHAN_DUALMONO;
459 pi_order_src = pi_order_dual_mono;
463 for( int i = 0; i < i_channels; i++ )
465 /* Ignore unknown or duplicated channels or not present in output */
466 if( !pi_order_src[i] || (i_layout & pi_order_src[i]) )
469 for( int j = 0; j < AOUT_CHAN_MAX; j++ )
471 if( pi_order_dst[j] == pi_order_src[i] )
473 assert( i_out < AOUT_CHAN_MAX );
474 pi_index[i_out++] = i;
475 i_layout |= pi_order_src[i];
482 for( int i = 0, j = 0; i < AOUT_CHAN_MAX; i++ )
484 for( int k = 0; k < i_out; k++ )
486 if( pi_order_dst[i] == pi_order_src[pi_index[k]] )
488 pi_selection[j++] = pi_index[k];
494 *pi_layout = i_layout;
495 *pi_channels = i_out;
497 for( int i = 0; i < i_out; i++ )
499 if( pi_selection[i] != i )
502 return i_out == i_channels;
505 /* Return the order in which filters should be inserted */
506 static int FilterOrder( const char *psz_name )
508 static const struct {
509 const char psz_name[10];
514 for( unsigned i = 0; i < ARRAY_SIZE(filter); i++ )
516 if( !strcmp( filter[i].psz_name, psz_name ) )
517 return filter[i].i_order;
522 /* This function will add or remove a a module from a string list (colon
523 * separated). It will return true if there is a modification
524 * In case p_aout is NULL, we will use configuration instead of variable */
525 bool aout_ChangeFilterString( vlc_object_t *p_obj, vlc_object_t *p_aout,
526 const char *psz_variable,
527 const char *psz_name, bool b_add )
529 if( *psz_name == '\0' )
535 psz_list = var_GetString( p_aout, psz_variable );
539 psz_list = var_CreateGetString( p_obj->p_libvlc, psz_variable );
540 var_Destroy( p_obj->p_libvlc, psz_variable );
543 /* Split the string into an array of filters */
545 for( char *p = psz_list; p && *p; p++ )
546 i_count += *p == ':';
549 const char **ppsz_filter = calloc( i_count, sizeof(*ppsz_filter) );
555 bool b_present = false;
557 for( char *p = psz_list; p && *p; )
559 char *psz_end = strchr(p, ':');
563 psz_end = p + strlen(p);
566 b_present |= !strcmp( p, psz_name );
567 ppsz_filter[i_count++] = p;
571 if( b_present == b_add )
580 int i_order = FilterOrder( psz_name );
582 for( i = 0; i < i_count; i++ )
584 if( FilterOrder( ppsz_filter[i] ) > i_order )
588 memmove( &ppsz_filter[i+1], &ppsz_filter[i], (i_count - i) * sizeof(*ppsz_filter) );
589 ppsz_filter[i] = psz_name;
594 for( int i = 0; i < i_count; i++ )
596 if( !strcmp( ppsz_filter[i], psz_name ) )
601 for( int i = 0; i < i_count; i++ )
602 i_length += 1 + strlen( ppsz_filter[i] );
604 char *psz_new = malloc( i_length + 1 );
606 for( int i = 0; i < i_count; i++ )
608 if( *ppsz_filter[i] == '\0' )
611 strcat( psz_new, ":" );
612 strcat( psz_new, ppsz_filter[i] );
618 var_SetString( p_aout, psz_variable, psz_new );
620 config_PutPsz( p_obj, psz_variable, psz_new );