1 /*****************************************************************************
2 * jack.c: JACK audio input module
3 *****************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
5 * Copyright (C) 2007 Société des arts technologiques
7 * Authors: Arnaud Sala <arnaud.sala at savoirfairelinux.com>
8 * Julien Plissonneau Duquene <... at savoirfairelinux.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 *****************************************************************************/
26 * \file modules/access/jack.c
27 * \brief JACK audio input functions
30 /*****************************************************************************
32 *****************************************************************************/
35 #include <vlc_input.h>
36 #include <vlc_demux.h>
38 #include <vlc_codecs.h>
40 #include <vlc_strings.h>
42 #include <jack/jack.h>
43 #include <jack/ringbuffer.h>
45 #include <sys/mman.h> /* mlock() */
48 /*****************************************************************************
50 *****************************************************************************/
51 static int Open ( vlc_object_t * );
52 static void Close( vlc_object_t * );
54 #define CACHING_TEXT N_("Caching value in ms")
55 #define CACHING_LONGTEXT N_( \
56 "Make VLC buffer audio data capturer from jack for the specified " \
57 "length in milliseconds." )
58 #define PACE_TEXT N_( "Pace" )
59 #define PACE_LONGTEXT N_( \
60 "Read the audio stream at VLC pace rather than Jack pace." )
61 #define AUTO_CONNECT_TEXT N_( "Auto Connection" )
62 #define AUTO_CONNECT_LONGTEXT N_( \
63 "Automatically connect VLC input ports to available output ports." )
66 set_description( _("JACK audio input") );
67 set_capability( "access_demux", 0 );
68 set_shortname( _( "JACK Input" ) );
69 set_category( CAT_INPUT );
70 set_subcategory( SUBCAT_INPUT_ACCESS );
72 add_integer( "jack-input-caching", DEFAULT_PTS_DELAY / 1000, NULL,
73 CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
74 add_bool( "jack-input-use-vlc-pace", VLC_FALSE, NULL,
75 PACE_TEXT, PACE_LONGTEXT, VLC_TRUE );
76 add_bool( "jack-input-auto-connect", VLC_FALSE, NULL,
77 PACE_TEXT, PACE_LONGTEXT, VLC_TRUE );
79 add_shortcut( "jack" );
80 set_callbacks( Open, Close );
83 /*****************************************************************************
85 *****************************************************************************/
89 /* Audio properties */
90 vlc_fourcc_t i_acodec_raw;
91 unsigned int i_channels;
93 int i_audio_max_frame_size;
95 block_t *p_block_audio;
96 es_out_id_t *p_es_audio;
100 jack_client_t *p_jack_client;
101 jack_port_t **pp_jack_port_input;
102 jack_default_audio_sample_t **pp_jack_buffer;
103 jack_ringbuffer_t *p_jack_ringbuffer;
104 jack_nframes_t jack_buffer_size;
105 jack_nframes_t jack_sample_rate;
106 size_t jack_sample_size;
109 static int Demux( demux_t * );
110 static int Control( demux_t *p_demux, int i_query, va_list args );
112 static void Parse ( demux_t * );
113 static int Process( jack_nframes_t i_frames, void *p_arg );
115 static block_t *GrabJack( demux_t * );
117 /*****************************************************************************
118 * Open: Connect to the JACK server
119 *****************************************************************************/
120 static int Open( vlc_object_t *p_this )
123 demux_t *p_demux = ( demux_t* )p_this;
126 p_demux->pf_demux = Demux;
127 p_demux->pf_control = Control;
129 /* Allocate structure */
130 p_demux->p_sys = p_sys = calloc( 1, sizeof( demux_sys_t ) );
133 msg_Err( p_demux, "out of memory, cannot allocate structure" );
136 memset( p_sys, 0, sizeof( demux_sys_t ) );
142 var_Create( p_demux, "jack-input-caching",
143 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
144 var_Create( p_demux, "jack-input-use-vlc-pace",
145 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
146 var_Create( p_demux, "jack-input-auto-connect",
147 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
149 /* JACK connexions */
150 /* define name and connect to jack server */
151 char p_vlc_client_name[32];
152 sprintf( p_vlc_client_name, "vlc-input-%d", getpid() );
153 p_sys->p_jack_client = jack_client_new( p_vlc_client_name );
154 if( p_sys->p_jack_client == NULL )
156 msg_Err( p_demux, "failed to connect to JACK server" );
161 /* allocate input ports */
162 if( p_sys->i_channels == 0 || p_sys->i_channels > 8 )
163 p_sys->i_channels = 2 ; /* default number of port */
164 p_sys->pp_jack_port_input = malloc(
165 p_sys->i_channels * sizeof( jack_port_t* ) );
166 if( p_sys->pp_jack_port_input == NULL )
168 msg_Err( p_demux, "out of memory, cannot allocate input ports" );
172 /* allocate ringbuffer */
173 p_sys->p_jack_ringbuffer = jack_ringbuffer_create( p_sys->i_channels
174 * jack_get_buffer_size( p_sys->p_jack_client )
175 * sizeof( jack_default_audio_sample_t ) );
176 if( p_sys->p_jack_ringbuffer == NULL )
178 msg_Err( p_demux, "out of memory, cannot allocate ringbuffer" );
182 /* register input ports */
183 for( i = 0; i < p_sys->i_channels; i++ )
185 char p_input_name[32];
186 snprintf( p_input_name, 32, "vlc_in_%d", i+1 );
187 p_sys->pp_jack_port_input[i] = jack_port_register(
188 p_sys->p_jack_client, p_input_name, JACK_DEFAULT_AUDIO_TYPE,
189 JackPortIsInput, 0 );
190 if( p_sys->pp_jack_port_input[i] == NULL )
192 msg_Err( p_demux, "failed to register a JACK port" );
193 if( p_sys->p_jack_client) jack_client_close( p_sys->p_jack_client );
194 if( p_sys->pp_jack_port_input ) free( p_sys->pp_jack_port_input );
195 if( p_sys->p_jack_ringbuffer ) jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
196 if( p_sys->pp_jack_buffer ) free( p_sys->pp_jack_buffer );
202 /* allocate buffer for input ports */
203 p_sys->pp_jack_buffer = malloc ( p_sys->i_channels
204 * sizeof( jack_default_audio_sample_t * ) );
205 if( p_sys->pp_jack_buffer == NULL )
207 msg_Err( p_demux, "out of memory, cannot allocate input buffer" );
211 /* set process callback */
212 jack_set_process_callback( p_sys->p_jack_client, Process, p_demux );
214 /* tell jack server we are ready */
215 if ( jack_activate( p_sys->p_jack_client ) )
217 msg_Err( p_demux, "failed to activate JACK client" );
218 if( p_sys->p_jack_client) jack_client_close( p_sys->p_jack_client );
219 if( p_sys->pp_jack_port_input ) free( p_sys->pp_jack_port_input );
220 if( p_sys->p_jack_ringbuffer ) jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
221 if( p_sys->pp_jack_buffer ) free( p_sys->pp_jack_buffer );
226 /* connect vlc input to jack output ports if requested */
227 if( var_GetBool( p_demux, "jack-input-auto-connect" ) )
229 const char **pp_jack_port_output;
233 pp_jack_port_output = jack_get_ports( p_sys->p_jack_client, NULL, NULL,
236 while( pp_jack_port_output && pp_jack_port_output[i_out_ports] )
240 if( i_out_ports > 0 )
242 for( j = 0; j < i_out_ports; j++ )
244 i_in = j % p_sys->i_channels;
245 jack_connect( p_sys->p_jack_client, pp_jack_port_output[j],
246 jack_port_name( p_sys->pp_jack_port_input[i_in] ) );
249 if( pp_jack_port_output ) free( pp_jack_port_output );
252 /* info about jack server */
253 /* get buffers size */
254 p_sys->jack_buffer_size = jack_get_buffer_size( p_sys->p_jack_client );
255 /* get sample rate */
256 p_sys->jack_sample_rate = jack_get_sample_rate( p_sys->p_jack_client );
257 /* get sample size */
258 p_sys->jack_sample_size = sizeof( jack_default_audio_sample_t );
260 /* Define output format */
261 es_format_Init( &fmt, AUDIO_ES, VLC_FOURCC( 'f','l','3','2' ) );
262 fmt.audio.i_channels = p_sys->i_channels;
263 fmt.audio.i_rate = p_sys->jack_sample_rate;
264 fmt.audio.i_bitspersample = p_sys->jack_sample_size * 8;
265 fmt.audio.i_blockalign = fmt.audio.i_bitspersample / 8;
266 fmt.i_bitrate = fmt.audio.i_rate * fmt.audio.i_bitspersample
267 * fmt.audio.i_channels;
269 p_sys->p_es_audio = es_out_Add( p_demux->out, &fmt );
270 date_Init( &p_sys->pts, fmt.audio.i_rate, 1 );
271 date_Set( &p_sys->pts, 1 );
277 /*****************************************************************************
278 * Close: Disconnect from jack server and release associated resources
279 *****************************************************************************/
280 static void Close( vlc_object_t *p_this )
282 demux_t *p_demux = ( demux_t* )p_this;
283 demux_sys_t *p_sys = p_demux->p_sys;
285 msg_Dbg( p_demux,"Module unloaded" );
286 if( p_sys->p_block_audio ) block_Release( p_sys->p_block_audio );
287 if( p_sys->p_jack_client ) jack_client_close( p_sys->p_jack_client );
288 if( p_sys->p_jack_ringbuffer ) jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
289 if( p_sys->pp_jack_port_input ) free( p_sys->pp_jack_port_input );
290 if( p_sys->pp_jack_buffer ) free( p_sys->pp_jack_buffer );
295 /*****************************************************************************
297 *****************************************************************************/
298 static int Control( demux_t *p_demux, int i_query, va_list args )
302 demux_sys_t *p_sys = p_demux->p_sys;
306 /* Special for access_demux */
307 case DEMUX_CAN_PAUSE:
308 case DEMUX_SET_PAUSE_STATE:
310 case DEMUX_CAN_CONTROL_PACE:
311 pb = ( vlc_bool_t* )va_arg( args, vlc_bool_t * );
312 *pb = var_GetBool( p_demux, "jack-input-use-vlc-pace" );
315 case DEMUX_GET_PTS_DELAY:
316 pi64 = ( int64_t* )va_arg( args, int64_t * );
317 *pi64 = ( int64_t )var_GetInteger( p_demux, "jack-input-caching" )
322 pi64 = ( int64_t* )va_arg( args, int64_t * );
323 *pi64 = date_Get(&p_sys->pts);
326 /* TODO implement others */
335 /*****************************************************************************
337 *****************************************************************************/
338 static int Demux( demux_t *p_demux )
345 p_sys = p_demux->p_sys;
346 p_es = p_sys->p_es_audio;
347 p_block = GrabJack( p_demux );
351 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
352 es_out_Send( p_demux->out, p_es, p_block );
359 /*****************************************************************************
360 * Process Callback : fill ringbuffer with Jack audio data
361 *****************************************************************************/
362 int Process( jack_nframes_t i_frames, void *p_arg )
364 demux_t *p_demux = ( demux_t* )p_arg;
365 demux_sys_t *p_sys = p_demux->p_sys;
369 /* Get and interlace buffers */
370 for ( i = 0; i < p_sys->i_channels ; i++ )
372 p_sys->pp_jack_buffer[i] = jack_port_get_buffer(
373 p_sys->pp_jack_port_input[i], i_frames );
376 /* fill ring buffer with signal */
377 for( j = 0; j < p_sys->jack_buffer_size; j++ )
379 for( i = 0; i <p_sys->i_channels; i++ )
381 if( jack_ringbuffer_write_space( p_sys->p_jack_ringbuffer )
382 < p_sys->jack_sample_size ) return 1; // buffer overflow
383 i_write = jack_ringbuffer_write( p_sys->p_jack_ringbuffer,
384 p_sys->pp_jack_buffer[i]+j, p_sys->jack_sample_size );
392 /*****************************************************************************
393 * GrabJack: grab audio data in the Jack buffer
394 *****************************************************************************/
395 static block_t *GrabJack( demux_t *p_demux )
398 demux_sys_t *p_sys = p_demux->p_sys;
401 /* read signal from ring buffer */
402 i_read = jack_ringbuffer_read_space( p_sys->p_jack_ringbuffer );
404 if( i_read < 100 ) /* avoid small read */
405 { /* vlc has too much free time on its hands? */
410 if( p_sys->p_block_audio )
412 p_block = p_sys->p_block_audio;
416 p_block = block_New( p_demux, i_read );
420 msg_Warn( p_demux, "cannot get block" );
424 p_sys->p_block_audio = p_block;
425 p_block->i_buffer = i_read;
426 p_sys->p_block_audio = 0;
428 jack_ringbuffer_read( p_sys->p_jack_ringbuffer, p_block->p_buffer, i_read );
430 p_block->i_dts = p_block->i_pts = date_Increment(
431 &p_sys->pts, i_read/(p_sys->i_channels * p_sys->jack_sample_size) );
437 /*****************************************************************************
438 * Parse: Parse the MRL
439 *****************************************************************************/
440 static void Parse( demux_t *p_demux )
442 demux_sys_t *p_sys = p_demux->p_sys;
443 char *psz_dup = strdup( p_demux->psz_path );
444 char *psz_parser = psz_dup;
446 if( !strncmp( psz_parser, "channels=", strlen( "channels=" ) ) )
448 p_sys->i_channels = abs( strtol( psz_parser + strlen( "channels=" ),
453 msg_Warn( p_demux, "unknown option" );
456 while( *psz_parser && *psz_parser != ':' )
461 if( *psz_parser == ':' )
465 *psz_parser++ = '\0';
466 if( !strncmp( psz_parser, "channels=", strlen( "channels=" ) ) )
468 p_sys->i_channels = abs( strtol(
469 psz_parser + strlen( "channels=" ), &psz_parser, 0 ) );
473 msg_Warn( p_demux, "unknown option" );
475 while( *psz_parser && *psz_parser != ':' )
480 if( *psz_parser == '\0' )