]> git.sesse.net Git - vlc/blob - src/audio_output/common.c
libvlc: use vlc_common.h (libvlccore) instead of vlc/vlc.h
[vlc] / src / audio_output / common.c
1 /*****************************************************************************
2  * common.c : audio output management of common data structures
3  *****************************************************************************
4  * Copyright (C) 2002-2007 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_aout.h>
33 #include "aout_internal.h"
34
35 /*
36  * Instances management (internal and external)
37  */
38
39 /* Local functions */
40 static void aout_Destructor( vlc_object_t * p_this );
41
42 /*****************************************************************************
43  * aout_New: initialize aout structure
44  *****************************************************************************/
45 aout_instance_t * __aout_New( vlc_object_t * p_parent )
46 {
47     aout_instance_t * p_aout;
48     vlc_value_t val;
49
50     /* Allocate descriptor. */
51     p_aout = vlc_object_create( p_parent, VLC_OBJECT_AOUT );
52     if( p_aout == NULL )
53     {
54         return NULL;
55     }
56
57     /* Initialize members. */
58     vlc_mutex_init( &p_aout->input_fifos_lock );
59     vlc_mutex_init( &p_aout->mixer_lock );
60     vlc_mutex_init( &p_aout->output_fifo_lock );
61     p_aout->i_nb_inputs = 0;
62     p_aout->mixer.f_multiplier = 1.0;
63     p_aout->mixer.b_error = 1;
64     p_aout->output.b_error = 1;
65     p_aout->output.b_starving = 1;
66
67     var_Create( p_aout, "intf-change", VLC_VAR_BOOL );
68     val.b_bool = true;
69     var_Set( p_aout, "intf-change", val );
70
71     vlc_object_set_destructor( p_aout, aout_Destructor );
72
73     return p_aout;
74 }
75
76 /*****************************************************************************
77  * aout_Destructor: destroy aout structure
78  *****************************************************************************/
79 static void aout_Destructor( vlc_object_t * p_this )
80 {
81     aout_instance_t * p_aout = (aout_instance_t *)p_this;
82     vlc_mutex_destroy( &p_aout->input_fifos_lock );
83     vlc_mutex_destroy( &p_aout->mixer_lock );
84     vlc_mutex_destroy( &p_aout->output_fifo_lock );
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('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'):
150     default:
151         /* For these formats the caller has to indicate the parameters
152          * by hand. */
153         return;
154     }
155
156     p_format->i_bytes_per_frame = i_result * aout_FormatNbChannels( p_format );
157     p_format->i_frame_length = 1;
158 }
159
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 )
164 {
165     switch ( p_format->i_physical_channels & AOUT_CHAN_PHYSMASK )
166     {
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)) )
171             return "Mono";
172         else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
173             return "Left";
174         return "Right";
175     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
176         if ( p_format->i_original_channels & AOUT_CHAN_REVERSESTEREO )
177         {
178             if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
179                 return "Dolby/Reverse";
180             return "Stereo/Reverse";
181         }
182         else
183         {
184             if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
185                 return "Dolby";
186             else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
187                 return "Dual-mono";
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";
194             return "Stereo";
195         }
196     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
197         return "3F";
198     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
199         return "2F1R";
200     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
201           | AOUT_CHAN_REARCENTER:
202         return "3F1R";
203     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
204           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
205         return "2F2R";
206     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
207           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
208         return "3F2R";
209
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)) )
214             return "Mono/LFE";
215         else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
216             return "Left/LFE";
217         return "Right/LFE";
218     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE:
219         if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
220             return "Dolby/LFE";
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 )
224             return "Mono/LFE";
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";
229          return "Stereo/LFE";
230     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
231         return "3F/LFE";
232     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER
233           | AOUT_CHAN_LFE:
234         return "2F1R/LFE";
235     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
236           | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE:
237         return "3F1R/LFE";
238     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
239           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
240         return "2F2R/LFE";
241     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
242           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
243         return "3F2R/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:
247         return "3F2M2R";
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:
251         return "3F2M2R/LFE";
252     }
253
254     return "ERROR";
255 }
256
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 )
262 {
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 );
267 }
268
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 )
275 {
276     msg_Dbg( p_aout, "%s '%4.4s'->'%4.4s' %d Hz->%d Hz %s->%s",
277              psz_text,
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 ) );
282 }
283
284
285 /*
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.
289  */
290
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,
295                     uint32_t i_rate )
296 {
297     if( i_rate == 0 )
298     {
299         msg_Err( p_aout, "initialising fifo with zero divider" );
300     }
301
302     p_fifo->p_first = NULL;
303     p_fifo->pp_last = &p_fifo->p_first;
304     aout_DateInit( &p_fifo->end_date, i_rate );
305 }
306
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 )
312 {
313     (void)p_aout;
314     *p_fifo->pp_last = p_buffer;
315     p_fifo->pp_last = &p_buffer->p_next;
316     *p_fifo->pp_last = NULL;
317     /* Enforce the continuity of the stream. */
318     if ( aout_DateGet( &p_fifo->end_date ) )
319     {
320         p_buffer->start_date = aout_DateGet( &p_fifo->end_date );
321         p_buffer->end_date = aout_DateIncrement( &p_fifo->end_date,
322                                                  p_buffer->i_nb_samples );
323     }
324     else
325     {
326         aout_DateSet( &p_fifo->end_date, p_buffer->end_date );
327     }
328 }
329
330 /*****************************************************************************
331  * aout_FifoSet : set end_date and trash all buffers (because they aren't
332  * properly dated)
333  *****************************************************************************/
334 void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
335                    mtime_t date )
336 {
337     aout_buffer_t * p_buffer;
338     (void)p_aout;
339
340     aout_DateSet( &p_fifo->end_date, date );
341     p_buffer = p_fifo->p_first;
342     while ( p_buffer != NULL )
343     {
344         aout_buffer_t * p_next = p_buffer->p_next;
345         aout_BufferFree( p_buffer );
346         p_buffer = p_next;
347     }
348     p_fifo->p_first = NULL;
349     p_fifo->pp_last = &p_fifo->p_first;
350 }
351
352 /*****************************************************************************
353  * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
354  *****************************************************************************/
355 void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
356                          mtime_t difference )
357 {
358     aout_buffer_t * p_buffer;
359     (void)p_aout;
360
361     aout_DateMove( &p_fifo->end_date, difference );
362     p_buffer = p_fifo->p_first;
363     while ( p_buffer != NULL )
364     {
365         p_buffer->start_date += difference;
366         p_buffer->end_date += difference;
367         p_buffer = p_buffer->p_next;
368     }
369 }
370
371 /*****************************************************************************
372  * aout_FifoNextStart : return the current end_date
373  *****************************************************************************/
374 mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
375 {
376     (void)p_aout;
377     return aout_DateGet( &p_fifo->end_date );
378 }
379
380 /*****************************************************************************
381  * aout_FifoFirstDate : return the playing date of the first buffer in the
382  * FIFO
383  *****************************************************************************/
384 mtime_t aout_FifoFirstDate( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
385 {
386     (void)p_aout;
387     return p_fifo->p_first ?  p_fifo->p_first->start_date : 0;
388 }
389
390 /*****************************************************************************
391  * aout_FifoPop : get the next buffer out of the FIFO
392  *****************************************************************************/
393 aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
394 {
395     aout_buffer_t * p_buffer;
396     (void)p_aout;
397
398     p_buffer = p_fifo->p_first;
399     if ( p_buffer == NULL ) return NULL;
400     p_fifo->p_first = p_buffer->p_next;
401     if ( p_fifo->p_first == NULL )
402     {
403         p_fifo->pp_last = &p_fifo->p_first;
404     }
405
406     return p_buffer;
407 }
408
409 /*****************************************************************************
410  * aout_FifoDestroy : destroy a FIFO and its buffers
411  *****************************************************************************/
412 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
413 {
414     aout_buffer_t * p_buffer;
415     (void)p_aout;
416
417     p_buffer = p_fifo->p_first;
418     while ( p_buffer != NULL )
419     {
420         aout_buffer_t * p_next = p_buffer->p_next;
421         aout_BufferFree( p_buffer );
422         p_buffer = p_next;
423     }
424
425     p_fifo->p_first = NULL;
426     p_fifo->pp_last = &p_fifo->p_first;
427 }
428
429
430 /*
431  * Date management (internal and external)
432  */
433
434 /*****************************************************************************
435  * aout_DateInit : set the divider of an audio_date_t
436  *****************************************************************************/
437 void aout_DateInit( audio_date_t * p_date, uint32_t i_divider )
438 {
439     p_date->date = 0;
440     p_date->i_divider = i_divider;
441     p_date->i_remainder = 0;
442 }
443
444 /*****************************************************************************
445  * aout_DateSet : set the date of an audio_date_t
446  *****************************************************************************/
447 void aout_DateSet( audio_date_t * p_date, mtime_t new_date )
448 {
449     p_date->date = new_date;
450     p_date->i_remainder = 0;
451 }
452
453 /*****************************************************************************
454  * aout_DateMove : move forwards or backwards the date of an audio_date_t
455  *****************************************************************************/
456 void aout_DateMove( audio_date_t * p_date, mtime_t difference )
457 {
458     p_date->date += difference;
459 }
460
461 /*****************************************************************************
462  * aout_DateGet : get the date of an audio_date_t
463  *****************************************************************************/
464 mtime_t aout_DateGet( const audio_date_t * p_date )
465 {
466     return p_date->date;
467 }
468
469 /*****************************************************************************
470  * aout_DateIncrement : increment the date and return the result, taking
471  * into account rounding errors
472  *****************************************************************************/
473 mtime_t aout_DateIncrement( audio_date_t * p_date, uint32_t i_nb_samples )
474 {
475     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
476     p_date->date += i_dividend / p_date->i_divider;
477     p_date->i_remainder += (int)(i_dividend % p_date->i_divider);
478     if ( p_date->i_remainder >= p_date->i_divider )
479     {
480         /* This is Bresenham algorithm. */
481         p_date->date++;
482         p_date->i_remainder -= p_date->i_divider;
483     }
484     return p_date->date;
485 }
486
487 /*****************************************************************************
488  * aout_CheckChannelReorder : Check if we need to do some channel re-ordering
489  *****************************************************************************/
490 int aout_CheckChannelReorder( const uint32_t *pi_chan_order_in,
491                               const uint32_t *pi_chan_order_out,
492                               uint32_t i_channel_mask,
493                               int i_channels, int *pi_chan_table )
494 {
495     bool b_chan_reorder = false;
496     int i, j, k, l;
497
498     if( i_channels > AOUT_CHAN_MAX ) return false;
499
500     for( i = 0, j = 0; pi_chan_order_in[i]; i++ )
501     {
502         if( !(i_channel_mask & pi_chan_order_in[i]) ) continue;
503
504         for( k = 0, l = 0; pi_chan_order_in[i] != pi_chan_order_out[k]; k++ )
505         {
506             if( i_channel_mask & pi_chan_order_out[k] ) l++;
507         }
508
509         pi_chan_table[j++] = l;
510     }
511
512     for( i = 0; i < i_channels; i++ )
513     {
514         if( pi_chan_table[i] != i ) b_chan_reorder = true;
515     }
516
517     return b_chan_reorder;
518 }
519
520 /*****************************************************************************
521  * aout_ChannelReorder :
522  *****************************************************************************/
523 void aout_ChannelReorder( uint8_t *p_buf, int i_buffer,
524                           int i_channels, const int *pi_chan_table,
525                           int i_bits_per_sample )
526 {
527     uint8_t p_tmp[AOUT_CHAN_MAX * 4];
528     int i, j;
529
530     if( i_bits_per_sample == 8 )
531     {
532         for( i = 0; i < i_buffer / i_channels; i++ )
533         {
534             for( j = 0; j < i_channels; j++ )
535             {
536                 p_tmp[pi_chan_table[j]] = p_buf[j];
537             }
538
539             memcpy( p_buf, p_tmp, i_channels );
540             p_buf += i_channels;
541         }
542     }
543     else if( i_bits_per_sample == 16 )
544     {
545         for( i = 0; i < i_buffer / i_channels / 2; i++ )
546         {
547             for( j = 0; j < i_channels; j++ )
548             {
549                 p_tmp[2 * pi_chan_table[j]]     = p_buf[2 * j];
550                 p_tmp[2 * pi_chan_table[j] + 1] = p_buf[2 * j + 1];
551             }
552
553             memcpy( p_buf, p_tmp, 2 * i_channels );
554             p_buf += 2 * i_channels;
555         }
556     }
557     else if( i_bits_per_sample == 24 )
558     {
559         for( i = 0; i < i_buffer / i_channels / 3; i++ )
560         {
561             for( j = 0; j < i_channels; j++ )
562             {
563                 p_tmp[3 * pi_chan_table[j]]     = p_buf[3 * j];
564                 p_tmp[3 * pi_chan_table[j] + 1] = p_buf[3 * j + 1];
565                 p_tmp[3 * pi_chan_table[j] + 2] = p_buf[3 * j + 2];
566             }
567
568             memcpy( p_buf, p_tmp, 3 * i_channels );
569             p_buf += 3 * i_channels;
570         }
571     }
572     else if( i_bits_per_sample == 32 )
573     {
574         for( i = 0; i < i_buffer / i_channels / 4; i++ )
575         {
576             for( j = 0; j < i_channels; j++ )
577             {
578                 p_tmp[4 * pi_chan_table[j]]     = p_buf[4 * j];
579                 p_tmp[4 * pi_chan_table[j] + 1] = p_buf[4 * j + 1];
580                 p_tmp[4 * pi_chan_table[j] + 2] = p_buf[4 * j + 2];
581                 p_tmp[4 * pi_chan_table[j] + 3] = p_buf[4 * j + 3];
582             }
583
584             memcpy( p_buf, p_tmp, 4 * i_channels );
585             p_buf += 4 * i_channels;
586         }
587     }
588 }