35af45890d88d022a7d77e0df649931795e1b461
[vlc.git] / modules / audio_output / arts.c
1 /*****************************************************************************
2  * arts.c : aRts module
3  *****************************************************************************
4  * Copyright (C) 2001-2002 VideoLAN
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., 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_category( CAT_AUDIO );
69     set_subcategory( SUBCAT_AUDIO_AOUT );
70    set_callbacks( Open, Close );
71 vlc_module_end();
72
73 /*****************************************************************************
74  * Open: open an aRts socket
75  *****************************************************************************/
76 static int Open( vlc_object_t *p_this )
77 {
78     aout_instance_t *p_aout = (aout_instance_t *)p_this;
79     struct aout_sys_t * p_sys;
80     int i_err;
81     int i_nb_channels;
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 VLC_ENOMEM;
89     }
90     p_aout->output.p_sys = p_sys;
91
92     i_err = arts_init();
93
94     if( i_err < 0 )
95     {
96         msg_Err( p_aout, "arts_init failed (%s)", arts_error_text(i_err) );
97         free( p_sys );
98         return VLC_EGENERIC;
99     }
100
101     p_aout->output.pf_play = Play;
102     aout_VolumeSoftInit( p_aout );
103
104     p_aout->output.output.i_format = AOUT_FMT_S16_NE;
105     i_nb_channels = aout_FormatNbChannels( &p_aout->output.output );
106     if ( i_nb_channels > 2 )
107     {
108         /* aRts doesn't support more than two channels. */
109         i_nb_channels = 2;
110         p_aout->output.output.i_physical_channels =
111             AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
112     }
113
114     /* Open a socket for playing a stream, set format to 16 bits */
115     p_sys->stream = arts_play_stream( p_aout->output.output.i_rate, 16,
116                                       i_nb_channels, "vlc" );
117     if( p_sys->stream == NULL )
118     {
119         msg_Err( p_aout, "cannot open aRts socket" );
120         free( p_sys );
121         return VLC_EGENERIC;
122     }
123
124     /* Try not to bufferize more than 200 ms */
125     arts_stream_set( p_sys->stream, ARTS_P_BUFFER_TIME, 50 );
126
127     /* Estimate latency with a half full buffer */
128     p_sys->latency = (mtime_t)1000
129        * (mtime_t)arts_stream_get( p_sys->stream, ARTS_P_SERVER_LATENCY );
130     p_sys->i_size = arts_stream_get( p_sys->stream, ARTS_P_PACKET_SIZE );
131
132     msg_Dbg( p_aout, "aRts initialized, latency %i000, %i packets of size %i",
133                      arts_stream_get( p_sys->stream, ARTS_P_SERVER_LATENCY ),
134                      arts_stream_get( p_sys->stream, ARTS_P_PACKET_COUNT ),
135                      arts_stream_get( p_sys->stream, ARTS_P_PACKET_SIZE ) );
136
137     p_aout->output.i_nb_samples = p_sys->i_size / sizeof(uint16_t)
138                                                 / i_nb_channels;
139
140     return VLC_SUCCESS;
141 }
142
143 /*****************************************************************************
144  * Play: nothing to do
145  *****************************************************************************/
146 static void Play( aout_instance_t *p_aout )
147 {
148     struct aout_sys_t * p_sys = p_aout->output.p_sys;
149     aout_buffer_t * p_buffer;
150     int i_tmp;
151
152 #if 0
153     while( arts_stream_get( p_sys->stream, ARTS_P_BUFFER_SPACE ) < 16384*3/2 )
154     {
155         msleep( 10000 );
156     }
157 #endif
158
159     p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
160
161     if( p_buffer != NULL )
162     {
163         i_tmp = arts_write( p_sys->stream, p_buffer->p_buffer,
164                                            p_buffer->i_nb_bytes );
165
166         if( i_tmp < 0 )
167         {
168             msg_Err( p_aout, "write failed (%s)", arts_error_text(i_tmp) );
169         }
170
171         aout_BufferFree( p_buffer );
172     }
173 }
174
175 /*****************************************************************************
176  * Close: close the aRts socket
177  *****************************************************************************/
178 static void Close( vlc_object_t *p_this )
179 {
180     aout_instance_t *p_aout = (aout_instance_t *)p_this;
181     struct aout_sys_t * p_sys = p_aout->output.p_sys;
182
183     arts_close_stream( p_sys->stream );
184     arts_free();
185     free( p_sys );
186 }
187