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