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 <unistd.h>                                      /* write(), close() */
  29
  30 #include <vlc/vlc.h>
  31 #include <vlc_aout.h>
  32
  33 #include <artsc.h>
  34
  35 /*****************************************************************************
  36  * aout_sys_t: arts audio output method descriptor
  37  *****************************************************************************
  38  * This structure is part of the audio output thread descriptor.
  39  * It describes some arts specific variables.
  40  *****************************************************************************/
  41 struct aout_sys_t
  42 {
  43     arts_stream_t stream;
  44
  45     mtime_t       latency;
  46     int           i_size;
  47 };
  48
  49 /*****************************************************************************
  50  * Local prototypes
  51  *****************************************************************************/
  52 static int  Open         ( vlc_object_t * );
  53 static void Close        ( vlc_object_t * );
  54 static void Play         ( aout_instance_t * );
  55
  56 /*****************************************************************************
  57  * Module descriptor
  58  *****************************************************************************/
  59 vlc_module_begin();
  60    set_shortname( "aRts" );
  61    set_description( _("aRts audio output") );
  62    set_capability( "audio output", 50 );
  63     set_category( CAT_AUDIO );
  64     set_subcategory( SUBCAT_AUDIO_AOUT );
  65    set_callbacks( Open, Close );
  66 vlc_module_end();
  67
  68 /*****************************************************************************
  69  * Open: open an aRts socket
  70  *****************************************************************************/
  71 static int Open( vlc_object_t *p_this )
  72 {
  73     aout_instance_t *p_aout = (aout_instance_t *)p_this;
  74     struct aout_sys_t * p_sys;
  75     int i_err;
  76     int i_nb_channels;
  77
  78     /* Allocate structure */
  79     p_sys = malloc( sizeof( aout_sys_t ) );
  80     if( p_sys == NULL )
  81     {
  82         msg_Err( p_aout, "out of memory" );
  83         return VLC_ENOMEM;
  84     }
  85     p_aout->output.p_sys = p_sys;
  86
  87     i_err = arts_init();
  88
  89     if( i_err < 0 )
  90     {
  91         msg_Err( p_aout, "arts_init failed (%s)", arts_error_text(i_err) );
  92         free( p_sys );
  93         return VLC_EGENERIC;
  94     }
  95
  96     p_aout->output.pf_play = Play;
  97     aout_VolumeSoftInit( p_aout );
  98
  99     p_aout->output.output.i_format = AOUT_FMT_S16_NE;
 100     i_nb_channels = aout_FormatNbChannels( &p_aout->output.output );
 101     if ( i_nb_channels > 2 )
 102     {
 103         /* aRts doesn't support more than two channels. */
 104         i_nb_channels = 2;
 105         p_aout->output.output.i_physical_channels =
 106             AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
 107     }
 108
 109     /* Open a socket for playing a stream, set format to 16 bits */
 110     p_sys->stream = arts_play_stream( p_aout->output.output.i_rate, 16,
 111                                       i_nb_channels, "vlc" );
 112     if( p_sys->stream == NULL )
 113     {
 114         msg_Err( p_aout, "cannot open aRts socket" );
 115         free( p_sys );
 116         return VLC_EGENERIC;
 117     }
 118
 119     /* Try not to bufferize more than 200 ms */
 120     arts_stream_set( p_sys->stream, ARTS_P_BUFFER_TIME, 50 );
 121
 122     /* Estimate latency with a half full buffer */
 123     p_sys->latency = (mtime_t)1000
 124        * (mtime_t)arts_stream_get( p_sys->stream, ARTS_P_SERVER_LATENCY );
 125     p_sys->i_size = arts_stream_get( p_sys->stream, ARTS_P_PACKET_SIZE );
 126
 127     msg_Dbg( p_aout, "aRts initialized, latency %i000, %i packets of size %i",
 128                      arts_stream_get( p_sys->stream, ARTS_P_SERVER_LATENCY ),
 129                      arts_stream_get( p_sys->stream, ARTS_P_PACKET_COUNT ),
 130                      arts_stream_get( p_sys->stream, ARTS_P_PACKET_SIZE ) );
 131
 132     p_aout->output.i_nb_samples = p_sys->i_size / sizeof(uint16_t)
 133                                                 / i_nb_channels;
 134
 135     return VLC_SUCCESS;
 136 }
 137
 138 /*****************************************************************************
 139  * Play: nothing to do
 140  *****************************************************************************/
 141 static void Play( aout_instance_t *p_aout )
 142 {
 143     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 144     aout_buffer_t * p_buffer;
 145     int i_tmp;
 146
 147 #if 0
 148     while( arts_stream_get( p_sys->stream, ARTS_P_BUFFER_SPACE ) < 16384*3/2 )
 149     {
 150         msleep( 10000 );
 151     }
 152 #endif
 153
 154     p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
 155
 156     if( p_buffer != NULL )
 157     {
 158         i_tmp = arts_write( p_sys->stream, p_buffer->p_buffer,
 159                                            p_buffer->i_nb_bytes );
 160
 161         if( i_tmp < 0 )
 162         {
 163             msg_Err( p_aout, "write failed (%s)", arts_error_text(i_tmp) );
 164         }
 165
 166         aout_BufferFree( p_buffer );
 167     }
 168 }
 169
 170 /*****************************************************************************
 171  * Close: close the aRts socket
 172  *****************************************************************************/
 173 static void Close( vlc_object_t *p_this )
 174 {
 175     aout_instance_t *p_aout = (aout_instance_t *)p_this;
 176     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 177
 178     arts_close_stream( p_sys->stream );
 179     arts_free();
 180     free( p_sys );
 181 }
 182