← Back to branch summary

~ubuntu-branches/ubuntu/hoary/kdemultimedia/hoary

« back to all changes in this revision

Viewing changes to arts/examples/README

  • Committer: Bazaar Package Importer
  • Author(s): Martin Schulze
  • Date: 2003-01-22 15:00:51 UTC
  • Revision ID: james.westby@ubuntu.com-20030122150051-uihwkdoxf15mi1tn
Tags: upstream-2.2.2
Import upstream version 2.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
arts/examples/README
 
1
Example Arts Modules
 
2
--------------------
 
3
 
 
4
This directory contains example arts modules. The examples fall into
 
5
several categories:
 
6
 
 
7
1. Effects which can be used as reusable building blocks (named
 
8
   effect_*.arts)
 
9
 
 
10
2. Standalone examples illustrating how to use each of the built-in
 
11
   arts modules (named example_*.arts). These typically send some
 
12
   output to a sound card.
 
13
 
 
14
3. Instruments built from lower level arts modules (named
 
15
   instrument_*.arts). These following a standard convention for
 
16
   input and output ports so they can be used by a (future) instrument
 
17
   manager.
 
18
 
 
19
4. Mixer elements used for creating mixers, including graphical
 
20
   controls (named mixer_element_*.arts).
 
21
 
 
22
5. Templates for creating new modules (names template_*.arts).
 
23
 
 
24
6. Miscellaneous modules that don't fit into any of the above
 
25
   categories.
 
26
 
 
27
Detailed Description Of Each Module
 
28
-----------------------------------
 
29
 
 
30
Examples
 
31
--------
 
32
 
 
33
example_stereo_beep.arts
 
34
 
 
35
Generates a 440Hz sine wave tone in the left channel and an 880Hz sine
 
36
wave tone in the right channel, and sends it to the sound card
 
37
output. This is referenced in the aRts documentation.
 
38
 
 
39
example_sine.arts
 
40
 
 
41
Generates a 440 Hz sine wave.
 
42
 
 
43
example_pulse.arts
 
44
 
 
45
Generates a 440 Hz pulse wave with a 20% duty cycle.
 
46
 
 
47
example_softsaw.arts
 
48
 
 
49
Generates a 440 Hz sawtooth wave.
 
50
 
 
51
example_square.arts
 
52
 
 
53
Generates a 440 Hz square wave.
 
54
 
 
55
example_tri.arts
 
56
 
 
57
Generates a 440 Hz triangle wave.
 
58
 
 
59
example_noise.arts
 
60
 
 
61
Generates white noise.
 
62
 
 
63
example_dtmf1.arts
 
64
 
 
65
Generates a dual tone by producing 697 and 1209 Hz sine waves, scaling
 
66
them by 0.5, and adding them together. This is the DTMF tone for the
 
67
digit "1" on a telephone keypad.
 
68
 
 
69
example_atan_saturate.arts
 
70
 
 
71
Runs a triangle wave through the atan saturate filter.
 
72
 
 
73
example_autopanner.arts
 
74
 
 
75
Uses an autopanner to pan a 400 Hz sine wave between the left and
 
76
right speakers at a 2 Hz rate.
 
77
 
 
78
example_brickwall.arts
 
79
 
 
80
Scales a sine wave by a factor of 5 and then runs it through a
 
81
brickwall limiter.
 
82
 
 
83
example_bus.arts
 
84
 
 
85
Downlinks from a bus called "Bus" and uplinks to the bus
 
86
"out_soundcard" with the left and right channels reversed.
 
87
 
 
88
example_cdelay.arts
 
89
 
 
90
Downlinks from a bus called "Delay", uplinks the right channel through
 
91
a 0.5 second cdelay, and the left channel unchanged. You can use
 
92
artscontrol to connect the effect to a sound player and observe the
 
93
results.
 
94
 
 
95
example_delay.arts
 
96
 
 
97
This is the same as example_cdelay but used the delay effect.
 
98
 
 
99
example_capture_wav.arts
 
100
 
 
101
This uses the Synth_CAPTURE_WAV to save a 400 Hz sine wave as a wav
 
102
file. Run the module for a few seconds, and then examine the file
 
103
created in /tmp. You can play the file with a player such as kaiman.
 
104
 
 
105
example_data.arts
 
106
 
 
107
This uses the Data module to generate a constant stream of the value
 
108
"3" and sends it to a Debug module to periodically display it. It
 
109
also contains a Nil module, illustrating how it can be used to
 
110
do nothing at all.
 
111
 
 
112
example_adsr.arts
 
113
 
 
114
Shows how to create a simple instrument sound using the Envelope Adsr
 
