| 1 | .\" -*-nroff-*- |
| 2 | .\" |
| 3 | .\" Copyright (C) 2007, 2008 Richard Kettlewell |
| 4 | .\" Copyright (C) 2016 Mark Wooding |
| 5 | .\" |
| 6 | .\" This program is free software: you can redistribute it and/or modify |
| 7 | .\" it under the terms of the GNU General Public License as published by |
| 8 | .\" the Free Software Foundation, either version 3 of the License, or |
| 9 | .\" (at your option) any later version. |
| 10 | .\" |
| 11 | .\" This program is distributed in the hope that it will be useful, |
| 12 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | .\" GNU General Public License for more details. |
| 15 | .\" |
| 16 | .\" You should have received a copy of the GNU General Public License |
| 17 | .\" along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 18 | .\" |
| 19 | .TH disorder-gstdecode 8 |
| 20 | .SH NAME |
| 21 | disorder-gstdecode \- DisOrder audio decoder using GStreamer |
| 22 | .SH SYNOPSIS |
| 23 | .B disorder\-gstdecode |
| 24 | .RB [ \-s ] |
| 25 | .RB [ -c |
| 26 | .IR CONFIGFILE ] |
| 27 | .RB [ \-d |
| 28 | .IR DITHER ] |
| 29 | .RB [ \-f |
| 30 | .IR GAIN ] |
| 31 | .br |
| 32 | \h'8n'\c |
| 33 | .RB [ \-n |
| 34 | .IR SHAPE ] |
| 35 | .RB [ \-q |
| 36 | .IR QUALITY ] |
| 37 | .RB [ \-r |
| 38 | .IR MODE ] |
| 39 | .I PATH |
| 40 | .SH DESCRIPTION |
| 41 | .B disorder\-gstdecode |
| 42 | converts encoded audio files into DisOrder's "raw" format. |
| 43 | It uses the GStreamer library for conversion, |
| 44 | and can decode any kind of audio file |
| 45 | for which the necessary GStreamer plugins are available. |
| 46 | .PP |
| 47 | It is suitable for use as an |
| 48 | .B execraw |
| 49 | player. |
| 50 | .PP |
| 51 | It is not intended to be used from the command line, |
| 52 | but command-line options can usefully be provided |
| 53 | in DisOrder's configuration file. |
| 54 | .SH OPTIONS |
| 55 | .TP |
| 56 | .B \-\-help\fR, \fB\-h |
| 57 | Display a usage message. |
| 58 | .TP |
| 59 | .B \-\-version\fR, \fB\-V |
| 60 | Display version number. |
| 61 | .TP |
| 62 | .B \-\-config \fICONFIGFILE\fR, \fB\-c \fICONFIGFILE |
| 63 | Set the configuration file. |
| 64 | .TP |
| 65 | .B \-\-dither \fITYPE\fR, \fB\-d \fIDITHER |
| 66 | Set the dither type used during audio format conversion. |
| 67 | This can be \fBnone\fR, |
| 68 | \fBrpdf\fR for rectangular dithering, |
| 69 | \fBtpdf\fR for triangular dithering, or |
| 70 | \fBtpdf-hf\fR for high-frequency triangular dithering. |
| 71 | Maybe the GStreamer documentation will explain what these mean. |
| 72 | The default is to leave the decision |
| 73 | to GStreamer's \fBaudioconvert\fR plugin. |
| 74 | .TP |
| 75 | .B \-\-fallback-gain \fIGAIN\fR, \fB\-f \fIGAIN |
| 76 | Set the gain to be applied to tracks |
| 77 | which don't have ReplayGain information. |
| 78 | This is in decibels, and will usually be negative. |
| 79 | The default is zero, which is probably wrong. |
| 80 | .TP |
| 81 | .B \-\-noise-shape \fITYPE\fR, \fB-n \fITYPE |
| 82 | Set the noise shaping type used during audio format conversion. |
| 83 | This can be \fBnone\fR, |
| 84 | \fBerror-feedback\fR, |
| 85 | \fBsimple\fR for 2-pole noise shaping, |
| 86 | \fBmedium\fR for 5-pole noise shaping, or |
| 87 | \fBhigh\fR for 8-pole noise shaping. |
| 88 | Maybe the GStreamer documentation will explain what these mean. |
| 89 | The default is to leave the decision |
| 90 | to GStreamer's \fBaudioconvert\fR plugin. |
| 91 | .TP |
| 92 | .B \-\-quality \fIQUALITY\fR, \fB\-q \fIQUALITY |
| 93 | Set the quality level to be used for resampling. |
| 94 | This should be an integer between |
| 95 | 0 (poor, but fast) and |
| 96 | 10 (good, but slow). |
| 97 | See the GStreamer documentation for more information. |
| 98 | The default is to leave the decision |
| 99 | to GStreamer's \fBaudioresample\fR plugin. |
| 100 | .TP |
| 101 | .B \-\-replay-gain \fIMODE\fR, \fB\-r \fIMODE |
| 102 | Set the ReplayGain mode. |
| 103 | This can be \fBoff\fR to not bother with ReplayGain at all, |
| 104 | \fBtrack\fR to use the per-track gain setting, or |
| 105 | \fBalbum\fR to use the per-album gain setting |
| 106 | (so that the volume level sounds consistent |
| 107 | when playing an entire album). |
| 108 | The default is \fBalbum\fR. |
| 109 | .TP |
| 110 | .B \-\-stream\fR, \fB\-s |
| 111 | Write a stream of raw samples to the output, |
| 112 | instead of including DisOrder's usual framing. |
| 113 | This is useful for testing the program on its own. |
| 114 | .SH "SEE ALSO" |
| 115 | .BR disorderd (8), |
| 116 | .BR disorder_config (5) |