1 /*****************************************************************************
2 * oss.c : OSS /dev/dsp module for vlc
3 *****************************************************************************
4 * Copyright (C) 2000-2002 VideoLAN
5 * $Id: oss.c,v 1.8 2002/08/13 11:59:36 sam Exp $
7 * Authors: Michel Kaempf <maxx@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Christophe Massiot <massiot@via.ecp.fr>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
29 #include <errno.h> /* ENOMEM */
30 #include <fcntl.h> /* open(), O_WRONLY */
31 #include <sys/ioctl.h> /* ioctl() */
32 #include <string.h> /* strerror() */
33 #include <unistd.h> /* write(), close() */
34 #include <stdlib.h> /* calloc(), malloc(), free() */
44 #include "aout_internal.h"
46 /* SNDCTL_DSP_RESET, SNDCTL_DSP_SETFMT, SNDCTL_DSP_STEREO, SNDCTL_DSP_SPEED,
47 * SNDCTL_DSP_GETOSPACE */
48 #ifdef HAVE_SOUNDCARD_H
49 # include <soundcard.h>
50 #elif defined( HAVE_SYS_SOUNDCARD_H )
51 # include <sys/soundcard.h>
52 #elif defined( HAVE_MACHINE_SOUNDCARD_H )
53 # include <machine/soundcard.h>
56 /*****************************************************************************
57 * aout_sys_t: OSS 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 *****************************************************************************/
65 volatile vlc_bool_t b_initialized;
68 #define DEFAULT_FRAME_SIZE 2048
70 /*****************************************************************************
72 *****************************************************************************/
73 static int Open ( vlc_object_t * );
74 static void Close ( vlc_object_t * );
76 static int SetFormat ( aout_instance_t * );
77 static void Play ( aout_instance_t *, aout_buffer_t * );
78 static int OSSThread ( aout_instance_t * );
80 /*****************************************************************************
82 *****************************************************************************/
84 add_category_hint( N_("Audio"), NULL );
85 add_file( "dspdev", "/dev/dsp", NULL, N_("OSS dsp device"), NULL );
86 set_description( _("Linux OSS /dev/dsp module") );
87 set_capability( "audio output", 100 );
88 set_callbacks( Open, Close );
91 /*****************************************************************************
92 * Open: open the audio device (the digital sound processor)
93 *****************************************************************************
94 * This function opens the dsp as a usual non-blocking write-only file, and
95 * modifies the p_aout->p_sys->i_fd with the file's descriptor.
96 *****************************************************************************/
97 static int Open( vlc_object_t *p_this )
99 aout_instance_t * p_aout = (aout_instance_t *)p_this;
100 struct aout_sys_t * p_sys;
103 /* Allocate structure */
104 p_aout->output.p_sys = p_sys = malloc( sizeof( aout_sys_t ) );
107 msg_Err( p_aout, "out of memory" );
111 /* Initialize some variables */
112 if( (psz_device = config_GetPsz( p_aout, "dspdev" )) == NULL )
114 msg_Err( p_aout, "no audio device given (maybe /dev/dsp ?)" );
119 /* Open the sound device */
120 if( (p_sys->i_fd = open( psz_device, O_WRONLY )) < 0 )
122 msg_Err( p_aout, "cannot open audio device (%s)", psz_device );
129 /* Create OSS thread and wait for its readiness. */
130 p_sys->b_initialized = VLC_FALSE;
131 if( vlc_thread_create( p_aout, "aout", OSSThread, VLC_FALSE ) )
133 msg_Err( p_aout, "cannot create OSS thread (%s)", strerror(errno) );
139 p_aout->output.pf_setformat = SetFormat;
140 p_aout->output.pf_play = Play;
145 /*****************************************************************************
146 * SetFormat: reset the dsp and set its format
147 *****************************************************************************
148 * This functions resets the DSP device, tries to initialize the output
149 * format with the value contained in the dsp structure, and if this value
150 * could not be set, the default value returned by ioctl is set. It then
151 * does the same for the stereo mode, and for the output rate.
152 *****************************************************************************/
153 static int SetFormat( aout_instance_t *p_aout )
155 struct aout_sys_t * p_sys = p_aout->output.p_sys;
160 p_sys->b_initialized = VLC_FALSE;
162 /* Reset the DSP device */
163 if( ioctl( p_sys->i_fd, SNDCTL_DSP_RESET, NULL ) < 0 )
165 msg_Err( p_aout, "cannot reset OSS audio device" );
169 /* Set the output format */
170 if ( AOUT_FMT_IS_SPDIF( &p_aout->output.output ) )
172 p_aout->output.output.i_format = i_format = AOUT_FMT_SPDIF;
173 p_aout->output.i_nb_samples = 1;
177 p_aout->output.output.i_format = i_format = AOUT_FMT_S16_NE;
178 p_aout->output.i_nb_samples = DEFAULT_FRAME_SIZE;
181 if( ioctl( p_sys->i_fd, SNDCTL_DSP_SETFMT, &i_format ) < 0
182 || i_format != p_aout->output.output.i_format )
184 msg_Err( p_aout, "cannot set audio output format (%i)",
189 if ( !AOUT_FMT_IS_SPDIF( &p_aout->output.output ) )
192 if ( p_aout->output.output.i_channels > 2 )
194 msg_Warn( p_aout, "only two channels are supported at the moment" );
195 /* Trigger downmixing */
196 p_aout->output.output.i_channels = 2;
199 /* Set the number of channels */
200 b_stereo = p_aout->output.output.i_channels - 1;
202 if( ioctl( p_sys->i_fd, SNDCTL_DSP_STEREO, &b_stereo ) < 0 )
204 msg_Err( p_aout, "cannot set number of audio channels (%i)",
205 p_aout->output.output.i_channels );
209 if ( b_stereo + 1 != p_aout->output.output.i_channels )
211 msg_Warn( p_aout, "driver forced up/downmixing %li->%li",
212 p_aout->output.output.i_channels,
214 p_aout->output.output.i_channels = b_stereo + 1;
217 /* Set the output rate */
218 i_rate = p_aout->output.output.i_rate;
219 if( ioctl( p_sys->i_fd, SNDCTL_DSP_SPEED, &i_rate ) < 0 )
221 msg_Err( p_aout, "cannot set audio output rate (%i)",
222 p_aout->output.output.i_rate );
226 if( i_rate != p_aout->output.output.i_rate )
228 msg_Warn( p_aout, "driver forced resampling %li->%li",
229 p_aout->output.output.i_rate, i_rate );
230 p_aout->output.output.i_rate = i_rate;
234 p_sys->b_initialized = VLC_TRUE;
239 /*****************************************************************************
240 * Play: queue a buffer for playing by OSSThread
241 *****************************************************************************/
242 static void Play( aout_instance_t *p_aout, aout_buffer_t * p_buffer )
244 aout_FifoPush( p_aout, &p_aout->output.fifo, p_buffer );
247 /*****************************************************************************
248 * Close: close the dsp audio device
249 *****************************************************************************/
250 static void Close( vlc_object_t * p_this )
252 aout_instance_t *p_aout = (aout_instance_t *)p_this;
253 struct aout_sys_t * p_sys = p_aout->output.p_sys;
256 vlc_thread_join( p_aout );
258 close( p_sys->i_fd );
263 /*****************************************************************************
264 * GetBufInfo: buffer status query
265 *****************************************************************************
266 * This function fills in the audio_buf_info structure :
267 * - returns : number of available fragments (not partially used ones)
268 * - int fragstotal : total number of fragments allocated
269 * - int fragsize : size of a fragment in bytes
270 * - int bytes : available space in bytes (includes partially used fragments)
271 * Note! 'bytes' could be more than fragments*fragsize
272 *****************************************************************************/
273 static int GetBufInfo( aout_instance_t * p_aout )
275 struct aout_sys_t * p_sys = p_aout->output.p_sys;
276 audio_buf_info audio_buf;
278 ioctl( p_sys->i_fd, SNDCTL_DSP_GETOSPACE, &audio_buf );
280 /* returns the allocated space in bytes */
281 return ( (audio_buf.fragstotal * audio_buf.fragsize) - audio_buf.bytes );
284 /*****************************************************************************
285 * OSSThread: asynchronous thread used to DMA the data to the device
286 *****************************************************************************/
287 static int OSSThread( aout_instance_t * p_aout )
289 struct aout_sys_t * p_sys = p_aout->output.p_sys;
291 while ( !p_aout->b_die )
293 aout_buffer_t * p_buffer;
294 mtime_t next_date = 0;
298 if( !p_sys->b_initialized )
300 msleep( THREAD_SLEEP );
304 if ( p_aout->output.output.i_format != AOUT_FMT_SPDIF )
306 /* Get the presentation date of the next write() operation. It
307 * is equal to the current date + duration of buffered samples.
308 * Order is important here, since GetBufInfo is believed to take
309 * more time than mdate(). */
310 next_date = (mtime_t)GetBufInfo( p_aout ) * 1000000
311 / aout_FormatToByterate( &p_aout->output.output,
312 p_aout->output.output.i_rate );
313 next_date += mdate();
316 p_buffer = aout_OutputNextBuffer( p_aout, next_date );
318 if ( p_buffer != NULL )
320 p_bytes = p_buffer->p_buffer;
321 i_size = aout_FormatToSize( &p_aout->output.output,
322 p_buffer->i_nb_samples );
326 i_size = aout_FormatToSize( &p_aout->output.output,
327 DEFAULT_FRAME_SIZE );
328 p_bytes = alloca( i_size );
329 memset( p_bytes, 0, i_size );
332 i_tmp = write( p_sys->i_fd, p_bytes, i_size );
336 msg_Err( p_aout, "write failed (%s)", strerror(errno) );
339 if ( p_buffer != NULL )
341 aout_BufferFree( p_buffer );