<?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>gain</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="ftsr.html" title="ftsr" />
<link rel="next" href="gainslider.html" title="gainslider" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">gain</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="ftsr.html">Prev</a> </td>
<th width="60%" align="center">Orchestra Opcodes and Operators</th>
<td width="20%" align="right"> <a accesskey="n" href="gainslider.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="refentry" title="gain">
<a id="gain"></a>
<div class="titlepage"></div>
<a id="IndexGain" class="indexterm"></a>
<div class="refnamediv">
<h2>
<span class="refentrytitle">gain</span>
</h2>
<p>gain —
Adjusts the amplitude audio signal according to a root-mean-square value.
</p>
</div>
<div class="refsect1" title="Description">
<a id="idp24932856"></a>
<h2>Description</h2>
<p>
Adjusts the amplitude audio signal according to a root-mean-square value.
</p>
</div>
<div class="refsect1" title="Syntax">
<a id="idp24933544"></a>
<h2>Syntax</h2>
<pre class="synopsis">ares <span class="command"><strong>gain</strong></span> asig, krms [, ihp] [, iskip]</pre>
</div>
<div class="refsect1" title="Initialization">
<a id="idp24941736"></a>
<h2>Initialization</h2>
<p>
<span class="emphasis"><em>ihp</em></span> (optional, default=10) -- half-power point (in Hz) of a special internal low-pass filter. The default value is 10.
</p>
<p>
<span class="emphasis"><em>iskip</em></span> (optional, default=0) -- initial disposition of internal data space (see <a class="link" href="reson.html" title="reson"><em class="citetitle">reson</em></a>). The default value is 0.
</p>
</div>
<div class="refsect1" title="Performance">
<a id="idp24943640"></a>
<h2>Performance</h2>
<p>
<span class="emphasis"><em>asig</em></span> -- input audio signal
</p>
<p>
<span class="emphasis"><em>gain</em></span> provides an amplitude modification of <span class="emphasis"><em>asig</em></span> so that the output <span class="emphasis"><em>ares</em></span> has rms power equal to <span class="emphasis"><em>krms</em></span>. <a class="link" href="rms.html" title="rms"><em class="citetitle">rms</em></a> and <span class="emphasis"><em>gain</em></span> used together (and given matching <span class="emphasis"><em>ihp</em></span> values) will provide the same effect as <a class="link" href="balance.html" title="balance"><em class="citetitle">balance</em></a>.
</p>
</div>
<div class="refsect1" title="Examples">
<a id="idp24946928"></a>
<h2>Examples</h2>
<p>
Here is an example of the gain opcode. It uses the file <a class="ulink" href="examples/gain.csd" target="_top"><em class="citetitle">gain.csd</em></a>.
</p>
<div class="example">
<a id="idp24947896"></a>
<p class="title">
<strong>Example 314. Example of the gain 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 <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 gain.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
<span class="oblock">instr</span> 1
asrc <span class="opc">buzz</span> .8, 440, <span class="ohdr">sr</span><span class="op">/</span>440, 1 <span class="comment">; band-limited pulse train.</span>
a1 <span class="opc">reson</span> asrc, 1000, 100 <span class="comment">; Sent through</span>
a2 <span class="opc">reson</span> a1, 3000, 500 <span class="comment">; 2 filters</span>
krms <span class="opc">rms</span> asrc <span class="comment">; then balanced</span>
afin <span class="opc">gain</span> a2, krms <span class="comment">; with source</span>
<span class="opc">outs</span> afin, afin
<span class="oblock">endin</span>
<span class="csdtag"></CsInstruments></span>
<span class="csdtag"><CsScore></span>
<span class="comment">;sine wave.</span>
<span class="stamnt">f</span> 1 0 16384 10 1
<span class="stamnt">i</span> 1 0 2
<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="idp25003232"></a>
<h2>See Also</h2>
<p>
<a class="link" href="balance.html" title="balance"><em class="citetitle">balance</em></a>,
<a class="link" href="rms.html" title="rms"><em class="citetitle">rms</em></a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="ftsr.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="gainslider.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">ftsr </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> gainslider</td>
</tr>
</table>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
b707d9a4ee443103660a75ccb6e51334
>
files
>
1764
