1 /*****************************************************************************
2 * jack : JACK audio output module
3 *****************************************************************************
4 * Copyright (C) 2006 the VideoLAN team
7 * Authors: Cyril Deguet <asmax _at_ videolan.org>
8 * Jon Griffiths <jon_p_griffiths _At_ yahoo _DOT_ com>
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.
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.
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 *****************************************************************************/
25 * \file modules/audio_output/jack.c
26 * \brief JACK audio output functions
28 /*****************************************************************************
30 *****************************************************************************/
31 #include <unistd.h> /* write(), close() */
36 #include <jack/jack.h>
38 typedef jack_default_audio_sample_t jack_sample_t;
40 /*****************************************************************************
41 * aout_sys_t: JACK audio output method descriptor
42 *****************************************************************************
43 * This structure is part of the audio output thread descriptor.
44 * It describes some JACK specific variables.
45 *****************************************************************************/
48 jack_client_t *p_jack_client;
49 jack_port_t **p_jack_ports;
50 jack_sample_t **p_jack_buffers;
51 unsigned int i_channels;
54 /*****************************************************************************
56 *****************************************************************************/
57 static int Open ( vlc_object_t * );
58 static void Close ( vlc_object_t * );
59 static void Play ( aout_instance_t * );
60 static int Process ( jack_nframes_t i_frames, void *p_arg );
62 #define AUTO_CONNECT_OPTION "jack-auto-connect"
63 #define AUTO_CONNECT_TEXT N_("Automatically connect to writable clients")
64 #define AUTO_CONNECT_LONGTEXT N_( \
65 "If enabled, this option will automatically connect sound output to the " \
66 "first writable JACK clients found." )
68 #define CONNECT_REGEX_OPTION "jack-connect-regex"
69 #define CONNECT_REGEX_TEXT N_("Connect to clients matching")
70 #define CONNECT_REGEX_LONGTEXT N_( \
71 "If automatic connection is enabled, only JACK clients whose names " \
72 "match this regular expression will be considered for connection." )
74 /*****************************************************************************
76 *****************************************************************************/
78 set_shortname( "JACK" );
79 set_description( _("JACK audio output") );
80 set_capability( "audio output", 100 );
81 set_category( CAT_AUDIO );
82 set_subcategory( SUBCAT_AUDIO_AOUT );
83 add_bool( AUTO_CONNECT_OPTION, 0, NULL, AUTO_CONNECT_TEXT,
84 AUTO_CONNECT_LONGTEXT, VLC_TRUE );
86 add_string( CONNECT_REGEX_OPTION, NULL, NULL, CONNECT_REGEX_TEXT,
87 CONNECT_REGEX_LONGTEXT, VLC_TRUE );
89 set_callbacks( Open, Close );
92 /*****************************************************************************
93 * Open: create a JACK client
94 *****************************************************************************/
95 static int Open( vlc_object_t *p_this )
98 aout_instance_t *p_aout = (aout_instance_t *)p_this;
99 struct aout_sys_t *p_sys = NULL;
100 int status = VLC_SUCCESS;
104 /* Allocate structure */
105 p_sys = calloc( 1, sizeof( aout_sys_t ) );
108 msg_Err( p_aout, "out of memory" );
112 p_aout->output.p_sys = p_sys;
114 /* Connect to the JACK server */
115 snprintf( psz_name, sizeof(psz_name), "vlc_%d", getpid());
116 psz_name[sizeof(psz_name) - 1] = '\0';
117 p_sys->p_jack_client = jack_client_new( psz_name );
118 if( p_sys->p_jack_client == NULL )
120 msg_Err( p_aout, "failed to connect to JACK server" );
121 status = VLC_EGENERIC;
125 /* Set the process callback */
126 jack_set_process_callback( p_sys->p_jack_client, Process, p_aout );
128 p_aout->output.pf_play = Play;
129 aout_VolumeSoftInit( p_aout );
131 /* JACK only supports fl32 format */
132 p_aout->output.output.i_format = VLC_FOURCC('f','l','3','2');
133 // TODO add buffer size callback
134 p_aout->output.i_nb_samples = jack_get_buffer_size( p_sys->p_jack_client );
135 p_aout->output.output.i_rate = jack_get_sample_rate( p_sys->p_jack_client );
137 p_sys->i_channels = aout_FormatNbChannels( &p_aout->output.output );
139 p_sys->p_jack_ports = malloc( p_sys->i_channels *
140 sizeof(jack_port_t *) );
141 if( p_sys->p_jack_ports == NULL )
143 msg_Err( p_aout, "out of memory" );
148 p_sys->p_jack_buffers = malloc( p_sys->i_channels *
149 sizeof(jack_sample_t *) );
150 if( p_sys->p_jack_buffers == NULL )
152 msg_Err( p_aout, "out of memory" );
157 /* Create the output ports */
158 for( i = 0; i < p_sys->i_channels; i++ )
160 snprintf( psz_name, sizeof(psz_name), "out_%d", i + 1);
161 psz_name[sizeof(psz_name) - 1] = '\0';
162 p_sys->p_jack_ports[i] = jack_port_register( p_sys->p_jack_client,
163 psz_name, JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0 );
165 if( p_sys->p_jack_ports[i] == NULL )
167 msg_Err( p_aout, "failed to register a JACK port" );
168 status = VLC_EGENERIC;
173 /* Tell the JACK server we are ready */
174 i_error = jack_activate( p_sys->p_jack_client );
177 msg_Err( p_aout, "failed to activate JACK client (error %d)", i_error );
178 status = VLC_EGENERIC;
182 /* Auto connect ports if we were asked to */
183 if( config_GetInt( p_aout, AUTO_CONNECT_OPTION ) )
185 unsigned int i_in_ports;
186 char *psz_regex = config_GetPsz( p_aout, CONNECT_REGEX_OPTION );
187 const char **pp_in_ports = jack_get_ports( p_sys->p_jack_client,
190 /* Count the number of returned ports */
192 while( pp_in_ports && pp_in_ports[i_in_ports] )
197 /* Tie the output ports to JACK input ports */
198 for( i = 0; i_in_ports > 0 && i < p_sys->i_channels; i++ )
200 const char* psz_in = pp_in_ports[i % i_in_ports];
201 const char* psz_out = jack_port_name( p_sys->p_jack_ports[i] );
203 i_error = jack_connect( p_sys->p_jack_client, psz_out, psz_in );
206 msg_Err( p_aout, "failed to connect port %s to port %s (error %d)",
207 psz_out, psz_in, i_error );
211 msg_Dbg( p_aout, "connecting port %s to port %s",
221 msg_Dbg( p_aout, "JACK audio output initialized (%d channels, buffer "
222 "size=%d, rate=%d)", p_sys->i_channels,
223 p_aout->output.i_nb_samples, p_aout->output.output.i_rate );
226 /* Clean up, if an error occurred */
227 if( status != VLC_SUCCESS && p_sys != NULL)
229 if( p_sys->p_jack_client )
231 jack_deactivate( p_sys->p_jack_client );
232 jack_client_close( p_sys->p_jack_client );
234 if( p_sys->p_jack_ports )
236 free( p_sys->p_jack_ports );
238 if( p_sys->p_jack_buffers )
240 free( p_sys->p_jack_buffers );
248 /*****************************************************************************
249 * Process: callback for JACK
250 *****************************************************************************/
251 int Process( jack_nframes_t i_frames, void *p_arg )
253 unsigned int i, j, i_nb_samples = 0;
254 aout_instance_t *p_aout = (aout_instance_t*) p_arg;
255 struct aout_sys_t *p_sys = p_aout->output.p_sys;
256 jack_sample_t *p_src = NULL;
258 /* Get the next audio data buffer */
259 aout_buffer_t *p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
260 if( p_buffer != NULL )
262 p_src = (jack_sample_t *)p_buffer->p_buffer;
263 i_nb_samples = p_buffer->i_nb_samples;
266 /* Get the JACK buffers to write to */
267 for( i = 0; i < p_sys->i_channels; i++ )
269 p_sys->p_jack_buffers[i] = jack_port_get_buffer( p_sys->p_jack_ports[i],
273 /* Copy in the audio data */
274 for( j = 0; j < i_nb_samples; j++ )
276 for( i = 0; i < p_sys->i_channels; i++ )
278 jack_sample_t *p_dst = p_sys->p_jack_buffers[i];
284 /* Fill any remaining buffer with silence */
285 if( i_nb_samples < i_frames )
287 for( i = 0; i < p_sys->i_channels; i++ )
289 memset( p_sys->p_jack_buffers[i] + i_nb_samples, 0,
290 sizeof( jack_sample_t ) * (i_frames - i_nb_samples) );
296 aout_BufferFree( p_buffer );
302 /*****************************************************************************
303 * Play: nothing to do
304 *****************************************************************************/
305 static void Play( aout_instance_t *p_aout )
307 aout_FifoFirstDate( p_aout, &p_aout->output.fifo );
310 /*****************************************************************************
311 * Close: close the JACK client
312 *****************************************************************************/
313 static void Close( vlc_object_t *p_this )
316 aout_instance_t *p_aout = (aout_instance_t *)p_this;
317 struct aout_sys_t *p_sys = p_aout->output.p_sys;
319 i_error = jack_deactivate( p_sys->p_jack_client );
322 msg_Err( p_aout, "jack_deactivate failed (error %d)", i_error );
325 i_error = jack_client_close( p_sys->p_jack_client );
328 msg_Err( p_aout, "jack_client_close failed (error %d)", i_error );
330 free( p_sys->p_jack_ports );
331 free( p_sys->p_jack_buffers );