ardour/manual
13
0
Fork 0
Code Pull Requests Releases Activity

more passive form, some external links

Browse Source
This commit is contained in:
Ed Ward 2019-01-04 11:38:43 +01:00
parent dca83f1e5d
commit 74636938f3
3 changed files with 127 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/transcoding-formats-amp-codecs.html
View File

@ -1,13 +1,14 @@
<p>
This chapter provides a short primer on video files, formats and
codecs – because it is often cause for confusion:
codecs &ndash; because it is often cause for confusion:
</p>
<p>
A video file is a <dfn>container</dfn>. It usually contains one
<dfn>video track</dfn> and one or more <dfn>audio tracks</dfn>.
How these tracks are stored in the file is defined by the
<dfn>video track</dfn>, one or more <dfn>audio tracks</dfn>, and possibly <dfn>
subtitle</dfn> tracks, <dfn>chapters</dfn>&hellip;
The way these tracks are stored in the file is defined by the
<dfn>file format</dfn>. Common formats are
avi, mov, ogg, mkv, mpeg, mpeg-ts, mp4, flv, or vob.
</p>
@ -20,7 +21,7 @@
<p>
Not all codecs can be packed into a given format. For example the
mpeg format is limited to mpeg2, mpeg4 and mp3 codecs (not entirely true).
DVDs do have stringent limitations as well. The opposite would be .avi;
DVDs do have stringent limitations as well. The opposite would be .avi:
pretty much every audio/video codec combination can be contained in an avi
file-format.
</p>
@ -47,8 +48,8 @@
</p>
<p>
The export dialog includes presets for common format and codec
combinations (such as DVD, web-video,..). If in doubt use one of the
presets.
combinations (such as DVD, web-video,..). If in doubt, one of the
presets should be used.
</p>
<p>
As a last note: every time a video is transcoded, the quality can only get
@ -56,4 +57,3 @@
title="Multiplexing Audio and Video">muxing</abbr> process, one should
always go back and use the original source of the video.
</p>

82
include/video-timeline-setup.html
View File

