docbase/sfz/01_sfz.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>SFZ File Format</title>
    <urlpath>sfz</urlpath>
    <meta name="description" content="SFZ File Format Reference.">
    <link rel="stylesheet" href="http://doc.linuxsampler.org/css/preview.css">
    <script type="text/javascript" src="http://doc.linuxsampler.org/js/preview.js"></script>
  </head>
  <body>
    <h1>SFZ</h1>
    <p>
      The SFZ file format is a human readable instrument definition file format
      for audio sample based virtual instruments. In contrast to many other
      sampler file formats you can open and modify such .sfz files simply with
      any text editor.
    </p>
    <note>
      This SFZ documentation is yet under construction. In the meantime you may want to
      have a look at the old and currently still separate list of <a href="http://linuxsampler.org/sfz/">opcodes supported by LinuxSampler</a>.
      You want to help filling up the missing information about the SFZ file format on this site? Great!
      Check out the <a href="http://svn.linuxsampler.org/cgi-bin/viewvc.cgi/doc/docbase/sfz/">source files of this SFZ documentation</a>
      on our Subversion server and <a href="http://linuxsampler.org/developers.html">get in touch with us</a>!
      There is also a short guide for getting started on <a href="../writing_docs/01_writing_docs.html">writing articles for this site</a>.
    </note>

    <h2>Sections</h2>
    <p>
      A sfz file is divided into sections. A section defines in which context
      the subsequent statements in the sfz file shall be interpreted as. For example
      You may want to declare a lowpass filter to be used either for the entire
      sfz instrument, or you may declare the lowpass filter to be only used for
      a certain region on the keyboard instead. A section is introduced by
      its section name, where the section name is placed in a pair of angle brackets.
      The section name is then followed by the respective sfz opcodes which shall be
      assigned to that particular section. The sections available with sfz are:
    </p>
    <table>
      <tr>
        <th>Section</th> <th>Standard</th> <th>Description</th>
      </tr>
      <tr>
        <td><code lang="sfz">&lt;global&gt;</code></td> <td>SFZ v1</td> <td>Declarations which shall apply to the entire instrument.</td>
      </tr>
      <tr>
        <td><code lang="sfz">&lt;group&gt;</code></td> <td>SFZ v1</td> <td>TODO ...</td>
      </tr>
      <tr>
        <td><code lang="sfz">&lt;region&gt;</code></td> <td>SFZ v1</td> <td>TODO ...</td>
      </tr>
      <tr>
        <td><code lang="sfz">&lt;control&gt;</code></td> <td>?</td> <td>TODO ...</td>
      </tr>
      <tr>
        <td><code lang="sfz">&lt;curve&gt;</code></td> <td>?</td> <td>TODO ...</td>
      </tr>
      <tr>
        <td><code lang="sfz">&lt;effect&gt;</code></td> <td>?</td> <td>TODO ...</td>
      </tr>
    </table>

    <h2>Opcodes</h2>
    <p>
      The actual individual statements which make up the articulation
      definition of a sfz instrument are called <i>opcodes</i>. For example there
      is an opcode for loading and assigning a sample file to be played. And
      there is an opcode for defining envelope parameters, and so on.
      The opcodes available with the SFZ file format are:
    </p>
    <table>
      <tr>
        <th>Opcode</th> <th>Standard</th> <th>Description</th>
      </tr>
      
      <tr>
        <td><code>hibend</code></td> <td>SFZ v1</td> <td>Assign pitch pend upper limit to region.</td>
      </tr>
      <tr>
        <td><code>hichan</code></td> <td>SFZ v1</td> <td>Assign MIDI channel upper limit to region.</td>
      </tr>
      <tr>
        <td><code>hikey</code></td> <td>SFZ v1</td> <td>Assign MIDI note number upper limit to region.</td>
      </tr>
      <tr>
        <td><code>hirand</code></td> <td>SFZ v1</td> <td>Assign random number generator upper limit to region.</td>
      </tr>
      <tr>
        <td><code>hivel</code></td> <td>SFZ v1</td> <td>Assign MIDI velocity upper limit to region.</td>
      </tr>
      <tr>
        <td><code>key</code></td> <td>SFZ v1</td> <td>Assign precise note number to region.</td>
      </tr>
      <tr>
        <td><code>lobend</code></td> <td>SFZ v1</td> <td>Assign pitch bend lower limit to region.</td>
      </tr>
      <tr>
        <td><code>lochan</code></td> <td>SFZ v1</td> <td>Assign MIDI channel lower limit to region.</td>
      </tr>
      <tr>
        <td><code>lokey</code></td> <td>SFZ v1</td> <td>Assign MIDI note number lower limit to region.</td>
      </tr>
      <tr>
        <td><code>lorand</code></td> <td>SFZ v1</td> <td>Assign random number generator lower limit to region.</td>
      </tr>
      <tr>
        <td><code>lovel</code></td> <td>SFZ v1</td> <td>Assign MIDI velocity lower limit to region.</td>
      </tr>
      <tr>
        <td><code lang="sfz">sample</code></td> <td>SFZ v1</td> <td>Load and assign an audio sample file.</td>
      </tr>
      <tr>
        <td><code lang="sfz">script</code></td> <td>LinuxSampler Ext.</td> <td>Load an real-time instrument script for the instrument.</td>
      </tr>
      <tr>
        <td><code>seq_length</code></td> <td>SFZ v1</td> <td>Defines a round robin length.</td>
      </tr>
      <tr>
        <td><code>seq_position</code></td> <td>SFZ v1</td> <td>Assigns a round robin position to a region.</td>
      </tr>
      <tr>
        <td><code>set_ccN</code></td> <td>SFZ v2</td> <td>Assign initial value to MIDI controller.</td>
      </tr>
      <tr>
        <td><code>transpose</code></td> <td>SFZ v1</td> <td>Transpose by given amount of semi tones.</td>
      </tr>
      <tr>
        <td><code>tune</code></td> <td>SFZ v1</td> <td>Fine tuning by given amount of cents.</td>
      </tr>
      <tr>
        <td>TODO ...</td> <td></td> <td></td>
      </tr>
    </table>

  </body>
