]> git.sesse.net Git - vlc/blob - modules/access/jack.c
Merge branch 'base' into master
[vlc] / modules / access / jack.c
1 /*****************************************************************************
2  * jack.c: JACK audio input module
3  *****************************************************************************
4  * Copyright (C) 2007-2008 the VideoLAN team
5  * Copyright (C) 2007 Société des arts technologiques
6  * Copyright (C) 2007 Savoir-faire Linux
7  *
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>
11  *
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.
16  *
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.
21  *
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  *****************************************************************************/
26
27 /**
28  * \file modules/access/jack.c
29  * \brief JACK audio input functions
30  */
31
32 /*****************************************************************************
33  * Preamble
34  *****************************************************************************/
35
36 #ifdef HAVE_CONFIG_H
37 # include "config.h"
38 #endif
39
40 #include <vlc_common.h>
41 #include <vlc_plugin.h>
42 #include <vlc_input.h>
43 #include <vlc_demux.h>
44 #include <vlc_codecs.h>
45 #include <vlc_url.h>
46 #include <vlc_strings.h>
47
48 #include <jack/jack.h>
49 #include <jack/ringbuffer.h>
50
51 #include <errno.h>
52 #include <sys/types.h>
53 #include <unistd.h>
54
55 /*****************************************************************************
56  * Module descriptor
57  *****************************************************************************/
58 static int  Open ( vlc_object_t * );
59 static void Close( vlc_object_t * );
60
61 #define CACHING_TEXT N_("Caching value in ms")
62 #define CACHING_LONGTEXT N_( \
63     "Make VLC buffer audio data captured from jack for the specified " \
64     "length in milliseconds." )
65 #define PACE_TEXT N_( "Pace" )
66 #define PACE_LONGTEXT N_( \
67     "Read the audio stream at VLC pace rather than Jack pace." )
68 #define AUTO_CONNECT_TEXT N_( "Auto Connection" )
69 #define AUTO_CONNECT_LONGTEXT N_( \
70     "Automatically connect VLC input ports to available output ports." )
71
72 vlc_module_begin ()
73      set_description( N_("JACK audio input") )
74      set_capability( "access_demux", 0 )
75      set_shortname( N_( "JACK Input" ) )
76      set_category( CAT_INPUT )
77      set_subcategory( SUBCAT_INPUT_ACCESS )
78
79      add_integer( "jack-input-caching", DEFAULT_PTS_DELAY / 1000, NULL,
80          CACHING_TEXT, CACHING_LONGTEXT, true )
81      add_bool( "jack-input-use-vlc-pace", false, NULL,
82          PACE_TEXT, PACE_LONGTEXT, true )
83      add_bool( "jack-input-auto-connect", false, NULL,
84          AUTO_CONNECT_TEXT, AUTO_CONNECT_LONGTEXT, true )
85
86      add_shortcut( "jack" )
87      set_callbacks( Open, Close )
88 vlc_module_end ()
89
90 /*****************************************************************************
91  * Local prototypes
92  *****************************************************************************/
93
94 struct demux_sys_t
95 {
96     /* Audio properties */
97     vlc_fourcc_t                i_acodec_raw;
98     unsigned int                i_channels;
99     int                         i_sample_rate;
100     int                         i_audio_max_frame_size;
101     int                         i_frequency;
102     block_t                     *p_block_audio;
103     es_out_id_t                 *p_es_audio;
104     date_t                      pts;
105
106     /* Jack properties */
107     jack_client_t               *p_jack_client;
108     jack_port_t                 **pp_jack_port_input;
109     jack_default_audio_sample_t **pp_jack_buffer;
110     jack_ringbuffer_t           *p_jack_ringbuffer;
111     jack_nframes_t              jack_buffer_size;
112     jack_nframes_t              jack_sample_rate;
113     size_t                      jack_sample_size;
114     char                        *psz_ports;
115     char                        **pp_jack_port_table;
116     char                        i_match_ports;
117 };
118
119 static int Demux( demux_t * );
120 static int Control( demux_t *p_demux, int i_query, va_list args );
121
122 static void Parse ( demux_t * );
123 static void Port_finder( demux_t * );
124 static int Process( jack_nframes_t i_frames, void *p_arg );
125
126 static block_t *GrabJack( demux_t * );
127
128 /*****************************************************************************
129  * Open: Connect to the JACK server
130  *****************************************************************************/
131 static int Open( vlc_object_t *p_this )
132 {
133     unsigned int i;
134     demux_t             *p_demux = ( demux_t* )p_this;
135     demux_sys_t         *p_sys;
136     es_format_t         fmt;
137     int i_out_ports = 0;
138
139     p_demux->pf_demux = Demux;
140     p_demux->pf_control = Control;
141
142     /* Allocate structure */
143     p_demux->p_sys = p_sys = calloc( 1, sizeof( demux_sys_t ) );
144     if( !p_sys )
145         return VLC_ENOMEM;
146
147     /* Parse MRL */
148     Parse( p_demux );
149
150     /* Create var */
151     var_Create( p_demux, "jack-input-caching",
152         VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
153     var_Create( p_demux, "jack-input-use-vlc-pace",
154         VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
155     var_Create( p_demux, "jack-input-auto-connect",
156         VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
157
158     /* JACK connexions */
159     /* define name and connect to jack server */
160     char p_vlc_client_name[32];
161     sprintf( p_vlc_client_name, "vlc-input-%d", getpid() );
162     p_sys->p_jack_client = jack_client_new( p_vlc_client_name );
163     if( p_sys->p_jack_client == NULL )
164     {
165         msg_Err( p_demux, "failed to connect to JACK server" );
166         free( p_sys );
167         return VLC_EGENERIC;
168     }
169
170     /* find some specifics ports if user entered a regexp */
171     if( p_sys->psz_ports )
172     {
173         Port_finder( p_demux );
174         if( p_sys->i_channels == 0 )
175         {
176             p_sys->i_channels = p_sys->i_match_ports;
177         }
178     }
179
180     /* allocate input ports */
181     if( p_sys->i_channels == 0 ) p_sys->i_channels = 2 ; /* default number of port */
182     p_sys->pp_jack_port_input = malloc(
183         p_sys->i_channels * sizeof( jack_port_t* ) );
184     if( p_sys->pp_jack_port_input == NULL )
185     {
186         jack_client_close( p_sys->p_jack_client );
187         free( p_sys );
188         return VLC_ENOMEM;
189     }
190
191     /* allocate ringbuffer */
192     /* The length of the ringbuffer is critical, it must be large enought
193        to keep all data between 2 GrabJack() calls.  We assume 1 sec is ok */
194     p_sys->p_jack_ringbuffer = jack_ringbuffer_create( p_sys->i_channels
195          * jack_get_sample_rate( p_sys->p_jack_client )
196          * sizeof( jack_default_audio_sample_t ) );
197     if( p_sys->p_jack_ringbuffer == NULL )
198     {
199         free( p_sys->pp_jack_port_input );
200         jack_client_close( p_sys->p_jack_client );
201         free( p_sys );
202         return VLC_ENOMEM;
203     }
204
205     /* register input ports */
206     for( i = 0; i <  p_sys->i_channels; i++ )
207     {
208         char p_input_name[32];
209         snprintf( p_input_name, 32, "vlc_in_%d", i+1 );
210         p_sys->pp_jack_port_input[i] = jack_port_register(
211             p_sys->p_jack_client, p_input_name, JACK_DEFAULT_AUDIO_TYPE,
212             JackPortIsInput, 0 );
213         if( p_sys->pp_jack_port_input[i] == NULL )
214         {
215             msg_Err( p_demux, "failed to register a JACK port" );
216             jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
217             free( p_sys->pp_jack_port_input );
218             jack_client_close( p_sys->p_jack_client );
219             free( p_sys );
220             return VLC_EGENERIC;
221         }
222     }
223
224     /* allocate buffer for input ports */
225     p_sys->pp_jack_buffer = malloc ( p_sys->i_channels
226         * sizeof( jack_default_audio_sample_t * ) );
227     if( p_sys->pp_jack_buffer == NULL )
228     {
229         for( i = 0; i < p_sys->i_channels; i++ )
230             jack_port_unregister( p_sys->p_jack_client, p_sys->pp_jack_port_input[i] );
231         jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
232         free( p_sys->pp_jack_port_input );
233         jack_client_close( p_sys->p_jack_client );
234         free( p_sys );
235         return VLC_ENOMEM;
236     }
237
238     /* set process callback */
239     jack_set_process_callback( p_sys->p_jack_client, Process, p_demux );
240
241     /* tell jack server we are ready */
242     if ( jack_activate( p_sys->p_jack_client ) )
243     {
244         msg_Err( p_demux, "failed to activate JACK client" );
245         free( p_sys->pp_jack_buffer );
246         for( i = 0; i < p_sys->i_channels; i++ )
247             jack_port_unregister( p_sys->p_jack_client, p_sys->pp_jack_port_input[i] );
248         jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
249         free( p_sys->pp_jack_port_input );
250         jack_client_close( p_sys->p_jack_client );
251         free( p_sys );
252         return VLC_EGENERIC;
253     }
254
255     /* connect vlc input to specifics jack output ports if requested */
256    /*  if( var_GetBool( p_demux, "jack-input-auto-connect" ) && p_sys->psz_ports ) */
257     if( p_sys->psz_ports )
258     {
259         int        i_input_ports;
260         int        j;
261  
262     if( p_sys->i_match_ports > 0 )
263         {
264             for( j = 0; j < p_sys->i_match_ports; j++ )
265             {
266                 i_input_ports = j % p_sys->i_channels;
267                 jack_connect( p_sys->p_jack_client, p_sys->pp_jack_port_table[j],
268                     jack_port_name( p_sys->pp_jack_port_input[i_input_ports] ) );
269             }
270         }
271     }
272
273     /* connect vlc input to all jack output ports if requested */
274     if( var_GetBool( p_demux, "jack-input-auto-connect" ) && !p_sys->psz_ports )
275     {
276         int        i_input_ports;
277         int        j;
278         const char **pp_jack_port_output;
279
280         pp_jack_port_output = jack_get_ports( p_sys->p_jack_client, NULL, NULL, JackPortIsOutput );
281
282         while( pp_jack_port_output && pp_jack_port_output[i_out_ports] )
283         {
284             i_out_ports++;
285         }
286         if( i_out_ports > 0 )
287         {
288             for( j = 0; j < i_out_ports; j++ )
289             {
290                 i_input_ports = j % p_sys->i_channels;
291                 jack_connect( p_sys->p_jack_client, pp_jack_port_output[j],
292                     jack_port_name( p_sys->pp_jack_port_input[i_input_ports] ) );
293             }
294         }
295         free( pp_jack_port_output );
296     }
297
298     /* info about jack server */
299     /* get buffers size */
300     p_sys->jack_buffer_size = jack_get_buffer_size( p_sys->p_jack_client );
301     /* get sample rate */
302     p_sys->jack_sample_rate = jack_get_sample_rate( p_sys->p_jack_client );
303     /* get sample size */
304     p_sys->jack_sample_size = sizeof( jack_default_audio_sample_t );
305
306     /* Define output format */
307     es_format_Init( &fmt, AUDIO_ES, VLC_CODEC_FL32 );
308     fmt.audio.i_channels =  p_sys->i_channels;
309     fmt.audio.i_rate =  p_sys->jack_sample_rate;
310     fmt.audio.i_bitspersample =  p_sys->jack_sample_size * 8;
311     fmt.audio.i_blockalign = fmt.audio.i_bitspersample / 8;
312     fmt.i_bitrate = fmt.audio.i_rate * fmt.audio.i_bitspersample
313         * fmt.audio.i_channels;
314
315     p_sys->p_es_audio = es_out_Add( p_demux->out, &fmt );
316     date_Init( &p_sys->pts, fmt.audio.i_rate, 1 );
317     date_Set( &p_sys->pts, 1 );
318
319     return VLC_SUCCESS;
320 }
321
322
323 /*****************************************************************************
324  * Close: Disconnect from jack server and release associated resources
325  *****************************************************************************/
326 static void Close( vlc_object_t *p_this )
327 {
328     demux_t    *p_demux = ( demux_t* )p_this;
329     demux_sys_t    *p_sys = p_demux->p_sys;
330
331     msg_Dbg( p_demux,"Module unloaded" );
332     if( p_sys->p_block_audio ) block_Release( p_sys->p_block_audio );
333     if( p_sys->p_jack_client ) jack_client_close( p_sys->p_jack_client );
334     if( p_sys->p_jack_ringbuffer ) jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
335     free( p_sys->pp_jack_port_input );
336     free( p_sys->pp_jack_buffer );
337     free( p_sys->pp_jack_port_table );
338     free( p_sys );
339 }
340
341
342 /*****************************************************************************
343  * Control
344  *****************************************************************************/
345 static int Control( demux_t *p_demux, int i_query, va_list args )
346 {
347     bool  *pb;
348     int64_t     *pi64;
349     demux_sys_t *p_sys = p_demux->p_sys;
350
351     switch( i_query )
352     {
353     /* Special for access_demux */
354     case DEMUX_CAN_PAUSE:
355     case DEMUX_CAN_SEEK:
356         pb = (bool *)va_arg( args, bool * );
357         *pb = true;
358         return VLC_SUCCESS;
359
360     case DEMUX_SET_PAUSE_STATE:
361         return VLC_SUCCESS;
362     case DEMUX_CAN_CONTROL_PACE:
363         pb = ( bool* )va_arg( args, bool * );
364         *pb = var_GetBool( p_demux, "jack-input-use-vlc-pace" );
365         return VLC_SUCCESS;
366
367     case DEMUX_GET_PTS_DELAY:
368         pi64 = ( int64_t* )va_arg( args, int64_t * );
369         *pi64 = ( int64_t )var_GetInteger( p_demux, "jack-input-caching" )
370             * 1000;
371         return VLC_SUCCESS;
372
373     case DEMUX_GET_TIME:
374         pi64 = ( int64_t* )va_arg( args, int64_t * );
375         *pi64 =  date_Get(&p_sys->pts);
376             return VLC_SUCCESS;
377
378     /* TODO implement others */
379     default:
380         return VLC_EGENERIC;
381     }
382
383     return VLC_EGENERIC;
384 }
385
386
387 /*****************************************************************************
388  * Demux
389  *****************************************************************************/
390 static int Demux( demux_t *p_demux )
391 {
392
393     demux_sys_t *p_sys;
394     es_out_id_t  *p_es;
395     block_t *p_block;
396
397     p_sys = p_demux->p_sys;
398     p_es = p_sys->p_es_audio;
399     p_block = GrabJack( p_demux );
400
401     if( p_block )
402     {
403         es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
404         es_out_Send( p_demux->out, p_es, p_block );
405     }
406
407     return 1;
408 }
409
410
411 /*****************************************************************************
412  * Process Callback : fill ringbuffer with Jack audio data
413  *****************************************************************************/
414 int Process( jack_nframes_t i_frames, void *p_arg )
415 {
416     demux_t            *p_demux = ( demux_t* )p_arg;
417     demux_sys_t        *p_sys = p_demux->p_sys;
418     unsigned int        i, j;
419     size_t              i_write;
420  
421     /* Get and interlace buffers */
422     for ( i = 0; i < p_sys->i_channels ; i++ )
423     {
424         p_sys->pp_jack_buffer[i] = jack_port_get_buffer(
425             p_sys->pp_jack_port_input[i], i_frames );
426     }
427
428     /* fill ring buffer with signal */
429     for( j = 0; j < i_frames; j++ )
430     {
431         for( i = 0; i <p_sys->i_channels; i++ )
432         {
433             if( jack_ringbuffer_write_space( p_sys->p_jack_ringbuffer ) <
434                 p_sys->jack_sample_size ) {
435                 msg_Err( p_demux, "buffer overflow");
436                 return 0; // buffer overflow
437             }
438             i_write = jack_ringbuffer_write( p_sys->p_jack_ringbuffer,
439                                              ( char * ) (p_sys->pp_jack_buffer[i]+j),
440                                              p_sys->jack_sample_size );
441             if (i_write != p_sys->jack_sample_size ) {
442                 msg_Warn( p_demux, "error writing on ring buffer");
443             }
444         }
445     }
446
447     return 1;
448 }
449
450
451 /*****************************************************************************
452  * GrabJack: grab audio data in the Jack buffer
453  *****************************************************************************/
454 static block_t *GrabJack( demux_t *p_demux )
455 {
456     size_t      i_read;
457     demux_sys_t *p_sys = p_demux->p_sys;
458     block_t     *p_block;
459
460     /* read signal from ring buffer */
461     i_read = jack_ringbuffer_read_space( p_sys->p_jack_ringbuffer );
462
463     if( i_read < 100 ) /* avoid small read */
464     {   /* vlc has too much free time on its hands? */
465         msleep(1000);
466         return NULL;
467     }
468
469     if( p_sys->p_block_audio )
470     {
471         p_block = p_sys->p_block_audio;
472     }
473     else
474     {
475         p_block = block_New( p_demux, i_read );
476     }
477     if( !p_block )
478     {
479         msg_Warn( p_demux, "cannot get block" );
480         return 0;
481     }
482  
483     //Find the previous power of 2, this algo assumes size_t has the same size on all arch
484     i_read >>= 1;
485     i_read--;
486     i_read |= i_read >> 1;
487     i_read |= i_read >> 2;
488     i_read |= i_read >> 4;
489     i_read |= i_read >> 8;
490     i_read |= i_read >> 16;
491     i_read++;
492  
493     i_read = jack_ringbuffer_read( p_sys->p_jack_ringbuffer, ( char * ) p_block->p_buffer, i_read );
494  
495     p_block->i_dts = p_block->i_pts =    date_Increment( &p_sys->pts,
496          i_read/(p_sys->i_channels * p_sys->jack_sample_size) );
497
498     p_sys->p_block_audio = p_block;
499     p_block->i_buffer = i_read;
500     p_sys->p_block_audio = 0;
501  
502     return p_block;
503 }
504
505
506 /*****************************************************************************
507  * Port_finder: compare ports with the regexp entered
508  *****************************************************************************/
509 static void Port_finder( demux_t *p_demux )
510 {
511
512     demux_sys_t *p_sys = p_demux->p_sys;
513     char *psz_expr = p_sys->psz_ports;
514     char *token = NULL;
515     char *state = NULL;
516     char *psz_uri = NULL;
517     const char **pp_jack_port_output = NULL;
518     int i_out_ports = 0;
519     int i_total_out_ports =0;
520     p_sys->pp_jack_port_table = NULL;
521
522     /* parse the ports part of the MRL */
523     for( token = strtok_r( psz_expr, ",", &state ); token;
524             token = strtok_r( NULL, ",", &state ) )
525     {
526         psz_uri = decode_URI_duplicate( token );
527         /* get the ports which match the regexp */
528         pp_jack_port_output = jack_get_ports( p_sys->p_jack_client,
529            psz_uri, NULL, JackPortIsOutput );
530         if( pp_jack_port_output == NULL )
531         {
532             msg_Err( p_demux, "port(s) asked not found:%s", psz_uri );
533             free( pp_jack_port_output );
534         }
535         else
536         {
537             while( pp_jack_port_output && pp_jack_port_output[i_out_ports] )
538             {
539                 i_out_ports++;
540             }
541             /* alloc an array to store all the matched ports */
542             p_sys->pp_jack_port_table = realloc( p_sys->pp_jack_port_table,
543                 (i_out_ports * sizeof( char * ) + i_total_out_ports * sizeof( char * ) ) );
544
545             for(int i=0; i<i_out_ports;i++)
546             {
547                 p_sys->pp_jack_port_table[i_total_out_ports+i] = ( char * ) pp_jack_port_output[i];
548             }
549
550             i_total_out_ports += i_out_ports;
551         }
552     }
553
554     free( pp_jack_port_output );
555     p_sys->i_match_ports = i_total_out_ports;
556 }
557
558
559 /*****************************************************************************
560  * Parse: Parse the MRL
561  *****************************************************************************/
562 static void Parse( demux_t *p_demux )
563 {
564     demux_sys_t *p_sys = p_demux->p_sys;
565     char *psz_dup = strdup( p_demux->psz_path );
566     char *psz_parser = psz_dup;
567
568     if( !strncmp( psz_parser, "channels=", strlen( "channels=" ) ) )
569     {
570         p_sys->i_channels = abs( strtol( psz_parser + strlen( "channels=" ),
571             &psz_parser, 0 ) );
572     }
573     else if( !strncmp( psz_parser, "ports=", strlen( "ports=" ) ) )
574     {
575         int i_len;
576         psz_parser += strlen( "ports=" );
577         if( strchr( psz_parser, ':' ) )
578         {
579             i_len = strchr( psz_parser, ':' ) - psz_parser;
580         }
581         else
582         {
583             i_len = strlen( psz_parser );
584         }
585         p_sys->psz_ports = strndup( psz_parser, i_len );
586         psz_parser += i_len;
587     }
588     else
589     {
590         msg_Warn( p_demux, "unknown option" );
591     }
592
593     while( *psz_parser && *psz_parser != ':' )
594     {
595         psz_parser++;
596     }
597
598     if( *psz_parser == ':' )
599     {
600         for( ;; )
601         {
602             *psz_parser++ = '\0';
603             if( !strncmp( psz_parser, "channels=", strlen( "channels=" ) ) )
604             {
605                 p_sys->i_channels = abs( strtol(
606                     psz_parser + strlen( "channels=" ), &psz_parser, 0 ) );
607             }
608             else if( !strncmp( psz_parser, "ports=", strlen( "ports=" ) ) )
609             {
610                 int i_len;
611                 psz_parser += strlen( "ports=" );
612                 if( strchr( psz_parser, ':' ) )
613                 {
614                     i_len = strchr( psz_parser, ':' ) - psz_parser;
615                 }
616                 else
617                 {
618                     i_len = strlen( psz_parser );
619                 }
620                 p_sys->psz_ports = strndup( psz_parser, i_len );
621                 psz_parser += i_len;
622             }
623             else
624             {
625                 msg_Warn( p_demux, "unknown option" );
626             }
627             while( *psz_parser && *psz_parser != ':' )
628             {
629                 psz_parser++;
630             }
631
632             if( *psz_parser == '\0' )
633             {
634                 break;
635             }
636         }
637     }
638 }
639