README

   1 # dtas - duct tape audio suite for *nix
   2
   3 Free Software command-line tools for audio playback, mastering, and
   4 whatever else related to audio.  dtas follows the worse-is-better
   5 philosophy and acts as duct tape to combine existing command-line tools
   6 for flexibility and ease-of-development.  dtas is currently implemented
   7 in Ruby (and some embedded shell), but may use other languages in the
   8 future.
   9
  10 Primary executables available are:
  11
  12 * dtas-player - gapless music player (or pipeline/process manager :P)
  13 * dtas-cueedit - embedded cuesheet editor (FLAC-only for now)
  14 * dtas-splitfx - split audio and apply effects to all tracks
  15
  16 The centerpiece is dtas-player, a gapless music player designed to aid
  17 in writing scripts for sox/ecasound use.  Unlike monolithic music
  18 players, dtas-player is close to a *nix shell in functionality, allowing
  19 for the execution of arbitrary commands as sources, filters, and sinks
  20 for audio.  dtas-player supports:
  21
  22 * any DSP effects offered by SoX, ecasound, LADSPA, LV2, etc..
  23 * multiple outputs for playback (including dumping audio to
  24   files or piping to arbitrary commands)
  25 * ReplayGain (including fallback gain and peak normalization)
  26
  27 dtas-player is a *nix pipeline and process manager.  It may be used
  28 spawn and pipe to arbitrary Unix commands, not just audio-related
  29 commands.  It can interactively restart/replace the source (audio
  30 decoder) component of a pipeline while keeping the sink (playback
  31 endpoint) running.
  32
  33 Users of dtas-player will also be interested in the following scripts:
  34
  35 * dtas-ctl - "raw" command-line scripting interface for dtas-player
  36 * dtas-enq - enqueue files/commands for dtas-player
  37 * dtas-msinkctl - enable/disable multiple sinks with one command
  38 * dtas-console - rudimentary curses interface for dtas-player
  39 * dtas-sinkedit - edit sinks (playback targets) for dtas-player
  40 * dtas-sourceedit - edit source (decoder process parameters) for dtas-player
  41 * dtas-xdelay - alternative sink for dtas-player
  42 * dtas-tl - command-line helpers for tracklist functionality in dtas-player
  43
  44 All scripts have some documentation in the Documentation/ directory or
  45 manpages distributed with the gem.  Documentation is also available on
  46 https://80x24.org/dtas/$COMMAND.txt in plain-text form.
  47
  48 dtas exposes no public APIs outside of command-line and YAML text.  dtas is
  49 aimed at users familiar with the *nix command-line and editing text files.
  50 Familiarity with the Ruby programming language is absolutely NOT required.
  51
  52 Coming:
  53
  54 * mpd (Music Player Daemon) bridge for partial dtas-player control
  55 * MPRIS/MPRIS 2.0 bridge for partial dtas-player control
  56 * whatever command-line tools come to mind...
  57 * better error handling, many bugfixes, etc...
  58 * better documentation
  59
  60 ## Source code
  61
  62   git clone https://80x24.org/dtas.git
  63
  64 Please use git-format-patch(1) and git-send-email(1) distributed with
  65 the git(7) suite for generating and sending patches.  Please format
  66 pull requests with the git-request-pull(1) script (also distributed
  67 with git(7)) and send them via email to <dtas-all@nongnu.org>.
  68
  69 See https://www.git-scm.com/ for more information on git.
  70
  71 ## Contact
  72
  73 All feedback (comments, results, feature requests, bug reports, patches,
  74 pull-requests) via plain-text mail to the mailing list is very much
  75 appreciated.
  76
  77 Please send plain-text mail to the list at <dtas-all@nongnu.org>
  78 HTML mail will not be read.  dtas is for GUI-phobes, by GUI-phobes.
  79 Mailing list archives available at <https://80x24.org/dtas-all/> or
  80 <https://lists.gnu.org/archive/html/dtas-all/>.
  81
  82 No subscription is necessary to post to the mailing list.
  83 You may also read via:
  84 NNTP: <nntps://news.public-inbox.org/inbox.comp.audio.dtas>
  85         <nntp://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.audio.dtas>
  86         <nntp://news.gmane.io/gmane.comp.audio.dtas.general>
  87 IMAP: <imaps://;AUTH=ANONYMOUS@public-inbox.org/inbox.comp.audio.dtas.0>
  88         <imap://;AUTH=ANONYMOUS@7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.audio.dtas.0>
  89 Atom: <https://80x24.org/dtas-all/new.atom>
  90         <http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/dtas-all/new.atom>
  91 (.onion URLs require Tor: <https://www.torproject.org/>)
  92
  93 ## Copyright
  94
  95 Copyright all contributors <dtas-all@nongnu.org>
  96 License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
  97
  98 dtas is copyrighted Free Software by all contributors, see logs
  99 in revision control for names and email addresses of all of them.
 100
 101 dtas is free software; you can redistribute it and/or modify it
 102 under the terms of the GNU General Public License as published by the
 103 Free Software Foundation; either version 3 of the License, or (at your
 104 option) any later version.
 105
 106 dtas is distributed in the hope that it will be useful, but WITHOUT ANY
 107 WARRANTY; without even the implied warranty of MERCHANTABILITY or
 108 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 109 for more details.
 110
 111 You should have received a copy of the GNU General Public License along
 112 with this program; if not, see https://www.gnu.org/licenses/gpl-3.0.txt
 113
 114 Note: The GPL does not and can not apply to external commands run by
 115 dtas scripts, so users _may_ run any non-Free Software they want via dtas
 116 (just like one may do so via bash).  However, the dtas project does not
 117 endorse or support the use of any non-Free Software.