Add warning if people try using an unimplemented aout function (zorglub!!!). This...
[vlc.git] / src / audio_output / dec.c
1 /*****************************************************************************
2  * dec.c : audio output API towards decoders
3  *****************************************************************************
4  * Copyright (C) 2002-2007 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 <vlc/vlc.h>
28
29 #ifdef HAVE_ALLOCA_H
30 #   include <alloca.h>
31 #endif
32
33 #include <vlc_aout.h>
34 #include <vlc_input.h>
35
36 #include "aout_internal.h"
37
38 /** FIXME: Ugly but needed to access the counters */
39 #include "input/input_internal.h"
40
41 /*****************************************************************************
42  * aout_DecNew : create a decoder
43  *****************************************************************************/
44 static aout_input_t * DecNew( vlc_object_t * p_this, aout_instance_t * p_aout,
45                               audio_sample_format_t *p_format,
46                               audio_replay_gain_t *p_replay_gain )
47 {
48     aout_input_t * p_input;
49     input_thread_t * p_input_thread;
50     vlc_value_t val;
51
52     /* Sanitize audio format */
53     if( p_format->i_channels > 32 )
54     {
55         msg_Err( p_aout, "too many audio channels (%u)",
56                  p_format->i_channels );
57         goto error;
58     }
59
60     if( p_format->i_rate > 192000 )
61     {
62         msg_Err( p_aout, "excessive audio sample frequency (%u)",
63                  p_format->i_rate );
64         goto error;
65     }
66
67     /* We can only be called by the decoder, so no need to lock
68      * p_input->lock. */
69     vlc_mutex_lock( &p_aout->mixer_lock );
70
71     if ( p_aout->i_nb_inputs >= AOUT_MAX_INPUTS )
72     {
73         msg_Err( p_aout, "too many inputs already (%d)", p_aout->i_nb_inputs );
74         goto error;
75     }
76
77     p_input = malloc(sizeof(aout_input_t));
78     if ( p_input == NULL )
79     {
80         msg_Err( p_aout, "out of memory" );
81         goto error;
82     }
83     memset( p_input, 0, sizeof(aout_input_t) );
84
85     vlc_mutex_init( p_aout, &p_input->lock );
86
87     p_input->b_changed = 0;
88     p_input->b_error = 1;
89
90     aout_FormatPrepare( p_format );
91
92     memcpy( &p_input->input, p_format,
93             sizeof(audio_sample_format_t) );
94     if( p_replay_gain )
95         p_input->replay_gain = *p_replay_gain;
96
97     p_aout->pp_inputs[p_aout->i_nb_inputs] = p_input;
98     p_aout->i_nb_inputs++;
99
100     if ( p_aout->mixer.b_error )
101     {
102         int i;
103
104         var_Destroy( p_aout, "audio-device" );
105         var_Destroy( p_aout, "audio-channels" );
106
107         /* Recreate the output using the new format. */
108         if ( aout_OutputNew( p_aout, p_format ) < 0 )
109         {
110             for ( i = 0; i < p_aout->i_nb_inputs - 1; i++ )
111             {
112                 vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
113                 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
114                 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
115             }
116             vlc_mutex_unlock( &p_aout->mixer_lock );
117             return p_input;
118         }
119
120         /* Create other input streams. */
121         for ( i = 0; i < p_aout->i_nb_inputs - 1; i++ )
122         {
123             vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
124             aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
125             aout_InputNew( p_aout, p_aout->pp_inputs[i] );
126             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
127         }
128     }
129     else
130     {
131         aout_MixerDelete( p_aout );
132     }
133
134     if ( aout_MixerNew( p_aout ) == -1 )
135     {
136         aout_OutputDelete( p_aout );
137         goto error;
138     }
139
140     aout_InputNew( p_aout, p_input );
141
142     vlc_mutex_unlock( &p_aout->mixer_lock );
143     p_input->i_desync = var_CreateGet( p_this, "audio-desync" ) * 1000;
144
145     p_input_thread = (input_thread_t *)vlc_object_find( p_this,
146                                            VLC_OBJECT_INPUT, FIND_PARENT );
147     if( p_input_thread )
148     {
149         p_input->i_pts_delay = p_input_thread->i_pts_delay;
150         p_input->i_pts_delay += p_input->i_desync;
151         p_input->p_input_thread = p_input_thread;
152         vlc_object_release( p_input_thread );
153     }
154     else
155     {
156         p_input->i_pts_delay = DEFAULT_PTS_DELAY;
157         p_input->i_pts_delay += p_input->i_desync;
158         p_input->p_input_thread = NULL;
159     }
160
161     return p_input;
162
163 error:
164     vlc_mutex_unlock( &p_aout->mixer_lock );
165     return NULL;
166 }
167
168 aout_input_t * __aout_DecNew( vlc_object_t * p_this,
169                               aout_instance_t ** pp_aout,
170                               audio_sample_format_t * p_format,
171                               audio_replay_gain_t *p_replay_gain )
172 {
173     if ( *pp_aout == NULL )
174     {
175         /* Create an audio output if there is none. */
176         *pp_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT, FIND_ANYWHERE );
177
178         if( *pp_aout == NULL )
179         {
180             msg_Dbg( p_this, "no aout present, spawning one" );
181
182             *pp_aout = aout_New( p_this );
183             /* Everything failed, I'm a loser, I just wanna die */
184             if( *pp_aout == NULL )
185             {
186                 return NULL;
187             }
188             vlc_object_attach( *pp_aout, p_this->p_libvlc );
189         }
190         else
191         {
192             vlc_object_release( *pp_aout );
193         }
194     }
195
196     return DecNew( p_this, *pp_aout, p_format, p_replay_gain );
197 }
198
199 /*****************************************************************************
200  * aout_DecDelete : delete a decoder
201  *****************************************************************************/
202 int aout_DecDelete( aout_instance_t * p_aout, aout_input_t * p_input )
203 {
204     int i_input;
205
206     /* This function can only be called by the decoder itself, so no need
207      * to lock p_input->lock. */
208     vlc_mutex_lock( &p_aout->mixer_lock );
209
210     for ( i_input = 0; i_input < p_aout->i_nb_inputs; i_input++ )
211     {
212         if ( p_aout->pp_inputs[i_input] == p_input )
213         {
214             break;
215         }
216     }
217
218     if ( i_input == p_aout->i_nb_inputs )
219     {
220         msg_Err( p_aout, "cannot find an input to delete" );
221         return -1;
222     }
223
224     /* Remove the input from the list. */
225     memmove( &p_aout->pp_inputs[i_input], &p_aout->pp_inputs[i_input + 1],
226              (AOUT_MAX_INPUTS - i_input - 1) * sizeof(aout_input_t *) );
227     p_aout->i_nb_inputs--;
228
229     aout_InputDelete( p_aout, p_input );
230
231     vlc_mutex_destroy( &p_input->lock );
232     free( p_input );
233
234     if ( !p_aout->i_nb_inputs )
235     {
236         aout_OutputDelete( p_aout );
237         aout_MixerDelete( p_aout );
238         if ( var_Type( p_aout, "audio-device" ) != 0 )
239         {
240             var_Destroy( p_aout, "audio-device" );
241         }
242         if ( var_Type( p_aout, "audio-channels" ) != 0 )
243         {
244             var_Destroy( p_aout, "audio-channels" );
245         }
246     }
247
248     vlc_mutex_unlock( &p_aout->mixer_lock );
249
250     return 0;
251 }
252
253
254 /*
255  * Buffer management
256  */
257
258 /*****************************************************************************
259  * aout_DecNewBuffer : ask for a new empty buffer
260  *****************************************************************************/
261 aout_buffer_t * aout_DecNewBuffer( aout_instance_t * p_aout,
262                                    aout_input_t * p_input,
263                                    size_t i_nb_samples )
264 {
265     aout_buffer_t * p_buffer;
266     mtime_t duration;
267
268     vlc_mutex_lock( &p_input->lock );
269
270     if ( p_input->b_error )
271     {
272         vlc_mutex_unlock( &p_input->lock );
273         return NULL;
274     }
275
276     duration = (1000000 * (mtime_t)i_nb_samples) / p_input->input.i_rate;
277
278     /* This necessarily allocates in the heap. */
279     aout_BufferAlloc( &p_input->input_alloc, duration, NULL, p_buffer );
280     if( p_buffer != NULL )
281         p_buffer->i_nb_bytes = i_nb_samples * p_input->input.i_bytes_per_frame
282                                   / p_input->input.i_frame_length;
283
284     /* Suppose the decoder doesn't have more than one buffered buffer */
285     p_input->b_changed = 0;
286
287     vlc_mutex_unlock( &p_input->lock );
288
289     if( p_buffer == NULL )
290         return NULL;
291
292     p_buffer->i_nb_samples = i_nb_samples;
293     p_buffer->start_date = p_buffer->end_date = 0;
294     return p_buffer;
295 }
296
297 /*****************************************************************************
298  * aout_DecDeleteBuffer : destroy an undecoded buffer
299  *****************************************************************************/
300 void aout_DecDeleteBuffer( aout_instance_t * p_aout, aout_input_t * p_input,
301                            aout_buffer_t * p_buffer )
302 {
303     (void)p_aout; (void)p_input;
304     aout_BufferFree( p_buffer );
305 }
306
307 /*****************************************************************************
308  * aout_DecPlay : filter & mix the decoded buffer
309  *****************************************************************************/
310 int aout_DecPlay( aout_instance_t * p_aout, aout_input_t * p_input,
311                   aout_buffer_t * p_buffer, int i_input_rate )
312 {
313     if ( p_buffer->start_date == 0 )
314     {
315         msg_Warn( p_aout, "non-dated buffer received" );
316         aout_BufferFree( p_buffer );
317         return -1;
318     }
319
320     if( i_input_rate > INPUT_RATE_DEFAULT * AOUT_MAX_INPUT_RATE ||
321         i_input_rate < INPUT_RATE_DEFAULT / AOUT_MAX_INPUT_RATE )
322     {
323         aout_BufferFree( p_buffer );
324         return 0;
325     }
326
327     /* Apply the desynchronisation requested by the user */
328     p_buffer->start_date += p_input->i_desync;
329     p_buffer->end_date += p_input->i_desync;
330
331     if ( p_buffer->start_date > mdate() + p_input->i_pts_delay +
332          AOUT_MAX_ADVANCE_TIME )
333     {
334         msg_Warn( p_aout, "received buffer in the future ("I64Fd")",
335                   p_buffer->start_date - mdate());
336         if( p_input->p_input_thread )
337         {
338             vlc_mutex_lock( &p_input->p_input_thread->p->counters.counters_lock);
339             stats_UpdateInteger( p_aout,
340                            p_input->p_input_thread->p->counters.p_lost_abuffers,
341                            1, NULL );
342             vlc_mutex_unlock( &p_input->p_input_thread->p->counters.counters_lock);
343         }
344         aout_BufferFree( p_buffer );
345         return -1;
346     }
347
348     p_buffer->end_date = p_buffer->start_date
349                             + (mtime_t)p_buffer->i_nb_samples * 1000000
350                                 / p_input->input.i_rate;
351
352     vlc_mutex_lock( &p_input->lock );
353
354     if ( p_input->b_error )
355     {
356         vlc_mutex_unlock( &p_input->lock );
357         aout_BufferFree( p_buffer );
358         return -1;
359     }
360
361     if ( p_input->b_changed )
362     {
363         /* Maybe the allocation size has changed. Re-allocate a buffer. */
364         aout_buffer_t * p_new_buffer;
365         mtime_t duration = (1000000 * (mtime_t)p_buffer->i_nb_samples)
366                             / p_input->input.i_rate;
367
368         aout_BufferAlloc( &p_input->input_alloc, duration, NULL, p_new_buffer );
369         p_aout->p_libvlc->pf_memcpy( p_new_buffer->p_buffer, p_buffer->p_buffer,
370                                   p_buffer->i_nb_bytes );
371         p_new_buffer->i_nb_samples = p_buffer->i_nb_samples;
372         p_new_buffer->i_nb_bytes = p_buffer->i_nb_bytes;
373         p_new_buffer->start_date = p_buffer->start_date;
374         p_new_buffer->end_date = p_buffer->end_date;
375         aout_BufferFree( p_buffer );
376         p_buffer = p_new_buffer;
377         p_input->b_changed = 0;
378     }
379
380     /* If the buffer is too early, wait a while. */
381     mwait( p_buffer->start_date - AOUT_MAX_PREPARE_TIME );
382
383     if ( aout_InputPlay( p_aout, p_input, p_buffer, i_input_rate ) == -1 )
384     {
385         vlc_mutex_unlock( &p_input->lock );
386         return -1;
387     }
388
389     vlc_mutex_unlock( &p_input->lock );
390
391     /* Run the mixer if it is able to run. */
392     vlc_mutex_lock( &p_aout->mixer_lock );
393     aout_MixerRun( p_aout );
394     if( p_input->p_input_thread )
395     {
396         vlc_mutex_lock( &p_input->p_input_thread->p->counters.counters_lock);
397         stats_UpdateInteger( p_aout,
398                              p_input->p_input_thread->p->counters.p_played_abuffers,
399                              1, NULL );
400         vlc_mutex_unlock( &p_input->p_input_thread->p->counters.counters_lock);
401     }
402     vlc_mutex_unlock( &p_aout->mixer_lock );
403
404     return 0;
405 }