~ubuntu-branches/ubuntu/utopic/glame/utopic

« back to all changes in this revision

Viewing changes to doc/glame.info-3

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Kobras
  • Date: 2002-04-09 17:14:12 UTC
  • Revision ID: james.westby@ubuntu.com-20020409171412-jzpnov7mbz2w6zsr
Tags: upstream-0.6.2
ImportĀ upstreamĀ versionĀ 0.6.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
This is glame.info, produced by makeinfo version 4.1 from glame.texi.
 
2
 
 
3
INFO-DIR-SECTION Sound
 
4
START-INFO-DIR-ENTRY
 
5
* GLAME: (glame).          GNU/Linux Audio Mechanics-A capable audio editor.
 
6
END-INFO-DIR-ENTRY
 
7
 
 
8
 
 
9
File: glame.info,  Node: Distortion,  Prev: Flanger,  Up: Effects
 
10
 
 
11
Distortion
 
12
----------
 
13
 
 
14
The distortion effect simulates a MOSFET preamplifier with adjustable
 
15
clipping. With a mode parameter one can switch between a halfwave and a
 
16
fullwave rectifying output stage.
 
17
 
 
18
`distortion' ports
 
19
..................
 
20
 
 
21
`in (input)'
 
22
     Input stream of sample data. Only one connection is allowed.
 
23
 
 
24
`out (output)'
 
25
     Output stream of processed sample data. Only one connection is
 
26
     allowed.
 
27
 
 
28
`distortion' parameters
 
29
.......................
 
30
 
 
31
`pregain (float)'
 
32
     This parameters set the amount of signal gain before the signals
 
33
     enters the distortion stage.  The more pregain you set the more
 
34
     dramatic the distortion becomes. Good values are between 10.0 and
 
35
     20.0, defaults to 10.0
 
36
 
 
37
`fxgain (float)'
 
38
     The distorted signal and the dry signal are mixed at the output.
 
39
     fxgain sets the amount of effect signal added to the dry signal,
 
40
     defaults to 1.0
 
41
 
 
42
`clip, asym (float)'
 
43
     asym sets the signal midlevel for clipping. In mode 0 the signal
 
44
     is clipped if it's smaller than asym-clip or greater than
 
45
     asym+clip, e.g. clip=0.5 and asym=0.5 simulates a halfwave
 
46
     rectifier. Setting these values allows you to modify the harmonic
 
47
     content of the distorted signal. In mode 1 the signal is fully
 
48
     rectified and clipped at level <clip>.
 
49
 
 
50
`mode (int)'
 
51
 
 
52
    `0 enables asymmetrical clipping mode'
 
53
 
 
54
    `1 enables fullwave rectifying mode'
 
55
 
 
56
File: glame.info,  Node: FFT Plugins,  Next: Operations,  Prev: Effects,  Up: Plugin Collection
 
57
 
 
58
FFT Plugins
 
59
===========
 
60
 
 
61
Glame provides a simple framework of FFT filters to allow for the
 
62
application of effects in the frequency domain of sample sounds. The
 
63
core plugins are fft and ifft using the specially designed FFT protocol
 
64
which supports adjustable FFT blocksizes and oversampling. All FFT
 
