]> git.sesse.net Git - vlc/blob - modules/access/jack.c
Used VLC_CODEC_* and vlc_fourcc_GetCodec when suitable.
[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_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 captured 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          AUTO_CONNECT_TEXT, AUTO_CONNECT_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 )
146         return VLC_ENOMEM;
147
148     /* Parse MRL */
149     Parse( p_demux );
150
151     /* Create var */
152     var_Create( p_demux, "jack-input-caching",
153         VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
154     var_Create( p_demux, "jack-input-use-vlc-pace",
155         VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
156     var_Create( p_demux, "jack-input-auto-connect",
157         VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
158
159     /* JACK connexions */
160     /* define name and connect to jack server */
161     char p_vlc_client_name[32];
162     sprintf( p_vlc_client_name, "vlc-input-%d", getpid() );
163     p_sys->p_jack_client = jack_client_new( p_vlc_client_name );
164     if( p_sys->p_jack_client == NULL )
165     {
166         msg_Err( p_demux, "failed to connect to JACK server" );
167         free( p_sys );
168         return VLC_EGENERIC;
169     }
170
171     /* find some specifics ports if user entered a regexp */
172     if( p_sys->psz_ports )
173     {
174         Port_finder( p_demux );
175         if( p_sys->i_channels == 0 )
176         {
177             p_sys->i_channels = p_sys->i_match_ports;
178         }
179     }
180
181     /* allocate input ports */
182     if( p_sys->i_channels == 0 ) p_sys->i_channels = 2 ; /* default number of port */
183     p_sys->pp_jack_port_input = malloc(
184         p_sys->i_channels * sizeof( jack_port_t* ) );
185     if( p_sys->pp_jack_port_input == NULL )
186     {
187         jack_client_close( p_sys->p_jack_client );
188         free( p_sys );
189         return VLC_ENOMEM;
190     }
191
192     /* allocate ringbuffer */
193     /* The length of the ringbuffer is critical, it must be large enought
194        to keep all data between 2 GrabJack() calls.  We assume 1 sec is ok */
195     p_sys->p_jack_ringbuffer = jack_ringbuffer_create( p_sys->i_channels
196          * jack_get_sample_rate( p_sys->p_jack_client )
197          * sizeof( jack_default_audio_sample_t ) );
198     if( p_sys->p_jack_ringbuffer == NULL )
199     {
200         free( p_sys->pp_jack_port_input );
201         jack_client_close( p_sys->p_jack_client );
202         free( p_sys );
203         return VLC_ENOMEM;
204     }
205
206     /* register input ports */
207     for( i = 0; i <  p_sys->i_channels; i++ )
208     {
209         char p_input_name[32];
210         snprintf( p_input_name, 32, "vlc_in_%d", i+1 );
211         p_sys->pp_jack_port_input[i] = jack_port_register(
212             p_sys->p_jack_client, p_input_name, JACK_DEFAULT_AUDIO_TYPE,
213             JackPortIsInput, 0 );
214         if( p_sys->pp_jack_port_input[i] == NULL )
215         {
216             msg_Err( p_demux, "failed to register a JACK port" );
217             jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
218             free( p_sys->pp_jack_port_input );
219             jack_client_close( p_sys->p_jack_client );
220             free( p_sys );
221             return VLC_EGENERIC;
222         }
223     }
224
225     /* allocate buffer for input ports */
226     p_sys->pp_jack_buffer = malloc ( p_sys->i_channels
227         * sizeof( jack_default_audio_sample_t * ) );
228     if( p_sys->pp_jack_buffer == NULL )
229     {
230         for( i = 0; i < p_sys->i_channels; i++ )
231             jack_port_unregister( p_sys->p_jack_client, p_sys->pp_jack_port_input[i] );
232         jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
233         free( p_sys->pp_jack_port_input );
234         jack_client_close( p_sys->p_jack_client );
235         free( p_sys );
236         return VLC_ENOMEM;
237     }
238
239     /* set process callback */
240     jack_set_process_callback( p_sys->p_jack_client, Process, p_demux );
241
242     /* tell jack server we are ready */
243     if ( jack_activate( p_sys->p_jack_client ) )
244     {
245         msg_Err( p_demux, "failed to activate JACK client" );
246         free( p_sys->pp_jack_buffer );
247         for( i = 0; i < p_sys->i_channels; i++ )
248             jack_port_unregister( p_sys->p_jack_client, p_sys->pp_jack_port_input[i] );
249         jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
250         free( p_sys->pp_jack_port_input );
251         jack_client_close( p_sys->p_jack_client );
252         free( p_sys );
253         return VLC_EGENERIC;
254     }
255
256     /* connect vlc input to specifics jack output ports if requested */
257    /*  if( var_GetBool( p_demux, "jack-input-auto-connect" ) && p_sys->psz_ports ) */
258     if( p_sys->psz_ports )
259     {
260         int        i_input_ports;
261         int        j;
262  
263     if( p_sys->i_match_ports > 0 )
264         {
265             for( j = 0; j < p_sys->i_match_ports; j++ )
266             {
267                 i_input_ports = j % p_sys->i_channels;
268                 jack_connect( p_sys->p_jack_client, p_sys->pp_jack_port_table[j],
269                     jack_port_name( p_sys->pp_jack_port_input[i_input_ports] ) );
270             }
271         }
272     }
273
274     /* connect vlc input to all jack output ports if requested */
275     if( var_GetBool( p_demux, "jack-input-auto-connect" ) && !p_sys->psz_ports )
276     {
277         int        i_input_ports;
278         int        j;
279         const char **pp_jack_port_output;
280
281         pp_jack_port_output = jack_get_ports( p_sys->p_jack_client, NULL, NULL, JackPortIsOutput );
282
283         while( pp_jack_port_output && pp_jack_port_output[i_out_ports] )
284         {
285             i_out_ports++;
286         }
287         if( i_out_ports > 0 )
288         {
289             for( j = 0; j < i_out_ports; j++ )
290             {
291                 i_input_ports = j % p_sys->i_channels;
292                 jack_connect( p_sys->p_jack_client, pp_jack_port_output[j],
293                     jack_port_name( p_sys->pp_jack_port_input[i_input_ports] ) );
294             }
295         }
296         free( pp_jack_port_output );
297     }
298
299     /* info about jack server */
300     /* get buffers size */
301     p_sys->jack_buffer_size = jack_get_buffer_size( p_sys->p_jack_client );
302     /* get sample rate */
303     p_sys->jack_sample_rate = jack_get_sample_rate( p_sys->p_jack_client );
304     /* get sample size */
305     p_sys->jack_sample_size = sizeof( jack_default_audio_sample_t );
306
307     /* Define output format */
308     es_format_Init( &fmt, AUDIO_ES, VLC_CODEC_FL32 );
309     fmt.audio.i_channels =  p_sys->i_channels;
310     fmt.audio.i_rate =  p_sys->jack_sample_rate;
311     fmt.audio.i_bitspersample =  p_sys->jack_sample_size * 8;
312     fmt.audio.i_blockalign = fmt.audio.i_bitspersample / 8;
313     fmt.i_bitrate = fmt.audio.i_rate * fmt.audio.i_bitspersample
314         * fmt.audio.i_channels;
315
316     p_sys->p_es_audio = es_out_Add( p_demux->out, &fmt );
317     date_Init( &p_sys->pts, fmt.audio.i_rate, 1 );
318     date_Set( &p_sys->pts, 1 );
319
320     return VLC_SUCCESS;
321 }
322
323
324 /*****************************************************************************
325  * Close: Disconnect from jack server and release associated resources
326  *****************************************************************************/
327 static void Close( vlc_object_t *p_this )
328 {
329     demux_t    *p_demux = ( demux_t* )p_this;
330     demux_sys_t    *p_sys = p_demux->p_sys;
331
332     msg_Dbg( p_demux,"Module unloaded" );
333     if( p_sys->p_block_audio ) block_Release( p_sys->p_block_audio );
334     if( p_sys->p_jack_client ) jack_client_close( p_sys->p_jack_client );
335     if( p_sys->p_jack_ringbuffer ) jack_ringbuffer_free( p_sys->p_jack_ringbuffer );
336     free( p_sys->pp_jack_port_input );
337     free( p_sys->pp_jack_buffer );
338     free( p_sys->pp_jack_port_table );
339     free( p_sys );
340 }
341
342
343 /*****************************************************************************
344  * Control
345  *****************************************************************************/
346 static int Control( demux_t *p_demux, int i_query, va_list args )
347 {
348     bool  *pb;
349     int64_t     *pi64;
350     demux_sys_t *p_sys = p_demux->p_sys;
351
352     switch( i_query )
353     {
354     /* Special for access_demux */
355     case DEMUX_CAN_PAUSE:
356     case DEMUX_CAN_SEEK:
357         pb = (bool *)va_arg( args, bool * );
358         *pb = true;
359         return VLC_SUCCESS;
360
361     case DEMUX_SET_PAUSE_STATE:
362         return VLC_SUCCESS;
363     case DEMUX_CAN_CONTROL_PACE:
364         pb = ( bool* )va_arg( args, bool * );
365         *pb = var_GetBool( p_demux, "jack-input-use-vlc-pace" );
366         return VLC_SUCCESS;
367
368     case DEMUX_GET_PTS_DELAY:
369         pi64 = ( int64_t* )va_arg( args, int64_t * );
370         *pi64 = ( int64_t )var_GetInteger( p_demux, "jack-input-caching" )
371             * 1000;
372         return VLC_SUCCESS;
373
374     case DEMUX_GET_TIME:
375         pi64 = ( int64_t* )va_arg( args, int64_t * );
376         *pi64 =  date_Get(&p_sys->pts);
377             return VLC_SUCCESS;
378
379     /* TODO implement others */
380     default:
381         return VLC_EGENERIC;
382     }
383
384     return VLC_EGENERIC;
385 }
386
387
388 /*****************************************************************************
389  * Demux
390  *****************************************************************************/
391 static int Demux( demux_t *p_demux )
392 {
393
394     demux_sys_t *p_sys;
395     es_out_id_t  *p_es;
396     block_t *p_block;
397
398     p_sys = p_demux->p_sys;
399     p_es = p_sys->p_es_audio;
400     p_block = GrabJack( p_demux );
401
402     if( p_block )
403     {
404         es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
405         es_out_Send( p_demux->out, p_es, p_block );
406     }
407
408     return 1;
409 }
410
411
412 /*****************************************************************************
413  * Process Callback : fill ringbuffer with Jack audio data
414  *****************************************************************************/
415 int Process( jack_nframes_t i_frames, void *p_arg )
416 {
417     demux_t            *p_demux = ( demux_t* )p_arg;
418     demux_sys_t        *p_sys = p_demux->p_sys;
419     unsigned int        i, j;
420     size_t              i_write;
421  
422     /* Get and interlace buffers */
423     for ( i = 0; i < p_sys->i_channels ; i++ )
424     {
425         p_sys->pp_jack_buffer[i] = jack_port_get_buffer(
426             p_sys->pp_jack_port_input[i], i_frames );
427     }
428
429     /* fill ring buffer with signal */
430     for( j = 0; j < i_frames; j++ )
431     {
432         for( i = 0; i <p_sys->i_channels; i++ )
433         {
434             if( jack_ringbuffer_write_space( p_sys->p_jack_ringbuffer ) <
435                 p_sys->jack_sample_size ) {
436                 msg_Err( p_demux, "buffer overflow");
437                 return 0; // buffer overflow
438             }
439             i_write = jack_ringbuffer_write( p_sys->p_jack_ringbuffer,
440                                              ( char * ) (p_sys->pp_jack_buffer[i]+j),
441                                              p_sys->jack_sample_size );
442             if (i_write != p_sys->jack_sample_size ) {
443                 msg_Warn( p_demux, "error writing on ring buffer");
444             }
445         }
446     }
447
448     return 1;
449 }
450
451
452 /*****************************************************************************
453  * GrabJack: grab audio data in the Jack buffer
454  *****************************************************************************/
455 static block_t *GrabJack( demux_t *p_demux )
456 {
457     size_t      i_read;
458     demux_sys_t *p_sys = p_demux->p_sys;
459     block_t     *p_block;
460
461     /* read signal from ring buffer */
462     i_read = jack_ringbuffer_read_space( p_sys->p_jack_ringbuffer );
463
464     if( i_read < 100 ) /* avoid small read */
465     {   /* vlc has too much free time on its hands? */
466         msleep(1000);
467         return NULL;
468     }
469
470     if( p_sys->p_block_audio )
471     {
472         p_block = p_sys->p_block_audio;
473     }
474     else
475     {
476         p_block = block_New( p_demux, i_read );
477     }
478     if( !p_block )
479     {
480         msg_Warn( p_demux, "cannot get block" );
481         return 0;
482     }
483  
484     //Find the previous power of 2, this algo assumes size_t has the same size on all arch
485     i_read >>= 1;
486     i_read--;
487     i_read |= i_read >> 1;
488     i_read |= i_read >> 2;
489     i_read |= i_read >> 4;
490     i_read |= i_read >> 8;
491     i_read |= i_read >> 16;
492     i_read++;
493  
494     i_read = jack_ringbuffer_read( p_sys->p_jack_ringbuffer, ( char * ) p_block->p_buffer, i_read );
495  
496     p_block->i_dts = p_block->i_pts =    date_Increment( &p_sys->pts,
497          i_read/(p_sys->i_channels * p_sys->jack_sample_size) );
498
499     p_sys->p_block_audio = p_block;
500     p_block->i_buffer = i_read;
501     p_sys->p_block_audio = 0;
502  
503     return p_block;
504 }
505
506
507 /*****************************************************************************
508  * Port_finder: compare ports with the regexp entered
509  *****************************************************************************/
510 static void Port_finder( demux_t *p_demux )
511 {
512
513     demux_sys_t *p_sys = p_demux->p_sys;
514     char *psz_expr = p_sys->psz_ports;
515     char *token = NULL;
516     char *state = NULL;
517     char *psz_uri = NULL;
518     const char **pp_jack_port_output = NULL;
519     int i_out_ports = 0;
520     int i_total_out_ports =0;
521     p_sys->pp_jack_port_table = NULL;
522
523     /* parse the ports part of the MRL */
524     for( token = strtok_r( psz_expr, ",", &state ); token;
525             token = strtok_r( NULL, ",", &state ) )
526     {
527         psz_uri = decode_URI_duplicate( token );
528         /* get the ports which match the regexp */
529         pp_jack_port_output = jack_get_ports( p_sys->p_jack_client,
530            psz_uri, NULL, JackPortIsOutput );
531         if( pp_jack_port_output == NULL )
532         {
533             msg_Err( p_demux, "port(s) asked not found:%s", psz_uri );
534             free( pp_jack_port_output );
535         }
536         else
537         {
538             while( pp_jack_port_output && pp_jack_port_output[i_out_ports] )
539             {
540                 i_out_ports++;
541             }
542             /* alloc an array to store all the matched ports */
543             p_sys->pp_jack_port_table = realloc( p_sys->pp_jack_port_table,
544                 (i_out_ports * sizeof( char * ) + i_total_out_ports * sizeof( char * ) ) );
545
546             for(int i=0; i<i_out_ports;i++)
547             {
548                 p_sys->pp_jack_port_table[i_total_out_ports+i] = ( char * ) pp_jack_port_output[i];
549             }
550
551             i_total_out_ports += i_out_ports;
552         }
553     }
554
555     free( pp_jack_port_output );
556     p_sys->i_match_ports = i_total_out_ports;
557 }
558
559
560 /*****************************************************************************
561  * Parse: Parse the MRL
562  *****************************************************************************/
563 static void Parse( demux_t *p_demux )
564 {
565     demux_sys_t *p_sys = p_demux->p_sys;
566     char *psz_dup = strdup( p_demux->psz_path );
567     char *psz_parser = psz_dup;
568
569     if( !strncmp( psz_parser, "channels=", strlen( "channels=" ) ) )
570     {
571         p_sys->i_channels = abs( strtol( psz_parser + strlen( "channels=" ),
572             &psz_parser, 0 ) );
573     }
574     else if( !strncmp( psz_parser, "ports=", strlen( "ports=" ) ) )
575     {
576         int i_len;
577         psz_parser += strlen( "ports=" );
578         if( strchr( psz_parser, ':' ) )
579         {
580             i_len = strchr( psz_parser, ':' ) - psz_parser;
581         }
582         else
583         {
584             i_len = strlen( psz_parser );
585         }
586         p_sys->psz_ports = strndup( psz_parser, i_len );
587         psz_parser += i_len;
588     }
589     else
590     {
591         msg_Warn( p_demux, "unknown option" );
592     }
593
594     while( *psz_parser && *psz_parser != ':' )
595     {
596         psz_parser++;
597     }
598
599     if( *psz_parser == ':' )
600     {
601         for( ;; )
602         {
603             *psz_parser++ = '\0';
604             if( !strncmp( psz_parser, "channels=", strlen( "channels=" ) ) )
605             {
606                 p_sys->i_channels = abs( strtol(
607                     psz_parser + strlen( "channels=" ), &psz_parser, 0 ) );
608             }
609             else if( !strncmp( psz_parser, "ports=", strlen( "ports=" ) ) )
610             {
611                 int i_len;
612                 psz_parser += strlen( "ports=" );
613                 if( strchr( psz_parser, ':' ) )
614                 {
615                     i_len = strchr( psz_parser, ':' ) - psz_parser;
616                 }
617                 else
618                 {
619                     i_len = strlen( psz_parser );
620                 }
621                 p_sys->psz_ports = strndup( psz_parser, i_len );
622                 psz_parser += i_len;
623             }
624             else
625             {
626                 msg_Warn( p_demux, "unknown option" );
627             }
628             while( *psz_parser && *psz_parser != ':' )
629             {
630                 psz_parser++;
631             }
632
633             if( *psz_parser == '\0' )
634             {
635                 break;
636             }
637         }
638     }
639 }
640