]> git.sesse.net Git - vlc/blob - modules/access/jack.c
Plugins: include vlc_common.h directly instead of vlc/vlc.h
[vlc] / modules / access / jack.c
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
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_vout.h>
45 #include <vlc_codecs.h>
46 #include <vlc_url.h>
47 #include <vlc_strings.h>
48
49 #include <jack/jack.h>
50 #include <jack/ringbuffer.h>
51
52 #include <errno.h>
53 #include <sys/types.h>
54 #include <unistd.h>
55
56 /*****************************************************************************
57  * Module descriptor
58  *****************************************************************************/
59 static int  Open ( vlc_object_t * );
60 static void Close( vlc_object_t * );
61
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." )
72
73 vlc_module_begin();
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 );
79
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 );
86
87      add_shortcut( "jack" );
88      set_callbacks( Open, Close );
89 vlc_module_end();
90
91 /*****************************************************************************
92  * Local prototypes
93  *****************************************************************************/
94
95 struct demux_sys_t
96 {
97     /* Audio properties */
98     vlc_fourcc_t                i_acodec_raw;
99     unsigned int                i_channels;
100     int                         i_sample_rate;
101     int                         i_audio_max_frame_size;
102     int                         i_frequency;
103     block_t                     *p_block_audio;
104     es_out_id_t                 *p_es_audio;
105     date_t                      pts;
106
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;
115     char                        *psz_ports;
116     char                        **pp_jack_port_table;
117     char                        i_match_ports;
118 };
119
120 static int Demux( demux_t * );
121 static int Control( demux_t *p_demux, int i_query, va_list args );
122
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 );
126
127 static block_t *GrabJack( demux_t * );
128
129 /*****************************************************************************
130  * Open: Connect to the JACK server
131  *****************************************************************************/
132 static int Open( vlc_object_t *p_this )
133 {
134     unsigned int i;
135     demux_t             *p_demux = ( demux_t* )p_this;
136     demux_sys_t         *p_sys;
137     es_format_t         fmt;
138     int i_out_ports = 0;
139
140     p_demux->pf_demux = Demux;
141     p_demux->pf_control = Control;
142
143     /* Allocate structure */
144     p_demux->p_sys = p_sys = calloc( 1, sizeof( demux_sys_t ) );
145     if( p_sys == NULL )
146     {
147         msg_Err( p_demux, "out of memory, cannot allocate structure" );
148         return VLC_ENOMEM;
149     }
150     memset( p_sys, 0, sizeof( demux_sys_t ) );
151
152     /* Parse MRL */
153     Parse( p_demux );
154
155     /* Create var */
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 );
162
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 )
169     {
170         msg_Err( p_demux, "failed to connect to JACK server" );
171         free( p_sys );
172         return VLC_EGENERIC;
173     }
174
175     /* find some specifics ports if user entered a regexp */
176     if( p_sys->psz_ports)
177     {
178         Port_finder( p_demux );
179         if( p_sys->i_channels == 0 )
180         {
181             p_sys->i_channels = p_sys->i_match_ports;
182         }
183     }
184
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 )
190     {
191         msg_Err( p_demux, "out of memory, cannot allocate input ports" );
192         return VLC_ENOMEM;
193     }
194
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 )
202     {
203         msg_Err( p_demux, "out of memory, cannot allocate ringbuffer" );
204         return VLC_ENOMEM;
205     }
206
207     /* register input ports */
208     for( i = 0; i <  p_sys->i_channels; i++ )
209     {
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 )
216         {
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 );
222             free( p_sys );
223             return VLC_EGENERIC;
224         }
225     }
226
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 )
231     {
232         msg_Err( p_demux, "out of memory, cannot allocate input buffer" );
233         return VLC_ENOMEM;
234     }
235
236     /* set process callback */
237     jack_set_process_callback( p_sys->p_jack_client, Process, p_demux );
238
239     /* tell jack server we are ready */
240     if ( jack_activate( p_sys->p_jack_client ) )
241     {
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 );
247         free( p_sys );
248         return VLC_EGENERIC;
249     }
250
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 )
254     {
255         int        i_input_ports;
256         int        j;
257  
258     if( p_sys->i_match_ports > 0 )
259         {
260             for( j = 0; j < p_sys->i_match_ports; j++ )
261             {
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] ) );
265             }
266         }
267     }
268
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 )
271     {
272         int        i_input_ports;
273         int        j;
274         const char **pp_jack_port_output;
275
276         pp_jack_port_output = jack_get_ports( p_sys->p_jack_client, NULL, NULL, JackPortIsOutput );
277
278         while( pp_jack_port_output && pp_jack_port_output[i_out_ports] )
279         {
280             i_out_ports++;
281         }
282         if( i_out_ports > 0 )
283         {
284             for( j = 0; j < i_out_ports; j++ )
285             {
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] ) );
289             }
290         }
291     free( pp_jack_port_output );
292     }
293
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 );
301
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;
310
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 );
314
315     return VLC_SUCCESS;
316 }
317
318
319 /*****************************************************************************
320  * Close: Disconnect from jack server and release associated resources
321  *****************************************************************************/
322 static void Close( vlc_object_t *p_this )
323 {
324     demux_t    *p_demux = ( demux_t* )p_this;
325     demux_sys_t    *p_sys = p_demux->p_sys;
326
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 );
334     free( p_sys );
335 }
336
337
338 /*****************************************************************************
339  * Control
340  *****************************************************************************/
341 static int Control( demux_t *p_demux, int i_query, va_list args )
342 {
343     bool  *pb;
344     int64_t     *pi64;
345     demux_sys_t *p_sys = p_demux->p_sys;
346
347     switch( i_query )
348     {
349     /* Special for access_demux */
350     case DEMUX_CAN_PAUSE:
351     case DEMUX_CAN_SEEK:
352         pb = (bool *)va_arg( args, bool * );
353         *pb = true;
354         return VLC_SUCCESS;
355
356     case DEMUX_SET_PAUSE_STATE:
357         return VLC_SUCCESS;
358     case DEMUX_CAN_CONTROL_PACE:
359         pb = ( bool* )va_arg( args, bool * );
360         *pb = var_GetBool( p_demux, "jack-input-use-vlc-pace" );
361         return VLC_SUCCESS;
362
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" )
366             * 1000;
367         return VLC_SUCCESS;
368
369     case DEMUX_GET_TIME:
370         pi64 = ( int64_t* )va_arg( args, int64_t * );
371         *pi64 =  date_Get(&p_sys->pts);
372             return VLC_SUCCESS;
373
374     /* TODO implement others */
375     default:
376         return VLC_EGENERIC;
377     }
378
379     return VLC_EGENERIC;
380 }
381
382
383 /*****************************************************************************
384  * Demux
385  *****************************************************************************/
386 static int Demux( demux_t *p_demux )
387 {
388
389     demux_sys_t *p_sys;
390     es_out_id_t  *p_es;
391     block_t *p_block;
392
393     p_sys = p_demux->p_sys;
394     p_es = p_sys->p_es_audio;
395     p_block = GrabJack( p_demux );
396
397     if( p_block )
398     {
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 );
401     }
402
403     return 1;
404 }
405
406
407 /*****************************************************************************
408  * Process Callback : fill ringbuffer with Jack audio data
409  *****************************************************************************/
410 int Process( jack_nframes_t i_frames, void *p_arg )
411 {
412     demux_t            *p_demux = ( demux_t* )p_arg;
413     demux_sys_t        *p_sys = p_demux->p_sys;
414     unsigned int        i, j;
415     size_t              i_write;
416  
417     /* Get and interlace buffers */
418     for ( i = 0; i < p_sys->i_channels ; i++ )
419     {
420         p_sys->pp_jack_buffer[i] = jack_port_get_buffer(
421             p_sys->pp_jack_port_input[i], i_frames );
422     }
423
424     /* fill ring buffer with signal */
425     for( j = 0; j < i_frames; j++ )
426     {
427         for( i = 0; i <p_sys->i_channels; i++ )
428         {
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
433             }
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");
439             }
440         }
441     }
442
443     return 1;
444 }
445
446
447 /*****************************************************************************
448  * GrabJack: grab audio data in the Jack buffer
449  *****************************************************************************/
450 static block_t *GrabJack( demux_t *p_demux )
451 {
452     size_t      i_read;
453     demux_sys_t *p_sys = p_demux->p_sys;
454     block_t     *p_block;
455
456     /* read signal from ring buffer */
457     i_read = jack_ringbuffer_read_space( p_sys->p_jack_ringbuffer );
458
459     if( i_read < 100 ) /* avoid small read */
460     {   /* vlc has too much free time on its hands? */
461         msleep(1000);
462         return NULL;
463     }
464
465     if( p_sys->p_block_audio )
466     {
467         p_block = p_sys->p_block_audio;
468     }
469     else
470     {
471         p_block = block_New( p_demux, i_read );
472     }
473     if( !p_block )
474     {
475         msg_Warn( p_demux, "cannot get block" );
476         return 0;
477     }
478  
479     //Find the previous power of 2, this algo assumes size_t has the same size on all arch
480     i_read >>= 1;
481     i_read--;
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;
487     i_read++;
488  
489     i_read = jack_ringbuffer_read( p_sys->p_jack_ringbuffer, ( char * ) p_block->p_buffer, i_read );
490  
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) );
493
494     p_sys->p_block_audio = p_block;
495     p_block->i_buffer = i_read;
496     p_sys->p_block_audio = 0;
497  
498     return p_block;
499 }
500
501
502 /*****************************************************************************
503  * Port_finder: compare ports with the regexp entered
504  *****************************************************************************/
505 static void Port_finder( demux_t *p_demux )
506 {
507
508     demux_sys_t *p_sys = p_demux->p_sys;
509     char *psz_expr = p_sys->psz_ports;
510     char *token = NULL;
511     char *state = NULL;
512     char *psz_uri = NULL;
513     const char **pp_jack_port_output = NULL;
514     int i_out_ports = 0;
515     int i_total_out_ports =0;
516     p_sys->pp_jack_port_table = NULL;
517
518     /* parse the ports part of the MRL */
519     for( token = strtok_r( psz_expr, ",", &state ); token;
520             token = strtok_r( NULL, ",", &state ) )
521     {
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 )
527         {
528             msg_Err( p_demux, "port(s) asked not found:%s", psz_uri );
529             free( pp_jack_port_output );
530         }
531         else
532         {
533             while( pp_jack_port_output && pp_jack_port_output[i_out_ports] )
534             {
535                 i_out_ports++;
536             }
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 * ) ) );
540
541             for(int i=0; i<i_out_ports;i++)
542             {
543                 p_sys->pp_jack_port_table[i_total_out_ports+i] = ( char * ) pp_jack_port_output[i];
544             }
545
546             i_total_out_ports += i_out_ports;
547         }
548     }
549
550     free( pp_jack_port_output );
551     p_sys->i_match_ports = i_total_out_ports;
552 }
553
554
555 /*****************************************************************************
556  * Parse: Parse the MRL
557  *****************************************************************************/
558 static void Parse( demux_t *p_demux )
559 {
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;
563
564     if( !strncmp( psz_parser, "channels=", strlen( "channels=" ) ) )
565     {
566         p_sys->i_channels = abs( strtol( psz_parser + strlen( "channels=" ),
567             &psz_parser, 0 ) );
568     }
569     else if( !strncmp( psz_parser, "ports=", strlen( "ports=" ) ) )
570     {
571         int i_len;
572         psz_parser += strlen( "ports=" );
573         if( strchr( psz_parser, ':' ) )
574         {
575             i_len = strchr( psz_parser, ':' ) - psz_parser;
576         }
577         else
578         {
579             i_len = strlen( psz_parser );
580         }
581         p_sys->psz_ports = strndup( psz_parser, i_len );
582         psz_parser += i_len;
583     }
584     else
585     {
586         msg_Warn( p_demux, "unknown option" );
587     }
588
589     while( *psz_parser && *psz_parser != ':' )
590     {
591         psz_parser++;
592     }
593
594     if( *psz_parser == ':' )
595     {
596         for( ;; )
597         {
598             *psz_parser++ = '\0';
599             if( !strncmp( psz_parser, "channels=", strlen( "channels=" ) ) )
600             {
601                 p_sys->i_channels = abs( strtol(
602                     psz_parser + strlen( "channels=" ), &psz_parser, 0 ) );
603             }
604             else if( !strncmp( psz_parser, "ports=", strlen( "ports=" ) ) )
605             {
606                 int i_len;
607                 psz_parser += strlen( "ports=" );
608                 if( strchr( psz_parser, ':' ) )
609                 {
610                     i_len = strchr( psz_parser, ':' ) - psz_parser;
611                 }
612                 else
613                 {
614                     i_len = strlen( psz_parser );
615                 }
616                 p_sys->psz_ports = strndup( psz_parser, i_len );
617                 psz_parser += i_len;
618             }
619             else
620             {
621                 msg_Warn( p_demux, "unknown option" );
622             }
623             while( *psz_parser && *psz_parser != ':' )
624             {
625                 psz_parser++;
626             }
627
628             if( *psz_parser == '\0' )
629             {
630                 break;
631             }
632         }
633     }
634 }
635