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.19 2002/08/25 16:55:55 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_initialized;
  66 };
  67
  68 #define FRAME_SIZE 1024
  69 #define FRAME_COUNT 8
  70 #define A52_FRAME_NB 1536
  71
  72 /*****************************************************************************
  73  * Local prototypes
  74  *****************************************************************************/
  75 static int  Open         ( vlc_object_t * );
  76 static void Close        ( vlc_object_t * );
  77
  78 static int  SetFormat    ( aout_instance_t * );
  79 static void Play         ( aout_instance_t * );
  80 static int  OSSThread    ( aout_instance_t * );
  81
  82 /*****************************************************************************
  83  * Module descriptor
  84  *****************************************************************************/
  85 vlc_module_begin();
  86     add_category_hint( N_("OSS"), NULL );
  87     add_file( "dspdev", "/dev/dsp", NULL, N_("OSS dsp device"), NULL );
  88     set_description( _("Linux OSS /dev/dsp module") );
  89     set_capability( "audio output", 100 );
  90     add_shortcut( "dsp" );
  91     set_callbacks( Open, Close );
  92 vlc_module_end();
  93
  94 /*****************************************************************************
  95  * Open: open the audio device (the digital sound processor)
  96  *****************************************************************************
  97  * This function opens the dsp as a usual non-blocking write-only file, and
  98  * modifies the p_aout->p_sys->i_fd with the file's descriptor.
  99  *****************************************************************************/
 100 static int Open( vlc_object_t *p_this )
 101 {
 102     aout_instance_t * p_aout = (aout_instance_t *)p_this;
 103     struct aout_sys_t * p_sys;
 104     char * psz_device;
 105
 106     /* Allocate structure */
 107     p_aout->output.p_sys = p_sys = malloc( sizeof( aout_sys_t ) );
 108     if( p_sys == NULL )
 109     {
 110         msg_Err( p_aout, "out of memory" );
 111         return VLC_ENOMEM;
 112     }
 113
 114     /* Initialize some variables */
 115     if( (psz_device = config_GetPsz( p_aout, "dspdev" )) == NULL )
 116     {
 117         msg_Err( p_aout, "no audio device given (maybe /dev/dsp ?)" );
 118         free( p_sys );
 119         return VLC_EGENERIC;
 120     }
 121
 122     /* Open the sound device */
 123     if( (p_sys->i_fd = open( psz_device, O_WRONLY )) < 0 )
 124     {
 125         msg_Err( p_aout, "cannot open audio device (%s)", psz_device );
 126         free( psz_device );
 127         free( p_sys );
 128         return VLC_EGENERIC;
 129     }
 130     free( psz_device );
 131
 132     /* Create OSS thread and wait for its readiness. */
 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         close( p_sys->i_fd );
 138         free( psz_device );
 139         free( p_sys );
 140         return VLC_ETHREAD;
 141     }
 142
 143     p_aout->output.pf_setformat = SetFormat;
 144     p_aout->output.pf_play = Play;
 145
 146     return VLC_SUCCESS;
 147 }
 148
 149 /*****************************************************************************
 150  * SetFormat: reset the dsp and set its format
 151  *****************************************************************************
 152  * This functions resets the DSP device, tries to initialize the output
 153  * format with the value contained in the dsp structure, and if this value
 154  * could not be set, the default value returned by ioctl is set. It then
 155  * does the same for the stereo mode, and for the output rate.
 156  *****************************************************************************/
 157 static int SetFormat( aout_instance_t *p_aout )
 158 {
 159     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 160     int i_format;
 161     int i_rate;
 162     int i_fragments;
 163     vlc_bool_t b_stereo;
 164
 165     p_sys->b_initialized = VLC_FALSE;
 166
 167     /* Reset the DSP device */
 168     if( ioctl( p_sys->i_fd, SNDCTL_DSP_RESET, NULL ) < 0 )
 169     {
 170         msg_Err( p_aout, "cannot reset OSS audio device" );
 171         return VLC_EGENERIC;
 172     }
 173
 174     /* Set the fragment size */
 175     i_fragments = FRAME_COUNT << 16 | FRAME_SIZE;
 176     if( ioctl( p_sys->i_fd, SNDCTL_DSP_SETFRAGMENT, &i_fragments ) < 0 )
 177     {
 178         msg_Err( p_aout, "cannot set fragment size (%.8x)", i_fragments );
 179         return VLC_EGENERIC;
 180     }
 181
 182     /* Set the output format */
 183     if ( p_aout->output.output.i_format == AOUT_FMT_SPDIF )
 184     {
 185         i_format = AOUT_FMT_SPDIF;
 186         p_aout->output.i_nb_samples = A52_FRAME_NB;
 187         p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
 188         p_aout->output.output.i_frame_length = A52_FRAME_NB;
 189     }
 190     else
 191     {
 192         p_aout->output.output.i_format = i_format = AOUT_FMT_S16_NE;
 193         p_aout->output.i_nb_samples = FRAME_SIZE;
 194     }
 195
 196     if( ioctl( p_sys->i_fd, SNDCTL_DSP_SETFMT, &i_format ) < 0
 197          || i_format != p_aout->output.output.i_format )
 198     {
 199         msg_Err( p_aout, "cannot set audio output format (%i)", i_format );
 200         return VLC_EGENERIC;
 201     }
 202
 203     if ( p_aout->output.output.i_format != AOUT_FMT_SPDIF )
 204     {
 205         /* FIXME */
 206         if ( p_aout->output.output.i_channels > 2 )
 207         {
 208             msg_Warn( p_aout, "only two channels are supported at the moment" );
 209             /* Trigger downmixing */
 210             p_aout->output.output.i_channels = 2;
 211         }
 212
 213         /* Set the number of channels */
 214         b_stereo = p_aout->output.output.i_channels - 1;
 215
 216         if( ioctl( p_sys->i_fd, SNDCTL_DSP_STEREO, &b_stereo ) < 0 )
 217         {
 218             msg_Err( p_aout, "cannot set number of audio channels (%i)",
 219                               p_aout->output.output.i_channels );
 220             return VLC_EGENERIC;
 221         }
 222
 223         if ( b_stereo + 1 != p_aout->output.output.i_channels )
 224         {
 225             msg_Warn( p_aout, "driver forced up/downmixing %li->%li",
 226                               p_aout->output.output.i_channels,
 227                               b_stereo + 1 );
 228             p_aout->output.output.i_channels = b_stereo + 1;
 229         }
 230
 231         /* Set the output rate */
 232         i_rate = p_aout->output.output.i_rate;
 233         if( ioctl( p_sys->i_fd, SNDCTL_DSP_SPEED, &i_rate ) < 0 )
 234         {
 235             msg_Err( p_aout, "cannot set audio output rate (%i)",
 236                              p_aout->output.output.i_rate );
 237             return VLC_EGENERIC;
 238         }
 239
 240         if( i_rate != p_aout->output.output.i_rate )
 241         {
 242             msg_Warn( p_aout, "driver forced resampling %li->%li",
 243                               p_aout->output.output.i_rate, i_rate );
 244             p_aout->output.output.i_rate = i_rate;
 245         }
 246     }
 247
 248     p_sys->b_initialized = VLC_TRUE;
 249
 250     return VLC_SUCCESS;
 251 }
 252
 253 /*****************************************************************************
 254  * Play: queue a buffer for playing by OSSThread
 255  *****************************************************************************/
 256 static void Play( aout_instance_t *p_aout )
 257 {
 258 }
 259
 260 /*****************************************************************************
 261  * Close: close the dsp audio device
 262  *****************************************************************************/
 263 static void Close( vlc_object_t * p_this )
 264 {
 265     aout_instance_t *p_aout = (aout_instance_t *)p_this;
 266     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 267
 268     p_aout->b_die = VLC_TRUE;
 269     vlc_thread_join( p_aout );
 270     p_aout->b_die = VLC_FALSE;
 271
 272     ioctl( p_sys->i_fd, SNDCTL_DSP_RESET, NULL );
 273     close( p_sys->i_fd );
 274
 275     free( p_sys );
 276 }
 277
 278
 279 /*****************************************************************************
 280  * BufferDuration: buffer status query
 281  *****************************************************************************
 282  * This function returns the duration in microseconfs of the current buffer.
 283  *****************************************************************************/
 284 static mtime_t BufferDuration( aout_instance_t * p_aout )
 285 {
 286     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 287     audio_buf_info audio_buf;
 288     int i_bytes;
 289
 290     /* Fill the audio_buf_info structure:
 291      * - fragstotal: total number of fragments allocated
 292      * - fragsize: size of a fragment in bytes
 293      * - bytes: available space in bytes (includes partially used fragments)
 294      * Note! 'bytes' could be more than fragments*fragsize */
 295     ioctl( p_sys->i_fd, SNDCTL_DSP_GETOSPACE, &audio_buf );
 296
 297     /* calculate number of available fragments (not partially used ones) */
 298     i_bytes = (audio_buf.fragstotal * audio_buf.fragsize) - audio_buf.bytes;
 299
 300     /* Return the fragment duration */
 301     return (mtime_t)i_bytes * 1000000
 302             / p_aout->output.output.i_bytes_per_frame
 303             / p_aout->output.output.i_rate
 304             * p_aout->output.output.i_frame_length;
 305 }
 306
 307 /*****************************************************************************
 308  * OSSThread: asynchronous thread used to DMA the data to the device
 309  *****************************************************************************/
 310 static int OSSThread( aout_instance_t * p_aout )
 311 {
 312     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 313     mtime_t next_date = 0;
 314
 315     while ( !p_aout->b_die )
 316     {
 317         aout_buffer_t * p_buffer;
 318         int i_tmp, i_size;
 319         byte_t * p_bytes;
 320
 321         if( !p_sys->b_initialized )
 322         {
 323             msleep( THREAD_SLEEP );
 324             continue;
 325         }
 326
 327         if ( p_aout->output.output.i_format != AOUT_FMT_SPDIF )
 328         {
 329             mtime_t buffered = BufferDuration( p_aout );
 330
 331             /* Wait a bit - we don't want our buffer to be full */
 332             while( buffered > AOUT_PTS_TOLERANCE * 2 )
 333             {
 334                 msleep( buffered / 2 - 10000 );
 335                 buffered = BufferDuration( p_aout );
 336             }
 337
 338             if( !next_date )
 339             {
 340                 /* This is the _real_ presentation date */
 341                 next_date = mdate() + buffered;
 342             }
 343             else
 344             {
 345                 /* Give a hint to the audio output about our drift, but
 346                  * not too much because we want to make it happy with our
 347                  * nicely calculated dates. */
 348                 next_date = ( (next_date * 7) + (mdate() + buffered) ) / 8;
 349             }
 350
 351             /* Next buffer will be played at mdate()+buffered */
 352             p_buffer = aout_OutputNextBuffer( p_aout, next_date, VLC_FALSE );
 353         }
 354         else
 355         {
 356             p_buffer = aout_OutputNextBuffer( p_aout, 0, VLC_TRUE );
 357         }
 358
 359         if ( p_buffer != NULL )
 360         {
 361             p_bytes = p_buffer->p_buffer;
 362             i_size = p_buffer->i_nb_bytes;
 363             /* This is theoretical ... we'll see next iteration whether
 364              * we're drifting */
 365             next_date += p_buffer->end_date - p_buffer->start_date;
 366         }
 367         else
 368         {
 369             i_size = FRAME_SIZE / p_aout->output.output.i_frame_length
 370                       * p_aout->output.output.i_bytes_per_frame;
 371             p_bytes = malloc( i_size );
 372             memset( p_bytes, 0, i_size );
 373             next_date = 0;
 374         }
 375
 376         i_tmp = write( p_sys->i_fd, p_bytes, i_size );
 377
 378         if( i_tmp < 0 )
 379         {
 380             msg_Err( p_aout, "write failed (%s)", strerror(errno) );
 381         }
 382
 383         if ( p_buffer != NULL )
 384         {
 385             aout_BufferFree( p_buffer );
 386         }
 387         else
 388         {
 389             free( p_bytes );
 390         }
 391     }
 392
 393     return VLC_SUCCESS;
 394 }