summaryrefslogtreecommitdiff
path: root/preface
diff options
context:
space:
mode:
authorFelipe Sateler <fsateler@debian.org>2011-07-26 23:02:40 -0400
committerFelipe Sateler <fsateler@debian.org>2011-07-26 23:02:40 -0400
commit3a91171181113761a14bcc36a086a8dda144b77b (patch)
tree7affbde923b0131e3e954519a8afb24cd408982d /preface
parente99de1fa9e7b72351523a958cb2a13557884f0a4 (diff)
Imported Upstream version 5.13~dfsg
Diffstat (limited to 'preface')
-rw-r--r--preface/gettingstarted.xml34
-rw-r--r--preface/history.xml7
-rw-r--r--preface/whatsnew.xml189
3 files changed, 203 insertions, 27 deletions
diff --git a/preface/gettingstarted.xml b/preface/gettingstarted.xml
index 272f485..6f08a6c 100644
--- a/preface/gettingstarted.xml
+++ b/preface/gettingstarted.xml
@@ -2,73 +2,73 @@
<title>Getting Started with Csound</title>
<bridgehead>Downloading</bridgehead>
<para>
- In case you don't already have Csound (or have an older version) download the appropriate Csound version for your platform from the <ulink url="http://sourceforge.net/project/showfiles.php?group_id=81968&amp;package_id=120482"><citetitle>Sourceforge Csound5 Download Page</citetitle></ulink>. Installers for Windows have '.exe' extension and for Mac '.dmg' or '.tar.gz'. If the installer's filename ends in '-d' it means the installer has been built with <emphasis>double</emphasis> precision (64-bit) which provides higher quality output than the ordinary <emphasis>float</emphasis> precision (32-bit), which provides quicker output. You can also download the sources and build them, but this requires more expertise (See the section <link linkend="BuildingCsound"><citetitle>Building Csound</citetitle></link>).
+ In case you don't already have Csound (or have an older version) download the appropriate Csound version for your platform from the <ulink url="http://sourceforge.net/projects/csound/files/"><citetitle>Sourceforge Csound Download Page</citetitle></ulink>. Installers for Windows have '.exe' extension and for Mac '.dmg'. If the installer's filename ends in '-d' it means the installer has been built with <emphasis>double</emphasis> precision (64-bit) which provides higher quality output than the ordinary <emphasis>float</emphasis> precision (32-bit). The float versions provide quicker output, which may be important if you're using Csound in a real-time setting. You can also download the sources and build them, but this requires more expertise (See the section <link linkend="BuildingCsound"><citetitle>Building Csound</citetitle></link>).
</para>
<para>
- It's also useful to download the most recent version of this manual, which you will also find there.
+ It may also be useful to download the most recent version of this manual, which you will also find there.
</para>
<bridgehead>Running</bridgehead>
<para>
- Csound can be run in different ways. Since Csound is a command line program (DOS in Windows terms), just clicking on the csound executable will have no effect. Csound must be called either from a terminal (or DOS prompt), or from a front-end. To use Csound from the command line, you must open a <emphasis>Terminal</emphasis> (Command Prompt or DOS Prompt on Windows). Using Csound from the command line can be difficult if you've never used the terminal, so you may want to try to use one of the front-ends included with your distribution. A <link linkend="OviewFrontEnds"><citetitle>front-end</citetitle></link> is a graphical program that assists running Csound and can usually help edit csound files.
+ Csound can be run in different ways. Since Csound is a command line program (DOS in Windows terms), just clicking on the csound executable will have no effect. Csound must be called either from the computer's command line or from a front end. To use Csound from the command line, you must open a <emphasis>Terminal</emphasis> (Command Prompt or DOS Prompt on Windows, or Terminal on MacOS). Using Csound from the command line can be difficult if you've never used a terminal, so you may want to try to use one of the front ends, either QuteCsound, which is included with the latest distributions, or another front end. A <link linkend="OviewFrontEnds"><citetitle>front end</citetitle></link> is a window-based (not necessarily Windows-based) program that assists running Csound. Most front ends include text editors with which you can edit csound files, and many include other useful features.
</para>
<para>
- Both in the case of front-ends as well as execution from the command line, Csound needs two things:
+ Whether being run from a front end or being executed from the command line, Csound needs two things:
<itemizedlist>
<listitem>
<simpara>A Csound file ('.csd' or possibly an '.orc' and a '.sco' file)</simpara>
</listitem>
<listitem>
- <simpara>A list of command line flags (or configuration options) that configure execution. They determine things like output filename and format, whether real-time audio and MIDI are enabled, which soundcard to use, the buffer size, the amount of messages printed, etc. These options can be included in the '.csd' file itself, so for the examples included in this manual <emphasis>you shouldn't need to worry about them</emphasis>. The complete and very long list of available command flags can be found <link linkend="CommandFlags"><citetitle>here</citetitle></link>, but you might want to have a look there later...</simpara>
+ <simpara>A list of command line flags (or configuration options) that configure execution. They determine things like output filename and format, whether real-time audio and MIDI are enabled, which audio output to use for real-time audio, the buffer size, the types of messages printed, etc. These options can be included in the '.csd' file itself, so for the examples included in this manual <emphasis>you shouldn't need to worry about them</emphasis>. Front end programs often have dialog boxes in which the command line flags can be set. The complete and very long list of available command flags can be found <link linkend="CommandFlags"><citetitle>here</citetitle></link>, but you might want to have a look there later...</simpara>
</listitem>
</itemizedlist>
See the section <link linkend="Configuring"><citetitle>Configuring</citetitle></link> if Csound is giving you trouble.
</para>
<para>
- This documentation includes many '.csd' files which you can try out, and which should work directly from the command line or from any frontend. A simple example is <ulink url="examples/oscil.csd"><citetitle>oscil.csd</citetitle></ulink> that can be found in the <emphasis>examples</emphasis> folder of this documentation. Your front-end should allow you to choose the file, and it should have a 'play' or 'render' button.
+ This documentation includes many '.csd' files which you can try out, and which should work directly from the command line or from any front end. A simple example is <ulink url="examples/oscil.csd"><citetitle>oscil.csd</citetitle></ulink>, which can be found in the <emphasis>examples</emphasis> folder of this documentation. Your front end should allow you to load the file, and the front end should have a 'play' or 'render' button that will allow you to hear the file. If you want to experiment with the file, you're well advised to use the front end's 'Save As..." command to copy it to some other directory on your hard drive, such as a 'csound scores' directory that you create.
</para>
<note>
<title>Note for MacCsound users</title>
<simpara>You might need to remove all the lines from the command options slot in order for the manual examples to work.</simpara>
</note>
<para>
- You can also try the manual examples from the command line by navigating to the examples directory of the manual using something like this on Windows (assuming the manual is located at c:\Program Files\Csound\manual\):
+ You can also try the manual examples from the command line. To do this, navigate to the examples directory of the manual using something like this on Windows (assuming the manual is located at c:\Program Files\Csound\manual\):
<screen>
-cd "c:\Program Files\Csound\manual\examples"</screen>
+cd "c:\Program Files\Csound\doc\manual\examples"</screen>
or something like:
<screen>
cd /manualdirectory/manual/examples</screen>
- for the Mac or linux terminals and then typing:
+ for the Mac or linux Terminal. Then type:
<screen>
csound oscil.csd</screen>
</para>
<para>
- The example files are configured to run in realtime by default, so you should have heard a 2 second sine wave.
+ The example files are configured to run in real time by default, so with this command you should hear a two-second sine wave.
</para>
<bridgehead>Writing your own .csd files</bridgehead>
<para>A <emphasis>.csd</emphasis> file looks like this (this file is <ulink url="examples/oscils.csd"><citetitle>oscils.csd</citetitle></ulink>):</para>
<xi:include href="examples-xml/oscils.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<para>
- Csound's <link linkend="CommandUnifile"><citetitle>.csd</citetitle></link> files have 3 main sections between the <emphasis>&lt;CsSynthesizer&gt;</emphasis> and <emphasis>&lt;/CsSynthesizer&gt;</emphasis> tags:
+ Csound's <link linkend="CommandUnifile"><citetitle>.csd</citetitle></link> files have three main sections between the <emphasis>&lt;CsSynthesizer&gt;</emphasis> and <emphasis>&lt;/CsSynthesizer&gt;</emphasis> tags:
<itemizedlist>
<listitem>
- <simpara><emphasis>CsOptions</emphasis> - Includes the <link linkend="CommandFlagsCategory"><citetitle>Command Line flags</citetitle></link> specific to this particular file. These options can also be set using the <link linkend="CommandUnifileParFile"><citetitle>.csoundrc</citetitle></link> file or directly in the <link linkend="CommandDesc"><citetitle>command line</citetitle></link>. Some frontends also provide ways to specify global or local options.
+ <simpara><emphasis>CsOptions</emphasis> - Includes the <link linkend="CommandFlagsCategory"><citetitle>Command Line flags</citetitle></link> specific to this particular file. These options can also be set using the <link linkend="CommandUnifileParFile"><citetitle>.csoundrc</citetitle></link> file, which you can edit in a text editor, or directly in the <link linkend="CommandDesc"><citetitle>command line</citetitle></link>. Some front ends also provide ways to specify global or local options.
</simpara>
</listitem>
<listitem>
<simpara>
- <emphasis>CsInstruments</emphasis> - Contains the instruments or processes available in the file. Instruments are defined using the <link linkend="instr"><citetitle>instr</citetitle></link> and <link linkend="endin"><citetitle>endin</citetitle></link> opcodes. The <emphasis>CsInstruments</emphasis> section also contains the <link linkend="OrchHeader"><citetitle>Orchestra Header</citetitle></link> which defines things like <link linkend="sr"><citetitle>sample rate</citetitle></link>, the <link linkend="ksmps"><citetitle>number of samples in a control period</citetitle></link> and the <link linkend="nchnls"><citetitle>number of output channels</citetitle></link>.
+ <emphasis>CsInstruments</emphasis> - Contains the instruments or processes available in the file. Instruments are defined using the <link linkend="instr"><citetitle>instr</citetitle></link> and <link linkend="endin"><citetitle>endin</citetitle></link> opcodes. The <emphasis>CsInstruments</emphasis> section also contains the <link linkend="OrchHeader"><citetitle>Orchestra Header</citetitle></link>, which defines things like <link linkend="sr"><citetitle>sample rate</citetitle></link>, the <link linkend="ksmps"><citetitle>number of samples in a control period</citetitle></link>, and the <link linkend="nchnls"><citetitle>number of output channels</citetitle></link>.
</simpara>
</listitem>
<listitem>
<simpara>
- <emphasis>CsScore</emphasis> - Contains the 'notes' to be played optionally the definition of f-tables. Notes are created using the <link linkend="i"><citetitle>i statement</citetitle></link>, and f-tables are created using the <link linkend="f"><citetitle>f statement</citetitle></link>. There are several other <link linkend="ScoreStatements"><citetitle>score statements</citetitle></link> available.
+ <emphasis>CsScore</emphasis> - Contains the 'notes' to be played, and optionally the definition of f-tables. Notes are created using the <link linkend="i"><citetitle>i statement</citetitle></link>, and f-tables are created using the <link linkend="f"><citetitle>f statement</citetitle></link>. Several other <link linkend="ScoreStatements"><citetitle>score statements</citetitle></link> are available.
</simpara>
</listitem>
</itemizedlist>
- Note that anything after a semicolon (;) until the end of the line is a comment, and is ignored by csound.
+ Anything after a semicolon (;) until the end of the line is a comment, and is ignored by Csound.
</para>
<para>
- You can write csd files in any plain text editor like notepad or textedit. Just be sure to save the file as plain text (not rich text). Many <link linkend="OviewFrontEnds"><citetitle>frontends</citetitle></link> include advanced editing capabilities with syntax highlighting and completion.
+ You can write .csd files in any plain text editor, such as Notepad or Textedit. If you use a word processor (not recommended), be sure to save the file as plain text (not rich text). Many <link linkend="OviewFrontEnds"><citetitle>front ends</citetitle></link> include advanced editing capabilities, such as syntax highlighting and auto-completion of code.
</para>
- <para>You can find an in depth tutorial on getting started with Csound written by Michael Gogins <ulink url="http://csound.sourceforge.net/tutorial.pdf">here</ulink>.</para>
+ <para>You can find an in-depth tutorial on getting started with Csound written by Michael Gogins <ulink url="http://michael-gogins.com/archives/tutorial.pdf">here</ulink>.</para>
</section>
diff --git a/preface/history.xml b/preface/history.xml
index ede2901..66d8ecb 100644
--- a/preface/history.xml
+++ b/preface/history.xml
@@ -68,6 +68,13 @@
<row><entry>Robin Whittle </entry></row>
<row><entry>&namesteven;</entry></row>
<row><entry>&namepinot;</entry></row>
+ <row><entry>&nameandres;</entry></row>
+ <row><entry>Gareth Edwards</entry></row>
+ <row><entry>Joachim Heinz</entry></row>
+ <row><entry>&namejohn;</entry></row>
+ <row><entry>Oeyvind Brandstegg</entry></row>
+ <row><entry>Felipe Sateler</entry></row>
+ <row><entry>And many others.</entry></row>
</tbody>
</tgroup>
</table>
diff --git a/preface/whatsnew.xml b/preface/whatsnew.xml
index 6445ccd..6e0e543 100644
--- a/preface/whatsnew.xml
+++ b/preface/whatsnew.xml
@@ -64,6 +64,173 @@
</listitem>
</itemizedlist>
</para>-->
+<bridgehead>New in Version 5.13 (January 2011)</bridgehead>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>New opcodes:
+ <itemizedlist>
+ <listitem>
+ <simpara><link linkend="median"><citetitle>median</citetitle></link> opcode.</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="filevalid"><citetitle>filevalid</citetitle></link> opcode.</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="pvstanal"><citetitle>pvstanal</citetitle></link>, <link linkend="pvswarp"><citetitle>pvswarp</citetitle></link>, <link linkend="temposcal"><citetitle>temposcal</citetitle></link>, <link linkend="pvslock"><citetitle>pvslock</citetitle></link> spectral processing opcodes.</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="mincer"><citetitle>mincer</citetitle></link> opcode</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="fareylen"><citetitle>fareylen</citetitle></link> sequence opcodes.</simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ New functionality
+ <itemizedlist>
+ <listitem>
+ <simpara>Real random number generators using /dev/random (Linux only).
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>INF macro added to orchestras; z read as infinity in scores</simpara>
+ </listitem>
+ <listitem>
+ <simpara>init changed to allow multiple inits in on statement</simpara>
+ </listitem>
+ <listitem>
+ <simpara>GEN for support of farey sequences</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="maxalloc"><citetitle>maxalloc</citetitle></link>,<link linkend="cpuprc"><citetitle>cpuprc</citetitle></link>, <link linkend="active"><citetitle>active</citetitle></link> now accept named instruments.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>If normalisation in pow opcodes is zero treat as 1</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="inch"><citetitle>inch</citetitle></link> can take upto 20 inputs and outputs.</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="pvscale"><citetitle>pvscale</citetitle></link>, <link linkend="pvsvoc"><citetitle>pvsvoc</citetitle></link> and <link linkend="pvsmix"><citetitle>pvsmix</citetitle></link> now have very good spectral envelope preservation modes (1 = filtered cepstrum, 2 = true envelope).</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="oscil1"><citetitle>oscil1</citetitle></link> could be static if the duration was long; now there is a
+ positive minimum increment.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>GEN49 now uses search paths.</simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Bug fixes and improvements:
+ <itemizedlist>
+ <listitem>
+ <simpara>Count of lines fixed in orchestras, and \ inside strings
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>Fast tab opcodes made safe from crashes</simpara>
+ </listitem>
+ <listitem>
+ <simpara>% in formated printing could crash</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Double free in fgen fixed</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="sndwarp"><citetitle>sndwarp</citetitle></link> quietened (gave too many messages)</simpara>
+ </listitem>
+ <listitem>
+ <simpara>gen41 deals with positive probabilities</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="adsynt"><citetitle>adsynt</citetitle></link> reworked removing many bugs</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="adsynt2"><citetitle>adsynt2</citetitle></link> phase error fixed</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Bug in max number of gens fixed</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Better checking in grain4</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Better checking in <link linkend="adsyn"><citetitle>adsyn</citetitle></link></simpara>
+ </listitem>
+ <listitem>
+ <simpara>modulus was wrong in new parser</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="atonex"><citetitle>atonex</citetitle></link>/<link linkend="tonex"><citetitle>tonex</citetitle></link> did wrong operation</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="mp3in"><citetitle>mp3in</citetitle></link> could repeat sound at end of file</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="changed"><citetitle>changed</citetitle></link> opcode initialised to zero</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Serious bug in <link linkend="tabmorpha"><citetitle>tabmorpha</citetitle></link> fixed</simpara>
+ </listitem>
+ <listitem>
+ <simpara>GEN49 has serious bug removed, so no longer incorrect silences.</simpara>
+ </listitem>
+ <listitem>
+ <simpara><link linkend="partikkel"><citetitle>partikkel</citetitle></link> opcode: fixed bug in sub-sample grain placement when
+ using grain rate FM</simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Internal Changes:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ In the new parser only there are operator @ and @@ to round up the
+ next integer to a power of 2 or powerof2+1
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>Score sorting made much faster</simpara>
+ </listitem>
+ <listitem>
+ <simpara>lineto improved</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Named gens allowed</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Various printing include instrument name if available</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Command option to omit loading a library</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Number of out channels no longer constrained to be number of in</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Many fixes to new parser</simpara>
+ </listitem>
+ <listitem>
+ <simpara>More use of Warnings than Messages (allows for them to be switched off)</simpara>
+ </listitem>
+ <listitem>
+ <simpara>csoundSetMessageCallback reset if callback set to null</simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
<bridgehead>New in Version 5.12 (January 2010)</bridgehead>
<para>
<itemizedlist>
@@ -90,13 +257,6 @@
</simpara>
</listitem>
<listitem>
- <simpara>
- The new <link linkend="SignalFlowGraphOpcodes"><citetitle>Signal
- Flow opcodes </citetitle></link> enable the usage of
- signal flow graphs in Csound.
- </simpara>
- </listitem>
- <listitem>
<simpara><link linkend="passign"><citetitle>passign</citetitle></link>
allows quick initialization of i-rate variables from p-fields</simpara>
</listitem>
@@ -243,6 +403,13 @@
<listitem>
<simpara><link linkend="filebit"><citetitle>filebit</citetitle></link> reports the file depth of a file.</simpara>
</listitem>
+ <listitem>
+ <simpara>
+ The new <link linkend="SignalFlowGraphOpcodes"><citetitle>Signal
+ Flow opcodes </citetitle></link> enable the usage of
+ signal flow graphs in Csound.
+ </simpara>
+ </listitem>
</itemizedlist>
</para>
</listitem>
@@ -508,7 +675,7 @@
<listitem>
<simpara>New ambisonic opcodes: <link linkend="bformdec1"><citetitle>bformdec1</citetitle></link> and <link linkend="bformenc1"><citetitle>bformenc1</citetitle></link>. These opcodes deprecate the older <link linkend="bformdec"><citetitle>bformdec</citetitle></link> and <link linkend="bformenc"><citetitle>bformenc</citetitle></link>.</simpara>
</listitem>
- <listitem>New Score control opcodes by &namevictor;: <simpara><link linkend="rewindscore"><citetitle>rewindscore</citetitle></link> and <link linkend="setscorepos"><citetitle>setscorepos</citetitle></link>.</simpara>
+ <listitem><simpara>New Score control opcodes by &namevictor;: <link linkend="rewindscore"><citetitle>rewindscore</citetitle></link> and <link linkend="setscorepos"><citetitle>setscorepos</citetitle></link>.</simpara>
</listitem>
</itemizedlist>
</para>
@@ -660,8 +827,6 @@
</itemizedlist>
</para>
</listitem>
- Improvements:
-
<listitem>
<para>
New functionality
@@ -692,10 +857,14 @@
<para>Bug fixes and improvements:
<itemizedlist>
<listitem>
+ <simpara>
Changed order of outputs for <link linkend="hilbert"><citetitle>hilbert</citetitle></link>. This change breaks compatibility with previous versions, but fixes the opcode and now works as documented.
+ </simpara>
</listitem>
<listitem>
+ <simpara>
Messages about loading opcode plugins modified so can be suppressed with message level flag.
+ </simpara>
</listitem>
<listitem>
<simpara>Major changes to score error reporting; now accurately reports the line numbers for the chain of inputs for most errors.</simpara>