summaryrefslogtreecommitdiff
path: root/opcodes/fluidLoad.xml
blob: 0b19114782cee84c5de8b37f3b8a62fe437b2307 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<refentry id="fluidLoad">
<indexterm id="IndexFluidLoad"><primary>fluidLoad</primary></indexterm>
  <refentryinfo><title>Signal Generators:Sample Playback</title></refentryinfo>
  <refmeta>
    <refentrytitle>fluidLoad</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>fluidLoad</refname>
    <refpurpose>
       Loads a SoundFont into a fluidEngine, optionally listing SoundFont contents.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Syntax</title>
    <synopsis>isfnum <command>fluidLoad</command> soundfont, ienginenum[, ilistpresets]</synopsis>
  </refsect1>

  <refsect1>
    <title>Description</title> 
    <para>Loads a SoundFont into an instance of a fluidEngine, optionally
    listing banks and presets for SoundFont.
    </para>  
  </refsect1>

  <refsect1>
    <title>Initialization</title>

    <para><emphasis>isfnum </emphasis> -- number assigned to just-loaded
    soundfont.</para>
    <para><emphasis>soundfont </emphasis> -- string specifying a SoundFont
    filename. Note that any number of SoundFonts may be loaded (obviously,
    by different invocations of fluidLoad).</para>
    <para><emphasis>ienginenum </emphasis> -- engine number assigned from
      fluidEngine</para>
    <para><emphasis>ilistpresets </emphasis> -- optional, if specified, lists all
      Fluidsynth programs for the just-loaded SoundFont. A Fluidsynth program is a
      combination of SoundFont ID, bank number, and preset number that is assigned to
      a MIDI channel.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>Invoke fluidLoad in the orchestra header, any number of
    times. The same SoundFont may be invoked to assign programs to MIDI
    channels any number of times; the SoundFont is only loaded the first
    time.</para>
  </refsect1>
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the fluidsynth opcodes. It uses the file <ulink url="examples/fluid.orc"><citetitle>fluid.orc</citetitle></ulink>.
    </para>
    <xi:include href="examples-xml/fluid.orc.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
    <para>
      See <link linkend="fluidEngine"><citetitle>fluidEngine</citetitle></link> for more examples.
    </para>
  </refsect1>
  <refsect1>
    <title>See Also</title>
    <para><link linkend="fluidEngine"><citetitle>fluidEngine</citetitle></link>, <link linkend="fluidNote"><citetitle>fluidNote</citetitle></link></para>
  </refsect1>
  <refsect1>
    <title>Credits</title>
    <para>Michael Gogins (gogins at pipeline dot
  com), Steven Yi. Thanks to Peter Hanappe for Fluidsynth.
    </para>
    <para>New in Csound5.00</para>
  </refsect1>
</refentry>