๐Ÿ“ฆ neofright / transflac

๐Ÿ“„ transflac.1 ยท 132 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132.TH transflac 1
.SH NAME
transflac \- convert FLAC audio files to lossy formats.
.SH SYNOPSIS
.B transflac
[input_FLAC_directory] [output_lossy_directory] [lossy_format] [codec_quality]
.SH DESCRIPTION
The process of converting FLAC files to lossy formats
and preserving tag information can be a bit tedious.
.BR transflac
is designed to automate this. It will start at the input_flac_directory and
recursively walk the directory structure converting each flac audio file to the
specified lossy codec - preserving all associated tag information.  Additionally,
any cover art (stored in the directory structure as 
albumart | cover | folder . gif | jpg | jpeg | png | tiff) will be
duplicated in the target lossy directories.
.SH CONFIGURATION
\fBtransflac\fR allows for customization of certain items in the configuration.
.PP
If you wish to change an option in the configuration, first create a copy: \ficp /etc/transflac.conf $HOME/.transflac.conf\fR then modify only the \fI$HOME/.transflac.conf\fR version.
.PP
The configuration variables can be set as follows:
.TP
.B VARIABLE="value"
"value" needs to be quoted.
.TP
All shell escaping/quoting rules apply.
.TP
Here is a list of options \fBtransflac\fR recognizes:
.TP
.B FIGFONT="small"
Default setting is small.
This is the font to be used by the FIGlet generated banner.
.TP
.B ARTSYNC="YES"
Default setting is YES.
Album art is automatically sync'd.  If you do not wish artwork to
be copied, change the setting to ARTSYNC="NO".
.TP
.B input_flac_dir=""
Specifies the directory starting point which will be recursively
search for FLAC audio files.  All FLAC audio files in the directory
structure will be converted to the specified lossy codec.
Default value is "$1" which is arg1 from the command line invocation.
This value is case sensitive.  Any symlinks that are encountered will be
resolved and the physical path will be displayed.
.TP
.B output_lossy_dir=""
Specifies the target directory which will be used to store the lossy
audio files which are created during the conversion process.
Default value is "$2" which is arg2 from the command line invocation.
This value is case sensitive.  Any symlinks that are encounted will be
resolved and the physical path will be displayed.
.TP
.B lossy_codec=""
Specifies the lossy codec which will be used to convert the FLAC
audio files.  Default value is "$3" which is arg3 from the command line
invocation.  This value is NOT case sensitive.
OPUS generally will provide the best sound quality for a given filesize
or bitrate - and is the recommended codec.
.br
Valid values are: OPUS | OGG | AAC | MP3
.TP
.B codec_quality=""
Specifies the quality preset which will be used to encode the lossy
audio files.  Default value is "$4" which is arg4 from the command line
invocation.  This value is NOT case sensitive.
OPUS STANDARD quality provides Full bandwidth stereo music,
good quality approaching transparency - and is the recommended
setting.
.br
Valid values are: LOW | MEDIUM | STANDARD | HIGH | PREMIUM
.TS
allbox,tab(@);
c c c c c c
l r r r r r .
CODEC@LOW@MEDIUM@STANDARD@HIGH@PREMIUM
OPUS@48 kbps@64 kbps@96 kbps@128 kbps@192 kbps
OGG@80 kbps@96 kbps@112 kbps@128 kbps@160 kbps
AAC@40 kbps@80 kbps@96 kbps@128 kbps@224 kbps
MP3@85 kbps@100 kbps@115 kbps@130 kbps@165 kbps
.TE
.TP
.sp 1
.B COLOR OVERRIDES
Colors can be modified by assigning a valid color name to the variable names as shown in the sample transflac.conf file. Monochrome or terminal defaults can be obtained by setting the a particular variable name to "DEFAULT". Additional information can be found at TransFLAC website.
.sp 1
Available color names: RED, YELLOW, GREEN, BLUE, CYAN, PURPLE, GRAY
.sp 1
Placing an "L" in fron of the color designates the "LIGHT" version.
.SH EXAMPLES
Possible ways one can call \fBtransflac\fR:
.TP
.B transflac
"You will be prompted to enter all options.  If you have customized
options in $HOME/.transflac.conf those values will be substituted.
.TP
.B transflac [input_flac_dir] [output_lossy_dir] [lossy_codec] [codec_quality]
transflac processing will proceed with the options entered on the
command line.
.SH BACKEND TOOLS
\fBtransflac\fR requires the following backend tools:
.TP
.B *
opus-tools - Required to convert files to the OPUS lossy format
.TP
.B *
vorbis-tools - Required to convert files to the OGG Vorbis lossy
format
.TP
.B *
ffmpeg - Required to convert files to the AAC or MP3 lossy formats
.TP
.B *
flac - Required to convert files from the FLAC lossless format
.TP
.B *
rsync - Required to copy cover art files to the new lossy format
directory structure
.TP
.B *
figlet - Required to facilate display formatting
.SH "SEE ALSO"
.BR opusenc (1),
.BR oggenc (1),
.BR flac (1),
.BR ffmpeg (1)
.SH AUTHOR
Gerald Cox <gbcox@fedoraproject.org>
.SH WWW
.BR https://bitbucket.org/gbcox/transflac/