README
1Files in this directory:
2
3 - coverage
4 configure guitarix with --with-coverage, build it and run guitarix
5 with some tests. Then call this script to see the list of unused
6 functions. Starting guitarix again adds more coverage data.
7
8 - waf-1.5.18.tar.bz2, gcov.py
9 the distributed waf is build from the archive with
10 $ tar -xjf waf-1.5.18.tar.bz2
11 $ cp gcov.py waf-1.5.18/wafadmin/Tools/
12 $ cd waf-1.5.18
13 $ ./waf-light --make-waf --nopyc
14 $ ls -l waf
15
16 - search_all
17 search all relevant guitarix source files for function names,
18 variable names etc. Fits nicely with Emacs grep (see below).
19
20 - tubestage.dsp
21 faust module as test case for build-module (core tube stage
22 copied from the faust directory)
23
24 - convert-0.06-format
25 script to convert very old guitarix state file format
26
27 - freq-plot
28 make a frequency plot from a faust module (you can set
29 faust parameters as options). Needs octave.
30
31 - tube_transfer.py
32 script to calculate tables, approximation accuracy etc.
33 for the tube transfer functions
34
35 - tubestage_calc.py
36 script to calculate various things (e.g. execution time, output
37 voltage for 0 input) for a tube stage faust dsp module (you need to
38 run build-module on tubestage.dsp first).
39
40 - gxglade
41 script to start glade with GxWidget support (needed to use the
42 .glade files of this project with glade)
43
44 - dsp2cc
45 convert the C++ output of faust into the form used by
46 guitarix. Used by build process.
47
48 - gen_regler_marshal
49 script build libgxw/gxw/regler_marshal.cc
50
51 - lv2loader.py
52 loads a LV2 plugin.
53
54 - lilv.py
55 included for convenience. It's part of lilv, but not included by
56 all distributions (http://drobilla.net/software/lilv)
57
58 - ts9sim.py, ts9func.pyx
59 simulates a Ibanez TS9 tube screamer
60
61 - dunwah1.py, dunwah2.py
62 analyzes the crybaby2 physical modeling LV2 plugin and produces a
63 simpler linear representation (2 different methods)
64 crybaby2 is written by Martin Holters, the source can be downloaded
65 from:
66 https://www.hsu-hh.de/ant/mitarbeiter/martin-holters/wah-wah-simulation
67 (debian) package dependencies:
68 gfortran, libgsl-dev, python3-scipy, python3-matplotlib,
69 octave, octave-signal
70
71----------------- Python module builder ------------------------
72
73 - the .pyx module sources need cython3
74
75 - build-module, faustmod.pyx, pythonmodule.cpp
76 build python modules directly from faust sources (e.g. for
77 analytical processing). Uses faustmod.pyx
78
79 - build-pluginloader, pluginloader.pyx, pluginloader.h
80 build a python module pluginloader.so which loads Guitarix
81 plugins
82
83 - build-ladspaloader, ladspaloader.pyx
84 build a python module ladspaloader.so which loads LADSPA
85 plugins
86
87----------------- Guitarix module builder ----------------------
88
89 - build-cmodule
90 build a Guitarix module from a c source
91
92 - build-faust
93 build a Guitarix module from a faust source
94
95 - example.py
96 example how to use modules in python
97 run with "./build-cmodule example_plugin.cc && python example.py"
98
99 - pyrun-fixed
100 can be used instead of just python to get a better controlled
101 runtime environment for execution timing (2nd part of example.py)
102
103----------------------------------------------------------------
104
105Emacs support:
106
107File ".dirlocals.el" in the trunk root (replace "~/guitarix/trunk"
108with your path to guitarix svn trunk):
109----------------------------------
110;;; Directory Local Variables
111;;; See Info node `(emacs) Directory Variables' for more information.
112
113((nil
114 (compile-command . "(cd ~/guitarix/trunk && ./waf)")
115 (grep-command . "~/guitarix/trunk/tools/search_all "))
116 (c++-mode
117 (c-file-offsets . ((innamespace . 0)))
118 (c-file-style . "cc-mode"))
119 (c-mode
120 (mode . c++)
121 (c-file-offsets . ((innamespace . 0)))
122 (c-file-style . "cc-mode")))
123----------------------------------
124
125and for your .emacs (add to existing custum-set-variables):
126
127(custom-set-variables
128 '(safe-local-variable-values (quote ((grep-command . "~/guitarix/trunk/tools/search_all ") (c-file-offsets (innamespace . 0)))))
129)
130