git.sesse.net Git - vlc/blob - modules/codec/fluidsynth.c

   1 /*****************************************************************************
   2  * fluidsynth.c: Software MIDI synthesizer using libfluidsynth
   3  *****************************************************************************
   4  * Copyright © 2007 Rémi Denis-Courmont
   5  * $Id$
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  20  *****************************************************************************/
  21
  22 #ifdef HAVE_CONFIG_H
  23 # include "config.h"
  24 #endif
  25
  26 #include <vlc_common.h>
  27 #include <vlc_plugin.h>
  28 #include <vlc_codec.h>
  29 #include <vlc_dialog.h>
  30 #include <vlc_charset.h>
  31
  32 #ifdef HAVE_UNISTD_H
  33 # include <unistd.h>
  34 #endif
  35 #ifdef _POSIX_VERSION
  36 # include <glob.h>
  37 #endif
  38
  39 /* On Win32, we link statically */
  40 #ifdef WIN32
  41 # define FLUIDSYNTH_NOT_A_DLL
  42 #endif
  43
  44 #include <fluidsynth.h>
  45
  46 #define SOUNDFONT_TEXT N_("Sound fonts")
  47 #define SOUNDFONT_LONGTEXT N_( \
  48     "A sound fonts file is required for software synthesis." )
  49
  50 #define GAIN_TEXT N_("Synthesis gain")
  51 #define GAIN_LONGTEXT N_("This gain is applied to synthesis output. " \
  52     "High values may cause saturation when many notes are played at a time." )
  53
  54 #define SAMPLE_RATE_TEXT N_("Sample rate")
  55
  56 static int  Open  (vlc_object_t *);
  57 static void Close (vlc_object_t *);
  58
  59 vlc_module_begin ()
  60     set_description (N_("FluidSynth MIDI synthesizer"))
  61     set_capability ("decoder", 100)
  62     set_shortname (N_("FluidSynth"))
  63     set_category (CAT_INPUT)
  64     set_subcategory (SUBCAT_INPUT_ACODEC)
  65     set_callbacks (Open, Close)
  66     add_loadfile ("soundfont", "",
  67                   SOUNDFONT_TEXT, SOUNDFONT_LONGTEXT, false)
  68     add_float ("synth-gain", 0.8, GAIN_TEXT, GAIN_LONGTEXT, false)
  69         change_float_range (0., 10.)
  70     add_integer ("synth-sample-rate", 44100,
  71                  SAMPLE_RATE_TEXT, SAMPLE_RATE_TEXT, true)
  72         change_integer_range (22050, 96000)
  73 vlc_module_end ()
  74
  75
  76 struct decoder_sys_t
  77 {
  78     fluid_settings_t *settings;
  79     fluid_synth_t    *synth;
  80     int               soundfont;
  81     date_t            end_date;
  82 };
  83
  84
  85 static aout_buffer_t *DecodeBlock (decoder_t *p_dec, block_t **pp_block);
  86
  87
  88 static int Open (vlc_object_t *p_this)
  89 {
  90     decoder_t *p_dec = (decoder_t *)p_this;
  91
  92     if (p_dec->fmt_in.i_codec != VLC_CODEC_MIDI)
  93         return VLC_EGENERIC;
  94
  95     decoder_sys_t *p_sys = malloc (sizeof (*p_sys));
  96     if (unlikely(p_sys == NULL))
  97         return VLC_ENOMEM;
  98
  99     p_sys->settings = new_fluid_settings ();
 100     p_sys->synth = new_fluid_synth (p_sys->settings);
 101     p_sys->soundfont = -1;
 102
 103     char *font_path = var_InheritString (p_this, "soundfont");
 104     if (font_path != NULL)
 105     {
 106         const char *lpath = ToLocale (font_path);
 107
 108         msg_Dbg (p_this, "loading sound fonts file %s", font_path);
 109         p_sys->soundfont = fluid_synth_sfload (p_sys->synth, font_path, 1);
 110         LocaleFree (lpath);
 111         if (p_sys->soundfont == -1)
 112             msg_Err (p_this, "cannot load sound fonts file %s", font_path);
 113         free (font_path);
 114     }
 115 #ifdef _POSIX_VERSION
 116     else
 117     {
 118         glob_t gl;
 119
 120         glob ("/usr/share/sounds/sf2/*.sf2", GLOB_NOESCAPE, NULL, &gl);
 121         for (size_t i = 0; i < gl.gl_pathc; i++)
 122         {
 123             const char *path = gl.gl_pathv[i];
 124
 125             msg_Dbg (p_this, "loading sound fonts file %s", path);
 126             p_sys->soundfont = fluid_synth_sfload (p_sys->synth, path, 1);
 127             if (p_sys->soundfont != -1)
 128                 break; /* it worked! */
 129             msg_Err (p_this, "cannot load sound fonts file %s", path);
 130         }
 131         globfree (&gl);
 132     }
 133 #endif
 134
 135     if (p_sys->soundfont == -1)
 136     {
 137         msg_Err (p_this, "sound font file required for synthesis");
 138         dialog_Fatal (p_this, _("MIDI synthesis not set up"),
 139             _("A sound font file (.SF2) is required for MIDI synthesis.\n"
 140               "Please install a sound font and configure it "
 141               "from the VLC preferences "
 142               "(Input / Codecs > Audio codecs > FluidSynth).\n"));
 143         delete_fluid_synth (p_sys->synth);
 144         delete_fluid_settings (p_sys->settings);
 145         free (p_sys);
 146         return VLC_EGENERIC;
 147     }
 148
 149     fluid_synth_set_gain (p_sys->synth,
 150                           var_InheritFloat (p_this, "synth-gain"));
 151
 152     p_dec->fmt_out.i_cat = AUDIO_ES;
 153     p_dec->fmt_out.audio.i_rate =
 154         var_InheritInteger (p_this, "synth-sample-rate");;
 155     fluid_synth_set_sample_rate (p_sys->synth, p_dec->fmt_out.audio.i_rate);
 156     p_dec->fmt_out.audio.i_channels = 2;
 157     p_dec->fmt_out.audio.i_original_channels =
 158     p_dec->fmt_out.audio.i_physical_channels =
 159         AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
 160     p_dec->fmt_out.i_codec = VLC_CODEC_FL32;
 161     p_dec->fmt_out.audio.i_bitspersample = 32;
 162     date_Init (&p_sys->end_date, p_dec->fmt_out.audio.i_rate, 1);
 163     date_Set (&p_sys->end_date, 0);
 164
 165     p_dec->p_sys = p_sys;
 166     p_dec->pf_decode_audio = DecodeBlock;
 167     return VLC_SUCCESS;
 168 }
 169
 170
 171 static void Close (vlc_object_t *p_this)
 172 {
 173     decoder_sys_t *p_sys = ((decoder_t *)p_this)->p_sys;
 174
 175     fluid_synth_sfunload (p_sys->synth, p_sys->soundfont, 1);
 176     delete_fluid_synth (p_sys->synth);
 177     delete_fluid_settings (p_sys->settings);
 178     free (p_sys);
 179 }
 180
 181
 182 static aout_buffer_t *DecodeBlock (decoder_t *p_dec, block_t **pp_block)
 183 {
 184     block_t *p_block;
 185     decoder_sys_t *p_sys = p_dec->p_sys;
 186     aout_buffer_t *p_out = NULL;
 187
 188     if (pp_block == NULL)
 189         return NULL;
 190     p_block = *pp_block;
 191     if (p_block == NULL)
 192         return NULL;
 193     *pp_block = NULL;
 194
 195     if (p_block->i_pts > VLC_TS_INVALID && !date_Get (&p_sys->end_date))
 196         date_Set (&p_sys->end_date, p_block->i_pts);
 197     else
 198     if (p_block->i_pts < date_Get (&p_sys->end_date))
 199     {
 200         msg_Warn (p_dec, "MIDI message in the past?");
 201         goto drop;
 202     }
 203
 204     if (p_block->i_buffer < 1)
 205         goto drop;
 206
 207     uint8_t event = p_block->p_buffer[0];
 208     uint8_t channel = p_block->p_buffer[0] & 0xf;
 209     event &= 0xF0;
 210
 211     if (event == 0xF0)
 212         switch (channel)
 213         {
 214             case 0:
 215                 if (p_block->p_buffer[p_block->i_buffer - 1] != 0xF7)
 216                 {
 217             case 7:
 218                     msg_Warn (p_dec, "fragmented SysEx not implemented");
 219                     goto drop;
 220                 }
 221                 fluid_synth_sysex (p_sys->synth, (char *)p_block->p_buffer + 1,
 222                                    p_block->i_buffer - 2, NULL, NULL, NULL, 0);
 223                 break;
 224             case 0xF:
 225                 fluid_synth_system_reset (p_sys->synth);
 226                 break;
 227         }
 228
 229     uint8_t p1 = (p_block->i_buffer > 1) ? (p_block->p_buffer[1] & 0x7f) : 0;
 230     uint8_t p2 = (p_block->i_buffer > 2) ? (p_block->p_buffer[2] & 0x7f) : 0;
 231
 232     switch (event & 0xF0)
 233     {
 234         case 0x80:
 235             fluid_synth_noteoff (p_sys->synth, channel, p1);
 236             break;
 237         case 0x90:
 238             fluid_synth_noteon (p_sys->synth, channel, p1, p2);
 239             break;
 240         /*case 0xA0: note aftertouch not implemented */
 241         case 0xB0:
 242             fluid_synth_cc (p_sys->synth, channel, p1, p2);
 243             break;
 244         case 0xC0:
 245             fluid_synth_program_change (p_sys->synth, channel, p1);
 246             break;
 247         case 0xD0:
 248             fluid_synth_channel_pressure (p_sys->synth, channel, p1);
 249             break;
 250         case 0xE0:
 251             fluid_synth_pitch_bend (p_sys->synth, channel, (p2 << 7) | p1);
 252             break;
 253     }
 254
 255     unsigned samples =
 256         (p_block->i_pts - date_Get (&p_sys->end_date)) * 441 / 10000;
 257     if (samples == 0)
 258         goto drop;
 259
 260     p_out = decoder_NewAudioBuffer (p_dec, samples);
 261     if (p_out == NULL)
 262         goto drop;
 263
 264     p_out->i_pts = date_Get (&p_sys->end_date );
 265     p_out->i_length = date_Increment (&p_sys->end_date, samples)
 266                       - p_out->i_pts;
 267     fluid_synth_write_float (p_sys->synth, samples, p_out->p_buffer, 0, 2,
 268                              p_out->p_buffer, 1, 2);
 269 drop:
 270     block_Release (p_block);
 271     return p_out;
 272 }