summaryrefslogtreecommitdiff
path: root/man/miav.conf.1
blob: dc213e924a3a538bc23b0fe78f2f1e188241fc1e (plain)
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
.\" Process this file with
.\" groff -man -Tascii miav.conf.1
.\"
.TH MIAV.CONF 1 "June 2005" Linux "User Manuals"
.SH NAME
MIaV \- The Multicast Image and Video project. Configuration file.
.SH SYNOPSIS
.B /etc/miav.conf
.SH FORMAT
.RS
.RE
.I [property] = [value]
.SH FORMAT EXPLANATION
.TP
.B property
is a string without quotes, containing only normal characters. It is
case sensitive.
.TP
.B value
is one of the following:
.RS
.I string
.RS
A string is a sequence of characters, double quoted, and not
containgning newlines.
.RE
.I integer
.RS
An integer is a normal number, without qoutations, it may only
contain the characters 0-9.
.RE
.I float
.RS
A float is a floating point value, written without qoutations and
using a dot as the decimal indetifier.
.RE
.I boolean
.RS
A boolean is a string written without quotation, the following
three is equivalent: 
.I 1, true, yes.
The following three are equivalent:
.I 0, false, no.
.SH DESCRIPTION
.RS
.RE
MIaV \- The Multicast Image and Video project.

The MIaV configuration file:

.B Log files of the server and the client.
.RE
The values 
.I client_log_file
and
.I server_log_file
needs to be set to a string (double qouted) containing a filename,
which is writable by the user the program is run by. Please note that
the
.I user
and
.I group
properties do not apply to the client.

.B Cpr Database configuration.
.RE
The
.I cpr_host
property must be set to a string (double quoted) sontaining a valid
dns name for a cpr server.
The
.I cpr_port
is the port number on which to contact the cpr server, and the
.I cpr_timeout
property is the number of miliseconds before bailing out, if the cpr
server does not reply.

.B Video source.
.RE
The
.I video_width
and
.I video_height
properties are integers setting the width and height of the client
window.

.B Size of the screen in inches.
.RE
.I screensize
.I pixel_width
.I pixel_height

.B Skip frames in the player.
.RE
.I player_skip_frames
Set to 1 if client is slow ( less than 1.5 ghz )

.B How and where to connect to the miav server?
.RE
.I server_addr
.I server_port

.B Run the server as the following user:
.RE
.I server_user
.I server_group

.B Where to store the files recieved by the server
.RE
.I server_movie_root
points to the root folder of the directory structure (Which is created
by MIaV) to contain the movie clips.
.I server_image_root
points to the root folder of the directory structure (Which is created
by MIaV) to contain the images clips.

.B Video output controls.
.RE
.I frame_sequence
A sequence of I and P, where I is keyframes
which is fast to create, but uses a lot of discspace.
P uses changes since last frame, is more cpu intensive, but uses a
lot less diskspace than I frames

.B Frame quality.
.RE
.I frame_quality
in % - 100% is best quality

.B MP3 encoding quality
.RE
.I mp3_quality
internal algorithm selection.  True quality is determined by the bitrate
but this variable will effect quality by selecting expensive or cheap algorithms.
quality=0..9.  0=best (very slow).  9=worst.
recommended:  2     near-best quality, not too slow
              5     good quality, fast
              7     ok quality, really fast

.B The MP3 output bitrate
.RE
.I mp3_bitrate
in kilobits pr. second. (112 is recommended)

.B Encoder threads.
.RE
The number of threads started for parallel encoding on the server
(for multiprocessor systems)
.I encoding_threads

.B Encoder codec.
.RE
Codec is one of the following:
"mpeg1" For use with mpeg1 encoding.
"mpeg4" for use with mpeg4 encoding
default is "mpeg1"
.I encoding_codec
.SH EXAMPLE
.RS
.RE
client_log_file	= "/var/log/miav_client.log"
.RE
server_log_file	= "/var/log/miav_server.log"

cpr_host	= "cpr.example.com"
.RE
cpr_port	= 10301
.RE
cpr_timeout	= 10000

video_width	= 720
.RE
video_height	= 576

screensize	= 19.0
.RE
pixel_width	= 1024
.RE
pixel_height	= 768

player_skip_frames = no

server_addr	= "miav.example.com"
.RE
server_port	= 18120

server_user	= "miav"
.RE
server_group	= "miav"

server_root	= "/var/miav_files"

frame_sequence	= "IPPPP"

frame_quality	= 85

mp3_quality	= 3

mp3_bitrate	= 112

encoding_threads = 1

encoding_codec 	= "mpeg4"
.SH FILES
.I /etc/miav.conf
.RS
The system wide configuration file.
.SH "SEE ALSO"
.BR miav (1)
.SH AUTHOR
Bent Bisballe <deva at aasimon dot org>