]> Shamusworld >> Repos - ardour-manual/blob - include/video-timeline-setup.html
Clarify video-tools install, remove symlink suggestion
[ardour-manual] / include / video-timeline-setup.html
1
2 <p>
3   No configuration is required if everything is to meant be run on a single
4   machine, and the version of Ardour comes from <a href="http://www.ardour.org"
5   title="http://www.ardour.org">http://www.ardour.org</a>. Everything is
6   pre-configured and included with the download/install.
7 </p>
8
9 <h2>Single Machine</h2>
10
11 <p>
12   If Ardour is compiled from source, or installed from a 3rd party
13   repository, three additional tools will need to be installed manually, which are
14   used by Ardour to provide video features:
15 </p>
16
17 <ul>
18   <li>xjadeo (the video monitor application): <a
19     href="http://xjadeo.sourceforge.net/" title="http://xjadeo.sourceforge.net/"
20     rel="nofollow">http://xjadeo.sf.net</a></li>
21   <li>harvid (a video decoder used for the thumbnail timeline):
22     <a href="http://x42.github.io/harvid/" title="http://x42.github.io/harvid/"
23     rel="nofollow">http://x42.github.com/harvid/</a></li>
24   <li>ffmpeg, ffprobe (used to import/export video, extract soundtracks and query
25     video information and encode mp3 for export): <a
26     href="http://ffmpeg.org" title="http://ffmpeg.org"
27     rel="nofollow">http://ffmpeg.org</a></li>
28 </ul>
29
30 <p>
31   Ardour requires xjadeo &ge; version 0.6.4, harvid &ge; version 0.7.0 and
32   ffmpeg (known to work versions: 1.2, 2.8.2, 5.0)
33 </p>
34
35 <p>
36   The Ardour development team is in control of the first two applications.
37   ffmpeg however can be a bit of a problem. To avoid conflicts with distribution
38   packages, Ardour looks for <code>ffmpeg_harvid</code> and
39   <code>ffprobe_harvid</code>.
40 </p>
41
42 <p>
43   All four applications need to be found in <code>$PATH</code> (e.g.
44   <code>$HOME/bin</code> or <code>/usr/local/bin</code>). For convenience the
45   binary releases of harvid include ffmpeg_harvid and ffprobe_harvid.
46   Ardour binaries from ardour.org do include all relevant tools and most
47   GNU/Linux distributions also provide those.
48 </p>
49
50 <p>
51   Binary releases of the video-tools are available from ardour.org via a dedicated installer script:
52   <a href="https://github.com/Ardour/ardour/blob/master/tools/videotimeline/install_video_tools.sh"
53   title="https://github.com/Ardour/ardour/blob/master/tools/videotimeline/install_video_tools.sh"
54   rel="nofollow">install_video_tools.sh</a>.
55 </p>
56
57 <p>
58   The easiest way to install the video-utilities on Linux is by running the following
59   line in a terminal:
60 </p>
61
62 <kbd class="cmd lin">sh -c &quot;$(curl -s -L http://git.io/tVUCkw)&quot;</kbd>
63
64 <h2>Studio Setup</h2>
65
66 <p>
67   As Setting up a proper A/V post-production studio can be a complicated task, it
68   is advised to read the info in the previous section to get familiar with
69   the tools involved first. As much as the Ardour team streamlines and simplifies
70   the <em>single machine</em> setup, the <dfn>studio setup</dfn> is focused on
71   modularity.
72 </p>
73
74 <ul class="fixme">
75   <li>TODO:</li>
76   <li>Synchronization ardour &rarr; video-display-box should be accomplished by
77     external means. Jack-transport(netjack), MTC, LTC
78     (<abbr title="Open Sound Control&mdash;&quot;postmodern MIDI&quot;">OSC</abbr>
79     and/or ssh-pipe work but introduce additional latency + jitter)</li>
80   <li>Ardour launches <code>XJREMOTE</code> (environment variable, default
81     &#039;xjremote&#039; which comes with xjadeo).</li>
82   <li>Either use a custom shell script that ssh&#039;es into the remote box and
83     launches/controls xjadeo there, selects the sync-source and passes though
84     communication between ardour &iff; xjadeo via ssh (xjadeo is launched stopped with
85     the session).</li>
86   <li>&hellip;or override xjremote&#039;s behavior&mdash;instead of IPC with a local
87     running xjadeo-process, using <abbr title="Open Sound
88     Control&mdash;&quot;postmodern MIDI&quot;">OSC</abbr> for example. Xjadeo would
89     run permanently and Ardour will just tell it to load files and set offsets via
90     <acronym title="Open Sound Control&mdash;&quot;postmodern
91     MIDI&quot;">OSC</acronym>. See <a
92     href="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=contrib/xjremote-osc"
93     title="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=contrib/xjremote-osc"
94     rel="nofollow">xjremote-osc</a> example script.</li>
95   <li>If the video server runs remotely, Ardour needs to be configured in Ardour &gt;
96     Preference &gt; Video (hostname of the video-server).</li>
97   <li>Ideally the machines have a common shared folder (NFS or similar).
98     Ardour&#039;s import (audio-extract) and export (mux) functionality depends on
99     having access to the video file. Also Ardour's video-import transcodes the file
100     into a suitable proxy-format that allows reliable seeking to any
101     frame&hellip;</li>
102 </ul>