~ubuntu-branches/ubuntu/karmic/tovid/karmic

« back to all changes in this revision

Viewing changes to docs/src/en/tovid.t2t

  • Committer: Bazaar Package Importer
  • Author(s): Matvey Kozhev
  • Date: 2008-01-24 22:04:40 UTC
  • Revision ID: james.westby@ubuntu.com-20080124220440-x7cheljduf1rdgnq
Tags: upstream-0.31
ImportĀ upstreamĀ versionĀ 0.31

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
tovid manual
 
2
 
 
3
 
 
4
==Name==
 
5
 
 
6
tovid: Convert video to (S)VCD/DVD format
 
7
 
 
8
 
 
9
==Description==
 
10
 
 
11
tovid converts arbitrary video files into (S)VCD/DVD-compliant
 
12
MPEG format, suitable for burning to CD/DVD-R for playback on a
 
13
standalone DVD player.
 
14
 
 
15
 
 
16
==Usage==
 
17
 
 
18
**tovid** [//OPTIONS//] **-in** //INFILE// **-out** //OUTPREFIX//
 
19
 
 
20
Where //INFILE// is any multimedia video file, and //OUTPREFIX// is what
 
21
you want to call the output file, minus the file extension. //OPTIONS//
 
22
are additional customizations, described below.
 
23
 
 
24
By default, you will (hopefully) end up with an NTSC DVD-compliant
 
25
MPEG-2 video file; if you burn this file to a DVD-R, it should be
 
26
playable on most DVD players.
 
27
 
 
28
For example:
 
29
 
 
30
: ``tovid -in foo.avi -out foo_encoded``
 
31
    Convert 'foo.avi' to NTSC DVD format, saving to 'foo_encoded.mpg'.
 
32
 
 
33
: ``tovid -pal -vcd foo.avi -out foo_encoded``
 
34
    Convert 'foo.avi' to PAL VCD format, saving to 'foo_encoded.mpg'.
 
35
 
 
36
 
 
37
==Basic options==
 
38
 
 
39
: **-v**, **-version**
 
40
    Print tovid version number only, then exit.
 
41
: **-quiet**
 
42
    Reduce output to the console.
 
43
: **-fake**
 
44
    Do not actually encode; only print the commands (mplayer, mpeg2enc etc.)
 
45
    that would be executed. Useful in debugging; have tovid give you the
 
46
    commands, and run them manually.
 
47
: **-ffmpeg**
 
48
    Use ffmpeg for video encoding, instead of mplayer/mpeg2enc. Try this if
 
49
    you have any problems with the default encoding method. Using this option,
 
50
    encoding will be considerably faster. Works with **-vcd**, **-svcd**, and
 
51
    **-dvd**.
 
52
 
 
53
 
 
54
 
 
55
===Television standards===
 
56
 
 
57
: **-ntsc**
 
58
    NTSC format video (USA, Americas) (default)
 
59
: **-ntscfilm**
 
60
    NTSC-film format video
 
61
: **-pal**
 
62
    PAL format video (Europe and others)
 
63
 
 
64
 
 
65
===Formats===
 
66
 
 
67
Standard formats, should be playable in most DVD players:
 
68
 
 
69
: **-dvd**
 
70
    (720x480 NTSC, 720x576 PAL) DVD-compatible output (default)
 
71
: **-half-dvd**
 
72
    (352x480 NTSC, 352x576 PAL) Half-D1-compatible output
 
73
: **-svcd**
 
74
    (480x480 NTSC, 480x576 PAL) Super VideoCD-compatible output
 
75
: **-dvd-vcd**
 
76
    (352x240 NTSC, 352x288 PAL) VCD-on-DVD output
 
77
: **-vcd**
 
78
    (352x240 NTSC, 352x288 PAL) VideoCD-compatible output
 
79
 
 
80
 
 
81
Non-standard formats, playable in some DVD players:
 
82
 
 
83
: **-kvcd**
 
84
    (352x240 NTSC, 352x288 PAL) KVCD-enhanced long-playing video CD
 
85
: **-kdvd**
 
86
    (720x480 NTSC, 720x576 PAL) KVCD-enhanced long-playing DVD
 
87
: **-kvcdx3**
 
88
    (528x480 NTSC, 520x576 PAL) KVCDx3 specification
 
89
: **-kvcdx3a**
 
90
    (544x480 NTSC, 544x576 PAL) KVCDx3a specification (slightly wider)
 
91
: **-bdvd**
 
92
    (720x480 NTSC, 720x576 PAL) BVCD-enhanced long-playing DVD
 
93
 
 
94
 
 
95
See [kvcd.net http://kvcd.net/] for details on the KVCD specification. Please
 
96
note that KVCD ("K Video Compression Dynamics") is the name of a compression
 
97
scheme that can be applied to any MPEG-1 or MPEG-2 video, and has little to
 
98
do with VCD ("Video Compact Disc"), which is the name of a standard video disc
 
99
format.
 
100
 
 
101
 
 
102
==Advanced options==
 
103
 
 
104
 
 
105
===Aspect ratios===
 
106
 
 
107
tovid automatically determines aspect ratio of the input video by playing it in
 
108
mplayer. If your video plays with correct aspect in mplayer, you should not
 
109
need to override the default tovid behavior.
 
110
 
 
111
If mplayer does not play your video with correct aspect, you may provide an
 
112
explicit aspect ratio in one of several ways:
 
113
 
 
114
: **-full**
 
115
    Same as **-aspect 4:3**
 
116
: **-wide**
 
117
    Same as **-aspect 16:9**
 
118
: **-panavision**
 
119
    Same as **-aspect 235:100**
 
120
: **-aspect** //WIDTH//**:**//HEIGHT//
 
121
    Custom aspect, where //WIDTH// and //HEIGHT// are integers.
 
122
 
 
123
 
 
124
NOTE: This is the INPUT aspect ratio. tovid chooses an optimal output aspect
 
125
ratio for the selected disc format (VCD, DVD, etc.) and does the appropriate
 
126
letterboxing or anamorphic scaling.
 
127
 
 
128
 
 
129
===Video stream options===
 
130
 
 
131
: **-quality** //NUM// (default 6)
 
132
    Desired output quality, on a scale of 1 to 10, with 10 giving the best
 
133
    quality at the expense of a larger output file. Default is 6. Output size
 
134
    can vary by approximately a factor of 4 (that is, **-quality 1** output
 
135
    can be 1/4 the size of **-quality 10** output). Your results may vary.
 
136
    WARNING: With **-quality 10**, the output bitrate may be too high for
 
137
    your hardware DVD player to handle. Stick with 9 or lower unless you
 
138
    have phenomenally good eyesight.
 
139
 
 
140
    At present, this option affects both output bitrate and quantization (but
 
141
    may, in the future, affect other quality/size-related attributes). Use
 
142
    **-vbitrate** if you want to explicitly provide a maximum bitrate.
 
143
 
 
144
: **-vbitrate** //NUM//
 
145
    Maximum bitrate to use for video (in kbits/sec). Must be within allowable
 
146
    limits for the given format. Overrides default values. Ignored for VCD,
 
147
    which must be constant bitrate.
 
148
 
 
149
: **-interlaced**
 
150
    Do interlaced encoding of the input video (top fields first). Use this
 
151
    option if your video is  interlaced, and you want to preserve as much
 
152
    picture quality as possible. This option is ignored for VCD, which
 
153
    doesn't support it.
 
154
 
 
155
    You can tell your source video is interlaced by playing it, and pausing
 
156
    during a scene with horizontal motion; if you see a "comb" effect at the
 
157
    edges of objects in the scene, you have interlaced video. Use this option
 
158
    to encode it properly.
 
159
 
 
160
    If you would prefer to have output in progressive format, use
 
161
    **-progressive**. If you have a DV camera, use **-interlaced_bf** since
 
162
    DV footage is generally bottom fields first.
 
163
 
 
164
: **-interlaced_bf**
 
165
    Do interlaced encoding of the input video (bottom fields first).
 
166
 
 
167
: **-deinterlace** | **-progressive**
 
168
    Convert interlaced source video into progressive output video. Because
 
169
    deinterlacing works by averaging fields together, some picture quality is
 
170
    invariably lost. Uses an adaptive kernel deinterlacer (kerndeint), or,
 
171
    if that's not available, the libavcodec deinterlacer (lavcdeint).
 
172
 
 
173
: **-mkvsub** //LANG// (EXPERIMENTAL)
 
174
    Attempt to encode an integrated subtitle stream (such as may be found in
 
175
    Matroska .mkv files) in the given language code (eng, jpn, etc.) May work
 
176
    for other formats.
 
177
 
 
178
: **-autosubs**
 
179
    Automatically include subtitle files with the same name as the input video.
 
180
 
 
181
: **-subtitles** //FILE//
 
182
    Get subtitles from //FILE// and encode them into the video.  WARNING: This
 
183
    hard-codes the subtitles into the video, and you cannot turn them off while
 
184
    viewing the video. By default, no subtitles are loaded. If your video is
 
185
    already compliant with the chosen output format, it will be re-encoded to
 
186
    include the subtitles.
 
187
 
 
188
: **-type** {live|animation|bw}
 
189
    Optimize video encoding for different kinds of video. Use 'live' (default)
 
190
    for live-action video, use 'animation' for cartoons or anime, and 'bw' for
 
191
    black-and-white video.  This option currently only has an effect with
 
192
    KVCD/KSVCD output formats; other formats may support this in the future.
 
193
 
 
194
: **-safe** //PERCENT//
 
195
    Fit the video within a safe area defined by //PERCENT//. For example,
 
196
    **-safe 90%** will scale the video to 90% of the width/height of the output
 
197
    resolution, and pad the edges with a black border. Use this if some of the
 
198
    picture is cut off when played on your TV.  The percent sign is optional.
 
199
 
 
200
: **-filters** {none,denoise,deblock,contrast,all} (default none)
 
201
    Apply post-processing filters to enhance the video. If your input video is
 
202
    very high quality, use 'none'. If your input video is grainy, use 'denoise';
 
203
    if it looks washed out or faded, use 'contrast'. You can use multiple
 
204
    filters separated by commas. To apply all filters, use 'all'.
 
205
 
 
206
: **-fps** //RATIO//
 
207
    Force input video to be interpreted as //RATIO// frames per second.  May be
 
208
    necessary for some ASF, MOV, or other videos. //RATIO// should be an
 
209
    integer ratio such as "24000:1001" (23.976fps), "30000:1001" (29.97fps), or
 
210
    "25:1" (25fps). This option is temporary, and may disappear in future
 
211
    releases. (Hint: To convert a decimal like 23.976 to an integer ratio, just
 
212
    multiply by 1000, i.e. 23976:1000)
 
213
 
 
214
: **-crop** //WIDTH//://HEIGHT//://X//://Y//
 
215
    Crop a portion of the video //WIDTH// by //HEIGHT// in size, with the
 
216
    top-left corner at //X//, //Y//.
 
217
 
 
218
 
 
219
===Audio stream options===
 
220
 
 
221
: **-normalize** [VOLUME]
 
222
    If used without VOLUME argument, analyze the audio stream and then
 
223
    normalize the volume of the audio.
 
224
    This is useful if the audio is too quiet or too loud, or you want to
 
225
    make volume consistent for a bunch of videos. Similar to running
 
226
    normalize without any parameters. The default is -12dB average level
 
227
    with 0dB gain.
 
228
    If the optional VOLUME argument is supplied, ffmpeg will be used instead
 
229
    to increase or decrease the volume.  An argument of 256 is normal volume.
 
230
    This option is useful for -slice, because there are sync issues if
 
231
    audio and video are encoded separately after a seek.
 
232
 
 
233
: **-amplitude** //NUM//[dB]
 
234
    In addition to analyzing and normalizing, apply the gain to the audio
 
235
    such that the 'average' (RMS) sound level is //NUM//. Valid values
 
236
    range 0.0 - 1.0, with 0.0 being silent and 1.0 being full scale. Use
 
237
    //NUM//dB for a decibel gain below full scale (the default without
 
238
    -amplitude is -12dB).
 
239
 
 
240
: **-abitrate** //NUM//
 
241
    Encode audio at //NUM// kilobits per second.  Reasonable values include
 
242
    128, 224, and 384. The default is 224 kbits/sec, good enough for most
 
243
    encodings. The value must be within the allowable range for the chosen disc
 
244
    format; Ignored for VCD, which must be 224.
 
245
 
 
246
: **-audiotrack** //NUM//
 
247
    Encode the given audio track, if the input video has multiple audio tracks.
 
248
    //NUM// is //1// for the first track, //2// for the second, etc. You may
 
249
    also provide a list of tracks, separated by spaces or commas, for example
 
250
    **-audiotrack 3,1,2**. Use **idvid** on your source video to determine which
 
251
    audio tracks it contains.
 
252
 
 
253
: **-async** //NUM//
 
254
    Adjust audio synchronization by //NUM// seconds.
 
255
 
 
256
 
 
257
 
 
258
===Other options===
 
259
 
 
260
: **-config** //FILE//
 
261
    Read configuration from //FILE//, containing 'tovid' alone on the first
 
262
    line, and free-formatted (whitespace-separated) tovid command-line options
 
263
    on remaining lines.
 
264
 
 
265
: **-force**
 
266
    Force encoding of already-compliant video or audio streams.
 
267
 
 
268
: **-overwrite**
 
269
    Overwrite any existing output files (with the same name as the given
 
270
    **-out** option).
 
271
 
 
272
: **-priority** {low|medium|high}
 
273
    Sets the main encoding process to the given priority. With high priority,
 
274
    it may take other programs longer to load and respond. With lower priority,
 
275
    other programs will be more responsive, but encoding may take 30-40%
 
276
    longer.  The default is high priority.
 
277
 
 
278
: **-discsize** //NUM//
 
279
    When encoding, tovid automatically splits the output file into several
 
280
    pieces if it exceeds the size of the target media. This option sets the
 
281
    desired target DVD/CD-R size to //NUM// mebibytes (MiB, 2^20). By default,
 
282
    splitting occurs at 700 for CD, 4300 for DVD. Use higher values at your
 
283
    own risk. Use 650 or lower if you plan to burn to smaller-capacity CDs.
 
284
    Doesn't work with the **-ffmpeg** option.
 
285
 
 
286
: **-fit** //NUM//
 
287
    Fit the output file into //NUM// MiB. Rather than using default (or specified)
 
288
    video bitrates, tovid will calculate the correct video bitrate that will
 
289
    limit the final output size to //NUM// MiB. This is different than **-discsize**,
 
290
    which cuts the final file into //NUM// MiB pieces. **-fit** makes sure that
 
291
    the file never exceeds //NUM// MiB. This works with **-ffmpeg**, but not
 
292
    with **-vcd** since VCDs have a standardized constant bitrate.
 
293
 
 
294
: **-parallel**
 
295
    Perform ripping, encoding, and multiplexing processes in parallel using
 
296
    named pipes. Maximizes CPU utilization and minimizes disk usage. Note that
 
297
    this option simply does more tasks simultaneously, in order to make better
 
298
    use of available CPU cycles; it's unrelated to multi-CPU processing (which
 
299
    is done automatically anyway). Has no effect when **-ffmpeg** is used.
 
