forked from njh/rotter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rotter.1.txt
148 lines (105 loc) · 4.67 KB
/
rotter.1.txt
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
ROTTER(1)
=========
Nicholas J Humfrey
NAME
----
rotter - a recording of transmission / audio logger for JACK
SYNOPSIS
--------
'rotter' [options] <directory>
DESCRIPTION
-----------
Rotter is a Recording of Transmission / Audio Logger for JACK.
It was designed for use by radio stations, who are legally required
to keep a recording of all their output. Rotter runs continuously,
writing to a new file at regular intervals (by default every hour).
Rotter can output files in different layouts, either all files in
a single directory, or creating a directory structure as required.
Custom file layouts may be specified, using a strftime-style format
string, or one of the following predefined file layouts:
flat: /root_directory/YYYY-MM-DD-HH.suffix
hierarchy: /root_directory/YYYY/MM/DD/HH/archive.suffix
combo: /root_directory/YYYY/MM/DD/HH/YYYY-MM-DD-HH.suffix
dailydir: /root_directory/YYYY-MM-DD/YYYY-MM-DD-HH.suffix
accurate: /root_directory/YYYY-MM-DD/YYYY-MM-DD-HH-mm-ss-uu.suffix
The advantage of using a folder hierarchy is that you can store related
files in the hour's directory. The "accurate" structure stores the
start time of the hourly file to an accuracy of one hundredth of a
second.
OPTIONS
-------
-a::
Automatically connect JACK ports to the first two JACK
input ports found.
-f <format>::
Select the output format of the log files. See the rotter
help screen for a list of supported output format names.
-b <bitrate>::
Select the bitrate (in kbps) of the log file. This parameter
is only supported by bitstream formats (MPEG Audio).
-Q <quality>::
Enable VBR and set the encoding quality (0 lowest, 10 highest).
Currently only the MP3 and Vorbis codecs support this option.
-c <channels>::
Set the number of input channels to be logged. This number of
JACK ports will be created. Should either 1 or 2.
-n <name>::
Choose the name of the Jack client to register as.
-N <filename>::
Choose a filename prefix for the archive files created (default 'archive').
-O <originator>::
Specify the value for the originator / artist field in the metadata of
the output files (the default the hostname).
-p <secs>::
Specify the period of each archive file in seconds. The default is 1 hour
(-p 3600). As an example, this can be used to make rotter create a new
file at the start of every minute, using -p 60. Take care that the chosen
file layout includes sufficient time precision.
-d <hours>::
Specifies the number of hours of audio to keep before it is
deleted. Files are deleted at the start of every hour, based
on the files modification date. Default is to not delete files.
-R <secs>::
Sets the length (in seconds) of the ringbuffer. This is the buffer
between the internal audio grabber and the audio encoder. If you have
a slow machine you might want to try increating the size of the buffer.
-L <layout>::
Choose a file layout option for the archive files created.
See above for a list of pre-defined layout formats, or specify a custom
layout using strftime format specifiers, for example:
-L "%Y-%m-%d/studio-1/%H%M.flac"
will generate files like: [root]/2012-06-05/studio-1/1300.flac
See your system's strftime documentation for a full list of available
format specifiers (man strftime).
-s <secs>::
Sets the how often (in seconds) that rotter asks the operating
system to flush its buffers and sync the encoded audio to disk.
-j::
By default rotter will automatically try and start jackd if it
isn't running. This option disables that feature.
-u::
Use UTC rather than the default of local time in forming archive
filenames. Human-readable log messages will still be timestamped
with the local time.
-v::
Enable verbose mode. Display more messages about what rotter is doing.
-q::
Enable quiet mode. Only display error messages.
EXAMPLES
--------
'rotter -a -f mp3 -d 1000 -b 160 -v /var/achives'
Start logging audio to hourly files in /var/archives.
Rotter will automatically connect itself to the first two JACK output
ports it finds and encode to MPEG Layer 3 audio at 128kbps.
Each hour it will delete files older than 1000 hours (42 days).
Verbose mode means it will display more informational messages.
AUTHOR
------
Written by Nicholas J Humfrey
RESOURCES
---------
Web site: http://www.aelius.com/njh/rotter/[]
COPYING
-------
Copyright \(C) 2006-2007 Nicholas J Humfrey. Free use of this software is
granted under the terms of the GNU General Public License (GPL).