README
1padthv1 - an old-school polyphonic additive synthesizer
2-------------------------------------------------------
3
4 an old-school polyphonic additive synthesizer with stereo fx.
5
6 based on the PADsynth algorithm, by Paul Nasca, as a special
7 variant of additive synthesis.
8
9 cf. https://zynaddsubfx.sourceforge.net/doc/PADsynth/PADsynth.htm
10
11Features:
12
13 - pure stand-alone JACK [1] client with JACK-session, NSM [3] and both
14 JACK MIDI and ALSA MIDI [2] input support;
15
16 - LV2 [4] instrument plugin.
17 URI: http://padthv1.sourceforge.net/lv2
18
19License:
20
21 padthv1 is free, Linux Audio [5] open-source software, distributed under
22 the terms of the GNU General Public License (GPL) [6] version 2 or later.
23
24Website:
25
26 https://padthv1.sourceforge.io
27 http://padthv1.sourceforge.net
28
29Project page:
30
31 https://sourceforge.net/projects/padthv1
32
33Git repos:
34
35 https://git.code.sf.net/p/padthv1/code
36 https://github.com/rncbc/padthv1.git
37 https://gitlab.com/rncbc/padthv1.git
38 https://bitbucket.org/rncbc/padthv1.git
39
40Weblog:
41
42 https://www.rncbc.org
43
44Requirements:
45
46 mandatory,
47
48 - Qt framework [7], C++ class library and tools for
49 cross-platform application and UI development
50 https://qt.io/
51
52 - FFTW3 [9], a C library for computing the discrete
53 Fourier transform (DFT) in one or more dimensions
54 http://www.fftw.org
55
56 optional (opted-in at build time),
57
58 - JACK [1] Audio Connection Kit
59 https://jackaudio.org/
60
61 - ALSA [2], Advanced Linux Sound Architecture
62 https://www.alsa-project.org/
63
64 - LV2 [4], Audio Plugin Standard, the extensible successor of LADSPA
65 https://lv2plug.in/
66
67 - liblo [8], Lightweight OSC implementation
68 (needed for NSM support [3])
69 http://liblo.sourceforge.net/
70
71Installation:
72
73 - unpack tarball as usual; in the extracted source directory:
74
75 cmake [-DCMAKE_INSTALL_PREFIX=/usr/local] -B build -S .
76 make -C build
77
78 - optionally, as root:
79
80 sudo make -C build install
81
82 - see also the README.cmake file in the source distribution.
83
84Acknowledgements:
85
86 drumkv1 logo/icon is an original fine work of Jarle Richard Akselsen.
87
88References:
89
90 [1] JACK Audio Connection Kit
91 https://jackaudio.org/
92
93 [2] ALSA, Advanced Linux Sound Architecture
94 https://www.alsa-project.org/
95
96 [3] Non Session Management (NSM)
97 http://non.tuxfamily.org/nsm/
98
99 [4] LV2, Audio Plugin Standard, the extensible successor of LADSPA
100 http://lv2plug.in/
101
102 [5] Linux Audio consortium of libre software for audio-related work
103 https://linuxaudio.org
104
105 [6] GNU General Public License
106 https://www.gnu.org/copyleft/gpl.html
107
108 [7] Qt framework, C++ class library and tools for
109 cross-platform application and UI development
110 https://qt.io/
111
112 [8] liblo [8], Lightweight OSC implementation
113 (needed for NSM support)
114 http://liblo.sourceforge.net/
115
116 [9] FFTW3, a C library for computing the discrete
117 Fourier transform (DFT) in one or more dimensions
118 http://www.fftw.org
119
120
121Cheers && Enjoy.
122--
123rncbc aka. Rui Nuno Capela
124rncbc at rncbc dot org
125https://www.rncbc.org
126
README.cmake
1What is CMake?
2==============
3
4CMake is a cross platform build system, that can be used to replace the old
5auto-tools, providing a nice building environment and advanced features.
6
7Some of these features are:
8* Out of sources build: CMake allows you to build your software into a directory
9 different to the source tree. You can safely delete the build directory and
10 all its contents once you are done.
11* Multiple generators: classic makefiles can be generated for Unix and MinGW,
12 but also Visual Studio, XCode and Eclipse CDT projects among other types.
13* Graphic front-ends for configuration and build options.
14
15More information and documentation is available at the CMake project site:
16 http://www.cmake.org
17
18CMake is free software. You can get the sources and pre-compiled packages for
19Linux and other systems at:
20 http://www.cmake.org/cmake/resources/software.html
21
22How to use it?
23==============
24
251. You need CMake 3.13 or newer to build padthv1
26
272. Unpack the padthv1 sources somewhere, or checkout the repository,
28 and create a build directory. For instance, using a command line shell:
29
30$ tar -xvzf Downloads/padthv1-x.y.z.tar.gz
31$ cd padthv1-x.y.z
32$ mkdir build
33
342. Execute CMake from the build directory, providing the source directory
35 location and optionally, the build options. There are several ways.
36
37* From a command line shell:
38
39$ pwd
40padthv1-x.y.z
41$ cd build
42$ cmake -DCMAKE_BUILD_TYPE=debug ..
43
443. Execute the build command. If you used the Makefiles generator (the default
45 in Linux and other Unix systems) then execute make, gmake, or mingw32-make.
46 If you generated a project file, use your IDE to build it.
47
48Compiling with make
49===================
50
51There are many targets available. To see a complete list of them, type:
52
53$ make help
54
55The build process usually hides the compiler command lines, to show them:
56
57$ make VERBOSE=1
58
59There is a "clean" target, but not a "distclean" one. You should use a build
60directory different to the source tree. In this case, the "distclean" target
61would be equivalent to simply removing the build directory.
62
63If something fails
64==================
65
66If there is an error message while executing CMake, this probably means that a
67required package is missing in your system. You should install the missing
68component and run CMake again.
69
70If there is an error executing the build process, after running a flawless CMake
71configuration process, this means that there may be an error in the source code,
72or in the build system, or something incompatible in 3rd party libraries.
73