git.sesse.net Git - vlc/blob - plugins/sdl/aout_sdl.c

   1 /*****************************************************************************
   2  * aout_sdl.c : audio sdl functions library
   3  *****************************************************************************
   4  * Copyright (C) 1999, 2000 VideoLAN
   5  * $Id: aout_sdl.c,v 1.15 2001/07/25 08:41:21 gbazin Exp $
   6  *
   7  * Authors: Michel Kaempf <maxx@via.ecp.fr>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *          Pierre Baillet <oct@zoy.org>
  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 #define MODULE_NAME sdl
  27 #include "modules_inner.h"
  28
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32 #include "defs.h"
  33
  34 #include <errno.h>                                                 /* ENOMEM */
  35 #include <fcntl.h>                                       /* open(), O_WRONLY */
  36 #include <string.h>                                            /* strerror() */
  37 #include <unistd.h>                                      /* write(), close() */
  38 #include <stdio.h>                                           /* "intf_msg.h" */
  39 #include <stdlib.h>                            /* calloc(), malloc(), free() */
  40
  41 #include <SDL/SDL.h>                                     /* SDL base include */
  42
  43 #include "config.h"
  44 #include "common.h"                                     /* boolean_t, byte_t */
  45 #include "threads.h"
  46 #include "mtime.h"
  47 #include "tests.h"
  48
  49 #include "audio_output.h"                                   /* aout_thread_t */
  50
  51 #include "intf_msg.h"                        /* intf_DbgMsg(), intf_ErrMsg() */
  52 #include "main.h"
  53
  54 #include "modules.h"
  55 #include "modules_export.h"
  56
  57 /*****************************************************************************
  58  * aout_sys_t: dsp audio output method descriptor
  59  *****************************************************************************
  60  * This structure is part of the audio output thread descriptor.
  61  * It describes the dsp specific properties of an audio device.
  62  *****************************************************************************/
  63
  64 /* the overflow limit is used to prevent the fifo from growing too big */
  65 #define OVERFLOWLIMIT 100000
  66
  67 typedef struct aout_sys_s
  68 {
  69     byte_t  * audio_buf;
  70     int i_audio_end;
  71
  72     boolean_t b_active;
  73
  74 } aout_sys_t;
  75
  76 /*****************************************************************************
  77  * Local prototypes.
  78  *****************************************************************************/
  79 static int     aout_Probe       ( probedata_t *p_data );
  80 static int     aout_Open        ( aout_thread_t *p_aout );
  81 static int     aout_SetFormat   ( aout_thread_t *p_aout );
  82 static long    aout_GetBufInfo  ( aout_thread_t *p_aout, long l_buffer_info );
  83 static void    aout_Play        ( aout_thread_t *p_aout,
  84                                   byte_t *buffer, int i_size );
  85 static void    aout_Close       ( aout_thread_t *p_aout );
  86
  87 static void    aout_SDLCallback ( void *userdata, Uint8 *stream, int len );
  88
  89 /*****************************************************************************
  90  * Functions exported as capabilities. They are declared as static so that
  91  * we don't pollute the namespace too much.
  92  *****************************************************************************/
  93 void _M( aout_getfunctions )( function_list_t * p_function_list )
  94 {
  95     p_function_list->pf_probe = aout_Probe;
  96     p_function_list->functions.aout.pf_open = aout_Open;
  97     p_function_list->functions.aout.pf_setformat = aout_SetFormat;
  98     p_function_list->functions.aout.pf_getbufinfo = aout_GetBufInfo;
  99     p_function_list->functions.aout.pf_play = aout_Play;
 100     p_function_list->functions.aout.pf_close = aout_Close;
 101 }
 102
 103 /*****************************************************************************
 104  * aout_Probe: probe the audio device and return a score
 105  *****************************************************************************
 106  * This function tries to initialize SDL audio and returns a score to the
 107  * plugin manager so that it can select the best plugin.
 108  *****************************************************************************/
 109 static int aout_Probe( probedata_t *p_data )
 110 {
 111 #if 0
 112     SDL_AudioSpec desired, obtained;
 113
 114     /* Start AudioSDL */
 115     if( SDL_Init(SDL_INIT_AUDIO | SDL_INIT_NOPARACHUTE) != 0 )
 116     {
 117         intf_DbgMsg( "aout: SDL_Init failed (%s)", SDL_GetError() );
 118         return( 0 );
 119     }
 120
 121     desired.freq       = 11025;                                 /* frequency */
 122     desired.format     = AUDIO_U8;                        /* unsigned 8 bits */
 123     desired.channels   = 2;                                          /* mono */
 124     desired.callback   = aout_SDLCallback;    /* callback function mandatory */
 125     desired.userdata   = NULL;                     /* null parm for callback */
 126     desired.samples    = 4096;
 127
 128     /* If we were unable to open the device, there is no way we can use
 129      * the plugin. Return a score of 0. */
 130     if( SDL_OpenAudio( &desired, &obtained ) < 0 )
 131     {
 132         intf_DbgMsg( "aout: SDL_OpenAudio failed (%s)", SDL_GetError() );
 133         return( 0 );
 134     }
 135
 136     /* Otherwise, there are good chances we can use this plugin, return 100. */
 137     intf_DbgMsg( "aout: SDL_OpenAudio successfully run" );
 138     SDL_CloseAudio();
 139 #endif
 140
 141     if( TestMethod( AOUT_METHOD_VAR, "sdl" ) )
 142     {
 143         return( 999 );
 144     }
 145
 146     return( 40 );
 147 }
 148
 149 /*****************************************************************************
 150  * aout_Open: open the audio device
 151  *****************************************************************************
 152  * This function opens the dsp as a usual non-blocking write-only file, and
 153  * modifies the p_aout->i_fd with the file's descriptor.
 154  *****************************************************************************/
 155 static int aout_Open( aout_thread_t *p_aout )
 156 {
 157     SDL_AudioSpec desired;
 158     int i_channels = p_aout->b_stereo ? 2 : 1;
 159
 160    /* Allocate structure */
 161     p_aout->p_sys = malloc( sizeof( aout_sys_t ) );
 162
 163     if( p_aout->p_sys == NULL )
 164     {
 165         intf_ErrMsg( "aout error: %s", strerror(ENOMEM) );
 166         return( 1 );
 167     }
 168
 169     p_aout->p_sys->i_audio_end = 0;
 170     p_aout->p_sys->audio_buf = malloc( OVERFLOWLIMIT );
 171
 172     /* Initialize some variables */
 173     p_aout->psz_device = 0;
 174     p_aout->i_format   = AOUT_FORMAT_DEFAULT;
 175     p_aout->i_channels = 1 + main_GetIntVariable( AOUT_STEREO_VAR,
 176                                                   AOUT_STEREO_DEFAULT );
 177     p_aout->l_rate     = main_GetIntVariable( AOUT_RATE_VAR,
 178                                               AOUT_RATE_DEFAULT );
 179
 180     desired.freq =     p_aout->l_rate;
 181
 182     /* TODO: write conversion beetween AOUT_FORMAT_DEFAULT
 183      * AND AUDIO* from SDL. */
 184     desired.format     = AUDIO_S16LSB;                     /* stereo 16 bits */
 185     desired.channels   = i_channels;
 186     desired.callback   = aout_SDLCallback;
 187     desired.userdata   = p_aout->p_sys;
 188     desired.samples    = 1024;
 189
 190     /* Open the sound device
 191      * we just ask the SDL to wrap at the good frequency if the one we
 192      * ask for is unavailable. This is done by setting the second parar
 193      * to NULL
 194      */
 195     if( SDL_OpenAudio( &desired, NULL ) < 0 )
 196     {
 197         intf_ErrMsg( "aout error: SDL_OpenAudio failed (%s)", SDL_GetError() );
 198         return( -1 );
 199     }
 200
 201     p_aout->p_sys->b_active = 1;
 202     SDL_PauseAudio( 0 );
 203
 204     return( 0 );
 205 }
 206
 207 /*****************************************************************************
 208  * aout_SetFormat: reset the audio device and sets its format
 209  *****************************************************************************
 210  * This functions resets the audio device, tries to initialize the output
 211  * format with the value contained in the dsp structure, and if this value
 212  * could not be set, the default value returned by ioctl is set. It then
 213  * does the same for the stereo mode, and for the output rate.
 214  *****************************************************************************/
 215 static int aout_SetFormat( aout_thread_t *p_aout )
 216 {
 217     /* TODO: finish and clean this */
 218     SDL_AudioSpec desired;
 219     int i_stereo = p_aout->b_stereo ? 2 : 1;
 220
 221     /*i_format = p_aout->i_format;*/
 222     desired.freq       = p_aout->l_rate;             /* Set the output rate */
 223     desired.format     = AUDIO_S16LSB;                    /* stereo 16 bits */
 224     desired.channels   = i_stereo;
 225     desired.callback   = aout_SDLCallback;
 226     desired.userdata   = p_aout->p_sys;
 227     desired.samples    = 2048;
 228
 229     /* Open the sound device */
 230     SDL_PauseAudio( 1 );
 231     SDL_CloseAudio();
 232
 233     if( SDL_OpenAudio( &desired, NULL ) < 0 )
 234     {
 235         p_aout->p_sys->b_active = 0;
 236         return( -1 );
 237     }
 238
 239     p_aout->p_sys->b_active = 1;
 240     SDL_PauseAudio( 0 );
 241
 242     p_aout->i_latency = 0;
 243
 244     return( 0 );
 245 }
 246
 247 /*****************************************************************************
 248  * aout_GetBufInfo: buffer status query
 249  *****************************************************************************
 250  * returns the number of bytes in the audio buffer compared to the size of
 251  * l_buffer_limit...
 252  *****************************************************************************/
 253 static long aout_GetBufInfo( aout_thread_t *p_aout, long l_buffer_limit )
 254 {
 255     if(l_buffer_limit > p_aout->p_sys->i_audio_end)
 256     {
 257         /* returning 0 here juste gives awful sound in the speakers :/ */
 258         return( l_buffer_limit );
 259     }
 260     return( p_aout->p_sys->i_audio_end - l_buffer_limit);
 261 }
 262
 263 /*****************************************************************************
 264  * aout_Play: play a sound samples buffer
 265  *****************************************************************************
 266  * This function writes a buffer of i_length bytes in the dsp
 267  *****************************************************************************/
 268 static void aout_Play( aout_thread_t *p_aout, byte_t *buffer, int i_size )
 269 {
 270     byte_t * audio_buf = p_aout->p_sys->audio_buf;
 271
 272     SDL_LockAudio();                                     /* Stop callbacking */
 273
 274     p_aout->p_sys->audio_buf = realloc( audio_buf,
 275                                         p_aout->p_sys->i_audio_end + i_size);
 276     memcpy( p_aout->p_sys->audio_buf + p_aout->p_sys->i_audio_end,
 277             buffer, i_size);
 278
 279     p_aout->p_sys->i_audio_end += i_size;
 280
 281     SDL_UnlockAudio();                                  /* go on callbacking */
 282 }
 283
 284 /*****************************************************************************
 285  * aout_Close: close the audio device
 286  *****************************************************************************/
 287 static void aout_Close( aout_thread_t *p_aout )
 288 {
 289     if( p_aout->p_sys->b_active )
 290     {
 291         SDL_PauseAudio( 1 );                                  /* pause audio */
 292
 293         if( p_aout->p_sys->audio_buf != NULL )  /* do we have a buffer now ? */
 294         {
 295             free( p_aout->p_sys->audio_buf );
 296         }
 297     }
 298
 299     SDL_CloseAudio();
 300
 301     free( p_aout->p_sys );                              /* Close the Output. */
 302 }
 303
 304 /*****************************************************************************
 305  * aout_SDLCallback: what to do once SDL has played sound samples
 306  *****************************************************************************/
 307 static void aout_SDLCallback( void *userdata, byte_t *stream, int len )
 308 {
 309     struct aout_sys_s * p_sys = userdata;
 310
 311     if( p_sys->i_audio_end > OVERFLOWLIMIT )
 312     {
 313         intf_ErrMsg( "aout error: aout_SDLCallback overflowed" );
 314
 315         free( p_sys->audio_buf );
 316         p_sys->audio_buf = NULL;
 317
 318         p_sys->i_audio_end = 0;
 319         /* we've gone to slow, increase output freq */
 320     }
 321
 322     /* if we are not in underrun */
 323     if( p_sys->i_audio_end > len )
 324     {
 325         p_sys->i_audio_end -= len;
 326         memcpy( stream, p_sys->audio_buf, len );
 327         memmove( p_sys->audio_buf, p_sys->audio_buf + len, p_sys->i_audio_end );
 328     }
 329 }
 330