jack.c
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:11k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * jack : JACK audio output module
  3.  *****************************************************************************
  4.  * Copyright (C) 2006 the VideoLAN team
  5.  * $Id: e6f26546d662f263492c7f90b645da2bd459f30b $
  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. #ifdef HAVE_CONFIG_H
  33. # include "config.h"
  34. #endif
  35. #include <vlc_common.h>
  36. #include <vlc_plugin.h>
  37. #include <vlc_aout.h>
  38. #include <jack/jack.h>
  39. typedef jack_default_audio_sample_t jack_sample_t;
  40. /*****************************************************************************
  41.  * aout_sys_t: JACK audio output method descriptor
  42.  *****************************************************************************
  43.  * This structure is part of the audio output thread descriptor.
  44.  * It describes some JACK specific variables.
  45.  *****************************************************************************/
  46. struct aout_sys_t
  47. {
  48.     jack_client_t  *p_jack_client;
  49.     jack_port_t   **p_jack_ports;
  50.     jack_sample_t **p_jack_buffers;
  51.     unsigned int    i_channels;
  52. };
  53. /*****************************************************************************
  54.  * Local prototypes
  55.  *****************************************************************************/
  56. static int  Open         ( vlc_object_t * );
  57. static void Close        ( vlc_object_t * );
  58. static void Play         ( aout_instance_t * );
  59. static int  Process      ( jack_nframes_t i_frames, void *p_arg );
  60. #define AUTO_CONNECT_OPTION "jack-auto-connect"
  61. #define AUTO_CONNECT_TEXT N_("Automatically connect to writable clients")
  62. #define AUTO_CONNECT_LONGTEXT N_( 
  63.     "If enabled, this option will automatically connect sound output to the " 
  64.     "first writable JACK clients found." )
  65. #define CONNECT_REGEX_OPTION "jack-connect-regex"
  66. #define CONNECT_REGEX_TEXT N_("Connect to clients matching")
  67. #define CONNECT_REGEX_LONGTEXT N_( 
  68.     "If automatic connection is enabled, only JACK clients whose names " 
  69.     "match this regular expression will be considered for connection." )
  70. /*****************************************************************************
  71.  * Module descriptor
  72.  *****************************************************************************/
  73. vlc_module_begin ()
  74.     set_shortname( "JACK" )
  75.     set_description( N_("JACK audio output") )
  76.     set_capability( "audio output", 100 )
  77.     set_category( CAT_AUDIO )
  78.     set_subcategory( SUBCAT_AUDIO_AOUT )
  79.     add_bool( AUTO_CONNECT_OPTION, 0, NULL, AUTO_CONNECT_TEXT,
  80.               AUTO_CONNECT_LONGTEXT, true )
  81.     add_string( CONNECT_REGEX_OPTION, NULL, NULL, CONNECT_REGEX_TEXT,
  82.                 CONNECT_REGEX_LONGTEXT, true )
  83.     set_callbacks( Open, Close )
  84. vlc_module_end ()
  85. /*****************************************************************************
  86.  * Open: create a JACK client
  87.  *****************************************************************************/
  88. static int Open( vlc_object_t *p_this )
  89. {
  90.     char psz_name[32];
  91.     aout_instance_t *p_aout = (aout_instance_t *)p_this;
  92.     struct aout_sys_t *p_sys = NULL;
  93.     int status = VLC_SUCCESS;
  94.     unsigned int i;
  95.     int i_error;
  96.     /* Allocate structure */
  97.     p_sys = calloc( 1, sizeof( aout_sys_t ) );
  98.     if( p_sys == NULL )
  99.     {
  100.         status = VLC_ENOMEM;
  101.         goto error_out;
  102.     }
  103.     p_aout->output.p_sys = p_sys;
  104.     /* Connect to the JACK server */
  105.     snprintf( psz_name, sizeof(psz_name), "vlc_%d", getpid());
  106.     psz_name[sizeof(psz_name) - 1] = '';
  107.     p_sys->p_jack_client = jack_client_open( psz_name,
  108.                                              JackNullOption | JackNoStartServer,
  109.                                              NULL );
  110.     if( p_sys->p_jack_client == NULL )
  111.     {
  112.         msg_Err( p_aout, "failed to connect to JACK server" );
  113.         status = VLC_EGENERIC;
  114.         goto error_out;
  115.     }
  116.     /* Set the process callback */
  117.     jack_set_process_callback( p_sys->p_jack_client, Process, p_aout );
  118.     p_aout->output.pf_play = Play;
  119.     aout_VolumeSoftInit( p_aout );
  120.     /* JACK only supports fl32 format */
  121.     p_aout->output.output.i_format = VLC_FOURCC('f','l','3','2');
  122.     // TODO add buffer size callback
  123.     p_aout->output.i_nb_samples = jack_get_buffer_size( p_sys->p_jack_client );
  124.     p_aout->output.output.i_rate = jack_get_sample_rate( p_sys->p_jack_client );
  125.     p_sys->i_channels = aout_FormatNbChannels( &p_aout->output.output );
  126.     p_sys->p_jack_ports = malloc( p_sys->i_channels *
  127.                                   sizeof(jack_port_t *) );
  128.     if( p_sys->p_jack_ports == NULL )
  129.     {
  130.         status = VLC_ENOMEM;
  131.         goto error_out;
  132.     }
  133.     p_sys->p_jack_buffers = malloc( p_sys->i_channels *
  134.                                     sizeof(jack_sample_t *) );
  135.     if( p_sys->p_jack_buffers == NULL )
  136.     {
  137.         status = VLC_ENOMEM;
  138.         goto error_out;
  139.     }
  140.     /* Create the output ports */
  141.     for( i = 0; i < p_sys->i_channels; i++ )
  142.     {
  143.         snprintf( psz_name, sizeof(psz_name), "out_%d", i + 1);
  144.         psz_name[sizeof(psz_name) - 1] = '';
  145.         p_sys->p_jack_ports[i] = jack_port_register( p_sys->p_jack_client,
  146.                 psz_name, JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0 );
  147.         if( p_sys->p_jack_ports[i] == NULL )
  148.         {
  149.             msg_Err( p_aout, "failed to register a JACK port" );
  150.             status = VLC_EGENERIC;
  151.             goto error_out;
  152.         }
  153.     }
  154.     /* Tell the JACK server we are ready */
  155.     i_error = jack_activate( p_sys->p_jack_client );
  156.     if( i_error )
  157.     {
  158.         msg_Err( p_aout, "failed to activate JACK client (error %d)", i_error );
  159.         status = VLC_EGENERIC;
  160.         goto error_out;
  161.     }
  162.     /* Auto connect ports if we were asked to */
  163.     if( config_GetInt( p_aout, AUTO_CONNECT_OPTION ) )
  164.     {
  165.         unsigned int i_in_ports;
  166.         char *psz_regex = config_GetPsz( p_aout, CONNECT_REGEX_OPTION );
  167.         const char **pp_in_ports = jack_get_ports( p_sys->p_jack_client,
  168.                                                    psz_regex, NULL,
  169.                                                    JackPortIsInput );
  170.         free( psz_regex );
  171.         /* Count the number of returned ports */
  172.         i_in_ports = 0;
  173.         while( pp_in_ports && pp_in_ports[i_in_ports] )
  174.         {
  175.             i_in_ports++;
  176.         }
  177.         /* Tie the output ports to JACK input ports */
  178.         for( i = 0; i_in_ports > 0 && i < p_sys->i_channels; i++ )
  179.         {
  180.             const char* psz_in = pp_in_ports[i % i_in_ports];
  181.             const char* psz_out = jack_port_name( p_sys->p_jack_ports[i] );
  182.             i_error = jack_connect( p_sys->p_jack_client, psz_out, psz_in );
  183.             if( i_error )
  184.             {
  185.                 msg_Err( p_aout, "failed to connect port %s to port %s (error %d)",
  186.                          psz_out, psz_in, i_error );
  187.             }
  188.             else
  189.             {
  190.                 msg_Dbg( p_aout, "connecting port %s to port %s",
  191.                          psz_out, psz_in );
  192.             }
  193.         }
  194.         free( pp_in_ports );
  195.     }
  196.     msg_Dbg( p_aout, "JACK audio output initialized (%d channels, buffer "
  197.              "size=%d, rate=%d)", p_sys->i_channels,
  198.              p_aout->output.i_nb_samples, p_aout->output.output.i_rate );
  199. error_out:
  200.     /* Clean up, if an error occurred */
  201.     if( status != VLC_SUCCESS && p_sys != NULL)
  202.     {
  203.         if( p_sys->p_jack_client )
  204.         {
  205.             jack_deactivate( p_sys->p_jack_client );
  206.             jack_client_close( p_sys->p_jack_client );
  207.         }
  208.         free( p_sys->p_jack_ports );
  209.         free( p_sys->p_jack_buffers );
  210.         free( p_sys );
  211.     }
  212.     return status;
  213. }
  214. /*****************************************************************************
  215.  * Process: callback for JACK
  216.  *****************************************************************************/
  217. int Process( jack_nframes_t i_frames, void *p_arg )
  218. {
  219.     unsigned int i, j, i_nb_samples = 0;
  220.     aout_instance_t *p_aout = (aout_instance_t*) p_arg;
  221.     struct aout_sys_t *p_sys = p_aout->output.p_sys;
  222.     jack_sample_t *p_src = NULL;
  223.     /* Get the next audio data buffer */
  224.     vlc_mutex_lock( &p_aout->output_fifo_lock );
  225.     aout_buffer_t *p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
  226.     vlc_mutex_unlock( &p_aout->output_fifo_lock );
  227.     if( p_buffer != NULL )
  228.     {
  229.         p_src = (jack_sample_t *)p_buffer->p_buffer;
  230.         i_nb_samples = p_buffer->i_nb_samples;
  231.     }
  232.     /* Get the JACK buffers to write to */
  233.     for( i = 0; i < p_sys->i_channels; i++ )
  234.     {
  235.         p_sys->p_jack_buffers[i] = jack_port_get_buffer( p_sys->p_jack_ports[i],
  236.                                                          i_frames );
  237.     }
  238.     /* Copy in the audio data */
  239.     for( j = 0; j < i_nb_samples; j++ )
  240.     {
  241.         for( i = 0; i < p_sys->i_channels; i++ )
  242.         {
  243.             jack_sample_t *p_dst = p_sys->p_jack_buffers[i];
  244.             p_dst[j] = *p_src;
  245.             p_src++;
  246.         }
  247.     }
  248.     /* Fill any remaining buffer with silence */
  249.     if( i_nb_samples < i_frames )
  250.     {
  251.         for( i = 0; i < p_sys->i_channels; i++ )
  252.         {
  253.             memset( p_sys->p_jack_buffers[i] + i_nb_samples, 0,
  254.                     sizeof( jack_sample_t ) * (i_frames - i_nb_samples) );
  255.         }
  256.     }
  257.     if( p_buffer )
  258.     {
  259.         aout_BufferFree( p_buffer );
  260.     }
  261.     return 0;
  262. }
  263. /*****************************************************************************
  264.  * Play: nothing to do
  265.  *****************************************************************************/
  266. static void Play( aout_instance_t *p_aout )
  267. {
  268.     aout_FifoFirstDate( p_aout, &p_aout->output.fifo );
  269. }
  270. /*****************************************************************************
  271.  * Close: close the JACK client
  272.  *****************************************************************************/
  273. static void Close( vlc_object_t *p_this )
  274. {
  275.     int i_error;
  276.     aout_instance_t *p_aout = (aout_instance_t *)p_this;
  277.     struct aout_sys_t *p_sys = p_aout->output.p_sys;
  278.     i_error = jack_deactivate( p_sys->p_jack_client );
  279.     if( i_error )
  280.     {
  281.         msg_Err( p_aout, "jack_deactivate failed (error %d)", i_error );
  282.     }
  283.     i_error = jack_client_close( p_sys->p_jack_client );
  284.     if( i_error )
  285.     {
  286.         msg_Err( p_aout, "jack_client_close failed (error %d)", i_error );
  287.     }
  288.     free( p_sys->p_jack_ports );
  289.     free( p_sys->p_jack_buffers );
  290.     free( p_sys );
  291. }