<?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>octave</title> <link rel="stylesheet" href="csound.css" type="text/css" /> <meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /> <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="ntrpol.html" title="ntrpol" /> <link rel="next" href="octcps.html" title="octcps" /> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">octave</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="ntrpol.html">Prev</a> </td> <th width="60%" align="center">Orchestra Opcodes and Operators</th> <td width="20%" align="right"> <a accesskey="n" href="octcps.html">Next</a></td> </tr> </table> <hr /> </div> <div class="refentry" title="octave"> <a id="octave"></a> <div class="titlepage"></div> <a id="IndexOctave" class="indexterm"></a> <div class="refnamediv"> <h2> <span class="refentrytitle">octave</span> </h2> <p>octave — Calculates a factor to raise/lower a frequency by a given amount of octaves. </p> </div> <div class="refsect1" title="Description"> <a id="id3051233"></a> <h2>Description</h2> <p> Calculates a factor to raise/lower a frequency by a given amount of octaves. </p> </div> <div class="refsect1" title="Syntax"> <a id="id3051246"></a> <h2>Syntax</h2> <pre class="synopsis"><span class="command"><strong>octave</strong></span>(x)</pre> <p> This function works at a-rate, i-rate, and k-rate. </p> </div> <div class="refsect1" title="Initialization"> <a id="id3052068"></a> <h2>Initialization</h2> <p> <span class="emphasis"><em>x</em></span> -- a value expressed in octaves. </p> </div> <div class="refsect1" title="Performance"> <a id="id3052083"></a> <h2>Performance</h2> <p> The value returned by the <span class="emphasis"><em>octave</em></span> function is a factor. You can multiply a frequency by this factor to raise/lower it by the given amount of octaves. </p> </div> <div class="refsect1" title="Examples"> <a id="id3052102"></a> <h2>Examples</h2> <p> Here is an example of the octave opcode. It uses the file <a class="ulink" href="examples/octave.csd" target="_top"><em class="citetitle">octave.csd</em></a>. </p> <div class="example"> <a id="id3052118"></a> <p class="title"> <b>Example 394. Example of the octave opcode.</b> </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> <span class="comment">; Audio out Audio in</span> -odac -iadc <span class="comment">;;;RT audio I/O</span> <span class="comment">; For Non-realtime ouput leave only the line below:</span> <span class="comment">; -o octave.wav -W ;;; for file output any platform</span> <span class="csdtag"></CsOptions></span> <span class="csdtag"><CsInstruments></span> <span class="comment">; Initialize the global variables.</span> <span class="ohdr">sr</span> <span class="op">=</span> 44100 <span class="ohdr">kr</span> <span class="op">=</span> 4410 <span class="ohdr">ksmps</span> <span class="op">=</span> 10 <span class="ohdr">nchnls</span> <span class="op">=</span> 1 <span class="comment">; Instrument #1.</span> <span class="oblock">instr</span> 1 <span class="comment">; The root note is A above middle-C (440 Hz)</span> iroot <span class="op">=</span> 440 <span class="comment">; Raise the root note by two octaves.</span> ioctaves <span class="op">=</span> 2 <span class="comment">; Calculate the new note.</span> ifactor <span class="op">=</span> <span class="opc">octave</span>(ioctaves) inew <span class="op">=</span> iroot <span class="op">*</span> ifactor <span class="comment">; Print out of all of the values.</span> <span class="opc">print</span> iroot <span class="opc">print</span> ifactor <span class="opc">print</span> inew <span class="oblock">endin</span> <span class="csdtag"></CsInstruments></span> <span class="csdtag"><CsScore></span> <span class="comment">; Play Instrument #1 for one second.</span> <span class="stamnt">i</span> 1 0 1 <span class="stamnt">e</span> <span class="csdtag"></CsScore></span> <span class="csdtag"></CsoundSynthesizer></span> </pre> </div> </div> <p><br class="example-break" /> Its output should include lines like: </p> <pre class="screen"> instr 1: iroot = 440.000 instr 1: ifactor = 4.000 instr 1: inew = 1760.149</pre> <p> </p> </div> <div class="refsect1" title="See Also"> <a id="id3052165"></a> <h2>See Also</h2> <p> <a class="link" href="cent.html" title="cent"><em class="citetitle">cent</em></a>, <a class="link" href="db.html" title="db"><em class="citetitle">db</em></a>, <a class="link" href="semitone.html" title="semitone"><em class="citetitle">semitone</em></a> </p> </div> <div class="refsect1" title="Credits"> <a id="id3052198"></a> <h2>Credits</h2> <p>Example written by Kevin Conder.</p> <p>New in version 4.16</p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="ntrpol.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="octcps.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">ntrpol </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> octcps</td> </tr> </table> </div> </body> </html>