README.md
1# B.Slizr
2formerly known as B.Slicer
3
4Description: LV2 audio effect plugin for chopping stereo audio input signals. Each chop can be levelled up or down to get a step sequencer-like effect.
5
6
7
8
9##Installation
10
11a) Install the bslizr package for your system
12* [Arch linux](https://www.archlinux.org/packages/community/x86_64/bslizr/) by David Runge
13* [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/audio/bslizr/default.nix) by Bart Brouns
14* [openSUSE](https://software.opensuse.org/package/BSlizr)
15* [Ubuntu](https://launchpad.net/bslizr) by Eirch Eickmeyer
16* Check https://repology.org/project/bslizr/versions for other systems
17
18b) Build your own binaries in the following three steps.
19
20Step 1: [Download the latest published version](https://github.com/sjaehn/BSlizr/releases) of B.Slizr. Or clone or
21[download the master](https://github.com/sjaehn/BSlizr/archive/master.zip) of this repository.
22
23Step 2: Install pkg-config and the development packages for x11, cairo, and lv2 if not done yet. If you
24don't have already got the build tools (compilers, make, libraries) then install them too.
25
26On Debian-based systems you may run:
27```
28sudo apt-get install build-essential
29sudo apt-get install pkg-config libx11-dev libcairo2-dev lv2-dev
30```
31
32On Arch-based systems you may run:
33```
34sudo pacman -S base-devel
35sudo pacman -S pkg-config libx11 cairo lv2
36```
37
38Step 3: Building and installing into the default lv2 directory (/usr/local/lib/lv2/) is easy using `make` and
39`make install`. Simply call:
40```
41make
42sudo make install
43```
44
45**Optional:** Standard `make` and `make install` parameters are supported. Compiling using `make CPPFLAGS+=-O3`
46is recommended to improve the plugin performance. Alternatively, you may build a debugging version using
47`make CPPFLAGS+=-g`. For installation into an alternative directory (e.g., /usr/lib/lv2/), change the
48variable `PREFIX` while installing: `sudo make install PREFIX=/usr`. If you want to freely choose the
49install target directory, change the variable `LV2DIR` (e.g., `make install LV2DIR=~/.lv2`) or even define
50`DESTDIR`.
51
52**Optional:** Further supported parameters are `LANGUAGE` (two letters code) to change the GUI language and
53`SKIN` to change the skin (see customize).
54
55
56##Running
57
58After the installation Ardour, Carla, and any other LV2 host should automatically detect B.Slizr.
59
60If jalv is installed, you can also call it
61
62```
63jalv.gtk https://www.jahnichen.de/plugins/lv2/BSlizr
64```
65
66to run it stand-alone and connect it to the JACK system.
67
68Notes:
69
70* **Jack transport is required to get information about beat / position**
71* If you use an older version (until v0.3) of this plugin, use the URI https://www.jahnichen.de/plugins/lv2/BSlicer instead.
72
73
74##Usage
75
76The plugin slices a stereo input, amplifies or silences the individual slices and send the whole sequence to the output. Although this affects only the audio signal, it needs a playback running (Jack transport).
77
78The interface is divided into three parts: step controls, monitor and step shape.
79
80
81###Step controls
82
83* Sequences per bar : Number of sequences in one bar (1..8)
84* Number of steps : Number of steps in one sequence (1..16)
85* Step control : Coefficient for sound reduction for each individual step
86
87
88###Monitor
89
90* On/Off switch: Switches monitor and monitor <-> plugin communication on/off. Reduces CPU load.
91* Scale : Scales the visualization of the input / output signal
92* Monitor : Visualization (l + r signal) the input / output signal for a whole sequence
93
94
95###Step shape
96
97* Attack
98* Decay
99* Monitor : Visualization of a single step
100
101
102## Customize
103
104You can create customized builds of B.Slizr using the parameters `LANGUAGE` and `SKIN` (e.g.,
105`make LANGUAGE=RU SKIN=UWU`). To create a new language pack, copy `src/Locale_EN.hpp` and edit
106the text for the respective definitions. But do not change or delete any definition symbol!
107
108To create a new skin, duplicate `src/Skin_Default.hpp`, rename it to `src/Skin_Default.hpp`
109and edit the parameters. You can also provide a background image at `./surface_SkinName.png`.
110
111
112## What's new
113
114* Locales: DE, IT, FR
115* Do not mute if transport stopped
116
117
118## Acknowledgments
119
120* Thanks to LAM and Sahaathyva for translations
121
122## Links
123
124* Video: https://www.youtube.com/watch?v=gLI2ozKdNDk
125
