Big round of fixes in the aout3.
[vlc.git] / src / audio_output / audio_output.c
1 /*****************************************************************************
2  * audio_output.c : audio output instance miscellaneous functions
3  *****************************************************************************
4  * Copyright (C) 2002 VideoLAN
5  * $Id: audio_output.c,v 1.99 2002/08/21 22:41:59 massiot 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  * Instances management (see also input.c:aout_InputNew())
41  */
42
43 /*****************************************************************************
44  * aout_NewInstance: initialize aout structure
45  *****************************************************************************/
46 aout_instance_t * __aout_NewInstance( vlc_object_t * p_parent )
47 {
48     aout_instance_t * p_aout;
49
50     /* Allocate descriptor. */
51     p_aout = vlc_object_create( p_parent, VLC_OBJECT_AOUT );
52     if( p_aout == NULL )
53     {
54         return NULL;
55     }
56
57     /* Initialize members. */
58     vlc_mutex_init( p_parent, &p_aout->input_lock );
59     vlc_cond_init( p_parent, &p_aout->input_signal );
60     p_aout->i_inputs_active = 0;
61     p_aout->b_change_requested = 0;
62     p_aout->i_nb_inputs = 0;
63
64     vlc_mutex_init( p_parent, &p_aout->mixer_lock );
65
66     vlc_object_attach( p_aout, p_parent->p_vlc );
67
68     return p_aout;
69 }
70
71 /*****************************************************************************
72  * aout_DeleteInstance: destroy aout structure
73  *****************************************************************************/
74 void aout_DeleteInstance( aout_instance_t * p_aout )
75 {
76     vlc_mutex_destroy( &p_aout->input_lock );
77     vlc_cond_destroy( &p_aout->input_signal );
78     vlc_mutex_destroy( &p_aout->mixer_lock );
79
80     /* Free structure. */
81     vlc_object_destroy( p_aout );
82 }
83
84
85 /*
86  * Buffer management (interface to the decoders)
87  */
88
89 /*****************************************************************************
90  * aout_BufferNew : ask for a new empty buffer
91  *****************************************************************************/
92 aout_buffer_t * aout_BufferNew( aout_instance_t * p_aout,
93                                 aout_input_t * p_input,
94                                 size_t i_nb_samples )
95 {
96     aout_buffer_t * p_buffer;
97     mtime_t duration = (1000000 * (mtime_t)i_nb_samples)
98                         / p_input->input.i_rate;
99
100     /* This necessarily allocates in the heap. */
101     aout_BufferAlloc( &p_input->input_alloc, duration, NULL, p_buffer );
102     p_buffer->i_nb_samples = i_nb_samples;
103     p_buffer->i_nb_bytes = i_nb_samples * p_input->input.i_bytes_per_frame
104                               / p_input->input.i_frame_length;
105
106     if ( p_buffer == NULL )
107     {
108         msg_Err( p_aout, "NULL buffer !" );
109     }
110     else
111     {
112         p_buffer->start_date = p_buffer->end_date = 0;
113     }
114
115     return p_buffer;
116 }
117
118 /*****************************************************************************
119  * aout_BufferDelete : destroy an undecoded buffer
120  *****************************************************************************/
121 void aout_BufferDelete( aout_instance_t * p_aout, aout_input_t * p_input,
122                         aout_buffer_t * p_buffer )
123 {
124     aout_BufferFree( p_buffer );
125 }
126
127 /*****************************************************************************
128  * aout_BufferPlay : filter & mix the decoded buffer
129  *****************************************************************************/
130 void aout_BufferPlay( aout_instance_t * p_aout, aout_input_t * p_input,
131                       aout_buffer_t * p_buffer )
132 {
133     if ( p_buffer->start_date == 0 )
134     {
135         msg_Warn( p_aout, "non-dated buffer received" );
136         aout_BufferFree( p_buffer );
137     }
138     else
139     {
140         p_buffer->end_date = p_buffer->start_date
141                                 + (mtime_t)(p_buffer->i_nb_samples * 1000000)
142                                     / p_input->input.i_rate;
143     }
144
145     /* If the buffer is too early, wait a while. */
146     mwait( p_buffer->start_date - AOUT_MAX_PREPARE_TIME );
147
148     aout_InputPlay( p_aout, p_input, p_buffer );
149
150     /* Run the mixer if it is able to run. */
151     aout_MixerRun( p_aout );
152 }
153
154
155 /*
156  * Formats management (internal)
157  */
158
159 /*****************************************************************************
160  * aout_FormatPrepare : compute the number of bytes per frame & frame length
161  *****************************************************************************/
162 void aout_FormatPrepare( audio_sample_format_t * p_format )
163 {
164     int i_result;
165
166     switch ( p_format->i_format )
167     {
168     case AOUT_FMT_U8:
169     case AOUT_FMT_S8:
170         i_result = 1;
171         break;
172
173     case AOUT_FMT_U16_LE:
174     case AOUT_FMT_U16_BE:
175     case AOUT_FMT_S16_LE:
176     case AOUT_FMT_S16_BE:
177         i_result = 2;
178         break;
179
180     case AOUT_FMT_FLOAT32:
181     case AOUT_FMT_FIXED32:
182         i_result = 4;
183         break;
184
185     case AOUT_FMT_SPDIF:
186     case AOUT_FMT_A52:
187     case AOUT_FMT_DTS:
188         /* For these formats the caller has to indicate the parameters
189          * by hand. */
190         return;
191
192     default:
193         i_result = 0; /* will segfault much sooner... */
194     }
195
196     p_format->i_bytes_per_frame = i_result * p_format->i_channels;
197     p_format->i_frame_length = 1;
198 }
199
200
201 /*
202  * FIFO management (internal) - please understand that solving race conditions
203  * is _your_ job, ie. in the audio output you should own the mixer lock
204  * before calling any of these functions.
205  */
206
207 /*****************************************************************************
208  * aout_FifoInit : initialize the members of a FIFO
209  *****************************************************************************/
210 void aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
211                     u32 i_rate )
212 {
213     p_fifo->p_first = NULL;
214     p_fifo->pp_last = &p_fifo->p_first;
215     aout_DateInit( &p_fifo->end_date, i_rate );
216 }
217
218 /*****************************************************************************
219  * aout_FifoPush : push a packet into the FIFO
220  *****************************************************************************/
221 void aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
222                     aout_buffer_t * p_buffer )
223 {
224     *p_fifo->pp_last = p_buffer;
225     p_fifo->pp_last = &p_buffer->p_next;
226     *p_fifo->pp_last = NULL;
227     /* Enforce the continuity of the stream. */
228     if ( aout_DateGet( &p_fifo->end_date ) )
229     {
230         p_buffer->start_date = aout_DateGet( &p_fifo->end_date );
231         p_buffer->end_date = aout_DateIncrement( &p_fifo->end_date,
232                                                  p_buffer->i_nb_samples ); 
233     }
234     else
235     {
236         aout_DateSet( &p_fifo->end_date, p_buffer->end_date );
237     }
238 }
239
240 /*****************************************************************************
241  * aout_FifoSet : set end_date and trash all buffers (because they aren't
242  * properly dated)
243  *****************************************************************************/
244 void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
245                    mtime_t date )
246 {
247     aout_buffer_t * p_buffer;
248
249     aout_DateSet( &p_fifo->end_date, date );
250     p_buffer = p_fifo->p_first;
251     while ( p_buffer != NULL )
252     {
253         aout_buffer_t * p_next = p_buffer->p_next;
254         aout_BufferFree( p_buffer );
255         p_buffer = p_next;
256     }
257     p_fifo->p_first = NULL;
258     p_fifo->pp_last = &p_fifo->p_first;
259 }
260
261 /*****************************************************************************
262  * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
263  *****************************************************************************/
264 void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
265                          mtime_t difference )
266 {
267     aout_buffer_t * p_buffer;
268
269     aout_DateMove( &p_fifo->end_date, difference );
270     p_buffer = p_fifo->p_first;
271     while ( p_buffer != NULL )
272     {
273         p_buffer->start_date += difference;
274         p_buffer->end_date += difference;
275         p_buffer = p_buffer->p_next;
276     }
277 }
278
279 /*****************************************************************************
280  * aout_FifoNextStart : return the current end_date
281  *****************************************************************************/
282 mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
283 {
284     return aout_DateGet( &p_fifo->end_date );
285 }
286
287 /*****************************************************************************
288  * aout_FifoPop : get the next buffer out of the FIFO
289  *****************************************************************************/
290 aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
291 {
292     aout_buffer_t * p_buffer;
293     p_buffer = p_fifo->p_first;
294     if ( p_buffer == NULL ) return NULL;
295     p_fifo->p_first = p_buffer->p_next;
296     if ( p_fifo->p_first == NULL )
297     {
298         p_fifo->pp_last = &p_fifo->p_first;
299     }
300
301     return p_buffer;
302 }
303
304 /*****************************************************************************
305  * aout_FifoDestroy : destroy a FIFO and its buffers
306  *****************************************************************************/
307 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
308 {
309     aout_buffer_t * p_buffer;
310
311     p_buffer = p_fifo->p_first;
312     while ( p_buffer != NULL )
313     {
314         aout_buffer_t * p_next = p_buffer->p_next;
315         aout_BufferFree( p_buffer );
316         p_buffer = p_next;
317     }
318 }
319
320
321 /*
322  * Date management (internal and external)
323  */
324
325 /*****************************************************************************
326  * aout_DateInit : set the divider of an audio_date_t
327  *****************************************************************************/
328 void aout_DateInit( audio_date_t * p_date, u32 i_divider )
329 {
330     p_date->date = 0;
331     p_date->i_divider = i_divider;
332     p_date->i_remainder = 0;
333 }
334
335 /*****************************************************************************
336  * aout_DateSet : set the date of an audio_date_t
337  *****************************************************************************/
338 void aout_DateSet( audio_date_t * p_date, mtime_t new_date )
339 {
340     p_date->date = new_date;
341     p_date->i_remainder = 0;
342 }
343
344 /*****************************************************************************
345  * aout_DateMove : move forwards or backwards the date of an audio_date_t
346  *****************************************************************************/
347 void aout_DateMove( audio_date_t * p_date, mtime_t difference )
348 {
349     p_date->date += difference;
350 }
351
352 /*****************************************************************************
353  * aout_DateGet : get the date of an audio_date_t
354  *****************************************************************************/
355 mtime_t aout_DateGet( const audio_date_t * p_date )
356 {
357     return p_date->date;
358 }
359
360 /*****************************************************************************
361  * aout_DateIncrement : increment the date and return the result, taking
362  * into account rounding errors
363  *****************************************************************************/
364 mtime_t aout_DateIncrement( audio_date_t * p_date, u32 i_nb_samples )
365 {
366     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
367     p_date->date += i_dividend / p_date->i_divider;
368     p_date->i_remainder += i_dividend % p_date->i_divider;
369     if ( p_date->i_remainder >= p_date->i_divider )
370     {
371         /* This is Bresenham algorithm. */
372         p_date->date++;
373         p_date->i_remainder -= p_date->i_divider;
374     }
375     return p_date->date;
376 }
377