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

   1 /*****************************************************************************
   2  * arts.c : aRts module
   3  *****************************************************************************
   4  * Copyright (C) 2001-2002 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Emmanuel Blindauer <manu@agat.net>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <string.h>                                            /* strerror() */
  29 #include <unistd.h>                                      /* write(), close() */
  30 #include <stdlib.h>                            /* calloc(), malloc(), free() */
  31
  32 #include <vlc/vlc.h>
  33 #include <vlc_aout.h>
  34
  35 #include <artsc.h>
  36
  37 /*****************************************************************************
  38  * aout_sys_t: arts audio output method descriptor
  39  *****************************************************************************
  40  * This structure is part of the audio output thread descriptor.
  41  * It describes some arts specific variables.
  42  *****************************************************************************/
  43 struct aout_sys_t
  44 {
  45     arts_stream_t stream;
  46
  47     mtime_t       latency;
  48     int           i_size;
  49 };
  50
  51 /*****************************************************************************
  52  * Local prototypes
  53  *****************************************************************************/
  54 static int  Open         ( vlc_object_t * );
  55 static void Close        ( vlc_object_t * );
  56 static void Play         ( aout_instance_t * );
  57
  58 /*****************************************************************************
  59  * Module descriptor
  60  *****************************************************************************/
  61 vlc_module_begin();
  62    set_shortname( "aRts" );
  63    set_description( _("aRts audio output") );
  64    set_capability( "audio output", 50 );
  65     set_category( CAT_AUDIO );
  66     set_subcategory( SUBCAT_AUDIO_AOUT );
  67    set_callbacks( Open, Close );
  68 vlc_module_end();
  69
  70 /*****************************************************************************
  71  * Open: open an aRts socket
  72  *****************************************************************************/
  73 static int Open( vlc_object_t *p_this )
  74 {
  75     aout_instance_t *p_aout = (aout_instance_t *)p_this;
  76     struct aout_sys_t * p_sys;
  77     int i_err;
  78     int i_nb_channels;
  79
  80     /* Allocate structure */
  81     p_sys = malloc( sizeof( aout_sys_t ) );
  82     if( p_sys == NULL )
  83     {
  84         msg_Err( p_aout, "out of memory" );
  85         return VLC_ENOMEM;
  86     }
  87     p_aout->output.p_sys = p_sys;
  88
  89     i_err = arts_init();
  90
  91     if( i_err < 0 )
  92     {
  93         msg_Err( p_aout, "arts_init failed (%s)", arts_error_text(i_err) );
  94         free( p_sys );
  95         return VLC_EGENERIC;
  96     }
  97
  98     p_aout->output.pf_play = Play;
  99     aout_VolumeSoftInit( p_aout );
 100
 101     p_aout->output.output.i_format = AOUT_FMT_S16_NE;
 102     i_nb_channels = aout_FormatNbChannels( &p_aout->output.output );
 103     if ( i_nb_channels > 2 )
 104     {
 105         /* aRts doesn't support more than two channels. */
 106         i_nb_channels = 2;
 107         p_aout->output.output.i_physical_channels =
 108             AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
 109     }
 110
 111     /* Open a socket for playing a stream, set format to 16 bits */
 112     p_sys->stream = arts_play_stream( p_aout->output.output.i_rate, 16,
 113                                       i_nb_channels, "vlc" );
 114     if( p_sys->stream == NULL )
 115     {
 116         msg_Err( p_aout, "cannot open aRts socket" );
 117         free( p_sys );
 118         return VLC_EGENERIC;
 119     }
 120
 121     /* Try not to bufferize more than 200 ms */
 122     arts_stream_set( p_sys->stream, ARTS_P_BUFFER_TIME, 50 );
 123
 124     /* Estimate latency with a half full buffer */
 125     p_sys->latency = (mtime_t)1000
 126        * (mtime_t)arts_stream_get( p_sys->stream, ARTS_P_SERVER_LATENCY );
 127     p_sys->i_size = arts_stream_get( p_sys->stream, ARTS_P_PACKET_SIZE );
 128
 129     msg_Dbg( p_aout, "aRts initialized, latency %i000, %i packets of size %i",
 130                      arts_stream_get( p_sys->stream, ARTS_P_SERVER_LATENCY ),
 131                      arts_stream_get( p_sys->stream, ARTS_P_PACKET_COUNT ),
 132                      arts_stream_get( p_sys->stream, ARTS_P_PACKET_SIZE ) );
 133
 134     p_aout->output.i_nb_samples = p_sys->i_size / sizeof(uint16_t)
 135                                                 / i_nb_channels;
 136
 137     return VLC_SUCCESS;
 138 }
 139
 140 /*****************************************************************************
 141  * Play: nothing to do
 142  *****************************************************************************/
 143 static void Play( aout_instance_t *p_aout )
 144 {
 145     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 146     aout_buffer_t * p_buffer;
 147     int i_tmp;
 148
 149 #if 0
 150     while( arts_stream_get( p_sys->stream, ARTS_P_BUFFER_SPACE ) < 16384*3/2 )
 151     {
 152         msleep( 10000 );
 153     }
 154 #endif
 155
 156     p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
 157
 158     if( p_buffer != NULL )
 159     {
 160         i_tmp = arts_write( p_sys->stream, p_buffer->p_buffer,
 161                                            p_buffer->i_nb_bytes );
 162
 163         if( i_tmp < 0 )
 164         {
 165             msg_Err( p_aout, "write failed (%s)", arts_error_text(i_tmp) );
 166         }
 167
 168         aout_BufferFree( p_buffer );
 169     }
 170 }
 171
 172 /*****************************************************************************
 173  * Close: close the aRts socket
 174  *****************************************************************************/
 175 static void Close( vlc_object_t *p_this )
 176 {
 177     aout_instance_t *p_aout = (aout_instance_t *)p_this;
 178     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 179
 180     arts_close_stream( p_sys->stream );
 181     arts_free();
 182     free( p_sys );
 183 }
 184