beast r4467 - trunk/docs/imports
- From: timj svn gnome org
- To: svn-commits-list gnome org
- Subject: beast r4467 - trunk/docs/imports
- Date: Wed, 4 Jun 2008 21:55:15 +0000 (UTC)
Author: timj
Date: Wed Jun 4 21:55:14 2008
New Revision: 4467
URL: http://svn.gnome.org/viewvc/beast?rev=4467&view=rev
Log:
docs/imports: updated docs from testbit.eu.
Modified:
trunk/docs/imports/Beast-Quickstart
trunk/docs/imports/beastdocs.css
Modified: trunk/docs/imports/Beast-Quickstart
==============================================================================
--- trunk/docs/imports/Beast-Quickstart (original)
+++ trunk/docs/imports/Beast-Quickstart Wed Jun 4 21:55:14 2008
@@ -28,102 +28,226 @@
<tr>
<td id="main-cell" valign="top">
<div id="main">
- <h1 class="title"></h1>
+ <h1 class="title">Beast Quickstart</h1>
<div class="tabs"></div>
<div class="node">
<span class="submitted"></span>
<span class="taxonomy"></span>
- <div class="content ctype-wikipage">
-<h2 id="toc1">BEAST/BSE Quick Start Guide</h2>
-<p>This guide attempts to give a few brief hints for new users, in order to get started with the most basic tasks that can be accomplished with <a class="" style="" href="http://testbit.eu/wiki/Beast";>Beast</a>.</p>
-
-
-<h3 id="toc2">First Start At Synthesis</h3>
-<p>The most basic task <a class="" style="" href="http://testbit.eu/wiki/Beast";>Beast</a> is able to accomplish is the creation of new musical sounds which is done by using a variety of music producers, called "Modules". Forming a network of multiple modules to create a new sound is most generally being refered to as "Synthesis".</p>
-
-
-<h4 id="toc3">Creating A Synthesizer Network</h4>
-<ol>
- <li> Select <tt>/Project/Add Custom Synthesizer</tt> from the menu to create a new network.</li>
- <li> In the newly created synthesizer network <em>Unnamed</em>, on the notebook page <strong>Properties</strong>, enable the <strong>Auto Activate</strong> property to enable automated playback of this network.</li>
- <li> Select the <strong>Routing</strong> notebook page.</li>
-</ol>
-
-
-<h4 id="toc4">Creating And Connecting Synthesis Modules</h4>
-<p>The synthesis network routing editor allowes for creation of synthesis modules, establishing connections between module inputs and outputs, and for adjustment of a module's parameter set.</p>
-
-<p>Here's how to setup a very simple test case: <ol>
- <li> Create two modules by selecting them from either the pallete window or from the Button-3 popup menu of the <strong>Routing</strong> notebook page and then clicking into the routing area. The two modules you need are <a href="http://testbit.eu/wiki/BSE-Modules#PcmOutput";>PcmOutput</a> and <a href="http://testbit.eu/wiki/BSE-Modules#StandardOsc";>StandardOsc</a>.</li>
- <li> Connect the <strong>Audio Out</strong> output channel of the oscillator to the input channels <strong>Left Audio In</strong> and <strong>Right Audio In</strong> of the output module.</li>
-</ol>
-
-</p>
-
-
-<h4 id="toc5">Starting And Stopping Playback</h4>
-<p>Playback of a <a class="" style="" href="http://testbit.eu/wiki/Beast";>Beast</a> project can be started or restarted by selecting the menu item <tt>/Project/Play</tt>. Similarly, playback is halted by selecting <tt>/Project/Stop</tt>.</p>
-
-
-<h3 id="toc6">Setting Up Songs</h3>
-<p>To be able to playback songs with <a class="" style="" href="http://testbit.eu/wiki/Beast";>Beast</a>, synthesis instruments have to be created which are used to playback the notes contained in the parts of a song. Songs are created through the menu by selecting <tt>/Project/New Song</tt>.</p>
-
-
-<h4 id="toc7">What Is A Synthesis Instrument?</h4>
-<p>A synthesis instrument is a special kind of synthesizer network, it has particular properties:</p>
-
-<ul>
- <li> A synthesis instrument doesn't need to have its <strong>Auto Activate</strong> property enabled. That's because the song using the instrument will take care of activating it when neccessary.</li>
- <li> A dedicated module type is used as input to the synthesis instrument so information about the note to be played can be fed into it.</li>
- <li> A dedicated module type is used as output of the synthesis instrument to jointly compose the sound output together with other synthesis instruments being used.</li>
-</ul>
-
-
-<h4 id="toc8">Creating A Synthesis Instrument</h4>
-<p>Here is how to create a simple synthesis instrument with one oscillator producing the basic tone, an envelope to control a note's volume, and an amplifier to adjust overall volume and apply the envelope to the oscillator.</p>
-
-<ol>
- <li> Select <tt>/Project/New Custom Synthesizer</tt> from the menu.</li>
- <li> Switch to the networks's <strong>Routing</strong> notebook page.</li>
- <li> Create an <a href="http://testbit.eu/wiki/BSE-Modules#InstrumentInput";>InstrumentInput</a> and an <a href="http://testbit.eu/wiki/BSE-Modules#InstrumentOutput";>InstrumentOutput</a> module.</li>
- <li> Create the three modules making up the actual instrument: a <a href="http://testbit.eu/wiki/BSE-Modules#StandardOsc";>StandardOsc</a>, a <a href="http://testbit.eu/wiki/BSE-Modules#SimpleADSR";>SimpleADSR</a> (the envelope) and an <a href="http://testbit.eu/wiki/BSE-Modules#Amplifier";>Amplifier</a>.</li>
- <li> To control the oscillating frequency, and to trigger the oscillator wave at note start, connect the output channels <strong>Frequency</strong> and <strong>Gate</strong> of the <a href="http://testbit.eu/wiki/BSE-Modules#InstrumentInput";>InstrumentInput</a> module to the input channels <strong>Freq In</strong> and <strong>Sync In</strong> of the <a href="http://testbit.eu/wiki/BSE-Modules#StandardOsc";>StandardOsc</a> module respectively.</li>
- <li> To let the <a href="http://testbit.eu/wiki/BSE-Modules#Amplifier";>Amplifier</a> shape the volume of the oscillating tone and to provide actual output, connect the output channel <strong>Audio Out</strong> of the <a href="http://testbit.eu/wiki/BSE-Modules#StandardOsc";>StandardOsc</a> to one of the <strong>Audio</strong> input channels of the <a href="http://testbit.eu/wiki/BSE-Modules#Amplifier";>Amplifier</a> and connect the <a href="http://testbit.eu/wiki/BSE-Modules#Amplifier";>Amplifier</a>'s output channel <strong>Audio Out</strong> to the two input channels <strong>Right Audio</strong> and <strong>Left Audio</strong> of the <a href="http://testbit.eu/wiki/BSE-Modules#InstrumentOutput";>InstrumentOutput</a>.</li>
- <li> It is recommended to intially reduce the <strong>Master Volume</strong> property of the <a href="http://testbit.eu/wiki/BSE-Modules#Amplifier";>Amplifier</a> to avoid overdriving the output later on. The properties of a module can be adjusted in it's property dialog which is offered by the Button-3 popup menu of each module.</li>
- <li> Connect the input channel <strong>Gate In</strong> of the <a href="http://testbit.eu/wiki/BSE-Modules#SimpleADSR";>SimpleADSR</a> to the output channel <strong>Gate</strong> of the <a href="http://testbit.eu/wiki/BSE-Modules#InstrumentInput";>InstrumentInput</a> to trigger the envelope at note start. Connect the <strong>Ctrl Out</strong> output channel of the <a href="http://testbit.eu/wiki/BSE-Modules#SimpleADSR";>SimpleADSR</a> to one of the <strong>Control</strong> input channels of the <a href="http://testbit.eu/wiki/BSE-Modules#Amplifier";>Amplifier</a>.</li>
- <li> <strong>'IMPORTANT:'</strong> Synthesis instruments are used to play multiple notes sequentially. In order to determine when an instrument has finished playing a certain note and is thusly free to play a new note, the <strong>Synth Done</strong> channel of the <a href="http://testbit.eu/wiki/BSE-Modules#InstrumentOutput";>InstrumentOutput</a> must be connected to a signal going high at note end. For this example, connect the <strong>Synth Done</strong> channel to the <strong>Done Out</strong> output channel of the <a href="http://testbit.eu/wiki/BSE-Modules#SimpleADSR";>SimpleADSR</a> module, this output channel produces a signal which is low while the envelope is active and goes high past the envelope end.</li>
-</ol>
-
-<p>While the synthesis instrument is ready for use now, it can't be used or tested directly, but has to be deployed in a song or <a href="http://testbit.eu/wiki/BSE-Modules#MidiSynth";>MidiSynth</a> (offered by the main menu under <tt>/Project/New MIDI Synthesizer</tt>) which leads us to the next Topic.</p>
-
-
-<h4 id="toc9">Setting Up Parts And Tracks</h4>
-<p>Songs basically consist of notes kept in "Parts" which are arranged in "Tracks". The tracks control the order in which parts are played and what instrument is used to play a certain part. So the steps to a simple test setup for a synthesis instrument are:</p>
-
-<ol>
- <li> Switch to the <strong>Tracks</strong> notebook page of a song and add a track to the song.</li>
- <li> Click into the track's tact area to create a new part within it.</li>
- <li> Click onto the newly created part to start up a piano roll editor to arrange notes within parts.</li>
- <li> Use the piano roll editor to create some notes in the part to be played back.</li>
- <li> Select a synthesis network (created as shown in the last section) as synthesis input for this track by editing the <strong>Synth</strong> property.</li>
-</ol>
-
-<p>A song with parts, instruments and tracks setup can be played back via the main menu by selecting the menu item <tt>/Project/Play</tt>.</p>
-
-
-<h4 id="toc10">Postprocessing tracks and songs</h4>
-<p>The sound generated by the tracks of a song and the song itself can be postprocessed by synthesis networks to add effects and adjust the sound to your needs. Postprocessing networks are created as follows:</p>
-
-<ol>
- <li> Select <tt>/Project/New Custom Synthesizer</tt> from the menu to create a new network.</li>
- <li> Add a virtual input and output, i.e. a <a href="http://testbit.eu/wiki/BSE-Modules#BseSubIPort";>BseSubIPort</a> and a <a href="http://testbit.eu/wiki/BSE-Modules#BseSubOPort";>BseSubOPort</a> module, to the network.</li>
- <li> Connect the first two input and output channels between the two modules, these carry the left and right channel sound of a track respectively, so the sound signals may pass through the postprocessing network.</li>
- <li> Alternatively, rather than simply connecting the inputs to the outputs, you may use an effect such as the free reverb module <a href="http://testbit.eu/wiki/BSE-Modules#BseFreeVerb";>BseFreeVerb</a> inbetween the input and output connections.</li>
-</ol>
-
-<p>To postprocess the sound of a single track in a song, select the synthesis network as postprocessing network for the track by editing the tracks "Post" property. To apply the network to a song, select it as postprocessing network for the song by editing the songs "Custom Postprocess Net" property.</p>
-
-</div>
+ <div class="content ctype-wikipage"> <!--- paragraph break -->
+ <h2>
+ BEAST/BSE Quickstart Guide
+ </h2>
+ <!--- paragraph break -->
+ <p align="left">
+This guide attempts to give a few brief hints for new users,
+in order to get started with the most basic tasks that can be
+accomplished with <a href="http://testbit.eu/wiki/Beast";>Beast</a>.
+ </p>
+ <!--- paragraph break -->
+ <h3>
+ First Start At Synthesis
+ </h3>
+ <!--- paragraph break -->
+ <p align="left">
+The most basic task <a href="http://testbit.eu/wiki/Beast";>Beast</a> is able to accomplish is the creation
+of new musical sounds which is done by using a variety of music
+producers, called "Modules". Forming a network of multiple modules
+to create a new sound is most generally being refered to
+as "Synthesis".
+ </p>
+ <!--- paragraph break -->
+ <h4>
+ Creating A Synthesizer Network
+ </h4>
+ <!--- paragraph break -->
+ <ol>
+ <li>
+Select <code>/Project/Add Custom Synthesizer</code> from the menu to create a new network.
+ </li>
+ <li>
+In the newly created synthesizer network <em>Unnamed</em>, on the notebook page <strong>Properties</strong>, enable the <strong>Auto Activate</strong> property to enable automated playback of this network.
+ </li>
+ <li>
+Select the <strong>Routing</strong> notebook page.
+ </li>
+ </ol>
+ <!--- paragraph break -->
+ <h4>
+ Creating And Connecting Synthesis Modules
+ </h4>
+ <!--- paragraph break -->
+ <p align="left">
+The synthesis network routing editor allowes for creation of
+synthesis modules, establishing connections between module
+inputs and outputs, and for adjustment of a module's parameter set.
+ </p>
+ <!--- paragraph break -->
+ <p align="left">
+Here's how to setup a very simple test case:
+ </p>
+ <ol>
+ <li>
+Create two modules by selecting them from either the pallete window or from the Button-3 popup menu of the <strong>Routing</strong> notebook page and then clicking into the routing area. The two modules you need are <a href="http://testbit.eu/wiki/PcmOutput";>PcmOutput</a> and <a href="http://testbit.eu/wiki/StandardOsc";>StandardOsc</a>.
+ </li>
+ <li>
+Connect the <strong>Audio Out</strong> output channel of the oscillator to the input channels <strong>Left Audio In</strong> and <strong>Right Audio In</strong> of the output module.
+ </li>
+ </ol>
+ <!--- paragraph break -->
+ <h4>
+ Starting And Stopping Playback
+ </h4>
+ <!--- paragraph break -->
+ <p align="left">
+Playback of a <a href="http://testbit.eu/wiki/Beast";>Beast</a> project can be started or
+restarted by selecting the menu item <code>/Project/Play</code>.
+Similarly, playback is halted by selecting <code>/Project/Stop</code>.
+ </p>
+ <!--- paragraph break -->
+ <h3>
+ Setting Up Songs
+ </h3>
+ <!--- paragraph break -->
+ <p align="left">
+To be able to playback songs with <a href="http://testbit.eu/wiki/Beast";>Beast</a>, synthesis instruments have to
+be created which are used to playback the notes contained in the parts
+of a song. Songs are created through the menu by selecting
+<code>/Project/New Song</code>.
+ </p>
+ <!--- paragraph break -->
+ <h4>
+ What Is A Synthesis Instrument?
+ </h4>
+ <!--- paragraph break -->
+ <p align="left">
+A synthesis instrument is a special kind of synthesizer network,
+it has particular properties:
+ </p>
+ <!--- paragraph break -->
+ <ul type="disc">
+ <li>
+A synthesis instrument doesn't need to have its <strong>Auto Activate</strong> property enabled. That's because the song using the instrument will take care of activating it when neccessary.
+ </li>
+ <li>
+A dedicated module type is used as input to the synthesis instrument so information about the note to be played can be fed into it.
+ </li>
+ <li>
+A dedicated module type is used as output of the synthesis instrument to jointly compose the sound output together with other synthesis instruments being used.
+ </li>
+ </ul>
+ <!--- paragraph break -->
+ <h4>
+ Creating A Synthesis Instrument
+ </h4>
+ <!--- paragraph break -->
+ <p align="left">
+Here is how to create a simple synthesis instrument with one oscillator
+producing the basic tone, an envelope to control a note's volume, and
+an amplifier to adjust overall volume and apply the envelope to the
+oscillator.
+ </p>
+ <!--- paragraph break -->
+ <ol>
+ <li>
+Select <code>/Project/New Custom Synthesizer</code> from the menu.
+ </li>
+ <li>
+Switch to the networks's <strong>Routing</strong> notebook page.
+ </li>
+ <li>
+Create an <a href="http://testbit.eu/wiki/InstrumentInput";>InstrumentInput</a> and an <a href="http://testbit.eu/wiki/InstrumentOutput";>InstrumentOutput</a> module.
+ </li>
+ <li>
+Create the three modules making up the actual instrument: a <a href="http://testbit.eu/wiki/StandardOsc";>StandardOsc</a>, a <a href="http://testbit.eu/wiki/SimpleADSR";>SimpleADSR</a> (the envelope) and an <a href="http://testbit.eu/wiki/Amplifier";>Amplifier</a>.
+ </li>
+ <li>
+To control the oscillating frequency, and to trigger the oscillator wave at note start, connect the output channels <strong>Frequency</strong> and <strong>Gate</strong> of the <a href="http://testbit.eu/wiki/InstrumentInput";>InstrumentInput</a> module to the input channels <strong>Freq In</strong> and <strong>Sync In</strong> of the <a href="http://testbit.eu/wiki/StandardOsc";>StandardOsc</a> module respectively.
+ </li>
+ <li>
+To let the <a href="http://testbit.eu/wiki/Amplifier";>Amplifier</a> shape the volume of the oscillating tone and to provide actual output, connect the output channel <strong>Audio Out</strong> of the <a href="http://testbit.eu/wiki/StandardOsc";>StandardOsc</a> to one of the <strong>Audio</strong> input channels of the <a href="http://testbit.eu/wiki/Amplifier";>Amplifier</a> and connect the <a href="http://testbit.eu/wiki/Amplifier";>Amplifier</a>'s output channel <strong>Audio Out</strong> to the two input channels <strong>Right Audio</strong> and <strong>Left Audio</strong> of the <a href="http://testbit.eu/wiki/InstrumentOutput";>InstrumentOutput</a>.
+ </li>
+ <li>
+It is recommended to intially reduce the <strong>Master Volume</strong> property of the <a href="http://testbit.eu/wiki/Amplifier";>Amplifier</a> to avoid overdriving the output later on. The properties of a module can be adjusted in it's property dialog which is offered by the Button-3 popup menu of each module.
+ </li>
+ <li>
+Connect the input channel <strong>Gate In</strong> of the <a href="http://testbit.eu/wiki/SimpleADSR";>SimpleADSR</a> to the output channel <strong>Gate</strong> of the <a href="http://testbit.eu/wiki/InstrumentInput";>InstrumentInput</a> to trigger the envelope at note start. Connect the <strong>Ctrl Out</strong> output channel of the <a href="http://testbit.eu/wiki/SimpleADSR";>SimpleADSR</a> to one of the <strong>Control</strong> input channels of the <a href="http://testbit.eu/wiki/Amplifier";>Amplifier</a>.
+ </li>
+ <li>
+<em><strong>IMPORTANT:</strong></em> Synthesis instruments are used to play multiple notes sequentially. In order to determine when an instrument has finished playing a certain note and is thusly free to play a new note, the <strong>Synth Done</strong> channel of the <a href="http://testbit.eu/wiki/InstrumentOutput";>InstrumentOutput</a> must be connected to a signal going high at note end. For this example, connect the <strong>Synth Done</strong> channel to the <strong>Done Out</strong> output channel of the <a href="http://testbit.eu/wiki/SimpleADSR";>SimpleADSR</a> module, this output channel produces a signal which is low while the envelope is active and goes high past the envelope end.
+ </li>
+ </ol>
+ <!--- paragraph break -->
+ <p align="left">
+While the synthesis instrument is ready for use now, it can't be
+used or tested directly, but has to be deployed in a song or <a href="http://testbit.eu/wiki/MidiSynth";>MidiSynth</a>
+(offered by the main menu under <code>/Project/New MIDI Synthesizer</code>) which
+leads us to the next Topic.
+ </p>
+ <!--- paragraph break -->
+ <h4>
+ Setting Up Parts And Tracks
+ </h4>
+ <!--- paragraph break -->
+ <p align="left">
+Songs basically consist of notes kept in "Parts" which are arranged in
+"Tracks". The tracks control the order in which parts are played and
+what instrument is used to play a certain part.
+So the steps to a simple test setup for a synthesis instrument are:
+ </p>
+ <!--- paragraph break -->
+ <ol>
+ <li>
+Switch to the <strong>Tracks</strong> notebook page of a song and add a track to the song.
+ </li>
+ <li>
+Click into the track's tact area to create a new part within it.
+ </li>
+ <li>
+Click onto the newly created part to start up a piano roll editor to arrange notes within parts.
+ </li>
+ <li>
+Use the piano roll editor to create some notes in the part to be played back.
+ </li>
+ <li>
+Select a synthesis network (created as shown in the last section) as synthesis input for this track by editing the <strong>Synth</strong> property.
+ </li>
+ </ol>
+ <!--- paragraph break -->
+ <p align="left">
+A song with parts, instruments and tracks setup can be played back via
+the main menu by selecting the menu item <code>/Project/Play</code>.
+ </p>
+ <!--- paragraph break -->
+ <h4>
+ Postprocessing tracks and songs
+ </h4>
+ <!--- paragraph break -->
+ <p align="left">
+The sound generated by the tracks of a song and the song itself can be
+postprocessed by synthesis networks to add effects and adjust the sound
+to your needs.
+Postprocessing networks are created as follows:
+ </p>
+ <!--- paragraph break -->
+ <ol>
+ <li>
+Select <code>/Project/New Custom Synthesizer</code> from the menu to create a new network.
+ </li>
+ <li>
+Add a virtual input and output, i.e. a <a href="http://testbit.eu/wiki/BseSubIPort";>BseSubIPort</a> and a <a href="http://testbit.eu/wiki/BseSubOPort";>BseSubOPort</a> module, to the network.
+ </li>
+ <li>
+Connect the first two input and output channels between the two modules, these carry the left and right channel sound of a track respectively, so the sound signals may pass through the postprocessing network.
+ </li>
+ <li>
+Alternatively, rather than simply connecting the inputs to the outputs, you may use an effect such as the free reverb module <a href="http://testbit.eu/wiki/BseFreeVerb";>BseFreeVerb</a> inbetween the input and output connections.
+ </li>
+ </ol>
+ <!--- paragraph break -->
+ <p align="left">
+To postprocess the sound of a single track in a song, select the synthesis network as postprocessing network for the track by editing the tracks "Post" property.
+To apply the network to a song, select it as postprocessing network for the song by editing the songs "Custom Postprocess Net" property.
+ </p></div>
</div>
<div id="comments"></div> </div>
</td>
Modified: trunk/docs/imports/beastdocs.css
==============================================================================
--- trunk/docs/imports/beastdocs.css (original)
+++ trunk/docs/imports/beastdocs.css Wed Jun 4 21:55:14 2008
@@ -3,7 +3,7 @@
*
* GNU Lesser General Public License version 2 or any later version.
*/
-)
+
/* --- wiki specials --- */
div.ctype-wikipage h1 { margin: 1.5em 0 1.5em; font-size: 2.50em; text-decoration: underline; text-align: center; }
div.ctype-wikipage h2 { margin: 1.5em 0 1.0em; font-size: 2.00em; text-decoration: underline; text-align: center; }
@@ -17,13 +17,13 @@
table.wikitable { margin: 5px; padding: 3px; border: 1px solid #aaaaaa; border-collapse: collapse; caption-side: bottom; }
table.wikitable caption { margin-left: inherit; margin-right: inherit; font-weight: bold; }
-table.wikitable th { padding: 0 3px 0; text-align: center; border: 1px dashed #aaaaaa; border-bottom: 1px solid #aaaaaa; background-color: #ddddee; }
-table.wikitable td { padding: 0 3px 0; border: 1px dashed #aaaacc; background-color: #eeeeff; }
+table.wikitable th { padding: 0.1em 0.3em; text-align: center; border: 1px dashed #aaaaaa; border-bottom: 1px solid #aaaaaa; background-color: #ddddee; }
+table.wikitable td { padding: 0.1em 0.3em; border: 1px dashed #aaaacc; background-color: #eeeeff; }
table.wikitableslim { margin: 5px; padding: 3px; border: 1px solid #aaaaaa; border-collapse: collapse; caption-side: bottom; }
table.wikitableslim caption { margin-left: inherit; margin-right: inherit; font-weight: bold; }
-table.wikitableslim th { padding: 0 3px 0; text-align: center; border: 1px solid #aaaaaa; border-bottom: 1px solid #aaaaaa; }
-table.wikitableslim td { padding: 0 3px 0; border: 1px solid #aaaacc; }
+table.wikitableslim th { padding: 0.1em 0.3em; text-align: center; border: 1px solid #aaaaaa; border-bottom: 1px solid #aaaaaa; }
+table.wikitableslim td { padding: 0.1em 0.3em; border: 1px solid #aaaacc; }
/* BEAST - Bedevilled Audio System
* Copyright (C) 2007 Tim Janik
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
