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