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.13 2002/08/20 22:11:49 stef 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_initialized;
  66 };
  67
  68 #define FRAME_SIZE 2048
  69 #define A52_FRAME_NB 1536
  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 * );
  79 static int  OSSThread    ( aout_instance_t * );
  80
  81 /*****************************************************************************
  82  * Module descriptor
  83  *****************************************************************************/
  84 vlc_module_begin();
  85     add_category_hint( N_("OSS"), 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)", psz_device );
 124         free( psz_device );
 125         free( p_sys );
 126         return -1;
 127     }
 128     free( psz_device );
 129
 130     /* Create OSS thread and wait for its readiness. */
 131     p_sys->b_initialized = VLC_FALSE;
 132     if( vlc_thread_create( p_aout, "aout", OSSThread, VLC_FALSE ) )
 133     {
 134         msg_Err( p_aout, "cannot create OSS thread (%s)", strerror(errno) );
 135         close( p_sys->i_fd );
 136         free( psz_device );
 137         free( p_sys );
 138         return -1;
 139     }
 140
 141     p_aout->output.pf_setformat = SetFormat;
 142     p_aout->output.pf_play = Play;
 143
 144     return 0;
 145 }
 146
 147 /*****************************************************************************
 148  * SetFormat: reset the dsp and set its format
 149  *****************************************************************************
 150  * This functions resets the DSP device, tries to initialize the output
 151  * format with the value contained in the dsp structure, and if this value
 152  * could not be set, the default value returned by ioctl is set. It then
 153  * does the same for the stereo mode, and for the output rate.
 154  *****************************************************************************/
 155 static int SetFormat( aout_instance_t *p_aout )
 156 {
 157     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 158     int i_format;
 159     int i_rate;
 160     vlc_bool_t b_stereo;
 161
 162     p_sys->b_initialized = VLC_FALSE;
 163
 164     /* Reset the DSP device */
 165     if( ioctl( p_sys->i_fd, SNDCTL_DSP_RESET, NULL ) < 0 )
 166     {
 167         msg_Err( p_aout, "cannot reset OSS audio device" );
 168         return -1;
 169     }
 170
 171     /* Set the output format */
 172     if ( p_aout->output.output.i_format == AOUT_FMT_SPDIF )
 173     {
 174         i_format = AOUT_FMT_SPDIF;
 175         p_aout->output.i_nb_samples = A52_FRAME_NB;
 176         p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
 177         p_aout->output.output.i_frame_length = A52_FRAME_NB;
 178     }
 179     else
 180     {
 181         p_aout->output.output.i_format = i_format = AOUT_FMT_S16_NE;
 182         p_aout->output.i_nb_samples = FRAME_SIZE;
 183     }
 184
 185     if( ioctl( p_sys->i_fd, SNDCTL_DSP_SETFMT, &i_format ) < 0
 186          || i_format != p_aout->output.output.i_format )
 187     {
 188         msg_Err( p_aout, "cannot set audio output format (%i)",
 189                           i_format );
 190         return -1;
 191     }
 192
 193     if ( p_aout->output.output.i_format != AOUT_FMT_SPDIF )
 194     {
 195         /* FIXME */
 196         if ( p_aout->output.output.i_channels > 2 )
 197         {
 198             msg_Warn( p_aout, "only two channels are supported at the moment" );
 199             /* Trigger downmixing */
 200             p_aout->output.output.i_channels = 2;
 201         }
 202
 203         /* Set the number of channels */
 204         b_stereo = p_aout->output.output.i_channels - 1;
 205
 206         if( ioctl( p_sys->i_fd, SNDCTL_DSP_STEREO, &b_stereo ) < 0 )
 207         {
 208             msg_Err( p_aout, "cannot set number of audio channels (%i)",
 209                               p_aout->output.output.i_channels );
 210             return -1;
 211         }
 212
 213         if ( b_stereo + 1 != p_aout->output.output.i_channels )
 214         {
 215             msg_Warn( p_aout, "driver forced up/downmixing %li->%li",
 216                               p_aout->output.output.i_channels,
 217                               b_stereo + 1 );
 218             p_aout->output.output.i_channels = b_stereo + 1;
 219         }
 220
 221         /* Set the output rate */
 222         i_rate = p_aout->output.output.i_rate;
 223         if( ioctl( p_sys->i_fd, SNDCTL_DSP_SPEED, &i_rate ) < 0 )
 224         {
 225             msg_Err( p_aout, "cannot set audio output rate (%i)",
 226                              p_aout->output.output.i_rate );
 227             return -1;
 228         }
 229
 230         if( i_rate != p_aout->output.output.i_rate )
 231         {
 232             msg_Warn( p_aout, "driver forced resampling %li->%li",
 233                               p_aout->output.output.i_rate, i_rate );
 234             p_aout->output.output.i_rate = i_rate;
 235         }
 236     }
 237
 238     p_sys->b_initialized = VLC_TRUE;
 239
 240     return 0;
 241 }
 242
 243 /*****************************************************************************
 244  * Play: queue a buffer for playing by OSSThread
 245  *****************************************************************************/
 246 static void Play( aout_instance_t *p_aout )
 247 {
 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_aout->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_aout->b_die )
 295     {
 296         aout_buffer_t * p_buffer;
 297         int i_tmp, i_size;
 298         byte_t * p_bytes;
 299
 300         if( !p_sys->b_initialized )
 301         {
 302             msleep( THREAD_SLEEP );
 303             continue;
 304         }
 305
 306         if ( p_aout->output.output.i_format != AOUT_FMT_SPDIF )
 307         {
 308             mtime_t next_date = 0;
 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                       / p_aout->output.output.i_bytes_per_frame
 315                       / p_aout->output.output.i_rate
 316                       * p_aout->output.output.i_frame_length;
 317             next_date += mdate();
 318
 319             p_buffer = aout_OutputNextBuffer( p_aout, next_date, VLC_FALSE );
 320         }
 321         else
 322         {
 323             p_buffer = aout_OutputNextBuffer( p_aout, 0, VLC_TRUE );
 324         }
 325
 326         if ( p_buffer != NULL )
 327         {
 328             p_bytes = p_buffer->p_buffer;
 329             i_size = p_buffer->i_nb_bytes;
 330         }
 331         else
 332         {
 333             i_size = FRAME_SIZE / p_aout->output.output.i_frame_length
 334                       * p_aout->output.output.i_bytes_per_frame;
 335             p_bytes = alloca( i_size );
 336             memset( p_bytes, 0, i_size );
 337         }
 338
 339         i_tmp = write( p_sys->i_fd, p_bytes, i_size );
 340
 341         if( i_tmp < 0 )
 342         {
 343             msg_Err( p_aout, "write failed (%s)", strerror(errno) );
 344         }
 345
 346         if ( p_buffer != NULL )
 347         {
 348             aout_BufferFree( p_buffer );
 349         }
 350     }
 351
 352     return 0;
 353 }