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

   1 /*****************************************************************************
   2  * arts.c : aRts module
   3  *****************************************************************************
   4  * Copyright (C) 2001-2002 VideoLAN
   5  *
   6  * Authors: Emmanuel Blindauer <manu@agat.net>
   7  *          Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <errno.h>                                                 /* ENOMEM */
  28 #include <fcntl.h>                                       /* open(), O_WRONLY */
  29 #include <string.h>                                            /* strerror() */
  30 #include <unistd.h>                                      /* write(), close() */
  31 #include <stdlib.h>                            /* calloc(), malloc(), free() */
  32
  33 #include <vlc/vlc.h>
  34 #include <vlc/aout.h>
  35
  36 #include "aout_internal.h"
  37
  38 #include <artsc.h>
  39
  40 /*****************************************************************************
  41  * aout_sys_t: arts audio output method descriptor
  42  *****************************************************************************
  43  * This structure is part of the audio output thread descriptor.
  44  * It describes some arts specific variables.
  45  *****************************************************************************/
  46 struct aout_sys_t
  47 {
  48     arts_stream_t stream;
  49     vlc_bool_t    b_initialized;
  50
  51     mtime_t       latency;
  52     int           i_size;
  53 };
  54
  55 /*****************************************************************************
  56  * Local prototypes
  57  *****************************************************************************/
  58 static int  Open         ( vlc_object_t * );
  59 static void Close        ( vlc_object_t * );
  60
  61 static int  SetFormat    ( aout_instance_t * );
  62 static void Play         ( aout_instance_t *, aout_buffer_t * );
  63 static int  aRtsThread   ( aout_instance_t * );
  64
  65 /*****************************************************************************
  66  * Module descriptor
  67  *****************************************************************************/
  68 vlc_module_begin();
  69    set_description( _("aRts audio module") );
  70    set_capability( "audio output", 50 );
  71    set_callbacks( Open, Close );
  72 vlc_module_end();
  73
  74 /*****************************************************************************
  75  * Open: open an aRts socket
  76  *****************************************************************************/
  77 static int Open( vlc_object_t *p_this )
  78 {
  79     aout_instance_t *p_aout = (aout_instance_t *)p_this;
  80     struct aout_sys_t * p_sys;
  81     int i_err;
  82
  83     /* Allocate structure */
  84     p_sys = malloc( sizeof( aout_sys_t ) );
  85     if( p_sys == NULL )
  86     {
  87         msg_Err( p_aout, "out of memory" );
  88         return -1;
  89     }
  90
  91     i_err = arts_init();
  92
  93     if (i_err < 0)
  94     {
  95         msg_Err( p_aout, "arts_init failed (%s)", arts_error_text(i_err) );
  96         free( p_sys );
  97         return -1;
  98     }
  99
 100     p_aout->output.p_sys = p_sys;
 101
 102     /* Create aRts thread and wait for its readiness. */
 103     p_sys->b_initialized = VLC_FALSE;
 104     if( vlc_thread_create( p_aout, "aout", aRtsThread, VLC_FALSE ) )
 105     {
 106         msg_Err( p_aout, "cannot create aRts thread (%s)", strerror(errno) );
 107         free( p_sys );
 108         return -1;
 109     }
 110
 111     p_aout->output.pf_setformat = SetFormat;
 112     p_aout->output.pf_play = Play;
 113
 114     p_sys->stream = NULL;
 115
 116     return 0;
 117 }
 118
 119 /*****************************************************************************
 120  * SetFormat: set the output format
 121  *****************************************************************************/
 122 static int SetFormat( aout_instance_t *p_aout )
 123 {
 124     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 125
 126     p_sys->b_initialized = VLC_FALSE;
 127
 128     if( p_sys->stream )
 129     {
 130         arts_close_stream( p_sys->stream );
 131     }
 132
 133     /* open a socket for playing a stream */
 134     p_sys->stream = arts_play_stream( p_aout->output.output.i_rate, 16,
 135                                       p_aout->output.output.i_channels, "vlc" );
 136     if( p_sys->stream == NULL )
 137     {
 138         msg_Err( p_aout, "cannot open aRts socket" );
 139         return -1;
 140     }
 141
 142     /* Try not to bufferize more than 200 ms */
 143     arts_stream_set( p_sys->stream, ARTS_P_BUFFER_TIME, 200 );
 144
 145     /* Estimate latency with a half full buffer */
 146     p_sys->latency = (mtime_t)1000
 147        * (mtime_t)( arts_stream_get( p_sys->stream, ARTS_P_SERVER_LATENCY )
 148                   + arts_stream_get( p_sys->stream, ARTS_P_BUFFER_TIME ) / 2 );
 149     p_sys->i_size = arts_stream_get( p_sys->stream, ARTS_P_PACKET_SIZE );
 150
 151     p_aout->output.output.i_format = AOUT_FMT_S16_NE;
 152     p_aout->output.i_nb_samples = p_sys->i_size;
 153
 154     p_sys->b_initialized = VLC_TRUE;
 155
 156     return 0;
 157 }
 158
 159 /*****************************************************************************
 160  * Play: queue a buffer for playing by aRtsThread
 161  *****************************************************************************/
 162 static void Play( aout_instance_t *p_aout, aout_buffer_t * p_buffer )
 163 {
 164     aout_FifoPush( p_aout, &p_aout->output.fifo, p_buffer );
 165 }
 166
 167 /*****************************************************************************
 168  * Close: close the aRts socket
 169  *****************************************************************************/
 170 static void Close( vlc_object_t *p_this )
 171 {
 172     aout_instance_t *p_aout = (aout_instance_t *)p_this;
 173     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 174
 175     p_aout->b_die = 1;
 176     vlc_thread_join( p_aout );
 177
 178     if( p_sys->stream )
 179     {
 180         arts_close_stream( p_sys->stream );
 181     }
 182
 183     arts_free();
 184     free( p_sys );
 185 }
 186
 187 /*****************************************************************************
 188  * aRtsThread: asynchronous thread used to DMA the data to the device
 189  *****************************************************************************/
 190 static int aRtsThread( aout_instance_t * p_aout )
 191 {
 192     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 193
 194     while ( !p_aout->b_die )
 195     {
 196         aout_buffer_t * p_buffer;
 197         int i_tmp, i_size;
 198         byte_t * p_bytes;
 199
 200         if( !p_sys->b_initialized )
 201         {
 202             msleep( THREAD_SLEEP );
 203             continue;
 204         }
 205
 206         /* Get the presentation date of the next write() operation. It
 207          * is equal to the current date + latency */
 208         p_buffer = aout_OutputNextBuffer( p_aout, mdate() + p_sys->latency, 0 );
 209
 210         if ( p_buffer != NULL )
 211         {
 212             p_bytes = p_buffer->p_buffer;
 213             i_size = p_buffer->i_nb_bytes;
 214         }
 215         else
 216         {
 217             i_size = aout_FormatToByterate( &p_aout->output.output )
 218                       * p_sys->i_size
 219                       / p_aout->output.output.i_rate;
 220             p_bytes = alloca( i_size );
 221             memset( p_bytes, 0, i_size );
 222         }
 223
 224         i_tmp = arts_write( p_sys->stream, p_bytes, i_size );
 225
 226         if( i_tmp < 0 )
 227         {
 228             msg_Err( p_aout, "write failed (%s)", arts_error_text(i_tmp) );
 229         }
 230
 231         if ( p_buffer != NULL )
 232         {
 233             aout_BufferFree( p_buffer );
 234         }
 235     }
 236
 237     return 0;
 238 }
 239