Merge fixes to the python binding from my branch
[vlc.git] / src / audio_output / output.c
1 /*****************************************************************************
2  * output.c : internal management of output streams for the audio output
3  *****************************************************************************
4  * Copyright (C) 2002-2004 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., 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  * aout_OutputNew : allocate a new output and rework the filter pipeline
37  *****************************************************************************
38  * This function is entered with the mixer lock.
39  *****************************************************************************/
40 int aout_OutputNew( aout_instance_t * p_aout,
41                     audio_sample_format_t * p_format )
42 {
43     /* Retrieve user defaults. */
44     int i_rate = config_GetInt( p_aout, "aout-rate" );
45     vlc_value_t val, text;
46     /* kludge to avoid a fpu error when rate is 0... */
47     if( i_rate == 0 ) i_rate = -1;
48
49     memcpy( &p_aout->output.output, p_format, sizeof(audio_sample_format_t) );
50     if ( i_rate != -1 )
51         p_aout->output.output.i_rate = i_rate;
52     aout_FormatPrepare( &p_aout->output.output );
53
54     vlc_mutex_lock( &p_aout->output_fifo_lock );
55
56     /* Find the best output plug-in. */
57     p_aout->output.p_module = module_Need( p_aout, "audio output", "$aout", 0);
58     if ( p_aout->output.p_module == NULL )
59     {
60         msg_Err( p_aout, "no suitable aout module" );
61         vlc_mutex_unlock( &p_aout->output_fifo_lock );
62         return -1;
63     }
64
65     if ( var_Type( p_aout, "audio-channels" ) ==
66              (VLC_VAR_INTEGER | VLC_VAR_HASCHOICE) )
67     {
68         /* The user may have selected a different channels configuration. */
69         var_Get( p_aout, "audio-channels", &val );
70
71         if ( val.i_int == AOUT_VAR_CHAN_RSTEREO )
72         {
73             p_aout->output.output.i_original_channels |=
74                                         AOUT_CHAN_REVERSESTEREO;
75         }
76         else if ( val.i_int == AOUT_VAR_CHAN_STEREO )
77         {
78             p_aout->output.output.i_original_channels =
79                 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
80         }
81         else if ( val.i_int == AOUT_VAR_CHAN_LEFT )
82         {
83             p_aout->output.output.i_original_channels = AOUT_CHAN_LEFT;
84         }
85         else if ( val.i_int == AOUT_VAR_CHAN_RIGHT )
86         {
87             p_aout->output.output.i_original_channels = AOUT_CHAN_RIGHT;
88         }
89         else if ( val.i_int == AOUT_VAR_CHAN_DOLBYS )
90         {
91             p_aout->output.output.i_original_channels
92                 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_DOLBYSTEREO;
93         }
94     }
95     else if ( p_aout->output.output.i_physical_channels == AOUT_CHAN_CENTER
96               && (p_aout->output.output.i_original_channels
97                    & AOUT_CHAN_PHYSMASK) == (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT) )
98     {
99         /* Mono - create the audio-channels variable. */
100         var_Create( p_aout, "audio-channels",
101                     VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
102         text.psz_string = _("Audio Channels");
103         var_Change( p_aout, "audio-channels", VLC_VAR_SETTEXT, &text, NULL );
104
105         val.i_int = AOUT_VAR_CHAN_STEREO; text.psz_string = _("Stereo");
106         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val, &text );
107         val.i_int = AOUT_VAR_CHAN_LEFT; text.psz_string = _("Left");
108         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val, &text );
109         val.i_int = AOUT_VAR_CHAN_RIGHT; text.psz_string = _("Right");
110         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val, &text );
111         if ( p_aout->output.output.i_original_channels & AOUT_CHAN_DUALMONO )
112         {
113             /* Go directly to the left channel. */
114             p_aout->output.output.i_original_channels = AOUT_CHAN_LEFT;
115             val.i_int = AOUT_VAR_CHAN_LEFT;
116             var_Set( p_aout, "audio-channels", val );
117         }
118         var_AddCallback( p_aout, "audio-channels", aout_ChannelsRestart,
119                          NULL );
120     }
121     else if ( p_aout->output.output.i_physical_channels ==
122                (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)
123                 && (p_aout->output.output.i_original_channels &
124                      (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
125     {
126         /* Stereo - create the audio-channels variable. */
127         var_Create( p_aout, "audio-channels",
128                     VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
129         text.psz_string = _("Audio Channels");
130         var_Change( p_aout, "audio-channels", VLC_VAR_SETTEXT, &text, NULL );
131
132         if ( p_aout->output.output.i_original_channels & AOUT_CHAN_DOLBYSTEREO )
133         {
134             val.i_int = AOUT_VAR_CHAN_DOLBYS;
135             text.psz_string = _("Dolby Surround");
136         }
137         else
138         {
139             val.i_int = AOUT_VAR_CHAN_STEREO;
140             text.psz_string = _("Stereo");
141         }
142         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val, &text );
143         val.i_int = AOUT_VAR_CHAN_LEFT; text.psz_string = _("Left");
144         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val, &text );
145         val.i_int = AOUT_VAR_CHAN_RIGHT; text.psz_string = _("Right");
146         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val, &text );
147         val.i_int = AOUT_VAR_CHAN_RSTEREO; text.psz_string=_("Reverse stereo");
148         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val, &text );
149         if ( p_aout->output.output.i_original_channels & AOUT_CHAN_DUALMONO )
150         {
151             /* Go directly to the left channel. */
152             p_aout->output.output.i_original_channels = AOUT_CHAN_LEFT;
153             val.i_int = AOUT_VAR_CHAN_LEFT;
154             var_Set( p_aout, "audio-channels", val );
155         }
156         var_AddCallback( p_aout, "audio-channels", aout_ChannelsRestart,
157                          NULL );
158     }
159     val.b_bool = VLC_TRUE;
160     var_Set( p_aout, "intf-change", val );
161
162     aout_FormatPrepare( &p_aout->output.output );
163
164     /* Prepare FIFO. */
165     aout_FifoInit( p_aout, &p_aout->output.fifo,
166                    p_aout->output.output.i_rate );
167
168     vlc_mutex_unlock( &p_aout->output_fifo_lock );
169
170     aout_FormatPrint( p_aout, "output", &p_aout->output.output );
171
172     /* Calculate the resulting mixer output format. */
173     memcpy( &p_aout->mixer.mixer, &p_aout->output.output,
174             sizeof(audio_sample_format_t) );
175     if ( !AOUT_FMT_NON_LINEAR(&p_aout->output.output) )
176     {
177         /* Non-S/PDIF mixer only deals with float32 or fixed32. */
178         p_aout->mixer.mixer.i_format
179                      = (p_aout->p_libvlc->i_cpu & CPU_CAPABILITY_FPU) ?
180                         VLC_FOURCC('f','l','3','2') :
181                         VLC_FOURCC('f','i','3','2');
182         aout_FormatPrepare( &p_aout->mixer.mixer );
183     }
184     else
185     {
186         p_aout->mixer.mixer.i_format = p_format->i_format;
187     }
188
189     aout_FormatPrint( p_aout, "mixer", &p_aout->mixer.mixer );
190
191     /* Create filters. */
192     p_aout->output.i_nb_filters = 0;
193     if ( aout_FiltersCreatePipeline( p_aout, p_aout->output.pp_filters,
194                                      &p_aout->output.i_nb_filters,
195                                      &p_aout->mixer.mixer,
196                                      &p_aout->output.output ) < 0 )
197     {
198         msg_Err( p_aout, "couldn't set an output pipeline" );
199         module_Unneed( p_aout, p_aout->output.p_module );
200         return -1;
201     }
202
203     /* Prepare hints for the buffer allocator. */
204     p_aout->mixer.output_alloc.i_alloc_type = AOUT_ALLOC_HEAP;
205     p_aout->mixer.output_alloc.i_bytes_per_sec
206                         = p_aout->mixer.mixer.i_bytes_per_frame
207                            * p_aout->mixer.mixer.i_rate
208                            / p_aout->mixer.mixer.i_frame_length;
209
210     aout_FiltersHintBuffers( p_aout, p_aout->output.pp_filters,
211                              p_aout->output.i_nb_filters,
212                              &p_aout->mixer.output_alloc );
213
214     p_aout->output.b_error = 0;
215     return 0;
216 }
217
218 /*****************************************************************************
219  * aout_OutputDelete : delete the output
220  *****************************************************************************
221  * This function is entered with the mixer lock.
222  *****************************************************************************/
223 void aout_OutputDelete( aout_instance_t * p_aout )
224 {
225     if ( p_aout->output.b_error )
226     {
227         return;
228     }
229
230     module_Unneed( p_aout, p_aout->output.p_module );
231
232     aout_FiltersDestroyPipeline( p_aout, p_aout->output.pp_filters,
233                                  p_aout->output.i_nb_filters );
234     aout_FifoDestroy( p_aout, &p_aout->output.fifo );
235
236     p_aout->output.b_error = VLC_TRUE;
237 }
238
239 /*****************************************************************************
240  * aout_OutputPlay : play a buffer
241  *****************************************************************************
242  * This function is entered with the mixer lock.
243  *****************************************************************************/
244 void aout_OutputPlay( aout_instance_t * p_aout, aout_buffer_t * p_buffer )
245 {
246     aout_FiltersPlay( p_aout, p_aout->output.pp_filters,
247                       p_aout->output.i_nb_filters,
248                       &p_buffer );
249
250     if( p_buffer->i_nb_bytes == 0 )
251     {
252         aout_BufferFree( p_buffer );
253         return;
254     }
255
256     vlc_mutex_lock( &p_aout->output_fifo_lock );
257     aout_FifoPush( p_aout, &p_aout->output.fifo, p_buffer );
258     p_aout->output.pf_play( p_aout );
259     vlc_mutex_unlock( &p_aout->output_fifo_lock );
260 }
261
262 /*****************************************************************************
263  * aout_OutputNextBuffer : give the audio output plug-in the right buffer
264  *****************************************************************************
265  * If b_can_sleek is 1, the aout core functions won't try to resample
266  * new buffers to catch up - that is we suppose that the output plug-in can
267  * compensate it by itself. S/PDIF outputs should always set b_can_sleek = 1.
268  * This function is entered with no lock at all :-).
269  *****************************************************************************/
270 aout_buffer_t * aout_OutputNextBuffer( aout_instance_t * p_aout,
271                                        mtime_t start_date,
272                                        vlc_bool_t b_can_sleek )
273 {
274     aout_buffer_t * p_buffer;
275
276     vlc_mutex_lock( &p_aout->output_fifo_lock );
277
278     p_buffer = p_aout->output.fifo.p_first;
279
280     /* Drop the audio sample if the audio output is really late.
281      * In the case of b_can_sleek, we don't use a resampler so we need to be
282      * a lot more severe. */
283     while ( p_buffer && p_buffer->start_date <
284             (b_can_sleek ? start_date : mdate()) - AOUT_PTS_TOLERANCE )
285     {
286         msg_Dbg( p_aout, "audio output is too slow ("I64Fd"), "
287                  "trashing "I64Fd"us", mdate() - p_buffer->start_date,
288                  p_buffer->end_date - p_buffer->start_date );
289         p_buffer = p_buffer->p_next;
290         aout_BufferFree( p_aout->output.fifo.p_first );
291         p_aout->output.fifo.p_first = p_buffer;
292     }
293
294     if ( p_buffer == NULL )
295     {
296         p_aout->output.fifo.pp_last = &p_aout->output.fifo.p_first;
297
298 #if 0 /* This is bad because the audio output might just be trying to fill
299        * in it's internal buffers. And anyway, it's up to the audio output
300        * to deal with this kind of starvation. */
301
302         /* Set date to 0, to allow the mixer to send a new buffer ASAP */
303         aout_FifoSet( p_aout, &p_aout->output.fifo, 0 );
304         if ( !p_aout->output.b_starving )
305             msg_Dbg( p_aout,
306                  "audio output is starving (no input), playing silence" );
307         p_aout->output.b_starving = 1;
308 #endif
309
310         vlc_mutex_unlock( &p_aout->output_fifo_lock );
311         return NULL;
312     }
313
314     /* Here we suppose that all buffers have the same duration - this is
315      * generally true, and anyway if it's wrong it won't be a disaster.
316      */
317     if ( p_buffer->start_date > start_date
318                          + (p_buffer->end_date - p_buffer->start_date) )
319     /*
320      *                   + AOUT_PTS_TOLERANCE )
321      * There is no reason to want that, it just worsen the scheduling of
322      * an audio sample after an output starvation (ie. on start or on resume)
323      * --Gibalou
324      */
325     {
326         vlc_mutex_unlock( &p_aout->output_fifo_lock );
327         if ( !p_aout->output.b_starving )
328             msg_Dbg( p_aout, "audio output is starving ("I64Fd"), "
329                      "playing silence", p_buffer->start_date - start_date );
330         p_aout->output.b_starving = 1;
331         return NULL;
332     }
333
334     p_aout->output.b_starving = 0;
335
336     if ( !b_can_sleek &&
337           ( (p_buffer->start_date - start_date > AOUT_PTS_TOLERANCE)
338              || (start_date - p_buffer->start_date > AOUT_PTS_TOLERANCE) ) )
339     {
340         /* Try to compensate the drift by doing some resampling. */
341         int i;
342         mtime_t difference = start_date - p_buffer->start_date;
343         msg_Warn( p_aout, "output date isn't PTS date, requesting "
344                   "resampling ("I64Fd")", difference );
345
346         vlc_mutex_lock( &p_aout->input_fifos_lock );
347         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
348         {
349             aout_fifo_t * p_fifo = &p_aout->pp_inputs[i]->fifo;
350
351             aout_FifoMoveDates( p_aout, p_fifo, difference );
352         }
353
354         aout_FifoMoveDates( p_aout, &p_aout->output.fifo, difference );
355         vlc_mutex_unlock( &p_aout->input_fifos_lock );
356     }
357
358     p_aout->output.fifo.p_first = p_buffer->p_next;
359     if ( p_buffer->p_next == NULL )
360     {
361         p_aout->output.fifo.pp_last = &p_aout->output.fifo.p_first;
362     }
363
364     vlc_mutex_unlock( &p_aout->output_fifo_lock );
365     return p_buffer;
366 }