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