Skip to content

Commit

Permalink
add missing options and re-generate
Browse files Browse the repository at this point in the history
  • Loading branch information
Gavin Beatty committed Nov 25, 2013
1 parent 0668a78 commit b8cfad4
Show file tree
Hide file tree
Showing 4 changed files with 136 additions and 55 deletions.
86 changes: 57 additions & 29 deletions doc/mkvtomp4.1
Original file line number Diff line number Diff line change
@@ -1,109 +1,142 @@
.TH MKVTOMP4 1 "December 26, 2012"
.TH "MKVTOMP4" "1" "November 24, 2013" "" ""
.SH NAME
.PP
mkvtomp4 - convert H.264 mkv files to mp4 files playable on the PS3
mkvtomp4 \- convert H.264 mkv files to mp4 files playable on the PS3
.SH SYNOPSIS
.PP
\f[I]mkvtomp4\f[] [\f[I]OPTIONS\f[]] [--] \f[I]<mkvfile>\f[]
\f[I]mkvtomp4\f[] [\f[I]OPTIONS\f[]] [\-\-] \f[I]<mkvfile>\f[]
.PP
\f[I]mkvtomp4\f[] \f[I]--correct-profile-only\f[] [--]
\f[I]mkvtomp4\f[] \f[I]\-\-correct\-profile\-only\f[] [\-\-]
\f[I]<rawh264file>\f[]
.SH DESCRIPTION
.PP
Uses mpeg4ip or GPAC\[aq]s MP4Box, mkvtoolnix and ffmpeg to convert
troublesome mkv files to mp4.
The conversion does not re-encode the video and only re-encodes the
The conversion does not re\-encode the video and only re\-encodes the
audio if it doesn\[aq]t use AAC codec (one can override this behaviour
using \f[C]--audio-codec\f[]).
using \f[C]\-\-audio\-codec\f[]).
They will be playable on the Sony PS3.
.PP
We depend on: \f[I]mkvtoolnix\f[], \f[I]mpeg4ip\f[] or GPAC\[aq]s
\f[I]MP4Box\f[] for the conversion.
\f[I]ffmpeg\f[] is optional but required for audio transcoding.
.SH OPTIONS
.TP
.B --use-mp4creator, --use-mp4box
.B \-\-use\-mp4creator, \-\-use\-mp4box
Specify which mp4 backend to use.
mp4creator is the default.
.RS
.RE
.TP
.B --audio-delay-ms=\f[I]\f[]
.B \-\-mp4creator=\f[I]<mp4creator>\f[]
Use <mp4creator> as the mp4creator command.
.RS
.RE
.TP
.B \-\-mp4box=\f[I]<mp4box>\f[]
Use <mp4box> as the mp4box command.
.RS
.RE
.TP
.B \-\-mkvinfo=\f[I]<mkvinfo>\f[]
Use <mkvinfo> as the mkvinfo command.
.RS
.RE
.PP
\-\-mkvextract=** : Use <mkvextract> as the mkvextract command.
.PP
\-\-video\-track=** : Use <video_track> from the mkv file instead of
trying to parse it.
.PP
\-\-audio\-track=** : Use <audio_track> from the mkv file instead of
trying to parse it.
.TP
.B \-\-audio\-delay\-ms=\f[I]<delay_ms>\f[]
When importing the audio track, delay by \f[C]\\<delay_ms>\f[]
milliseconds.
e.g., \f[C]--audio-delay-ms\f[]=\f[C]1000\f[] delays by 1 second.
e.g., \f[C]\-\-audio\-delay\-ms\f[]=\f[C]1000\f[] delays by 1 second.
Not supported by mp4creator.
.RS
.RE
.TP
.B --audio-bitrate=\f[I]<bitrate>\f[]
.B \-\-audio\-bitrate=\f[I]<bitrate>\f[]
If/When converting audio, use the given bitrate.
e.g., \f[C]128\f[].
.RS
.RE
.TP
.B --audio-channels=\f[I]<channels>\f[]
.B \-\-audio\-channels=\f[I]<channels>\f[]
If/When converting audio, use \f[C]\\<channels>\f[] channels in the
output.
e.g., \f[C]5.1\f[].
.RS
.RE
.TP
.B --audio-codec=\f[I]<codec>\f[]
.B \-\-audio\-codec=\f[I]<codec>\f[]
If/When converting audio, convert to \f[C]\\<codec>\f[].
Default is \f[C]libfaac\f[].
This should be something supported by \f[I]ffmpeg\f[].
.RS
.RE
.TP
.B -o, --output=\f[I]<outfile>\f[]
.B \-o, \-\-output=\f[I]<outfile>\f[]
Put the completed mp4 into \f[C]\\<outfile>\f[].
.RS
.RE
.TP
.B --keep-temp-files
.B \-\-keep\-temp\-files
Keep all temporary files created while converting.
.RS
.RE
.TP
.B -n, --dry-run
.B \-v, \-\-verbose
Print info about what is happening.
.RS
.RE
.TP
.B \-n, \-\-dry\-run
Don\[aq]t run any commands, but print them in a shellquoted format that
can be safely copy-pasted by the user.
can be safely copy\-pasted by the user.
.RS
.RE
.TP
.B --stop-before-extract-video
.B \-\-correct\-profile\-only
Only correct the profile
.RS
.RE
.TP
.B \-\-stop\-before\-extract\-video
Exit before extracting video from \f[C]\\<mkvfile>\f[].
.RS
.RE
.TP
.B --stop-before-correct-profile
.B \-\-stop\-before\-correct\-profile
Exit before correcting profile of raw H.264 stream.
.RS
.RE
.TP
.B --stop-before-extract-audio
.B \-\-stop\-before\-extract\-audio
Exit before extracting audio from \f[C]\\<mkvfile>\f[].
.RS
.RE
.TP
.B --stop-before-convert-audio
.B \-\-stop\-before\-convert\-audio
Exit before converting audio previously extracted.
This will stop even if the audio does not need to be converted.
.RS
.RE
.TP
.B --stop-before-video-mp4
.B \-\-stop\-before\-video\-mp4
Exit before adding the extracted video to the mp4 container.
.RS
.RE
.TP
.B --stop-before-hinting-mp4
.B \-\-stop\-before\-hinting\-mp4
Exit before hinting the mp4 file with the video track.
.RS
.RE
.TP
.B --stop-before-audio-mp4
.B \-\-stop\-before\-audio\-mp4
Exit before adding the extracted (and possibly converted) audio to the
mp4 container.
.RS
Expand All @@ -114,11 +147,6 @@ The Matroska (.mkv) file you wish to convert.
.RS
.RE
.TP
.B --correct-profile-only
Only correct the profile
.RS
.RE
.TP
.B \f[C]\\<rawh264file>\f[]
The raw H.264 stream file that will have its profile corrected for use
on the PS3.
Expand All @@ -135,7 +163,7 @@ Website: <http://code.google.com/p/mkvtomp4/>
Please report all bugs and wishes to <[email protected]>
.SH COPYING
.PP
mkvtomp4 Copyright (c) 2012 Gavin Beatty, <[email protected]>
mkvtomp4 Copyright (c) 2012, 2013 Gavin Beatty, <[email protected]>
.PP
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
Expand Down
40 changes: 29 additions & 11 deletions doc/mkvtomp4.1.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<meta name="author" content="Gavin Beatty" />
<meta name="date" content="2012-12-26" />
<meta name="date" content="2013-11-24" />
<title>MKVTOMP4(1)</title>
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
<div id="header">
<h1 class="title">MKVTOMP4(1)</h1>
<h2 class="author">Gavin Beatty</h2>
<h3 class="date">December 26, 2012</h3>
<h3 class="date">November 24, 2013</h3>
</div>
<h1 id="name">NAME</h1>
<p>mkvtomp4 - convert H.264 mkv files to mp4 files playable on the PS3</p>
Expand All @@ -27,7 +28,21 @@ <h1 id="options">OPTIONS</h1>
<dt>--use-mp4creator, --use-mp4box</dt>
<dd><p>Specify which mp4 backend to use. mp4creator is the default.</p>
</dd>
<dt>--audio-delay-ms=<em><delay_ms></em></dt>
<dt>--mp4creator=<em>&lt;mp4creator&gt;</em></dt>
<dd><p>Use &lt;mp4creator&gt; as the mp4creator command.</p>
</dd>
<dt>--mp4box=<em>&lt;mp4box&gt;</em></dt>
<dd><p>Use &lt;mp4box&gt; as the mp4box command.</p>
</dd>
<dt>--mkvinfo=<em>&lt;mkvinfo&gt;</em></dt>
<dd><p>Use &lt;mkvinfo&gt; as the mkvinfo command.</p>
</dd>
</dl>
<p>--mkvextract=*<mkvextract>* : Use &lt;mkvextract&gt; as the mkvextract command.</p>
<p>--video-track=*<video_track>* : Use &lt;video_track&gt; from the mkv file instead of trying to parse it.</p>
<p>--audio-track=*<audio_track>* : Use &lt;audio_track&gt; from the mkv file instead of trying to parse it.</p>
<dl>
<dt>--audio-delay-ms=<em>&lt;delay_ms&gt;</em></dt>
<dd><p>When importing the audio track, delay by <code>\&lt;delay_ms&gt;</code> milliseconds. e.g., <code>--audio-delay-ms</code>=<code>1000</code> delays by 1 second. Not supported by mp4creator.</p>
</dd>
<dt>--audio-bitrate=<em>&lt;bitrate&gt;</em></dt>
Expand All @@ -45,9 +60,15 @@ <h1 id="options">OPTIONS</h1>
<dt>--keep-temp-files</dt>
<dd><p>Keep all temporary files created while converting.</p>
</dd>
<dt>-v, --verbose</dt>
<dd><p>Print info about what is happening.</p>
</dd>
<dt>-n, --dry-run</dt>
<dd><p>Don't run any commands, but print them in a shellquoted format that can be safely copy-pasted by the user.</p>
</dd>
<dt>--correct-profile-only</dt>
<dd><p>Only correct the profile</p>
</dd>
<dt>--stop-before-extract-video</dt>
<dd><p>Exit before extracting video from <code>\&lt;mkvfile&gt;</code>.</p>
</dd>
Expand All @@ -72,9 +93,6 @@ <h1 id="options">OPTIONS</h1>
<dt><code>\&lt;mkvfile&gt;</code></dt>
<dd><p>The Matroska (.mkv) file you wish to convert.</p>
</dd>
<dt>--correct-profile-only</dt>
<dd><p>Only correct the profile</p>
</dd>
<dt><code>\&lt;rawh264file&gt;</code></dt>
<dd><p>The raw H.264 stream file that will have its profile corrected for use on the PS3.</p>
</dd>
Expand All @@ -83,23 +101,23 @@ <h1 id="author">AUTHOR</h1>
<p>Gavin Beatty <script type="text/javascript">
<!--
h='&#x67;&#x6d;&#x61;&#x69;&#108;&#46;&#x63;&#x6f;&#x6d;';a='&#64;';n='&#x67;&#x61;&#118;&#x69;&#110;&#98;&#x65;&#x61;&#116;&#116;&#x79;';e=n+a+h;
document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'">'+'<code>'+e+'</code>'+'<\/'+'a'+'>');
document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'">'+e+'<\/'+'a'+'>');
// -->
</script><noscript>&#x67;&#x61;&#118;&#x69;&#110;&#98;&#x65;&#x61;&#116;&#116;&#x79;&#32;&#x61;&#116;&#32;&#x67;&#x6d;&#x61;&#x69;&#108;&#32;&#100;&#x6f;&#116;&#32;&#x63;&#x6f;&#x6d;</noscript></p>
<h1 id="resources">RESOURCES</h1>
<p>Website: <a href="http://code.google.com/p/mkvtomp4/"><code class="url">http://code.google.com/p/mkvtomp4/</code></a></p>
<p>Website: <a href="http://code.google.com/p/mkvtomp4/">http://code.google.com/p/mkvtomp4/</a></p>
<h1 id="reporting-bugs">REPORTING BUGS</h1>
<p>Please report all bugs and wishes to <script type="text/javascript">
<!--
h='&#x67;&#x6d;&#x61;&#x69;&#108;&#46;&#x63;&#x6f;&#x6d;';a='&#64;';n='&#x67;&#x61;&#118;&#x69;&#110;&#98;&#x65;&#x61;&#116;&#116;&#x79;';e=n+a+h;
document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'">'+'<code>'+e+'</code>'+'<\/'+'a'+'>');
document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'">'+e+'<\/'+'a'+'>');
// -->
</script><noscript>&#x67;&#x61;&#118;&#x69;&#110;&#98;&#x65;&#x61;&#116;&#116;&#x79;&#32;&#x61;&#116;&#32;&#x67;&#x6d;&#x61;&#x69;&#108;&#32;&#100;&#x6f;&#116;&#32;&#x63;&#x6f;&#x6d;</noscript></p>
<h1 id="copying">COPYING</h1>
<p>mkvtomp4 Copyright (c) 2012 Gavin Beatty, <script type="text/javascript">
<p>mkvtomp4 Copyright (c) 2012, 2013 Gavin Beatty, <script type="text/javascript">
<!--
h='&#x67;&#x6d;&#x61;&#x69;&#108;&#46;&#x63;&#x6f;&#x6d;';a='&#64;';n='&#x67;&#x61;&#118;&#x69;&#110;&#98;&#x65;&#x61;&#116;&#116;&#x79;';e=n+a+h;
document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'">'+'<code>'+e+'</code>'+'<\/'+'a'+'>');
document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'">'+e+'<\/'+'a'+'>');
// -->
</script><noscript>&#x67;&#x61;&#118;&#x69;&#110;&#98;&#x65;&#x61;&#116;&#116;&#x79;&#32;&#x61;&#116;&#32;&#x67;&#x6d;&#x61;&#x69;&#108;&#32;&#100;&#x6f;&#116;&#32;&#x63;&#x6f;&#x6d;</noscript></p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
Expand Down
33 changes: 24 additions & 9 deletions doc/mkvtomp4.1.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% MKVTOMP4(1)
% Gavin Beatty
% December 26, 2012
% November 24, 2013

