From 3083b7fbe2bc6e8dcd935b10bb7a165257c5252b Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 18 Jan 2016 05:18:09 +0000 Subject: doc: convert to perlpod(1) from Markdown perlpod(1) is already installed by default on Debian and RedHat-based systems; and probably most modern *nixes; pandoc(1) (and Haskell) are not. POD also more standardized than Markdown (which flavor? :P), especially for generating manpages. So save any potential documentation editors some disk space by not forcing them to install Haskell and pandoc. Finally, I'm a mildly proficient in Perl and do not know Haskell at all and have a better chance at reading/hacking the source if the document generator breaks. --- Documentation/dtas-player_effects.pod | 103 ++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 Documentation/dtas-player_effects.pod (limited to 'Documentation/dtas-player_effects.pod') diff --git a/Documentation/dtas-player_effects.pod b/Documentation/dtas-player_effects.pod new file mode 100644 index 0000000..149834a --- /dev/null +++ b/Documentation/dtas-player_effects.pod @@ -0,0 +1,103 @@ +% dtas-player_effects(7) dtas user manual + +=head1 NAME + +L effects overview + +=head1 DESCRIPTION + +Effects in dtas-player may be applied either at the source or the sink. +They are applied in the order described. + +=over + +=item 1. source effects + +Source effects are effects which should be applied per-source and do not +rely on inter-track information. + +Examples include: + +=over + +=item ReplayGain (simple gain changes) + +=item anything which does not change the length of the audio: + +gain, stereo, highpass, lowpass, loudness, bass, treble, equalizer, ... + +=back + +Modifying source effects should introduce no extra gaps in playback. +Effects which modify the length of the audio is not recommended here, +as seek functionality will be impaired. + +=item 2. sink effects + +Sink effects are any effects which: + +=over + +=item 1) should only be applied to a specific sink + +=item 2) effects which require inter-track information + +(multiband delays/compressors/expanders) + +=item 3) alter the length of the audio + +=back + +In a multi-zone audio system (where each zone has its own sink), sink +effects may also customize the sound of a certain zone while not +affecting others. + +Examples include: + +=over + +=item equalizer effects (highpass/bass/treble/equalizer) + +=item loudness + +=item delaying a certain channel or frequency range for time-alignment + +=item compressors/limiters + +=item reverb + +=item gain + +=item remix (for stereo image adjustments) + +=back + +Additionally, effects which are necessary due to the limitation of the +playback hardware are applied at the sink: + +=over + +=item rate + +=item dither + +=item remix (static channel mappings) + +=back + +=back + +=head1 CONTACT + +All feedback welcome via plain-text mail to: L + +Mailing list archives available at L +and L + +No subscription is necessary to post to the mailing list. + +=head1 COPYRIGHT + +Copyright 2013-2016 all contributors L + +License: GPL-3.0+ L -- cgit v1.2.3-24-ge0c7