git.sesse.net Git - vlc/blob - modules/audio_output/oss.c

   1 /*****************************************************************************
   2  * oss.c : OSS /dev/dsp module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2000-2002 VideoLAN
   5  * $Id: oss.c,v 1.7 2002/08/12 09:34:15 sam Exp $
   6  *
   7  * Authors: Michel Kaempf <maxx@via.ecp.fr>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *          Christophe Massiot <massiot@via.ecp.fr>
  10  *
  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.
  15  *
  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.
  20  *
  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  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  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() */
  35
  36 #include <vlc/vlc.h>
  37
  38 #ifdef HAVE_ALLOCA_H
  39 #   include <alloca.h>
  40 #endif
  41
  42 #include <vlc/aout.h>
  43
  44 #include "aout_internal.h"
  45
  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>
  54 #endif
  55
  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  *****************************************************************************/
  62 struct aout_sys_t
  63 {
  64     int                   i_fd;
  65     volatile vlc_bool_t   b_die;
  66     volatile vlc_bool_t   b_initialized;
  67 };
  68
  69 #define DEFAULT_FRAME_SIZE 2048
  70
  71 /*****************************************************************************
  72  * Local prototypes
  73  *****************************************************************************/
  74 static int  Open         ( vlc_object_t * );
  75 static void Close        ( vlc_object_t * );
  76
  77 static int  SetFormat    ( aout_instance_t * );
  78 static void Play         ( aout_instance_t *, aout_buffer_t * );
  79 static int  OSSThread    ( aout_instance_t * );
  80
  81 /*****************************************************************************
  82  * Module descriptor
  83  *****************************************************************************/
  84 vlc_module_begin();
  85     add_category_hint( N_("Audio"), NULL );
  86     add_file( "dspdev", "/dev/dsp", NULL, N_("OSS dsp device"), NULL );
  87     set_description( _("Linux OSS /dev/dsp module") );
  88     set_capability( "audio output", 100 );
  89     set_callbacks( Open, Close );
  90 vlc_module_end();
  91
  92 /*****************************************************************************
  93  * Open: open the audio device (the digital sound processor)
  94  *****************************************************************************
  95  * This function opens the dsp as a usual non-blocking write-only file, and
  96  * modifies the p_aout->p_sys->i_fd with the file's descriptor.
  97  *****************************************************************************/
  98 static int Open( vlc_object_t *p_this )
  99 {
 100     aout_instance_t * p_aout = (aout_instance_t *)p_this;
 101     struct aout_sys_t * p_sys;
 102     char * psz_device;
 103
 104     /* Allocate structure */
 105     p_aout->output.p_sys = p_sys = malloc( sizeof( aout_sys_t ) );
 106     if( p_sys == NULL )
 107     {
 108         msg_Err( p_aout, "out of memory" );
 109         return 1;
 110     }
 111
 112     /* Initialize some variables */
 113     if( (psz_device = config_GetPsz( p_aout, "dspdev" )) == NULL )
 114     {
 115         msg_Err( p_aout, "no audio device given (maybe /dev/dsp ?)" );
 116         free( p_sys );
 117         return -1;
 118     }
 119
 120     /* Open the sound device */
 121     if( (p_sys->i_fd = open( psz_device, O_WRONLY )) < 0 )
 122     {
 123         msg_Err( p_aout, "cannot open audio device (%s)",
 124                           psz_device );
 125         free( psz_device );
 126         free( p_sys );
 127         return -1;
 128     }
 129     free( psz_device );
 130
 131     /* Create OSS thread and wait for its readiness. */
 132     p_sys->b_die = 0;
 133     p_sys->b_initialized = VLC_FALSE;
 134     if( vlc_thread_create( p_aout, "aout", OSSThread, VLC_FALSE ) )
 135     {
 136         msg_Err( p_aout, "cannot create OSS thread (%s)", strerror(errno) );
 137         free( psz_device );
 138         free( p_sys );
 139         return -1;
 140     }
 141
 142     p_aout->output.pf_setformat = SetFormat;
 143     p_aout->output.pf_play = Play;
 144
 145     return 0;
 146 }
 147
 148 /*****************************************************************************
 149  * SetFormat: reset the dsp and set its format
 150  *****************************************************************************
 151  * This functions resets the DSP device, tries to initialize the output
 152  * format with the value contained in the dsp structure, and if this value
 153  * could not be set, the default value returned by ioctl is set. It then
 154  * does the same for the stereo mode, and for the output rate.
 155  *****************************************************************************/
 156 static int SetFormat( aout_instance_t *p_aout )
 157 {
 158     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 159     int i_format;
 160     int i_rate;
 161     vlc_bool_t b_stereo;
 162
 163     p_sys->b_initialized = VLC_FALSE;
 164
 165     /* Reset the DSP device */
 166     if( ioctl( p_sys->i_fd, SNDCTL_DSP_RESET, NULL ) < 0 )
 167     {
 168         msg_Err( p_aout, "cannot reset OSS audio device" );
 169         return -1;
 170     }
 171
 172     /* Set the output format */
 173     if ( AOUT_FMT_IS_SPDIF( &p_aout->output.output ) )
 174     {
 175         p_aout->output.output.i_format = i_format = AOUT_FMT_SPDIF;
 176         p_aout->output.i_nb_samples = 1;
 177     }
 178     else
 179     {
 180         p_aout->output.output.i_format = i_format = AOUT_FMT_S16_NE;
 181         p_aout->output.i_nb_samples = DEFAULT_FRAME_SIZE;
 182     }
 183
 184     if( ioctl( p_sys->i_fd, SNDCTL_DSP_SETFMT, &i_format ) < 0
 185          || i_format != p_aout->output.output.i_format )
 186     {
 187         msg_Err( p_aout, "cannot set audio output format (%i)",
 188                           i_format );
 189         return -1;
 190     }
 191
 192     if ( !AOUT_FMT_IS_SPDIF( &p_aout->output.output ) )
 193     {
 194         /* FIXME */
 195         if ( p_aout->output.output.i_channels > 2 )
 196         {
 197             msg_Warn( p_aout, "only two channels are supported at the moment" );
 198             /* Trigger downmixing */
 199             p_aout->output.output.i_channels = 2;
 200         }
 201
 202         /* Set the number of channels */
 203         b_stereo = p_aout->output.output.i_channels - 1;
 204
 205         if( ioctl( p_sys->i_fd, SNDCTL_DSP_STEREO, &b_stereo ) < 0 )
 206         {
 207             msg_Err( p_aout, "cannot set number of audio channels (%i)",
 208                               p_aout->output.output.i_channels );
 209             return -1;
 210         }
 211
 212         if ( b_stereo + 1 != p_aout->output.output.i_channels )
 213         {
 214             msg_Warn( p_aout, "driver forced up/downmixing %li->%li",
 215                               p_aout->output.output.i_channels,
 216                               b_stereo + 1 );
 217             p_aout->output.output.i_channels = b_stereo + 1;
 218         }
 219
 220         /* Set the output rate */
 221         i_rate = p_aout->output.output.i_rate;
 222         if( ioctl( p_sys->i_fd, SNDCTL_DSP_SPEED, &i_rate ) < 0 )
 223         {
 224             msg_Err( p_aout, "cannot set audio output rate (%i)",
 225                              p_aout->output.output.i_rate );
 226             return -1;
 227         }
 228
 229         if( i_rate != p_aout->output.output.i_rate )
 230         {
 231             msg_Warn( p_aout, "driver forced resampling %li->%li",
 232                               p_aout->output.output.i_rate, i_rate );
 233             p_aout->output.output.i_rate = i_rate;
 234         }
 235     }
 236
 237     p_sys->b_initialized = VLC_TRUE;
 238
 239     return 0;
 240 }
 241
 242 /*****************************************************************************
 243  * Play: queue a buffer for playing by OSSThread
 244  *****************************************************************************/
 245 static void Play( aout_instance_t *p_aout, aout_buffer_t * p_buffer )
 246 {
 247     aout_FifoPush( p_aout, &p_aout->output.fifo, p_buffer );
 248 }
 249
 250 /*****************************************************************************
 251  * Close: close the dsp audio device
 252  *****************************************************************************/
 253 static void Close( vlc_object_t * p_this )
 254 {
 255     aout_instance_t *p_aout = (aout_instance_t *)p_this;
 256     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 257
 258     p_sys->b_die = 1;
 259     vlc_thread_join( p_aout );
 260
 261     close( p_sys->i_fd );
 262     free( p_sys );
 263 }
 264
 265
 266 /*****************************************************************************
 267  * GetBufInfo: buffer status query
 268  *****************************************************************************
 269  * This function fills in the audio_buf_info structure :
 270  * - returns : number of available fragments (not partially used ones)
 271  * - int fragstotal : total number of fragments allocated
 272  * - int fragsize : size of a fragment in bytes
 273  * - int bytes : available space in bytes (includes partially used fragments)
 274  * Note! 'bytes' could be more than fragments*fragsize
 275  *****************************************************************************/
 276 static int GetBufInfo( aout_instance_t * p_aout )
 277 {
 278     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 279     audio_buf_info audio_buf;
 280
 281     ioctl( p_sys->i_fd, SNDCTL_DSP_GETOSPACE, &audio_buf );
 282
 283     /* returns the allocated space in bytes */
 284     return ( (audio_buf.fragstotal * audio_buf.fragsize) - audio_buf.bytes );
 285 }
 286
 287 /*****************************************************************************
 288  * OSSThread: asynchronous thread used to DMA the data to the device
 289  *****************************************************************************/
 290 static int OSSThread( aout_instance_t * p_aout )
 291 {
 292     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 293
 294     while ( !p_sys->b_die )
 295     {
 296         aout_buffer_t * p_buffer;
 297         mtime_t next_date = 0;
 298         int i_tmp, i_size;
 299         byte_t * p_bytes;
 300
 301         if( !p_sys->b_initialized )
 302         {
 303             msleep( THREAD_SLEEP );
 304             continue;
 305         }
 306
 307         if ( p_aout->output.output.i_format != AOUT_FMT_SPDIF )
 308         {
 309             /* Get the presentation date of the next write() operation. It
 310              * is equal to the current date + duration of buffered samples.
 311              * Order is important here, since GetBufInfo is believed to take
 312              * more time than mdate(). */
 313             next_date = (mtime_t)GetBufInfo( p_aout ) * 1000000
 314                       / aout_FormatToByterate( &p_aout->output.output,
 315                                                p_aout->output.output.i_rate );
 316             next_date += mdate();
 317         }
 318
 319         p_buffer = aout_OutputNextBuffer( p_aout, next_date );
 320
 321         if ( p_buffer != NULL )
 322         {
 323             p_bytes = p_buffer->p_buffer;
 324             i_size = aout_FormatToSize( &p_aout->output.output,
 325                                         p_buffer->i_nb_samples );
 326         }
 327         else
 328         {
 329             i_size = aout_FormatToSize( &p_aout->output.output,
 330                                         DEFAULT_FRAME_SIZE );
 331             p_bytes = alloca( i_size );
 332             memset( p_bytes, 0, i_size );
 333         }
 334
 335         i_tmp = write( p_sys->i_fd, p_bytes, i_size );
 336
 337         if( i_tmp < 0 )
 338         {
 339             msg_Err( p_aout, "write failed (%s)", strerror(errno) );
 340         }
 341
 342         if ( p_buffer != NULL )
 343         {
 344             aout_BufferFree( p_buffer );
 345         }
 346     }
 347
 348     return 0;
 349 }