]> git.sesse.net Git - vlc/blob - src/audio_output/common.c
* modules/codec/lpcm.c: support for 20/24 bits LPCM.
[vlc] / src / audio_output / common.c
1 /*****************************************************************************
2  * common.c : audio output management of common data structures
3  *****************************************************************************
4  * Copyright (C) 2002-2005 VideoLAN
5  * $Id$
6  *
7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                            /* calloc(), malloc(), free() */
28 #include <string.h>
29
30 #include <vlc/vlc.h>
31
32 #include "audio_output.h"
33 #include "aout_internal.h"
34
35
36 /*
37  * Instances management (internal and external)
38  */
39
40 /*****************************************************************************
41  * aout_New: initialize aout structure
42  *****************************************************************************/
43 aout_instance_t * __aout_New( vlc_object_t * p_parent )
44 {
45     aout_instance_t * p_aout;
46     vlc_value_t val;
47
48     /* Allocate descriptor. */
49     p_aout = vlc_object_create( p_parent, VLC_OBJECT_AOUT );
50     if( p_aout == NULL )
51     {
52         return NULL;
53     }
54
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;
64
65     var_Create( p_aout, "intf-change", VLC_VAR_BOOL );
66     val.b_bool = VLC_TRUE;
67     var_Set( p_aout, "intf-change", val );
68
69     return p_aout;
70 }
71
72 /*****************************************************************************
73  * aout_Delete: destroy aout structure
74  *****************************************************************************/
75 void aout_Delete( aout_instance_t * p_aout )
76 {
77     var_Destroy( p_aout, "intf-change" );
78
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 );
82
83     /* Free structure. */
84     vlc_object_destroy( p_aout );
85 }
86
87
88 /*
89  * Formats management (internal and external)
90  */
91
92 /*****************************************************************************
93  * aout_FormatNbChannels : return the number of channels
94  *****************************************************************************/
95 unsigned int aout_FormatNbChannels( const audio_sample_format_t * p_format )
96 {
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;
102
103     for ( i = 0; i < sizeof(pi_channels)/sizeof(uint32_t); i++ )
104     {
105         if ( p_format->i_physical_channels & pi_channels[i] ) i_nb++;
106     }
107
108     return i_nb;
109 }
110
111 /*****************************************************************************
112  * aout_FormatPrepare : compute the number of bytes per frame & frame length
113  *****************************************************************************/
114 void aout_FormatPrepare( audio_sample_format_t * p_format )
115 {
116     int i_result;
117
118     switch ( p_format->i_format )
119     {
120     case VLC_FOURCC('u','8',' ',' '):
121     case VLC_FOURCC('s','8',' ',' '):
122         i_result = 1;
123         break;
124
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'):
129         i_result = 2;
130         break;
131
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'):
136         i_result = 3;
137         break;
138
139     case VLC_FOURCC('f','l','3','2'):
140     case VLC_FOURCC('f','i','3','2'):
141         i_result = 4;
142         break;
143
144     case VLC_FOURCC('s','p','d','i'):
145     case VLC_FOURCC('a','5','2',' '):
146     case VLC_FOURCC('d','t','s',' '):
147     case VLC_FOURCC('m','p','g','a'):
148     case VLC_FOURCC('m','p','g','3'):
149     default:
150         /* For these formats the caller has to indicate the parameters
151          * by hand. */
152         return;
153     }
154
155     p_format->i_bytes_per_frame = i_result * aout_FormatNbChannels( p_format );
156     p_format->i_frame_length = 1;
157 }
158
159 /*****************************************************************************
160  * aout_FormatPrintChannels : print a channel in a human-readable form
161  *****************************************************************************/
162 const char * aout_FormatPrintChannels( const audio_sample_format_t * p_format )
163 {
164     switch ( p_format->i_physical_channels & AOUT_CHAN_PHYSMASK )
165     {
166     case AOUT_CHAN_CENTER:
167         if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
168               || (p_format->i_original_channels
169                    & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
170             return "Mono";
171         else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
172             return "Left";
173         return "Right";
174     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
175         if ( p_format->i_original_channels & AOUT_CHAN_REVERSESTEREO )
176         {
177             if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
178                 return "Dolby/Reverse";
179             return "Stereo/Reverse";
180         }
181         else
182         {
183             if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
184                 return "Dolby";
185             else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
186                 return "Dual-mono";
187             else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
188                 return "Stereo/Mono";
189             else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
190                 return "Stereo/Left";
191             else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
192                 return "Stereo/Right";
193             return "Stereo";
194         }
195     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
196         return "3F";
197     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
198         return "2F1R";
199     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
200           | AOUT_CHAN_REARCENTER:
201         return "3F1R";
202     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
203           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
204         return "2F2R";
205     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
206           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
207         return "3F2R";
208
209     case AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
210         if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
211               || (p_format->i_original_channels
212                    & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
213             return "Mono/LFE";
214         else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
215             return "Left/LFE";
216         return "Right/LFE";
217     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE:
218         if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
219             return "Dolby/LFE";
220         else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
221             return "Dual-mono/LFE";
222         else if ( p_format->i_original_channels == AOUT_CHAN_CENTER )
223             return "Mono/LFE";
224         else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
225             return "Stereo/Left/LFE";
226         else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
227             return "Stereo/Right/LFE";
228          return "Stereo/LFE";
229     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
230         return "3F/LFE";
231     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER
232           | AOUT_CHAN_LFE:
233         return "2F1R/LFE";
234     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
235           | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE:
236         return "3F1R/LFE";
237     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
238           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
239         return "2F2R/LFE";
240     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
241           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
242         return "3F2R/LFE";
243     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
244           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
245           | AOUT_CHAN_MIDDLERIGHT:
246         return "3F2M2R";
247     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
248           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
249           | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE:
250         return "3F2M2R/LFE";
251     }
252
253     return "ERROR";
254 }
255
256 /*****************************************************************************
257  * aout_FormatPrint : print a format in a human-readable form
258  *****************************************************************************/
259 void aout_FormatPrint( aout_instance_t * p_aout, const char * psz_text,
260                        const audio_sample_format_t * p_format )
261 {
262     msg_Dbg( p_aout, "%s '%4.4s' %d Hz %s frame=%d samples/%d bytes", psz_text,
263              (char *)&p_format->i_format, p_format->i_rate,
264              aout_FormatPrintChannels( p_format ),
265              p_format->i_frame_length, p_format->i_bytes_per_frame );
266 }
267
268 /*****************************************************************************
269  * aout_FormatsPrint : print two formats in a human-readable form
270  *****************************************************************************/
271 void aout_FormatsPrint( aout_instance_t * p_aout, const char * psz_text,
272                         const audio_sample_format_t * p_format1,
273                         const audio_sample_format_t * p_format2 )
274 {
275     msg_Dbg( p_aout, "%s '%4.4s'->'%4.4s' %d Hz->%d Hz %s->%s",
276              psz_text,
277              (char *)&p_format1->i_format, (char *)&p_format2->i_format,
278              p_format1->i_rate, p_format2->i_rate,
279              aout_FormatPrintChannels( p_format1 ),
280              aout_FormatPrintChannels( p_format2 ) );
281 }
282
283
284 /*
285  * FIFO management (internal) - please understand that solving race conditions
286  * is _your_ job, ie. in the audio output you should own the mixer lock
287  * before calling any of these functions.
288  */
289
290 /*****************************************************************************
291  * aout_FifoInit : initialize the members of a FIFO
292  *****************************************************************************/
293 void aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
294                     uint32_t i_rate )
295 {
296     p_fifo->p_first = NULL;
297     p_fifo->pp_last = &p_fifo->p_first;
298     aout_DateInit( &p_fifo->end_date, i_rate );
299 }
300
301 /*****************************************************************************
302  * aout_FifoPush : push a packet into the FIFO
303  *****************************************************************************/
304 void aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
305                     aout_buffer_t * p_buffer )
306 {
307     *p_fifo->pp_last = p_buffer;
308     p_fifo->pp_last = &p_buffer->p_next;
309     *p_fifo->pp_last = NULL;
310     /* Enforce the continuity of the stream. */
311     if ( aout_DateGet( &p_fifo->end_date ) )
312     {
313         p_buffer->start_date = aout_DateGet( &p_fifo->end_date );
314         p_buffer->end_date = aout_DateIncrement( &p_fifo->end_date,
315                                                  p_buffer->i_nb_samples );
316     }
317     else
318     {
319         aout_DateSet( &p_fifo->end_date, p_buffer->end_date );
320     }
321 }
322
323 /*****************************************************************************
324  * aout_FifoSet : set end_date and trash all buffers (because they aren't
325  * properly dated)
326  *****************************************************************************/
327 void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
328                    mtime_t date )
329 {
330     aout_buffer_t * p_buffer;
331
332     aout_DateSet( &p_fifo->end_date, date );
333     p_buffer = p_fifo->p_first;
334     while ( p_buffer != NULL )
335     {
336         aout_buffer_t * p_next = p_buffer->p_next;
337         aout_BufferFree( p_buffer );
338         p_buffer = p_next;
339     }
340     p_fifo->p_first = NULL;
341     p_fifo->pp_last = &p_fifo->p_first;
342 }
343
344 /*****************************************************************************
345  * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
346  *****************************************************************************/
347 void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
348                          mtime_t difference )
349 {
350     aout_buffer_t * p_buffer;
351
352     aout_DateMove( &p_fifo->end_date, difference );
353     p_buffer = p_fifo->p_first;
354     while ( p_buffer != NULL )
355     {
356         p_buffer->start_date += difference;
357         p_buffer->end_date += difference;
358         p_buffer = p_buffer->p_next;
359     }
360 }
361
362 /*****************************************************************************
363  * aout_FifoNextStart : return the current end_date
364  *****************************************************************************/
365 mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
366 {
367     return aout_DateGet( &p_fifo->end_date );
368 }
369
370 /*****************************************************************************
371  * aout_FifoFirstDate : return the playing date of the first buffer in the
372  * FIFO
373  *****************************************************************************/
374 mtime_t aout_FifoFirstDate( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
375 {
376     return p_fifo->p_first ?  p_fifo->p_first->start_date : 0;
377 }
378
379 /*****************************************************************************
380  * aout_FifoPop : get the next buffer out of the FIFO
381  *****************************************************************************/
382 aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
383 {
384     aout_buffer_t * p_buffer;
385
386     p_buffer = p_fifo->p_first;
387     if ( p_buffer == NULL ) return NULL;
388     p_fifo->p_first = p_buffer->p_next;
389     if ( p_fifo->p_first == NULL )
390     {
391         p_fifo->pp_last = &p_fifo->p_first;
392     }
393
394     return p_buffer;
395 }
396
397 /*****************************************************************************
398  * aout_FifoDestroy : destroy a FIFO and its buffers
399  *****************************************************************************/
400 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
401 {
402     aout_buffer_t * p_buffer;
403
404     p_buffer = p_fifo->p_first;
405     while ( p_buffer != NULL )
406     {
407         aout_buffer_t * p_next = p_buffer->p_next;
408         aout_BufferFree( p_buffer );
409         p_buffer = p_next;
410     }
411
412     p_fifo->p_first = NULL;
413     p_fifo->pp_last = &p_fifo->p_first;
414 }
415
416
417 /*
418  * Date management (internal and external)
419  */
420
421 /*****************************************************************************
422  * aout_DateInit : set the divider of an audio_date_t
423  *****************************************************************************/
424 void aout_DateInit( audio_date_t * p_date, uint32_t i_divider )
425 {
426     p_date->date = 0;
427     p_date->i_divider = i_divider;
428     p_date->i_remainder = 0;
429 }
430
431 /*****************************************************************************
432  * aout_DateSet : set the date of an audio_date_t
433  *****************************************************************************/
434 void aout_DateSet( audio_date_t * p_date, mtime_t new_date )
435 {
436     p_date->date = new_date;
437     p_date->i_remainder = 0;
438 }
439
440 /*****************************************************************************
441  * aout_DateMove : move forwards or backwards the date of an audio_date_t
442  *****************************************************************************/
443 void aout_DateMove( audio_date_t * p_date, mtime_t difference )
444 {
445     p_date->date += difference;
446 }
447
448 /*****************************************************************************
449  * aout_DateGet : get the date of an audio_date_t
450  *****************************************************************************/
451 mtime_t aout_DateGet( const audio_date_t * p_date )
452 {
453     return p_date->date;
454 }
455
456 /*****************************************************************************
457  * aout_DateIncrement : increment the date and return the result, taking
458  * into account rounding errors
459  *****************************************************************************/
460 mtime_t aout_DateIncrement( audio_date_t * p_date, uint32_t i_nb_samples )
461 {
462     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
463     p_date->date += i_dividend / p_date->i_divider;
464     p_date->i_remainder += (int)(i_dividend % p_date->i_divider);
465     if ( p_date->i_remainder >= p_date->i_divider )
466     {
467         /* This is Bresenham algorithm. */
468         p_date->date++;
469         p_date->i_remainder -= p_date->i_divider;
470     }
471     return p_date->date;
472 }
473
474 /*****************************************************************************
475  * aout_CheckChannelReorder : Check if we need to do some channel re-ordering
476  *****************************************************************************/
477 int aout_CheckChannelReorder( const uint32_t *pi_chan_order_in,
478                               const uint32_t *pi_chan_order_out,
479                               uint32_t i_channel_mask,
480                               int i_channels, int *pi_chan_table )
481 {
482     vlc_bool_t b_chan_reorder = VLC_FALSE;
483     int i, j, k, l;
484
485     if( i_channels > AOUT_CHAN_MAX ) return VLC_FALSE;
486
487     for( i = 0, j = 0; pi_chan_order_in[i]; i++ )
488     {
489         if( !(i_channel_mask & pi_chan_order_in[i]) ) continue;
490
491         for( k = 0, l = 0; pi_chan_order_in[i] != pi_chan_order_out[k]; k++ )
492         {
493             if( i_channel_mask & pi_chan_order_out[k] ) l++;
494         }
495
496         pi_chan_table[j++] = l;
497     }
498
499     for( i = 0; i < i_channels; i++ )
500     {
501         if( pi_chan_table[i] != i ) b_chan_reorder = VLC_TRUE;
502     }
503
504     return b_chan_reorder;
505 }
506
507 /*****************************************************************************
508  * aout_ChannelReorder :
509  *****************************************************************************/
510 void aout_ChannelReorder( uint8_t *p_buf, int i_buffer,
511                           int i_channels, const int *pi_chan_table,
512                           int i_bits_per_sample )
513 {
514     uint8_t p_tmp[AOUT_CHAN_MAX * 4];
515     int i, j;
516
517     if( i_bits_per_sample == 8 )
518     {
519         for( i = 0; i < i_buffer / i_channels; i++ )
520         {
521             for( j = 0; j < i_channels; j++ )
522             {
523                 p_tmp[pi_chan_table[j]] = p_buf[j];
524             }
525
526             memcpy( p_buf, p_tmp, i_channels );
527             p_buf += i_channels;
528         }
529     }
530     else if( i_bits_per_sample == 16 )
531     {
532         for( i = 0; i < i_buffer / i_channels / 2; i++ )
533         {
534             for( j = 0; j < i_channels; j++ )
535             {
536                 p_tmp[2 * pi_chan_table[j]]     = p_buf[2 * j];
537                 p_tmp[2 * pi_chan_table[j] + 1] = p_buf[2 * j + 1];
538             }
539
540             memcpy( p_buf, p_tmp, 2 * i_channels );
541             p_buf += 2 * i_channels;
542         }
543     }
544     else if( i_bits_per_sample == 24 )
545     {
546         for( i = 0; i < i_buffer / i_channels / 3; i++ )
547         {
548             for( j = 0; j < i_channels; j++ )
549             {
550                 p_tmp[3 * pi_chan_table[j]]     = p_buf[3 * j];
551                 p_tmp[3 * pi_chan_table[j] + 1] = p_buf[3 * j + 1];
552                 p_tmp[3 * pi_chan_table[j] + 2] = p_buf[3 * j + 2];
553             }
554
555             memcpy( p_buf, p_tmp, 3 * i_channels );
556             p_buf += 3 * i_channels;
557         }
558     }
559     else if( i_bits_per_sample == 32 )
560     {
561         for( i = 0; i < i_buffer / i_channels / 4; i++ )
562         {
563             for( j = 0; j < i_channels; j++ )
564             {
565                 p_tmp[4 * pi_chan_table[j]]     = p_buf[4 * j];
566                 p_tmp[4 * pi_chan_table[j] + 1] = p_buf[4 * j + 1];
567                 p_tmp[4 * pi_chan_table[j] + 2] = p_buf[4 * j + 2];
568                 p_tmp[4 * pi_chan_table[j] + 3] = p_buf[4 * j + 3];
569             }
570
571             memcpy( p_buf, p_tmp, 4 * i_channels );
572             p_buf += 4 * i_channels;
573         }
574     }
575 }