README
1Qsampler - A LinuxSampler Qt GUI Interface
2------------------------------------------
3
4Qsampler is a LinuxSampler GUI front-end application written in C++ around
5the Qt framework using Qt Designer. At the moment it just wraps as a client
6reference interface for the LinuxSampler Control Protocol (LSCP).
7
8LinuxSampler is a work in progress. The goal is to produce a free, open source
9pure software audio sampler with professional grade features, comparable to
10both hardware and commercial Windows/Mac software samplers.
11
12The initial platform will be Linux because it is one of the most promising
13open source multimedia operating systems. Thanks to various kernel patches
14and the Jack Audio Connection Kit, Linux is currently able to deliver rock
15solid sub-5 millisecond MIDI-to-Audio response.
16
17Homepage: https://qsampler.sourceforge.io
18 http://qsampler.sourceforge.net
19
20See also: https://www.linuxsampler.org
21
22License: GNU General Public License (GPL)
23
24
25Requirements
26------------
27
28The software requirements for build and runtime are listed as follows:
29
30 Mandatory:
31
32 - Qt framework, C++ class library and tools for
33 cross-platform application and UI development
34 https://qt.io/
35
36 - liblscp, C library for LinuxSampler control protocol API.
37 https://www.linuxsampler.org/
38
39 Optional (opted-in at build time):
40
41 - libgig, C++ library for loading and modifying Gigasampler and DLS files.
42 https://www.linuxsampler.org/libgig/
43
44
45Installation
46------------
47
48Unpack the tarball and in the extracted source directory:
49
50 cmake [-DCMAKE_INSTALL_PREFIX=/usr/local] -B build -S .
51 make -C build
52
53and optionally as root:
54
55 sudo make -C build install
56
57See also the README.cmake file in the source distribution.
58
59
60Configuration
61-------------
62
63Qsampler holds its settings and configuration state per user, in a
64file located as $HOME/.config/linuxsampler.org/Qsampler.conf .
65Normally, there's no need to edit this file, as it is recreated and
66rewritten everytime qsampler is run.
67
68
69Bugs
70----
71
72Plenty as this is still alpha software. Bug reports should be posted on
73LinuxSampler bug tracker (https://bugs.linuxsampler.org).
74
75
76Support
77-------
78
79Qsampler is open source free software. For bug reports, feature requests,
80discussion forums, mailling lists, or any other matter related to the
81development of this piece of software, please use the LinuxSampler project
82site (https://www.linuxsampler.org).
83
84
85Enjoy.
86
87rncbc aka Rui Nuno Capela
88rncbc at rncbc dot org
89https://www.rncbc.org
90
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 Qsampler
26
272. Unpack the Qsampler sources somewhere, or checkout the repository,
28 and create a build directory. For instance, using a command line shell:
29
30$ tar -xvzf Downloads/qsampler-x.y.z.tar.gz
31$ cd qsampler-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
40qsampler-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