git.sesse.net Git - vlc/blob - modules/audio_output/jack.c

   1 /*****************************************************************************
   2  * jack : JACK audio output module
   3  *****************************************************************************
   4  * Copyright (C) 2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet <asmax _at_ videolan.org>
   8  *          Jon Griffiths <jon_p_griffiths _At_ yahoo _DOT_ com>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24 /**
  25  * \file modules/audio_output/jack.c
  26  * \brief JACK audio output functions
  27  */
  28 /*****************************************************************************
  29  * Preamble
  30  *****************************************************************************/
  31 #include <unistd.h>                                      /* write(), close() */
  32
  33 #ifdef HAVE_CONFIG_H
  34 # include "config.h"
  35 #endif
  36
  37 #include <vlc_common.h>
  38 #include <vlc_plugin.h>
  39 #include <vlc_aout.h>
  40
  41 #include <jack/jack.h>
  42
  43 typedef jack_default_audio_sample_t jack_sample_t;
  44
  45 /*****************************************************************************
  46  * aout_sys_t: JACK audio output method descriptor
  47  *****************************************************************************
  48  * This structure is part of the audio output thread descriptor.
  49  * It describes some JACK specific variables.
  50  *****************************************************************************/
  51 struct aout_sys_t
  52 {
  53     aout_packet_t   packet;
  54     jack_client_t  *p_jack_client;
  55     jack_port_t   **p_jack_ports;
  56     jack_sample_t **p_jack_buffers;
  57     unsigned int    i_channels;
  58     jack_nframes_t latency;
  59 };
  60
  61 /*****************************************************************************
  62  * Local prototypes
  63  *****************************************************************************/
  64 static int  Open         ( vlc_object_t * );
  65 static void Close        ( vlc_object_t * );
  66 static int  Process      ( jack_nframes_t i_frames, void *p_arg );
  67 static int  GraphChange  ( void *p_arg );
  68
  69 #define AUTO_CONNECT_OPTION "jack-auto-connect"
  70 #define AUTO_CONNECT_TEXT N_("Automatically connect to writable clients")
  71 #define AUTO_CONNECT_LONGTEXT N_( \
  72     "If enabled, this option will automatically connect sound output to the " \
  73     "first writable JACK clients found." )
  74
  75 #define CONNECT_REGEX_OPTION "jack-connect-regex"
  76 #define CONNECT_REGEX_TEXT N_("Connect to clients matching")
  77 #define CONNECT_REGEX_LONGTEXT N_( \
  78     "If automatic connection is enabled, only JACK clients whose names " \
  79     "match this regular expression will be considered for connection." )
  80
  81 /*****************************************************************************
  82  * Module descriptor
  83  *****************************************************************************/
  84 vlc_module_begin ()
  85     set_shortname( "JACK" )
  86     set_description( N_("JACK audio output") )
  87     set_capability( "audio output", 100 )
  88     set_category( CAT_AUDIO )
  89     set_subcategory( SUBCAT_AUDIO_AOUT )
  90     add_bool( AUTO_CONNECT_OPTION, true, AUTO_CONNECT_TEXT,
  91               AUTO_CONNECT_LONGTEXT, false )
  92     add_string( CONNECT_REGEX_OPTION, "system", CONNECT_REGEX_TEXT,
  93                 CONNECT_REGEX_LONGTEXT, false )
  94     set_callbacks( Open, Close )
  95 vlc_module_end ()
  96
  97 /*****************************************************************************
  98  * Open: create a JACK client
  99  *****************************************************************************/
 100 static int Open( vlc_object_t *p_this )
 101 {
 102     char psz_name[32];
 103     audio_output_t *p_aout = (audio_output_t *)p_this;
 104     struct aout_sys_t *p_sys = NULL;
 105     int status = VLC_SUCCESS;
 106     unsigned int i;
 107     int i_error;
 108
 109     /* Allocate structure */
 110     p_sys = calloc( 1, sizeof( aout_sys_t ) );
 111     if( p_sys == NULL )
 112     {
 113         status = VLC_ENOMEM;
 114         goto error_out;
 115     }
 116     p_aout->sys = p_sys;
 117     p_sys->latency = 0;
 118
 119     /* Connect to the JACK server */
 120     snprintf( psz_name, sizeof(psz_name), "vlc_%d", getpid());
 121     psz_name[sizeof(psz_name) - 1] = '\0';
 122     p_sys->p_jack_client = jack_client_open( psz_name,
 123                                              JackNullOption | JackNoStartServer,
 124                                              NULL );
 125     if( p_sys->p_jack_client == NULL )
 126     {
 127         msg_Err( p_aout, "failed to connect to JACK server" );
 128         status = VLC_EGENERIC;
 129         goto error_out;
 130     }
 131
 132     /* Set the process callback */
 133     jack_set_process_callback( p_sys->p_jack_client, Process, p_aout );
 134     jack_set_graph_order_callback ( p_sys->p_jack_client, GraphChange, p_aout );
 135
 136     p_aout->pf_play = aout_PacketPlay;
 137     p_aout->pf_pause = aout_PacketPause;
 138     p_aout->pf_flush = aout_PacketFlush;
 139     aout_PacketInit( p_aout, &p_sys->packet,
 140                      jack_get_buffer_size( p_sys->p_jack_client ) );
 141     aout_VolumeSoftInit( p_aout );
 142
 143     /* JACK only supports fl32 format */
 144     p_aout->format.i_format = VLC_CODEC_FL32;
 145     // TODO add buffer size callback
 146     p_aout->format.i_rate = jack_get_sample_rate( p_sys->p_jack_client );
 147
 148     p_sys->i_channels = aout_FormatNbChannels( &p_aout->format );
 149
 150     p_sys->p_jack_ports = malloc( p_sys->i_channels *
 151                                   sizeof(jack_port_t *) );
 152     if( p_sys->p_jack_ports == NULL )
 153     {
 154         status = VLC_ENOMEM;
 155         goto error_out;
 156     }
 157
 158     p_sys->p_jack_buffers = malloc( p_sys->i_channels *
 159                                     sizeof(jack_sample_t *) );
 160     if( p_sys->p_jack_buffers == NULL )
 161     {
 162         status = VLC_ENOMEM;
 163         goto error_out;
 164     }
 165
 166     /* Create the output ports */
 167     for( i = 0; i < p_sys->i_channels; i++ )
 168     {
 169         snprintf( psz_name, sizeof(psz_name), "out_%d", i + 1);
 170         psz_name[sizeof(psz_name) - 1] = '\0';
 171         p_sys->p_jack_ports[i] = jack_port_register( p_sys->p_jack_client,
 172                 psz_name, JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0 );
 173
 174         if( p_sys->p_jack_ports[i] == NULL )
 175         {
 176             msg_Err( p_aout, "failed to register a JACK port" );
 177             status = VLC_EGENERIC;
 178             goto error_out;
 179         }
 180     }
 181
 182     /* Tell the JACK server we are ready */
 183     i_error = jack_activate( p_sys->p_jack_client );
 184     if( i_error )
 185     {
 186         msg_Err( p_aout, "failed to activate JACK client (error %d)", i_error );
 187         status = VLC_EGENERIC;
 188         goto error_out;
 189     }
 190
 191     /* Auto connect ports if we were asked to */
 192     if( var_InheritBool( p_aout, AUTO_CONNECT_OPTION ) )
 193     {
 194         unsigned int i_in_ports;
 195         char *psz_regex = var_InheritString( p_aout, CONNECT_REGEX_OPTION );
 196         const char **pp_in_ports = jack_get_ports( p_sys->p_jack_client,
 197                                                    psz_regex, NULL,
 198                                                    JackPortIsInput );
 199         free( psz_regex );
 200         /* Count the number of returned ports */
 201         i_in_ports = 0;
 202         while( pp_in_ports && pp_in_ports[i_in_ports] )
 203         {
 204             i_in_ports++;
 205         }
 206
 207         /* Tie the output ports to JACK input ports */
 208         for( i = 0; i_in_ports > 0 && i < p_sys->i_channels; i++ )
 209         {
 210             const char* psz_in = pp_in_ports[i % i_in_ports];
 211             const char* psz_out = jack_port_name( p_sys->p_jack_ports[i] );
 212
 213             i_error = jack_connect( p_sys->p_jack_client, psz_out, psz_in );
 214             if( i_error )
 215             {
 216                 msg_Err( p_aout, "failed to connect port %s to port %s (error %d)",
 217                          psz_out, psz_in, i_error );
 218             }
 219             else
 220             {
 221                 msg_Dbg( p_aout, "connecting port %s to port %s",
 222                          psz_out, psz_in );
 223             }
 224         }
 225         free( pp_in_ports );
 226     }
 227
 228     msg_Dbg( p_aout, "JACK audio output initialized (%d channels, rate=%d)",
 229              p_sys->i_channels, p_aout->format.i_rate );
 230
 231 error_out:
 232     /* Clean up, if an error occurred */
 233     if( status != VLC_SUCCESS && p_sys != NULL)
 234     {
 235         if( p_sys->p_jack_client )
 236         {
 237             jack_deactivate( p_sys->p_jack_client );
 238             jack_client_close( p_sys->p_jack_client );
 239             aout_PacketDestroy( p_aout );
 240         }
 241         free( p_sys->p_jack_ports );
 242         free( p_sys->p_jack_buffers );
 243         free( p_sys );
 244     }
 245     return status;
 246 }
 247
 248
 249 /*****************************************************************************
 250  * Process: callback for JACK
 251  *****************************************************************************/
 252 int Process( jack_nframes_t i_frames, void *p_arg )
 253 {
 254     unsigned int i, j, i_nb_samples = 0;
 255     audio_output_t *p_aout = (audio_output_t*) p_arg;
 256     struct aout_sys_t *p_sys = p_aout->sys;
 257     jack_sample_t *p_src = NULL;
 258
 259     jack_nframes_t dframes = p_sys->latency
 260                              - jack_frames_since_cycle_start( p_sys->p_jack_client );
 261
 262     jack_time_t dtime = dframes * 1000 * 1000 / jack_get_sample_rate( p_sys->p_jack_client );
 263     mtime_t play_date = mdate() + (mtime_t) ( dtime );
 264
 265     /* Get the next audio data buffer */
 266     aout_buffer_t *p_buffer = aout_PacketNext( p_aout, play_date );
 267
 268     if( p_buffer != NULL )
 269     {
 270         p_src = (jack_sample_t *)p_buffer->p_buffer;
 271         i_nb_samples = p_buffer->i_nb_samples;
 272     }
 273
 274     /* Get the JACK buffers to write to */
 275     for( i = 0; i < p_sys->i_channels; i++ )
 276     {
 277         p_sys->p_jack_buffers[i] = jack_port_get_buffer( p_sys->p_jack_ports[i],
 278                                                          i_frames );
 279     }
 280
 281     /* Copy in the audio data */
 282     for( j = 0; j < i_nb_samples; j++ )
 283     {
 284         for( i = 0; i < p_sys->i_channels; i++ )
 285         {
 286             jack_sample_t *p_dst = p_sys->p_jack_buffers[i];
 287             p_dst[j] = *p_src;
 288             p_src++;
 289         }
 290     }
 291
 292     /* Fill any remaining buffer with silence */
 293     if( i_nb_samples < i_frames )
 294     {
 295         for( i = 0; i < p_sys->i_channels; i++ )
 296         {
 297             memset( p_sys->p_jack_buffers[i] + i_nb_samples, 0,
 298                     sizeof( jack_sample_t ) * (i_frames - i_nb_samples) );
 299         }
 300     }
 301
 302     if( p_buffer )
 303     {
 304         aout_BufferFree( p_buffer );
 305     }
 306     return 0;
 307 }
 308
 309 /*****************************************************************************
 310  * GraphChange: callback when JACK reorders it's process graph.
 311                 We update latency information.
 312  *****************************************************************************/
 313
 314 static int GraphChange( void *p_arg )
 315 {
 316   audio_output_t *p_aout = (audio_output_t*) p_arg;
 317   struct aout_sys_t *p_sys = p_aout->sys;
 318   unsigned int i;
 319   jack_nframes_t port_latency;
 320
 321   p_sys->latency = 0;
 322
 323   for( i = 0; i < p_sys->i_channels; ++i )
 324   {
 325     port_latency = jack_port_get_total_latency( p_sys->p_jack_client,
 326                                                   p_sys->p_jack_ports[i] );
 327     p_sys->latency = __MAX( p_sys->latency, port_latency );
 328   }
 329
 330   msg_Dbg(p_aout, "JACK graph reordered. Our maximum latency=%d.", p_sys->latency);
 331
 332   return 0;
 333 }
 334
 335 /*****************************************************************************
 336  * Close: close the JACK client
 337  *****************************************************************************/
 338 static void Close( vlc_object_t *p_this )
 339 {
 340     int i_error;
 341     audio_output_t *p_aout = (audio_output_t *)p_this;
 342     struct aout_sys_t *p_sys = p_aout->sys;
 343
 344     i_error = jack_deactivate( p_sys->p_jack_client );
 345     if( i_error )
 346     {
 347         msg_Err( p_aout, "jack_deactivate failed (error %d)", i_error );
 348     }
 349
 350     i_error = jack_client_close( p_sys->p_jack_client );
 351     if( i_error )
 352     {
 353         msg_Err( p_aout, "jack_client_close failed (error %d)", i_error );
 354     }
 355     free( p_sys->p_jack_ports );
 356     free( p_sys->p_jack_buffers );
 357     aout_PacketDestroy( p_aout );
 358     free( p_sys );
 359 }