@ -1,45 +1,64 @@
<p>
No configuration is required if you intend to run everything on a single machine, and if you acquired Ardour from <a href="http://www.ardour.org" title="http://www.ardour.org">http://www.ardour.org</a>. Everything is pre-configured and included with the download/install.
No configuration is required if everything is to meant be run on a single
machine, and the version of Ardour comes from <a href="http://www.ardour.org"
title="http://www.ardour.org">http://www.ardour.org</a>. Everything is
pre-configured and included with the download/install.
</p>
<h2>Single Machine</h2>
<p>
If you compile Ardour from source, or have installed it from a 3rd party repository, three additional tools will need to be installed manually, which are used by Ardour to provide video features:
If Ardour is compiled from source, or installed from a 3rd party
repository, three additional tools will need to be installed manually, which are
used by Ardour to provide video features:
</p>
<ul>
<li>xjadeo (the video monitor application): <a href="http://xjadeo.sourceforge.net/" title="http://xjadeo.sourceforge.net/" rel="nofollow">http://xjadeo.sf.net</a></li>
<li>harvid (a video decoder used for the thumbnail timeline): <a href="http://x42.github.io/harvid/" title="http://x42.github.io/harvid/" rel="nofollow">http://x42.github.com/harvid/</a></li>
<li>ffmpeg, ffprobe (used to import/export video, extract soundtracks and query video information): <a href="http://ffmpeg.org" title="http://ffmpeg.org" rel="nofollow">http://ffmpeg.org</a></li>
<li>xjadeo (the video monitor application): <a
href="http://xjadeo.sourceforge.net/" title="http://xjadeo.sourceforge.net/"
rel="nofollow">http://xjadeo.sf.net</a></li>
<li>harvid (a video decoder used for the thumbnail timeline):
<a href="http://x42.github.io/harvid/" title="http://x42.github.io/harvid/"
rel="nofollow">http://x42.github.com/harvid/</a></li>
<li>ffmpeg, ffprobe (used to import/export video, extract soundtracks and query
video information): <a href="http://ffmpeg.org" title="http://ffmpeg.org"
rel="nofollow">http://ffmpeg.org</a></li>
</ul>
<p>
Ardour requires xjadeo &ge; version 0.6.4, harvid &ge; version 0.7.0 and ffmpeg (known to work versions: 1.2, 2.8.2)
Ardour requires xjadeo &ge; version 0.6.4, harvid &ge; version 0.7.0 and
ffmpeg (known to work versions: 1.2, 2.8.2)
</p>
<p>
The Ardour development team is in control of the first two applications. ffmpeg however can be a bit of a problem. To avoid conflicts with distribution packages, Ardour looks for <code>ffmpeg_harvid</code> and <code>ffprobe_harvid</code>.
The Ardour development team is in control of the first two applications.
ffmpeg however can be a bit of a problem. To avoid conflicts with distribution
packages, Ardour looks for <code>ffmpeg_harvid</code> and
<code>ffprobe_harvid</code>.
</p>
<p>
All four applications need to be found in <code>$PATH</code> (e.g.
<code>$HOME/bin</code> or <code>/usr/local/bin</code>). For convenience the
binary releases of harvid include ffmpeg_harvid and ffprobe_harvid, but if
your distribution provides suitable ffmpeg commands you can also just create
symbolic links:
binary releases of harvid include ffmpeg_harvid and ffprobe_harvid, but if the
distribution provides suitable ffmpeg commands, symbolic links can be created
to the distribution-provided binaries:
</p>
<kbd class="cmd lin">sudo ln -s /usr/bin/ffmpeg /usr/bin/ffmpeg_harvid</kbd>
<kbd class="cmd lin">sudo ln -s /usr/bin/ffprobe /usr/bin/ffprobe_harvid</kbd>
<p>
Binary releases are available from ardour.org as well as an installer script: <a href="https://github.com/Ardour/ardour/blob/master/tools/videotimeline/install_video_tools.sh" title="https://github.com/Ardour/ardour/blob/master/tools/videotimeline/install_video_tools.sh" rel="nofollow">install_video_tools.sh</a>.
Binary releases are available from ardour.org as well as an installer script:
<a href="https://github.com/Ardour/ardour/blob/master/tools/videotimeline/install_video_tools.sh"
title="https://github.com/Ardour/ardour/blob/master/tools/videotimeline/install_video_tools.sh"
rel="nofollow">install_video_tools.sh</a>.
</p>
<p>
The easiest way to install the video-utilities is by running the following line in a terminal:
The easiest way to install the video-utilities is by running the following
line in a terminal:
</p>
<kbd class="cmd lin">sh -c &quot;$(curl -s -L http://git.io/tVUCkw)&quot;</kbd>
@ -47,16 +66,39 @@
<h2>Studio Setup</h2>
<p>
Please read the info in the previous section to familiarize yourself with the tools involved first. Setting up a proper A/V post-production studio can be a complicated task. As much as we streamline and simplify the <em>single machine</em> setup, the <dfn>studio setup</dfn> is focused on modularity.
As Setting up a proper A/V post-production studio can be a complicated task, it
is advised to read the info in the previous section to get familiar with
the tools involved first. As much as the Ardour team streamlines and simplifies
the <em>single machine</em> setup, the <dfn>studio setup</dfn> is focused on
modularity.
</p>
<ul class="fixme">
<li>TODO:</li>
<li>Synchronization ardour → video-display-box should be accomplished by external means jack-transport(netjack), MTC, LTC (<abbr title="Open Sound Control&mdash;&quot;postmodern MIDI&quot;">OSC</abbr> and/or ssh-pipe work but introduce additional latency + jitter)</li>
<li>Ardour launches <code>XJREMOTE</code> (environment variable, default &#039;xjremote&#039; which comes with xjadeo).</li>
<li>Either use a custom shell script that ssh&#039;es into the remote box and launches/controls xjadeo there, selects the sync-source and passes though communication between ardour ⇔ xjadeo via ssh (xjadeo is launched stopped with the session).</li>
<li>..or override xjremote&#039;s behavior&mdash;instead of IPC with a local running xjadeo-process, using <abbr title="Open Sound Control&mdash;&quot;postmodern MIDI&quot;">OSC</abbr> for example. xjadeo would run permanently and Ardour will just tell it to load files and set offsets via <acronym title="Open Sound Control&mdash;&quot;postmodern MIDI&quot;">OSC</acronym>. see <a href="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=contrib/xjremote-osc" title="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=contrib/xjremote-osc" rel="nofollow">xjremote-osc</a> example script.</li>
<li>If the video server runs remotely, Ardour needs to be configured in Ardour &gt; Preference &gt; Video (hostname of the video-server).</li>
<li>Ideally the machines have a common shared folder (NFS or similar). Ardour&#039;s import (audio-extract) and export (mux) functionality depends on having access to the video file. Also Ardour's video-import transcodes the file into a suitable proxy-format that allows reliable seeking to any frame&hellip;</li>
<li>Synchronization ardour &rarr; video-display-box should be accomplished by
external means. Jack-transport(netjack), MTC, LTC
(<abbr title="Open Sound Control&mdash;&quot;postmodern MIDI&quot;">OSC</abbr>
and/or ssh-pipe work but introduce additional latency + jitter)</li>
<li>Ardour launches <code>XJREMOTE</code> (environment variable, default
&#039;xjremote&#039; which comes with xjadeo).</li>
<li>Either use a custom shell script that ssh&#039;es into the remote box and
launches/controls xjadeo there, selects the sync-source and passes though
communication between ardour &iff; xjadeo via ssh (xjadeo is launched stopped with
the session).</li>
<li>&hellip;or override xjremote&#039;s behavior&mdash;instead of IPC with a local
running xjadeo-process, using <abbr title="Open Sound
Control&mdash;&quot;postmodern MIDI&quot;">OSC</abbr> for example. Xjadeo would
run permanently and Ardour will just tell it to load files and set offsets via
<acronym title="Open Sound Control&mdash;&quot;postmodern
MIDI&quot;">OSC</acronym>. See <a
href="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=contrib/xjremote-osc"
title="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=contrib/xjremote-osc"
rel="nofollow">xjremote-osc</a> example script.</li>
<li>If the video server runs remotely, Ardour needs to be configured in Ardour &gt;
Preference &gt; Video (hostname of the video-server).</li>
<li>Ideally the machines have a common shared folder (NFS or similar).
Ardour&#039;s import (audio-extract) and export (mux) functionality depends on
having access to the video file. Also Ardour's video-import transcodes the file
into a suitable proxy-format that allows reliable seeking to any
frame&hellip;</li>
</ul>

78
include/workflow-amp-operations.html
View File

@ -21,15 +21,22 @@
<h2>Adding Video</h2>
<p>
Adding video is a two-step process: select a video file, and choose
import mode and optionally select an audio track to extract.
Adding video is a two-step process: selecting a video file, and choosing
import mode and optionally selecting an audio track to extract.
</p>
<p>
The first step is rather straight-forward. The panel on the right side
allows to seek through the video and displays basic file information.
It is also useful to check if the video format/codec is supported:
</p>
<img src="/images/a3_video_open.png" alt="video-open-dialog" width="300" />
<figure class="center">
<img src="/images/a3_video_open.png" alt="The video open dialog">
<figcaption>
The video open dialog
</figcaption>
</figure>
<p>
The second step analyzes the video file in more detail and offers import options:
</p>
@ -42,31 +49,53 @@
machine).</td></tr>
<tr><th><kbd class="menu">Reference from Current Location</kbd></th>
<td>Only useful for opening files that were previously encoded (are already
in a good format/codec). Use with care.</td></tr>
in a good format/codec). Should be used with care.</td></tr>
<tr><th><kbd class="menu">Do not Import Video</kbd></th>
<td>Useful for extracting audio only.</td></tr>
</table>
<img src="/images/a3_video_import.png" alt="Video Import Dialog" width="300" />
<figure class="center">
<img src="/images/a3_video_import.png" alt="The Video Import dialog">
<figcaption>
The Video Import dialog
</figcaption>
</figure>
<p>
By default the video is imported using the original width/height.
If it is a large video (e.g. full-HD) it makes sense to scale it down
If it is a large video (e.g. full-HD), it makes sense to scale it down
to decrease the CPU load and disk I/O required to decode and play the
file.<br>
file.
</p>
<p>
A small, low-quality representation of the image is usually sufficient
for editing soundtracks. The default bitrate in kbit/sec is set to use
0.7 bits per pixel. (Compare: the average DVD medium uses 5000&nbsp;kbit/s;
at PAL resolution this is about 0.5 bits per pixel. But the DVD is
0.7 bits per pixel (in comparison, the average DVD medium uses 5000&nbsp;kbit/s;
at PAL resolution this is about 0.5 bits per pixel, but the DVD is
using the <dfn>mpeg2</dfn>&mdash;a denser compression algorithm than the
<dfn>mjpeg</dfn> codec used by Ardour.)
<dfn>mjpeg</dfn> codec used by Ardour).
</p>
<h2>Working with A/V</h2>
<p>
Well now,..
Working with A/V in Ardour is similar to working in a pure audio setup, except
for the presence of a video timeline in the <a href="@@ruler">ruler</a> zone,
and a Xjadeo video window, showing a preview of the result.
</p>
<figure class="center">
<img class= "mini" src="/images/a3_videotimeline.png" alt="The Video Timeline">
<figcaption>
The Video Timeline
</figcaption>
</figure>
<p>
The Xjadeo window supports some user interactions, such as showing some OSD
information or changing the zoom level. Xjadeo's documentation is available
on its <a href="http://xjadeo.sourceforge.net/xjadeo.html#heading8">website</a>.
</p>
<img src="/images/a3_videotimeline.png" alt="Video Timeline" width="600" />
<h2 id="export">Exporting Video</h2>
<p>
@ -94,22 +123,29 @@
</p>
<p>
The file format is determined by the extension that you choose for it
(.avi, .mov, .flv, .ogv, .webm,&hellip;)
The file format is determined by the extension chosen for it
(.avi, .mov, .flv, .ogv, .webm,&hellip;).
Note: not all combinations of format, codec, and settings produce files
which are according to specifications. For example, flv files require
sample rates of 22.1&nbsp;kHz or 44.1&nbsp;kHz, mpeg containers can not
be used with ac3 audio-codec, etc. If in doubt, use one of the built-in
presets.
be used with ac3 audio-codec, etc. If in doubt, one of the built-in
presets should be used.
</p>
<img src="/images/a3_video_export.png" alt="Video Export Dialog" width="300" />
<figure class="center">
<img src="/images/a3_video_export.png" alt="The Video Export Dialog">
<figcaption>
The Video Export Dialog
</figcaption>
</figure>
<p>
Ardour video export is not recommended for mastering! While ffmpeg
(which is used by Ardour) can produce high-quality files, this export
lacks the possibility to tweak many settings. We recommend using winff,
devede or dvdauthor to mux and master. Nevertheless this video-export comes in
handy to do quick snapshots, intermediates, dailies or online videos.
lacks the possibility to tweak many settings. We recommend using
<a href="http://www.biggmatt.com/winff/">winff</a>,
<a href="http://www.rastersoft.com/programas/devede.html">devede</a> or
<a href="http://dvdauthor.sourceforge.net/">dvdauthor</a> to mux and master.
Nevertheless this video-export comes in handy to do quick snapshots,
intermediates, dailies or online videos.
</p>