commit b8b725110d949fc41b3a7a1702d783c3c38d79e2
parent fd9f97e876734be54b8adc76b3e1bc182f403827
Author: fundamental <mark.d.mccurry@gmail.com>
Date: Sun, 5 Jul 2009 20:55:14 -0400
Started AsciiDoc translation
Docbook seemed to be combersome, so AsciiDoc is being used to make
the documentation process easier.
Diffstat:
11 files changed, 283 insertions(+), 224 deletions(-)
diff --git a/doc/Makefile b/doc/Makefile
@@ -0,0 +1,33 @@
+all: xhtml
+
+xhtml: zynaddsubfx.txt envelope.txt intro.txt lfo.txt
+ asciidoc -a numbered -a toc -b xhtml11 \
+ --conf-file=myconf.conf zynaddsubfx.txt
+
+chunked:
+ asciidoc --doctype=article -b docbook \
+ --conf-file=myconf.conf zynaddsubfx.txt
+ mkdir ./zynaddsubfx.chunked
+ rm -f "./zynaddsubfx.chunked/*.html"
+ cd "."
+ xsltproc --stringparam html.stylesheet "./docbook-xsl.css" \
+ --stringparam callout.graphics 0 \
+ --stringparam navig.graphics 0 \
+ --stringparam admon.textlabel 1 \
+ --stringparam admon.graphics 0 \
+ --nonet \
+ --stringparam base.dir "zynaddsubfx.chunked/" \
+ "/etc/asciidoc/docbook-xsl/chunked.xsl" \
+ "./zynaddsubfx.xml" \
+
+pdf:
+ asciidoc -b latex --conf-file=myconf.conf zynaddsubfx.txt
+ grep -v figure zynaddsubfx.tex | \
+ sed -e 's~^\\includegraphics~\\par\\noindent\{\} \\includegraphics~' | \
+ sed -e 's~includegraphics\[\]~includegraphics[scale=0.5]~' > tmp.tex
+ mv tmp.tex zynaddsubfx.tex
+ latex zynaddsubfx.tex
+
+clean:
+ rm -f *~ *html *pdf *tex
+
diff --git a/doc/envelope.txt b/doc/envelope.txt
@@ -0,0 +1,132 @@
+Envelopes
+=========
+:Author: Paul Nasca
+
+Introduction
+------------
+Envelopes control how the amplitude, the frequency, or the
+filter changes over time.
+
+Amplitude Envelopes
+-------------------
+
+These envelopes controls the amplitude of the sound.
+In ZynAddSubFX, amplitude envelopes can be linear or logarithmic.
+In the next image, it is shown the differences between these envelopes.
+
+image::images/envelope1.png[Alt text]
+
+The amplitude envelope is divided into:
+
+* *Attack*: Begins at the Note On. The volume starts from 0 to the maximum.
+In ZynAddSubFX, the attack is always linear.
+* *Decay*: The volume drops from the maximum value to a level called "Sustain level"
+* *Sustain*: The volume remains constant until the key is depressed (Note Off).
+After this, the last stage take place.
+* *Release*: The volume drops to zero
+
+
+Frequency Envelopes
+-------------------
+
+These envelopes controls the frequency (more exactly, the pitch) of
+the oscillators.
+The following picture draws the stages of these envelopes.
+
+image::images/envelope2.png[Alt text]
+
+The dotted line represents the real pitch of the sound without the
+envelope.
+
+The frequency envelopes are divided into 3 stages:
+
+* *Attack*: Begins at the Note On. The frequency starts from a certain value and
+glides to the real frequency of the note.
+* *Sustain*: The frequency is the same on over the sustain period
+* *Release*: This stage begins on Note Off and glides the frequency of the note
+to a certain
+value
+
+Filter Envelopes
+----------------
+These envelopes controls the cutoff frequency of the filters and are divided
+into
+
+image:images/envelope3.png[Alt Text]
+
+* *Attack*: Begins at the Note On. The cutoff frequency starts from a certain value and glides to another value
+* *Decay*: The cutoff frequency continues to glide to the real cutoff frequency value of the filter (dotted line)
+* *Sustain*: the cutoff frequency is the same on over the sustain period (dotted line)
+* *Release*: this stage begins on Note Off and glides the filter cutoff frequency of the note to a certain value
+
+Freemode Envelopes
+------------------
+
+For all envelope there is a mode that allows the user to set an arbitrary number of stages and control points. This mode is called Freemode.
+
+image:images/envelope4.png[Alt Text]
+
+Only stage that always remains defined is the Sustain, where the envelopes freezes until a Note Off event.
+
+User Interface
+--------------
+All the envelope types has some common controls:
+
+* *E*: Shows a window that you can view the real envelope shape or convert to free mode to edit it
+* *Stretch*: How the envelope is stretched according the note.
+On the higher notes the envelopes are shorter than lower notes.
+In the leftmost value, the stretch is zero.
+The rightmost use a stretch of 200%; this means that the envelope is stretched about 4 times/octave.
+* *frcR*: Forced release.
+This means that if this option is turned on, the release will go to the final value, even if the sustain stage is not reached. Usually, this must be set.
+
+
+The parameters for Amplitude Envelopes for ZynAddSubFX are:
+
+image:images/uienvelope3.jpg[Alt Text]
+
+* *A.dt*: Attack duration
+* *D.dt*: Decay duration
+* *S.Val*: Sustain value
+* *R.dt*: Release time
+* *L*: If this option is set, the envelope is linear, otherwise, it will be
+logarithmic
+
+
+For Frequency Envelopes the interface has the following parameters:
+
+image:images/uienvelope2.jpg[Alt Text]
+
+* *A.val*: Attack value
+* *A.dt*: Attack duration
+* *R.dt*: Release time
+* *R.val*: Release value
+
+
+Filter Envelopes has the parameters:
+
+image:images/uienvelope1.jpg[Alt Text]
+
+* *A.val*: Attack value
+* *A.dt*: Attack duration
+* *D.val*: Decay value
+* *D.dt*: Decay time
+* *R.dt*: Release time
+* *R.val*: Release value
+
+The Freemode envelopes has a separate window to set the parameters and controls:
+
+image:images/uienvelope0.jpg[]
+
+* *Control points*: You can move the points using the mouse.
+In the right on the windows, it is shown the total duration of the envelope.
+If the mouse button will be pressed on a control point, it will be shown the
+duration of the stage where the point is.
+* *FreeMode*: this button activates or deactivates the freemode mode.
+* *Add Point*: Adds the point next to the current selected point.
+You can select a point by clicking on it.
+* *Delete point*: Removes the point from the envelope.
+* *Sust.*: Set the sustain point. It is shown using the yellow line.
+* *Str.*: Envelope stretch
+
+
diff --git a/doc/images/lfo0.png b/doc/images/lfo0.png
Binary files differ.
diff --git a/doc/images/lfo1.png b/doc/images/lfo1.png
Binary files differ.
diff --git a/doc/images/lfo2.png b/doc/images/lfo2.png
Binary files differ.
diff --git a/doc/images/uilfo.jpg b/doc/images/uilfo.jpg
Binary files differ.
diff --git a/doc/intro.txt b/doc/intro.txt
@@ -0,0 +1,23 @@
+Getting Started
+===============
+
+In most cases ZynAddSubFX is used it will not alone, and it will be linked
+with other programs.
+
+MIDI
+----
+
+MIDI can be used to connect other applications to ZynAddSubFX.
+Under ALSA on Linux the standard tool to connect ZynAddSubFX's MIDI is
+aconnect.
+
+ZynAddSubFX has one incomming MIDI port.
+Once another application is connected to this port, then it should be
+able to send information on notes, pitches, and modulations to
+ZynAddSubFX.
+For more specific information see INSERT CHAPTER NAME HERE.
+
+JACK
+----
+JACK can be used to connect the output of ZynAddSubFX to other
+applications.
diff --git a/doc/lfo.txt b/doc/lfo.txt
@@ -0,0 +1,65 @@
+LFO
+===
+:author: Paul Nasca
+
+Introduction
+------------
+
+"LFO" means Low Frequency Oscillator.
+These oscillators are not used to make sounds by themselves, but they changes
+somes parameters (like the frequencies, the amplitudes or the filters).
+
+The LFOs has some basic parameters:
+
+* *Delay*: This parameter sets how much time takes since the start of the
+ note to the start of the LFO
+* *Start Phase*: The possition that a LFO will start at
+* *Frequency*: How fast the LFO is (i.e. how fast the parameter's controlled by
+ the LFO changes)
+* *Depth*: The amplitude of the LFO (i.e. how much the parameter's controlled
+ by the LFO changes)
+
+image:images/lfo0.png[]
+
+Another important LFO parameter is the shape.
+There are many LFO Types according to the shape.
+ZynAddSubFX supports the folowing LFO shapes:
+
+image:images/lfo1.png[]
+
+Another parameter is the LFO Randomness.
+It modifies the LFO amplitude or the LFO frequency at random.
+In ZynAddSubFX you can choose how much the LFO frequency or LFO amplitude
+changes by this parameter.
+In the folowing images are shown some examples of randomness and how changes
+the shape of a triangle LFO.
+
+image:images/lfo2.png[]
+
+Other parameters are:
+
+* *Continous mode*: If this mode is used, the LFO will not start from "zero" on each new note, but it will be continuous. This is very usefull if you apply on filters to make interesting sweeps.
+* *Stretch*: It controlls how much the LFO frequency changes according to the
+note's frequency.
+It can vary from negative stretch (the LFO frequency is decreased on higher
+notes) to zero (the LFO frequency will be the same on all notes) to positive
+stretch (the LFO frequency will be increased on higher notes).
+
+User Interface
+--------------
+
+In ZynAddSubFX, LFO parameters are shown as:
+
+image:images/uilfo.jpg[]
+
+Theese parameters are:
+
+* *Freq*: LFO Frequency
+* *Depth*: LFO Depth
+* *Start*: LFO Start Phase -
+If this knob is at the lowest value, the LFO Start Phase will be random.
+* *Delay*: LFO Delay
+* *A.R.*: LFO Amplitude Randomnes
+* *F.R.*: LFO Frequency Randomness
+* *C.*: LFO Continous Mode
+* *Str.*: LFO Stretch - in the image above the LFO stretch is set to zero
diff --git a/doc/myconf.conf b/doc/myconf.conf
@@ -0,0 +1,3 @@
+[titles]
+
+underlines="__","==","--","~~","^^"
diff --git a/doc/zynaddsubfx.sgml b/doc/zynaddsubfx.sgml
@@ -1,224 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
-
-<book>
-
- <bookinfo>
- <title>Zynaddsubfx</title>
- <author>
- <!-- Just add yourself as an author when you work on the book -->
- <personname>
- <firstname>Paul</firstname> <surname>Nasca</surname>
- </personname>
- </author>
- <author>
- <personname>
- <firstname>Mark</firstname> <surname>McCurry</surname>
- </personname>
- </author>
-
- <abstract>
- <para>
- This document is a used to detail the features and use of
- the ZynAddSubFX synthisizer.
- </para>
- </abstract>
-
- </bookinfo>
-
- <chapter>
- <title>Introduction</title>
-
- <para>
- ZynAddSubFX is a synthisizer, which uses several components to generate
- sound.
- </para>
-
- </chapter>
-
- <chapter>
- <title>Getting Started</title>
- <para>
- In most cases ZynAddSubFX is used it will not alone, and it will be linked
- with other programs.
- </para>
- <sect1>
- <title>MIDI</title>
- <para>
- MIDI can be used to connect other applications into ZynAddSubFX.
- One standard tool to connect ZynAddSubFX with other programs is
- aconnect.
- </para>
- <para>
- ZynAddSubFX has one incomming MIDI port.
- Once another application is connected to this port, then it should be
- able to send information on notes, pitches, and modulations to
- ZynAddSubFX.
- For more specific information see INSERT CHAPTER NAME HERE.
- </para>
- </sect1>
- <sect1>
- <title>JACK</title>
- <para>
- JACK can be used to connect the output of ZynAddSubFX to other
- applications
- </para>
- </sect1>
- </chapter>
-
- <chapter>
- <title>Filters</title>
- <para>
- In ZynAddSubFX filters can be used at several different stages to
- increase or decrease a defined set of frequencys.
- </para>
- <table>
- <title>Types of Filters</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <thead>
- <row>
- <entry>Short Name</entry>
- <entry>Full Name</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>LPF</entry>
- <entry>Low Pass Filter</entry>
- <entry>Higher frequencies are removed</entry>
- </row>
- <row>
- <entry>HPF</entry>
- <entry>High Pass Filter</entry>
- <entry>Lower frequencies are removed</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </chapter>
-
- <chapter>
- <title>LFOs</title>
- <para>
- The Low Frequency Ocillators are used within ZynAddSubFX to modify the
- parameters of the Part's frequency, filter, and amplitude.
- </para>
- </chapter>
-
- <chapter>
- <title>Envelopes</title>
- <sect1>
- <title>Introduction</title>
- <para>Envelopes control how the amplitude, the frequency, or the
- filter changes over time.</para>
- <sect2>
- <title>Amplitude Envelopes</title>
- <para>
- Theese envelopes controls the amplitude of the sound.
- In ZynAddSubFX, amplitude envelopes can be linear or logarithmic.
- In the next image, it is shown the differences between these
- envelopes.
- </para>
- <mediaobject>
- <imageobject>
- <imagedata align="left" format="PNG"
- fileref="images/envelope1.png"/>
- </imageobject>
- </mediaobject>
- <para>
- The amplitude envelope is divided into:
- </para>
- <itemizedlist mark="bullet">
- <listitem>
- <para>
- Attack - begins at the Note On.
- The volume starts from 0 to the maximum.
- In ZynAddSubFX, the attack is always linear.
- </para>
- </listitem>
- <listitem>
- <para>
- Decay - the volume drops from the maximum value to a level called
- "Sustain level"
- </para>
- </listitem>
- <listitem>
- <para>
- Sustain - the volume remains constant until the key is depressed
- (Note Off).
- After this, the last stage take place.
- </para>
- </listitem>
- <listitem>
- <para>
- Release - the volume drops to zero
- </para>
- </listitem>
- </itemizedlist>
- </sect2>
- <sect2>
- <title>Frequency Envelopes</title>
- <para>
- These envelopes controls the frequency (more exactely, the pitch) of
- the oscillators.
- The folowing picture draws the stages of theese envelopes.
- <inlinemediaobject>
- <imageobject>
- <imagedata align="left" format="PNG"
- fileref="images/envelope2.png"/>
- </imageobject>
- </inlinemediaobject>
- The dotted line represents the real pitch of the sound without the
- envelope.
- The frequency envelopes are divided into 3 stages:
- </para>
- <itemizedlist mark="bullet">
- <listitem><para>
- Attack - begins at the Note On.
- The frequency starts from a certain value and glides to the
- real frequency of the note.
- </para></listitem>
- <listitem><para>
- Sustain - the frequency is the same on over the sustain period
- </para></listitem>
- <listitem><para>
- Release - this stage begins on Note Off and glides the frequency
- of the note to a certain value
- </para></listitem>
- </itemizedlist>
- </sect2>
- </sect1>
- </chapter>
-
- <chapter>
- <title>Ocillators</title>
- <para>
- The Ocillators are what generate the base sound for a part before it is
- modified.
- </para>
- </chapter>
-
- <chapter>
- <title>Types of Synthesis</title>
- <sect1>
- <title>ADDsynth</title>
- <para>
- The ADDsynth preforms additive synthisis
- </para>
- </sect1>
- <sect1>
- <title>SUBsynth</title>
- <para>
- The SUBsynth is responsible of the subtractive synthesis in ZynAddSubFX.
- </para>
- </sect1>
- <sect1>
- <title>PADsynth</title>
- <para>
- The PADsynth uses the PAD synthisis algorithm created by Paul Nasca
- </para>
- </sect1>
- </chapter>
-
-</book>
diff --git a/doc/zynaddsubfx.txt b/doc/zynaddsubfx.txt
@@ -0,0 +1,27 @@
+Zynaddsubfx
+___________
+:Author: Paul Nasca
+
+
+:titles.underlines: "__","==","--","~~","^^"
+
+include::./intro.txt[]
+
+Filters
+=======
+In ZynAddSubFX filters can be used at several different stages to
+increase or decrease a defined set of frequencys.
+
+.Types of Filters
+[grid="all"]
+`------.--------'-----------------------
+Short Long Description
+----------------------------------------
+LPF Low Pass High Frequencies cutoff
+HPF High PassHigher frequencies cutoff
+----------------------------------------
+
+include::./lfo.txt[]
+
+include::./envelope.txt[]
+
