- better communication between audio decoder and output: aout plugins
[vlc.git] / src / audio_output / audio_output.c
1 /*****************************************************************************
2  * audio_output.c : audio output thread
3  *****************************************************************************
4  * Copyright (C) 1999-2001 VideoLAN
5  * $Id: audio_output.c,v 1.70 2002/01/09 00:33:37 asmax Exp $
6  *
7  * Authors: Michel Kaempf <maxx@via.ecp.fr>
8  *          Cyril Deguet <asmax@via.ecp.fr>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  * 
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28 #include <stdio.h>                                           /* "intf_msg.h" */
29 #include <stdlib.h>                            /* calloc(), malloc(), free() */
30 #include <string.h>
31
32 #include <videolan/vlc.h>
33
34 #ifdef HAVE_UNISTD_H
35 #   include <unistd.h>                                           /* getpid() */
36 #endif
37
38 #ifdef WIN32                   /* getpid() for win32 is located in process.h */
39 #   include <process.h>
40 #endif
41
42 #include "audio_output.h"
43 #include "aout_common.h"
44
45 /*****************************************************************************
46  * Local prototypes
47  *****************************************************************************/
48 static int aout_SpawnThread( aout_thread_t * p_aout );
49
50 /*****************************************************************************
51  * aout_InitBank: initialize the audio output bank.
52  *****************************************************************************/
53 void aout_InitBank ( void )
54 {
55     p_aout_bank->i_count = 0;
56
57     vlc_mutex_init( &p_aout_bank->lock );
58 }
59
60 /*****************************************************************************
61  * aout_EndBank: empty the audio output bank.
62  *****************************************************************************
63  * This function ends all unused audio outputs and empties the bank in
64  * case of success.
65  *****************************************************************************/
66 void aout_EndBank ( void )
67 {
68     /* Ask all remaining audio outputs to die */
69     while( p_aout_bank->i_count )
70     {
71         aout_DestroyThread(
72                 p_aout_bank->pp_aout[ --p_aout_bank->i_count ], NULL );
73     }
74
75     vlc_mutex_destroy( &p_aout_bank->lock );
76 }
77
78 /*****************************************************************************
79  * aout_CreateThread: initialize audio thread
80  *****************************************************************************/
81 aout_thread_t *aout_CreateThread( int *pi_status, int i_channels, long l_rate )
82 {
83     aout_thread_t * p_aout;                             /* thread descriptor */
84 #if 0
85     int             i_status;                               /* thread status */
86 #endif
87
88     /* Allocate descriptor */
89     p_aout = (aout_thread_t *) malloc( sizeof(aout_thread_t) );
90     if( p_aout == NULL )
91     {
92         return( NULL );
93     }
94
95     /* Choose the best module */
96     p_aout->p_module = module_Need( MODULE_CAPABILITY_AOUT,
97                            main_GetPszVariable( AOUT_METHOD_VAR, NULL ), 
98                            NULL );
99
100     if( p_aout->p_module == NULL )
101     {
102         intf_ErrMsg( "aout error: no suitable aout module" );
103         free( p_aout );
104         return( NULL );
105     }
106
107 #define aout_functions p_aout->p_module->p_functions->aout.functions.aout
108     p_aout->pf_open       = aout_functions.pf_open;
109     p_aout->pf_setformat  = aout_functions.pf_setformat;
110     p_aout->pf_getbufinfo = aout_functions.pf_getbufinfo;
111     p_aout->pf_play       = aout_functions.pf_play;
112     p_aout->pf_close      = aout_functions.pf_close;
113 #undef aout_functions
114
115     /*
116      * Initialize audio device
117      */
118     if ( p_aout->pf_open( p_aout ) )
119     {
120         module_Unneed( p_aout->p_module );
121         free( p_aout );
122         return( NULL );
123     }
124
125     p_aout->l_rate = l_rate;
126     p_aout->i_channels = i_channels;
127
128     /* special setting for ac3 pass-through mode */
129     /* FIXME is it necessary ? (cf ac3_adec.c) */
130     if( main_GetIntVariable( AOUT_SPDIF_VAR, 0 ) && p_main->b_ac3 )
131     {
132         intf_WarnMsg( 4, "aout info: setting ac3 spdif" );
133         p_aout->i_format = AOUT_FMT_AC3;
134         p_aout->l_rate = 48000;
135     }
136
137     if( p_aout->l_rate == 0 )
138     {
139         intf_ErrMsg( "aout error: null sample rate" );
140         p_aout->pf_close( p_aout );
141         module_Unneed( p_aout->p_module );
142         free( p_aout );
143         return( NULL );
144     }
145
146     /* FIXME: only works for i_channels == 1 or 2 ?? */
147     p_aout->b_stereo = ( p_aout->i_channels == 2 ) ? 1 : 0;
148
149     if ( p_aout->pf_setformat( p_aout ) )
150     {
151         p_aout->pf_close( p_aout );
152         module_Unneed( p_aout->p_module );
153         free( p_aout );
154         return( NULL );
155     }
156
157     /* Initialize the volume level */
158     p_aout->i_volume = main_GetIntVariable( AOUT_VOLUME_VAR, VOLUME_DEFAULT );
159     p_aout->i_savedvolume = 0;
160     
161     /* FIXME: maybe it would be cleaner to change SpawnThread prototype
162      * see vout to handle status correctly ?? however, it is not critical since
163      * this thread is only called in main and all calls are blocking */
164     if( aout_SpawnThread( p_aout ) )
165     {
166         p_aout->pf_close( p_aout );
167         module_Unneed( p_aout->p_module );
168         free( p_aout );
169         return( NULL );
170     }
171
172     return( p_aout );
173 }
174
175 /*****************************************************************************
176  * aout_SpawnThread
177  *****************************************************************************/
178 static int aout_SpawnThread( aout_thread_t * p_aout )
179 {
180     int     i_fifo;
181     long    l_bytes;
182     void (* pf_aout_thread)( aout_thread_t * ) = NULL;
183
184     /* We want the audio output thread to live */
185     p_aout->b_die = 0;
186     p_aout->b_active = 1;
187
188     /* Initialize the fifos lock */
189     vlc_mutex_init( &p_aout->fifos_lock );
190     /* Initialize audio fifos : set all fifos as empty and initialize locks */
191     for ( i_fifo = 0; i_fifo < AOUT_MAX_FIFOS; i_fifo++ )
192     {
193         p_aout->fifo[i_fifo].i_type = AOUT_EMPTY_FIFO;
194         vlc_mutex_init( &p_aout->fifo[i_fifo].data_lock );
195         vlc_cond_init( &p_aout->fifo[i_fifo].data_wait );
196     }
197
198     /* Compute the size (in audio units) of the audio output buffer. Although
199      * AOUT_BUFFER_DURATION is given in microseconds, the output rate is given
200      * in Hz, that's why we need to divide by 10^6 microseconds (1 second) */
201     p_aout->l_units = (long)( ((s64)p_aout->l_rate * AOUT_BUFFER_DURATION) / 1000000 );
202     p_aout->l_msleep = (long)( ((s64)p_aout->l_units * 1000000) / (s64)p_aout->l_rate );
203
204     /* Make pf_aout_thread point to the right thread function, and compute the
205      * byte size of the audio output buffer */
206     switch ( p_aout->i_channels )
207     {
208     /* Audio output is mono */
209     case 1:
210         switch ( p_aout->i_format )
211         {
212         case AOUT_FMT_U8:
213             intf_WarnMsg( 2, "aout info: unsigned 8 bits mono thread" );
214             l_bytes = 1 * sizeof(u8) * p_aout->l_units;
215             pf_aout_thread = aout_U8MonoThread;
216             break;
217
218         case AOUT_FMT_S8:
219             intf_WarnMsg( 2, "aout info: signed 8 bits mono thread" );
220             l_bytes = 1 * sizeof(s8) * p_aout->l_units;
221             pf_aout_thread = aout_S8MonoThread;
222             break;
223
224         case AOUT_FMT_U16_LE:
225         case AOUT_FMT_U16_BE:
226             intf_WarnMsg( 2, "aout info: unsigned 16 bits mono thread" );
227             l_bytes = 1 * sizeof(u16) * p_aout->l_units;
228             pf_aout_thread = aout_U16MonoThread;
229             break;
230
231         case AOUT_FMT_S16_LE:
232         case AOUT_FMT_S16_BE:
233             intf_WarnMsg( 2, "aout info: signed 16 bits mono thread" );
234             l_bytes = 1 * sizeof(s16) * p_aout->l_units;
235             pf_aout_thread = aout_S16MonoThread;
236             break;
237
238         default:
239             intf_ErrMsg( "aout error: unknown audio output format (%i)",
240                          p_aout->i_format );
241             return( -1 );
242         }
243         break;
244
245     /* Audio output is stereo */
246     case 2:
247         switch ( p_aout->i_format )
248         {
249         case AOUT_FMT_U8:
250             intf_WarnMsg( 2, "aout info: unsigned 8 bits stereo thread" );
251             l_bytes = 2 * sizeof(u8) * p_aout->l_units;
252             pf_aout_thread = aout_U8StereoThread;
253             break;
254
255         case AOUT_FMT_S8:
256             intf_WarnMsg( 2, "aout info: signed 8 bits stereo thread" );
257             l_bytes = 2 * sizeof(s8) * p_aout->l_units;
258             pf_aout_thread = aout_S8StereoThread;
259             break;
260
261         case AOUT_FMT_U16_LE:
262         case AOUT_FMT_U16_BE:
263             intf_WarnMsg( 2, "aout info: unsigned 16 bits stereo thread" );
264             l_bytes = 2 * sizeof(u16) * p_aout->l_units;
265             pf_aout_thread = aout_U16StereoThread;
266             break;
267
268         case AOUT_FMT_S16_LE:
269         case AOUT_FMT_S16_BE:
270             intf_WarnMsg( 2, "aout info: signed 16 bits stereo thread" );
271             l_bytes = 2 * sizeof(s16) * p_aout->l_units;
272             pf_aout_thread = aout_S16StereoThread;
273             break;
274
275         case AOUT_FMT_AC3:
276             intf_WarnMsg( 2, "aout info: ac3 pass-through thread" );
277             l_bytes = SPDIF_FRAME_SIZE;
278             pf_aout_thread = aout_SpdifThread;
279             break;
280
281         default:
282             intf_ErrMsg( "aout error: unknown audio output format %i",
283                          p_aout->i_format );
284             return( -1 );
285         }
286         break;
287
288     default:
289         intf_ErrMsg( "aout error: unknown number of audio channels (%i)",
290                      p_aout->i_channels );
291         return( -1 );
292     }
293
294     /* Allocate the memory needed by the audio output buffers, and set to zero
295      * the s32 buffer's memory */
296     p_aout->buffer = malloc( l_bytes );
297     if ( p_aout->buffer == NULL )
298     {
299         intf_ErrMsg( "aout error: cannot create output buffer" );
300         return( -1 );
301     }
302
303     p_aout->s32_buffer = (s32 *)calloc( p_aout->l_units,
304                                         sizeof(s32) << ( p_aout->b_stereo ) );
305     if ( p_aout->s32_buffer == NULL )
306     {
307         intf_ErrMsg( "aout error: cannot create the s32 output buffer" );
308         free( p_aout->buffer );
309         return( -1 );
310     }
311
312     /* Rough estimate of the playing date */
313     p_aout->date = mdate() + p_main->i_desync;
314
315     /* Launch the thread */
316     if ( vlc_thread_create( &p_aout->thread_id, "audio output",
317                             (vlc_thread_func_t)pf_aout_thread, p_aout ) )
318     {
319         intf_ErrMsg( "aout error: cannot spawn audio output thread" );
320         free( p_aout->buffer );
321         free( p_aout->s32_buffer );
322         return( -1 );
323     }
324
325     intf_WarnMsg( 2, "aout info: audio output thread %i spawned", getpid() );
326     return( 0 );
327 }
328
329 /*****************************************************************************
330  * aout_DestroyThread
331  *****************************************************************************/
332 void aout_DestroyThread( aout_thread_t * p_aout, int *pi_status )
333 {
334     int i_fifo;
335     
336     /* FIXME: pi_status is not handled correctly: check vout how to do!?? */
337
338     /* Ask thread to kill itself and wait until it's done */
339     p_aout->b_die = 1;
340     vlc_thread_join( p_aout->thread_id ); /* only if pi_status is NULL */
341
342     /* Free the allocated memory */
343     free( p_aout->buffer );
344     free( p_aout->s32_buffer );
345
346     /* Destroy the condition and mutex locks */
347     for ( i_fifo = 0; i_fifo < AOUT_MAX_FIFOS; i_fifo++ )
348     {
349         vlc_mutex_destroy( &p_aout->fifo[i_fifo].data_lock );
350         vlc_cond_destroy( &p_aout->fifo[i_fifo].data_wait );
351     }
352     vlc_mutex_destroy( &p_aout->fifos_lock );
353     
354     /* Free the plugin */
355     p_aout->pf_close( p_aout );
356
357     /* Release the aout module */
358     module_Unneed( p_aout->p_module );
359
360     /* Free structure */
361     free( p_aout );
362 }
363