115
module, repetitively triggered by a square wave.
 
116
 
 
117
example_fm.arts
 
118
 
 
119
This uses the FM Source module to generate a 440 Hz sine
 
120
wave which is frequency modulated at a 5 Hz rate.
 
121
 
 
122
example_freeverb.arts
 
123
 
 
124
This connects the Freeverb effect from a bus downlink to a bus
 
125
outlink. You can use artscontrol to connect the effect to a sound
 
126
player and observe the results.
 
127
 
 
128
example_flanger.arts
 
129
 
 
130
This implements a simple flanger effect (it doesn't appear
 
131
to work yet, though).
 
132
 
 
133
example_moog.arts
 
134
 
 
135
This structure combines the two channels from a bus into
 
136
one, passes it though the Moog VCF filter, and sends
 
137
it out the out_soundcard bus.
 
138
 
 
139
example_pitch_shift.arts
 
140
 
 
141
This structure passes the left channel of sound card data through the
 
142
Pitch Shift effect. Adjust the speed parameter to vary the effect.
 
143
 
 
144
example_rc.arts
 
145
 
 
146
This structure passes a white noise generator though an RC filter and
 
147
out to the sound card. By viewing the FFT Scope display in artscontrol
 
148
you can see how this varies from an unfiltered noise waveform.
 
149
 
 
150
example_sequence.arts
 
151
 
 
152
This demonstrates the Sequence module by playing a sequence of notes.
 
153
 
 
154
example_shelve_cutoff.arts
 
155
 
 
156
This structure passes a white noise generator though a Shelve Cutoff
 
157
filter and out to the sound card. By viewing the FFT Scope display in
 
158
artscontrol you can see how this varies from an unfiltered noise
 
159
waveform.
 
160
 
 
161
example_equalizer.arts
 
162
 
 
163
This demonstrates the Std_Equalizer module. It boosts the low and high
 
164
frequencies by 6 dB.
 
165
 
 
166
example_tremolo.arts
 
167
 
 
168
This demonstrates the Tremolo effect. It modulates the left and right
 
169
channels using a 10 Hz tremolo.
 
170
 
 
171
example_xfade.arts
 
172
 
 
173
This example mixes 440 and 880 Hz sine waves using a cross fader.
 
174
Adjust the value of the cross fader's percentage input from -1 to 1 to
 
175
control the mixing of the two signals.
 
176
 
 
177
example_pscale.arts
 
178
 
 
179
This illustrates the Pscale module (I'm not sure if this is a
 
180
meaningful example).
 
181
 
 
182
example_play_wav.arts
 
183
 
 
184
This illustrates the Play Wave module. You will need to
 
185
enter the full path to a .wav file as the filename
 
186
parameter.
 
187
 
 
188
example_multi_add.arts
 
189
 
 
190
This shows the Multi Add module which accepts any number of inputs. It
 
191
sums three Data modules which produce inputs of 1, 2, and 3, and
 
192
displays the result 6.
 
193
 
 
194
Instruments
 
195
-----------
 
196
 
 
197
instrument_flexible_slide.arts
 
198
 
 
199
instrument_flexible_slide_GUI.arts
 
200
 
 
201
instrument_fm_horn.arts
 
202
 
 
203
instrument_full_square.arts
 
204
 
 
205
instrument_moog_vcf_tune.arts
 
206
 
 
207
instrument_moog_vcf_tune_GUI.arts
 
208
 
 
209
instrument_neworgan.arts
 
210
 
 
211
instrument_nokind.arts
 
212
 
 
213
instrument_organ2.arts
 
214
 
 
215
instrument_simple_sin.arts
 
216
 
 
217
instrument_simple_square.arts
 
218
 
 
219
instrument_simple_tri.arts
 
220
 
 
221
instrument_slide.arts
 
222
 
 
223
instrument_slide1.arts
 
224
 
 
225
instrument_square.arts
 
226
 
 
227
instrument_tri.arts
 
228
 
 
229
Effects
 
230
-------
 
231
 
 
232
effect_delay.arts
 
233
 
 
234
effect_delay_alone.arts
 
235
 
 
236
effect_flanger_alone.arts
 
237
 
 
238
Templates
 
239
---------
 
240
 
 
241
template_Empty_Structure.arts
 
242
 
 
243
template_Instrument.arts
 
244
 
 
245
template_Instrument_GUI.arts
 
246
 
 
247
template_Mixer_Element.arts
 
248
 
 
249
Mixer Elements
 
250
--------------
 
251
 
 
252
mixer_element_simple.arts
 
253
 
 
254
mixer_element_eq.arts
 
255
 
 
256
mixer_element_eqfx.arts