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

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