cf55934e40d4085608cfe85ac033c11c836a1ca4
[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 VideoLAN
5  * $Id: output.c,v 1.26 2002/12/07 15:25:27 gbazin Exp $
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     char * psz_name = config_GetPsz( p_aout, "aout" );
45     int i_rate = config_GetInt( p_aout, "aout-rate" );
46
47     memcpy( &p_aout->output.output, p_format, sizeof(audio_sample_format_t) );
48     if ( i_rate != -1 )
49         p_aout->output.output.i_rate = i_rate;
50     aout_FormatPrepare( &p_aout->output.output );
51
52     vlc_mutex_lock( &p_aout->output_fifo_lock );
53
54     /* Find the best output plug-in. */
55     p_aout->output.p_module = module_Need( p_aout, "audio output",
56                                            psz_name );
57     if ( psz_name != NULL ) free( psz_name );
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_STRING | VLC_VAR_HASCHOICE) )
67     {
68         /* The user may have selected a different channels configuration. */
69         vlc_value_t val;
70         var_Get( p_aout, "audio-channels", &val );
71
72         if ( !strcmp( val.psz_string, N_("Both") ) )
73         {
74             p_aout->output.output.i_original_channels =
75                 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
76         }
77         else if ( !strcmp( val.psz_string, N_("Left") ) )
78         {
79             p_aout->output.output.i_original_channels = AOUT_CHAN_LEFT;
80         }
81         else if ( !strcmp( val.psz_string, N_("Right") ) )
82         {
83             p_aout->output.output.i_original_channels = AOUT_CHAN_RIGHT;
84         }
85         else if ( !strcmp( val.psz_string, N_("Dolby Surround") ) )
86         {
87             p_aout->output.output.i_original_channels
88                 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_DOLBYSTEREO;
89         }
90         free( val.psz_string );
91     }
92     else if ( p_aout->output.output.i_physical_channels == AOUT_CHAN_CENTER )
93     {
94         /* Mono - create the audio-channels variable. */
95         vlc_value_t val;
96         var_Create( p_aout, "audio-channels", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
97         if ( p_aout->output.output.i_original_channels & AOUT_CHAN_DUALMONO )
98         {
99             /* Go directly to the left channel. */
100             p_aout->output.output.i_original_channels = AOUT_CHAN_LEFT;
101         }
102         else
103         {
104             val.psz_string = N_("Both");
105             var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val );
106         }
107         val.psz_string = N_("Left");
108         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val );
109         val.psz_string = N_("Right");
110         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val );
111         var_AddCallback( p_aout, "audio-channels", aout_ChannelsRestart,
112                          NULL );
113     }
114     else if ( p_aout->output.output.i_physical_channels ==
115                  (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)
116               && p_aout->output.output.i_original_channels ==
117                  (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT) )
118     {
119         /* Stereo - create the audio-channels variable. */
120         vlc_value_t val;
121         var_Create( p_aout, "audio-channels", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
122         val.psz_string = N_("Both");
123         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val );
124         val.psz_string = N_("Left");
125         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val );
126         val.psz_string = N_("Right");
127         var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val );
128         if ( p_aout->output.output.i_original_channels & AOUT_CHAN_DOLBYSTEREO )
129         {
130             val.psz_string = N_("Dolby Surround");
131             var_Change( p_aout, "audio-channels", VLC_VAR_ADDCHOICE, &val );
132         }
133         p_aout->output.output.i_original_channels &= ~AOUT_CHAN_DOLBYSTEREO;
134         var_AddCallback( p_aout, "audio-channels", aout_ChannelsRestart,
135                          NULL );
136     }
137
138     aout_FormatPrepare( &p_aout->output.output );
139
140     /* Prepare FIFO. */
141     aout_FifoInit( p_aout, &p_aout->output.fifo,
142                    p_aout->output.output.i_rate );
143
144     vlc_mutex_unlock( &p_aout->output_fifo_lock );
145
146     aout_FormatPrint( p_aout, "output", &p_aout->output.output );
147
148     /* Calculate the resulting mixer output format. */
149     memcpy( &p_aout->mixer.mixer, &p_aout->output.output,
150             sizeof(audio_sample_format_t) );
151     if ( !AOUT_FMT_NON_LINEAR(&p_aout->output.output) )
152     {
153         /* Non-S/PDIF mixer only deals with float32 or fixed32. */
154         p_aout->mixer.mixer.i_format
155                      = (p_aout->p_libvlc->i_cpu & CPU_CAPABILITY_FPU) ?
156                         VLC_FOURCC('f','l','3','2') :
157                         VLC_FOURCC('f','i','3','2');
158         aout_FormatPrepare( &p_aout->mixer.mixer );
159     }
160     else
161     {
162         p_aout->mixer.mixer.i_format = p_format->i_format;
163     }
164
165     aout_FormatPrint( p_aout, "mixer", &p_aout->output.output );
166
167     /* Create filters. */
168     if ( aout_FiltersCreatePipeline( p_aout, p_aout->output.pp_filters,
169                                      &p_aout->output.i_nb_filters,
170                                      &p_aout->mixer.mixer,
171                                      &p_aout->output.output ) < 0 )
172     {
173         msg_Err( p_aout, "couldn't set an output pipeline" );
174         module_Unneed( p_aout, p_aout->output.p_module );
175         return -1;
176     }
177
178     /* Prepare hints for the buffer allocator. */
179     p_aout->mixer.output_alloc.i_alloc_type = AOUT_ALLOC_HEAP;
180     p_aout->mixer.output_alloc.i_bytes_per_sec
181                         = p_aout->mixer.mixer.i_bytes_per_frame
182                            * p_aout->mixer.mixer.i_rate
183                            / p_aout->mixer.mixer.i_frame_length;
184
185     aout_FiltersHintBuffers( p_aout, p_aout->output.pp_filters,
186                              p_aout->output.i_nb_filters,
187                              &p_aout->mixer.output_alloc );
188
189     return 0;
190 }
191
192 /*****************************************************************************
193  * aout_OutputDelete : delete the output
194  *****************************************************************************
195  * This function is entered with the mixer lock.
196  *****************************************************************************/
197 void aout_OutputDelete( aout_instance_t * p_aout )
198 {
199     module_Unneed( p_aout, p_aout->output.p_module );
200
201     aout_FiltersDestroyPipeline( p_aout, p_aout->output.pp_filters,
202                                  p_aout->output.i_nb_filters );
203     aout_FifoDestroy( p_aout, &p_aout->output.fifo );
204 }
205
206 /*****************************************************************************
207  * aout_OutputPlay : play a buffer
208  *****************************************************************************
209  * This function is entered with the mixer lock.
210  *****************************************************************************/
211 void aout_OutputPlay( aout_instance_t * p_aout, aout_buffer_t * p_buffer )
212 {
213     aout_FiltersPlay( p_aout, p_aout->output.pp_filters,
214                       p_aout->output.i_nb_filters,
215                       &p_buffer );
216
217     vlc_mutex_lock( &p_aout->output_fifo_lock );
218     aout_FifoPush( p_aout, &p_aout->output.fifo, p_buffer );
219     p_aout->output.pf_play( p_aout );
220     vlc_mutex_unlock( &p_aout->output_fifo_lock );
221 }
222
223 /*****************************************************************************
224  * aout_OutputNextBuffer : give the audio output plug-in the right buffer
225  *****************************************************************************
226  * If b_can_sleek is 1, the aout core functions won't try to resample
227  * new buffers to catch up - that is we suppose that the output plug-in can
228  * compensate it by itself. S/PDIF outputs should always set b_can_sleek = 1.
229  * This function is entered with no lock at all :-).
230  *****************************************************************************/
231 aout_buffer_t * aout_OutputNextBuffer( aout_instance_t * p_aout,
232                                        mtime_t start_date,
233                                        vlc_bool_t b_can_sleek )
234 {
235     aout_buffer_t * p_buffer;
236
237     vlc_mutex_lock( &p_aout->output_fifo_lock );
238
239     p_buffer = p_aout->output.fifo.p_first;
240     while ( p_buffer && p_buffer->start_date < mdate() )
241     {
242         msg_Dbg( p_aout, "audio output is too slow ("I64Fd"), "
243                  "trashing "I64Fd"us", mdate() - p_buffer->start_date,
244                  p_buffer->end_date - p_buffer->start_date );
245         p_buffer = p_buffer->p_next;
246     }
247
248     p_aout->output.fifo.p_first = p_buffer;
249     if ( p_buffer == NULL )
250     {
251         p_aout->output.fifo.pp_last = &p_aout->output.fifo.p_first;
252
253 #if 0 /* This is bad because the audio output might just be trying to fill
254        * in it's internal buffers. And anyway, it's up to the audio output
255        * to deal with this kind of starvation. */
256
257         /* Set date to 0, to allow the mixer to send a new buffer ASAP */
258         aout_FifoSet( p_aout, &p_aout->output.fifo, 0 );
259         if ( !p_aout->output.b_starving )
260             msg_Dbg( p_aout,
261                  "audio output is starving (no input), playing silence" );
262         p_aout->output.b_starving = 1;
263 #endif
264
265         vlc_mutex_unlock( &p_aout->output_fifo_lock );
266         return NULL;
267     }
268
269     /* Here we suppose that all buffers have the same duration - this is
270      * generally true, and anyway if it's wrong it won't be a disaster. */
271     if ( p_buffer->start_date > start_date
272                          + (p_buffer->end_date - p_buffer->start_date) )
273     {
274         vlc_mutex_unlock( &p_aout->output_fifo_lock );
275         if ( !p_aout->output.b_starving )
276             msg_Dbg( p_aout, "audio output is starving ("I64Fd"), "
277                      "playing silence", p_buffer->start_date - start_date );
278         p_aout->output.b_starving = 1;
279         return NULL;
280     }
281
282     p_aout->output.b_starving = 0;
283
284     if ( !b_can_sleek &&
285           ( (p_buffer->start_date - start_date > AOUT_PTS_TOLERANCE)
286              || (start_date - p_buffer->start_date > AOUT_PTS_TOLERANCE) ) )
287     {
288         /* Try to compensate the drift by doing some resampling. */
289         int i;
290         mtime_t difference = start_date - p_buffer->start_date;
291         msg_Warn( p_aout, "output date isn't PTS date, requesting "
292                   "resampling ("I64Fd")", difference );
293
294         vlc_mutex_lock( &p_aout->input_fifos_lock );
295         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
296         {
297             aout_fifo_t * p_fifo = &p_aout->pp_inputs[i]->fifo;
298
299             aout_FifoMoveDates( p_aout, p_fifo, difference );
300         }
301
302         aout_FifoMoveDates( p_aout, &p_aout->output.fifo, difference );
303         vlc_mutex_unlock( &p_aout->input_fifos_lock );
304     }
305
306     p_aout->output.fifo.p_first = p_buffer->p_next;
307     if ( p_buffer->p_next == NULL )
308     {
309         p_aout->output.fifo.pp_last = &p_aout->output.fifo.p_first;
310     }
311
312     vlc_mutex_unlock( &p_aout->output_fifo_lock );
313     return p_buffer;
314 }