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
6 * Copyright (C) 2007 Savoir-faire Linux
8 * Authors: Arnaud Sala <arnaud.sala at savoirfairelinux.com>
9 * Julien Plissonneau Duquene <... at savoirfairelinux.com>
10 * Pierre-Luc Beaudoin <pierre-luc.beaudoin at savoirfairelinux.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
28 * \file modules/access/jack.c
29 * \brief JACK audio input functions
32 /*****************************************************************************
34 *****************************************************************************/
40 #include <vlc_common.h>
41 #include <vlc_plugin.h>
42 #include <vlc_input.h>
43 #include <vlc_demux.h>
45 #include <vlc_codecs.h>
47 #include <vlc_strings.h>
49 #include <jack/jack.h>
50 #include <jack/ringbuffer.h>
53 #include <sys/types.h>
56 /*****************************************************************************
58 *****************************************************************************/
59 static int Open ( vlc_object_t * );
60 static void Close( vlc_object_t * );
62 #define CACHING_TEXT N_("Caching value in ms")
63 #define CACHING_LONGTEXT N_( \
64 "Make VLC buffer audio data capturer from jack for the specified " \
65 "length in milliseconds." )
66 #define PACE_TEXT N_( "Pace" )
67 #define PACE_LONGTEXT N_( \
68 "Read the audio stream at VLC pace rather than Jack pace." )
69 #define AUTO_CONNECT_TEXT N_( "Auto Connection" )
70 #define AUTO_CONNECT_LONGTEXT N_( \
71 "Automatically connect VLC input ports to available output ports." )
74 set_description( N_("JACK audio input") );
75 set_capability( "access_demux", 0 );
76 set_shortname( N_( "JACK Input" ) );
77 set_category( CAT_INPUT );
78 set_subcategory( SUBCAT_INPUT_ACCESS );
80 add_integer( "jack-input-caching", DEFAULT_PTS_DELAY / 1000, NULL,
81 CACHING_TEXT, CACHING_LONGTEXT, true );
82 add_bool( "jack-input-use-vlc-pace", false, NULL,
83 PACE_TEXT, PACE_LONGTEXT, true );
84 add_bool( "jack-input-auto-connect", false, NULL,
85 PACE_TEXT, PACE_LONGTEXT, true );
87 add_shortcut( "jack" );
88 set_callbacks( Open, Close );
91 /*****************************************************************************
93 *****************************************************************************/
97 /* Audio properties */
98 vlc_fourcc_t i_acodec_raw;
99 unsigned int i_channels;
101 int i_audio_max_frame_size;
103 block_t *p_block_audio;
104 es_out_id_t *p_es_audio;
107 /* Jack properties */
108 jack_client_t *p_jack_client;
109 jack_port_t **pp_jack_port_input;
110 jack_default_audio_sample_t **pp_jack_buffer;
111 jack_ringbuffer_t *p_jack_ringbuffer;
112 jack_nframes_t jack_buffer_size;
113 jack_nframes_t jack_sample_rate;
114 size_t jack_sample_size;
116 char **pp_jack_port_table;
120 static int Demux( demux_t * );
121 static int Control( demux_t *p_demux, int i_query, va_list args );
123 static void Parse ( demux_t * );
124 static void Port_finder( demux_t * );
125 static int Process( jack_nframes_t i_frames, void *p_arg );
127 static block_t *GrabJack( demux_t * );
129 /*****************************************************************************
130 * Open: Connect to the JACK server
131 *****************************************************************************/
132 static int Open( vlc_object_t *p_this )
135 demux_t *p_demux = ( demux_t* )p_this;
140 p_demux->pf_demux = Demux;
141 p_demux->pf_control = Control;
143 /* Allocate structure */
144 p_demux->p_sys = p_sys = calloc( 1, sizeof( demux_sys_t ) );
147 msg_Err( p_demux, "out of memory, cannot allocate structure" );
150 memset( p_sys, 0, sizeof( demux_sys_t ) );
156 var_Create( p_demux, "jack-input-caching",
157 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
158 var_Create( p_demux, "jack-input-use-vlc-pace",
159 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
160 var_Create( p_demux, "jack-input-auto-connect",
161 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
163 /* JACK connexions */
164 /* define name and connect to jack server */
165 char p_vlc_client_name[32];
166 sprintf( p_vlc_client_name, "vlc-input-%d", getpid() );
167 p_sys->p_jack_client = jack_client_new( p_vlc_client_name );
168 if( p_sys->p_jack_client == NULL )
170 msg_Err( p_demux, "failed to connect to JACK server" );
175 /* find some specifics ports if user entered a regexp */
176 if( p_sys->psz_ports)
178 Port_finder( p_demux );
179 if( p_sys->i_channels == 0 )
181 p_sys->i_channels = p_sys->i_match_ports;
185 /* allocate input ports */
186 if( p_sys->i_channels == 0 ) p_sys->i_channels = 2 ; /* default number of port */
187 p_sys->pp_jack_port_input = malloc(
188 p_sys->i_channels * sizeof( jack_port_t* ) );
189 if( p_sys->pp_jack_port_input == NULL )
191 msg_Err( p_demux, "out of memory, cannot allocate input ports" );
195 /* allocate ringbuffer */
196 /* The length of the ringbuffer is critical, it must be large enought
197 to keep all data between 2 GrabJack() calls. We assume 1 sec is ok */
198 p_sys->p_jack_ringbuffer = jack_ringbuffer_create( p_sys->i_channels
199 * jack_get_sample_rate( p_sys->p_jack_client )
200 * sizeof( jack_default_audio_sample_t ) );
201 if( p_sys->p_jack_ringbuffer == NULL )
203 msg_Err( p_demux, "out of memory, cannot allocate ringbuffer" );
207 /* register input ports */
208 for( i = 0; i < p_sys->i_channels; i++ )
210 char p_input_name[32];
211 snprintf( p_input_name, 32, "vlc_in_%d", i+1 );
212 p_sys->pp_jack_port_input[i] = jack_port_register(
213 p_sys->p_jack_client, p_input_name, JACK_DEFAULT_AUDIO_TYPE,
214 JackPortIsInput, 0 );
215 if( p_sys->pp_jack_port_input[i] == NULL )
217 msg_Err( p_demux, "failed to register a JACK port" );
218 if( p_sys->p_jack_client) jack_client_close( p_sys->p_jack_client );
219 free( p_sys->pp_jack_port_input );
220 if( p_sys->p_jack_ringbuffer ) jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
221 free( p_sys->pp_jack_buffer );
227 /* allocate buffer for input ports */
228 p_sys->pp_jack_buffer = malloc ( p_sys->i_channels
229 * sizeof( jack_default_audio_sample_t * ) );
230 if( p_sys->pp_jack_buffer == NULL )
232 msg_Err( p_demux, "out of memory, cannot allocate input buffer" );
236 /* set process callback */
237 jack_set_process_callback( p_sys->p_jack_client, Process, p_demux );
239 /* tell jack server we are ready */
240 if ( jack_activate( p_sys->p_jack_client ) )
242 msg_Err( p_demux, "failed to activate JACK client" );
243 if( p_sys->p_jack_client) jack_client_close( p_sys->p_jack_client );
244 free( p_sys->pp_jack_port_input );
245 if( p_sys->p_jack_ringbuffer ) jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
246 free( p_sys->pp_jack_buffer );
251 /* connect vlc input to specifics jack output ports if requested */
252 /* if( var_GetBool( p_demux, "jack-input-auto-connect" ) && p_sys->psz_ports ) */
253 if( p_sys->psz_ports )
258 if( p_sys->i_match_ports > 0 )
260 for( j = 0; j < p_sys->i_match_ports; j++ )
262 i_input_ports = j % p_sys->i_channels;
263 jack_connect( p_sys->p_jack_client, p_sys->pp_jack_port_table[j],
264 jack_port_name( p_sys->pp_jack_port_input[i_input_ports] ) );
269 /* connect vlc input to all jack output ports if requested */
270 if( var_GetBool( p_demux, "jack-input-auto-connect" ) && !p_sys->psz_ports )
274 const char **pp_jack_port_output;
276 pp_jack_port_output = jack_get_ports( p_sys->p_jack_client, NULL, NULL, JackPortIsOutput );
278 while( pp_jack_port_output && pp_jack_port_output[i_out_ports] )
282 if( i_out_ports > 0 )
284 for( j = 0; j < i_out_ports; j++ )
286 i_input_ports = j % p_sys->i_channels;
287 jack_connect( p_sys->p_jack_client, pp_jack_port_output[j],
288 jack_port_name( p_sys->pp_jack_port_input[i_input_ports] ) );
291 free( pp_jack_port_output );
294 /* info about jack server */
295 /* get buffers size */
296 p_sys->jack_buffer_size = jack_get_buffer_size( p_sys->p_jack_client );
297 /* get sample rate */
298 p_sys->jack_sample_rate = jack_get_sample_rate( p_sys->p_jack_client );
299 /* get sample size */
300 p_sys->jack_sample_size = sizeof( jack_default_audio_sample_t );
302 /* Define output format */
303 es_format_Init( &fmt, AUDIO_ES, VLC_FOURCC( 'f','l','3','2' ) );
304 fmt.audio.i_channels = p_sys->i_channels;
305 fmt.audio.i_rate = p_sys->jack_sample_rate;
306 fmt.audio.i_bitspersample = p_sys->jack_sample_size * 8;
307 fmt.audio.i_blockalign = fmt.audio.i_bitspersample / 8;
308 fmt.i_bitrate = fmt.audio.i_rate * fmt.audio.i_bitspersample
309 * fmt.audio.i_channels;
311 p_sys->p_es_audio = es_out_Add( p_demux->out, &fmt );
312 date_Init( &p_sys->pts, fmt.audio.i_rate, 1 );
313 date_Set( &p_sys->pts, 1 );
319 /*****************************************************************************
320 * Close: Disconnect from jack server and release associated resources
321 *****************************************************************************/
322 static void Close( vlc_object_t *p_this )
324 demux_t *p_demux = ( demux_t* )p_this;
325 demux_sys_t *p_sys = p_demux->p_sys;
327 msg_Dbg( p_demux,"Module unloaded" );
328 if( p_sys->p_block_audio ) block_Release( p_sys->p_block_audio );
329 if( p_sys->p_jack_client ) jack_client_close( p_sys->p_jack_client );
330 if( p_sys->p_jack_ringbuffer ) jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
331 free( p_sys->pp_jack_port_input );
332 free( p_sys->pp_jack_buffer );
333 free( p_sys->pp_jack_port_table );
338 /*****************************************************************************
340 *****************************************************************************/
341 static int Control( demux_t *p_demux, int i_query, va_list args )
345 demux_sys_t *p_sys = p_demux->p_sys;
349 /* Special for access_demux */
350 case DEMUX_CAN_PAUSE:
352 pb = (bool *)va_arg( args, bool * );
356 case DEMUX_SET_PAUSE_STATE:
358 case DEMUX_CAN_CONTROL_PACE:
359 pb = ( bool* )va_arg( args, bool * );
360 *pb = var_GetBool( p_demux, "jack-input-use-vlc-pace" );
363 case DEMUX_GET_PTS_DELAY:
364 pi64 = ( int64_t* )va_arg( args, int64_t * );
365 *pi64 = ( int64_t )var_GetInteger( p_demux, "jack-input-caching" )
370 pi64 = ( int64_t* )va_arg( args, int64_t * );
371 *pi64 = date_Get(&p_sys->pts);
374 /* TODO implement others */
383 /*****************************************************************************
385 *****************************************************************************/
386 static int Demux( demux_t *p_demux )
393 p_sys = p_demux->p_sys;
394 p_es = p_sys->p_es_audio;
395 p_block = GrabJack( p_demux );
399 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
400 es_out_Send( p_demux->out, p_es, p_block );
407 /*****************************************************************************
408 * Process Callback : fill ringbuffer with Jack audio data
409 *****************************************************************************/
410 int Process( jack_nframes_t i_frames, void *p_arg )
412 demux_t *p_demux = ( demux_t* )p_arg;
413 demux_sys_t *p_sys = p_demux->p_sys;
417 /* Get and interlace buffers */
418 for ( i = 0; i < p_sys->i_channels ; i++ )
420 p_sys->pp_jack_buffer[i] = jack_port_get_buffer(
421 p_sys->pp_jack_port_input[i], i_frames );
424 /* fill ring buffer with signal */
425 for( j = 0; j < i_frames; j++ )
427 for( i = 0; i <p_sys->i_channels; i++ )
429 if( jack_ringbuffer_write_space( p_sys->p_jack_ringbuffer ) <
430 p_sys->jack_sample_size ) {
431 msg_Err( p_demux, "buffer overflow");
432 return 0; // buffer overflow
434 i_write = jack_ringbuffer_write( p_sys->p_jack_ringbuffer,
435 ( char * ) (p_sys->pp_jack_buffer[i]+j),
436 p_sys->jack_sample_size );
437 if (i_write != p_sys->jack_sample_size ) {
438 msg_Warn( p_demux, "error writing on ring buffer");
447 /*****************************************************************************
448 * GrabJack: grab audio data in the Jack buffer
449 *****************************************************************************/
450 static block_t *GrabJack( demux_t *p_demux )
453 demux_sys_t *p_sys = p_demux->p_sys;
456 /* read signal from ring buffer */
457 i_read = jack_ringbuffer_read_space( p_sys->p_jack_ringbuffer );
459 if( i_read < 100 ) /* avoid small read */
460 { /* vlc has too much free time on its hands? */
465 if( p_sys->p_block_audio )
467 p_block = p_sys->p_block_audio;
471 p_block = block_New( p_demux, i_read );
475 msg_Warn( p_demux, "cannot get block" );
479 //Find the previous power of 2, this algo assumes size_t has the same size on all arch
482 i_read |= i_read >> 1;
483 i_read |= i_read >> 2;
484 i_read |= i_read >> 4;
485 i_read |= i_read >> 8;
486 i_read |= i_read >> 16;
489 i_read = jack_ringbuffer_read( p_sys->p_jack_ringbuffer, ( char * ) p_block->p_buffer, i_read );
491 p_block->i_dts = p_block->i_pts = date_Increment( &p_sys->pts,
492 i_read/(p_sys->i_channels * p_sys->jack_sample_size) );
494 p_sys->p_block_audio = p_block;
495 p_block->i_buffer = i_read;
496 p_sys->p_block_audio = 0;
502 /*****************************************************************************
503 * Port_finder: compare ports with the regexp entered
504 *****************************************************************************/
505 static void Port_finder( demux_t *p_demux )
508 demux_sys_t *p_sys = p_demux->p_sys;
509 char *psz_expr = p_sys->psz_ports;
512 char *psz_uri = NULL;
513 const char **pp_jack_port_output = NULL;
515 int i_total_out_ports =0;
516 p_sys->pp_jack_port_table = NULL;
518 /* parse the ports part of the MRL */
519 for( token = strtok_r( psz_expr, ",", &state ); token;
520 token = strtok_r( NULL, ",", &state ) )
522 psz_uri = decode_URI_duplicate( token );
523 /* get the ports which match the regexp */
524 pp_jack_port_output = jack_get_ports( p_sys->p_jack_client,
525 psz_uri, NULL, JackPortIsOutput );
526 if( pp_jack_port_output == NULL )
528 msg_Err( p_demux, "port(s) asked not found:%s", psz_uri );
529 free( pp_jack_port_output );
533 while( pp_jack_port_output && pp_jack_port_output[i_out_ports] )
537 /* alloc an array to store all the matched ports */
538 p_sys->pp_jack_port_table = realloc( p_sys->pp_jack_port_table,
539 (i_out_ports * sizeof( char * ) + i_total_out_ports * sizeof( char * ) ) );
541 for(int i=0; i<i_out_ports;i++)
543 p_sys->pp_jack_port_table[i_total_out_ports+i] = ( char * ) pp_jack_port_output[i];
546 i_total_out_ports += i_out_ports;
550 free( pp_jack_port_output );
551 p_sys->i_match_ports = i_total_out_ports;
555 /*****************************************************************************
556 * Parse: Parse the MRL
557 *****************************************************************************/
558 static void Parse( demux_t *p_demux )
560 demux_sys_t *p_sys = p_demux->p_sys;
561 char *psz_dup = strdup( p_demux->psz_path );
562 char *psz_parser = psz_dup;
564 if( !strncmp( psz_parser, "channels=", strlen( "channels=" ) ) )
566 p_sys->i_channels = abs( strtol( psz_parser + strlen( "channels=" ),
569 else if( !strncmp( psz_parser, "ports=", strlen( "ports=" ) ) )
572 psz_parser += strlen( "ports=" );
573 if( strchr( psz_parser, ':' ) )
575 i_len = strchr( psz_parser, ':' ) - psz_parser;
579 i_len = strlen( psz_parser );
581 p_sys->psz_ports = strndup( psz_parser, i_len );
586 msg_Warn( p_demux, "unknown option" );
589 while( *psz_parser && *psz_parser != ':' )
594 if( *psz_parser == ':' )
598 *psz_parser++ = '\0';
599 if( !strncmp( psz_parser, "channels=", strlen( "channels=" ) ) )
601 p_sys->i_channels = abs( strtol(
602 psz_parser + strlen( "channels=" ), &psz_parser, 0 ) );
604 else if( !strncmp( psz_parser, "ports=", strlen( "ports=" ) ) )
607 psz_parser += strlen( "ports=" );
608 if( strchr( psz_parser, ':' ) )
610 i_len = strchr( psz_parser, ':' ) - psz_parser;
614 i_len = strlen( psz_parser );
616 p_sys->psz_ports = strndup( psz_parser, i_len );
621 msg_Warn( p_demux, "unknown option" );
623 while( *psz_parser && *psz_parser != ':' )
628 if( *psz_parser == '\0' )