<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>sfinstr</title>
<link rel="stylesheet" type="text/css" href="csound.css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1" />
<link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
<link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" />
<link rel="prev" href="sfinstr3m.html" title="sfinstr3m" />
<link rel="next" href="sfinstrm.html" title="sfinstrm" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">sfinstr</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="sfinstr3m.html">Prev</a> </td>
<th width="60%" align="center">Orchestra Opcodes and Operators</th>
<td width="20%" align="right"> <a accesskey="n" href="sfinstrm.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="refentry" title="sfinstr">
<a id="sfinstr"></a>
<div class="titlepage"></div>
<a id="IndexSfinstr" class="indexterm"></a>
<div class="refnamediv">
<h2>
<span class="refentrytitle">sfinstr</span>
</h2>
<p>sfinstr —
Plays a SoundFont2 (SF2) sample instrument, generating a stereo sound.
</p>
</div>
<div class="refsect1" title="Description">
<a id="idp42417320"></a>
<h2>Description</h2>
<p>
Plays a SoundFont2 (SF2) sample instrument, generating a stereo sound. These opcodes allow management the sample-structure of SF2 files. In order to understand the usage of these opcodes, the user must have some knowledge of the SF2 format, so a brief description of this format can be found in the <a class="link" href="MiscSf2.html" title="Appendix G. SoundFont2 File Format"><em class="citetitle">SoundFont2 File Format Appendix</em></a>.
</p>
</div>
<div class="refsect1" title="Syntax">
<a id="idp42418648"></a>
<h2>Syntax</h2>
<pre class="synopsis">ar1, ar2 <span class="command"><strong>sfinstr</strong></span> ivel, inotenum, xamp, xfreq, instrnum, ifilhandle \
[, iflag] [, ioffset]</pre>
</div>
<div class="refsect1" title="Initialization">
<a id="idp42478072"></a>
<h2>Initialization</h2>
<p>
<span class="emphasis"><em>ivel</em></span> -- velocity value
</p>
<p>
<span class="emphasis"><em>inotenum</em></span> -- MIDI note number value
</p>
<p>
<span class="emphasis"><em>instrnum</em></span> -- number of an instrument of a SF2 file.
</p>
<p>
<span class="emphasis"><em>ifilhandle</em></span> -- unique number generated by <span class="emphasis"><em>sfload</em></span> opcode to be used as an identifier for a SF2 file. Several SF2 files can be loaded and activated at the same time.
</p>
<p>
<span class="emphasis"><em>iflag</em></span> (optional) -- flag regarding the behavior of <span class="emphasis"><em>xfreq</em></span> and <span class="emphasis"><em>inotenum</em></span>
</p>
<p>
<span class="emphasis"><em>ioffset</em></span> (optional) -- start playing at offset, in samples.
</p>
</div>
<div class="refsect1" title="Performance">
<a id="idp42481936"></a>
<h2>Performance</h2>
<p>
<span class="emphasis"><em>xamp</em></span> -- amplitude correction factor
</p>
<p>
<span class="emphasis"><em>xfreq</em></span> -- frequency value or frequency multiplier, depending by <span class="emphasis"><em>iflag</em></span>. When <span class="emphasis"><em>iflag</em></span> = 0, <span class="emphasis"><em>xfreq</em></span> is a multiplier of a the default frequency, assigned by SF2 preset to the <span class="emphasis"><em>inotenum</em></span> value. When <span class="emphasis"><em>iflag</em></span> = 1, <span class="emphasis"><em>xfreq</em></span> is the absolute frequency of the output sound, in Hz. Default is 0.
</p>
<p>
When <span class="emphasis"><em>iflag</em></span> = 0, <span class="emphasis"><em>inotenum</em></span> sets the frequency of the output according to the MIDI note number used, and <span class="emphasis"><em>xfreq</em></span> is used as a multiplier. When <span class="emphasis"><em>iflag</em></span> = 1, the frequency of the output, is set directly by <span class="emphasis"><em>xfreq</em></span>. This allows the user to use any kind of micro-tuning based scales. However, this method is designed to work correctly only with presets tuned to the default equal temperament. Attempts to use this method with a preset already having non-standard tunings, or with drum-kit-based presets, could give unexpected results.
</p>
<p>
Adjustment of the amplitude can be done by varying the <span class="emphasis"><em>xamp</em></span> argument, which acts as
a multiplier.
</p>
<p>
The <span class="emphasis"><em>ioffset</em></span> parameter allows the sound to start from a sample different than the first one. The user should make sure that its value is within the length of the specific sound. Otherwise, Csound will probably crash.
</p>
<p>
<span class="emphasis"><em>sfinstr</em></span> plays an SF2 instrument instead of a preset (an SF2 instrument is the base of a preset layer). <span class="emphasis"><em>instrnum</em></span> specifies the instrument number, and the user must be sure that the specified number belongs to an existing instrument of a determinate soundfont bank. Notice that both <span class="emphasis"><em>xamp</em></span> and <span class="emphasis"><em>xfreq</em></span> can operate at k-rate as well as a-rate, but both arguments must work at the same rate.
</p>
<p>
These opcodes only support the sample structure of SF2 files. The modulator structure of the SoundFont2 format is not supported in Csound. Any modulation or processing to the sample data is left to the Csound user, bypassing all restrictions forced by the SF2 standard.
</p>
</div>
<div class="refsect1" title="Examples">
<a id="idp42489584"></a>
<h2>Examples</h2>
<p>
Here is an example of the sfinstr opcode. It uses the file <a class="ulink" href="examples/sfinstr.csd" target="_top"><em class="citetitle">sfinstr.csd</em></a>.
</p>
<div class="example">
<a id="idp42490560"></a>
<p class="title">
<strong>Example 764. Example of the sfinstr opcode.</strong>
</p>
<div class="example-contents">
<p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
<pre class="programlisting">
<span class="csdtag"><CsoundSynthesizer></span>
<span class="csdtag"><CsOptions></span>
<span class="comment">; Select audio/midi flags here according to platform</span>
-odac -+rtmidi=virtual -M0 <span class="comment">;;;realtime audio out</span>
<span class="comment">;-iadc ;;;uncomment -iadc if realtime audio input is needed too</span>
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">; -o sfinstr.wav -W ;;; for file output any platform</span>
<span class="csdtag"></CsOptions></span>
<span class="csdtag"><CsInstruments></span>
<span class="ohdr">sr</span> <span class="op">=</span> 44100
<span class="ohdr">ksmps</span> <span class="op">=</span> 32
<span class="ohdr">nchnls</span> <span class="op">=</span> 2
<span class="ohdr">0dbfs</span> <span class="op">=</span> 1
gisf <span class="opc">sfload</span> "sf_GMbank.sf2"
<span class="opc">sfilist</span> isf
<span class="oblock">instr</span> 1 <span class="comment">; play from score and midi keyboard</span>
<span class="opc">mididefault</span> 60, p3
<span class="opc">midinoteonkey</span> p4, p5
inum <span class="opc">init</span> p4
ivel <span class="opc">init</span> p5
ivel <span class="opc">init</span> ivel<span class="op">/</span>127 <span class="comment">;make velocity dependent</span>
kamp <span class="opc">linsegr</span> 1, 1, 1, .1, 0
kamp <span class="op">=</span> kamp<span class="op">/</span>5000 <span class="comment">;scale amplitude</span>
kfreq <span class="opc">init</span> 1 <span class="comment">;do not change freq from sf</span>
a1,a2 <span class="opc">sfinstr</span> ivel, inum, kamp<span class="op">*</span>ivel, kfreq, 194, gisf <span class="comment">;= Strings 2 tighter</span>
<span class="opc">outs</span> a1, a2
<span class="oblock">endin</span>
<span class="csdtag"></CsInstruments></span>
<span class="csdtag"><CsScore></span>
<span class="stamnt">f</span>0 60 <span class="comment">; stay active for 1 minute</span>
<span class="stamnt">i</span>1 0 1 60 127
<span class="stamnt">i</span>1 + 1 62 <
<span class="stamnt">i</span>1 + 1 65 <
<span class="stamnt">i</span>1 + 1 69 10
<span class="stamnt">e</span>
<span class="csdtag"></CsScore></span>
<span class="csdtag"></CsoundSynthesizer></span>
</pre>
</div>
</div>
<p><br class="example-break" />
</p>
</div>
<div class="refsect1" title="See Also">
<a id="idp42492840"></a>
<h2>See Also</h2>
<p>
<a class="link" href="sfilist.html" title="sfilist"><em class="citetitle">sfilist</em></a>,
<a class="link" href="sfinstrm.html" title="sfinstrm"><em class="citetitle">sfinstrm</em></a>,
<a class="link" href="sfload.html" title="sfload"><em class="citetitle">sfload</em></a>,
<a class="link" href="sfpassign.html" title="sfpassign"><em class="citetitle">sfpassign</em></a>,
<a class="link" href="sfplay.html" title="sfplay"><em class="citetitle">sfplay</em></a>,
<a class="link" href="sfplaym.html" title="sfplaym"><em class="citetitle">sfplaym</em></a>,
<a class="link" href="sfplist.html" title="sfplist"><em class="citetitle">sfplist</em></a>,
<a class="link" href="sfpreset.html" title="sfpreset"><em class="citetitle">sfpreset</em></a>
</p>
</div>
<div class="refsect1" title="Credits">
<a id="idp42497216"></a>
<h2>Credits</h2>
<p>
</p>
<table border="0" summary="Simple list" class="simplelist">
<tr>
<td>Author: Gabriel Maldonado</td>
</tr>
<tr>
<td>Italy</td>
</tr>
<tr>
<td>May 2000</td>
</tr>
</table>
<p>
</p>
<p>New in Csound Version 4.07</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="sfinstr3m.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="OpcodesTop.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="sfinstrm.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">sfinstr3m </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> sfinstrm</td>
</tr>
</table>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
b707d9a4ee443103660a75ccb6e51334
>
files
>
2573