</html>
1	schoenebeck	3083	<html>
2			<head>
3			<meta name="author" content="Christian Schoenebeck">
4			<title>SFZ File Format</title>
5			<urlpath>sfz</urlpath>
6			<meta name="description" content="SFZ File Format Reference.">
7			<link rel="stylesheet" href="http://doc.linuxsampler.org/css/preview.css">
8			<script type="text/javascript" src="http://doc.linuxsampler.org/js/preview.js"></script>
9			</head>
10			<body>
11			<h1>SFZ</h1>
12			<p>
13			The SFZ file format is a human readable instrument definition file format
14			for audio sample based virtual instruments. In contrast to many other
15			sampler file formats you can open and modify such .sfz files simply with
16			any text editor.
17			</p>
18	schoenebeck	3087	<note>
19			This SFZ documentation is yet under construction. In the meantime you may want to
20			have a look at the old and currently still separate list of <a href="http://linuxsampler.org/sfz/">opcodes supported by LinuxSampler</a>.
21			You want to help filling up the missing information about the SFZ file format on this site? Great!
22			Check out the <a href="http://svn.linuxsampler.org/cgi-bin/viewvc.cgi/doc/docbase/sfz/">source files of this SFZ documentation</a>
23			on our Subversion server and <a href="http://linuxsampler.org/developers.html">get in touch with us</a>!
24			There is also a short guide for getting started on <a href="../writing_docs/01_writing_docs.html">writing articles for this site</a>.
25			</note>
26	schoenebeck	3083
27			<h2>Sections</h2>
28			<p>
29			A sfz file is divided into sections. A section defines in which context
30			the subsequent statements in the sfz file shall be interpreted as. For example
31			You may want to declare a lowpass filter to be used either for the entire
32			sfz instrument, or you may declare the lowpass filter to be only used for
33			a certain region on the keyboard instead. A section is introduced by
34			its section name, where the section name is placed in a pair of angle brackets.
35			The section name is then followed by the respective sfz opcodes which shall be
36			assigned to that particular section. The sections available with sfz are:
37			</p>
38			<table>
39			<tr>
40			<th>Section</th> <th>Standard</th> <th>Description</th>
41			</tr>
42			<tr>
43			<td><code lang="sfz"><global></code></td> <td>SFZ v1</td> <td>Declarations which shall apply to the entire instrument.</td>
44			</tr>
45			<tr>
46			<td><code lang="sfz"><group></code></td> <td>SFZ v1</td> <td>TODO ...</td>
47			</tr>
48			<tr>
49			<td><code lang="sfz"><region></code></td> <td>SFZ v1</td> <td>TODO ...</td>
50			</tr>
51			<tr>
52			<td><code lang="sfz"><control></code></td> <td>?</td> <td>TODO ...</td>
53			</tr>
54			<tr>
55			<td><code lang="sfz"><curve></code></td> <td>?</td> <td>TODO ...</td>
56			</tr>
57			<tr>
58			<td><code lang="sfz"><effect></code></td> <td>?</td> <td>TODO ...</td>
59			</tr>
60			</table>
61
62			<h2>Opcodes</h2>
63			<p>
64			The actual individual statements which make up the articulation
65			definition of a sfz instrument are called <i>opcodes</i>. For example there
66			is an opcode for loading and assigning a sample file to be played. And
67			there is an opcode for defining envelope parameters, and so on.
68			The opcodes available with the SFZ file format are:
69			</p>
70			<table>
71			<tr>
72			<th>Opcode</th> <th>Standard</th> <th>Description</th>
73			</tr>
74	schoenebeck	3149
75	schoenebeck	3083	<tr>
76	schoenebeck	3149	<td><code>hibend</code></td> <td>SFZ v1</td> <td>Assign pitch pend upper limit to region.</td>
77			</tr>
78			<tr>
79			<td><code>hichan</code></td> <td>SFZ v1</td> <td>Assign MIDI channel upper limit to region.</td>
80			</tr>
81			<tr>
82			<td><code>hikey</code></td> <td>SFZ v1</td> <td>Assign MIDI note number upper limit to region.</td>
83			</tr>
84			<tr>
85			<td><code>hirand</code></td> <td>SFZ v1</td> <td>Assign random number generator upper limit to region.</td>
86			</tr>
87			<tr>
88			<td><code>hivel</code></td> <td>SFZ v1</td> <td>Assign MIDI velocity upper limit to region.</td>
89			</tr>
90			<tr>
91			<td><code>key</code></td> <td>SFZ v1</td> <td>Assign precise note number to region.</td>
92			</tr>
93			<tr>
94			<td><code>lobend</code></td> <td>SFZ v1</td> <td>Assign pitch bend lower limit to region.</td>
95			</tr>
96			<tr>
97			<td><code>lochan</code></td> <td>SFZ v1</td> <td>Assign MIDI channel lower limit to region.</td>
98			</tr>
99			<tr>
100			<td><code>lokey</code></td> <td>SFZ v1</td> <td>Assign MIDI note number lower limit to region.</td>
101			</tr>
102			<tr>
103			<td><code>lorand</code></td> <td>SFZ v1</td> <td>Assign random number generator lower limit to region.</td>
104			</tr>
105			<tr>
106			<td><code>lovel</code></td> <td>SFZ v1</td> <td>Assign MIDI velocity lower limit to region.</td>
107			</tr>
108			<tr>
109	schoenebeck	3083	<td><code lang="sfz">sample</code></td> <td>SFZ v1</td> <td>Load and assign an audio sample file.</td>
110			</tr>
111			<tr>
112			<td><code lang="sfz">script</code></td> <td>LinuxSampler Ext.</td> <td>Load an real-time instrument script for the instrument.</td>
113			</tr>
114			<tr>
115	schoenebeck	3149	<td><code>seq_length</code></td> <td>SFZ v1</td> <td>Defines a round robin length.</td>
116			</tr>
117			<tr>
118			<td><code>seq_position</code></td> <td>SFZ v1</td> <td>Assigns a round robin position to a region.</td>
119			</tr>
120			<tr>
121	schoenebeck	3098	<td><code>set_ccN</code></td> <td>SFZ v2</td> <td>Assign initial value to MIDI controller.</td>
122			</tr>
123			<tr>
124	schoenebeck	3149	<td><code>transpose</code></td> <td>SFZ v1</td> <td>Transpose by given amount of semi tones.</td>
125			</tr>
126			<tr>
127			<td><code>tune</code></td> <td>SFZ v1</td> <td>Fine tuning by given amount of cents.</td>
128			</tr>
129			<tr>
130	schoenebeck	3083	<td>TODO ...</td> <td></td> <td></td>
131			</tr>
132			</table>
133
134			</body>
135			</html>