]> git.sesse.net Git - vlc/blob - src/audio_output/output.c
A bit of headers cleanup
[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 #include <stdlib.h>                            /* calloc(), malloc(), free() */
28 #include <string.h>
29
30 #include <vlc/vlc.h>
31 #include <vlc_aout.h>
32 #include "aout_internal.h"
33
34 /*****************************************************************************
35  * aout_OutputNew : allocate a new output and rework the filter pipeline
36  *****************************************************************************
37  * This function is entered with the mixer lock.
38  *****************************************************************************/
39 int aout_OutputNew( aout_instance_t * p_aout,
40                     audio_sample_format_t * p_format )
41 {
42     /* Retrieve user defaults. */
43     int i_rate = config_GetInt( p_aout, "aout-rate" );
44     vlc_value_t val, text;
45     /* kludge to avoid a fpu error when rate is 0... */
46     if( i_rate == 0 ) i_rate = -1;
47
48     memcpy( &p_aout->output.output, p_format, sizeof(audio_sample_format_t) );
49     if ( i_rate != -1 )
50         p_aout->output.output.i_rate = i_rate;
51     aout_FormatPrepare( &p_aout->output.output );
52
53     vlc_mutex_lock( &p_aout->output_fifo_lock );
54
55     /* Find the best output plug-in. */
56     p_aout->output.p_module = module_Need( p_aout, "audio output", "$aout", 0);
57     if ( p_aout->output.p_module == NULL )
58     {
59         msg_Err( p_aout, "no suitable audio output module" );
60         vlc_mutex_unlock( &p_aout->output_fifo_lock );
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 = VLC_TRUE;
159     var_Set( p_aout, "intf-change", val );
160
161     aout_FormatPrepare( &p_aout->output.output );
162
163     /* Prepare FIFO. */
164     aout_FifoInit( p_aout, &p_aout->output.fifo,
165                    p_aout->output.output.i_rate );
166
167     vlc_mutex_unlock( &p_aout->output_fifo_lock );
168
169     aout_FormatPrint( p_aout, "output", &p_aout->output.output );
170
171     /* Calculate the resulting mixer output format. */
172     memcpy( &p_aout->mixer.mixer, &p_aout->output.output,
173             sizeof(audio_sample_format_t) );
174     if ( !AOUT_FMT_NON_LINEAR(&p_aout->output.output) )
175     {
176         /* Non-S/PDIF mixer only deals with float32 or fixed32. */
177         p_aout->mixer.mixer.i_format
178                      = (p_aout->p_libvlc_global->i_cpu & CPU_CAPABILITY_FPU) ?
179                         VLC_FOURCC('f','l','3','2') :
180                         VLC_FOURCC('f','i','3','2');
181         aout_FormatPrepare( &p_aout->mixer.mixer );
182     }
183     else
184     {
185         p_aout->mixer.mixer.i_format = p_format->i_format;
186     }
187
188     aout_FormatPrint( p_aout, "mixer", &p_aout->mixer.mixer );
189
190     /* Create filters. */
191     p_aout->output.i_nb_filters = 0;
192     if ( aout_FiltersCreatePipeline( p_aout, p_aout->output.pp_filters,
193                                      &p_aout->output.i_nb_filters,
194                                      &p_aout->mixer.mixer,
195                                      &p_aout->output.output ) < 0 )
196     {
197         msg_Err( p_aout, "couldn't create audio output pipeline" );
198         module_Unneed( p_aout, p_aout->output.p_module );
199         return -1;
200     }
201
202     /* Prepare hints for the buffer allocator. */
203     p_aout->mixer.output_alloc.i_alloc_type = AOUT_ALLOC_HEAP;
204     p_aout->mixer.output_alloc.i_bytes_per_sec
205                         = p_aout->mixer.mixer.i_bytes_per_frame
206                            * p_aout->mixer.mixer.i_rate
207                            / p_aout->mixer.mixer.i_frame_length;
208
209     aout_FiltersHintBuffers( p_aout, p_aout->output.pp_filters,
210                              p_aout->output.i_nb_filters,
211                              &p_aout->mixer.output_alloc );
212
213     p_aout->output.b_error = 0;
214     return 0;
215 }
216
217 /*****************************************************************************
218  * aout_OutputDelete : delete the output
219  *****************************************************************************
220  * This function is entered with the mixer lock.
221  *****************************************************************************/
222 void aout_OutputDelete( aout_instance_t * p_aout )
223 {
224     if ( p_aout->output.b_error )
225     {
226         return;
227     }
228
229     module_Unneed( p_aout, p_aout->output.p_module );
230
231     aout_FiltersDestroyPipeline( p_aout, p_aout->output.pp_filters,
232                                  p_aout->output.i_nb_filters );
233     aout_FifoDestroy( p_aout, &p_aout->output.fifo );
234
235     p_aout->output.b_error = VLC_TRUE;
236 }
237
238 /*****************************************************************************
239  * aout_OutputPlay : play a buffer
240  *****************************************************************************
241  * This function is entered with the mixer lock.
242  *****************************************************************************/
243 void aout_OutputPlay( aout_instance_t * p_aout, aout_buffer_t * p_buffer )
244 {
245     aout_FiltersPlay( p_aout, p_aout->output.pp_filters,
246                       p_aout->output.i_nb_filters,
247                       &p_buffer );
248
249     if( p_buffer->i_nb_bytes == 0 )
250     {
251         aout_BufferFree( p_buffer );
252         return;
253     }
254
255     vlc_mutex_lock( &p_aout->output_fifo_lock );
256     aout_FifoPush( p_aout, &p_aout->output.fifo, p_buffer );
257     p_aout->output.pf_play( p_aout );
258     vlc_mutex_unlock( &p_aout->output_fifo_lock );
259 }
260
261 /*****************************************************************************
262  * aout_OutputNextBuffer : give the audio output plug-in the right buffer
263  *****************************************************************************
264  * If b_can_sleek is 1, the aout core functions won't try to resample
265  * new buffers to catch up - that is we suppose that the output plug-in can
266  * compensate it by itself. S/PDIF outputs should always set b_can_sleek = 1.
267  * This function is entered with no lock at all :-).
268  *****************************************************************************/
269 aout_buffer_t * aout_OutputNextBuffer( aout_instance_t * p_aout,
270                                        mtime_t start_date,
271                                        vlc_bool_t b_can_sleek )
272 {
273     aout_buffer_t * p_buffer;
274
275     vlc_mutex_lock( &p_aout->output_fifo_lock );
276
277     p_buffer = p_aout->output.fifo.p_first;
278
279     /* Drop the audio sample if the audio output is really late.
280      * In the case of b_can_sleek, we don't use a resampler so we need to be
281      * a lot more severe. */
282     while ( p_buffer && p_buffer->start_date <
283             (b_can_sleek ? start_date : mdate()) - AOUT_PTS_TOLERANCE )
284     {
285         msg_Dbg( p_aout, "audio output is too slow ("I64Fd"), "
286                  "trashing "I64Fd"us", mdate() - p_buffer->start_date,
287                  p_buffer->end_date - p_buffer->start_date );
288         p_buffer = p_buffer->p_next;
289         aout_BufferFree( p_aout->output.fifo.p_first );
290         p_aout->output.fifo.p_first = p_buffer;
291     }
292
293     if ( p_buffer == NULL )
294     {
295         p_aout->output.fifo.pp_last = &p_aout->output.fifo.p_first;
296
297 #if 0 /* This is bad because the audio output might just be trying to fill
298        * in its internal buffers. And anyway, it's up to the audio output
299        * to deal with this kind of starvation. */
300
301         /* Set date to 0, to allow the mixer to send a new buffer ASAP */
302         aout_FifoSet( p_aout, &p_aout->output.fifo, 0 );
303         if ( !p_aout->output.b_starving )
304             msg_Dbg( p_aout,
305                  "audio output is starving (no input), playing silence" );
306         p_aout->output.b_starving = 1;
307 #endif
308
309         vlc_mutex_unlock( &p_aout->output_fifo_lock );
310         return NULL;
311     }
312
313     /* Here we suppose that all buffers have the same duration - this is
314      * generally true, and anyway if it's wrong it won't be a disaster.
315      */
316     if ( p_buffer->start_date > start_date
317                          + (p_buffer->end_date - p_buffer->start_date) )
318     /*
319      *                   + AOUT_PTS_TOLERANCE )
320      * There is no reason to want that, it just worsen the scheduling of
321      * an audio sample after an output starvation (ie. on start or on resume)
322      * --Gibalou
323      */
324     {
325         vlc_mutex_unlock( &p_aout->output_fifo_lock );
326         if ( !p_aout->output.b_starving )
327             msg_Dbg( p_aout, "audio output is starving ("I64Fd"), "
328                      "playing silence", p_buffer->start_date - start_date );
329         p_aout->output.b_starving = 1;
330         return NULL;
331     }
332
333     p_aout->output.b_starving = 0;
334
335     if ( !b_can_sleek &&
336           ( (p_buffer->start_date - start_date > AOUT_PTS_TOLERANCE)
337              || (start_date - p_buffer->start_date > AOUT_PTS_TOLERANCE) ) )
338     {
339         /* Try to compensate the drift by doing some resampling. */
340         int i;
341         mtime_t difference = start_date - p_buffer->start_date;
342         msg_Warn( p_aout, "output date isn't PTS date, requesting "
343                   "resampling ("I64Fd")", difference );
344
345         vlc_mutex_lock( &p_aout->input_fifos_lock );
346         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
347         {
348             aout_fifo_t * p_fifo = &p_aout->pp_inputs[i]->fifo;
349
350             aout_FifoMoveDates( p_aout, p_fifo, difference );
351         }
352
353         aout_FifoMoveDates( p_aout, &p_aout->output.fifo, difference );
354         vlc_mutex_unlock( &p_aout->input_fifos_lock );
355     }
356
357     p_aout->output.fifo.p_first = p_buffer->p_next;
358     if ( p_buffer->p_next == NULL )
359     {
360         p_aout->output.fifo.pp_last = &p_aout->output.fifo.p_first;
361     }
362
363     vlc_mutex_unlock( &p_aout->output_fifo_lock );
364     return p_buffer;
365 }