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