README.md

   1 jack_mixer -- Jack Audio Mixer
   2 ==============================
   3
   4 **jack_mixer** is a GTK+ JACK audio mixer app with a look & handling similar to
   5 hardware mixing desks. It has lot of useful features, apart from being able to
   6 mix multiple JACK audio streams.
   7
   8 It is licensed under GPL version 2 (or later), check the file [COPYING] for
   9 more information.
  10
  11 Please visit the project's homepage at https://rdio.space/jackmixer/ for more
  12 information.
  13
  14
  15 ## Installation
  16
  17 To build and install jack_mixer run:
  18
  19 ```console
  20 meson builddir --prefix=/usr --buildtype=release
  21 meson compile -C builddir
  22 [sudo] meson install -C builddir
  23 ```
  24
  25 Please read the file [INSTALL.md] for more information and requirements.
  26
  27
  28 ## Using MIDI CCs to control jack_mixer
  29
  30 MIDI Control Change messages (CCs) can be used to control volume,
  31 balance/panorama, mute, and solo of input and output channels.
  32
  33 The default controllers for added channels are chosen using a predefined
  34 algorithm: the first free controller starting from #11, first for volume, next
  35 for balance/panorama, then mute and finally solo.
  36
  37 So, if you don't delete channels, CC#11 will control the first channel's
  38 volume, CC#12 the balance/panorama, CC#13 the mute and CC#14 the solo switch.
  39 CC#15 will control the second channel' volume, CC#16 it's balance/panorama, and
  40 so on.
  41
  42 It is also possible to set other CCs when creating a channel, or afterwards
  43 from the channel properties dialog (accessible from the menu or by double
  44 clicking on the channel name).
  45
  46 MIDI CC values (0-127) are mapped to dBFS using the current slider scale for
  47 the corresponding channel.
  48
  49
  50 ## Authors and Acknowledgements
  51
  52 jack_mixer was initially written and supported by Nedko Arnaudov, it is now
  53 maintained by Frédéric Péters. For a list of contributors see the file
  54 [AUTHORS].
  55
  56 K-meter implementation taken from jkmeter, licensed under the GPL 2, by Fons
  57 Adriaensen.
  58
  59
  60 ## Feedback and Contributing
  61
  62 If you have trouble getting jack_mixer working, find a bug or you miss some
  63 feature, please [create an issue] on GitHub or contact the maintainer by email.
  64
  65 You can reach Frédéric at `fpeters (a.t) 0d (dot) be`, and Nedko at
  66 `nedko (a.t) arnaudov (dot) name`. Most recently, the primary developers are
  67 Daniel Sheeler at `dsheeler (a.t) pobox (dot) com` and Christopher Arndt at
  68 `chris (a.t) chrisarndt (dot) de`, and you can also usually find these folks in
  69 `#jack_mixer` or `#lad` on FreeNode (as *fpeters*, *nedko*, *dsheeler* and
  70 *strogon14*).
  71
  72 If you want to get involved with jack_mixer's development, documentation or
  73 translation, please read the [contributing guide].
  74
  75
  76 [AUTHORS]: ./AUTHORS
  77 [COPYING]: ./COPYING
  78 [INSTALL.md]: ./INSTALL.md
  79 [contributing guide]: ./docs/CONTRIBUTING.md
  80 [create an issue]: https://github.com/jack-mixer/jack_mixer/issues