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_aout.h>
  29 #include <vlc_codec.h>
  30 #include <vlc_cpu.h>
  31 #include <vlc_dialog.h>
  32 #include <vlc_charset.h>
  33
  34 /* On Win32, we link statically */
  35 #ifdef WIN32
  36 # define FLUIDSYNTH_NOT_A_DLL
  37 #endif
  38
  39 #include <fluidsynth.h>
  40
  41 #if (FLUIDSYNTH_VERSION_MAJOR < 1) \
  42  || (FLUIDSYNTH_VERSION_MAJOR == 1 && FLUIDSYNTH_VERSION_MINOR < 1)
  43 # define FLUID_FAILED (-1)
  44 # define fluid_synth_sysex(synth, ptr, len, d, e, f, g) (FLUID_FAILED)
  45 # define fluid_synth_system_reset(synth) (FLUID_FAILED)
  46 # define fluid_synth_channel_pressure(synth, channel, p) (FLUID_FAILED)
  47 #endif
  48
  49 #define SOUNDFONT_TEXT N_("Sound fonts (required)")
  50 #define SOUNDFONT_LONGTEXT N_( \
  51     "A sound fonts file is required for software synthesis." )
  52
  53 static int  Open  (vlc_object_t *);
  54 static void Close (vlc_object_t *);
  55
  56 vlc_module_begin ()
  57     set_description (N_("FluidSynth MIDI synthesizer"))
  58     set_capability ("decoder", 100)
  59     set_shortname (N_("FluidSynth"))
  60     set_category (CAT_INPUT)
  61     set_subcategory (SUBCAT_INPUT_ACODEC)
  62     set_callbacks (Open, Close)
  63     add_loadfile ("soundfont", "",
  64                   SOUNDFONT_TEXT, SOUNDFONT_LONGTEXT, false);
  65 vlc_module_end ()
  66
  67
  68 struct decoder_sys_t
  69 {
  70     fluid_settings_t *settings;
  71     fluid_synth_t    *synth;
  72     int               soundfont;
  73     bool              fixed;
  74     date_t            end_date;
  75 };
  76
  77
  78 static aout_buffer_t *DecodeBlock (decoder_t *p_dec, block_t **pp_block);
  79
  80
  81 static int Open (vlc_object_t *p_this)
  82 {
  83     decoder_t *p_dec = (decoder_t *)p_this;
  84     decoder_sys_t *p_sys;
  85
  86     if (p_dec->fmt_in.i_codec != VLC_CODEC_MIDI)
  87         return VLC_EGENERIC;
  88
  89     char *font_path = var_InheritString (p_this, "soundfont");
  90     if (font_path == NULL)
  91     {
  92         msg_Err (p_this, "sound font file required for synthesis");
  93         dialog_Fatal (p_this, _("MIDI synthesis not set up"),
  94             _("A sound font file (.SF2) is required for MIDI synthesis.\n"
  95               "Please install a sound font and configure it "
  96               "from the VLC preferences "
  97               "(Input / Codecs > Audio codecs > FluidSynth).\n"));
  98         return VLC_EGENERIC;
  99     }
 100
 101     p_dec->pf_decode_audio = DecodeBlock;
 102     p_sys = p_dec->p_sys = malloc (sizeof (*p_sys));
 103     if (p_sys == NULL)
 104     {
 105         free (font_path);
 106         return VLC_ENOMEM;
 107     }
 108
 109     p_sys->settings = new_fluid_settings ();
 110     p_sys->synth = new_fluid_synth (p_sys->settings);
 111     /* FIXME: I bet this is not thread-safe */
 112     const char *lpath = ToLocale (font_path);
 113     p_sys->soundfont = fluid_synth_sfload (p_sys->synth, font_path, 1);
 114     LocaleFree (lpath);
 115     if (p_sys->soundfont == -1)
 116     {
 117         msg_Err (p_this, "cannot load sound fonts file %s", font_path);
 118         Close (p_this);
 119         dialog_Fatal (p_this, _("MIDI synthesis not set up"),
 120             _("The specified sound font file (%s) is incorrect.\n"
 121               "Please install a valid sound font and reconfigure it "
 122               "from the VLC preferences (Codecs / Audio / FluidSynth).\n"),
 123               font_path);
 124         free (font_path);
 125         return VLC_EGENERIC;
 126     }
 127     free (font_path);
 128
 129     p_dec->fmt_out.i_cat = AUDIO_ES;
 130     p_dec->fmt_out.audio.i_rate = 44100;
 131     p_dec->fmt_out.audio.i_channels = 2;
 132     p_dec->fmt_out.audio.i_original_channels =
 133     p_dec->fmt_out.audio.i_physical_channels =
 134         AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
 135     if (HAVE_FPU)
 136     {
 137         p_dec->fmt_out.i_codec = VLC_CODEC_FL32;
 138         p_dec->fmt_out.audio.i_bitspersample = 32;
 139         p_sys->fixed = false;
 140     }
 141     else
 142     {
 143         p_dec->fmt_out.i_codec = VLC_CODEC_S16N;
 144         p_dec->fmt_out.audio.i_bitspersample = 16;
 145         p_sys->fixed = true;
 146     }
 147     date_Init (&p_sys->end_date, p_dec->fmt_out.audio.i_rate, 1);
 148     date_Set (&p_sys->end_date, 0);
 149
 150     return VLC_SUCCESS;
 151 }
 152
 153
 154 static void Close (vlc_object_t *p_this)
 155 {
 156     decoder_sys_t *p_sys = ((decoder_t *)p_this)->p_sys;
 157
 158     if (p_sys->soundfont != -1)
 159         fluid_synth_sfunload (p_sys->synth, p_sys->soundfont, 1);
 160     delete_fluid_synth (p_sys->synth);
 161     delete_fluid_settings (p_sys->settings);
 162     free (p_sys);
 163 }
 164
 165
 166 static aout_buffer_t *DecodeBlock (decoder_t *p_dec, block_t **pp_block)
 167 {
 168     block_t *p_block;
 169     decoder_sys_t *p_sys = p_dec->p_sys;
 170     aout_buffer_t *p_out = NULL;
 171
 172     if (pp_block == NULL)
 173         return NULL;
 174     p_block = *pp_block;
 175     if (p_block == NULL)
 176         return NULL;
 177     *pp_block = NULL;
 178
 179     if (p_block->i_pts > VLC_TS_INVALID && !date_Get (&p_sys->end_date))
 180         date_Set (&p_sys->end_date, p_block->i_pts);
 181     else
 182     if (p_block->i_pts < date_Get (&p_sys->end_date))
 183     {
 184         msg_Warn (p_dec, "MIDI message in the past?");
 185         goto drop;
 186     }
 187
 188     if (p_block->i_buffer < 1)
 189         goto drop;
 190
 191     uint8_t event = p_block->p_buffer[0];
 192     uint8_t channel = p_block->p_buffer[0] & 0xf;
 193     event &= 0xF0;
 194
 195     if (event == 0xF0)
 196         switch (channel)
 197         {
 198             case 0:
 199                 if (p_block->p_buffer[p_block->i_buffer - 1] != 0xF7)
 200                 {
 201             case 7:
 202                     msg_Warn (p_dec, "fragmented SysEx not implemented");
 203                     goto drop;
 204                 }
 205                 fluid_synth_sysex (p_sys->synth, (char *)p_block->p_buffer + 1,
 206                                    p_block->i_buffer - 2, NULL, NULL, NULL, 0);
 207                 break;
 208             case 0xF:
 209                 fluid_synth_system_reset (p_sys->synth);
 210                 break;
 211         }
 212
 213     uint8_t p1 = (p_block->i_buffer > 1) ? (p_block->p_buffer[1] & 0x7f) : 0;
 214     uint8_t p2 = (p_block->i_buffer > 2) ? (p_block->p_buffer[2] & 0x7f) : 0;
 215
 216     switch (event & 0xF0)
 217     {
 218         case 0x80:
 219             fluid_synth_noteoff (p_sys->synth, channel, p1);
 220             break;
 221         case 0x90:
 222             fluid_synth_noteon (p_sys->synth, channel, p1, p2);
 223             break;
 224         /*case 0xA0: note aftertouch not implemented */
 225         case 0xB0:
 226             fluid_synth_cc (p_sys->synth, channel, p1, p2);
 227             break;
 228         case 0xC0:
 229             fluid_synth_program_change (p_sys->synth, channel, p1);
 230             break;
 231         case 0xD0:
 232             fluid_synth_channel_pressure (p_sys->synth, channel, p1);
 233             break;
 234         case 0xE0:
 235             fluid_synth_pitch_bend (p_sys->synth, channel, (p2 << 7) | p1);
 236             break;
 237     }
 238
 239     unsigned samples =
 240         (p_block->i_pts - date_Get (&p_sys->end_date)) * 441 / 10000;
 241     if (samples == 0)
 242         goto drop;
 243
 244     p_out = decoder_NewAudioBuffer (p_dec, samples);
 245     if (p_out == NULL)
 246         goto drop;
 247
 248     p_out->i_pts = date_Get (&p_sys->end_date );
 249     p_out->i_length = date_Increment (&p_sys->end_date, samples)
 250                       - p_out->i_pts;
 251     if (!p_sys->fixed)
 252         fluid_synth_write_float (p_sys->synth, samples,
 253                                  p_out->p_buffer, 0, 2,
 254                                  p_out->p_buffer, 1, 2);
 255     else
 256         fluid_synth_write_s16 (p_sys->synth, samples,
 257                                (int16_t *)p_out->p_buffer, 0, 2,
 258                                (int16_t *)p_out->p_buffer, 1, 2);
 259 drop:
 260     block_Release (p_block);
 261     return p_out;
 262 }