* src/audio_output/input.c, src/audio_output/mixer.c: Fixed an annoying bug in the...
[vlc.git] / src / audio_output / mixer.c
1 /*****************************************************************************
2  * mixer.c : audio output mixing operations
3  *****************************************************************************
4  * Copyright (C) 2002 VideoLAN
5  * $Id: mixer.c,v 1.25 2003/01/26 13:37:09 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 #ifdef HAVE_ALLOCA_H
33 #   include <alloca.h>
34 #endif
35
36 #include "audio_output.h"
37 #include "aout_internal.h"
38
39 /*****************************************************************************
40  * aout_MixerNew: prepare a mixer plug-in
41  *****************************************************************************
42  * Please note that you must hold the mixer lock.
43  *****************************************************************************/
44 int aout_MixerNew( aout_instance_t * p_aout )
45 {
46     p_aout->mixer.p_module = module_Need( p_aout, "audio mixer", NULL );
47     if ( p_aout->mixer.p_module == NULL )
48     {
49         msg_Err( p_aout, "no suitable aout mixer" );
50         return -1;
51     }
52     p_aout->mixer.b_error = 0;
53     return 0;
54 }
55
56 /*****************************************************************************
57  * aout_MixerDelete: delete the mixer
58  *****************************************************************************
59  * Please note that you must hold the mixer lock.
60  *****************************************************************************/
61 void aout_MixerDelete( aout_instance_t * p_aout )
62 {
63     if ( p_aout->mixer.b_error ) return;
64     module_Unneed( p_aout, p_aout->mixer.p_module );
65     p_aout->mixer.b_error = 1;
66 }
67
68 /*****************************************************************************
69  * MixBuffer: try to prepare one output buffer
70  *****************************************************************************
71  * Please note that you must hold the mixer lock.
72  *****************************************************************************/
73 static int MixBuffer( aout_instance_t * p_aout )
74 {
75     int             i, i_first_input = 0;
76     aout_buffer_t * p_output_buffer;
77     mtime_t start_date, end_date;
78     audio_date_t exact_start_date;
79
80     if ( p_aout->mixer.b_error )
81     {
82         /* Free all incoming buffers. */
83         vlc_mutex_lock( &p_aout->input_fifos_lock );
84         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
85         {
86             aout_input_t * p_input = p_aout->pp_inputs[i];
87             aout_buffer_t * p_buffer = p_input->fifo.p_first;
88             if ( p_input->b_error ) continue;
89             while ( p_buffer != NULL )
90             {
91                 aout_buffer_t * p_next = p_buffer->p_next;
92                 aout_BufferFree( p_buffer );
93                 p_buffer = p_next;
94             }
95         }
96         vlc_mutex_unlock( &p_aout->input_fifos_lock );
97         return -1;
98     }
99
100
101     vlc_mutex_lock( &p_aout->output_fifo_lock );
102     vlc_mutex_lock( &p_aout->input_fifos_lock );
103
104     /* Retrieve the date of the next buffer. */
105     memcpy( &exact_start_date, &p_aout->output.fifo.end_date,
106             sizeof(audio_date_t) );
107     start_date = aout_DateGet( &exact_start_date );
108
109     if ( start_date != 0 && start_date < mdate() )
110     {
111         /* The output is _very_ late. This can only happen if the user
112          * pauses the stream (or if the decoder is buggy, which cannot
113          * happen :). */
114         msg_Warn( p_aout, "output PTS is out of range ("I64Fd"), clearing out",
115                   mdate() - start_date );
116         aout_FifoSet( p_aout, &p_aout->output.fifo, 0 );
117         aout_DateSet( &exact_start_date, 0 );
118         start_date = 0;
119     }
120
121     vlc_mutex_unlock( &p_aout->output_fifo_lock );
122
123     /* See if we have enough data to prepare a new buffer for the audio
124      * output. First : start date. */
125     if ( !start_date )
126     {
127         /* Find the latest start date available. */
128         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
129         {
130             aout_input_t * p_input = p_aout->pp_inputs[i];
131             aout_fifo_t * p_fifo = &p_input->fifo;
132             aout_buffer_t * p_buffer;
133
134             if ( p_input->b_error ) continue;
135
136             p_buffer = p_fifo->p_first;
137             while ( p_buffer != NULL && p_buffer->start_date < mdate() )
138             {
139                 msg_Warn( p_aout, "input PTS is out of range ("I64Fd"), "
140                           "trashing", mdate() - p_buffer->start_date );
141                 p_buffer = aout_FifoPop( p_aout, p_fifo );
142                 aout_BufferFree( p_buffer );
143                 p_buffer = p_fifo->p_first;
144                 p_input->p_first_byte_to_mix = NULL;
145             }
146
147             if ( p_buffer == NULL )
148             {
149                 break;
150             }
151
152             if ( !start_date || start_date < p_buffer->start_date )
153             {
154                 aout_DateSet( &exact_start_date, p_buffer->start_date );
155                 start_date = p_buffer->start_date;
156             }
157         }
158
159         if ( i < p_aout->i_nb_inputs )
160         {
161             /* Interrupted before the end... We can't run. */
162             vlc_mutex_unlock( &p_aout->input_fifos_lock );
163             return -1;
164         }
165     }
166     aout_DateIncrement( &exact_start_date, p_aout->output.i_nb_samples );
167     end_date = aout_DateGet( &exact_start_date );
168
169     /* Check that start_date and end_date are available for all input
170      * streams. */
171     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
172     {
173         aout_input_t * p_input = p_aout->pp_inputs[i];
174         aout_fifo_t * p_fifo = &p_input->fifo;
175         aout_buffer_t * p_buffer;
176         mtime_t prev_date;
177         vlc_bool_t b_drop_buffers;
178
179         if ( p_input->b_error )
180         {
181             if ( i_first_input == i ) i_first_input++;
182             continue;
183         }
184
185         p_buffer = p_fifo->p_first;
186         if ( p_buffer == NULL )
187         {
188             break;
189         }
190
191         /* Check for the continuity of start_date */
192         while ( p_buffer != NULL && p_buffer->end_date < start_date )
193         {
194             aout_buffer_t * p_next = p_buffer->p_next;
195             msg_Warn( p_aout, "the mixer got a packet in the past ("I64Fd")",
196                       start_date - p_buffer->end_date );
197             aout_BufferFree( p_buffer );
198             p_fifo->p_first = p_buffer = p_next;
199             p_input->p_first_byte_to_mix = NULL;
200         }
201         if ( p_buffer == NULL )
202         {
203             p_fifo->pp_last = &p_fifo->p_first;
204             break;
205         }
206
207         if ( !AOUT_FMT_NON_LINEAR( &p_aout->mixer.mixer ) )
208         {
209             /* Additionally check that p_first_byte_to_mix is well
210              * located. */
211             mtime_t i_nb_bytes = (start_date - p_buffer->start_date)
212                             * p_aout->mixer.mixer.i_bytes_per_frame
213                             * p_aout->mixer.mixer.i_rate
214                             / p_aout->mixer.mixer.i_frame_length
215                             / 1000000;
216             ptrdiff_t mixer_nb_bytes;
217
218             if ( p_input->p_first_byte_to_mix == NULL )
219             {
220                 p_input->p_first_byte_to_mix = p_buffer->p_buffer;
221             }
222             mixer_nb_bytes = p_input->p_first_byte_to_mix
223                               - p_buffer->p_buffer;
224
225             if ( !((i_nb_bytes + p_aout->mixer.mixer.i_bytes_per_frame
226                      > mixer_nb_bytes) &&
227                    (i_nb_bytes < p_aout->mixer.mixer.i_bytes_per_frame
228                      + mixer_nb_bytes)) )
229             {
230                 msg_Warn( p_aout,
231                           "mixer start isn't output start ("I64Fd,
232                           i_nb_bytes - mixer_nb_bytes );
233
234                 /* Round to the nearest multiple */
235                 i_nb_bytes /= p_aout->mixer.mixer.i_bytes_per_frame;
236                 i_nb_bytes *= p_aout->mixer.mixer.i_bytes_per_frame;
237                 p_input->p_first_byte_to_mix = p_buffer->p_buffer
238                                                 + i_nb_bytes;
239             }
240         }
241
242         /* Check that we have enough samples. */
243         for ( ; ; )
244         {
245             p_buffer = p_fifo->p_first;
246             if ( p_buffer == NULL ) break;
247             if ( p_buffer->end_date >= end_date ) break;
248
249             /* Check that all buffers are contiguous. */
250             prev_date = p_fifo->p_first->end_date;
251             p_buffer = p_buffer->p_next;
252             b_drop_buffers = 0;
253             for ( ; p_buffer != NULL; p_buffer = p_buffer->p_next )
254             {
255                 if ( prev_date != p_buffer->start_date )
256                 {
257                     msg_Warn( p_aout,
258                               "buffer hole, dropping packets ("I64Fd")",
259                               p_buffer->start_date - prev_date );
260                     b_drop_buffers = 1;
261                     break;
262                 }
263                 if ( p_buffer->end_date >= end_date ) break;
264                 prev_date = p_buffer->end_date;
265             }
266             if ( b_drop_buffers )
267             {
268                 aout_buffer_t * p_deleted = p_fifo->p_first;
269                 while ( p_deleted != NULL && p_deleted != p_buffer )
270                 {
271                     aout_buffer_t * p_next = p_deleted->p_next;
272                     aout_BufferFree( p_deleted );
273                     p_deleted = p_next;
274                 }
275                 p_fifo->p_first = p_deleted; /* == p_buffer */
276             }
277             else break;
278         }
279         if ( p_buffer == NULL ) break;
280     }
281
282     if ( i < p_aout->i_nb_inputs || i_first_input == p_aout->i_nb_inputs )
283     {
284         /* Interrupted before the end... We can't run. */
285         vlc_mutex_unlock( &p_aout->input_fifos_lock );
286         return -1;
287     }
288
289     /* Run the mixer. */
290     aout_BufferAlloc( &p_aout->mixer.output_alloc,
291                       ((uint64_t)p_aout->output.i_nb_samples * 1000000)
292                         / p_aout->output.output.i_rate,
293                       /* This is a bit kludgy, but is actually only used
294                        * for the S/PDIF dummy mixer : */
295                       p_aout->pp_inputs[i_first_input]->fifo.p_first,
296                       p_output_buffer );
297     if ( p_output_buffer == NULL )
298     {
299         msg_Err( p_aout, "out of memory" );
300         vlc_mutex_unlock( &p_aout->input_fifos_lock );
301         return -1;
302     }
303     /* This is again a bit kludgy - for the S/PDIF mixer. */
304     if ( p_aout->mixer.output_alloc.i_alloc_type != AOUT_ALLOC_NONE )
305     {
306         p_output_buffer->i_nb_samples = p_aout->output.i_nb_samples;
307         p_output_buffer->i_nb_bytes = p_aout->output.i_nb_samples
308                               * p_aout->mixer.mixer.i_bytes_per_frame
309                               / p_aout->mixer.mixer.i_frame_length;
310     }
311     p_output_buffer->start_date = start_date;
312     p_output_buffer->end_date = end_date;
313
314     p_aout->mixer.pf_do_work( p_aout, p_output_buffer );
315
316     vlc_mutex_unlock( &p_aout->input_fifos_lock );
317
318     aout_OutputPlay( p_aout, p_output_buffer );
319
320     return 0;
321 }
322
323 /*****************************************************************************
324  * aout_MixerRun: entry point for the mixer & post-filters processing
325  *****************************************************************************
326  * Please note that you must hold the mixer lock.
327  *****************************************************************************/
328 void aout_MixerRun( aout_instance_t * p_aout )
329 {
330     while( MixBuffer( p_aout ) != -1 );
331 }
332
333 /*****************************************************************************
334  * aout_MixerMultiplierSet: set p_aout->mixer.f_multiplier
335  *****************************************************************************
336  * Please note that we assume that you own the mixer lock when entering this
337  * function. This function returns -1 on error.
338  *****************************************************************************/
339 int aout_MixerMultiplierSet( aout_instance_t * p_aout, float f_multiplier )
340 {
341     float f_old = p_aout->mixer.f_multiplier;
342     vlc_bool_t b_new_mixer = 0;
343
344     if ( !p_aout->mixer.b_error )
345     {
346         aout_MixerDelete( p_aout );
347         b_new_mixer = 1;
348     }
349
350     p_aout->mixer.f_multiplier = f_multiplier;
351
352     if ( b_new_mixer && aout_MixerNew( p_aout ) )
353     {
354         p_aout->mixer.f_multiplier = f_old;
355         aout_MixerNew( p_aout );
356         return -1;
357     }
358
359     return 0;
360 }
361
362 /*****************************************************************************
363  * aout_MixerMultiplierGet: get p_aout->mixer.f_multiplier
364  *****************************************************************************
365  * Please note that we assume that you own the mixer lock when entering this
366  * function. This function returns -1 on error.
367  *****************************************************************************/
368 int aout_MixerMultiplierGet( aout_instance_t * p_aout, float * pf_multiplier )
369 {
370     *pf_multiplier = p_aout->mixer.f_multiplier;
371     return 0;
372 }
373