Last minute documentation updates.
[nondaw.git] / timeline / doc / OVERVIEW.html
blob9ea0139cd8b821201f9663019eb2e92d0231b9f2
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head>
3 <meta name="generator" content="Generated by MUP v3.5">
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5 <link type="text/css" rel="stylesheet" href="mup.css">
6 <title>The Non DAW</title>
7 </head>
8 <body>
9 <div id=cover>
10 <h1>The Non DAW</h1>
11 <h3></h3>
12 <address>
13 Jonathan Moore Liles <a href="mailto:male@tuxfamily.org">&lt;male@tuxfamily.org&gt;</a><br>
14 March 1, 2008<br>
16 </address><img src="logo.png" alt="logo"><hr></div>
17 <div id=body>
18 <div id=toc>
19 <h1 id=toc>Table Of Contents</h1>
20 <ul>
21 <li><a href="#n:1.">1. Overview</a>
22 <ul><li><a href="#n:1.1.">1.1. Description</a>
24 <li><a href="#n:1.2.">1.2. What it is not</a>
26 <li><a href="#n:1.3.">1.3. What is a DAW?</a>
28 <li><a href="#n:1.4.">1.4. Why write another one?</a>
30 <li><a href="#n:1.5.">1.5. Features</a>
32 <ul><li><a href="#n:1.5.1.">1.5.1. Journaled Projects</a>
34 <li><a href="#n:1.5.2.">1.5.2. Non-destructive editing</a>
36 <li><a href="#n:1.5.3.">1.5.3. Unlimited tracks</a>
38 <li><a href="#n:1.5.4.">1.5.4. Unlimited takes</a>
40 <li><a href="#n:1.5.5.">1.5.5. Cross-fades</a>
42 <li><a href="#n:1.5.6.">1.5.6. Automation</a>
44 <li><a href="#n:1.5.7.">1.5.7. Time/tempo mapping</a>
46 </ul><li><a href="#n:1.6.">1.6. Components</a>
48 <ul><li><a href="#n:1.6.1.">1.6.1. Timeline</a>
50 </ul></ul><li><a href="#u:1.">What does freedom have to do with this software?</a>
52 <li><a href="#u:2.">Donations</a>
54 <li><a href="#u:3.">Distribution</a>
56 <li><a href="#u:4.">Requirements</a>
58 <li><a href="#u:5.">Community</a>
60 </ul></ul><hr></div>
61 <h1 id="n:1.">1. Overview</h1>
62 <h2 id="n:1.1.">1.1. Description</h2>
63 <p>
64 The Non DAW is a powerful, reliable and fast modular Digital Audio Workstation system, released under the GNU General Public License (GPL). It utilizes the JACK Audio Connection Kit for inter-application audio I/O and the FLTK GUI toolkit for a fast and lightweight user interface.
65 </p>
66 <p>
67 Please see the <a class=ext href="MANUAL.html">Manual</a> for more information.
68 </p>
69 <h2 id="n:1.2.">1.2. What it is not</h2>
70 <p>
71 Non-DAW is <b>not</b> a wave editor. It is not a beat slicer. It is not a granular synthesis engine. It is <b>not</b> a clone of some proprietary DAW. It is not an <i>insert name of proprietary audio thing here</i> killer. It is <b>not</b> limiting and restricting. It is <b>not</b> a monolithic DAW with internal mixing or EQ DSP. Non-DAW is intended to be one tool among many in your Linux audio toolbox.
72 </p>
73 <h2 id="n:1.3.">1.3. What is a DAW?</h2>
74 <p>
75 The acronym DAW stands for Digital Audio Workstation. Of course, Non is software, so when we say DAW we imply a purely software based system. A DAW is used by modern studio engineers to record and arrange multitrack sessions of different musicians into a single song. Perhaps a more noble use of a DAW, and the one for which Non-DAW was specifically written, is to provide the mutli-instrumentalist individual with all the software necessary to quickly and conveniently record and arrange his compositions and produce a professional quality result.
76 </p>
77 <p>
78 In this author's opinion, a DAW comprises the following functionality:
79 </p>
80 <ul><li><span>Non-linear, non-destructive arrangement of portions of audio clips.</span>
81 <li><span>Tempo and time signature mapping, with editing operations being closely aligned to this map.</span>
82 </ul><p>
83 Since Non uses JACK for IO, some things traditionally considered to be within the scope of a monolithic DAW can be pared out into JACK and Non Mixer:
84 </p>
85 <ul><li><span>Signal routing</span>
86 <li><span>Audio mixing</span>
87 <li><span>Hosting of plugins</span>
88 </ul><h2 id="n:1.4.">1.4. Why write another one?</h2>
89 <p>
90 First and foremost, we can disregard all non-free DAWs because we do not waste our precious time and spirit on non-free and/or proprietary software. This excludes virtually every other DAW in existence. Secondly, we require a DAW that runs on the GNU/Linux operating system in conjunction with other free software, such as the JACK Audio Connection Kit, in a modular and cooperative and manner. Finally, we require a program that is powerful, fast, and reliable. No other software meets these requirements.
91 </p>
92 <p>
93 The design of the Non DAW differs substantially from others. This is a good thing; for a clone of a bad design is doomed from the start.
94 </p>
95 <p>
96 There is only one other DAW that is capable and free software, and its name is Ardour. Suffice it to say that the architecture of Ardour is incompatible with the requirements of speed and reliability. Other DAW-like free software programs, including Traverso and QTractor, are similarly limited (being of similar design), but suffer the additional burden of cumbersome legacy ALSA support and very a limited feature set.
97 </p>
98 <p>
99 Given these options, we had no choice but to start from scratch, this time on a solid foundation, rather than attempting (in vain) to shoehorn good design into an existing code base.
100 </p>
101 <h2 id="n:1.5.">1.5. Features</h2>
103 Non-DAW shares many features in common with other, similar projects. However, Non-DAW's unique architecture permits surprising new functionality.
104 </p>
105 <h3 id="n:1.5.1.">1.5.1. Journaled Projects</h3>
107 Unlike legacy DAWs, which keep project state in huge, memory wasting, hard to manage XML (or binary equivalent) trees, Non-DAW has the unique ability to store project state in a compact continuous journal of bidirectional delta messages--similar to the journal part of journaling filesystems--in plain ASCII.
108 </p>
110 The Non-DAW disk format takes the form of a journal of delta messages. Each project file contains the complete history of that project since the last (optional) compaction operation. These journals are so terse that it is practical to keep the complete history of a project from the time it was first opened. No XML or other bloated, buggy, resource hungry format is employed. (Anyone suggesting the use of XML for anything related to this project will be shot on sight with incendiary rounds.)
111 </p>
113 This has a number of highly desirable consequences. Among them:
114 </p>
115 <ol><li><span>Zero time spent 'saving' projects.</span>
116 <li><span>No need to 'save' projects manualy.</span>
117 <li><span>No need for CPU and RAM wasting 'autosave' function.</span>
118 <li><span>In the (unlikely) event of a crash, at most *one* transaction (user action) may be lost, and the project will *not* be invalidated.</span>
119 <li><span>Unlimited undo--potentially going back to the very moment the project was created (state of the template it was based on).</span>
120 <li><span>Undo history requires no additional RAM.</span>
121 <li><span>Project format is insanely simple and easy to manipulate with sed or awk scripts, should the need arise (see the included `remove-unused-sources` script for an example).</span>
122 </ol><p>
123 Non-DAW's journalling capability can drastically change your workflow. No longer will you fear a system failure. No longer will your pinky finger become sore from hitting Control-S after every important change. No longer will you have to attempt, in vain, to manually edit a completely incomprehensible XML 'document', because Ardour has corrupted its memory and therefore the project you 'saved'.
124 </p>
125 <h3 id="n:1.5.2.">1.5.2. Non-destructive editing</h3>
127 Sound sources (audio files) are represented by <i>regions</i>. Any number of regions may represent different parts of the same source. All editing is performed on these region structures--the sound sources themselves are considered read-only (except for captures in-progress).
128 </p>
129 <h3 id="n:1.5.3.">1.5.3. Unlimited tracks</h3>
131 Tracks in a DAW are unlike tracks on tape in that a single track can contain more than one channel of audio. Each audio track has its own record, mute, solo, and gain, as well an active take and any number of inactive takes. A track may also have any number of annotation and control sequences associated with it.
132 </p>
133 <h3 id="n:1.5.4.">1.5.4. Unlimited takes</h3>
135 A <i>take</i> is a sequence of regions. Each track has <i>current take</i>, implied by 'the track', as well as any number of other, inactive takes. A track may be set to display all takes simultaneously, to ease the process of reviewing past takes or stitching together a new take from parts of previous takes. Old takes may be deleted, either one by one or all at once, when they are no longer required. Takes may not be transferred between tracks (there's no technical reason why they can't, but allowing this would be bad design).
136 </p>
137 <h3 id="n:1.5.5.">1.5.5. Cross-fades</h3>
139 Where regions overlap, a cross-fade exists. This means that the transition from region A to region B will be gradual rather than abrupt. The shape of the gain curve may be selected separately for region A and B of the cross-fade. Available curves include: Linear, Sigmoid, Logarithmic, and Parabolic.
140 </p>
141 <h3 id="n:1.5.6.">1.5.6. Automation</h3>
143 Each track can have associated with it any number of <i>control sequences</i>, a subset of which may be visible at any one time. Each control sequence comprises a series of <i>control points</i>, which collectively represent a graph of changes to a single controllable value over time. Anything may be controlled by a control track, including external software supporting OSC or MIDI control, although the most common application is mixer gain automation, where the value controlled is the fader level in the mixer.
144 </p>
145 <h3 id="n:1.5.7.">1.5.7. Time/tempo mapping</h3>
147 The time and tempo maps (rulers) affect where and how many bar/beat lines are drawn. During playback they affect the time/tempo of the JACK transport so that other programs, like the Non-Sequencer, can follow along in sync.
148 </p>
149 <h2 id="n:1.6.">1.6. Components</h2>
151 The Mixer and the Timeline are separate programs, connected through JACK.
152 </p>
153 <h3 id="n:1.6.1.">1.6.1. Timeline</h3>
155 All operations on the timeline are journaled, and therefore reversible.
156 </p>
158 The following data belong to the timeline:
159 </p>
160 <dl>
161 <dt><em>Tracks and Takes</em></dt>
162 <dd>Each Track has a number of input and output ports, a name, and any number of attached sequences. All sequences but the current (topmost) are inactive and do not generate sound or accept captures. These sequences are referred to as <i>Takes</i>. Previous takes may be swapped with the current sequence and all takes may be shown on screen at once for easy splicing. Each track can also have any number of Control Sequences attached to it, in which case all control sequences generate control output unless disconnected. The height of a track may be adjusted and a track can be muted, soloed, or record-enabled.</dd>
163 <dt><em>Regions</em></dt>
164 <dd>Regions are the most common object on the timeline. Each region represents a segment of some particular audio file. Waveforms of all regions belonging to the same source are displayed in the same hue. Each region has a normalization value and regions can be selected individually or operated on in groups. Each region has a fade-in and fade-out curve, and when two regions overlap, this constitutes a cross-fade.</dd>
165 <dt><em>Control Points</em></dt>
166 <dd>Control points are arbitrarily placed points on a curve (or line) from which continuous control values are interpolated and sent out a JACK port (like a control voltage).</dd>
167 <dt><em>Time and Tempo Points</em></dt>
168 <dd>Time and Tempo points control the tempo and meter throughout time. This information is used for drawing the measure lines and snapping to the grid, as well as informing other JACK clients of tempo changes throughout a song.</dd>
169 <dt><em>Annotation Points</em></dt>
170 <dd>Cue points are textual markers on the timeline. Common names for cue points include "Verse 1", "Bridge", etc.</dd>
171 <dt><em>Annotation Regions</em></dt>
172 <dd>Annotation Regions are annotations with a definite duration. These are useful for representing lyrics or other notes of a timely nature. Each track may have any number of annotation sequences associated with it, and these sequences can contain a free mix of annotation points and annotation regions.</dd>
173 </dl>
174 <h1 id="u:1.">What does freedom have to do with this software?</h1>
176 Non is <i>free software</i>. This means, briefly, that you are free use it as <b>you</b> wish, free to examine and adapt the source code, free to share it with your friends, and free to publish your changes to the source code. Furthermore, Non is <i>copyleft</i>, which means that you are free from the threat of some other entity taking over and denying you the above freedoms. The <i>free</i> part of <i>free software</i> doesn't refer to price any more than the <i>free</i> in <i>free speech</i> does.
177 </p>
179 To learn why free software is so important to us (and why it should be important to you), please see the Free Software Foundation's website:
180 </p>
182 <a class=ext href="http://www.fsf.org/licensing/essays/free-sw.html">What is Free Software?</a> <a class=ext href="http://www.fsf.org/licensing/essays/copyleft.html">What is Copyleft?</a>
183 </p>
184 <h1 id="u:2.">Donations</h1>
186 Donations can take many forms. You can donate your time in code, either by sending it to me for review or cloning the git repository and publishing one containing your changes. You can donate your time in testing, documentation, artwork, indexing, etc. Or, if you don't feel that you possess the time or skills required for the above forms of donation, you can donate money instead. Money donated will help to ensure that I have the free time, good nutrition and enthusiasm required to implement new features. It can also be a more palpable way of saying "Thanks for caring." or "Job well done!"
187 </p>
189 If you don't love this software, don't feel guilty about not contributing. If you do love it, then please help me improve it--in whatever manner you think is appropriate.
190 </p>
192 <a class=ext href="http://non.tuxfamily.org/donation.html">Make a donation</a>
193 </p>
194 <h1 id="u:3.">Distribution</h1>
196 Development of the Non-DAW and Non-Mixer can be followed with Git:
197 </p>
198 <div class="fig example"><table width=100%><tr><td><pre>
199 git clone git://git.tuxfamily.org/gitroot/non/daw.git
200 </pre></td></tr>
201 </table></div>
203 There are no pre-compiled binaries available.
204 </p>
205 <h1 id="u:4.">Requirements</h1>
207 The following libraries are required to build Non DAW and Non Mixer
208 </p>
209 <ul><li><span>FLTK >= 1.1.7 (with `fluid`)</span>
210 <li><span>JACK >= 0.103.0</span>
211 <li><span>libsndfile >= 0.18.0</span>
212 </ul><h1 id="u:5.">Community</h1>
214 Feel free to drop by the <tt>#non</tt> channel on irc.freenode.net.
215 </p>
217 There is a mailing list <tt>non-daw@lists.tuxfamily.org</tt>.
218 </p>
220 To subscribe, send a message with the subject 'subscribe' to <a href="mailto:non-daw-request@lists.tuxfamily.org">&lt;non-daw-request@lists.tuxfamily.org&gt;</a>.
221 </p>
223 You can also browse the <a class=ext href="http://listengine.tuxfamily.org/lists.tuxfamily.org/non-daw/">archive</a>.
224 </p>
225 </div>
226 </body>
227 </html>