300
 
 
301
: **-update** //SECS//
 
302
    Print status updates at intervals of //SECS// seconds. This affects how
 
303
    regularly the progress-meter is updated. The default is once every five
 
304
    seconds.
 
305
 
 
306
: **-mplayeropts** **"**//OPTIONS//**"**
 
307
    Append //OPTIONS// to the mplayer command run during video encoding.  Use
 
308
    this if you want to add specific video filters (documented in the mplayer
 
309
    manual page). Overriding some options will cause encoding to fail, so use
 
310
    this with caution!
 
311
 
 
312
: **-nofifo** (EXPERIMENTAL)
 
313
    Do not use a FIFO pipe for video encoding. If you are getting "Broken pipe"
 
314
    errors with normal encoding, try this option.  WARNING: This uses lots of
 
315
    disk space (about 2 GB per minute of video).
 
316
 
 
317
: **-keepfiles**
 
318
    Keep the intermediate files after encoding. Usually, this means the audio
 
319
    and video streams are kept (eg the .ac3 and .m2v files for an NTSC DVD).
 
320
    This doesn't work with -parallel because the intermediate files are named
 
321
    pipes, and not real files.
 
322
 
 
323
: **-slice** //START//-//END//
 
324
    Encode a segment from //START// to //END// (in seconds).
 