65
processing is done based on the fftw (<http://www.fftw.org>) library.
 
66
 
 
67
* Menu:
 
68
 
 
69
* FFT::
 
70
* IFFT::
 
71
* FFT Resample::
 
72
* FFT Bandpass::
 
73
* FFT Equalizer::
 
74
 
 
75
 
 
76
File: glame.info,  Node: FFT,  Next: IFFT,  Up: FFT Plugins
 
77
 
 
78
fft
 
79
---
 
80
 
 
81
`fft' ports
 
82
...........
 
83
 
 
84
`in (input)'
 
85
     Input stream of sample data. Only one connection is allowed.
 
86
 
 
87
`out (output)'
 
88
     Output stream of fft data. Only one connection is allowed.
 
89
 
 
90
`fft' parameters
 
91
................
 
92
 
 
93
`blocksize (int)'
 
94
     This parameter sets the blocksize for the FFT. The higher the
 
95
     value the better the frequency resolution of the transformation.
 
96
 
 
97
`oversamp (int)'
 
98
     To enhance the time resolution of the signal and thereby the
 
99
     quality of the resynthesized sound it is necessary to do
 
100
     oversampling. A good factor is the default value of 8.
 
101
 
 
102
 
 
103
File: glame.info,  Node: IFFT,  Next: FFT Resample,  Prev: FFT,  Up: FFT Plugins
 
104
 
 
105
ifft
 
106
----
 
107
 
 
108
`ifft' ports
 
109
............
 
110
 
 
111
`in (input)'
 
112
     Input stream of fft data. Only one connection is allowed.
 
113
 
 
114
`out (output)'
 
115
     Output stream of sample data. Only one connection is allowed.
 
116
 
 
117
`ifft' parameters
 
118
.................
 
119
 
 
120
The ifft plugin doesn't need any parameters. blocksize and oversampling
 
121
factor are taken from the pipe properties.
 
122
 
 
123
 
 
124
File: glame.info,  Node: FFT Resample,  Next: FFT Bandpass,  Prev: IFFT,  Up: FFT Plugins
 
125
 
 
126
fft_resample
 
127
------------
 
128
 
 
129
Implements a resampler in the frequency domain.
 
130
 
 
131
`fft_resample' ports
 
132
....................
 
133
 
 
134
`in (input)'
 
135
     Input stream of fft data. Only one connection is allowed.
 
136
 
 
137
`out (output)'
 
138
     Output stream of resampled fft data. Only one connection is
 
139
     allowed.
 
140
 
 
141
`fft_resample' parameters
 
142
.........................
 
143
 
 
144
`frequency (int)'
 
145
     Frequency of resampled stream.
 
146
 
 
147
 
 
148
File: glame.info,  Node: FFT Bandpass,  Next: FFT Equalizer,  Prev: FFT Resample,  Up: FFT Plugins
 
149
 
 
150
fft_bandpass
 
151
------------
 
152
 
 
153
Implements a bandpass filter in the frequency domain.
 
154
 
 
155
`fft_bandpass' ports
 
156
....................
 
157
 
 
158
`in (input)'
 
159
     Input stream of fft data. Only one connection is allowed.
 
160
 
 
161
`out (output)'
 
162
     Output stream of processed fft data. Only one connection is
 
163
     allowed.
 
164
 
 
165
`fft_bandpass' parameters
 
166
.........................
 
167
 
 
168
`band minimum (float)'
 
169
     Minimum of passband in Hz.
 
170
 
 
171
`band maximum (float)'
 
172
     Maximum of passband in Hz.
 
173
 
 
174
`gain (float)'
 
175
     Gain in dB of passband.
 
176
 
 
177
 
 
178
File: glame.info,  Node: FFT Equalizer,  Prev: FFT Bandpass,  Up: FFT Plugins
 
179
 
 
180
fft_equalizer
 
181
-------------
 
182
 
 
183
Implements a five band equalizer in the frequency domain. It features a
 
184
low, midlow, mid, midhigh and high band which are equally distributed
 
185
over the frequency range.  This distribution is not really usable, but
 
186
it's a proove of concept at the present time..
 
187
 
 
188
`fft_equalizer' ports
 
189
.....................
 
190
 
 
191
`in (input)'
 
192
     Input stream of fft data. Only one connection is allowed.
 
193
 
 
194
`out (output)'
 
195
     Output stream of processed fft data. Only one connection is
 
196
     allowed.
 
197
 
 
198
`fft_equalizer' parameters
 
199
..........................
 
200
 
 
201
`low (float)'
 
202
     Gain of low range band (not in dB)
 
203
 
 
204
`midlow (float)'
 
205
     Gain of midlow range band (not in dB)
 
206
 
 
207
`mid (float)'
 
208
     Gain of mid range band (not in dB)
 
209
 
 
210
`midhigh (float)'
 
211
     Gain of midhigh range band (not in dB)
 
212
 
 
213
`high (float)'
 
214
     Gain of high range band (not in dB)
 
215
 
 
216
 
 
217
File: glame.info,  Node: Operations,  Prev: FFT Plugins,  Up: Plugin Collection
 
218
 
 
219
Operations
 
220
==========
 
221
 
 
222
* Menu:
 
223
 
 
224
* Normalize::
 
225
* Fade in/out::
 
226
 
 
227
 
 
228
File: glame.info,  Node: Normalize,  Next: Fade in/out,  Up: Operations
 
229
 
 
230
Normalize
 
231
---------
 
232
 
 
233
The normalize function can be invoked from the main menu or from the
 
234
waveeditor widget.  Normalize scans all given tracks for the highest
 
235
peak in amplitude or the highest RMS peak for a given frequency window.
 
236
You can normalize the signal in three different modes:
 
237
`Peak'
 
238
     The maximum peak is adjusted to 1.0 with a factor given by the 1.0
 
239
     divided by the max. peak.
 
240
 
 
241
`Volume'
 
242
     The maximum peak is adjusted to the given amplitude(either
 
243
     absolute or dB).
 
244
 
 
245
`Volume/Frequency'
 
246
     The signal is scanned for the highest RMS energy in the given
 
247
     frequency and then adjusted to the given amplitude (either
 
248
     absolute or dB).  By pressing the analyze button in the normalize
 
249
GUI, the file is just scanned and the found results are presented in
 
250
the text box. If you don't press analyze, this step is done
 
251
automatically after pressing the ok button.
 
252
 
 
253
 
 
254
File: glame.info,  Node: Fade in/out,  Prev: Normalize,  Up: Operations
 
255
 
 
256
Fade in/out
 
257
-----------
 
258
 
 
259
The fade in (and out) operations fade in (or out) the current selection
 
260
linearly. These operations are only useful if invoked through the
 
261
context menu of the waveedit window.
 
262
 
 
263
 
 
264
File: glame.info,  Node: Function and Type Index,  Prev: Plugin Collection,  Up: Top
 
265
 
 
266
Function and Type Index
 
267
***********************
 
268
 
 
269
* Menu:
 
270
 
 
271
* filter->string:                        Scheme Filter API.
 
272
* filter-add-node:                       Scheme Filter API.
 
273
* filter-connect:                        Scheme Filter API.
 
274
* filter-delete:                         Scheme Filter API.
 
275
* filter-launch:                         Scheme Filter API.
 
276
* filter-name:                           Scheme Filter API.
 
277
* filter-new:                            Scheme Filter API.
 
278
* filter-nodes:                          Scheme Filter API.
 
279
* filter-params:                         Scheme Filter API.
 
280
* filter-pause:                          Scheme Filter API.
 
281
* filter-ports:                          Scheme Filter API.
 
282
* filter-start:                          Scheme Filter API.
 
283
* filter-terminate:                      Scheme Filter API.
 
284
* filter-wait:                           Scheme Filter API.
 
285
* filter?:                               Scheme Filter API.
 
286
* filternetwork-add-input:               Scheme Filter API.
 
287
* filternetwork-add-output:              Scheme Filter API.
 
288
* filternetwork-add-param:               Scheme Filter API.
 
289
* get-property:                          Scheme Filter API.
 
290
* glame_create_plugin:                   Scheme Filter API.
 
291
* glame_plugin_define:                   Scheme Filter API.
 
292
* gpsm-close:                            Scheme GPSM API.
 
293
* gpsm-grp-hbox?:                        Scheme GPSM API.
 
294
* gpsm-grp-items:                        Scheme GPSM API.
 
295
* gpsm-grp-vbox?:                        Scheme GPSM API.
 
296
* gpsm-grp?:                             Scheme GPSM API.
 
297
* gpsm-hbox-can-insert?:                 Scheme GPSM API.
 
298
* gpsm-hbox-cut:                         Scheme GPSM API.
 
299
* gpsm-hbox-insert:                      Scheme GPSM API.
 
300
* gpsm-init:                             Scheme GPSM API.
 
301
* gpsm-invalidate-swapfile:              Scheme GPSM API.
 
302
* gpsm-item-can-place?:                  Scheme GPSM API.
 
303
* gpsm-item-destroy:                     Scheme GPSM API.
 
304
* gpsm-item-hposition:                   Scheme GPSM API.
 
305
* gpsm-item-hsize:                       Scheme GPSM API.
 
306
* gpsm-item-label:                       Scheme GPSM API.
 
307
* gpsm-item-parent:                      Scheme GPSM API.
 
308
* gpsm-item-place:                       Scheme GPSM API.
 
309
* gpsm-item-remove:                      Scheme GPSM API.
 
310
* gpsm-item-set-label!:                  Scheme GPSM API.
 
311
* gpsm-item-vposition:                   Scheme GPSM API.
 
312
* gpsm-item-vsize:                       Scheme GPSM API.
 
313
* gpsm-item?:                            Scheme GPSM API.
 
314
* gpsm-newgrp:                           Scheme GPSM API.
 
315
* gpsm-newswfile:                        Scheme GPSM API.
 
316
* gpsm-notify-swapfile-change:           Scheme GPSM API.
 
317
* gpsm-notify-swapfile-cut:              Scheme GPSM API.
 
318
* gpsm-notify-swapfile-insert:           Scheme GPSM API.
 
319
* gpsm-op-can-redo?:                     Scheme GPSM API.
 
320
* gpsm-op-can-undo?:                     Scheme GPSM API.
 
321
* gpsm-op-forget:                        Scheme GPSM API.
 
322
* gpsm-op-prepare:                       Scheme GPSM API.
 
323
* gpsm-op-redo:                          Scheme GPSM API.
 
324
* gpsm-op-redo-and-forget:               Scheme GPSM API.
 
325
* gpsm-op-undo:                          Scheme GPSM API.
 
326
* gpsm-op-undo-and-forget:               Scheme GPSM API.
 
327
* gpsm-root:                             Scheme GPSM API.
 
328
* gpsm-swfile-cow:                       Scheme GPSM API.
 
329
* gpsm-swfile-filename:                  Scheme GPSM API.
 
330
* gpsm-swfile-link:                      Scheme GPSM API.
 
331
* gpsm-swfile-position:                  Scheme GPSM API.
 
332
* gpsm-swfile-samplerate:                Scheme GPSM API.
 
333
* gpsm-swfile-set-position!:             Scheme GPSM API.
 
334
* gpsm-swfile-set-samplerate!:           Scheme GPSM API.
 
335
* gpsm-swfile?:                          Scheme GPSM API.
 
336
* gpsm-sync:                             Scheme GPSM API.
 
337
* gpsm-vbox-can-insert?:                 Scheme GPSM API.
 
338
* gpsm-vbox-cut:                         Scheme GPSM API.
 
339
* gpsm-vbox-insert:                      Scheme GPSM API.
 
340
* net-add-node:                          Network setup.
 
341
* net-add-nodes:                         Network setup.
 
342
* net-new:                               Network setup.
 
343
* net-run:                               Network setup.
 
344
* net-run-bg:                            Network setup.
 
345
* node-set-params:                       Network setup.
 
346
* nodes-connect:                         Network setup.
 
347
* nodes-delete:                          Network setup.
 
348
* param->string:                         Scheme Filter API.
 
349
* param-delete:                          Scheme Filter API.
 
350
* param-label:                           Scheme Filter API.
 
351
* param-set!:                            Scheme Filter API.
 
352
* param-value:                           Scheme Filter API.
 
353
* param?:                                Scheme Filter API.
 
354
* pipe-delete:                           Scheme Filter API.
 
355
* pipe-dest-params:                      Scheme Filter API.
 
356
* pipe-fft?:                             Scheme Filter API.
 
357
* pipe-position:                         Scheme Filter API.
 
358
* pipe-sample?:                          Scheme Filter API.
 
359
* pipe-samplerate:                       Scheme Filter API.
 
360
* pipe-source-params:                    Scheme Filter API.
 
361
* pipe-ssp?:                             Scheme Filter API.
 
362
* pipe?:                                 Scheme Filter API.
 
363
* play:                                  Cooked operations.
 
364
* play-eff:                              Cooked operations.
 
365
* plugin-add-path:                       Scheme Plugin API.
 
366
* plugin-get:                            Scheme Plugin API.
 
367
* plugin-name:                           Scheme Plugin API.
 
368
* plugin-query:                          Scheme Plugin API.
 
369
* plugin-set!:                           Scheme Plugin API.
 
370
* plugin?:                               Scheme Plugin API.
 
371
* port-delete:                           Scheme Filter API.
 
372
* port-label:                            Scheme Filter API.
 
373
* port-params:                           Scheme Filter API.
 
374
* port-pipes:                            Scheme Filter API.
 
375
* port?:                                 Scheme Filter API.
 
376
* save-eff:                              Cooked operations.
 
377
* set-property!:                         Scheme Filter API.
 
378
* sw-close:                              Scheme Swapfile API.
 
379
* sw-closedir:                           Scheme Swapfile API.
 
380
* sw-fstat:                              Scheme Swapfile API.
 
381
* sw-ftruncate:                          Scheme Swapfile API.
 
382
* sw-lseek:                              Scheme Swapfile API.
 
383
* sw-open:                               Scheme Swapfile API.
 
384
* sw-opendir:                            Scheme Swapfile API.
 
385
* sw-read-floatvec:                      Scheme Swapfile API.
 
386
* sw-read-string:                        Scheme Swapfile API.
 
387
* sw-readdir:                            Scheme Swapfile API.
 
388
* sw-sendfile:                           Scheme Swapfile API.
 
389
* sw-unlink:                             Scheme Swapfile API.
 
390
* sw-write:                              Scheme Swapfile API.
 
391
* swapfile-close:                        Scheme Swapfile API.
 
392
* swapfile-creat:                        Scheme Swapfile API.
 
393
* swapfile-open:                         Scheme Swapfile API.
 
394
* swdir?:                                Scheme Swapfile API.
 
395
* swfd?:                                 Scheme Swapfile API.
 
396
 
 
397