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