- better communication between audio decoder and output: aout plugins
[vlc.git] / plugins / dsp / aout_dsp.c
1 /*****************************************************************************
2  * aout_dsp.c : dsp functions library
3  *****************************************************************************
4  * Copyright (C) 1999-2001 VideoLAN
5  * $Id: aout_dsp.c,v 1.19 2002/01/09 00:33:37 asmax Exp $
6  *
7  * Authors: Michel Kaempf <maxx@via.ecp.fr>
8  *          Samuel Hocevar <sam@zoy.org>
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 /* TODO:
26  *
27  * - an aout_GetFormats() function
28  * - dsp inline/static
29  * - make this library portable (see mpg123)
30  *
31  */
32
33 /*****************************************************************************
34  * Preamble
35  *****************************************************************************/
36 #include <errno.h>                                                 /* ENOMEM */
37 #include <fcntl.h>                                       /* open(), O_WRONLY */
38 #include <sys/ioctl.h>                                            /* ioctl() */
39 #include <string.h>                                            /* strerror() */
40 #include <unistd.h>                                      /* write(), close() */
41 #include <stdio.h>                                           /* "intf_msg.h" */
42 #include <stdlib.h>                            /* calloc(), malloc(), free() */
43
44 #include <videolan/vlc.h>
45
46 #ifdef SYS_BSD
47 #include <machine/soundcard.h>       /* SNDCTL_DSP_RESET, SNDCTL_DSP_SETFMT,
48                    SNDCTL_DSP_STEREO, SNDCTL_DSP_SPEED, SNDCTL_DSP_GETOSPACE */
49 #else
50 #include <sys/soundcard.h>           /* SNDCTL_DSP_RESET, SNDCTL_DSP_SETFMT,
51                    SNDCTL_DSP_STEREO, SNDCTL_DSP_SPEED, SNDCTL_DSP_GETOSPACE */
52 #endif
53
54 #include "audio_output.h"                                   /* aout_thread_t */
55
56 /*****************************************************************************
57  * aout_sys_t: dsp audio output method descriptor
58  *****************************************************************************
59  * This structure is part of the audio output thread descriptor.
60  * It describes the dsp specific properties of an audio device.
61  *****************************************************************************/
62 typedef struct aout_sys_s
63 {
64     audio_buf_info        audio_buf;
65
66 } aout_sys_t;
67
68 /*****************************************************************************
69  * Local prototypes.
70  *****************************************************************************/
71 static int     aout_Probe       ( probedata_t *p_data );
72 static int     aout_Open        ( aout_thread_t *p_aout );
73 static int     aout_SetFormat   ( aout_thread_t *p_aout );
74 static long    aout_GetBufInfo  ( aout_thread_t *p_aout, long l_buffer_info );
75 static void    aout_Play        ( aout_thread_t *p_aout,
76                                   byte_t *buffer, int i_size );
77 static void    aout_Close       ( aout_thread_t *p_aout );
78
79 /*****************************************************************************
80  * Functions exported as capabilities. They are declared as static so that
81  * we don't pollute the namespace too much.
82  *****************************************************************************/
83 void _M( aout_getfunctions )( function_list_t * p_function_list )
84 {
85     p_function_list->pf_probe = aout_Probe;
86     p_function_list->functions.aout.pf_open = aout_Open;
87     p_function_list->functions.aout.pf_setformat = aout_SetFormat;
88     p_function_list->functions.aout.pf_getbufinfo = aout_GetBufInfo;
89     p_function_list->functions.aout.pf_play = aout_Play;
90     p_function_list->functions.aout.pf_close = aout_Close;
91 }
92
93 /*****************************************************************************
94  * aout_Probe: probe the audio device and return a score
95  *****************************************************************************
96  * This function tries to open the DSP and returns a score to the plugin
97  * manager so that it can choose the most appropriate one.
98  *****************************************************************************/
99 static int aout_Probe( probedata_t *p_data )
100 {
101     char * psz_device = main_GetPszVariable( AOUT_DSP_VAR, AOUT_DSP_DEFAULT );
102     int i_fd = open( psz_device, O_WRONLY|O_NONBLOCK );
103
104     /* If we were unable to open the device, there is no way we can use
105      * the plugin. Return a score of 0. */
106     if( i_fd < 0 )
107     {
108         return( 0 );
109     }
110
111     /* Otherwise, there are good chances we can use this plugin, return 100. */
112     close( i_fd );
113
114     return( 100 );
115 }
116
117 /*****************************************************************************
118  * aout_Open: opens the audio device (the digital sound processor)
119  *****************************************************************************
120  * This function opens the dsp as a usual non-blocking write-only file, and
121  * modifies the p_aout->i_fd with the file's descriptor.
122  *****************************************************************************/
123 static int aout_Open( aout_thread_t *p_aout )
124 {
125     /* Allocate structure */
126     p_aout->p_sys = malloc( sizeof( aout_sys_t ) );
127     if( p_aout->p_sys == NULL )
128     {
129         intf_ErrMsg("aout error: %s", strerror(ENOMEM) );
130         return( 1 );
131     }
132
133     /* Initialize some variables */
134     p_aout->psz_device = main_GetPszVariable( AOUT_DSP_VAR, AOUT_DSP_DEFAULT );
135     p_aout->i_format   = AOUT_FORMAT_DEFAULT;
136
137  /* All that is drawn directly from the audio stream.
138     p_aout->i_channels = 1 + main_GetIntVariable( AOUT_STEREO_VAR,
139                                                   AOUT_STEREO_DEFAULT );
140     p_aout->l_rate     = main_GetIntVariable( AOUT_RATE_VAR,
141                                               AOUT_RATE_DEFAULT );
142   */                                            
143
144     /* Open the sound device */
145     if( (p_aout->i_fd = open( p_aout->psz_device, O_WRONLY )) < 0 )
146     {
147         intf_ErrMsg( "aout error: can't open audio device (%s)",
148                      p_aout->psz_device );
149         return( -1 );
150     }
151
152     return( 0 );
153 }
154
155 /*****************************************************************************
156  * aout_SetFormat: resets the dsp and sets its format
157  *****************************************************************************
158  * This functions resets the DSP device, tries to initialize the output
159  * format with the value contained in the dsp structure, and if this value
160  * could not be set, the default value returned by ioctl is set. It then
161  * does the same for the stereo mode, and for the output rate.
162  *****************************************************************************/
163 static int aout_SetFormat( aout_thread_t *p_aout )
164 {
165     int i_format;
166     long l_rate;
167     boolean_t b_stereo = p_aout->b_stereo;
168
169     /* Reset the DSP device */
170     if( ioctl( p_aout->i_fd, SNDCTL_DSP_RESET, NULL ) < 0 )
171     {
172         intf_ErrMsg( "aout error: can't reset audio device (%s)",
173                      p_aout->psz_device );
174         return( -1 );
175     }
176
177     /* Set the output format */
178     i_format = p_aout->i_format;
179     if( ioctl( p_aout->i_fd, SNDCTL_DSP_SETFMT, &i_format ) < 0 )
180     {
181         intf_ErrMsg( "aout error: can't set audio output format (%i)",
182                      p_aout->i_format );
183         return( -1 );
184     }
185
186     if( i_format != p_aout->i_format )
187     {
188         intf_WarnMsg( 2, "aout warning: audio output format not supported (%i)",
189                       p_aout->i_format );
190         p_aout->i_format = i_format;
191     }
192
193     /* Set the number of channels */
194     if( ioctl( p_aout->i_fd, SNDCTL_DSP_STEREO, &b_stereo ) < 0 )
195     {
196         intf_ErrMsg( "aout error: can't set number of audio channels (%i)",
197                      p_aout->i_channels );
198         return( -1 );
199     }
200
201     if( b_stereo != p_aout->b_stereo )
202     {
203         intf_WarnMsg( 2, "aout warning: number of audio channels not supported (%i)",
204                       p_aout->i_channels );
205         p_aout->b_stereo = b_stereo;
206         p_aout->i_channels = 1 + b_stereo;
207     }
208
209     /* Set the output rate */
210     l_rate = p_aout->l_rate;
211     if( ioctl( p_aout->i_fd, SNDCTL_DSP_SPEED, &l_rate ) < 0 )
212     {
213         intf_ErrMsg( "aout error: can't set audio output rate (%li)",
214                      p_aout->l_rate );
215         return( -1 );
216     }
217
218     if( l_rate != p_aout->l_rate )
219     {
220         intf_WarnMsg( 1, "aout warning: audio output rate not supported (%li)",
221                       p_aout->l_rate );
222         p_aout->l_rate = l_rate;
223     }
224
225     p_aout->i_latency = 0;
226     
227     return( 0 );
228 }
229
230 /*****************************************************************************
231  * aout_GetBufInfo: buffer status query
232  *****************************************************************************
233  * This function fills in the audio_buf_info structure :
234  * - int fragments : number of available fragments (partially usend ones not
235  *   counted)
236  * - int fragstotal : total number of fragments allocated
237  * - int fragsize : size of a fragment in bytes
238  * - int bytes : available space in bytes (includes partially used fragments)
239  * Note! 'bytes' could be more than fragments*fragsize
240  *****************************************************************************/
241 static long aout_GetBufInfo( aout_thread_t *p_aout, long l_buffer_limit )
242 {
243     ioctl( p_aout->i_fd, SNDCTL_DSP_GETOSPACE, &p_aout->p_sys->audio_buf );
244
245     /* returns the allocated space in bytes */
246     return ( (p_aout->p_sys->audio_buf.fragstotal
247                  * p_aout->p_sys->audio_buf.fragsize)
248             - p_aout->p_sys->audio_buf.bytes );
249 }
250
251 /*****************************************************************************
252  * aout_Play: plays a sound samples buffer
253  *****************************************************************************
254  * This function writes a buffer of i_length bytes in the dsp
255  *****************************************************************************/
256 static void aout_Play( aout_thread_t *p_aout, byte_t *buffer, int i_size )
257 {
258     if( p_aout->b_active )
259     {
260         write( p_aout->i_fd, buffer, i_size );
261     }
262 }
263
264 /*****************************************************************************
265  * aout_Close: closes the dsp audio device
266  *****************************************************************************/
267 static void aout_Close( aout_thread_t *p_aout )
268 {
269     close( p_aout->i_fd );
270 }
271