# NAME

Expand Down Expand Up @@ -32,11 +32,23 @@ We depend on: *mkvtoolnix*, *mpeg4ip* or GPAC's *MP4Box* for the conversion.
\--use-mp4creator, \--use-mp4box
: Specify which mp4 backend to use. mp4creator is the default.

\--mp4creator=*\<mp4creator>
: Specific the command/path to execute *mp4creator*.
\--mp4creator=*\<mp4creator>*
: Use \<mp4creator> as the mp4creator command.

\--mp4box=*\<mp4box>
: Specific the command/path to execute *MP4Box*.
\--mp4box=*\<mp4box>*
: Use \<mp4box> as the mp4box command.

--mkvinfo=*\<mkvinfo>*
: Use \<mkvinfo> as the mkvinfo command.

--mkvextract=\*<mkvextract>*
: Use \<mkvextract> as the mkvextract command.

--video-track=\*<video_track>*
: Use \<video_track> from the mkv file instead of trying to parse it.

--audio-track=\*<audio_track>*
: Use \<audio_track> from the mkv file instead of trying to parse it.

\--audio-delay-ms=*\<delay_ms>*
: When importing the audio track, delay by `\<delay_ms>` milliseconds.
Expand All @@ -59,10 +71,16 @@ We depend on: *mkvtoolnix*, *mpeg4ip* or GPAC's *MP4Box* for the conversion.
\--keep-temp-files
: Keep all temporary files created while converting.

-v, --verbose
: Print info about what is happening.

-n, \--dry-run
: Don't run any commands, but print them in a shellquoted format that can be
safely copy-pasted by the user.

--correct-profile-only
: Only correct the profile

\--stop-before-extract-video
: Exit before extracting video from `\<mkvfile>`.

Expand All @@ -89,9 +107,6 @@ We depend on: *mkvtoolnix*, *mpeg4ip* or GPAC's *MP4Box* for the conversion.
`\<mkvfile>`
: The Matroska (.mkv) file you wish to convert.

--correct-profile-only
: Only correct the profile

`\<rawh264file>`
: The raw H.264 stream file that will have its profile corrected for use on
the PS3.
Expand All @@ -114,7 +129,7 @@ Please report all bugs and wishes to <[email protected]>

# COPYING

mkvtomp4 Copyright \(c) 2012 Gavin Beatty, <[email protected]>
mkvtomp4 Copyright \(c) 2012, 2013 Gavin Beatty, <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
Loading

0 comments on commit b8cfad4

Please sign in to comment.