325
 
 
326
: **-from-gui**
 
327
    Put tovid into a fully non-interactive state, suitable for calling from
 
328
    a gui.
 
329
 
 
330
: **-noask**
 
331
    Don't ask questions when choices need to be made. Assume reasonable
 
332
    answers.
 
333
 
 
334
 
 
335
==Configuration==
 
336
 
 
337
Two configuration files are created the first time you run tovid. Edit them
 
338
to change tovid's directory use and default behavior.
 
339
 
 
340
Working and output directories are defined in **~/.tovid/preferences**:
 
341
 
 
342
```
 
343
WORKING_DIR=/tmp
 
344
OUTPUT_DIR=/pub/video
 
345
```
 
346
 
 
347
If you would like to include certain command-line options all the time, edit
 
348
**~/.tovid/tovid.config** and add them.
 
349
 
 
350
 
 
351
==See also==
 
352
 
 
353
**idvid**(1), **makedvd**(1), **makemenu**(1), **makeslides**(1),
 
354
**makevcd**(1), **makexml**(1), **postproc**(1), **tovid**(1), **todisc**(1)
 
355
 
 
356
 
 
357
==Contact==
 
358
 
 
359
For further assistance, contact information, forum and IRC links,
 
360
please refer to the [tovid homepage http://tovid.org/].