0 | 0 |
<?xml version="1.0" encoding="UTF-8"?>
|
1 | |
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
2 | |
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
|
|
1 |
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
|
3 | 2 |
<article lang="en">
|
4 | 3 |
<articleinfo>
|
5 | |
<title><application>xjadeo</application> - X Jack Video Monitor</title>
|
6 | |
<subtitle><ulink url="http://xjadeo.sourceforge.net"></ulink></subtitle>
|
|
4 |
<title><application>Xjadeo</application> - X Jack Video Monitor</title>
|
|
5 |
|
|
6 |
<subtitle><ulink url="http://xjadeo.sourceforge.net"/></subtitle>
|
|
7 |
|
7 | 8 |
<copyright>
|
8 | 9 |
<year>2005</year>
|
|
10 |
|
9 | 11 |
<year>2006</year>
|
|
12 |
|
10 | 13 |
<year>2007</year>
|
|
14 |
|
11 | 15 |
<year>2009</year>
|
|
16 |
|
12 | 17 |
<year>2010</year>
|
|
18 |
|
13 | 19 |
<holder>Robin Gareus, Luis Garrido</holder>
|
14 | 20 |
</copyright>
|
15 | |
|
|
21 |
|
16 | 22 |
<author>
|
17 | 23 |
<firstname>Robin</firstname>
|
|
24 |
|
18 | 25 |
<surname>Gareus</surname>
|
|
26 |
|
19 | 27 |
<email>robin@gareus.org</email>
|
|
28 |
|
20 | 29 |
<personblurb>
|
21 | 30 |
<para>linuxaudio.org</para>
|
22 | 31 |
</personblurb>
|
23 | 32 |
</author>
|
24 | 33 |
|
|
34 |
<author>
|
|
35 |
<firstname>Luis Garrido</firstname>
|
|
36 |
|
|
37 |
<email>luisgarrido@users.sourceforge.net</email>
|
|
38 |
|
|
39 |
<personblurb>
|
|
40 |
<para>luisgarrido.users.sourceforge.net</para>
|
|
41 |
</personblurb>
|
|
42 |
</author>
|
|
43 |
|
25 | 44 |
<abstract>
|
26 | |
<para>
|
27 | |
<mediaobject>
|
|
45 |
<para><mediaobject>
|
28 | 46 |
<imageobject>
|
29 | |
<imagedata fileref="xjadeo.png" align="center" valign="top"/>
|
|
47 |
<imagedata align="center" fileref="xjadeo.eps" valign="top" format="EPS"/>
|
30 | 48 |
</imageobject>
|
31 | |
</mediaobject>
|
32 | |
</para>
|
33 | |
|
34 | |
<para><application>xjadeo</application> is a software video player
|
35 | |
that displays a video-clip in sync with an external time source
|
36 | |
(MTC, LTC, JACK-transport).</para>
|
37 | |
|
38 | |
<para>It has applications in soundtrack composition, video monitoring or
|
39 | |
any task that requires to associate movie frames with audio events.
|
40 | |
</para>
|
41 | |
|
42 | |
<para><application>xjadeo</application> supports a multitude of video file
|
43 | |
formats, display libraries and sync sources. It includes an optional
|
44 | |
GUI <application>qjadeo</application> that provides file-history,
|
45 | |
video-import/transcoding and
|
46 | |
allows to modify settings of a running <application>xjadeo</application>
|
47 | |
instance.</para>
|
48 | |
|
49 | |
<para><application>xjadeo</application> is being developed on the
|
50 | |
GNU/Linux operating system, but not limited to it. There are binaries
|
51 | |
available for Win32 and OSX.</para>
|
52 | |
|
53 | |
<para>Quick access links:
|
54 | |
<ulink
|
55 | |
url="http://sourceforge.net/projects/xjadeo/">SF-Project Page</ulink>
|
56 | |
|
57 | |
<ulink
|
58 | |
url="http://sourceforge.net/projects/xjadeo/files/">Download</ulink>
|
59 | |
|
60 | |
<ulink
|
61 | |
url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo"
|
62 | |
>Source-Code</ulink>
|
63 | |
|
64 | |
<ulink
|
65 | |
url="http://xjadeo.sourceforge.net/xjadeo.pdf">This manual as PDF
|
66 | |
</ulink>
|
67 | |
</para>
|
|
49 |
<imageobject>
|
|
50 |
<imagedata align="center" fileref="xjadeo.png" valign="top" format="PNG"/>
|
|
51 |
</imageobject>
|
|
52 |
</mediaobject></para>
|
|
53 |
|
|
54 |
<para><application>Xjadeo</application> is a software video player that
|
|
55 |
displays a video-clip in sync with an external time source (MTC, LTC,
|
|
56 |
JACK-transport).</para>
|
|
57 |
|
|
58 |
<para><application>Xjadeo</application> is useful in soundtrack
|
|
59 |
composition, video monitoring or any task that requires to synchronizing
|
|
60 |
movie frames with audio events.</para>
|
|
61 |
|
|
62 |
<para><application>Xjadeo</application> supports a multitude of video
|
|
63 |
file formats, display libraries and sync sources. It includes an
|
|
64 |
optional GUI <application>called qjadeo</application> that provides
|
|
65 |
setup options, file history, video import/transcoding and control of
|
|
66 |
<application>Xjadeo</application>'s run-time parameters.</para>
|
|
67 |
|
|
68 |
<para>Primarily developed for the GNU/Linux operating system, there are
|
|
69 |
also binaries available for Win32 and OSX.</para>
|
|
70 |
|
|
71 |
<para>Quick access links: <ulink url="http://sourceforge.net/projects/xjadeo/">SF-Project Page</ulink>
|
|
72 |
<ulink url="http://sourceforge.net/projects/xjadeo/files/">Download</ulink>
|
|
73 |
<ulink url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo">Source-Code</ulink>
|
|
74 |
<ulink url="http://xjadeo.sourceforge.net/xjadeo.pdf">This manual as
|
|
75 |
PDF </ulink></para>
|
68 | 76 |
</abstract>
|
|
77 |
|
|
78 |
<revhistory>
|
|
79 |
<revision>
|
|
80 |
<revnumber>0.6-r1</revnumber>
|
|
81 |
|
|
82 |
<date>16 Nov 2010</date>
|
|
83 |
|
|
84 |
<revremark>Improved English by Geoff Beasley.</revremark>
|
|
85 |
</revision>
|
|
86 |
</revhistory>
|
69 | 87 |
</articleinfo>
|
70 | 88 |
|
71 | |
<!-- CHAPTER -->
|
|
89 |
<!-- CHAPTER -->
|
72 | 90 |
|
73 | 91 |
<section id="about">
|
74 | 92 |
<title>About</title>
|
|
93 |
|
75 | 94 |
<section id="features">
|
76 | 95 |
<title>FEATURES</title>
|
77 | |
<para><application>xjadeo</application> - video Monitor </para>
|
|
96 |
|
|
97 |
<para><application>Xjadeo</application> - video Monitor</para>
|
78 | 98 |
|
79 | 99 |
<itemizedlist>
|
80 | 100 |
<listitem>
|
81 | 101 |
<para>Display: full-screen or windowed mode, letterbox, timecode
|
82 | |
on-screen-display.
|
83 | |
<itemizedlist>
|
|
102 |
on-screen-display. <itemizedlist>
|
84 | 103 |
<listitem>
|
85 | 104 |
<para>XV/X11 (hardware accelerated)</para>
|
86 | 105 |
</listitem>
|
|
96 | 115 |
<listitem>
|
97 | 116 |
<para>carbon/quartz (hardware accelerated - OSX)</para>
|
98 | 117 |
</listitem>
|
99 | |
</itemizedlist>
|
100 | |
</para>
|
|
118 |
</itemizedlist></para>
|
101 | 119 |
</listitem>
|
102 | 120 |
|
103 | 121 |
<listitem>
|
104 | |
<para>Video decoding via <ulink
|
105 | |
url="http://ffmpeg.org/">FFMPEG</ulink>;
|
106 | |
<application>xjadeo</application> supports a multitude of
|
107 | |
file-formats and video codecs.
|
108 | |
</para>
|
|
122 |
<para>Video decoding via <ulink url="http://ffmpeg.org/">FFMPEG</ulink>;
|
|
123 |
<application>Xjadeo</application> supports a multitude of
|
|
124 |
file-formats and video codecs.</para>
|
109 | 125 |
</listitem>
|
110 | 126 |
|
111 | 127 |
<listitem>
|
112 | 128 |
<para>Sync sources:<itemizedlist>
|
113 | 129 |
<listitem>
|
114 | 130 |
<para><ulink url="http://jackaudio.org/">JACK</ulink>
|
115 | |
transport mechanism.</para>
|
|
131 |
<ulink url="http://jackaudio.org/files/docs/html/transport-design.html">transport mechanism</ulink>.</para>
|
116 | 132 |
</listitem>
|
|
133 |
|
117 | 134 |
<listitem>
|
118 | |
<para><ulink
|
119 | |
url="http://en.wikipedia.org/wiki/MIDI_timecode">MTC</ulink>
|
120 | |
using either ALSA-MIDI , JACK-MIDI or portmidi.</para>
|
|
135 |
<para><ulink url="http://en.wikipedia.org/wiki/MIDI_timecode">MTC</ulink>
|
|
136 |
using either ALSA-MIDI , JACK-MIDI or portmidi.</para>
|
121 | 137 |
</listitem>
|
|
138 |
|
122 | 139 |
<listitem>
|
123 | |
<para><ulink
|
124 | |
url="http://en.wikipedia.org/wiki/Linear_timecode">LTC</ulink>
|
125 | |
using JACK-audio</para>
|
|
140 |
<para><ulink url="http://en.wikipedia.org/wiki/Linear_timecode">LTC</ulink>
|
|
141 |
using JACK-audio</para>
|
126 | 142 |
</listitem>
|
127 | 143 |
</itemizedlist></para>
|
128 | |
</listitem>
|
|
144 |
</listitem>
|
129 | 145 |
|
130 | 146 |
<listitem>
|
131 | 147 |
<para>frame-accurate: tested with 23.976, 24, 24.976, 25, 29.97df,
|
132 | |
30, 59.94 and 60 fps video-files.</para>
|
|
148 |
30, 59.94 and 60 fps video-files.</para>
|
133 | 149 |
</listitem>
|
134 | 150 |
|
135 | 151 |
<listitem>
|
|
137 | 153 |
</listitem>
|
138 | 154 |
|
139 | 155 |
<listitem>
|
140 | |
<para>Remote-control interface allows to query and modify all
|
141 | |
settings and parameters of a running instance.
|
142 | |
<itemizedlist>
|
143 | |
<listitem><para>OSC - <ulink
|
144 | |
url="http://opensoundcontrol.org/">Opensoundcontrol</ulink>
|
145 | |
</para></listitem>
|
146 | |
<listitem><para>Standard I/O</para></listitem>
|
147 | |
<listitem><para>POSIX real-time message queues (MQ)</para></listitem>
|
148 | |
<listitem><para>System-V IPC</para></listitem>
|
149 | |
</itemizedlist>
|
150 | |
</para>
|
|
156 |
<para>Remote-control interface allows you to query and modify all
|
|
157 |
settings and parameters of a running instance. <itemizedlist>
|
|
158 |
<listitem>
|
|
159 |
<para>OSC - <ulink url="http://opensoundcontrol.org/">Opensoundcontrol</ulink></para>
|
|
160 |
</listitem>
|
|
161 |
|
|
162 |
<listitem>
|
|
163 |
<para>Standard I/O</para>
|
|
164 |
</listitem>
|
|
165 |
|
|
166 |
<listitem>
|
|
167 |
<para>POSIX real-time message queues (MQ)</para>
|
|
168 |
</listitem>
|
|
169 |
|
|
170 |
<listitem>
|
|
171 |
<para>System-V IPC</para>
|
|
172 |
</listitem>
|
|
173 |
</itemizedlist></para>
|
151 | 174 |
</listitem>
|
152 | 175 |
|
153 | 176 |
<listitem>
|
154 | 177 |
<para>Optional Qt Graphical User interface to control
|
155 | |
<application>xjadeo</application>.</para>
|
|
178 |
<application>Xjadeo</application>.</para>
|
156 | 179 |
</listitem>
|
157 | |
|
158 | 180 |
</itemizedlist>
|
159 | 181 |
</section>
|
160 | 182 |
|
161 | 183 |
<section id="license">
|
162 | 184 |
<title>LICENSE</title>
|
163 | 185 |
|
164 | |
<para><application>xjadeo</application> is free software; you can
|
165 | |
redistribute it and/or modify it under the terms of the GNU General Public
|
166 | |
License as published by the Free Software Foundation; either version 2 of
|
167 | |
the License, or (at your option) any later version.</para>
|
168 | |
|
169 | |
<para>This program is distributed in the hope that it will be useful, but
|
170 | |
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
171 | |
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
172 | |
for more details.</para>
|
|
186 |
<para><application>Xjadeo</application> is free software; you can
|
|
187 |
redistribute it and/or modify it under the terms of the GNU General
|
|
188 |
Public License as published by the Free Software Foundation; either
|
|
189 |
version 2 of the License, or (at your option) any later version.</para>
|
|
190 |
|
|
191 |
<para>This program is distributed in the hope that it will be useful,
|
|
192 |
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
193 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
|
|
194 |
Public License for more details.</para>
|
173 | 195 |
|
174 | 196 |
<para>You should receive a copy of the GNU General Public License along
|
175 | |
with the program; if not, write to the Free Software Foundation, Inc., 59
|
176 | |
Temple Place, Suite 330, Boston, MA 02111-1307 USA</para>
|
|
197 |
with the program; if not, write to the Free Software Foundation, Inc.,
|
|
198 |
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</para>
|
177 | 199 |
</section>
|
178 | |
|
179 | 200 |
</section>
|
180 | 201 |
|
181 | |
<!-- CHAPTER -->
|
|
202 |
<!-- CHAPTER -->
|
182 | 203 |
|
183 | 204 |
<section id="build_instructions" xreflabel="Build and Install Instructions">
|
184 | 205 |
<title>Build and Install Instructions</title>
|
185 | 206 |
|
186 | 207 |
<section id="system_requirements">
|
187 | 208 |
<title>System Requirements</title>
|
188 | |
<para><application>xjadeo</application> is currently known to work on
|
189 | |
GNU/Linux, *BSD, Win32 and Mac OSX. There are no special hardware
|
190 | |
requirements.</para>
|
|
209 |
|
|
210 |
<para><application>Xjadeo</application> is currently known to work on
|
|
211 |
GNU/Linux, *BSD, Win32 and Mac OSX. There are no special hardware
|
|
212 |
requirements.</para>
|
191 | 213 |
</section>
|
192 | 214 |
|
193 | 215 |
<section id="section_binaries">
|
194 | |
<title id="binaries" >Binaries</title>
|
195 | |
<para>If you are using a "major" GNU/Linux distribution (Debian,
|
196 | |
Fedora, Ubuntu, SuSe, Gentoo, Slackware, etc.),
|
197 | |
you can acquire <application>xjadeo</application> directly from
|
198 | |
your distribution.
|
199 | |
It can be installed using the normal software installation tools
|
200 | |
for your distribution.
|
201 | |
In case your distribution does not provide, or only ships an old
|
202 | |
version of <application>xjadeo</application>,
|
203 | |
you can build it from <xref linkend="src"/>.</para>
|
204 | |
|
205 | |
<para>Windows and Mac/OSX binaries are available from the
|
206 | |
<ulink url="http://sourceforge.net/projects/xjadeo/files/">Sourceforge
|
207 | |
Download Page</ulink>. Note that you'll need to install
|
208 | |
<ulink
|
209 | |
url="http://jackaudio.org/download">JACK for OSX or Windows.</ulink>
|
210 | |
in order to use <application>xjadeo</application>.
|
211 | |
</para>
|
|
216 |
<title id="binaries">Binaries</title>
|
|
217 |
|
|
218 |
<para>If you are using a "major" GNU/Linux distribution (Debian, Fedora,
|
|
219 |
Ubuntu, SuSe, Gentoo, Slackware, etc.), you can acquire
|
|
220 |
<application>Xjadeo</application> directly from your distribution. It
|
|
221 |
can be installed using the normal software installation tools for your
|
|
222 |
distribution. In case your distribution does not provide or only ships
|
|
223 |
an old version of <application>Xjadeo</application>, you can build it
|
|
224 |
from <xref linkend="src"/>.</para>
|
|
225 |
|
|
226 |
<para>Windows and Mac/OSX binaries are available from the <ulink url="http://sourceforge.net/projects/xjadeo/files/">Sourceforge Download
|
|
227 |
Page</ulink>. Note that you'll need to install <ulink url="http://jackaudio.org/download">JACK for OSX or Windows.</ulink> in
|
|
228 |
order to use <application>Xjadeo</application>.</para>
|
212 | 229 |
</section>
|
213 | 230 |
|
214 | |
<section id="src" xreflabel="source">
|
|
231 |
<section id="src" xreflabel="source">
|
215 | 232 |
<title>Source</title>
|
216 | |
<para><application>xjadeo</application> is developed using a
|
217 | |
git-repository at <ulink
|
218 | |
url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo"
|
219 | |
>git://xjadeo.git.sourceforge.net/gitroot/xjadeo/xjadeo</ulink>.
|
220 | |
In case you are unfamiliar with git, Sourceforge provides <ulink
|
221 | |
url="http://sourceforge.net/scm/?type=git&group_id=131926"
|
222 | |
>information</ulink>
|
223 | |
on how to access it.</para>
|
224 | |
|
225 | |
<para><application>xjadeo</application> is also available as <ulink
|
226 | |
url="http://sourceforge.net/projects/xjadeo/files/"
|
227 | |
>source code package</ulink>.</para>
|
|
233 |
|
|
234 |
<para><application>Xjadeo</application> is developed using a
|
|
235 |
git-repository at <ulink url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo">git://xjadeo.git.sourceforge.net/gitroot/xjadeo/xjadeo</ulink>.
|
|
236 |
In case you are unfamiliar with git, Sourceforge provides <ulink url="http://sourceforge.net/scm/?type=git&group_id=131926">information</ulink>
|
|
237 |
on how to access it.</para>
|
|
238 |
|
|
239 |
<para><application>Xjadeo</application> is also available as <ulink url="http://sourceforge.net/projects/xjadeo/files/">source code
|
|
240 |
package</ulink>.</para>
|
228 | 241 |
</section>
|
229 | 242 |
|
230 | 243 |
<section id="build_depends" xreflabel="build dependencies">
|
231 | 244 |
<title>Build Dependencies</title>
|
232 | 245 |
|
233 | |
<para>In order to compile the xjadeo from source, you will need the
|
234 | |
"development" (-dev) version of the following libraries:</para>
|
235 | |
|
236 | |
<para>Mandatory Libraries:
|
237 | |
<itemizedlist>
|
238 | |
<listitem>
|
239 | |
<para><ulink
|
240 | |
url="http://jackaudio.org/">JACK-audio-connection-kit</ulink>
|
241 | |
</para>
|
242 | |
</listitem>
|
|
246 |
<para>In order to compile the <application>Xjadeo</application> from source, you will need the
|
|
247 |
"development" (-dev) version of the following libraries:</para>
|
|
248 |
|
|
249 |
<para>Mandatory Libraries: <itemizedlist>
|
|
250 |
<listitem>
|
|
251 |
<para><ulink url="http://jackaudio.org/">JACK-audio-connection-kit</ulink></para>
|
|
252 |
</listitem>
|
|
253 |
|
243 | 254 |
<listitem>
|
244 | 255 |
<para><ulink url="http://ffmpeg.org/">ffmpeg</ulink> (libavcodec,
|
245 | |
libavformat, libavutil, libswscale)</para>
|
|
256 |
libavformat, libavutil, libswscale)</para>
|
|
257 |
|
246 | 258 |
<para>Note that linking against ffmpeg requires all of ffmpeg's
|
247 | |
dependencies. Depending on the configuration of ffmpeg, these can
|
248 | |
include development packages of:
|
249 | |
libxvidcore, liblame, libfaac, libfaad, libvorbis, libogg,
|
250 | |
libx264, liba52, libdts,... </para>
|
251 | |
</listitem>
|
252 | |
</itemizedlist>
|
253 | |
</para>
|
254 | |
|
255 | |
<para>Video Display Libraries (you need at least one of the following):
|
256 | |
<itemizedlist>
|
|
259 |
dependencies. Depending on the configuration of ffmpeg, these can
|
|
260 |
include development packages of: libxvidcore, liblame, libfaac,
|
|
261 |
libfaad, libvorbis, libogg, libx264, liba52, libdts,...</para>
|
|
262 |
</listitem>
|
|
263 |
</itemizedlist></para>
|
|
264 |
|
|
265 |
<para>Video Display Libraries (you need at least one of the following):
|
|
266 |
<itemizedlist>
|
257 | 267 |
<listitem>
|
258 | 268 |
<para><ulink url="http://xorg.freedesktop.org">libXV</ulink>
|
259 | |
(recommended)</para>
|
260 | |
</listitem>
|
261 | |
<listitem>
|
262 | |
<para><ulink url="http://www.enlightenment.org/Libraries/Imlib2/"
|
263 | |
>IMlib2</ulink></para>
|
264 | |
</listitem>
|
|
269 |
(recommended)</para>
|
|
270 |
</listitem>
|
|
271 |
|
|
272 |
<listitem>
|
|
273 |
<para><ulink url="http://www.enlightenment.org/Libraries/Imlib2/">IMlib2</ulink></para>
|
|
274 |
</listitem>
|
|
275 |
|
265 | 276 |
<listitem>
|
266 | 277 |
<para><ulink url="http://www.libsdl.org">SDL 1.2</ulink></para>
|
267 | 278 |
</listitem>
|
268 | |
</itemizedlist>
|
269 | |
(Note: for the Win32 version: SDL is required; on OSX none of the
|
270 | |
above are used but xjadeo uses carbon/quartz)
|
271 | |
</para>
|
272 | |
|
273 | |
<para>Optional libraries:
|
274 | |
<itemizedlist>
|
|
279 |
</itemizedlist> (Note: for the Win32 version: SDL is required; on OSX
|
|
280 |
none of the above are used but <application>Xjadeo</application> uses carbon/quartz)</para>
|
|
281 |
|
|
282 |
<para>Optional libraries: <itemizedlist>
|
275 | 283 |
<listitem>
|
276 | 284 |
<para><ulink url="http://freetype.org">Freetype 2</ulink>
|
277 | |
(actually libfreetype6-2) - for On Screen Display.</para>
|
278 | |
</listitem>
|
|
285 |
(actually libfreetype6-2) - for On Screen Display.</para>
|
|
286 |
</listitem>
|
|
287 |
|
279 | 288 |
<listitem>
|
280 | 289 |
<para><ulink url="http://www.alsa-project.org/">ALSA</ulink>
|
281 | |
(alsa-lib, libasound2) - MIDI Time Code.</para>
|
282 | |
</listitem>
|
283 | |
<listitem>
|
284 | |
<para><ulink url="http://www.cs.cmu.edu/~music/portmusic/portmidi/"
|
285 | |
>portmidi</ulink> - MIDI Time Code.</para>
|
286 | |
</listitem>
|
287 | |
<listitem>
|
288 | |
<para><ulink url="http://ltcsmpte.sourceforge.net/"
|
289 | |
>LTCSMPTE</ulink> - for parsing LTC timecode.</para>
|
290 | |
</listitem>
|
|
290 |
(alsa-lib, libasound2) - MIDI Time Code.</para>
|
|
291 |
</listitem>
|
|
292 |
|
|
293 |
<listitem>
|
|
294 |
<para><ulink url="http://www.cs.cmu.edu/~music/portmusic/portmidi/">portmidi</ulink>
|
|
295 |
- MIDI Time Code.</para>
|
|
296 |
</listitem>
|
|
297 |
|
|
298 |
<listitem>
|
|
299 |
<para><ulink url="http://ltcsmpte.sourceforge.net/">LTCSMPTE</ulink> - for
|
|
300 |
parsing LTC timecode.</para>
|
|
301 |
</listitem>
|
|
302 |
|
291 | 303 |
<listitem>
|
292 | 304 |
<para><ulink url="http://qt.nokia.com/">QT4</ulink> - qjadeo
|
293 | |
Graphical User Interface</para>
|
294 | |
</listitem>
|
295 | |
<listitem>
|
296 | |
<para><ulink url="http://liblo.sourceforge.net/">liblo</ulink>
|
297 | |
- remote control via <ulink url="http://opensoundcontrol.org/"
|
298 | |
>Opensoundcontrol</ulink></para>
|
299 | |
</listitem>
|
300 | |
<listitem>
|
301 | |
<para>librt (from the <ulink
|
302 | |
url="http://www.gnu.org/software/libc/">GNU C Library</ulink>
|
303 | |
≥ 2.3.2) - remote-control via POSIX message queue
|
304 | |
(requires kernel support - Linux ≥ 2.6.6)</para>
|
305 | |
</listitem>
|
306 | |
<listitem>
|
307 | |
<para><ulink url="http://www.nongnu.org/lash/">lash</ulink>
|
308 | |
- session management (deprecated<footnote><para>LASH support is
|
309 | |
still available, but not newer options - in particular LTC
|
310 | |
and MIDI-drivers - are not saved/restored.</para></footnote>
|
311 | |
since <application>xjadeo</application> ≥ 0.6.0).</para>
|
312 | |
</listitem>
|
313 | |
</itemizedlist>
|
314 | |
</para>
|
315 | |
|
316 | |
<para>QT is only needed to compile and run the
|
317 | |
<application>qjadeo</application> Graphical User Interface (GUI) - not
|
318 | |
<application>xjadeo</application> itself. You can certainly build and
|
319 | |
use <application>xjadeo</application> without the GUI.
|
320 | |
<application>qjadeo</application> uses the remote-control feature of
|
321 | |
<application>xjadeo</application> and provides easy access for users
|
322 | |
who are not familiar with the command-line.
|
323 | |
</para>
|
324 | |
|
325 | |
<para>Furthermore you'll need the standard GNU development tool-set
|
326 | |
(<application>gcc</application>, <application>make</application>,
|
327 | |
libc-devel, etc) and if you're building from
|
328 | |
the source-repository <application>autotools</application> (automake,
|
329 | |
autoconf) are required to to generate the build environment.
|
330 | |
</para>
|
331 | |
|
332 | |
<para>We also recommend to install <application>mencoder</application> to
|
333 | |
transcode video-files.
|
334 | |
</para>
|
335 | |
|
|
305 |
Graphical User Interface</para>
|
|
306 |
</listitem>
|
|
307 |
|
|
308 |
<listitem>
|
|
309 |
<para><ulink url="http://liblo.sourceforge.net/">liblo</ulink> -
|
|
310 |
remote control via <ulink url="http://opensoundcontrol.org/">Opensoundcontrol</ulink></para>
|
|
311 |
</listitem>
|
|
312 |
|
|
313 |
<listitem>
|
|
314 |
<para>librt (from the <ulink url="http://www.gnu.org/software/libc/">GNU C Library</ulink> ≥
|
|
315 |
2.3.2) - remote-control via POSIX message queue (requires kernel
|
|
316 |
support - Linux ≥ 2.6.6)</para>
|
|
317 |
</listitem>
|
|
318 |
|
|
319 |
<listitem>
|
|
320 |
<para><ulink url="http://www.nongnu.org/lash/">lash</ulink> -
|
|
321 |
session management (deprecated<footnote>
|
|
322 |
<para>LASH support is still available, but not newer options -
|
|
323 |
in particular LTC and MIDI-drivers - are not
|
|
324 |
saved/restored.</para>
|
|
325 |
</footnote> since <application>Xjadeo</application> ≥
|
|
326 |
0.6.0).</para>
|
|
327 |
</listitem>
|
|
328 |
</itemizedlist></para>
|
|
329 |
|
|
330 |
<para>QT is only needed to compile and run the
|
|
331 |
<application>qjadeo</application> Graphical User Interface (GUI) - not
|
|
332 |
<application>Xjadeo</application> itself. You can certainly build and
|
|
333 |
use <application>Xjadeo</application> without the GUI.
|
|
334 |
<application>qjadeo</application> uses the remote-control feature of
|
|
335 |
<application>Xjadeo</application> and provides easy access for users who
|
|
336 |
are not familiar with the command-line.</para>
|
|
337 |
|
|
338 |
<para>Furthermore you'll need the standard GNU development tool-set
|
|
339 |
(<application>gcc</application>, <application>make</application>,
|
|
340 |
libc-devel, etc) and if you're building from the source-repository
|
|
341 |
<application>autotools</application> (automake, autoconf) are required
|
|
342 |
to to generate the build environment.</para>
|
|
343 |
|
|
344 |
<para>We also recommend to install <application>mencoder</application>
|
|
345 |
to transcode video files.</para>
|
336 | 346 |
</section>
|
337 | 347 |
|
338 | 348 |
<section id="build" xreflabel="building xjadeo">
|
339 | |
<title>Building xjadeo</title>
|
340 | |
|
341 | |
<para>If you are using sources from the repository, you'll first need
|
342 | |
to generate the configuration script:
|
343 | |
<screen>
|
|
349 |
<title>Building <application>Xjadeo</application></title>
|
|
350 |
|
|
351 |
<para>If you are using sources from the repository, you'll first need to
|
|
352 |
generate the configuration script: <screen>
|
344 | 353 |
cd xjadeo/
|
345 | |
./autogen.sh</screen>
|
346 | |
</para>
|
|
354 |
./autogen.sh</screen></para>
|
347 | 355 |
|
348 | 356 |
<para>Once you have all the build-dependencies the usual spells apply:
|
349 | 357 |
<screen>
|
350 | 358 |
./configure
|
351 | 359 |
make
|
352 | |
make install # (requires root privileges) </screen>
|
353 | |
</para>
|
|
360 |
make install # (requires root privileges) </screen></para>
|
354 | 361 |
|
355 | 362 |
<para>The configuration process tries to auto-detect available optional
|
356 | |
libraries. However, you might want to consider
|
357 | |
using some of the compile-time options. run
|
358 | |
<command>./configure --help</command> for a full list of available
|
359 | |
arguments.
|
360 | |
<variablelist>
|
|
363 |
libraries. However, you might want to consider using some of the
|
|
364 |
compile-time options. run <command>./configure --help</command> for a
|
|
365 |
full list of available arguments. <variablelist>
|
361 | 366 |
<varlistentry>
|
362 | 367 |
<term><option>--with-fontfile=/path/to/font.ttf</option></term>
|
363 | |
<listitem>
|
364 | |
<para>Set the default (hardcoded) true type font file to use
|
365 | |
for the on-screen-display.</para>
|
|
368 |
|
|
369 |
<listitem>
|
|
370 |
<para>Set the default (hardcoded) true type font file to use for
|
|
371 |
the on-screen-display.</para>
|
366 | 372 |
</listitem>
|
367 | 373 |
</varlistentry>
|
368 | 374 |
|
369 | 375 |
<varlistentry>
|
370 | 376 |
<term><option>--enable-contrib</option></term>
|
371 | |
<listitem>
|
372 | |
<para>build additional support tools - mostly for
|
373 | |
testing xjadeo.</para>
|
|
377 |
|
|
378 |
<listitem>
|
|
379 |
<para>build additional support tools - mostly for testing
|
|
380 |
<application>Xjadeo</application>.</para>
|
374 | 381 |
</listitem>
|
375 | 382 |
</varlistentry>
|
376 | 383 |
|
377 | 384 |
<varlistentry>
|
378 | 385 |
<term><option>--enable-lash</option></term>
|
|
386 |
|
379 | 387 |
<listitem>
|
380 | 388 |
<para>enable LASH support (deprecated). New features which were
|
381 | |
introduced after xjadeo 0.4.10 are not saved/restored with LASH.
|
382 | |
In particular this affects LTC and JACK-MIDI. Future versions
|
383 | |
of xjadeo may support JACK-Session management.</para>
|
|
389 |
introduced after <application>Xjadeo</application> 0.4.10 are not saved/restored with LASH.
|
|
390 |
In particular this affects LTC and JACK-MIDI. Future versions of
|
|
391 |
xjadeo may support JACK-Session management.</para>
|
384 | 392 |
</listitem>
|
385 | 393 |
</varlistentry>
|
386 | 394 |
|
387 | 395 |
<varlistentry>
|
388 | 396 |
<term><option>--disable-qtgui</option></term>
|
|
397 |
|
389 | 398 |
<listitem>
|
390 | 399 |
<para>Do not build the QT Graphical User Interface.</para>
|
391 | 400 |
</listitem>
|
|
394 | 403 |
</section>
|
395 | 404 |
</section>
|
396 | 405 |
|
397 | |
<!-- CHAPTER -->
|
|
406 |
<!-- CHAPTER -->
|
398 | 407 |
|
399 | 408 |
<section id="usage" xreflabel="xjadeo usage section">
|
400 | |
<title>Using xjadeo</title>
|
|
409 |
<title>Using <application>Xjadeo</application></title>
|
401 | 410 |
|
402 | 411 |
<section id="quickstart">
|
403 | 412 |
<title>Quick Start</title>
|
404 | |
<para>simply run <command>xjadeo video-file.avi</command> from a terminal
|
405 | |
to get a default monitor window displaying the specified video file
|
406 | |
synchronously to JACK-transport. You can use
|
407 | |
<application>qjackctl</application>, <application>ardour</application>
|
408 | |
or any other JACK-transport aware application to start, stop or
|
409 | |
reposition the transport location.</para>
|
|
413 |
|
|
414 |
<para>Simply run <command>xjadeo your-video-file.avi</command> from a
|
|
415 |
terminal to get a default monitor window displaying the specified video
|
|
416 |
file synchronously to JACK-transport. You can use
|
|
417 |
<application>qjackctl</application>, <application>ardour</application>
|
|
418 |
or any other JACK-transport aware application to start, stop or
|
|
419 |
reposition the transport location.</para>
|
410 | 420 |
|
411 | 421 |
<para><command>xjadeo --help</command> will print a list of available
|
412 | |
command line options. Refer to the manual-pages
|
413 | |
(<command>man xjadeo</command>) which are also available in the
|
414 | |
<xref linkend="manual_pages"/> for available commendline options.</para>
|
|
422 |
command line options. Refer to the manual-pages (<command>man
|
|
423 |
xjadeo</command>) which are also available in the <xref linkend="manual_pages"/> for available commendline options.</para>
|
415 | 424 |
|
416 | 425 |
<para>If you prefer, you can also use the graphical user interface
|
417 | |
<command>qjadeo</command>, be aware that
|
418 | |
<application>qjadeo</application> only provides access to a limited
|
419 | |
set of <application>xjadeo</application>'s features.</para>
|
420 | |
|
421 | |
<para>But let's back off a little, first you will need a suitable
|
422 | |
video file to display..</para>
|
|
426 |
<command>qjadeo</command>, be aware that
|
|
427 |
<application>qjadeo</application> only provides access to a limited set
|
|
428 |
of <application>Xjadeo</application>'s features.</para>
|
|
429 |
|
|
430 |
<para>But let's back off a little, first you will need a suitable video
|
|
431 |
file to display..</para>
|
423 | 432 |
</section>
|
424 | 433 |
|
425 | 434 |
<section id="video_formats">
|
426 | 435 |
<title>Video Formats</title>
|
427 | 436 |
|
428 | |
<para><application>xjadeo</application> has been designed to aid
|
429 | |
creative people and not as a general purpose video player. As it is most
|
430 | |
likely that you will work with the video file for a while, you should
|
431 | |
take some time to convert in to suitable format for your purpose,
|
432 | |
trading off I/O and the efforts to decode the file.</para>
|
433 | |
|
434 | |
<para><application>xjadeo</application> uses <ulink
|
435 | |
url="http://ffmpeg.org/">ffmpeg</ulink> to decode the video
|
436 | |
file and supports only seekable video streams. Probably you
|
437 | |
first need to encode your video file to a supported format.</para>
|
438 | |
|
439 | |
<para>Be aware that some Codecs are governed by licenses or patents
|
440 | |
in many countries. This is an issue with
|
441 | |
<application>ffmpeg</application> and not
|
442 | |
<application>xjadeo</application>: Nevertheless, you (any end-users)
|
443 | |
are responsible to for to comply to the licenses of the Codecs you
|
444 | |
are using. see <ulink
|
445 | |
url="http://ffmpeg.org/legal.html">FFmpeg License and Legal
|
446 | |
Considerations</ulink>.
|
447 | |
</para>
|
|
437 |
<para><application>Xjadeo</application> has been designed to aid
|
|
438 |
creative people and not as a general purpose video player. Since it is
|
|
439 |
likely you will be working with the video file for some time, you may
|
|
440 |
want to consider the system resources required for decoding it and
|
|
441 |
perhaps convert it into a format that will tax less your CPU, usually at
|
|
442 |
the expense of more disk space needed to store it.</para>
|
|
443 |
|
|
444 |
<para><application>Xjadeo</application> uses <ulink url="http://ffmpeg.org/">ffmpeg</ulink> to decode the video file and
|
|
445 |
supports only seekable video streams. Probably you first need to encode
|
|
446 |
your video file to a supported format.</para>
|
|
447 |
|
|
448 |
<para>Be aware that some codecs are governed by licenses or patents in
|
|
449 |
many countries. This is an issue with <application>ffmpeg</application>
|
|
450 |
and not <application>Xjadeo</application>: Nevertheless, you (the
|
|
451 |
end-user) are responsible for complying with the licenses of the codecs
|
|
452 |
you are using. see <ulink url="http://ffmpeg.org/legal.html">FFmpeg
|
|
453 |
License and Legal Considerations</ulink>.</para>
|
448 | 454 |
|
449 | 455 |
<para>We recommend <application>mencoder</application> that comes with
|
450 | |
<ulink url="http://www.mplayerhq.hu/">mplayer</ulink>:
|
451 | |
<screen>mencoder -idx -ovc lavc -lavcopts keyint=1 -nosound input-file.xxx -o output-file.avi</screen>
|
452 | |
This creates from your <filename>input-file.xxx</filename> an
|
453 | |
AVI mpeg4 encoded video file with no sound, an index (-idx) and no
|
454 | |
compression between frames (every frame is a key frame). Thus The file
|
455 | |
can become really BIG, so watch your disk space.</para>
|
456 | |
<para>You may want to shrink the size by scaling the geometry of the
|
457 | |
video-frames, which also taxes less system resources while displaying
|
458 | |
it and leaves more space in the screen for your audio software..</para>
|
|
456 |
<ulink url="http://www.mplayerhq.hu/">mplayer</ulink>: <screen>mencoder -idx -ovc lavc -lavcopts keyint=1 -nosound input-file.xxx -o output-file.avi</screen>This
|
|
457 |
creates from your <filename>input-file.xxx</filename> an AVI mpeg4
|
|
458 |
encoded video file with no sound, an index (-idx) and no compression
|
|
459 |
between frames (every frame is a key frame). Thus The file can become
|
|
460 |
really BIG, so watch your disk space!</para>
|
|
461 |
|
|
462 |
<para>You may want also to shrink the size of the file's video frames by
|
|
463 |
scaling down its geometry. This uses fewer system resources while
|
|
464 |
decoding and displaying it and leaves more space in the screen for your
|
|
465 |
audio software.</para>
|
459 | 466 |
|
460 | 467 |
<screen>-vf scale=width:height</screen>
|
461 | 468 |
|
462 | 469 |
<para><application>qjadeo</application> provides an "import dialog"
|
463 | |
available from the File menu, that will invoke
|
464 | |
<application>mencoder</application> with these arguments.</para>
|
|
470 |
available from the File menu, that will invoke
|
|
471 |
<application>mencoder</application> with these arguments.</para>
|
465 | 472 |
|
466 | 473 |
<important>
|
467 | |
<para><application>xjadeo</application>'s <option>-K</option>
|
468 | |
option allows to seek to frames other than key-frames and
|
469 | |
enables <application>xjadeo</application> to play back any file
|
470 | |
without transcoding. It comes with the expense of increased CPU usage
|
471 | |
and possibly increased seek latency. The latter depends on the
|
472 | |
key-frame interval and video-codec)</para>
|
|
474 |
<para><application>Xjadeo</application>'s <option>-K</option> option
|
|
475 |
allows to seek to frames other than key-frames and enables
|
|
476 |
<application>Xjadeo</application> to play back any file without
|
|
477 |
transcoding. The down side is increased CPU usage and possibly
|
|
478 |
increased seek latency. The latter depends on the key-frame interval
|
|
479 |
and video-codec.</para>
|
|
480 |
|
473 | 481 |
<para>The same can be achieved by adding
|
474 | |
<literal>seek=continuously</literal> to
|
475 | |
<filename>~/.xjadeorc</filename>.</para>
|
|
482 |
<literal>seek=continuously</literal> to
|
|
483 |
<filename>~/.xjadeorc</filename>.</para>
|
476 | 484 |
</important>
|
477 | 485 |
</section>
|
478 | 486 |
|
479 | 487 |
<section id="invoking_xjadeo">
|
480 | |
<title>Invoking xjadeo</title>
|
481 | |
|
482 | |
<para>The command syntax:<command>xjadeo [options] <replaceable>video-file</replaceable></command></para>
|
483 | |
|
484 | |
<para>There are numerous options documented in the unix man-page, see
|
485 | |
<xref linkend="commandline_options"/>.
|
486 | |
The default settings should be good for most use-cases.
|
487 | |
You can use any application that supports JACK-transport
|
488 | |
(e.g. <application>qjackctl</application>,
|
489 | |
<application>ardour</application>,
|
490 | |
<application>gjacktransport</application>,
|
491 | |
<application>muse</application>,
|
492 | |
<application>qtractor</application>, ...) to
|
493 | |
fool around with its transport controls and see the video clip moving
|
494 | |
along.</para>
|
495 | |
|
496 | |
<section id="configuring_xjadeo">
|
497 | |
<title>Configuring xjadeo</title>
|
498 | |
<para>On startup <application>xjadeo</application> reads resource
|
499 | |
configuration (rc) files if they exist. They are read before parsing
|
500 | |
command-line options so settings specified in the .rc file are
|
501 | |
overridden by command-line arguments.
|
|
488 |
<title>Invoking <application>Xjadeo</application></title>
|
|
489 |
|
|
490 |
<para>The command syntax: <command>xjadeo [options]
|
|
491 |
<replaceable>video-file</replaceable></command></para>
|
|
492 |
|
|
493 |
<para>There are numerous options documented in the unix man-page, see
|
|
494 |
<xref linkend="commandline_options"/>. The default settings should be
|
|
495 |
good for most use-cases. You can use any application that supports
|
|
496 |
JACK-transport (e.g. <application>qjackctl</application>,
|
|
497 |
<application>ardour</application>,
|
|
498 |
<application>gjacktransport</application>,
|
|
499 |
<application>muse</application>, <application>qtractor</application>,
|
|
500 |
...) to fool around with its transport controls and see the video clip
|
|
501 |
moving along.</para>
|
|
502 |
|
|
503 |
<section id="configuring_xjadeo">
|
|
504 |
<title>Configuring <application>Xjadeo</application></title>
|
|
505 |
|
|
506 |
<para>On startup <application>Xjadeo</application> reads its resource
|
|
507 |
configuration (rc) files if they exist. They are read before parsing
|
|
508 |
command-line options, so settings specified in the .rc file are
|
|
509 |
overridden by command-line arguments.</para>
|
|
510 |
|
|
511 |
<para><application>Xjadeo</application> reads the following resource configuration files in this
|
|
512 |
order:</para>
|
|
513 |
|
|
514 |
<orderedlist>
|
|
515 |
<listitem>
|
|
516 |
<para><filename>/@SYSCONFDIR@/xjadeorc</filename> (usually
|
|
517 |
<filename>/etc/xjadeorc</filename> or
|
|
518 |
<filename>/usr/local/etc/xjadeorc</filename>, which depends on
|
|
519 |
your distribution and on the configuration when <xref linkend="build"/>)</para>
|
|
520 |
</listitem>
|
|
521 |
|
|
522 |
<listitem>
|
|
523 |
<para><filename>$HOME/.xjadeorc</filename></para>
|
|
524 |
</listitem>
|
|
525 |
|
|
526 |
<listitem>
|
|
527 |
<para><filename>./xjadeorc</filename></para>
|
|
528 |
</listitem>
|
|
529 |
</orderedlist>
|
|
530 |
|
|
531 |
<para>An example rc file, listing all available options is available
|
|
532 |
with the source-code and can be found online: <ulink url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob;f=doc/xjadeorc">http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob;f=doc/xjadeorc</ulink></para>
|
|
533 |
</section>
|
|
534 |
|
|
535 |
<section id="sync_methods">
|
|
536 |
<title>Sync Methods</title>
|
|
537 |
|
|
538 |
<para><application>Xjadeo</application> polls the time code information in the following order,
|
|
539 |
using the first available:</para>
|
|
540 |
|
|
541 |
<orderedlist>
|
|
542 |
<listitem>
|
|
543 |
<para>MIDI Time Code (if MIDI is connected).</para>
|
|
544 |
</listitem>
|
|
545 |
|
|
546 |
<listitem>
|
|
547 |
<para>LTC (if enabled).</para>
|
|
548 |
</listitem>
|
|
549 |
|
|
550 |
<listitem>
|
|
551 |
<para>JACK-transport (if connected).</para>
|
|
552 |
</listitem>
|
|
553 |
|
|
554 |
<listitem>
|
|
555 |
<para>default value (selecttable using <literal>seek</literal>
|
|
556 |
remote command).</para>
|
|
557 |
</listitem>
|
|
558 |
</orderedlist>
|
|
559 |
|
|
560 |
<para>By default <application>Xjadeo</application> connects to
|
|
561 |
<application>jackd</application> on startup. This behavior can be
|
|
562 |
overridden by command line arguments, setting options in the
|
|
563 |
configuration file or later using the remote control interface.</para>
|
|
564 |
|
|
565 |
<para>An optional time-offset is added after converting the current
|
|
566 |
frame-number to the video file's frames-per-second timebase, followed
|
|
567 |
by clamping the displayed frame-number into the range of the video
|
|
568 |
file duration.</para>
|
|
569 |
</section>
|
|
570 |
</section>
|
|
571 |
|
|
572 |
<section id="qt_gui">
|
|
573 |
<title><application>qjadeo</application> - Graphical User Interface</title>
|
|
574 |
<para>To provide easy accesibility and integration into the desktop environment,
|
|
575 |
<application>Xjadeo</application> is supplemented by a graphical user interface:
|
|
576 |
<application>qjadeo</application> is a remote control application that launches
|
|
577 |
<application>Xjadeo</application> and allows to control
|
|
578 |
settings which otherwise would be need to be specified on the command-line.
|
502 | 579 |
</para>
|
503 | |
<para>xjadeo reads the following resource configuration files in this
|
504 | |
order:</para>
|
505 | |
<orderedlist>
|
506 | |
<listitem>
|
507 | |
<para><filename>/@SYSCONFDIR@/xjadeorc</filename>
|
508 | |
(usually <filename>/etc/xjadeorc</filename>
|
509 | |
or <filename>/usr/local/etc/xjadeorc</filename>,
|
510 | |
which depends on your distribution and on the configuration when
|
511 | |
<xref linkend="build"/>)</para>
|
512 | |
</listitem>
|
513 | |
<listitem>
|
514 | |
<para><filename>$HOME/.xjadeorc</filename></para>
|
515 | |
</listitem>
|
516 | |
<listitem>
|
517 | |
<para><filename>./xjadeorc</filename></para>
|
518 | |
</listitem>
|
519 | |
</orderedlist>
|
520 | |
<para>An example rc file, listing all available options is available
|
521 | |
with the source-code and can be found online: <ulink
|
522 | |
url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob;f=doc/xjadeorc"
|
523 | |
>http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob;f=doc/xjadeorc</ulink>
|
|
580 |
|
|
581 |
<para>
|
|
582 |
<mediaobject>
|
|
583 |
<imageobject>
|
|
584 |
<imagedata align="center" fileref="qjadeo.eps" valign="middle" format="EPS"/>
|
|
585 |
</imageobject>
|
|
586 |
<imageobject>
|
|
587 |
<imagedata align="center" fileref="qjadeo.png" valign="middle" format="PNG"/>
|
|
588 |
</imageobject>
|
|
589 |
<textobject>
|
|
590 |
<phrase>Qjadeo screenshot</phrase>
|
|
591 |
</textobject>
|
|
592 |
<caption>
|
|
593 |
<para>Screenshot of <application>qjadeo</application>'s main window.</para>
|
|
594 |
</caption>
|
|
595 |
</mediaobject>
|
|
596 |
</para>
|
|
597 |
|
|
598 |
<para>
|
|
599 |
<application>qjadeo</application> offers "click and go" interface to the most common tasks:
|
|
600 |
<itemizedlist>
|
|
601 |
<listitem><para>Load/replace video-file to display.</para></listitem>
|
|
602 |
<listitem><para>Provides a history of recently used files.</para></listitem>
|
|
603 |
<listitem><para>Change the sync-source on the fly.</para></listitem>
|
|
604 |
<listitem><para>Frontend for importing/transcoding cideo-files (using <application>mencoder</application>).</para></listitem>
|
|
605 |
<listitem><para>Control On-Screen-Display and set OSD font.</para></listitem>
|
|
606 |
<listitem><para>manually seek through the video-file using a slider.</para></listitem>
|
|
607 |
<listitem><para>Change the decoder seek mode.</para></listitem>
|
|
608 |
</itemizedlist>
|
|
609 |
Combined with keyboard shortcuts that can be used with the <application>Xjadeo</application>
|
|
610 |
window itself (see <xref linkend="interaction"/>),
|
|
611 |
this covers all functionality (but for some obscure switches) available from the commandline.
|
|
612 |
</para>
|
|
613 |
|
|
614 |
<para>
|
|
615 |
Once started, <application>qjadeo</application> can be terminating without closing
|
|
616 |
the monitor window.
|
|
617 |
Re-launching <application>qjadeo</application> will re-connect to the running
|
|
618 |
instance of <application>Xjadeo</application>.
|
|
619 |
</para>
|
|
620 |
|
|
621 |
</section>
|
|
622 |
|
|
623 |
<section id="osxjadeo">
|
|
624 |
<title>Notes for OSX <application>Jadeo</application></title>
|
|
625 |
<para>As with many thing on OS X <application>Jadeo</application> is different there.
|
|
626 |
Since OS X mandates a menu-bar for each graphical application, the menu-bar part of
|
|
627 |
<application>qjadeo</application> has been integrated into <application>Jadeo</application>.
|
|
628 |
On the downside: it does not include the import/transcoding feature and no slider for manual
|
|
629 |
seeking.
|
|
630 |
</para>
|
|
631 |
<important><para>
|
|
632 |
Configuration of <application>Jadeo</application> on OSX can be done exclusively
|
|
633 |
by using a <filename>.xjadeorc</filename> resource configuration file.
|
|
634 |
See <xref linkend="configuring_xjadeo"/> and save it in your home folder.
|
|
635 |
</para></important>
|
|
636 |
</section>
|
|
637 |
|
|
638 |
<section id="winxjadeo">
|
|
639 |
<title><application>Xjadeo</application> on Windows</title>
|
|
640 |
<para>
|
|
641 |
The usual way is to launch <application>qjadeo</application> from the Start-Menu,
|
|
642 |
after starting JACK.
|
|
643 |
<application>qjadeo</application> will fire up an <application>Xjadeo</application>
|
|
644 |
window and you can take it from there. See <xref linkend="qt_gui"/> for usage information.
|
|
645 |
</para>
|
|
646 |
<para>
|
|
647 |
In order to use the import/transcoding feature, you need to install <application>mencoder</application> that comes
|
|
648 |
with <ulink url="http://www.mplayerhq.hu">mplayer</ulink> and configure the location of installation
|
|
649 |
(default <filename>C:\Program Files\mplayer\mencoder.exe</filename>) in
|
|
650 |
<menuchoice><guimenu>File</guimenu><guimenuitem>Configure Qjadeo</guimenuitem></menuchoice>).
|
|
651 |
</para>
|
|
652 |
<important><para>
|
|
653 |
On windows it is not possible to disconnect/quit <application>qjadeo</application> without terminating
|
|
654 |
the monitor window of <application>Xjadeo</application>.
|
|
655 |
</para></important>
|
|
656 |
<para>
|
|
657 |
It is possible to invoke <application>Xjadeo</application> using a command prompt
|
|
658 |
(<filename>xjadeo.exe</filename> is installed by default to
|
|
659 |
<filename>C:\Program Files\xjadeo\</filename>).
|
524 | 660 |
</para>
|
525 | 661 |
</section>
|
526 | 662 |
|
527 | |
<section id="sync_methods">
|
528 | |
<title>Sync Methods</title>
|
529 | |
|
530 | |
<para>xjadeo polls the time code information in the following order,
|
531 | |
using the first available:</para>
|
532 | |
|
533 | |
<orderedlist>
|
534 | |
<listitem>
|
535 | |
<para>MIDI Time Code (if MIDI is connected).</para>
|
536 | |
</listitem>
|
537 | |
|
538 | |
<listitem>
|
539 | |
<para>LTC (if enabled).</para>
|
540 | |
</listitem>
|
541 | |
|
542 | |
<listitem>
|
543 | |
<para>JACK-transport (if connected).</para>
|
544 | |
</listitem>
|
545 | |
|
546 | |
<listitem>
|
547 | |
<para>default value (settable using <literal>seek</literal> remote
|
548 | |
command).</para>
|
549 | |
</listitem>
|
550 | |
</orderedlist>
|
551 | |
|
552 | |
<para>By default <application>xjadeo</application> connects to
|
553 | |
<application>jackd</application> on startup.
|
554 | |
This behavior can be overridden by command line arguments,
|
555 | |
setting options in the configuration file,
|
556 | |
or later using the remote control interface.</para>
|
557 | |
|
558 | |
<para>An optional time-offset is added after converting the current
|
559 | |
frame-number to the video file's frames-per-second timebase, followed
|
560 | |
by clamping the displayed frame-number into
|
561 | |
the range of the video file duration.</para>
|
562 | |
</section>
|
563 | |
</section>
|
564 | |
|
565 | 663 |
<section id="interaction">
|
566 | |
<title>Interacting with xjadeo</title>
|
567 | |
<para>
|
568 | |
In most cases you will start up xjadeo with your favorite command line
|
569 | |
options and not come back to bother again. However you may find it
|
570 | |
useful to change some settings during runtime:</para>
|
|
664 |
<title>Interacting with <application>Xjadeo</application></title>
|
|
665 |
|
|
666 |
<para>In most cases you will start up <application>Xjadeo</application> with your favorite command
|
|
667 |
line options and not come back to bother again. However you may find it
|
|
668 |
useful to change some settings during runtime:</para>
|
571 | 669 |
|
572 | 670 |
<section id="remote_control_interaction">
|
573 | 671 |
<title>Remote Control</title>
|
574 | |
<para>If you do not want to re-focus your keyboard to the xjadeo
|
575 | |
window use <xref linkend="xjremote" /> and
|
576 | |
jump <xref linkend="remote_control_interface"/>.</para>
|
|
672 |
|
|
673 |
<para>If you do not want to re-focus your keyboard to the <application>Xjadeo</application>
|
|
674 |
window use <xref linkend="xjremote"/> and jump <xref linkend="remote_control_interface"/>.</para>
|
577 | 675 |
</section>
|
578 | 676 |
|
579 | 677 |
<section id="x_window_interaction">
|
580 | 678 |
<title>Monitor Window - Key bindings</title>
|
581 | |
<para>xjadeo accepts keyboard input (and the X11 version can
|
582 | |
receive Drag and Drop URIs to load a new file).</para>
|
583 | |
<para> The current key-bindings are as follows:</para>
|
|
679 |
|
|
680 |
<para><application>Xjadeo</application> accepts keyboard input (and the X11 version can receive
|
|
681 |
Drag and Drop URIs to load a new file).</para>
|
|
682 |
|
|
683 |
<para>The current key-bindings are as follows:</para>
|
|
684 |
|
584 | 685 |
<table frame="all" tabstyle="tbl">
|
585 | 686 |
<title>Key Bindings</title>
|
586 | |
<tgroup cols="2" align="left">
|
587 | |
<colspec colname='c1' align="center" colwidth="*"/>
|
588 | |
<colspec colname='c2' colwidth="*"/>
|
589 | |
<thead><row><entry>Key</entry><entry>Description</entry></row></thead>
|
|
687 |
|
|
688 |
<tgroup align="left" cols="2">
|
|
689 |
<colspec align="center" colname="c1"/>
|
|
690 |
|
|
691 |
<colspec colname="c2" colwidth="*"/>
|
|
692 |
|
|
693 |
<thead>
|
|
694 |
<row>
|
|
695 |
<entry>Key</entry>
|
|
696 |
|
|
697 |
<entry>Description</entry>
|
|
698 |
</row>
|
|
699 |
</thead>
|
|
700 |
|
590 | 701 |
<tbody>
|
591 | 702 |
<row>
|
592 | 703 |
<entry><keycap>Esc</keycap></entry>
|
593 | |
<entry><para>Terminate xjadeo.</para></entry>
|
|
704 |
|
|
705 |
<entry><para>Terminate <application>Xjadeo</application>.</para></entry>
|
594 | 706 |
</row>
|
|
707 |
|
595 | 708 |
<row>
|
596 | 709 |
<entry><keycap>Space</keycap></entry>
|
597 | |
<entry><para>If xjadeo is synchronized to JACK-transport,
|
598 | |
toggle JACK-transport play/pause.</para></entry>
|
|
710 |
|
|
711 |
<entry><para>If <application>Xjadeo</application> is synchronized to JACK-transport,
|
|
712 |
toggle JACK-transport play/pause.</para></entry>
|
599 | 713 |
</row>
|
|
714 |
|
600 | 715 |
<row>
|
601 | 716 |
<entry><keycap>Backspace</keycap></entry>
|
602 | |
<entry><para>If xjadeo is synchronized to JACK-transport,
|
603 | |
rewind the play-head.</para></entry>
|
|
717 |
|
|
718 |
<entry><para>If <application>Xjadeo</application> is synchronized to JACK-transport,
|
|
719 |
rewind the play-head.</para></entry>
|
604 | 720 |
</row>
|
|
721 |
|
605 | 722 |
<row>
|
606 | 723 |
<entry><keycap>A</keycap></entry>
|
|
724 |
|
607 | 725 |
<entry><para>Toggle window always-on-top.</para></entry>
|
608 | 726 |
</row>
|
|
727 |
|
609 | 728 |
<row>
|
610 | 729 |
<entry><keycap>B</keycap></entry>
|
611 | |
<entry><para>Draws a black box around OSD items.</para></entry>
|
|
730 |
|
|
731 |
<entry><para>Draws a black box 'On Screen Display' (OSD)
|
|
732 |
items.</para></entry>
|
612 | 733 |
</row>
|
|
734 |
|
613 | 735 |
<row>
|
614 | |
<entry><keycombo><keycap>Shift</keycap><keycap>C</keycap></keycombo></entry>
|
615 | |
<entry><para>Clear all on screen display (OSD) information.</para></entry>
|
|
736 |
<entry><keycombo>
|
|
737 |
<keycap>Shift</keycap>
|
|
738 |
|
|
739 |
<keycap>C</keycap>
|
|
740 |
</keycombo></entry>
|
|
741 |
|
|
742 |
<entry><para>Clear all 'On Screen Display' (OSD)
|
|
743 |
information.</para></entry>
|
616 | 744 |
</row>
|
|
745 |
|
617 | 746 |
<row>
|
618 | 747 |
<entry><keycap>E</keycap></entry>
|
619 | |
<entry><para>Toggle display of Color-Equalizer
|
620 | |
(only XV and imlib2).</para></entry>
|
|
748 |
|
|
749 |
<entry><para>Toggle display of Color-Equalizer (only XV and
|
|
750 |
imlib2).</para></entry>
|
621 | 751 |
</row>
|
|
752 |
|
622 | 753 |
<row>
|
623 | |
<entry><keycombo><keycap>Shift</keycap><keycap>E</keycap></keycombo></entry>
|
624 | |
<entry><para>Reset Color-Equalizer to default values.</para></entry>
|
|
754 |
<entry><keycombo>
|
|
755 |
<keycap>Shift</keycap>
|
|
756 |
|
|
757 |
<keycap>E</keycap>
|
|
758 |
</keycombo></entry>
|
|
759 |
|
|
760 |
<entry><para>Reset Color-Equalizer to default
|
|
761 |
values.</para></entry>
|
625 | 762 |
</row>
|
|
763 |
|
626 | 764 |
<row>
|
627 | 765 |
<entry><keycap>F</keycap></entry>
|
|
766 |
|
628 | 767 |
<entry><para>Toggle full-screen mode.</para></entry>
|
629 | 768 |
</row>
|
|
769 |
|
630 | 770 |
<row>
|
631 | 771 |
<entry><keycap>L</keycap></entry>
|
632 | |
<entry><para>Toggle letterbox / scale breaking aspect-ratio.</para></entry>
|
|
772 |
|
|
773 |
<entry><para>Toggle letterbox / scale breaking
|
|
774 |
aspect-ratio.</para></entry>
|
633 | 775 |
</row>
|
|
776 |
|
634 | 777 |
<row>
|
635 | 778 |
<entry><keycap>M</keycap></entry>
|
|
779 |
|
636 | 780 |
<entry><para>Toggle mouse pointer visibility.</para></entry>
|
637 | 781 |
</row>
|
|
782 |
|
638 | 783 |
<row>
|
639 | 784 |
<entry><keycap>O</keycap></entry>
|
640 | |
<entry><para>cycle time-offset OSD: video-frames / SMPTE / off.</para></entry>
|
|
785 |
|
|
786 |
<entry><para>cycle time-offset OSD: video-frames / SMPTE /
|
|
787 |
off.</para></entry>
|
641 | 788 |
</row>
|
|
789 |
|
642 | 790 |
<row>
|
643 | 791 |
<entry><keycap>Q</keycap></entry>
|
644 | |
<entry><para>Identical to pressing the Escape key - Terminate xjadeo.</para></entry>
|
|
792 |
|
|
793 |
<entry><para>Identical to pressing the Escape key - Terminate
|
|
794 |
<application>Xjadeo</application>.</para></entry>
|
645 | 795 |
</row>
|
|
796 |
|
646 | 797 |
<row>
|
647 | 798 |
<entry><keycap>S</keycap></entry>
|
|
799 |
|
648 | 800 |
<entry><para>Toggle OSD SMPTE display.</para></entry>
|
649 | 801 |
</row>
|
|
802 |
|
650 | 803 |
<row>
|
651 | 804 |
<entry><keycap>V</keycap></entry>
|
|
805 |
|
652 | 806 |
<entry><para>Toggle OSD frame-number display.</para></entry>
|
653 | 807 |
</row>
|
|
808 |
|
654 | 809 |
<row>
|
655 | 810 |
<entry><keycap><</keycap></entry>
|
656 | |
<entry><para>Decrease window size by a factor of 1.2 .</para></entry>
|
|
811 |
|
|
812 |
<entry><para>Decrease window size by a factor of 1.2
|
|
813 |
.</para></entry>
|
657 | 814 |
</row>
|
|
815 |
|
658 | 816 |
<row>
|
659 | 817 |
<entry><keycap>></keycap></entry>
|
660 | |
<entry><para>Increase window size by a factor of 1.2 .</para></entry>
|
|
818 |
|
|
819 |
<entry><para>Increase window size by a factor of 1.2
|
|
820 |
.</para></entry>
|
661 | 821 |
</row>
|
|
822 |
|
662 | 823 |
<row>
|
663 | 824 |
<entry><keycap>.</keycap></entry>
|
664 | |
<entry><para>Resize window to original (movie-file) size.</para></entry>
|
|
825 |
|
|
826 |
<entry><para>Resize window to original (movie-file)
|
|
827 |
size.</para></entry>
|
665 | 828 |
</row>
|
|
829 |
|
666 | 830 |
<row>
|
667 | 831 |
<entry><keycap>,</keycap></entry>
|
668 | |
<entry><para>Scale window to match movies aspect ratio.</para></entry>
|
|
832 |
|
|
833 |
<entry><para>Scale window to match movies aspect
|
|
834 |
ratio.</para></entry>
|
669 | 835 |
</row>
|
|
836 |
|
670 | 837 |
<row>
|
671 | 838 |
<entry><keycap>-</keycap></entry>
|
672 | |
<entry><para>Decrement A/V offset by 1 video-frame.</para></entry>
|
|
839 |
|
|
840 |
<entry><para>Decrement A/V offset by 1
|
|
841 |
video-frame.</para></entry>
|
673 | 842 |
</row>
|
|
843 |
|
674 | 844 |
<row>
|
675 | 845 |
<entry><keycap>+</keycap></entry>
|
676 | |
<entry><para>Increment A/V offset by 1 video-frame.</para></entry>
|
|
846 |
|
|
847 |
<entry><para>Increment A/V offset by 1
|
|
848 |
video-frame.</para></entry>
|
677 | 849 |
</row>
|
|
850 |
|
678 | 851 |
<row>
|
679 | 852 |
<entry><keycap>{</keycap></entry>
|
|
853 |
|
680 | 854 |
<entry><para>Decrement A/V offset by 1 minute.</para></entry>
|
681 | 855 |
</row>
|
|
856 |
|
682 | 857 |
<row>
|
683 | 858 |
<entry><keycap>}</keycap></entry>
|
|
859 |
|
684 | 860 |
<entry><para>Increment A/V offset by 1 minute.</para></entry>
|
685 | 861 |
</row>
|
|
862 |
|
686 | 863 |
<row>
|
687 | 864 |
<entry><keycap>0-9</keycap></entry>
|
688 | |
<entry><para>change Color-EQ parameters with key pairs.
|
689 | |
brightness:1+2, contrast:3+4, gamma:5+6, saturation:7+8,
|
690 | |
hue:9+0</para>
|
691 | |
<para>XV color balance is hardware dependant: Some boards do
|
692 | |
not support all parameters. The imlib2 software EQ is limited
|
693 | |
to brightness/contrast and gamma correction.</para>
|
694 | |
</entry>
|
|
865 |
|
|
866 |
<entry><para>change Color-EQ parameters with key pairs.
|
|
867 |
brightness:1+2, contrast:3+4, gamma:5+6, saturation:7+8,
|
|
868 |
hue:9+0</para> <para>XV color balance is hardware dependant:
|
|
869 |
Some boards do not support all parameters. The imlib2 software
|
|
870 |
EQ is limited to brightness/contrast and gamma
|
|
871 |
correction.</para></entry>
|
695 | 872 |
</row>
|
696 | |
</tbody>
|
|
873 |
</tbody>
|
697 | 874 |
</tgroup>
|
698 | 875 |
</table>
|
699 | 876 |
</section>
|
|
704 | 881 |
|
705 | 882 |
<section id="examples" xreflabel="example commandlines">
|
706 | 883 |
<title>Example Commandlines</title>
|
707 | |
<para>
|
708 | |
<screen>xjadeo -f 25 -i 2 video-file.avi</screen> updates the monitor window 25 times per second and renders SMPTE on the bottom of the screen
|
709 | |
<screen>xjadeo -m -1 -v video-file.avi</screen> (using xjadeo compiled with portmidi) auto-connect to first available MIDI-in port and use arriving MTC messages display video in sync.
|
710 | |
<screen>xjadeo -f 12.5 -m 80:0 video-file.avi</screen> (using xjadeo compiled with ALSA seq) connect to MIDI device 80 port 0 and display video in sync with MTC messages, updating the screen every 80ms.
|
|
884 |
|
|
885 |
<para><screen>xjadeo -f 25 -i 2 video-file.avi</screen> updates the
|
|
886 |
monitor window 25 times per second and renders SMPTE on the bottom of
|
|
887 |
the screen <screen>xjadeo -m -1 -v video-file.avi</screen> (using
|
|
888 |
xjadeo compiled with portmidi) auto-connect to first available MIDI-in
|
|
889 |
port and use arriving MTC messages display video in sync. <screen>xjadeo -f 12.5 -m 80:0 video-file.avi</screen>
|
|
890 |
(using <application>Xjadeo</application> compiled with ALSA seq) connect to MIDI device 80 port 0
|
|
891 |
and display video in sync with MTC messages, updating the screen every
|
|
892 |
80ms.</para>
|
|
893 |
</section>
|
|
894 |
|
|
895 |
<section id="howto_ardour1">
|
|
896 |
<title>Configure Ardour 0.99.X to sync to JACK</title>
|
|
897 |
|
|
898 |
<para><itemizedlist>
|
|
899 |
<listitem>
|
|
900 |
<para><menuchoice>
|
|
901 |
<guimenu>Windows</guimenu>
|
|
902 |
|
|
903 |
<guimenuitem>Option Editor</guimenuitem>
|
|
904 |
</menuchoice></para>
|
|
905 |
</listitem>
|
|
906 |
|
|
907 |
<listitem>
|
|
908 |
<para>Tab "Sync"</para>
|
|
909 |
</listitem>
|
|
910 |
|
|
911 |
<listitem>
|
|
912 |
<para>Set "Positional Sync" to "Sync with JACK"</para>
|
|
913 |
</listitem>
|
|
914 |
|
|
915 |
<listitem>
|
|
916 |
<para>Check option "JACK time master" (optional)</para>
|
|
917 |
</listitem>
|
|
918 |
</itemizedlist></para>
|
|
919 |
</section>
|
|
920 |
|
|
921 |
<section id="howto_ardour2">
|
|
922 |
<title>Configure Ardour 2 and Ardour 3 to sync to JACK</title>
|
|
923 |
|
|
924 |
<para><application>Ardour2</application> has button just right of to
|
|
925 |
the clock which allows to set <application>Ardour's</application> sync
|
|
926 |
mode (Internal, JACK and MTC)</para>
|
|
927 |
|
|
928 |
<para>Note: All versions or <application>Ardour</application> provide
|
|
929 |
the alternative option to connect <application>Xjadeo</application> as
|
|
930 |
a MTC slave instead of using JACK-transport.</para>
|
|
931 |
</section>
|
|
932 |
|
|
933 |
<section id="howto_rg">
|
|
934 |
<title>configure rosegarden to run with <application>Xjadeo</application></title>
|
|
935 |
|
|
936 |
<para><itemizedlist>
|
|
937 |
<listitem>
|
|
938 |
<para><menuchoice>
|
|
939 |
<guimenu>Settings</guimenu>
|
|
940 |
|
|
941 |
<guimenuitem>Configure Rosegarden</guimenuitem>
|
|
942 |
</menuchoice></para>
|
|
943 |
</listitem>
|
|
944 |
|
|
945 |
<listitem>
|
|
946 |
<para>Select "Sequencer" icon.</para>
|
|
947 |
</listitem>
|
|
948 |
|
|
949 |
<listitem>
|
|
950 |
<para>Tab "Synchronization"</para>
|
|
951 |
</listitem>
|
|
952 |
|
|
953 |
<listitem>
|
|
954 |
<para>Set "JACK-transport mode" to "Sync"</para>
|
|
955 |
</listitem>
|
|
956 |
</itemizedlist></para>
|
|
957 |
</section>
|
|
958 |
|
|
959 |
<section id="howto_tco">
|
|
960 |
<title>Sync to RME HDME</title>
|
|
961 |
|
|
962 |
<para>If you own a
|
|
963 |
<ulink url="http://www.rme-audio.de/en_products_hdsp_tco.php">RME HDSP Time Code Option</ulink>
|
|
964 |
Module which is available for selected RME cards. You can use the MTC which is generated automatically
|
|
965 |
by hardware. Simply connect the MIDI port (which shows up as standard ALSA interface on Linux) to
|
|
966 |
<application>Xjadeo</application>'s MTC input.
|
711 | 967 |
</para>
|
712 | 968 |
</section>
|
713 | 969 |
|
714 | |
<section id="howto_ardour1">
|
715 | |
<title>Configure Ardour 0.99.X to sync to JACK</title>
|
716 | |
<para>
|
717 | |
<itemizedlist>
|
718 | |
<listitem>
|
719 | |
<para><menuchoice>
|
720 | |
<guimenu>Windows</guimenu>
|
721 | |
<guimenuitem>Option Editor</guimenuitem>
|
722 | |
</menuchoice></para>
|
723 | |
</listitem>
|
724 | |
<listitem>
|
725 | |
<para>Tab "Sync"</para>
|
726 | |
</listitem>
|
727 | |
<listitem>
|
728 | |
<para>Set "Positional Sync" to "Sync with JACK"</para>
|
729 | |
</listitem>
|
730 | |
<listitem>
|
731 | |
<para>Check option "JACK time master" (optional)</para>
|
732 | |
</listitem>
|
733 | |
</itemizedlist>
|
734 | |
</para>
|
735 | |
</section>
|
736 | |
|
737 | |
<section id="howto_ardour2">
|
738 | |
<title>Configure Ardour 2 and Ardour 3 to sync to JACK</title>
|
739 | |
<para><application>Ardour2</application> has button just right of to
|
740 | |
the clock which allows to set <application>Ardour's</application>
|
741 | |
sync mode (Internal, JACK and MTC)</para>
|
742 | |
<para>Note: All versions or <application>Ardour</application> provide
|
743 | |
the alternative option to connect <application>xjadeo</application>
|
744 | |
as a MTC slave instead of using JACK-transport.</para>
|
745 | |
</section>
|
746 | |
|
747 | |
<section id="howto_rg">
|
748 | |
<title>configure rosegarden to run with xjadeo</title>
|
749 | |
<para>
|
750 | |
<itemizedlist>
|
751 | |
<listitem>
|
752 | |
<para><menuchoice>
|
753 | |
<guimenu>Settings</guimenu>
|
754 | |
<guimenuitem>Configure Rosegarden</guimenuitem>
|
755 | |
</menuchoice></para>
|
756 | |
</listitem>
|
757 | |
<listitem>
|
758 | |
<para>Select "Sequencer" icon.</para>
|
759 | |
</listitem>
|
760 | |
<listitem>
|
761 | |
<para>Tab "Synchronization"</para>
|
762 | |
</listitem>
|
763 | |
<listitem>
|
764 | |
<para>Set "JACK-transport mode" to "Sync"</para>
|
765 | |
</listitem>
|
766 | |
</itemizedlist>
|
767 | |
</para>
|
768 | |
</section>
|
769 | 970 |
</section>
|
770 | 971 |
</section>
|
771 | 972 |
|
772 | |
<!-- CHAPTER -->
|
|
973 |
<!-- CHAPTER -->
|
773 | 974 |
|
774 | 975 |
<section id="troubleshoot_and_support">
|
775 | 976 |
<title>Troubleshoot & Support</title>
|
|
977 |
|
776 | 978 |
<section id="troubleshoot">
|
777 | 979 |
<title>Troubleshoot</title>
|
778 | 980 |
|
779 | |
<para>In case xjadeo does not work out of the box..</para>
|
|
981 |
<para>In case <application>Xjadeo</application> does not work out of the box..</para>
|
780 | 982 |
|
781 | 983 |
<itemizedlist>
|
782 | 984 |
<listitem>
|
783 | 985 |
<para>Try to play the (transcoded) video-file with another
|
784 | |
video-player. It may not be <application>xjadeo</application>'s
|
785 | |
fault but simply an invalid video-file.</para>
|
|
986 |
video-player. It may not be <application>Xjadeo</application>'s
|
|
987 |
fault but simply an invalid video-file.</para>
|
786 | 988 |
</listitem>
|
|
989 |
|
787 | 990 |
<listitem>
|
788 | 991 |
<para>run <command>xjadeo -v filename</command> - look for warning
|
789 | |
and error messages, verify that the detected duration and offset
|
790 | |
(override with <option>-I</option> is correct. In verbose-more
|
791 | |
(<option>-v</option>) <application>xjadeo</application> also prints
|
792 | |
information about thedisplayed frame and JACK-transport which might
|
793 | |
give a clue to what is going on.</para>
|
|
992 |
and error messages, verify that the detected duration and offset
|
|
993 |
(override with <option>-I</option> is correct. In verbose-more
|
|
994 |
(<option>-v</option>) <application>Xjadeo</application> also prints
|
|
995 |
information about thedisplayed frame and JACK-transport which might
|
|
996 |
give a clue to what is going on.</para>
|
794 | 997 |
</listitem>
|
|
998 |
|
795 | 999 |
<listitem>
|
796 | |
<para>open the example video from <ulink
|
797 | |
url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob;f=contrib/xjadeo-example.avi"
|
798 | |
>http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob;f=contrib/xjadeo-example.avi</ulink>
|
799 | |
or validate time-accurancy using time-stamped test videos: <ulink
|
800 | |
url="http://tux.gareus.org/torrents/tsmm_mjpeg-avi_10mins.torrent"
|
801 | |
>http://tux.gareus.org/torrents/tsmm_mjpeg-avi_10mins.torrent</ulink>.
|
802 | |
</para>
|
|
1000 |
<para>open the example video from <ulink url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob;f=contrib/xjadeo-example.avi">http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob;f=contrib/xjadeo-example.avi</ulink>
|
|
1001 |
or validate time-accurancy using time-stamped test videos: <ulink url="http://tux.gareus.org/torrents/tsmm_mjpeg-avi_10mins.torrent">http://tux.gareus.org/torrents/tsmm_mjpeg-avi_10mins.torrent</ulink>.</para>
|
803 | 1002 |
</listitem>
|
804 | 1003 |
|
805 | 1004 |
<listitem>
|
806 | |
<para>Ask for help and share your experience:
|
807 | |
<ulink url="http://sourceforge.net/projects/xjadeo/support"
|
808 | |
>http://sourceforge.net/projects/xjadeo/support</ulink>.
|
809 | |
Don't hesitate and don't be shy. We require your feedback to
|
810 | |
improve <application>xjadeo</application>.
|
811 | |
Please include the output of <command>xjadeo -V</command>.
|
812 | |
</para>
|
|
1005 |
<para>Ask for help and share your experience: <ulink url="http://sourceforge.net/projects/xjadeo/support">http://sourceforge.net/projects/xjadeo/support</ulink>.
|
|
1006 |
Don't hesitate and don't be shy! We require your feedback to improve
|
|
1007 |
<application>Xjadeo</application>. Please include the output of
|
|
1008 |
<command>xjadeo -V</command>.</para>
|
813 | 1009 |
</listitem>
|
814 | 1010 |
</itemizedlist>
|
815 | 1011 |
</section>
|
|
819 | 1015 |
|
820 | 1016 |
<para>Some Video codecs are known not to work properly on some systems.
|
821 | 1017 |
This is mostly due to different ffmpeg versions, available codec
|
822 | |
decoders, etc. There is nothing we can do about it. You are required
|
823 | |
to transcode the video into a suitable format.
|
824 | |
see <xref linkend="video_formats"/></para>
|
825 | |
|
826 | |
<para><application>xjadeo</application> portmidi sync make xjadeo bail
|
|
1018 |
decoders, etc. There is nothing we can do about it. You are required to
|
|
1019 |
transcode the video into a suitable format. see <xref linkend="video_formats"/></para>
|
|
1020 |
|
|
1021 |
<para><application>Xjadeo</application> portmidi sync make <application>Xjadeo</application> bail
|
827 | 1022 |
out if it fails to connect or encounters a MIDI buffer overflow. This is
|
828 | 1023 |
in fact a feature of portmidi but could also be considered a bug in
|
829 | |
<application>xjadeo</application>.</para>
|
830 | |
|
831 | |
<para>X11 / nvidia might not work properly with the <ulink url="http://download.nvidia.com/XFree86/Linux-x86_64/1.0-8762/README/appendix-s.html">Composite Extension</ulink> as reported in the <ulink url="http://sourceforge.net/forum/forum.php?thread_id=1437336?forum_id=447923">Forum</ulink>.
|
832 | |
Temporarily disable this extension
|
833 | |
<command>nvidia-xconfig --composite</command>
|
834 | |
<command>nvidia-xconfig --no-composite</command>
|
835 | |
or permanently disable it in your X configuration:
|
836 | |
<screen>
|
|
1024 |
<application>Xjadeo</application>.</para>
|
|
1025 |
|
|
1026 |
<para>X11 / nvidia might not work properly with the <ulink url="http://download.nvidia.com/XFree86/Linux-x86_64/1.0-8762/README/appendix-s.html">Composite
|
|
1027 |
Extension</ulink> as reported in the <ulink url="http://sourceforge.net/forum/forum.php?thread_id=1437336?forum_id=447923">Forum</ulink>.
|
|
1028 |
Temporarily disable this extension <command>nvidia-xconfig
|
|
1029 |
--composite</command> <command>nvidia-xconfig --no-composite</command>
|
|
1030 |
or permanently disable it in your X configuration: <screen>
|
837 | 1031 |
Section "Extensions"
|
838 | 1032 |
Option "Composite" "Disable"
|
839 | 1033 |
EndSection
|
840 | |
</screen>
|
841 | |
</para>
|
842 | |
|
843 | |
<para>If you experience unexpected behavior please file a bug report
|
844 | |
<ulink url="http://sourceforge.net/projects/xjadeo/support"
|
845 | |
>http://sourceforge.net/projects/xjadeo/support</ulink>
|
846 | |
or <ulink url="http://sourceforge.net/project/memberlist.php?group_id=131926"
|
847 | |
>contact the developers</ulink>.
|
848 | |
</para>
|
|
1034 |
</screen></para>
|
|
1035 |
|
|
1036 |
<para>If you experience unexpected behavior please file a bug report
|
|
1037 |
<ulink url="http://sourceforge.net/projects/xjadeo/support">http://sourceforge.net/projects/xjadeo/support</ulink>
|
|
1038 |
or <ulink url="http://sourceforge.net/project/memberlist.php?group_id=131926">contact
|
|
1039 |
the developers</ulink>.</para>
|
849 | 1040 |
</section>
|
850 | 1041 |
</section>
|
851 | 1042 |
|
852 | |
<!-- CHAPTER -->
|
|
1043 |
<!-- CHAPTER -->
|
853 | 1044 |
|
854 | 1045 |
<section id="remote_control_interface">
|
855 | 1046 |
<title>Remote Control Interface</title>
|
856 | 1047 |
|
857 | |
<para><application>xjadeo</application> features a remote control mode that
|
858 | |
allows to modify all settings of a running xjadeo instance. When started
|
859 | |
in remote mode (using option <option>-R</option> or
|
|
1048 |
<para><application>Xjadeo</application> features a remote control mode
|
|
1049 |
that allows you to modify all settings of a running <application>Xjadeo</application> instance. When
|
|
1050 |
started in remote mode (using option <option>-R</option> or
|
860 | 1051 |
<option>--remote</option>) <command>xjadeo</command> will interactively
|
861 | |
accept commands and issue responses through standard input/output
|
|
1052 |
accept commands and issue responses through the standard input/output
|
862 | 1053 |
mechanism.</para>
|
863 | 1054 |
|
864 | |
<para>Since version <literal>0.3.20</literal> xjadeo implements POSIX <ulink
|
865 | |
url="http://www.linuxhowtos.org/manpages/7/mq_overview.htm"
|
866 | |
>message queues</ulink> as an alternative to the standard-I/O remote
|
867 | |
control and since 0.4.11 also System-V IPC. The latter provide the
|
868 | |
capability to dis- and re-connect to existing xjadeo sessions. For more
|
869 | |
information about message queues read the
|
870 | |
<xref linkend="xjremote"/> manual.</para>
|
871 | |
|
872 | |
<para>Note that <application>qjadeo</application> controls xjadeo via
|
|
1055 |
<para>Since version <literal>0.3.20</literal> <application>Xjadeo</application> implements POSIX
|
|
1056 |
<ulink url="http://www.linuxhowtos.org/manpages/7/mq_overview.htm">message
|
|
1057 |
queues</ulink> as an alternative to the standard-I/O remote control and
|
|
1058 |
since 0.4.11 also System-V IPC. The latter allows you to disconnect from
|
|
1059 |
and reconnect to an existing <application>Xjadeo</application> session. For more information about
|
|
1060 |
message queues read the <xref linkend="xjremote"/> manual.</para>
|
|
1061 |
|
|
1062 |
<para>Note that <application>qjadeo</application> controls <application>Xjadeo</application> via
|
873 | 1063 |
message queues.</para>
|
874 | 1064 |
|
875 | 1065 |
<important>
|
876 | |
<para><application>xjadeo</application>'s remote control interpreter is
|
877 | |
self documented, use the <option>help</option> command to query the
|
878 | |
available set of commands. The following list only covers basic
|
879 | |
interaction:</para>
|
|
1066 |
<para><application>Xjadeo</application>'s remote control interpreter is
|
|
1067 |
self documented, use the <option>help</option> command to query the
|
|
1068 |
available command set. The following list only covers basic
|
|
1069 |
interaction:</para>
|
880 | 1070 |
</important>
|
881 | 1071 |
|
882 | 1072 |
<section id="rc_general">
|
|
885 | 1075 |
<variablelist>
|
886 | 1076 |
<varlistentry>
|
887 | 1077 |
<term><option>help</option></term>
|
888 | |
<listitem>
|
889 | |
<para>print a list of available commands with a short description.
|
890 | |
</para>
|
|
1078 |
|
|
1079 |
<listitem>
|
|
1080 |
<para>print a list of available commands with a short
|
|
1081 |
description.</para>
|
891 | 1082 |
</listitem>
|
892 | 1083 |
</varlistentry>
|
893 | 1084 |
|
894 | 1085 |
<varlistentry>
|
895 | 1086 |
<term><option>quit</option></term>
|
|
1087 |
|
896 | 1088 |
<listitem>
|
897 | 1089 |
<para>exit qjadeo.</para>
|
898 | 1090 |
</listitem>
|
|
905 | 1097 |
|
906 | 1098 |
<variablelist>
|
907 | 1099 |
<varlistentry>
|
908 | |
<term><option>load <replaceable
|
909 | |
class="option">filename</replaceable></option></term>
|
|
1100 |
<term><option>load <replaceable class="option">filename</replaceable></option></term>
|
|
1101 |
|
910 | 1102 |
<listitem>
|
911 | 1103 |
<para>Load a video file, replacing any previous one.</para>
|
912 | 1104 |
</listitem>
|
|
914 | 1106 |
|
915 | 1107 |
<varlistentry>
|
916 | 1108 |
<term><option>unload</option></term>
|
|
1109 |
|
917 | 1110 |
<listitem>
|
918 | 1111 |
<para>Close the current video file.</para>
|
919 | 1112 |
</listitem>
|
|
921 | 1114 |
|
922 | 1115 |
<varlistentry>
|
923 | 1116 |
<term><option>get filename</option></term>
|
|
1117 |
|
924 | 1118 |
<listitem>
|
925 | 1119 |
<para>Returns the file name of the current movie.</para>
|
926 | 1120 |
</listitem>
|
|
928 | 1122 |
|
929 | 1123 |
<varlistentry>
|
930 | 1124 |
<term><option>get duration</option></term>
|
|
1125 |
|
931 | 1126 |
<listitem>
|
932 | 1127 |
<para>Returns the length of the movie in seconds.</para>
|
933 | 1128 |
</listitem>
|
|
935 | 1130 |
|
936 | 1131 |
<varlistentry>
|
937 | 1132 |
<term><option>get frames</option></term>
|
|
1133 |
|
938 | 1134 |
<listitem>
|
939 | 1135 |
<para>Returns the length of the movie in frames.</para>
|
940 | 1136 |
</listitem>
|
|
942 | 1138 |
|
943 | 1139 |
<varlistentry>
|
944 | 1140 |
<term><option>get frame-rate</option></term>
|
|
1141 |
|
945 | 1142 |
<listitem>
|
946 | 1143 |
<para>Returns the frame rate of the current movie.</para>
|
947 | 1144 |
</listitem>
|
|
949 | 1146 |
|
950 | 1147 |
<varlistentry>
|
951 | 1148 |
<term><option>get width</option></term>
|
|
1149 |
|
952 | 1150 |
<listitem>
|
953 | 1151 |
<para>Returns the width of the current movie in pixels.</para>
|
954 | 1152 |
</listitem>
|
|
956 | 1154 |
|
957 | 1155 |
<varlistentry>
|
958 | 1156 |
<term><option>get height</option></term>
|
|
1157 |
|
959 | 1158 |
<listitem>
|
960 | 1159 |
<para>Returns the height of the current movie in pixels.</para>
|
961 | 1160 |
</listitem>
|
|
963 | 1162 |
|
964 | 1163 |
<varlistentry>
|
965 | 1164 |
<term><option>get seekmode</option></term>
|
966 | |
<listitem>
|
967 | |
<para>Returns an integer from 1 to 3 on how xjadeo seeks to a given
|
968 | |
video frame.</para>
|
969 | |
<variablelist>
|
970 | |
<varlistentry>
|
971 | |
<term><option>1</option></term>
|
972 | |
<listitem>
|
973 | |
<para>seek <option>continuous</option>ly starting from the
|
974 | |
previous key-frame.</para>
|
975 | |
</listitem>
|
976 | |
</varlistentry>
|
977 | |
<varlistentry>
|
978 | |
<term><option>2</option></term>
|
979 | |
<listitem>
|
980 | |
<para>seek directly to <option>any</option> frame.</para>
|
981 | |
</listitem>
|
982 | |
</varlistentry>
|
983 | |
<varlistentry>
|
984 | |
<term><option>3</option></term>
|
985 | |
<listitem>
|
986 | |
<para>seek only to <option>keyframe</option>s.</para>
|
987 | |
</listitem>
|
988 | |
</varlistentry>
|
989 | |
</variablelist>
|
990 | |
</listitem>
|
991 | |
</varlistentry>
|
992 | |
|
993 | |
<varlistentry>
|
994 | |
<term><option>set seekmode
|
995 | |
<replaceable class="option">value</replaceable></option></term>
|
996 | |
<listitem>
|
997 | |
<para>Set the seek-mode. Valid parameters are integer 1-3 or any of
|
998 | |
the words: <option>keyframe</option>, <option>any</option> or
|
999 | |
<option>continuous</option>.</para>
|
|
1165 |
|
|
1166 |
<listitem>
|
|
1167 |
<para>Returns an integer from 1 to 3 on how <application>Xjadeo</application> seeks to a
|
|
1168 |
given video frame.</para>
|
|
1169 |
|
|
1170 |
<variablelist>
|
|
1171 |
<varlistentry>
|
|
1172 |
<term><option>1</option></term>
|
|
1173 |
|
|
1174 |
<listitem>
|
|
1175 |
<para>seek <option>continuous</option>ly starting from the
|
|
1176 |
previous key-frame.</para>
|
|
1177 |
</listitem>
|
|
1178 |
</varlistentry>
|
|
1179 |
|
|
1180 |
<varlistentry>
|
|
1181 |
<term><option>2</option></term>
|
|
1182 |
|
|
1183 |
<listitem>
|
|
1184 |
<para>seek directly to <option>any</option> frame.</para>
|
|
1185 |
</listitem>
|
|
1186 |
</varlistentry>
|
|
1187 |
|
|
1188 |
<varlistentry>
|
|
1189 |
<term><option>3</option></term>
|
|
1190 |
|
|
1191 |
<listitem>
|
|
1192 |
<para>seek only to <option>keyframe</option>s.</para>
|
|
1193 |
</listitem>
|
|
1194 |
</varlistentry>
|
|
1195 |
</variablelist>
|
|
1196 |
</listitem>
|
|
1197 |
</varlistentry>
|
|
1198 |
|
|
1199 |
<varlistentry>
|
|
1200 |
<term><option>set seekmode <replaceable class="option">value</replaceable></option></term>
|
|
1201 |
|
|
1202 |
<listitem>
|
|
1203 |
<para>Set the seek-mode. Valid parameters are integer 1-3 or any
|
|
1204 |
of the words: <option>keyframe</option>, <option>any</option> or
|
|
1205 |
<option>continuous</option>.</para>
|
1000 | 1206 |
</listitem>
|
1001 | 1207 |
</varlistentry>
|
1002 | 1208 |
</variablelist>
|
|
1041 | 1247 |
<variablelist>
|
1042 | 1248 |
<varlistentry>
|
1043 | 1249 |
<term><option>ltc connect</option></term>
|
|
1250 |
|
1044 | 1251 |
<listitem>
|
1045 | 1252 |
<para>Connect to JACK and sync to audio received on the
|
1046 | |
<literal>xjadeo:ltc</literal> audio port.</para>
|
|
1253 |
<literal>xjadeo:ltc</literal> audio port.</para>
|
1047 | 1254 |
</listitem>
|
1048 | 1255 |
</varlistentry>
|
1049 | 1256 |
|
1050 | 1257 |
<varlistentry>
|
1051 | 1258 |
<term><option>ltc disconnect</option></term>
|
|
1259 |
|
1052 | 1260 |
<listitem>
|
1053 | 1261 |
<para>Disconnect from JACK and disable LTC sync.</para>
|
1054 | 1262 |
</listitem>
|
|
1056 | 1264 |
|
1057 | 1265 |
<varlistentry>
|
1058 | 1266 |
<term><option>ltc status</option></term>
|
|
1267 |
|
1059 | 1268 |
<listitem>
|
1060 | 1269 |
<para>Display status of JACK/LTC connection.</para>
|
1061 | 1270 |
</listitem>
|
|
1069 | 1278 |
<variablelist>
|
1070 | 1279 |
<varlistentry>
|
1071 | 1280 |
<term><option>midi reconnect</option></term>
|
1072 | |
<listitem>
|
1073 | |
<para>(Dis and re)connect to the last specified MIDI port.
|
1074 | |
The default port is -1, but it can be overridden with
|
1075 | |
<option>-m</option> or the
|
1076 | |
<command>midi open <port></command> command.</para>
|
|
1281 |
|
|
1282 |
<listitem>
|
|
1283 |
<para>(Dis and re)connect to the last specified MIDI port. The
|
|
1284 |
default port is -1, but it can be overridden with
|
|
1285 |
<option>-m</option> or the <command>midi open
|
|
1286 |
<port></command> command.</para>
|
|
1287 |
|
1077 | 1288 |
<para>Note: when a MIDI port is connected, the JACK-transport
|
1078 | |
information will be ignored, no matter if xjadeo is connected
|
1079 | |
to JACK or not.</para>
|
1080 | |
</listitem>
|
1081 | |
</varlistentry>
|
1082 | |
|
1083 | |
<varlistentry>
|
1084 | |
<term><option>midi driver
|
1085 | |
<replaceable class="option">driver-name</replaceable></option>
|
1086 | |
</term>
|
|
1289 |
information will be ignored, no matter if <application>Xjadeo</application> is connected to
|
|
1290 |
JACK or not.</para>
|
|
1291 |
</listitem>
|
|
1292 |
</varlistentry>
|
|
1293 |
|
|
1294 |
<varlistentry>
|
|
1295 |
<term><option>midi driver <replaceable class="option">driver-name</replaceable></option></term>
|
|
1296 |
|
1087 | 1297 |
<listitem>
|
1088 | 1298 |
<para>Choose MIDI back-end to use (ALSA, portmidi or JACK -
|
1089 | |
available back-ends depend on the operating-system and
|
1090 | |
compile-time configuration), or if
|
1091 | |
<replaceable class="option">driver-name</replaceable> is empty
|
1092 | |
print current driver.</para>
|
1093 | |
</listitem>
|
1094 | |
</varlistentry>
|
1095 | |
|
1096 | |
<varlistentry>
|
1097 | |
<term><option>midi connect
|
1098 | |
<replaceable class="option">port</replaceable></option></term>
|
|
1299 |
available back-ends depend on the operating-system and
|
|
1300 |
compile-time configuration), or if <replaceable class="option">driver-name</replaceable> is empty print current
|
|
1301 |
driver.</para>
|
|
1302 |
</listitem>
|
|
1303 |
</varlistentry>
|
|
1304 |
|
|
1305 |
<varlistentry>
|
|
1306 |
<term><option>midi connect <replaceable class="option">port</replaceable></option></term>
|
|
1307 |
|
1099 | 1308 |
<listitem>
|
1100 | 1309 |
<para>Get sync from MTC (MIDI Time Code) instead of JACK.</para>
|
1101 | 1310 |
|
1102 | |
<para>If using ALSA MIDI, <replaceable
|
1103 | |
class="option">port</replaceable> is the ALSA sequencer id of
|
|
1311 |
<para>If using ALSA MIDI, <replaceable class="option">port</replaceable> is the ALSA sequencer id of
|
1104 | 1312 |
the MTC source. A value of -1 will leave
|
1105 | |
<application>xjadeo</application> unconnected.</para>
|
1106 | |
|
1107 | |
<para>for JACK MIDI, <replaceable
|
1108 | |
class="option">port</replaceable> is the JACK-MIDI port name
|
1109 | |
to auto-connect to. An empty value or non-existing port-name
|
1110 | |
will leave <application>xjadeo</application> unconnected.</para>
|
1111 | |
|
1112 | |
<para>If using portmidi, <replaceable
|
1113 | |
class="option">port</replaceable> is the port number of the MIDI
|
|
1313 |
<application>Xjadeo</application> unconnected.</para>
|
|
1314 |
|
|
1315 |
<para>for JACK MIDI, <replaceable class="option">port</replaceable> is the JACK-MIDI port name to
|
|
1316 |
auto-connect to. An empty value or non-existing port-name will
|
|
1317 |
leave <application>Xjadeo</application> unconnected.</para>
|
|
1318 |
|
|
1319 |
<para>If using portmidi, <replaceable class="option">port</replaceable> is the port number of the MIDI
|
1114 | 1320 |
input to use. WARNING: using an invalid id with portmidi will
|
1115 | |
cause xjadeo to bail out!</para>
|
|
1321 |
cause <application>Xjadeo</application> to bail out!</para>
|
1116 | 1322 |
</listitem>
|
1117 | 1323 |
</varlistentry>
|
1118 | 1324 |
|
1119 | 1325 |
<varlistentry>
|
1120 | 1326 |
<term><option>midi disconnect </option></term>
|
|
1327 |
|
1121 | 1328 |
<listitem>
|
1122 | 1329 |
<para>Close MIDI device.</para>
|
1123 | 1330 |
</listitem>
|
|
1125 | 1332 |
|
1126 | 1333 |
<varlistentry>
|
1127 | 1334 |
<term><option>midi status </option></term>
|
|
1335 |
|
1128 | 1336 |
<listitem>
|
1129 | 1337 |
<para>Displays the status of the
|
1130 | |
<application>xjadeo</application> MIDI port connection.</para>
|
|
1338 |
<application>Xjadeo</application> MIDI port connection.</para>
|
1131 | 1339 |
</listitem>
|
1132 | 1340 |
</varlistentry>
|
1133 | 1341 |
|
1134 | 1342 |
<varlistentry>
|
1135 | 1343 |
<term><option>get midisync </option></term>
|
|
1344 |
|
1136 | 1345 |
<listitem>
|
1137 | 1346 |
<para>Display MIDI SMPTE conversion mode, corresponding to -M
|
1138 | 1347 |
option.</para>
|
|
1140 | 1349 |
</varlistentry>
|
1141 | 1350 |
|
1142 | 1351 |
<varlistentry>
|
1143 | |
<term><option>set midisync <replaceable>n</replaceable></option>
|
1144 | |
</term>
|
|
1352 |
<term><option>set midisync
|
|
1353 |
<replaceable>n</replaceable></option></term>
|
|
1354 |
|
1145 | 1355 |
<listitem>
|
1146 | 1356 |
<para>Set MIDI SMPTE conversion mode.
|
1147 | |
<replaceable>n</replaceable> is an integer, corresponding to
|
1148 | |
the <option>-M</option> command line option.</para>
|
|
1357 |
<replaceable>n</replaceable> is an integer, corresponding to the
|
|
1358 |
<option>-M</option> command line option.</para>
|
1149 | 1359 |
</listitem>
|
1150 | 1360 |
</varlistentry>
|
1151 | 1361 |
</variablelist>
|
1152 | 1362 |
</section>
|
1153 | 1363 |
|
1154 | 1364 |
<section id="sync_remote_commands" xreflabel="xjadeo synchronization commands">
|
1155 | |
<title>General xjadeo sync commands</title>
|
|
1365 |
<title>General <application>Xjadeo</application> sync commands</title>
|
1156 | 1366 |
|
1157 | 1367 |
<variablelist>
|
1158 | 1368 |
<varlistentry>
|
1159 | |
<term><option>seek <replaceable
|
1160 | |
class="option">frame</replaceable></option></term>
|
1161 | |
<listitem>
|
1162 | |
<para>"Default" frame to display when disconnected from
|
1163 | |
any other sync source.</para>
|
|
1369 |
<term><option>seek <replaceable class="option">frame</replaceable></option></term>
|
|
1370 |
|
|
1371 |
<listitem>
|
|
1372 |
<para>"Default" frame to display when disconnected from any
|
|
1373 |
other sync source.</para>
|
1164 | 1374 |
</listitem>
|
1165 | 1375 |
</varlistentry>
|
1166 | 1376 |
|
1167 | 1377 |
<varlistentry>
|
1168 | 1378 |
<term><option>get position</option></term>
|
|
1379 |
|
1169 | 1380 |
<listitem>
|
1170 | 1381 |
<para>Returns the current frame number.</para>
|
1171 | 1382 |
</listitem>
|
|
1173 | 1384 |
|
1174 | 1385 |
<varlistentry>
|
1175 | 1386 |
<term><option>get smpte</option></term>
|
|
1387 |
|
1176 | 1388 |
<listitem>
|
1177 | 1389 |
<para>Returns the current head position in SMPTE code.</para>
|
1178 | 1390 |
</listitem>
|
|
1180 | 1392 |
|
1181 | 1393 |
<varlistentry>
|
1182 | 1394 |
<term><option>get syncsource</option></term>
|
1183 | |
<listitem>
|
1184 | |
<para>Prints the currently active source:
|
1185 | |
<literal>3</literal>: LTC,
|
1186 | |
<literal>2</literal>:MIDI,
|
1187 | |
<literal>1</literal>:JACK,
|
1188 | |
<literal>0</literal>:none / manual seek</para>
|
|
1395 |
|
|
1396 |
<listitem>
|
|
1397 |
<para>Prints the currently active source: <literal>3</literal>:
|
|
1398 |
LTC, <literal>2</literal>:MIDI, <literal>1</literal>:JACK,
|
|
1399 |
<literal>0</literal>:none / manual seek</para>
|
1189 | 1400 |
</listitem>
|
1190 | 1401 |
</varlistentry>
|
1191 | 1402 |
|
1192 | 1403 |
<varlistentry>
|
1193 | 1404 |
<term><option>get fps</option></term>
|
|
1405 |
|
1194 | 1406 |
<listitem>
|
1195 | 1407 |
<para>Returns the current window update rate.</para>
|
1196 | 1408 |
</listitem>
|
1197 | 1409 |
</varlistentry>
|
1198 | 1410 |
|
1199 | 1411 |
<varlistentry>
|
1200 | |
<term><option>set fps <replaceable
|
1201 | |
class="option">value</replaceable></option></term>
|
|
1412 |
<term><option>set fps <replaceable class="option">value</replaceable></option></term>
|
|
1413 |
|
1202 | 1414 |
<listitem>
|
1203 | 1415 |
<para>Set the window update rate.</para>
|
1204 | 1416 |
</listitem>
|
|
1206 | 1418 |
|
1207 | 1419 |
<varlistentry>
|
1208 | 1420 |
<term><option>get offset</option></term>
|
|
1421 |
|
1209 | 1422 |
<listitem>
|
1210 | 1423 |
<para>Returns the current time offset in frames.</para>
|
1211 | 1424 |
</listitem>
|
1212 | 1425 |
</varlistentry>
|
1213 | 1426 |
|
1214 | 1427 |
<varlistentry>
|
1215 | |
<term><option>set offset
|
1216 | |
<replaceable class="option">value</replaceable></option></term>
|
|
1428 |
<term><option>set offset <replaceable class="option">value</replaceable></option></term>
|
|
1429 |
|
1217 | 1430 |
<listitem>
|
1218 | 1431 |
<para>Set the time offset in frames.</para>
|
1219 | 1432 |
</listitem>
|
|
1236 | 1449 |
|
1237 | 1450 |
<varlistentry>
|
1238 | 1451 |
<term><option>window open</option></term>
|
|
1452 |
|
1239 | 1453 |
<listitem>
|
1240 | 1454 |
<para>Opens the video window using the default video-mode. The
|
1241 | |
default video-mode is 'autodetect' unless overridden on the
|
1242 | |
command-line.</para>
|
|
1455 |
default video-mode is 'autodetect' unless overridden on the
|
|
1456 |
command-line.</para>
|
1243 | 1457 |
</listitem>
|
1244 | 1458 |
</varlistentry>
|
1245 | 1459 |
|
1246 | 1460 |
<varlistentry>
|
1247 | 1461 |
<term><option>window mode
|
1248 | |
<replaceable>video-mode</replaceable></option></term>
|
|
1462 |
<replaceable>video-mode</replaceable></option></term>
|
|
1463 |
|
1249 | 1464 |
<listitem>
|
1250 | 1465 |
<para>Opens the video window using the specified video-mode. A
|
1251 | |
value of 0 autodetects while a positive integer corresponds to a
|
1252 | |
video-mode which can be listed with the
|
1253 | |
<command>list videomodes</command> command.</para>
|
1254 | |
</listitem>
|
1255 | |
</varlistentry>
|
1256 | |
|
1257 | |
<varlistentry>
|
1258 | |
<term><option>window resize <replaceable
|
1259 | |
class="option">value</replaceable></option></term>
|
|
1466 |
value of 0 autodetects while a positive integer corresponds to a
|
|
1467 |
video-mode which can be listed with the <command>list
|
|
1468 |
videomodes</command> command.</para>
|
|
1469 |
</listitem>
|
|
1470 |
</varlistentry>
|
|
1471 |
|
|
1472 |
<varlistentry>
|
|
1473 |
<term><option>window resize <replaceable class="option">value</replaceable></option></term>
|
|
1474 |
|
1260 | 1475 |
<listitem>
|
1261 | 1476 |
<para>Resizes the monitor window. Value may either be a 2
|
1262 | |
dimensional vector <width>x<height> of absolute
|
1263 | |
values, or a single integer specifying the window size in
|
1264 | |
percentage of the movie file geometry.</para>
|
1265 | |
</listitem>
|
1266 | |
</varlistentry>
|
1267 | |
|
1268 | |
<varlistentry>
|
1269 | |
<term><option>window move <replaceable
|
1270 | |
class="option">value</replaceable></option></term>
|
|
1477 |
dimensional vector <width>x<height> of absolute
|
|
1478 |
values, or a single integer specifying the window size in
|
|
1479 |
percentage of the movie file geometry.</para>
|
|
1480 |
</listitem>
|
|
1481 |
</varlistentry>
|
|
1482 |
|
|
1483 |
<varlistentry>
|
|
1484 |
<term><option>window move <replaceable class="option">value</replaceable></option></term>
|
|
1485 |
|
1271 | 1486 |
<listitem>
|
1272 | 1487 |
<para>Position the monitor window on the desktop. The value is
|
1273 | |
expected to be: <width>x<height></para>
|
|
1488 |
expected to be: <width>x<height></para>
|
1274 | 1489 |
</listitem>
|
1275 | 1490 |
</varlistentry>
|
1276 | 1491 |
|
1277 | 1492 |
<varlistentry>
|
1278 | 1493 |
<term><option>get windowsize</option></term>
|
|
1494 |
|
1279 | 1495 |
<listitem>
|
1280 | 1496 |
<para>Prints the size of the video window in a 2D vector.
|
1281 | 1497 |
<width>x<height></para>
|
|
1284 | 1500 |
|
1285 | 1501 |
<varlistentry>
|
1286 | 1502 |
<term><option>get videomode</option></term>
|
|
1503 |
|
1287 | 1504 |
<listitem>
|
1288 | 1505 |
<para>Returns the current video mode.</para>
|
1289 | 1506 |
</listitem>
|
|
1291 | 1508 |
|
1292 | 1509 |
<varlistentry>
|
1293 | 1510 |
<term><option>list videomodes</option></term>
|
|
1511 |
|
1294 | 1512 |
<listitem>
|
1295 | 1513 |
<para>Prints a list of available video modes.</para>
|
1296 | 1514 |
</listitem>
|
|
1304 | 1522 |
<variablelist>
|
1305 | 1523 |
<varlistentry>
|
1306 | 1524 |
<term><option>notify loop </option></term>
|
1307 | |
<listitem>
|
1308 | |
<para>Enables async messages. <application>xjadeo</application>
|
1309 | |
will generate a '@300' reply message each time it polls for a
|
1310 | |
time-code (one message per loop is emitted at the frequency
|
1311 | |
specified with <option>-f</option> ).</para>
|
|
1525 |
|
|
1526 |
<listitem>
|
|
1527 |
<para>Enables async messages. <application>Xjadeo</application>
|
|
1528 |
will generate a '@300' reply message each time it polls for a
|
|
1529 |
time-code (one message per loop is emitted at the frequency
|
|
1530 |
specified with <option>-f</option> ).</para>
|
1312 | 1531 |
</listitem>
|
1313 | 1532 |
</varlistentry>
|
1314 | 1533 |
|
1315 | 1534 |
<varlistentry>
|
1316 | 1535 |
<term><option>notify frame </option></term>
|
1317 | |
<listitem>
|
1318 | |
<para>Enables async messages. <application>xjadeo</application>
|
1319 | |
will generate a '@300' reply message each time it displays a new
|
1320 | |
video-frame.</para>
|
|
1536 |
|
|
1537 |
<listitem>
|
|
1538 |
<para>Enables async messages. <application>Xjadeo</application>
|
|
1539 |
will generate a '@300' reply message each time it displays a new
|
|
1540 |
video-frame.</para>
|
1321 | 1541 |
</listitem>
|
1322 | 1542 |
</varlistentry>
|
1323 | 1543 |
|
1324 | 1544 |
<varlistentry>
|
1325 | 1545 |
<term><option>notify disable </option></term>
|
|
1546 |
|
1326 | 1547 |
<listitem>
|
1327 | 1548 |
<para>Stop generating notify messages.</para>
|
1328 | 1549 |
</listitem>
|
|
1332 | 1553 |
|
1333 | 1554 |
<section id="rc_osd">
|
1334 | 1555 |
<title>On Screen Display Commands</title>
|
|
1556 |
|
1335 | 1557 |
<variablelist>
|
1336 | 1558 |
<varlistentry>
|
1337 | 1559 |
<term><option>osd frame
|
1338 | |
<replaceable>ypos</replaceable></option></term>
|
|
1560 |
<replaceable>ypos</replaceable></option></term>
|
|
1561 |
|
1339 | 1562 |
<listitem>
|
1340 | 1563 |
<para>Render current frame-number on screen.
|
1341 | |
<replaceable>ypos</replaceable> specifies the vertical position
|
1342 | |
in percent (0..100). The text is horizontally centered.
|
1343 | |
A value <0 disables the frame display.</para>
|
|
1564 |
<replaceable>ypos</replaceable> specifies the vertical position in
|
|
1565 |
percent (0..100). The text is horizontally centered. A value <0
|
|
1566 |
disables the frame display.</para>
|
1344 | 1567 |
</listitem>
|
1345 | 1568 |
</varlistentry>
|
1346 | 1569 |
|
1347 | 1570 |
<varlistentry>
|
1348 | 1571 |
<term><option>osd smpte
|
1349 | |
<replaceable>ypos</replaceable></option></term>
|
|
1572 |
<replaceable>ypos</replaceable></option></term>
|
|
1573 |
|
1350 | 1574 |
<listitem>
|
1351 | 1575 |
<para>Render SMPTE on screen. <replaceable>ypos</replaceable>
|
1352 | |
specifies the vertical position in percent. The text is
|
1353 | |
horizontally centered. A <replaceable>ypos</replaceable> value
|
1354 | |
<0 disables SMPTE OSD.</para>
|
1355 | |
</listitem>
|
1356 | |
</varlistentry>
|
1357 | |
|
1358 | |
<varlistentry>
|
1359 | |
<term><option>osd text <replaceable
|
1360 | |
class="option">text</replaceable></option></term>
|
1361 | |
<listitem>
|
1362 | |
<para>Render the specified text on the screen. The position can
|
1363 | |
be specified with the <command>osd pos</command> command.</para>
|
|
1576 |
specifies the vertical position in percent. The text is
|
|
1577 |
horizontally centered. A <replaceable>ypos</replaceable> value
|
|
1578 |
<0 disables SMPTE OSD.</para>
|
|
1579 |
</listitem>
|
|
1580 |
</varlistentry>
|
|
1581 |
|
|
1582 |
<varlistentry>
|
|
1583 |
<term><option>osd text <replaceable class="option">text</replaceable></option></term>
|
|
1584 |
|
|
1585 |
<listitem>
|
|
1586 |
<para>Render the specified text on the screen. The position can be
|
|
1587 |
specified with the <command>osd pos</command> command.</para>
|
1364 | 1588 |
</listitem>
|
1365 | 1589 |
</varlistentry>
|
1366 | 1590 |
|
1367 | 1591 |
<varlistentry>
|
1368 | 1592 |
<term><option>osd text </option></term>
|
|
1593 |
|
1369 | 1594 |
<listitem>
|
1370 | 1595 |
<para>Display the previously set OSD text again.</para>
|
1371 | 1596 |
</listitem>
|
|
1373 | 1598 |
|
1374 | 1599 |
<varlistentry>
|
1375 | 1600 |
<term><option>osd notext </option></term>
|
|
1601 |
|
1376 | 1602 |
<listitem>
|
1377 | 1603 |
<para>Turn off OSD text.</para>
|
1378 | 1604 |
</listitem>
|
|
1380 | 1606 |
|
1381 | 1607 |
<varlistentry>
|
1382 | 1608 |
<term><option>osd pos
|
1383 | |
<replaceable>xalign</replaceable><replaceable>ypos</replaceable>
|
|
1609 |
<replaceable>xalign</replaceable><replaceable>ypos</replaceable>
|
1384 | 1610 |
</option></term>
|
|
1611 |
|
1385 | 1612 |
<listitem>
|
1386 | 1613 |
<para>Set the position of the OSD text</para>
|
|
1614 |
|
1387 | 1615 |
<para><replaceable>xalign</replaceable> is an integer:
|
1388 | |
<literal>0</literal>:Left,
|
1389 | |
<literal>1</literal>:Center,
|
1390 | |
<literal>2</literal>:Right</para>
|
|
1616 |
<literal>0</literal>:Left, <literal>1</literal>:Center,
|
|
1617 |
<literal>2</literal>:Right</para>
|
|
1618 |
|
1391 | 1619 |
<para><replaceable>ypos</replaceable> specifies the vertical
|
1392 | |
position in percent (0..100).</para>
|
|
1620 |
position in percent (0..100).</para>
|
1393 | 1621 |
</listitem>
|
1394 | 1622 |
</varlistentry>
|
1395 | 1623 |
|
1396 | 1624 |
<varlistentry>
|
1397 | 1625 |
<term><option>osd available </option></term>
|
|
1626 |
|
1398 | 1627 |
<listitem>
|
1399 | 1628 |
<para>display if freetype support in available.</para>
|
1400 | 1629 |
</listitem>
|
|
1402 | 1631 |
|
1403 | 1632 |
<varlistentry>
|
1404 | 1633 |
<term><option>osd font
|
1405 | |
<replaceable>font-filename</replaceable></option></term>
|
|
1634 |
<replaceable>font-filename</replaceable></option></term>
|
|
1635 |
|
1406 | 1636 |
<listitem>
|
1407 | 1637 |
<para>Specify a TrueType Font file to be used when rendering
|
1408 | |
On-Screen-Display text.</para>
|
|
1638 |
On-Screen-Display text.</para>
|
1409 | 1639 |
</listitem>
|
1410 | 1640 |
</varlistentry>
|
1411 | 1641 |
|
1412 | 1642 |
<varlistentry>
|
1413 | 1643 |
<term><option>osd box </option></term>
|
|
1644 |
|
1414 | 1645 |
<listitem>
|
1415 | 1646 |
<para>draw a black box around the OSD</para>
|
1416 | 1647 |
</listitem>
|
|
1426 | 1657 |
|
1427 | 1658 |
<varlistentry>
|
1428 | 1659 |
<term><option>get osdcfg</option></term>
|
|
1660 |
|
1429 | 1661 |
<listitem>
|
1430 | 1662 |
<para>Return information on which text is currently rendered on
|
1431 | |
screen in a bitwise integer encoding:</para>
|
1432 | |
<para>
|
1433 | |
bit<literal>0</literal> (<literal>1</literal>): Frame,
|
1434 | |
|
1435 | |
bit<literal>1</literal> (<literal>2</literal>): SMPTE timecode,
|
1436 | |
|
1437 | |
bit<literal>2</literal> (<literal>4</literal>): Text,
|
1438 | |
|
1439 | |
bit<literal>3</literal> (<literal>8</literal>):
|
1440 | |
black-background-box</para>
|
|
1663 |
screen in a bitwise integer encoding:</para>
|
|
1664 |
|
|
1665 |
<para>bit<literal>0</literal> (<literal>1</literal>): Frame,
|
|
1666 |
bit<literal>1</literal> (<literal>2</literal>): SMPTE timecode,
|
|
1667 |
bit<literal>2</literal> (<literal>4</literal>): Text,
|
|
1668 |
bit<literal>3</literal> (<literal>8</literal>):
|
|
1669 |
black-background-box</para>
|
1441 | 1670 |
</listitem>
|
1442 | 1671 |
</varlistentry>
|
1443 | 1672 |
</variablelist>
|
|
1445 | 1674 |
|
1446 | 1675 |
<section id="response_format">
|
1447 | 1676 |
<title>Response Format</title>
|
|
1677 |
|
1448 | 1678 |
<para>Each remote command is acknowledged with a response, which you can
|
1449 | 1679 |
ignore at your option. It is intended to be both human readable and
|
1450 | 1680 |
machine parse-able. The response is a single line terminated with the
|
1451 | |
newline character
|
1452 | |
'\n' formatted as: <screen>@<status-integer> <text></screen>
|
|
1681 |
newline character '\n' formatted as: <screen>@<status-integer> <text></screen>
|
1453 | 1682 |
each line start with an @ followed by an integer that tells if the
|
1454 | 1683 |
command succeeded and specifies the format of the text. The status
|
1455 | |
integer is usually a 3 digit decimal number in [100..999]: </para>
|
|
1684 |
integer is usually a 3 digit decimal number in [100..999]:</para>
|
|
1685 |
|
1456 | 1686 |
<variablelist>
|
1457 | 1687 |
<varlistentry>
|
1458 | 1688 |
<term><option>1xx:</option></term>
|
|
1689 |
|
1459 | 1690 |
<listitem>
|
1460 | 1691 |
<para>OK. The command succeeded returning a small text info
|
1461 | |
message.</para>
|
|
1692 |
message.</para>
|
1462 | 1693 |
</listitem>
|
1463 | 1694 |
</varlistentry>
|
1464 | 1695 |
|
1465 | 1696 |
<varlistentry>
|
1466 | 1697 |
<term><option>2xx:</option></term>
|
|
1698 |
|
1467 | 1699 |
<listitem>
|
1468 | 1700 |
<para>the command succeeded and the return text is in format
|
1469 | |
<literal>name=value</literal></para>
|
|
1701 |
<literal>name=value</literal></para>
|
|
1702 |
|
1470 | 1703 |
<para>This is used for returning variables. 200-299 defines the
|
1471 | 1704 |
type of the value as follows:</para>
|
1472 | 1705 |
|
1473 | 1706 |
<variablelist>
|
1474 | 1707 |
<varlistentry>
|
1475 | 1708 |
<term><option>201:</option></term>
|
|
1709 |
|
1476 | 1710 |
<listitem>
|
1477 | 1711 |
<para>integer</para>
|
1478 | 1712 |
</listitem>
|
|
1480 | 1714 |
|
1481 | 1715 |
<varlistentry>
|
1482 | 1716 |
<term><option>202:</option></term>
|
|
1717 |
|
1483 | 1718 |
<listitem>
|
1484 | 1719 |
<para>double</para>
|
1485 | 1720 |
</listitem>
|
|
1487 | 1722 |
|
1488 | 1723 |
<varlistentry>
|
1489 | 1724 |
<term><option>210:</option></term>
|
|
1725 |
|
1490 | 1726 |
<listitem>
|
1491 | 1727 |
<para>Two dimensional vector <int>x<int></para>
|
1492 | 1728 |
</listitem>
|
|
1494 | 1730 |
|
1495 | 1731 |
<varlistentry>
|
1496 | 1732 |
<term><option>220:</option></term>
|
|
1733 |
|
1497 | 1734 |
<listitem>
|
1498 | 1735 |
<para>string</para>
|
1499 | 1736 |
</listitem>
|
|
1501 | 1738 |
|
1502 | 1739 |
<varlistentry>
|
1503 | 1740 |
<term><option>228:</option></term>
|
|
1741 |
|
1504 | 1742 |
<listitem>
|
1505 | 1743 |
<para>SMPTE-string in format 'HH:MM:SS:FF'</para>
|
1506 | 1744 |
</listitem>
|
|
1511 | 1749 |
|
1512 | 1750 |
<varlistentry>
|
1513 | 1751 |
<term><option>3xx:</option></term>
|
1514 | |
<listitem>
|
1515 | |
<para>These are messages that are generated by xjadeo notify,
|
1516 | |
not in response to a command. The format and type declaration is
|
|
1752 |
|
|
1753 |
<listitem>
|
|
1754 |
<para>These are messages that are generated by <application>Xjadeo</application> notify, not
|
|
1755 |
in response to a command. The format and type declaration is
|
1517 | 1756 |
identical to 2xx messages. Currently the only 3xx message is 301
|
1518 | 1757 |
position=integer.</para>
|
1519 | 1758 |
</listitem>
|
|
1521 | 1760 |
|
1522 | 1761 |
<varlistentry>
|
1523 | 1762 |
<term><option>4xx:</option></term>
|
|
1763 |
|
1524 | 1764 |
<listitem>
|
1525 | 1765 |
<para>Error message.</para>
|
1526 | 1766 |
</listitem>
|
|
1528 | 1768 |
|
1529 | 1769 |
<varlistentry>
|
1530 | 1770 |
<term><option>8xx:</option></term>
|
1531 | |
<listitem>
|
1532 | |
<para>Info or help message. These messages are meant to be
|
1533 | |
ignored by automatic parsers and are for user information or
|
1534 | |
displaying comments only.</para>
|
|
1771 |
|
|
1772 |
<listitem>
|
|
1773 |
<para>Info or help message. These messages are meant to be ignored
|
|
1774 |
by automatic parsers and are for user information or displaying
|
|
1775 |
comments only.</para>
|
1535 | 1776 |
</listitem>
|
1536 | 1777 |
</varlistentry>
|
1537 | 1778 |
</variablelist>
|
1538 | 1779 |
</section>
|
1539 | 1780 |
</section>
|
1540 | 1781 |
|
1541 | |
<!-- CHAPTER -->
|
|
1782 |
<!-- CHAPTER -->
|
1542 | 1783 |
|
1543 | 1784 |
<section id="open_sound_control_interface">
|
1544 | 1785 |
<title>Open Sound Control Interface</title>
|
1545 | |
<para>An alternative to the remote-control described in
|
1546 | |
<xref linkend="remote_control_interface"/> is to use <ulink
|
1547 | |
url="http://opensoundcontrol.org/">Opensoundcontrol</ulink>.
|
1548 | |
The drawback with OSC however is that there is no feedback. It is a
|
1549 | |
one-way method of communication. Furthermore OSC usually has more latency
|
1550 | |
compared to POSIX real-time messages, although it is quite possible to
|
1551 | |
play a video sending 'seek' commands. On the upside OSC offers a control
|
1552 | |
interface that works via Network. It is easy to use and ubiquitous.
|
1553 | |
There is support to transmit OSC messages for nearly every programming
|
1554 | |
language and even some hardware controllers - be it arduiuno, iPhone or
|
1555 | |
mixing-desks.
|
1556 | |
</para>
|
1557 | |
<para>To enable <application>xjadeo</application>'s OSC interface it needs
|
1558 | |
to be started with the <option>-O <replaceable>port</replaceable></option>
|
1559 | |
option where <replaceable>port</replaceable> is the UDP port number
|
1560 | |
<application>xjadeo</application> listens on for messages. e.g.
|
1561 | |
<screen>xjadeo -O 7890 myvideofile.mov</screen>
|
1562 | |
</para>
|
|
1786 |
|
|
1787 |
<para>An alternative to the remote-control described in <xref linkend="remote_control_interface"/> is to use <ulink url="http://opensoundcontrol.org/">Opensoundcontrol</ulink>. The drawback
|
|
1788 |
with OSC however is that there is no feedback. It is a one-way method of
|
|
1789 |
communication. Furthermore OSC usually has more latency compared to POSIX
|
|
1790 |
real-time messages, although it is quite possible to play a video sending
|
|
1791 |
'seek' commands. On the upside OSC offers a control interface that works
|
|
1792 |
via Network. It is easy to use and ubiquitous. There is support to
|
|
1793 |
transmit OSC messages for nearly every programming language and even some
|
|
1794 |
hardware controllers - be it arduiuno, iPhone or mixing-desks.</para>
|
|
1795 |
|
|
1796 |
<para>To enable <application>Xjadeo</application>'s OSC interface it needs
|
|
1797 |
to be started with the <option>-O <replaceable>port</replaceable></option>
|
|
1798 |
option where <replaceable>port</replaceable> is the UDP port number
|
|
1799 |
<application>Xjadeo</application> listens on for messages. e.g. <screen>xjadeo -O 7890 myvideofile.mov</screen></para>
|
|
1800 |
|
1563 | 1801 |
<table frame="all" tabstyle="tbl">
|
1564 | 1802 |
<title>OSC Commands</title>
|
1565 | |
<tgroup cols="3" align="left">
|
1566 | |
<colspec colname='c1' colwidth="*"/>
|
1567 | |
<colspec colname='c2' align="center" colwidth="*"/>
|
1568 | |
<colspec colname='c3' colwidth="*"/>
|
1569 | |
<spanspec spanname="fw" namest="c1" nameend="c3" align="center"/>
|
|
1803 |
|
|
1804 |
<tgroup align="left" cols="3">
|
|
1805 |
<colspec colname="c1"/>
|
|
1806 |
|
|
1807 |
<colspec align="center" colname="c2"/>
|
|
1808 |
|
|
1809 |
<colspec colname="c3" colwidth="*"/>
|
|
1810 |
|
|
1811 |
<spanspec align="center" nameend="c3" namest="c1" spanname="fw"/>
|
|
1812 |
|
1570 | 1813 |
<thead>
|
1571 | 1814 |
<row>
|
1572 | 1815 |
<entry>Address Pattern</entry>
|
|
1816 |
|
1573 | 1817 |
<entry>Type Tags</entry>
|
|
1818 |
|
1574 | 1819 |
<entry>Description - notes in brackes are corresponding remote-ctl
|
1575 | |
commanands or commandline-options</entry>
|
|
1820 |
commands or commandline-options</entry>
|
1576 | 1821 |
</row>
|
1577 | 1822 |
</thead>
|
|
1823 |
|
1578 | 1824 |
<tbody>
|
1579 | 1825 |
<row>
|
1580 | 1826 |
<entry><literal>/jadeo/seek</literal></entry>
|
|
1827 |
|
1581 | 1828 |
<entry><literal>i</literal></entry>
|
|
1829 |
|
1582 | 1830 |
<entry><para>seek to given frame-number (identical to
|
1583 | |
<literal>seek</literal> from <xref
|
1584 | |
linkend="sync_remote_commands"/>
|
1585 | |
- xjadeo needs to be disconnected from JACK and MTC
|
1586 | |
sync-sources)</para></entry>
|
|
1831 |
<literal>seek</literal> from <xref linkend="sync_remote_commands"/> - <application>Xjadeo</application> needs to be
|
|
1832 |
disconnected from JACK and MTC sync-sources)</para></entry>
|
1587 | 1833 |
</row>
|
|
1834 |
|
1588 | 1835 |
<row>
|
1589 | 1836 |
<entry><literal>/jadeo/load</literal></entry>
|
|
1837 |
|
1590 | 1838 |
<entry><literal>s</literal></entry>
|
|
1839 |
|
1591 | 1840 |
<entry><para>Load a video file, replacing any previous one.
|
1592 | |
(<literal>load filename</literal>)</para></entry>
|
|
1841 |
(<literal>load filename</literal>)</para></entry>
|
1593 | 1842 |
</row>
|
|
1843 |
|
1594 | 1844 |
<row>
|
1595 | 1845 |
<entry><literal>/jadeo/fps</literal></entry>
|
|
1846 |
|
1596 | 1847 |
<entry><literal>f</literal></entry>
|
|
1848 |
|
1597 | 1849 |
<entry><para>set the screen update frequency (<option>-f</option>,
|
1598 | |
<literal>set fps</literal>)</para></entry>
|
|
1850 |
<literal>set fps</literal>)</para></entry>
|
1599 | 1851 |
</row>
|
|
1852 |
|
1600 | 1853 |
<row>
|
1601 | 1854 |
<entry><literal>/jadeo/framerate</literal></entry>
|
|
1855 |
|
1602 | 1856 |
<entry><literal>f</literal></entry>
|
|
1857 |
|
1603 | 1858 |
<entry><para>override video-files frame-rate (<option>-F</option>,
|
1604 | |
<literal>set framerate</literal>)</para></entry>
|
|
1859 |
<literal>set framerate</literal>)</para></entry>
|
1605 | 1860 |
</row>
|
|
1861 |
|
1606 | 1862 |
<row>
|
1607 | 1863 |
<entry><literal>/jadeo/offset</literal></entry>
|
|
1864 |
|
1608 | 1865 |
<entry><literal>i</literal></entry>
|
|
1866 |
|
1609 | 1867 |
<entry><para>set time-offset as frame-number (<option>-o</option>,
|
1610 | |
<literal>set offset</literal></para></entry>
|
|
1868 |
<literal>set offset</literal></para></entry>
|
1611 | 1869 |
</row>
|
|
1870 |
|
1612 | 1871 |
<row>
|
1613 | 1872 |
<entry><literal>/jadeo/offset</literal></entry>
|
|
1873 |
|
1614 | 1874 |
<entry><literal>s</literal></entry>
|
1615 | |
<entry><para>set time offset as SMPTE
|
1616 | |
(<literal>set offset</literal></para></entry>
|
|
1875 |
|
|
1876 |
<entry><para>set time offset as SMPTE (<literal>set
|
|
1877 |
offset</literal></para></entry>
|
1617 | 1878 |
</row>
|
|
1879 |
|
1618 | 1880 |
<row>
|
1619 | 1881 |
<entry><literal>/jadeo/jack/connect</literal></entry>
|
1620 | |
<entry><literal></literal></entry>
|
|
1882 |
|
|
1883 |
<entry><literal/></entry>
|
|
1884 |
|
1621 | 1885 |
<entry><para>Connect to JACK and sync to JACK-transport
|
1622 | |
(<literal>jack connect</literal>)</para></entry>
|
|
1886 |
(<literal>jack connect</literal>)</para></entry>
|
1623 | 1887 |
</row>
|
|
1888 |
|
1624 | 1889 |
<row>
|
1625 | 1890 |
<entry><literal>/jadeo/jack/disconnect</literal></entry>
|
1626 | |
<entry><literal></literal></entry>
|
|
1891 |
|
|
1892 |
<entry><literal/></entry>
|
|
1893 |
|
1627 | 1894 |
<entry><para>Stop synchronization with JACK-transport
|
1628 | |
(<literal>jack disconnect</literal>)</para></entry>
|
|
1895 |
(<literal>jack disconnect</literal>)</para></entry>
|
1629 | 1896 |
</row>
|
|
1897 |
|
1630 | 1898 |
<row>
|
1631 | 1899 |
<entry><literal>/jadeo/osd/font</literal></entry>
|
|
1900 |
|
1632 | 1901 |
<entry><literal>s</literal></entry>
|
1633 | |
<entry><para>Specify a TrueType Font file to be used when rendering
|
1634 | |
On-Screen-Display text
|
1635 | |
(<literal>osd font</literal>)</para></entry>
|
|
1902 |
|
|
1903 |
<entry><para>Specify a TrueType Font file to be used when
|
|
1904 |
rendering On-Screen-Display text (<literal>osd
|
|
1905 |
font</literal>)</para></entry>
|
1636 | 1906 |
</row>
|
|
1907 |
|
1637 | 1908 |
<row>
|
1638 | 1909 |
<entry><literal>/jadeo/osd/smtpe</literal></entry>
|
|
1910 |
|
1639 | 1911 |
<entry><literal>i</literal></entry>
|
|
1912 |
|
1640 | 1913 |
<entry><para>if set to <literal>1</literal>: render SMPTE on
|
1641 | |
screen, set to <literal>0</literal> to disable
|
1642 | |
(<option>-i 2</option>, <literal>osd smpte</literal>)</para>
|
1643 | |
</entry>
|
|
1914 |
screen, set to <literal>0</literal> to disable (<option>-i
|
|
1915 |
2</option>, <literal>osd smpte</literal>)</para></entry>
|
1644 | 1916 |
</row>
|
|
1917 |
|
1645 | 1918 |
<row>
|
1646 | 1919 |
<entry><literal>/jadeo/osd/frame</literal></entry>
|
|
1920 |
|
1647 | 1921 |
<entry><literal>i</literal></entry>
|
1648 | |
<entry><para>if set to <literal>1</literal>: render frame-number on
|
1649 | |
screen, set to <literal>0</literal> to disable
|
1650 | |
(<option>-i 1</option>, <literal>osd frame</literal>)</para>
|
1651 | |
</entry>
|
|
1922 |
|
|
1923 |
<entry><para>if set to <literal>1</literal>: render frame-number
|
|
1924 |
on screen, set to <literal>0</literal> to disable (<option>-i
|
|
1925 |
1</option>, <literal>osd frame</literal>)</para></entry>
|
1652 | 1926 |
</row>
|
|
1927 |
|
1653 | 1928 |
<row>
|
1654 | 1929 |
<entry><literal>/jadeo/osd/box</literal></entry>
|
|
1930 |
|
1655 | 1931 |
<entry><literal>i</literal></entry>
|
|
1932 |
|
1656 | 1933 |
<entry><para>if set to <literal>1</literal>: draw frame-number on
|
1657 | |
screen, set to <literal>0</literal> to disable
|
1658 | |
(<literal>osd box</literal>, <literal>osd nobox</literal>)
|
1659 | |
</para></entry>
|
|
1934 |
screen, set to <literal>0</literal> to disable (<literal>osd
|
|
1935 |
box</literal>, <literal>osd nobox</literal>) </para></entry>
|
1660 | 1936 |
</row>
|
|
1937 |
|
1661 | 1938 |
<row>
|
1662 | 1939 |
<entry><literal>/jadeo/quit</literal></entry>
|
1663 | |
<entry><literal></literal></entry>
|
1664 | |
<entry><para>terminate xjadeo.</para></entry>
|
|
1940 |
|
|
1941 |
<entry><literal/></entry>
|
|
1942 |
|
|
1943 |
<entry><para>terminate <application>Xjadeo</application>.</para></entry>
|
1665 | 1944 |
</row>
|
1666 | 1945 |
|
1667 | 1946 |
<row>
|
1668 | 1947 |
<entry spanname="fw">The following commands are only available if
|
1669 | |
MIDI is supported.</entry>
|
|
1948 |
MIDI is supported.</entry>
|
1670 | 1949 |
</row>
|
|
1950 |
|
1671 | 1951 |
<row>
|
1672 | 1952 |
<entry><literal>/jadeo/midi/connect</literal></entry>
|
|
1953 |
|
1673 | 1954 |
<entry><literal>s</literal></entry>
|
|
1955 |
|
1674 | 1956 |
<entry><para>Get sync from MTC (MIDI Time Code) instead of JACK.
|
1675 | |
The parameter specifies the midi-port to connect to. see <xref
|
1676 | |
linkend="rc_midi"/> for the format. (<option>-m</option>,
|
1677 | |
<option>-d</option>, <literal>midi connect</literal>)</para>
|
1678 | |
</entry>
|
|
1957 |
The parameter specifies the midi-port to connect to. see <xref linkend="rc_midi"/> for the format. (<option>-m</option>,
|
|
1958 |
<option>-d</option>, <literal>midi
|
|
1959 |
connect</literal>)</para></entry>
|
1679 | 1960 |
</row>
|
|
1961 |
|
1680 | 1962 |
<row>
|
1681 | 1963 |
<entry><literal>/jadeo/midi/disconnect</literal></entry>
|
1682 | |
<entry><literal></literal></entry>
|
1683 | |
<entry><para>Close the MIDI device
|
1684 | |
(<literal>midi disconnect</literal>)</para></entry>
|
|
1964 |
|
|
1965 |
<entry><literal/></entry>
|
|
1966 |
|
|
1967 |
<entry><para>Close the MIDI device (<literal>midi
|
|
1968 |
disconnect</literal>)</para></entry>
|
1685 | 1969 |
</row>
|
|
1970 |
|
1686 | 1971 |
<row>
|
1687 | 1972 |
<entry><literal>/jadeo/midi/quarterframes</literal></entry>
|
|
1973 |
|
1688 | 1974 |
<entry><literal>i</literal></entry>
|
|
1975 |
|
1689 | 1976 |
<entry><para><literal>1, 0</literal> en/disable sync to MTC quater
|
1690 | |
frames (<option>-c</option>, <literal>midi clk</literal>)</para>
|
1691 | |
</entry>
|
|
1977 |
frames (<option>-c</option>, <literal>midi
|
|
1978 |
clk</literal>)</para></entry>
|
1692 | 1979 |
</row>
|
|
1980 |
|
1693 | 1981 |
<row>
|
1694 | 1982 |
<entry><literal>/jadeo/midi/clkconvert</literal></entry>
|
|
1983 |
|
1695 | 1984 |
<entry><literal>i</literal></entry>
|
|
1985 |
|
1696 | 1986 |
<entry><para>specify how to 'convert' MTC SMPTE to framenumber:
|
1697 | |
<literal>0</literal>: use framerate of MTC clock (default);
|
1698 | |
<literal>2</literal>: use video file FPS;
|
1699 | |
<literal>3</literal>: "resample": videoFPS / MTC
|
1700 | |
(<option>-M</option>,<literal>midi sync</literal>)</para>
|
1701 | |
</entry>
|
|
1987 |
<literal>0</literal>: use framerate of MTC clock (default);
|
|
1988 |
<literal>2</literal>: use video file FPS; <literal>3</literal>:
|
|
1989 |
"resample": videoFPS / MTC (<option>-M</option>,<literal>midi
|
|
1990 |
sync</literal>)</para></entry>
|
1702 | 1991 |
</row>
|
1703 | 1992 |
|
1704 | 1993 |
<row>
|
1705 | 1994 |
<entry spanname="fw">The following command is only available if
|
1706 | |
"panorama mode" is enabled.
|
1707 | |
see <xref linkend="advanced_features"/></entry>
|
|
1995 |
"panorama mode" is enabled. see <xref linkend="advanced_features"/></entry>
|
1708 | 1996 |
</row>
|
|
1997 |
|
1709 | 1998 |
<row>
|
1710 | 1999 |
<entry><literal>/jadeo/pan</literal></entry>
|
|
2000 |
|
1711 | 2001 |
<entry><literal>i</literal></entry>
|
1712 | |
<entry><para>set the x-offset to the value given in pixels.
|
1713 | |
0 ≤ <replaceable>val</replaceable> ≤
|
1714 | |
<literal>movie-width</literal></para></entry>
|
|
2002 |
|
|
2003 |
<entry><para>set the x-offset to the value given in pixels. 0 ≤
|
|
2004 |
<replaceable>val</replaceable> ≤
|
|
2005 |
<literal>movie-width</literal></para></entry>
|
1715 | 2006 |
</row>
|
1716 | 2007 |
|
1717 | 2008 |
<row>
|
1718 | 2009 |
<entry spanname="fw">The following commands are only available if
|
1719 | |
"timescale mode" is enabled.
|
1720 | |
see <xref linkend="advanced_features"/></entry>
|
|
2010 |
"timescale mode" is enabled. see <xref linkend="advanced_features"/></entry>
|
1721 | 2011 |
</row>
|
|
2012 |
|
1722 | 2013 |
<row>
|
1723 | 2014 |
<entry><literal>/jadeo/timescale</literal></entry>
|
|
2015 |
|
1724 | 2016 |
<entry><literal>f</literal></entry>
|
1725 | |
<entry><para>set time-multiplier;
|
1726 | |
default value: <literal>1.0</literal></para></entry>
|
|
2017 |
|
|
2018 |
<entry><para>set time-multiplier; default value:
|
|
2019 |
<literal>1.0</literal></para></entry>
|
1727 | 2020 |
</row>
|
|
2021 |
|
1728 | 2022 |
<row>
|
1729 | 2023 |
<entry><literal>/jadeo/timescale</literal></entry>
|
|
2024 |
|
1730 | 2025 |
<entry><literal>fi</literal></entry>
|
1731 | |
<entry><para>set both time-multiplier and offset.
|
1732 | |
default: <literal>1.0, 0</literal></para></entry>
|
|
2026 |
|
|
2027 |
<entry><para>set both time-multiplier and offset. default:
|
|
2028 |
<literal>1.0, 0</literal></para></entry>
|
1733 | 2029 |
</row>
|
|
2030 |
|
1734 | 2031 |
<row>
|
1735 | 2032 |
<entry><literal>/jadeo/loop</literal></entry>
|
|
2033 |
|
1736 | 2034 |
<entry><literal>i</literal></entry>
|
|
2035 |
|
1737 | 2036 |
<entry><para>wrap-around/loop video. If set to<literal>1</literal>
|
1738 | |
(multiples) of the movie-length are added/subtracted if the
|
1739 | |
current time-stamp is less/above the movie-duration.</para>
|
1740 | |
</entry>
|
|
2037 |
(multiples) of the movie-length are added/subtracted if the
|
|
2038 |
current time-stamp is less/above the
|
|
2039 |
movie-duration.</para></entry>
|
1741 | 2040 |
</row>
|
|
2041 |
|
1742 | 2042 |
<row>
|
1743 | 2043 |
<entry><literal>/jadeo/reverse</literal></entry>
|
1744 | |
<entry><literal></literal></entry>
|
|
2044 |
|
|
2045 |
<entry><literal/></entry>
|
|
2046 |
|
1745 | 2047 |
<entry><para>multiplies the current time-scale with
|
1746 | |
<literal>-1.0</literal> and sets a time-offset so that the
|
1747 | |
currently displayed frame is retained.</para></entry>
|
|
2048 |
<literal>-1.0</literal> and sets a time-offset so that the
|
|
2049 |
currently displayed frame is retained.</para></entry>
|
1748 | 2050 |
</row>
|
1749 | |
|
1750 | 2051 |
</tbody>
|
1751 | 2052 |
</tgroup>
|
1752 | 2053 |
</table>
|
1753 | 2054 |
</section>
|
1754 | 2055 |
|
1755 | |
|
1756 | |
<!-- CHAPTER -->
|
|
2056 |
<!-- CHAPTER -->
|
1757 | 2057 |
|
1758 | 2058 |
<section id="advanced_features">
|
1759 | 2059 |
<title>Advanced Features - Artistic add-ons</title>
|
1760 | |
<para><application>xjadeo</application>'s core functionality - to display
|
1761 | |
a given video frame at a certain point in time - is not only useful
|
1762 | |
for post-production but has applications in media-art installations.
|
1763 | |
</para>
|
|
2060 |
|
|
2061 |
<para><application>Xjadeo</application>'s core functionality - to display
|
|
2062 |
a given video frame at a certain point in time - is not only useful for
|
|
2063 |
post-production but has applications in media-art installations.</para>
|
|
2064 |
|
1764 | 2065 |
<para>There are two major features which are not enabled by default:
|
1765 | |
<itemizedlist>
|
1766 | |
<listitem><para>time-scale: operations to modify the time-code: multiply
|
1767 | |
(slow-down/speed-up), offset and wrap-around/loop.</para></listitem>
|
1768 | |
<listitem><para>Panorama/frame-cropping: allows to display a
|
1769 | |
sub-section of the image.</para></listitem>
|
1770 | |
</itemizedlist>
|
1771 | |
</para>
|
|
2066 |
<itemizedlist>
|
|
2067 |
<listitem>
|
|
2068 |
<para>time-scale: operations to modify the time-code: multiply
|
|
2069 |
(slow-down/speed-up), offset and wrap-around/loop.</para>
|
|
2070 |
</listitem>
|
|
2071 |
|
|
2072 |
<listitem>
|
|
2073 |
<para>Panorama/frame-cropping: allows to display a sub-section of
|
|
2074 |
the image.</para>
|
|
2075 |
</listitem>
|
|
2076 |
</itemizedlist></para>
|
|
2077 |
|
1772 | 2078 |
<section>
|
1773 | 2079 |
<title>Time-scaling</title>
|
1774 | |
<para>
|
1775 | |
Time-scaling adds three additional parameters to modify the displayed
|
1776 | |
frame. They are applied in the following order:
|
1777 | |
<orderedlist>
|
1778 | |
<listitem><para> scale - multiply frame-number (default: 1.0)
|
1779 | |
</para></listitem>
|
1780 | |
<listitem><para> offset - add integer to frame-number (default: 0)
|
1781 | |
</para></listitem>
|
1782 | |
<listitem><para> wraparound - add/subtract (multiples) of
|
1783 | |
movie-length if the current time-stamp is less/above the
|
1784 | |
movie-duration (default: off)</para></listitem>
|
1785 | |
</orderedlist>
|
1786 | |
These parameters can be set via the remote-control described in
|
1787 | |
<xref linkend="remote_control_interface"/> or by as OSC documented at
|
1788 | |
<xref linkend="open_sound_control_interface"/>.
|
1789 | |
</para>
|
|
2080 |
|
|
2081 |
<para>Time-scaling adds three additional parameters to modify the
|
|
2082 |
displayed frame. They are applied in the following order: <orderedlist>
|
|
2083 |
<listitem>
|
|
2084 |
<para>scale - multiply frame-number (default: 1.0)</para>
|
|
2085 |
</listitem>
|
|
2086 |
|
|
2087 |
<listitem>
|
|
2088 |
<para>offset - add integer to frame-number (default: 0)</para>
|
|
2089 |
</listitem>
|
|
2090 |
|
|
2091 |
<listitem>
|
|
2092 |
<para>wraparound - add/subtract (multiples) of movie-length if the
|
|
2093 |
current time-stamp is less/above the movie-duration (default:
|
|
2094 |
off)</para>
|
|
2095 |
</listitem>
|
|
2096 |
</orderedlist> These parameters can be set via the remote-control
|
|
2097 |
described in <xref linkend="remote_control_interface"/> or by as OSC
|
|
2098 |
documented at <xref linkend="open_sound_control_interface"/>.</para>
|
1790 | 2099 |
</section>
|
|
2100 |
|
1791 | 2101 |
<section>
|
1792 | 2102 |
<title>Cave/Panorama mode</title>
|
|
2103 |
|
1793 | 2104 |
<para>The Panorama mode needs be enabled at compile-time using
|
1794 | |
<command>./configure --enable-framecrop</command>.
|
1795 | |
when enabled during compilation <application>xjadeo</application> will
|
1796 | |
crop the image width to 50%.
|
1797 | |
The x-offset can be modified with the keyboard
|
1798 | |
<keycap>[</keycap>, <keycap>]</keycap> or OSC commands - see
|
1799 | |
<xref linkend="open_sound_control_interface"/>.
|
1800 | |
</para>
|
1801 | |
<para>
|
1802 | |
It is intended to be used with two neighboring movies stitched together:
|
1803 | |
<screen>
|
|
2105 |
<command>./configure --enable-framecrop</command>. when enabled during
|
|
2106 |
compilation <application>Xjadeo</application> will crop the image width
|
|
2107 |
to 50%. The x-offset can be modified with the keyboard
|
|
2108 |
<keycap>[</keycap>, <keycap>]</keycap> or OSC commands - see <xref linkend="open_sound_control_interface"/>.</para>
|
|
2109 |
|
|
2110 |
<para>It is intended to be used with two neighboring movies stitched
|
|
2111 |
together: <screen>
|
1804 | 2112 |
A B C D
|
1805 | 2113 |
AB BC CD DA
|
1806 | |
</screen>
|
1807 | |
To panning across boundaries, the files have to be re-loaded
|
1808 | |
(using OSC or remote-control).
|
1809 | |
</para>
|
|
2114 |
</screen> To panning across boundaries, the files have to be re-loaded
|
|
2115 |
(using OSC or remote-control).</para>
|
1810 | 2116 |
</section>
|
|
2117 |
|
1811 | 2118 |
<section>
|
1812 | 2119 |
<title>Action Override</title>
|
|
2120 |
|
1813 | 2121 |
<para>using the <command>set override</command> remote-control command,
|
1814 | |
it is possible to disable certain key-bindings or window-events.
|
1815 | |
and limit user interation with the window.
|
1816 | |
</para>
|
|
2122 |
it is possible to disable certain key-bindings or window-events. and
|
|
2123 |
limit user interaction with the window.</para>
|
|
2124 |
|
1817 | 2125 |
<table frame="all" tabstyle="tbl">
|
1818 | 2126 |
<title>Interaction Override</title>
|
1819 | |
<tgroup cols="3" align="left">
|
1820 | |
<colspec colname='c1' align="center" colwidth="*"/>
|
1821 | |
<colspec colname='c2' align="center" colwidth="*"/>
|
1822 | |
<colspec colname='c3' colwidth="*"/>
|
|
2127 |
|
|
2128 |
<tgroup align="left" cols="3">
|
|
2129 |
<colspec align="center" colname="c1"/>
|
|
2130 |
|
|
2131 |
<colspec align="center" colname="c2"/>
|
|
2132 |
|
|
2133 |
<colspec colname="c3" colwidth="*"/>
|
|
2134 |
|
1823 | 2135 |
<thead>
|
1824 | 2136 |
<row>
|
1825 | 2137 |
<entry>Bit</entry>
|
|
2138 |
|
1826 | 2139 |
<entry>Value</entry>
|
|
2140 |
|
1827 | 2141 |
<entry>Description</entry>
|
1828 | 2142 |
</row>
|
1829 | 2143 |
</thead>
|
|
2144 |
|
1830 | 2145 |
<tbody>
|
1831 | 2146 |
<row>
|
1832 | 2147 |
<entry><literal>0</literal></entry>
|
|
2148 |
|
1833 | 2149 |
<entry><literal>1</literal></entry>
|
1834 | |
<entry><para>ignore <keycap>Esc</keycap> and <keycap>Q</keycap></para></entry>
|
|
2150 |
|
|
2151 |
<entry><para>ignore <keycap>Esc</keycap> and
|
|
2152 |
<keycap>Q</keycap></para></entry>
|
1835 | 2153 |
</row>
|
|
2154 |
|
1836 | 2155 |
<row>
|
1837 | 2156 |
<entry><literal>1</literal></entry>
|
|
2157 |
|
1838 | 2158 |
<entry><literal>2</literal></entry>
|
|
2159 |
|
1839 | 2160 |
<entry><para>ignore window-close event</para></entry>
|
1840 | 2161 |
</row>
|
|
2162 |
|
1841 | 2163 |
<row>
|
1842 | 2164 |
<entry><literal>2</literal></entry>
|
|
2165 |
|
1843 | 2166 |
<entry><literal>4</literal></entry>
|
1844 | |
<entry><para>ignore <mousebutton>Button1</mousebutton>
|
1845 | |
- do not resize the window.
|
1846 | |
</para></entry>
|
|
2167 |
|
|
2168 |
<entry><para>ignore <mousebutton>Button1</mousebutton> - do not
|
|
2169 |
resize the window. </para></entry>
|
1847 | 2170 |
</row>
|
|
2171 |
|
1848 | 2172 |
<row>
|
1849 | 2173 |
<entry><literal>3</literal></entry>
|
|
2174 |
|
1850 | 2175 |
<entry><literal>8</literal></entry>
|
1851 | |
<entry><para>(OSX only) ignore
|
1852 | |
<menuchoice>
|
1853 | |
<guimenu>Jadeo</guimenu>
|
1854 | |
<guimenuitem>Quit Jadeo</guimenuitem>
|
1855 | |
</menuchoice>
|
1856 | |
</para></entry>
|
|
2176 |
|
|
2177 |
<entry><para>(OSX only) ignore <menuchoice>
|
|
2178 |
<guimenu>Jadeo</guimenu>
|
|
2179 |
|
|
2180 |
<guimenuitem>Quit Jadeo</guimenuitem>
|
|
2181 |
</menuchoice> </para></entry>
|
1857 | 2182 |
</row>
|
|
2183 |
|
1858 | 2184 |
<row>
|
1859 | 2185 |
<entry><literal>4</literal></entry>
|
|
2186 |
|
1860 | 2187 |
<entry><literal>16</literal></entry>
|
|
2188 |
|
1861 | 2189 |
<entry><para>Ignore time-offset keyboard-shortcuts (
|
1862 | |
<keycap>-</keycap>,
|
1863 | |
<keycap>+</keycap>,
|
1864 | |
<keycap>{</keycap>,
|
1865 | |
<keycap>}</keycap>
|
1866 | |
)</para></entry>
|
|
2190 |
<keycap>-</keycap>, <keycap>+</keycap>, <keycap>{</keycap>,
|
|
2191 |
<keycap>}</keycap> )</para></entry>
|
1867 | 2192 |
</row>
|
1868 | 2193 |
</tbody>
|
1869 | 2194 |
</tgroup>
|
|
1871 | 2196 |
</section>
|
1872 | 2197 |
</section>
|
1873 | 2198 |
|
1874 | |
<!-- MAN PAGES -->
|
|
2199 |
<!-- MAN PAGES -->
|
1875 | 2200 |
|
1876 | 2201 |
<appendix id="manual_pages">
|
1877 | 2202 |
<title>Manual Pages</title>
|
1878 | 2203 |
|
1879 | 2204 |
<refentry id="xjadeo">
|
1880 | |
<refmeta>
|
|
2205 |
<refmeta>
|
1881 | 2206 |
<refentrytitle>xjadeo</refentrytitle>
|
|
2207 |
|
1882 | 2208 |
<manvolnum>1</manvolnum>
|
|
2209 |
|
1883 | 2210 |
<refmiscinfo class="source">http://xjadeo.sf.net</refmiscinfo>
|
|
2211 |
|
1884 | 2212 |
<refmiscinfo class="version">0.6.X</refmiscinfo>
|
1885 | |
<!--
|
1886 | |
-->
|
1887 | |
</refmeta>
|
1888 | |
|
1889 | |
<refnamediv>
|
|
2213 |
|
|
2214 |
</refmeta>
|
|
2215 |
|
|
2216 |
<refnamediv>
|
1890 | 2217 |
<refname>xjadeo</refname>
|
1891 | 2218 |
|
1892 | |
<refpurpose>display a video-clip in sync with an external time source</refpurpose>
|
|
2219 |
<refpurpose>display a video-clip in sync with an external time
|
|
2220 |
source</refpurpose>
|
1893 | 2221 |
</refnamediv>
|
1894 | 2222 |
|
1895 | 2223 |
<refsynopsisdiv>
|
1896 | 2224 |
<cmdsynopsis>
|
1897 | 2225 |
<command>xjadeo</command>
|
|
2226 |
|
1898 | 2227 |
<arg choice="opt">-aAbcCDhIkKlLnNPqQRsStvV</arg>
|
|
2228 |
|
1899 | 2229 |
<arg choice="opt">-d <replaceable>midi-driver</replaceable></arg>
|
|
2230 |
|
1900 | 2231 |
<arg choice="opt">-f <replaceable>fps</replaceable></arg>
|
|
2232 |
|
1901 | 2233 |
<arg choice="opt">-F <replaceable>fps</replaceable></arg>
|
|
2234 |
|
1902 | 2235 |
<arg choice="opt">-i <replaceable>int</replaceable></arg>
|
|
2236 |
|
1903 | 2237 |
<arg choice="opt">-m <replaceable>midi-port</replaceable></arg>
|
|
2238 |
|
1904 | 2239 |
<arg choice="opt">-M <replaceable>num</replaceable></arg>
|
|
2240 |
|
1905 | 2241 |
<arg choice="opt">-o <replaceable>frames|SMPTE</replaceable></arg>
|
|
2242 |
|
1906 | 2243 |
<arg choice="opt">-O <replaceable>osc-port</replaceable></arg>
|
|
2244 |
|
1907 | 2245 |
<arg choice="opt">-W <replaceable>rpc-id</replaceable></arg>
|
|
2246 |
|
1908 | 2247 |
<arg choice="opt">-x <replaceable>dpy-mode</replaceable></arg>
|
|
2248 |
|
1909 | 2249 |
<arg choice="plain"><replaceable>videofile</replaceable></arg>
|
1910 | 2250 |
</cmdsynopsis>
|
|
2251 |
|
1911 | 2252 |
<cmdsynopsis>
|
1912 | 2253 |
<command>xjadeo</command>
|
|
2254 |
|
1913 | 2255 |
<arg choice="plain">-R</arg>
|
|
2256 |
|
1914 | 2257 |
<arg choice="opt">options</arg>
|
|
2258 |
|
1915 | 2259 |
<arg choice="opt"><replaceable>videofile</replaceable></arg>
|
1916 | 2260 |
</cmdsynopsis>
|
|
2261 |
|
1917 | 2262 |
<cmdsynopsis>
|
1918 | 2263 |
<command>xjadeo</command>
|
|
2264 |
|
1919 | 2265 |
<arg choice="plain">-Q</arg>
|
|
2266 |
|
1920 | 2267 |
<arg choice="opt">options</arg>
|
|
2268 |
|
1921 | 2269 |
<arg choice="opt"><replaceable>videofile</replaceable></arg>
|
1922 | 2270 |
</cmdsynopsis>
|
1923 | 2271 |
</refsynopsisdiv>
|
|
1925 | 2273 |
<refsect1>
|
1926 | 2274 |
<title>DESCRIPTION</title>
|
1927 | 2275 |
|
1928 | |
<para><application>xjadeo</application> is a software video player
|
1929 | |
that displays a video-clip in sync with an external time source
|
1930 | |
(MTC, LTC, JACK-transport).</para>
|
|
2276 |
<para><application>Xjadeo</application> is a software video player
|
|
2277 |
that displays a video-clip in sync with an external time source (MTC,
|
|
2278 |
LTC, JACK-transport).</para>
|
1931 | 2279 |
|
1932 | 2280 |
<para>It has applications in soundtrack composition, video monitoring
|
1933 | |
or any task that requires to associate movie frames with audio events.
|
1934 | |
</para>
|
1935 | |
|
1936 | |
<para><application>xjadeo</application> supports different video file
|
1937 | |
formats, video output libraries and sync sources.</para>
|
|
2281 |
or any task that requires synchronizing movie frames with audio
|
|
2282 |
events.</para>
|
|
2283 |
|
|
2284 |
<para><application>Xjadeo</application> supports different video file
|
|
2285 |
formats, video output libraries and sync sources.</para>
|
1938 | 2286 |
</refsect1>
|
1939 | 2287 |
|
1940 | 2288 |
<refsect1 id="commandline_options" xreflabel="command-line options">
|
1941 | 2289 |
<title>OPTIONS</title>
|
|
2290 |
|
1942 | 2291 |
<variablelist>
|
1943 | |
|
1944 | |
<varlistentry>
|
1945 | |
<term><option>-a</option>,
|
1946 | |
<option>--ontop</option></term>
|
1947 | |
<listitem>
|
1948 | |
<para>Start xjadeo always-on-top of other windows (this option
|
1949 | |
requires support from window-manager).</para>
|
1950 | |
</listitem>
|
1951 | |
</varlistentry>
|
1952 | |
|
1953 | |
<varlistentry>
|
1954 | |
<term><option>-A</option>,
|
1955 | |
<option>--avverbose</option></term>
|
1956 | |
<listitem>
|
1957 | |
<para>Enable verbose ffmpeg messages (format/codec debugging).
|
1958 | |
</para>
|
1959 | |
</listitem>
|
1960 | |
</varlistentry>
|
1961 | |
|
1962 | |
<varlistentry>
|
1963 | |
<term><option>-b</option>,
|
1964 | |
<option>--letterbox</option></term>
|
|
2292 |
<varlistentry>
|
|
2293 |
<term><option>-a</option>, <option>--ontop</option></term>
|
|
2294 |
|
|
2295 |
<listitem>
|
|
2296 |
<para>Start <application>Xjadeo</application> 'always-on-top' of other windows (this option
|
|
2297 |
requires support from your window manager).</para>
|
|
2298 |
</listitem>
|
|
2299 |
</varlistentry>
|
|
2300 |
|
|
2301 |
<varlistentry>
|
|
2302 |
<term><option>-A</option>, <option>--avverbose</option></term>
|
|
2303 |
|
|
2304 |
<listitem>
|
|
2305 |
<para>Enable verbose ffmpeg messages (format/codec
|
|
2306 |
debugging).</para>
|
|
2307 |
</listitem>
|
|
2308 |
</varlistentry>
|
|
2309 |
|
|
2310 |
<varlistentry>
|
|
2311 |
<term><option>-b</option>, <option>--letterbox</option></term>
|
|
2312 |
|
1965 | 2313 |
<listitem>
|
1966 | 2314 |
<para>Retain aspect ratio and draw a letterbox around the
|
1967 | |
video-frame if necessary.</para>
|
1968 | |
</listitem>
|
1969 | |
</varlistentry>
|
1970 | |
|
1971 | |
<varlistentry>
|
1972 | |
<term><option>-c</option>,
|
1973 | |
<option>--no-midiclk</option></term>
|
|
2315 |
video-frame if necessary.</para>
|
|
2316 |
</listitem>
|
|
2317 |
</varlistentry>
|
|
2318 |
|
|
2319 |
<varlistentry>
|
|
2320 |
<term><option>-c</option>, <option>--no-midiclk</option></term>
|
|
2321 |
|
1974 | 2322 |
<listitem>
|
1975 | 2323 |
<para>Do not use MIDI quarter-frames for more exact sync.</para>
|
1976 | 2324 |
</listitem>
|
1977 | 2325 |
</varlistentry>
|
1978 | 2326 |
|
1979 | 2327 |
<varlistentry>
|
1980 | |
<term><option>-C, --midiclk</option>,
|
1981 | |
<option>--midiclk</option></term>
|
|
2328 |
<term><option>-c</option>, <option>--midiclk</option></term>
|
|
2329 |
|
1982 | 2330 |
<listitem>
|
1983 | 2331 |
<para>Use MIDI quarter-frame timing for more exact sync (this is
|
1984 | |
enabled by default since version 0.4.11).</para>
|
|
2332 |
enabled by default since version 0.4.11).</para>
|
1985 | 2333 |
</listitem>
|
1986 | 2334 |
</varlistentry>
|
1987 | 2335 |
|
1988 | 2336 |
<varlistentry>
|
1989 | 2337 |
<term><option>-d <replaceable>midi-driver</replaceable></option>,
|
1990 | |
<option>--midi-driver <replaceable>midi-driver</replaceable>
|
|
2338 |
<option>--midi-driver <replaceable>midi-driver</replaceable>
|
1991 | 2339 |
</option></term>
|
1992 | |
<listitem>
|
1993 | |
<para>Choose MIDI back-end to use.
|
1994 | |
<replaceable>midi-driver</replaceable> can be either one of
|
1995 | |
"JACK", "ALSA" or "portmidi" - depending on the
|
1996 | |
operating-System and compile-time configuration.</para>
|
1997 | |
</listitem>
|
1998 | |
</varlistentry>
|
1999 | |
|
2000 | |
<varlistentry>
|
2001 | |
<term><option>-D, --debug</option>, <option>--debug</option></term>
|
2002 | |
<listitem>
|
2003 | |
<para>Enable debug mode. Print development related information.
|
2004 | |
</para>
|
|
2340 |
|
|
2341 |
<listitem>
|
|
2342 |
<para>Choose MIDI back-end to use.
|
|
2343 |
<replaceable>midi-driver</replaceable> can be either one of
|
|
2344 |
"JACK", "ALSA" or "portmidi" - depending on the operating-System
|
|
2345 |
and compile-time configuration.</para>
|
|
2346 |
</listitem>
|
|
2347 |
</varlistentry>
|
|
2348 |
|
|
2349 |
<varlistentry>
|
|
2350 |
<term><option>-D, --debug</option>,
|
|
2351 |
<option>--debug</option></term>
|
|
2352 |
|
|
2353 |
<listitem>
|
|
2354 |
<para>Enable debug mode. Print development related
|
|
2355 |
information.</para>
|
2005 | 2356 |
</listitem>
|
2006 | 2357 |
</varlistentry>
|
2007 | 2358 |
|
2008 | 2359 |
<varlistentry>
|
2009 | 2360 |
<term><option>-f <replaceable>n</replaceable></option>,
|
2010 | 2361 |
<option>--fps <replaceable>n</replaceable></option></term>
|
|
2362 |
|
2011 | 2363 |
<listitem>
|
2012 | 2364 |
<para>Desired refresh-rate of the video display in frames per
|
2013 | 2365 |
second. Non-integer values are possible. Default: -1.</para>
|
2014 | |
<para>If this value is set to zero (or less), xjadeo will use the
|
2015 | |
FPS of the video-file as its screen update frequency.</para>
|
2016 | |
</listitem>
|
2017 | |
</varlistentry>
|
2018 | |
|
2019 | |
<varlistentry>
|
2020 | |
<term><option>-F <replaceable>n</replaceable></option>,
|
|
2366 |
|
|
2367 |
<para>If this value is set to zero (or less), <application>Xjadeo</application> will use
|
|
2368 |
the FPS of the video-file as its screen update frequency.</para>
|
|
2369 |
</listitem>
|
|
2370 |
</varlistentry>
|
|
2371 |
|
|
2372 |
<varlistentry>
|
|
2373 |
<term><option>-F <replaceable>n</replaceable></option>,
|
2021 | 2374 |
<option>--filefps <replaceable>n</replaceable></option></term>
|
2022 | |
<listitem>
|
2023 | |
<para>Override the (auto-detected) frame-rate of the video-file.
|
2024 | |
</para>
|
|
2375 |
|
|
2376 |
<listitem>
|
|
2377 |
<para>Override the (auto-detected) frame-rate of the
|
|
2378 |
video-file.</para>
|
2025 | 2379 |
</listitem>
|
2026 | 2380 |
</varlistentry>
|
2027 | 2381 |
|
2028 | 2382 |
<varlistentry>
|
2029 | 2383 |
<term><option>-h, --help</option></term>
|
|
2384 |
|
2030 | 2385 |
<listitem>
|
2031 | 2386 |
<para>Prints usage help and exits.</para>
|
2032 | 2387 |
</listitem>
|
|
2035 | 2390 |
<varlistentry>
|
2036 | 2391 |
<term><option>-i <replaceable>n</replaceable></option>,
|
2037 | 2392 |
<option>--info <replaceable>n</replaceable></option></term>
|
|
2393 |
|
2038 | 2394 |
<listitem>
|
2039 | 2395 |
<para>Displays information using the OSD (on-screen display.)
|
2040 | |
<variablelist>
|
|
2396 |
<variablelist>
|
2041 | 2397 |
<varlistentry>
|
2042 | 2398 |
<term><option>0</option></term>
|
|
2399 |
|
2043 | 2400 |
<listitem>
|
2044 | 2401 |
<para>Off.</para>
|
2045 | 2402 |
</listitem>
|
2046 | 2403 |
</varlistentry>
|
|
2404 |
|
2047 | 2405 |
<varlistentry>
|
2048 | 2406 |
<term><option>1</option></term>
|
|
2407 |
|
2049 | 2408 |
<listitem>
|
2050 | 2409 |
<para>Frame number.</para>
|
2051 | 2410 |
</listitem>
|
2052 | 2411 |
</varlistentry>
|
|
2412 |
|
2053 | 2413 |
<varlistentry>
|
2054 | 2414 |
<term><option>2</option></term>
|
|
2415 |
|
2055 | 2416 |
<listitem>
|
2056 | 2417 |
<para>SMPTE time code.</para>
|
2057 | 2418 |
</listitem>
|
2058 | 2419 |
</varlistentry>
|
|
2420 |
|
2059 | 2421 |
<varlistentry>
|
2060 | 2422 |
<term><option>3</option></term>
|
|
2423 |
|
2061 | 2424 |
<listitem>
|
2062 | 2425 |
<para>Both frame number and SMPTE.</para>
|
2063 | 2426 |
</listitem>
|
2064 | 2427 |
</varlistentry>
|
2065 | |
</variablelist>
|
2066 | |
The remote control interface allows more
|
2067 | |
complete control over the OSD.
|
2068 | |
</para>
|
|
2428 |
</variablelist> The remote control interface allows more
|
|
2429 |
complete control over the OSD.</para>
|
2069 | 2430 |
</listitem>
|
2070 | 2431 |
</varlistentry>
|
2071 | 2432 |
|
2072 | 2433 |
<varlistentry>
|
2073 | 2434 |
<term><option>-I</option>,
|
2074 | 2435 |
<option>--ignorefileoffset</option></term>
|
2075 | |
<listitem>
|
2076 | |
<para>This option is only useful for video files that with a
|
2077 | |
start-offset, such as split vob files. Per default xjadeo will
|
2078 | |
honor offsets specified in the video-file header and the
|
2079 | |
file's PTS/DTS. <option>-I</option> allows to override and
|
2080 | |
subtract this offset and makes the file start at SMPTE
|
2081 | |
position 00:00:00:00. (although you can archive the same
|
2082 | |
result, this option is not related to <option>-o</option>.)
|
2083 | |
</para>
|
2084 | |
</listitem>
|
2085 | |
</varlistentry>
|
2086 | |
|
2087 | |
<varlistentry>
|
2088 | |
<term><option>-k</option>,
|
2089 | |
<option>--keyframes </option></term>
|
|
2436 |
|
|
2437 |
<listitem>
|
|
2438 |
<para>This option is only useful for video files with a
|
|
2439 |
start-offset, such as split vob files. Per default <application>Xjadeo</application> will
|
|
2440 |
honor offsets specified in the video-file header and the file's
|
|
2441 |
PTS/DTS. <option>-I</option> allows you to override and subtract
|
|
2442 |
this offset and makes the file start at SMPTE position
|
|
2443 |
00:00:00:00 (although you can archive the same result, this
|
|
2444 |
option is not related to <option>-o</option>.)</para>
|
|
2445 |
</listitem>
|
|
2446 |
</varlistentry>
|
|
2447 |
|
|
2448 |
<varlistentry>
|
|
2449 |
<term><option>-k</option>, <option>--keyframes </option></term>
|
|
2450 |
|
2090 | 2451 |
<listitem>
|
2091 | 2452 |
<para>Instructs the internal algorithm to seek only to
|
2092 | |
key-frames. This option may improve the performance for
|
2093 | |
certain video encodings.</para>
|
|
2453 |
key-frames. This option may improve the performance for certain
|
|
2454 |
video encodings.</para>
|
|
2455 |
|
2094 | 2456 |
<para>The default behavior (without <option>-k</option> and
|
2095 | |
<option>-K</option> arguments) is to search any ANY
|
2096 | |
frame.</para>
|
2097 | |
</listitem>
|
2098 | |
</varlistentry>
|
2099 | |
|
2100 | |
<varlistentry>
|
2101 | |
<term><option>-K</option>,
|
2102 | |
<option>--continuous </option></term>
|
|
2457 |
<option>-K</option> arguments) is to search any ANY
|
|
2458 |
frame.</para>
|
|
2459 |
</listitem>
|
|
2460 |
</varlistentry>
|
|
2461 |
|
|
2462 |
<varlistentry>
|
|
2463 |
<term><option>-K</option>, <option>--continuous </option></term>
|
|
2464 |
|
2103 | 2465 |
<listitem>
|
2104 | 2466 |
<para>Decode video frame by frame starting from previous
|
2105 | |
key-frame. This particularly useful to read files where not
|
2106 | |
every frame is a key-frame at cost of increased CPU usage.
|
2107 | |
Note that this option adds some extra latency when seeking.
|
2108 | |
Combine with <option>-f -1</option>:
|
2109 | |
It makes sense to set <application>xjadeo</application>'s
|
2110 | |
screen-update frequency to match the frame-rate of the
|
2111 | |
video file.</para>
|
2112 | |
</listitem>
|
2113 | |
</varlistentry>
|
2114 | |
|
2115 | |
<varlistentry>
|
2116 | |
<term><option>-l</option>,
|
2117 | |
<option>--ltc</option></term>
|
|
2467 |
key-frame. This particularly useful for reading files where not
|
|
2468 |
every frame is a key-frame at the cost of increased CPU usage.
|
|
2469 |
Note that this option adds some extra latency when seeking.
|
|
2470 |
Combine it with <option>-f -1</option>: it makes sense to set
|
|
2471 |
<application>Xjadeo</application>'s screen-update frequency to
|
|
2472 |
match the frame-rate of the video file.</para>
|
|
2473 |
</listitem>
|
|
2474 |
</varlistentry>
|
|
2475 |
|
|
2476 |
<varlistentry>
|
|
2477 |
<term><option>-l</option>, <option>--ltc</option></term>
|
|
2478 |
|
2118 | 2479 |
<listitem>
|
2119 | 2480 |
<para>Use LTC as sync-source instead of JACK-transport.</para>
|
2120 | 2481 |
</listitem>
|
2121 | 2482 |
</varlistentry>
|
2122 | 2483 |
|
2123 | 2484 |
<varlistentry>
|
2124 | |
<term><option>-L</option>,
|
2125 | |
<option>--nolash</option></term>
|
|
2485 |
<term><option>-L</option>, <option>--nolash</option></term>
|
|
2486 |
|
2126 | 2487 |
<listitem>
|
2127 | 2488 |
<para>Disable LASH support.</para>
|
2128 | 2489 |
</listitem>
|
|
2130 | 2491 |
|
2131 | 2492 |
<varlistentry>
|
2132 | 2493 |
<term><option>-m <replaceable>midi-port</replaceable></option>,
|
2133 | |
<option>--midi <replaceable>midi-port</replaceable></option></term>
|
2134 | |
<listitem>
|
2135 | |
<para>Get sync from MTC (MIDI Time Code)
|
2136 | |
instead of JACK or LTC.</para>
|
|
2494 |
<option>--midi
|
|
2495 |
<replaceable>midi-port</replaceable></option></term>
|
|
2496 |
|
|
2497 |
<listitem>
|
|
2498 |
<para>Get sync from MTC (MIDI Time Code) instead of JACK or
|
|
2499 |
LTC.</para>
|
|
2500 |
|
2137 | 2501 |
<para>If using JACK-MIDI driver,
|
2138 | |
<replaceable>midi-port</replaceable> is the JACK-MIDI port
|
2139 | |
to use as input - use an empty value ("") to not
|
2140 | |
auto-connect</para>
|
|
2502 |
<replaceable>midi-port</replaceable> is the JACK-MIDI port to
|
|
2503 |
use as input - use an empty value ("") to not
|
|
2504 |
auto-connect</para>
|
2141 | 2505 |
|
2142 | 2506 |
<para>If using ALSA MIDI back-end,
|
2143 | |
<replaceable>midi-port</replaceable> is the ALSA sequencer-id
|
2144 | |
to be used as the MTC source. A value of -1 will leave
|
2145 | |
<application>xjadeo</application> unconnected.</para>
|
2146 | |
|
2147 | |
<para>If using portmidi, <replaceable>port</replaceable>
|
2148 | |
is the port-number of the MIDI
|
2149 | |
input device to use. The value -1 will attempt auto-connect.
|
2150 | |
Use <option>-v -m -1</option> to list MIDI ports during
|
2151 | |
auto-detection.</para>
|
|
2507 |
<replaceable>midi-port</replaceable> is the ALSA sequencer-id to
|
|
2508 |
be used as the MTC source. A value of -1 will leave
|
|
2509 |
<application>Xjadeo</application> unconnected.</para>
|
|
2510 |
|
|
2511 |
<para>If using portmidi, <replaceable>port</replaceable> is the
|
|
2512 |
port-number of the MIDI input device to use. The value -1 will
|
|
2513 |
attempt auto-connect. Use <option>-v -m -1</option> to list MIDI
|
|
2514 |
ports during auto-detection.</para>
|
2152 | 2515 |
</listitem>
|
2153 | 2516 |
</varlistentry>
|
2154 | 2517 |
|
2155 | 2518 |
<varlistentry>
|
2156 | 2519 |
<term><option>-M <replaceable>n</replaceable></option>,
|
2157 | 2520 |
<option>--midifps <replaceable>n</replaceable></option></term>
|
|
2521 |
|
2158 | 2522 |
<listitem>
|
2159 | 2523 |
<para>Conversion between MTC SMPTE and frame number.
|
2160 | 2524 |
<variablelist>
|
2161 | 2525 |
<varlistentry>
|
2162 | 2526 |
<term><option>0</option> (default)</term>
|
|
2527 |
|
2163 | 2528 |
<listitem>
|
2164 | 2529 |
<para>Use MTC clock frame rate.</para>
|
2165 | 2530 |
</listitem>
|
2166 | 2531 |
</varlistentry>
|
|
2532 |
|
2167 | 2533 |
<varlistentry>
|
2168 | 2534 |
<term><option>1</option></term>
|
|
2535 |
|
2169 | 2536 |
<listitem>
|
2170 | 2537 |
<para>Use video-file's frame-rate.</para>
|
2171 | 2538 |
</listitem>
|
2172 | 2539 |
</varlistentry>
|
|
2540 |
|
2173 | 2541 |
<varlistentry>
|
2174 | 2542 |
<term><option>1</option></term>
|
|
2543 |
|
2175 | 2544 |
<listitem>
|
2176 | 2545 |
<para>Resample video frame rate / MTC.</para>
|
2177 | 2546 |
</listitem>
|
|
2181 | 2550 |
</varlistentry>
|
2182 | 2551 |
|
2183 | 2552 |
<varlistentry>
|
2184 | |
<term><option>-n</option>,
|
2185 | |
<option>--nodropframes</option></term>
|
2186 | |
<listitem>
|
2187 | |
<para>Prevent xjadeo from detecting drop-frame-timecode
|
2188 | |
(usually files with 29.97 fps)</para>
|
2189 | |
</listitem>
|
2190 | |
</varlistentry>
|
2191 | |
|
2192 | |
<varlistentry>
|
2193 | |
<term><option>-N</option>,
|
2194 | |
<option>--dropframes</option></term>
|
2195 | |
<listitem>
|
2196 | |
<para>Force xjadeo to use drop-frame-timecode
|
2197 | |
(drop-frame-timecode is only valid for files with
|
2198 | |
29.97 fps but your milage may vary)</para>
|
|
2553 |
<term><option>-n</option>, <option>--nodropframes</option></term>
|
|
2554 |
|
|
2555 |
<listitem>
|
|
2556 |
<para>Prevent <application>Xjadeo</application> from detecting drop-frame-timecode (usually
|
|
2557 |
files with 29.97 fps)</para>
|
|
2558 |
</listitem>
|
|
2559 |
</varlistentry>
|
|
2560 |
|
|
2561 |
<varlistentry>
|
|
2562 |
<term><option>-N</option>, <option>--dropframes</option></term>
|
|
2563 |
|
|
2564 |
<listitem>
|
|
2565 |
<para>Force <application>Xjadeo</application> to use drop-frame-timecode
|
|
2566 |
(drop-frame-timecode is only valid for files with 29.97 fps but
|
|
2567 |
your milage may vary)</para>
|
2199 | 2568 |
</listitem>
|
2200 | 2569 |
</varlistentry>
|
2201 | 2570 |
|
2202 | 2571 |
<varlistentry>
|
2203 | 2572 |
<term><option>-o <replaceable>n</replaceable></option>,
|
2204 | 2573 |
<option>--offset <replaceable>n</replaceable></option></term>
|
2205 | |
<listitem>
|
2206 | |
<para>Offset the video a certain number of (video) frames
|
2207 | |
relative to the sync master time base. Admits negative
|
2208 | |
values. <replaceable>n</replaceable> can be specified either
|
2209 | |
as integer frame-number or SMPTE text.</para>
|
2210 | |
</listitem>
|
2211 | |
</varlistentry>
|
2212 | |
|
2213 | |
<varlistentry>
|
2214 | |
<term><option>-P</option>,
|
2215 | |
<option>--genpts</option></term>
|
2216 | |
<listitem>
|
2217 | |
<para>This option passed on to ffmpeg and has no effect on
|
2218 | |
older versions of libavformat.</para>
|
2219 | |
<para>it can be used to generate "presentation time stamps"
|
2220 | |
if they are missing in the file, even if it requires parsing
|
2221 | |
future frames.</para>
|
2222 | |
</listitem>
|
2223 | |
</varlistentry>
|
2224 | |
|
2225 | |
<varlistentry>
|
2226 | |
<term><option>-q</option>,
|
2227 | |
<option>--quiet</option>,
|
|
2574 |
|
|
2575 |
<listitem>
|
|
2576 |
<para>Offset the video playback a certain number of (video)
|
|
2577 |
frames relative to the sync master time base. Admits negative
|
|
2578 |
values. <replaceable>n</replaceable> can be specified either as
|
|
2579 |
integer frame-number or SMPTE text.</para>
|
|
2580 |
</listitem>
|
|
2581 |
</varlistentry>
|
|
2582 |
|
|
2583 |
<varlistentry>
|
|
2584 |
<term><option>-P</option>, <option>--genpts</option></term>
|
|
2585 |
|
|
2586 |
<listitem>
|
|
2587 |
<para>This option passed on to ffmpeg and has no effect on older
|
|
2588 |
versions of libavformat.</para>
|
|
2589 |
|
|
2590 |
<para>it can be used to generate "presentation time stamps" if
|
|
2591 |
they are missing in the file, even if it requires parsing future
|
|
2592 |
frames.</para>
|
|
2593 |
</listitem>
|
|
2594 |
</varlistentry>
|
|
2595 |
|
|
2596 |
<varlistentry>
|
|
2597 |
<term><option>-q</option>, <option>--quiet</option>,
|
2228 | 2598 |
<option>--silent</option></term>
|
|
2599 |
|
2229 | 2600 |
<listitem>
|
2230 | 2601 |
<para>Suppresses normal output messages.</para>
|
2231 | 2602 |
</listitem>
|
2232 | 2603 |
</varlistentry>
|
2233 | 2604 |
|
2234 | 2605 |
<varlistentry>
|
2235 | |
<term><option>-Q</option>,
|
2236 | |
<option>--mq</option></term>
|
|
2606 |
<term><option>-Q</option>, <option>--mq</option></term>
|
|
2607 |
|
2237 | 2608 |
<listitem>
|
2238 | 2609 |
<para>Enable POSIX message queues. Set up a communication
|
2239 | |
channel for use with <xref linkend="xjremote"/>.
|
2240 | |
See the <xref linkend="remote_control_interface"/> in the
|
2241 | |
online documentation for more information.</para>
|
2242 | |
</listitem>
|
2243 | |
</varlistentry>
|
2244 | |
|
2245 | |
<varlistentry>
|
2246 | |
<term><option>-R</option>,
|
2247 | |
<option>--remote</option></term>
|
|
2610 |
channel for use with <xref linkend="xjremote"/>. See the <xref linkend="remote_control_interface"/> in the online
|
|
2611 |
documentation for more information.</para>
|
|
2612 |
</listitem>
|
|
2613 |
</varlistentry>
|
|
2614 |
|
|
2615 |
<varlistentry>
|
|
2616 |
<term><option>-R</option>, <option>--remote</option></term>
|
|
2617 |
|
2248 | 2618 |
<listitem>
|
2249 | 2619 |
<para>Enable interactive (stdin/stdout) remote control mode.
|
2250 | |
Options <option>--quiet</option> and <option>--verbose</option>
|
2251 | |
have no effect in remote mode.</para>
|
2252 | |
</listitem>
|
2253 | |
</varlistentry>
|
2254 | |
|
2255 | |
<varlistentry>
|
2256 | |
<term><option>-s</option>,
|
2257 | |
<option>--fullscreen</option></term>
|
2258 | |
<listitem>
|
2259 | |
<para>Start <application>xjadeo</application> in full-screen
|
2260 | |
mode.</para>
|
2261 | |
</listitem>
|
2262 | |
</varlistentry>
|
2263 | |
|
2264 | |
<varlistentry>
|
2265 | |
<term><option>-S</option>,
|
2266 | |
<option>--nosplash</option></term>
|
|
2620 |
Options <option>--quiet</option> and <option>--verbose</option>
|
|
2621 |
have no effect in remote mode.</para>
|
|
2622 |
</listitem>
|
|
2623 |
</varlistentry>
|
|
2624 |
|
|
2625 |
<varlistentry>
|
|
2626 |
<term><option>-s</option>, <option>--fullscreen</option></term>
|
|
2627 |
|
|
2628 |
<listitem>
|
|
2629 |
<para>Start <application>Xjadeo</application> in full-screen
|
|
2630 |
mode.</para>
|
|
2631 |
</listitem>
|
|
2632 |
</varlistentry>
|
|
2633 |
|
|
2634 |
<varlistentry>
|
|
2635 |
<term><option>-S</option>, <option>--nosplash</option></term>
|
|
2636 |
|
2267 | 2637 |
<listitem>
|
2268 | 2638 |
<para>Skip the on-screen-display startup sequence.</para>
|
2269 | 2639 |
</listitem>
|
2270 | 2640 |
</varlistentry>
|
2271 | 2641 |
|
2272 | 2642 |
<varlistentry>
|
2273 | |
<term><option>-t</option>,
|
2274 | |
<option>--try-codec</option></term>
|
|
2643 |
<term><option>-t</option>, <option>--try-codec</option></term>
|
|
2644 |
|
2275 | 2645 |
<listitem>
|
2276 | 2646 |
<para>Check if the video file is encoded in a format suitable
|
2277 | |
for use with <application>xjadeo</application> and exit.
|
2278 | |
If the video format is not supported the exit code is 1.</para>
|
2279 | |
</listitem>
|
2280 | |
</varlistentry>
|
2281 | |
|
2282 | |
<varlistentry>
|
2283 | |
<term><option>-v</option>,
|
2284 | |
<option>--verbose</option></term>
|
|
2647 |
for use with <application>Xjadeo</application> and exit. If the
|
|
2648 |
video format is not supported the exit code is 1.</para>
|
|
2649 |
</listitem>
|
|
2650 |
</varlistentry>
|
|
2651 |
|
|
2652 |
<varlistentry>
|
|
2653 |
<term><option>-v</option>, <option>--verbose</option></term>
|
|
2654 |
|
2285 | 2655 |
<listitem>
|
2286 | 2656 |
<para>Print additional information.</para>
|
2287 | 2657 |
</listitem>
|
2288 | 2658 |
</varlistentry>
|
2289 | 2659 |
|
2290 | 2660 |
<varlistentry>
|
2291 | |
<term><option>-V</option>,
|
2292 | |
<option>--version</option></term>
|
2293 | |
<listitem>
|
2294 | |
<para>Display version and compile-time configuration
|
2295 | |
information and exit.</para>
|
|
2661 |
<term><option>-V</option>, <option>--version</option></term>
|
|
2662 |
|
|
2663 |
<listitem>
|
|
2664 |
<para>Display version and compile-time configuration information
|
|
2665 |
and exit.</para>
|
2296 | 2666 |
</listitem>
|
2297 | 2667 |
</varlistentry>
|
2298 | 2668 |
|
2299 | 2669 |
<varlistentry>
|
2300 | 2670 |
<term><option>-W <replaceable>rpc-id</replaceable></option>,
|
2301 | 2671 |
<option>--ipc <replaceable>rpc-id</replaceable></option></term>
|
|
2672 |
|
2302 | 2673 |
<listitem>
|
2303 | 2674 |
<para>Set-up IPC message queues for
|
2304 | |
<application>xjremote</application>.
|
2305 | |
<replaceable>rpc-id</replaceable> specifies a file-path used
|
2306 | |
to identify the message-queue.
|
2307 | |
</para>
|
|
2675 |
<application>xjremote</application>.
|
|
2676 |
<replaceable>rpc-id</replaceable> specifies a file-path used to
|
|
2677 |
identify the message-queue.</para>
|
2308 | 2678 |
</listitem>
|
2309 | 2679 |
</varlistentry>
|
2310 | 2680 |
|
2311 | 2681 |
<varlistentry>
|
2312 | 2682 |
<term><option>-x <replaceable>dpy-mode</replaceable></option>,
|
2313 | |
<option>--vo <replaceable>dpy-mode</replaceable></option>,
|
2314 | |
<option>--videomode <replaceable>dpy-mode</replaceable></option>
|
2315 | |
</term>
|
|
2683 |
<option>--vo <replaceable>dpy-mode</replaceable></option>,
|
|
2684 |
<option>--videomode
|
|
2685 |
<replaceable>dpy-mode</replaceable></option></term>
|
|
2686 |
|
2316 | 2687 |
<listitem>
|
2317 | 2688 |
<para>Selects the video output driver. Defaults to
|
2318 | |
<literal>0</literal> (auto-detect).
|
2319 | |
A value of -1 lists the available modes and exit.</para>
|
2320 | |
</listitem>
|
2321 | |
</varlistentry>
|
2322 | |
|
|
2689 |
<literal>0</literal> (auto-detect). A value of -1 lists the
|
|
2690 |
available modes and exits.</para>
|
|
2691 |
</listitem>
|
|
2692 |
</varlistentry>
|
2323 | 2693 |
</variablelist>
|
2324 | 2694 |
</refsect1>
|
2325 | 2695 |
|
|
2327 | 2697 |
<title>SYNC SOURCES</title>
|
2328 | 2698 |
|
2329 | 2699 |
<para><command>xjadeo</command> currently supports the following
|
2330 | |
synchronization sources:</para>
|
|
2700 |
synchronization sources:</para>
|
|
2701 |
|
2331 | 2702 |
<itemizedlist>
|
2332 | 2703 |
<listitem>
|
2333 | 2704 |
<para>JACK-transport.</para>
|
2334 | 2705 |
</listitem>
|
|
2706 |
|
2335 | 2707 |
<listitem>
|
2336 | 2708 |
<para>LTC (Linear/Longitudinal Time Code) - via JACK audio.</para>
|
2337 | 2709 |
</listitem>
|
|
2710 |
|
2338 | 2711 |
<listitem>
|
2339 | 2712 |
<para>MTC (MIDI Time Code) via JACK-MIDI.</para>
|
2340 | 2713 |
</listitem>
|
|
2714 |
|
2341 | 2715 |
<listitem>
|
2342 | 2716 |
<para>MTC (MIDI Time Code) via ALSA sequencer.</para>
|
2343 | 2717 |
</listitem>
|
|
2718 |
|
2344 | 2719 |
<listitem>
|
2345 | 2720 |
<para>MTC (MIDI Time Code) via portmidi.</para>
|
2346 | 2721 |
</listitem>
|
|
2722 |
|
2347 | 2723 |
<listitem>
|
2348 | 2724 |
<para>remote-ctrl manual seeks (not really a sync source).</para>
|
2349 | 2725 |
</listitem>
|
|
2353 | 2729 |
<refsect1>
|
2354 | 2730 |
<title>VIDEO FORMATS</title>
|
2355 | 2731 |
|
2356 | |
<para><application>xjadeo</application> uses ffmpeg to decode
|
2357 | |
video files, so a wide range of formats and codecs are supported.
|
2358 | |
Note, however, that not all the formats support seeking.
|
2359 | |
To transcode a video-file into a suitable format we recommend:
|
2360 | |
|
2361 | |
<screen>mencoder -idx -ovc lavc -lavcopts keyint=1 -nosound input_file.xxx -o output_file.avi</screen>
|
2362 | |
|
2363 | |
This creates from your input-file.xxx an AVI mpeg4 encoded video
|
2364 | |
file with no sound, an index (-idx) and no compression between frames
|
2365 | |
(every frame is a keyframe). The file thus can become really BIG, so
|
2366 | |
watch your disk space.</para>
|
2367 | |
|
2368 | |
<para>You may want to shrink the size by scaling the geometry of the
|
2369 | |
video-frames, which also taxes less system resources while displaying
|
2370 | |
it and leaves more space in the screen for your audio
|
2371 | |
software..</para>
|
|
2732 |
<para><application>Xjadeo</application> uses ffmpeg to decode video
|
|
2733 |
files, so a wide range of formats and codecs are supported. Note,
|
|
2734 |
however, that not all the formats support seeking. To transcode a
|
|
2735 |
video-file into a suitable format we recommend: <screen>mencoder -idx -ovc lavc -lavcopts keyint=1 -nosound input_file.xxx -o output_file.avi</screen>
|
|
2736 |
This creates from your input-file.xxx an AVI mpeg4 encoded video file
|
|
2737 |
with no sound, an index (-idx) and no compression between frames
|
|
2738 |
(every frame is a keyframe). The file thus can become really BIG, so
|
|
2739 |
watch your disk space!</para>
|
|
2740 |
|
|
2741 |
<para>You may want also to shrink the size of the file's video frames
|
|
2742 |
by scaling down its geometry. This uses fewer system resources while
|
|
2743 |
decoding and displaying it and leaves more space in the screen for
|
|
2744 |
your audio software.</para>
|
2372 | 2745 |
|
2373 | 2746 |
<screen>-vf scale=width:height</screen>
|
2374 | 2747 |
|
2375 | 2748 |
<important>
|
2376 | |
<para>Also note <application>xjadeo</application>'s
|
2377 | |
<option>-K</option> option which allows to seek to frames other
|
2378 | |
than key-frames and enables <application>xjadeo</application> to
|
2379 | |
play back any file without transcoding at. It comes with the
|
2380 | |
expense of increased CPU usage and possibly increased seek latency.
|
2381 | |
The latter depends on the key-frame interval and video-codec)
|
2382 | |
</para>
|
|
2749 |
<para>Also note <application>Xjadeo</application>'s
|
|
2750 |
<option>-K</option> option which allows to seek to frames other than
|
|
2751 |
key-frames and enables <application>Xjadeo</application> to play
|
|
2752 |
back any file without transcoding it. It comes at the expense of
|
|
2753 |
increased CPU usage and possibly increased seek latency. The latter
|
|
2754 |
depends on the key-frame interval and video-codec.</para>
|
|
2755 |
|
2383 | 2756 |
<para>The same can be achieved by adding
|
2384 | |
<literal>seek=continuously</literal> to
|
2385 | |
<filename>~/.xjadeorc</filename>.</para>
|
|
2757 |
<literal>seek=continuously</literal> to
|
|
2758 |
<filename>~/.xjadeorc</filename>.</para>
|
2386 | 2759 |
</important>
|
2387 | 2760 |
</refsect1>
|
2388 | 2761 |
|
2389 | 2762 |
<refsect1>
|
2390 | 2763 |
<title>USER INPUT</title>
|
2391 | 2764 |
|
2392 | |
<para><command>xjadeo</command> window accepts the following input:
|
2393 | |
</para>
|
|
2765 |
<para><command>xjadeo</command> window accepts the following
|
|
2766 |
input:</para>
|
2394 | 2767 |
|
2395 | 2768 |
<itemizedlist>
|
2396 | 2769 |
<listitem>
|
2397 | 2770 |
<para>Pressing mouse button 1 will resize the window to the
|
2398 | |
original movie size.</para>
|
2399 | |
</listitem>
|
|
2771 |
original movie size.</para>
|
|
2772 |
</listitem>
|
|
2773 |
|
2400 | 2774 |
<listitem>
|
2401 | 2775 |
<para>Mouse button 2 and 3 resize the window to match the movie
|
2402 | |
aspect ratio.</para>
|
2403 | |
</listitem>
|
|
2776 |
aspect ratio.</para>
|
|
2777 |
</listitem>
|
|
2778 |
|
2404 | 2779 |
<listitem>
|
2405 | 2780 |
<para>Scroll Wheel (buttons 4,5) stepwise decreases/increases the
|
2406 | |
window size maintaining the original aspect ratio.</para>
|
2407 | |
</listitem>
|
2408 | |
<listitem>
|
2409 | |
<para> xjadeo ≥ v0.3.8 supports keyboard events. Pressing
|
2410 | |
<keycap>Esc</keycap> and <keycap>q</keycap> will end the program.
|
2411 | |
<keycap>f</keycap> toggles full-screen, <keycap>a</keycap>
|
2412 | |
togglesalways-on-top.
|
2413 | |
Press <keycap>m</keycap> to hide mouse cursor.
|
2414 | |
<keycap>v</keycap>, <keycap>s</keycap>, <keycap>o</keycap>,
|
2415 | |
<keycap>C</keycap> and <keycap>b</keycap> control
|
2416 | |
on-screen-display and <keycap>l</keycap> toggles the
|
2417 | |
letter-box mode.
|
2418 | |
|
2419 | |
The time-offset can be modified with <keycap>+</keycap>,
|
2420 | |
<keycap>-</keycap>, <keycap>{</keycap>, <keycap>}</keycap>
|
2421 | |
and window-size with <keycap><</keycap>, <keycap>></keycap>,
|
2422 | |
<keycap>,</keycap>, <keycap>.</keycap>.
|
2423 | |
<keycap>SPACE</keycap> and <keycap>BACKSPACE</keycap> can be used
|
2424 | |
to control JACK-transport.
|
2425 | |
See <xref linkend="x_window_interaction" /> in the online
|
2426 | |
documentation for a complete list.</para>
|
|
2781 |
window size maintaining the original aspect ratio.</para>
|
|
2782 |
</listitem>
|
|
2783 |
|
|
2784 |
<listitem>
|
|
2785 |
<para><application>Xjadeo</application> ≥ v0.3.8 supports keyboard events. Pressing
|
|
2786 |
<keycap>Esc</keycap> and <keycap>q</keycap> will end the program.
|
|
2787 |
<keycap>f</keycap> toggles full-screen, <keycap>a</keycap>
|
|
2788 |
togglesalways-on-top. Press <keycap>m</keycap> to hide mouse
|
|
2789 |
cursor. <keycap>v</keycap>, <keycap>s</keycap>,
|
|
2790 |
<keycap>o</keycap>, <keycap>C</keycap> and <keycap>b</keycap>
|
|
2791 |
control on-screen-display and <keycap>l</keycap> toggles the
|
|
2792 |
letter-box mode. The time-offset can be modified with
|
|
2793 |
<keycap>+</keycap>, <keycap>-</keycap>, <keycap>{</keycap>,
|
|
2794 |
<keycap>}</keycap> and window-size with <keycap><</keycap>,
|
|
2795 |
<keycap>></keycap>, <keycap>,</keycap>, <keycap>.</keycap>.
|
|
2796 |
<keycap>SPACE</keycap> and <keycap>BACKSPACE</keycap> can be used
|
|
2797 |
to control JACK-transport. See <xref linkend="x_window_interaction"/> in the online documentation for
|
|
2798 |
a complete list.</para>
|
2427 | 2799 |
</listitem>
|
2428 | 2800 |
</itemizedlist>
|
2429 | 2801 |
</refsect1>
|
2430 | 2802 |
|
2431 | 2803 |
<refsect1>
|
2432 | 2804 |
<title>REMOTE MODE</title>
|
|
2805 |
|
2433 | 2806 |
<para>When started in remote mode (option <option>-R</option> or
|
2434 | |
<option>--remote</option>) <application>xjadeo</application> will
|
|
2807 |
<option>--remote</option>) <application>Xjadeo</application> will
|
2435 | 2808 |
interactively accept commands and issue responses through its standard
|
2436 | 2809 |
input/output mechanism.</para>
|
2437 | 2810 |
|
2438 | 2811 |
<para>Use the remote command <command>help</command> to get a quick
|
2439 | |
overview of all available commands. Please refer to the online
|
2440 | |
documentation for a complete description of the remote
|
2441 | |
commands.</para>
|
|
2812 |
overview of all available commands. Please refer to the online
|
|
2813 |
documentation for a complete description of the remote
|
|
2814 |
commands.</para>
|
2442 | 2815 |
|
2443 | 2816 |
<para><command>xjadeo -Q</command> enables remote control by
|
2444 | |
message-queues; use <command>xjremote</command> to connect.</para>
|
|
2817 |
message-queues; use <command>xjremote</command> to connect.</para>
|
2445 | 2818 |
</refsect1>
|
2446 | 2819 |
|
2447 | 2820 |
<refsect1>
|
2448 | 2821 |
<title>FILES</title>
|
2449 | |
<para>xjadeo reads the following resource configuration files in
|
2450 | |
this order:</para>
|
2451 | |
<orderedlist>
|
2452 | |
<listitem>
|
2453 | |
<para><filename>/@SYSCONFDIR@/xjadeorc</filename>
|
2454 | |
(usually <filename>/etc/xjadeorc</filename>
|
2455 | |
or <filename>/usr/local/etc/xjadeorc</filename>, which depends
|
2456 | |
on your distribution and on the configuration when
|
2457 | |
<xref linkend="build"/>)</para>
|
2458 | |
</listitem>
|
2459 | |
<listitem>
|
2460 | |
<para><filename>$HOME/.xjadeorc</filename></para>
|
2461 | |
</listitem>
|
2462 | |
<listitem>
|
2463 | |
<para><filename>./xjadeorc</filename></para>
|
2464 | |
</listitem>
|
2465 | |
</orderedlist>
|
2466 | |
<para>Each line in the configuration file must be in in the format:
|
2467 | |
<screen>KEY=VALUE</screen>
|
2468 | |
If the first character on a line is either <literal>#</literal> or
|
2469 | |
<literal>;</literal> the line is ignored.
|
2470 | |
<option>KEYS</option> are not case sensitive.
|
2471 | |
Some <option>VALUES</option> are case sensitive (e.g. filenames)
|
2472 | |
and are parsed identical to the corresponding command-line
|
2473 | |
arguments (e.g. <option>-x SDL</option> is equivalent to the
|
2474 | |
config-file option <option>videomode=SDL</option>).
|
2475 | |
Boolean values are specified as <literal>yes</literal>
|
2476 | |
or <literal>no</literal> (e.g. <option>quiet=yes</option>).</para>
|
2477 | |
|
2478 | |
<para>currently supported RC-KEYS:
|
2479 | |
fps, fontfile, lash, letterbox, midiclk, mididriver, midiid,
|
2480 | |
midismpte, mq, nosplash, quiet, seek, verbose and videomode.
|
2481 | |
Which are documented in the example <ulink
|
2482 | |
url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=doc/xjadeorc" >xjadeorc</ulink>
|
2483 | |
</para>
|
|
2822 |
|
|
2823 |
<para><application>Xjadeo</application> reads the following resource configuration files in this
|
|
2824 |
order:</para>
|
|
2825 |
|
|
2826 |
<orderedlist>
|
|
2827 |
<listitem>
|
|
2828 |
<para><filename>/@SYSCONFDIR@/xjadeorc</filename> (usually
|
|
2829 |
<filename>/etc/xjadeorc</filename> or
|
|
2830 |
<filename>/usr/local/etc/xjadeorc</filename>, which depends on
|
|
2831 |
your distribution and on the configuration when <xref linkend="build"/>)</para>
|
|
2832 |
</listitem>
|
|
2833 |
|
|
2834 |
<listitem>
|
|
2835 |
<para><filename>$HOME/.xjadeorc</filename></para>
|
|
2836 |
</listitem>
|
|
2837 |
|
|
2838 |
<listitem>
|
|
2839 |
<para><filename>./xjadeorc</filename></para>
|
|
2840 |
</listitem>
|
|
2841 |
</orderedlist>
|
|
2842 |
|
|
2843 |
<para>Each line in the configuration file must be in in the format:
|
|
2844 |
<screen>KEY=VALUE</screen> If the first character on a line is either
|
|
2845 |
<literal>#</literal> or <literal>;</literal> the line is ignored.
|
|
2846 |
<option>KEYS</option> are not case sensitive. Some
|
|
2847 |
<option>VALUES</option> are case sensitive (e.g. filenames) and are
|
|
2848 |
parsed identical to the corresponding command-line arguments (e.g.
|
|
2849 |
<option>-x SDL</option> is equivalent to the config-file option
|
|
2850 |
<option>videomode=SDL</option>). Boolean values are specified as
|
|
2851 |
<literal>yes</literal> or <literal>no</literal> (e.g.
|
|
2852 |
<option>quiet=yes</option>).</para>
|
|
2853 |
|
|
2854 |
<para>currently supported RC-KEYS: fps, fontfile, lash, letterbox,
|
|
2855 |
midiclk, mididriver, midiid, midismpte, mq, nosplash, quiet, seek,
|
|
2856 |
verbose and videomode. Which are documented in the example <ulink url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=doc/xjadeorc">xjadeorc</ulink></para>
|
2484 | 2857 |
</refsect1>
|
|
2858 |
|
2485 | 2859 |
<refsect1>
|
2486 | 2860 |
<title>ENVIRONMENT</title>
|
|
2861 |
|
2487 | 2862 |
<variablelist>
|
2488 | 2863 |
<varlistentry>
|
2489 | 2864 |
<term><option>JACK_DEFAULT_SERVER</option></term>
|
|
2865 |
|
2490 | 2866 |
<listitem>
|
2491 | 2867 |
<para>Set the jack-server-name to connect to (used by
|
2492 | |
JACK-transport, JACK-MIDI and LTC)</para>
|
|
2868 |
JACK-transport, JACK-MIDI and LTC)</para>
|
2493 | 2869 |
</listitem>
|
2494 | 2870 |
</varlistentry>
|
2495 | 2871 |
</variablelist>
|
|
2497 | 2873 |
|
2498 | 2874 |
<refsect1>
|
2499 | 2875 |
<title>SEE ALSO</title>
|
2500 | |
<para><xref linkend="qjadeo"/></para>
|
2501 | |
<para><xref linkend="xjremote"/></para>
|
2502 | |
<para><xref linkend="xjinfo"/></para>
|
2503 | |
<para><ulink url="http://xjadeo.sourceforge.net/">online-manual</ulink></para>
|
|
2876 |
|
|
2877 |
<para><xref linkend="qjadeo"/></para>
|
|
2878 |
|
|
2879 |
<para><xref linkend="xjremote"/></para>
|
|
2880 |
|
|
2881 |
<para><xref linkend="xjinfo"/></para>
|
|
2882 |
|
|
2883 |
<para><ulink url="http://xjadeo.sourceforge.net/">online-manual</ulink></para>
|
2504 | 2884 |
</refsect1>
|
2505 | |
|
2506 | 2885 |
</refentry>
|
2507 | |
|
2508 | 2886 |
|
2509 | 2887 |
<refentry id="qjadeo">
|
2510 | 2888 |
<refmeta>
|
2511 | 2889 |
<refentrytitle>qjadeo</refentrytitle>
|
2512 | |
<manvolnum>1</manvolnum>
|
|
2890 |
|
|
2891 |
<manvolnum>1</manvolnum>
|
|
2892 |
|
2513 | 2893 |
<refmiscinfo class="source">http://xjadeo.sf.net</refmiscinfo>
|
|
2894 |
|
2514 | 2895 |
<refmiscinfo class="version">0.6.X</refmiscinfo>
|
2515 | 2896 |
</refmeta>
|
2516 | 2897 |
|
|
2523 | 2904 |
<refsynopsisdiv>
|
2524 | 2905 |
<cmdsynopsis>
|
2525 | 2906 |
<command>qjadeo</command>
|
2526 | |
|
2527 | 2907 |
</cmdsynopsis>
|
2528 | 2908 |
</refsynopsisdiv>
|
2529 | 2909 |
|
2530 | 2910 |
<refsect1>
|
2531 | 2911 |
<title>DESCRIPTION</title>
|
2532 | 2912 |
|
2533 | |
<para><application>xjadeo</application> is a software video player
|
2534 | |
that displays a video-clip in sync with an external time source
|
2535 | |
(MTC, LTC, JACK-transport).</para>
|
2536 | |
|
2537 | |
<para><command>qjadeo</command> is a graphical front-end to xjadeo. It
|
2538 | |
communicates with xjadeo either directly (single session) or using
|
|
2913 |
<para><application>Xjadeo</application> is a software video player
|
|
2914 |
that displays a video-clip in sync with an external time source (MTC,
|
|
2915 |
LTC, JACK-transport).</para>
|
|
2916 |
|
|
2917 |
<para><command>qjadeo</command> is a graphical front-end to <application>Xjadeo</application>. It
|
|
2918 |
communicates with <application>Xjadeo</application> either directly (single session) or using
|
2539 | 2919 |
<command>xjremote</command>.</para>
|
2540 | 2920 |
</refsect1>
|
2541 | 2921 |
|
|
2543 | 2923 |
<title>ENVIRONMENT</title>
|
2544 | 2924 |
|
2545 | 2925 |
<para>If the <option>XJREMOTE</option> variable is set,
|
2546 | |
<application>qjadeo</application> will assume that it holds the path
|
2547 | |
to the <command>xjremote</command> executable.</para>
|
|
2926 |
<application>qjadeo</application> will assume that it holds the path
|
|
2927 |
to the <command>xjremote</command> executable.</para>
|
2548 | 2928 |
</refsect1>
|
2549 | 2929 |
|
2550 | 2930 |
<refsect1>
|
2551 | 2931 |
<title>SEE ALSO</title>
|
2552 | |
<para><xref linkend="xjadeo"/></para>
|
2553 | |
<para><xref linkend="xjremote"/></para>
|
|
2932 |
|
|
2933 |
<para><xref linkend="xjadeo"/></para>
|
|
2934 |
|
|
2935 |
<para><xref linkend="xjremote"/></para>
|
2554 | 2936 |
</refsect1>
|
2555 | 2937 |
</refentry>
|
2556 | |
|
|
2938 |
|
2557 | 2939 |
<refentry id="xjremote">
|
2558 | 2940 |
<refmeta>
|
2559 | 2941 |
<refentrytitle>xjremote</refentrytitle>
|
2560 | |
<manvolnum>1</manvolnum>
|
|
2942 |
|
|
2943 |
<manvolnum>1</manvolnum>
|
|
2944 |
|
2561 | 2945 |
<refmiscinfo class="source">http://xjadeo.sf.net</refmiscinfo>
|
|
2946 |
|
2562 | 2947 |
<refmiscinfo class="version">0.6.X</refmiscinfo>
|
2563 | 2948 |
</refmeta>
|
2564 | 2949 |
|
2565 | 2950 |
<refnamediv>
|
2566 | 2951 |
<refname>xjremote</refname>
|
2567 | 2952 |
|
2568 | |
<refpurpose>CLI remote-control to <command>xjadeo</command></refpurpose>
|
|
2953 |
<refpurpose>CLI remote-control to
|
|
2954 |
<command>xjadeo</command></refpurpose>
|
2569 | 2955 |
</refnamediv>
|
2570 | 2956 |
|
2571 | 2957 |
<refsynopsisdiv>
|
2572 | 2958 |
<cmdsynopsis>
|
2573 | 2959 |
<command>xjremote</command>
|
|
2960 |
|
2574 | 2961 |
<arg choice="opt">-fhPquUvV</arg>
|
|
2962 |
|
2575 | 2963 |
<arg choice="opt">-I <replaceable>mq-queue-id</replaceable></arg>
|
2576 | 2964 |
</cmdsynopsis>
|
2577 | 2965 |
</refsynopsisdiv>
|
|
2579 | 2967 |
<refsect1 id="xjremote_description">
|
2580 | 2968 |
<title>DESCRIPTION</title>
|
2581 | 2969 |
|
2582 | |
<para><application>xjadeo</application> is a software video player
|
2583 | |
that displays a video-clip in sync with an external time source
|
2584 | |
(MTC, LTC, JACK-transport).</para>
|
2585 | |
|
2586 | |
<para><command>xjremote</command> connects to a instance of
|
2587 | |
<application>xjadeo</application> and allows a user to tweak the
|
2588 | |
running configuration.</para>
|
|
2970 |
<para><application>Xjadeo</application> is a software video player
|
|
2971 |
that displays a video-clip in sync with an external time source (MTC,
|
|
2972 |
LTC, JACK-transport).</para>
|
|
2973 |
|
|
2974 |
<para><command>xjremote</command> connects to a instance of
|
|
2975 |
<application>Xjadeo</application> and allows a user to tweak the
|
|
2976 |
running configuration.</para>
|
2589 | 2977 |
|
2590 | 2978 |
<para>If it can not connect, xjremote will start a new instance of
|
2591 | |
xjadeo and open a connection to it unless the <option>-f</option>
|
2592 | |
is given.</para>
|
|
2979 |
<application>Xjadeo</application> and open a connection to it unless the <option>-f</option> is
|
|
2980 |
given.</para>
|
2593 | 2981 |
</refsect1>
|
2594 | 2982 |
|
2595 | 2983 |
<refsect1>
|
2596 | 2984 |
<title>OPTIONS</title>
|
|
2985 |
|
2597 | 2986 |
<variablelist>
|
2598 | 2987 |
<varlistentry>
|
2599 | |
<term><option>-f</option>,
|
2600 | |
<option>--nofork</option></term>
|
|
2988 |
<term><option>-f</option>, <option>--nofork</option></term>
|
|
2989 |
|
2601 | 2990 |
<listitem>
|
2602 | 2991 |
<para>disable automatic startup of
|
2603 | |
<application>xjadeo</application>. Instead xjremote will
|
2604 | |
terminate if it can not connect to a running
|
2605 | |
<application>xjadeo</application>.</para>
|
2606 | |
</listitem>
|
2607 | |
</varlistentry>
|
2608 | |
|
2609 | |
<varlistentry>
|
2610 | |
<term><option>-h</option>,
|
2611 | |
<option>--help</option></term>
|
|
2992 |
<application>Xjadeo</application>. Instead xjremote will
|
|
2993 |
terminate if it can not connect to a running
|
|
2994 |
<application>Xjadeo</application>.</para>
|
|
2995 |
</listitem>
|
|
2996 |
</varlistentry>
|
|
2997 |
|
|
2998 |
<varlistentry>
|
|
2999 |
<term><option>-h</option>, <option>--help</option></term>
|
|
3000 |
|
2612 | 3001 |
<listitem>
|
2613 | 3002 |
<para>Prints usage help and exits.</para>
|
2614 | 3003 |
</listitem>
|
|
2617 | 3006 |
<varlistentry>
|
2618 | 3007 |
<term><option>-I <replaceable>ipc-id</replaceable></option>,
|
2619 | 3008 |
<option>--id <replaceable>ipc-id</replaceable></option></term>
|
|
3009 |
|
2620 | 3010 |
<listitem>
|
2621 | 3011 |
<para>specify message-queue identifier.</para>
|
2622 | 3012 |
</listitem>
|
2623 | 3013 |
</varlistentry>
|
2624 | 3014 |
|
2625 | |
|
2626 | |
<varlistentry>
|
2627 | |
<term><option>-P</option>,
|
2628 | |
<option>-P, --noping</option></term>
|
2629 | |
<listitem>
|
2630 | |
<para>Skip checking for xjadeo live signs (ping).</para>
|
2631 | |
</listitem>
|
2632 | |
</varlistentry>
|
2633 | |
|
2634 | |
<varlistentry>
|
2635 | |
<term><option>-q</option>,
|
2636 | |
<option>--quiet</option>,
|
|
3015 |
<varlistentry>
|
|
3016 |
<term><option>-P</option>, <option>-P, --noping</option></term>
|
|
3017 |
|
|
3018 |
<listitem>
|
|
3019 |
<para>Skip checking for <application>Xjadeo</application> life signs (ping).</para>
|
|
3020 |
</listitem>
|
|
3021 |
</varlistentry>
|
|
3022 |
|
|
3023 |
<varlistentry>
|
|
3024 |
<term><option>-q</option>, <option>--quiet</option>,
|
2637 | 3025 |
<option>--silent</option></term>
|
|
3026 |
|
2638 | 3027 |
<listitem>
|
2639 | 3028 |
<para>Suppresses normal output messages.</para>
|
2640 | 3029 |
</listitem>
|
|
2642 | 3031 |
|
2643 | 3032 |
<varlistentry>
|
2644 | 3033 |
<term><option>-Q</option></term>
|
|
3034 |
|
2645 | 3035 |
<listitem>
|
2646 | 3036 |
<para>ignored - <application>xjremote</application> can be used
|
2647 | |
as a drop in replacement for <command>xjadeo -Q</command>.
|
2648 | |
</para>
|
|
3037 |
as a drop in replacement for <command>xjadeo
|
|
3038 |
-Q</command>.</para>
|
2649 | 3039 |
</listitem>
|
2650 | 3040 |
</varlistentry>
|
2651 | 3041 |
|
2652 | 3042 |
<varlistentry>
|
2653 | 3043 |
<term><option>-R</option></term>
|
|
3044 |
|
2654 | 3045 |
<listitem>
|
2655 | 3046 |
<para>ignored - <application>xjremote</application> can be used
|
2656 | |
as a drop in replacement for <command>xjadeo -R</command>.
|
2657 | |
</para>
|
2658 | |
</listitem>
|
2659 | |
</varlistentry>
|
2660 | |
|
2661 | |
<varlistentry>
|
2662 | |
<term><option>-u</option>,
|
2663 | |
<option>--unlink</option></term>
|
|
3047 |
as a drop in replacement for <command>xjadeo
|
|
3048 |
-R</command>.</para>
|
|
3049 |
</listitem>
|
|
3050 |
</varlistentry>
|
|
3051 |
|
|
3052 |
<varlistentry>
|
|
3053 |
<term><option>-u</option>, <option>--unlink</option></term>
|
|
3054 |
|
2664 | 3055 |
<listitem>
|
2665 | 3056 |
<para>remove existing queues. Unless combined with
|
2666 | |
<option>-f</option> this will launch always a new xjadeo
|
|
3057 |
<option>-f</option> this will launch always a new <application>Xjadeo</application>
|
2667 | 3058 |
instance after unlinking the queues. Note: active connections
|
2668 | 3059 |
are not affected.</para>
|
2669 | 3060 |
</listitem>
|
2670 | 3061 |
</varlistentry>
|
2671 | 3062 |
|
2672 | 3063 |
<varlistentry>
|
2673 | |
<term><option>-U</option>,
|
2674 | |
<option>--unlinkonly</option></term>
|
2675 | |
<listitem>
|
2676 | |
<para>remove existing message queues and exit. If no xjadeo
|
2677 | |
instance is running this is equivalent to
|
2678 | |
<option>-u -f</option>.</para>
|
2679 | |
</listitem>
|
2680 | |
</varlistentry>
|
2681 | |
|
2682 | |
<varlistentry>
|
2683 | |
<term><option>-v</option>,
|
2684 | |
<option>--verbose</option></term>
|
|
3064 |
<term><option>-U</option>, <option>--unlinkonly</option></term>
|
|
3065 |
|
|
3066 |
<listitem>
|
|
3067 |
<para>remove existing message queues and exit. If no <application>Xjadeo</application>
|
|
3068 |
instance is running this is equivalent to <option>-u
|
|
3069 |
-f</option>.</para>
|
|
3070 |
</listitem>
|
|
3071 |
</varlistentry>
|
|
3072 |
|
|
3073 |
<varlistentry>
|
|
3074 |
<term><option>-v</option>, <option>--verbose</option></term>
|
|
3075 |
|
2685 | 3076 |
<listitem>
|
2686 | 3077 |
<para>Print additional information.</para>
|
2687 | 3078 |
</listitem>
|
2688 | 3079 |
</varlistentry>
|
2689 | 3080 |
|
2690 | 3081 |
<varlistentry>
|
2691 | |
<term><option>-V</option>,
|
2692 | |
<option>--version</option></term>
|
|
3082 |
<term><option>-V</option>, <option>--version</option></term>
|
|
3083 |
|
2693 | 3084 |
<listitem>
|
2694 | 3085 |
<para>Print version information end exit.</para>
|
2695 | 3086 |
</listitem>
|
|
2697 | 3088 |
|
2698 | 3089 |
<varlistentry>
|
2699 | 3090 |
<term><option>-W <replaceable>rpc-id</replaceable></option></term>
|
|
3091 |
|
2700 | 3092 |
<listitem>
|
2701 | 3093 |
<para>ignored - <application>xjremote</application> can be used
|
2702 | |
as a drop in replacement for <command>xjadeo -W ..</command>.
|
2703 | |
</para>
|
2704 | |
</listitem>
|
2705 | |
</varlistentry>
|
2706 | |
|
|
3094 |
as a drop in replacement for <command>xjadeo -W
|
|
3095 |
..</command>.</para>
|
|
3096 |
</listitem>
|
|
3097 |
</varlistentry>
|
2707 | 3098 |
</variablelist>
|
2708 | |
|
2709 | 3099 |
</refsect1>
|
2710 | 3100 |
|
2711 | 3101 |
<refsect1>
|
2712 | 3102 |
<title>ENVIRONMENT</title>
|
2713 | 3103 |
|
2714 | 3104 |
<para>If the <option>XJADEO</option> variable is set,
|
2715 | |
<application>xjremote</application> will assume that it holds the
|
2716 | |
path to the <application>xjadeo</application> executable.</para>
|
|
3105 |
<application>xjremote</application> will assume that it holds the path
|
|
3106 |
to the <application>Xjadeo</application> executable.</para>
|
2717 | 3107 |
</refsect1>
|
2718 | 3108 |
|
2719 | 3109 |
<refsect1>
|
2720 | 3110 |
<title>Note</title>
|
2721 | |
<para>Apart from Standard-I/O, <application>xjadeo</application> can
|
2722 | |
either use POSIX real-time message-queues (MQ) or System-V IPC
|
2723 | |
communication.
|
2724 | |
The decision is made when compiling it. Basically GNU/Linux uses MQ
|
2725 | |
(but could use IPC as well).
|
2726 | |
OSX only supports IPC and Windows is limited to standard-I/O only.
|
2727 | |
</para>
|
|
3111 |
|
|
3112 |
<para>Apart from Standard-I/O, <application>Xjadeo</application> can
|
|
3113 |
either use POSIX real-time message-queues (MQ) or System-V IPC
|
|
3114 |
communication. The decision is made when compiling it. Basically
|
|
3115 |
GNU/Linux uses MQ (but could use IPC as well). OSX only supports IPC
|
|
3116 |
and Windows is limited to standard-I/O only.</para>
|
2728 | 3117 |
</refsect1>
|
2729 | 3118 |
|
2730 | 3119 |
<refsect1>
|
2731 | 3120 |
<title>SEE ALSO</title>
|
2732 | |
<para><xref linkend="xjadeo"/></para>
|
2733 | |
<para><xref linkend="qjadeo"/></para>
|
|
3121 |
|
|
3122 |
<para><xref linkend="xjadeo"/></para>
|
|
3123 |
|
|
3124 |
<para><xref linkend="qjadeo"/></para>
|
2734 | 3125 |
</refsect1>
|
2735 | |
|
2736 | 3126 |
</refentry>
|
2737 | |
|
2738 | 3127 |
|
2739 | 3128 |
<refentry id="xjinfo">
|
2740 | 3129 |
<refmeta>
|
2741 | 3130 |
<refentrytitle>xjinfo</refentrytitle>
|
2742 | |
<manvolnum>1</manvolnum>
|
|
3131 |
|
|
3132 |
<manvolnum>1</manvolnum>
|
|
3133 |
|
2743 | 3134 |
<refmiscinfo class="source">http://xjadeo.sf.net</refmiscinfo>
|
|
3135 |
|
2744 | 3136 |
<refmiscinfo class="version">0.6.X</refmiscinfo>
|
2745 | 3137 |
</refmeta>
|
2746 | 3138 |
|
|
2753 | 3145 |
<refsynopsisdiv>
|
2754 | 3146 |
<cmdsynopsis>
|
2755 | 3147 |
<command>xjinfo</command>
|
|
3148 |
|
2756 | 3149 |
<arg choice="opt">-chtvVx</arg>
|
|
3150 |
|
2757 | 3151 |
<arg choice="plain"><replaceable>videofile</replaceable></arg>
|
2758 | 3152 |
</cmdsynopsis>
|
2759 | 3153 |
</refsynopsisdiv>
|
|
2762 | 3156 |
<title>DESCRIPTION</title>
|
2763 | 3157 |
|
2764 | 3158 |
<para><application>xjinfo</application> does basically the same as
|
2765 | |
<command>ffprobe</command> but displays the information in
|
2766 | |
XML or simple text format that can be used for scripting.</para>
|
2767 | |
|
|
3159 |
<command>ffprobe</command> but displays the information in XML or
|
|
3160 |
simple text format that can be used for scripting.</para>
|
2768 | 3161 |
</refsect1>
|
2769 | 3162 |
|
2770 | 3163 |
<refsect1>
|
|
2772 | 3165 |
|
2773 | 3166 |
<variablelist>
|
2774 | 3167 |
<varlistentry>
|
2775 | |
<term><option>-c</option>,
|
2776 | |
<option>--csv</option></term>
|
|
3168 |
<term><option>-c</option>, <option>--csv</option></term>
|
|
3169 |
|
2777 | 3170 |
<listitem>
|
2778 | 3171 |
<para>comma separated values, one line per video stream in file.
|
2779 | |
Use the built-in help <option>-h</option> to learn about the
|
2780 | |
format.</para>
|
2781 | |
</listitem>
|
2782 | |
</varlistentry>
|
2783 | |
<varlistentry>
|
2784 | |
<term><option>-h</option>,
|
2785 | |
<option>-h, --help</option></term>
|
|
3172 |
Use the built-in help <option>-h</option> to learn about the
|
|
3173 |
format.</para>
|
|
3174 |
</listitem>
|
|
3175 |
</varlistentry>
|
|
3176 |
|
|
3177 |
<varlistentry>
|
|
3178 |
<term><option>-h</option>, <option>-h, --help</option></term>
|
|
3179 |
|
2786 | 3180 |
<listitem>
|
2787 | 3181 |
<para>Print usage help and exit.</para>
|
2788 | 3182 |
</listitem>
|
2789 | 3183 |
</varlistentry>
|
2790 | |
<varlistentry>
|
2791 | |
<term><option>-t</option>,
|
2792 | |
<option>--time</option>,
|
|
3184 |
|
|
3185 |
<varlistentry>
|
|
3186 |
<term><option>-t</option>, <option>--time</option>,
|
2793 | 3187 |
<option>--duration</option></term>
|
2794 | |
<listitem>
|
2795 | |
<para>print the duration in seconds (without trailing newline)
|
2796 | |
</para>
|
2797 | |
</listitem>
|
2798 | |
</varlistentry>
|
2799 | |
<varlistentry>
|
2800 | |
<term><option>-v</option>,
|
2801 | |
<option>--text</option></term>
|
2802 | |
<listitem>
|
2803 | |
<para>print a single line: duration, fps, geometry and codec info.
|
2804 | |
</para>
|
2805 | |
</listitem>
|
2806 | |
</varlistentry>
|
2807 | |
<varlistentry>
|
2808 | |
<term><option>-x</option>,
|
2809 | |
<option>--xml</option></term>
|
2810 | |
<listitem>
|
2811 | |
<para>output XML data. This is the default if no
|
2812 | |
option is specified.</para>
|
2813 | |
<para>A DTD is available with the source or from
|
2814 | |
<ulink url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=src/xjadeo/avinfo.dtd">xjadeo.sf.net</ulink>
|
2815 | |
</para>
|
|
3188 |
|
|
3189 |
<listitem>
|
|
3190 |
<para>print the duration in seconds (without trailing
|
|
3191 |
newline)</para>
|
|
3192 |
</listitem>
|
|
3193 |
</varlistentry>
|
|
3194 |
|
|
3195 |
<varlistentry>
|
|
3196 |
<term><option>-v</option>, <option>--text</option></term>
|
|
3197 |
|
|
3198 |
<listitem>
|
|
3199 |
<para>print a single line: duration, fps, geometry and codec
|
|
3200 |
info.</para>
|
|
3201 |
</listitem>
|
|
3202 |
</varlistentry>
|
|
3203 |
|
|
3204 |
<varlistentry>
|
|
3205 |
<term><option>-x</option>, <option>--xml</option></term>
|
|
3206 |
|
|
3207 |
<listitem>
|
|
3208 |
<para>output XML data. This is the default if no option is
|
|
3209 |
specified.</para>
|
|
3210 |
|
|
3211 |
<para>A DTD is available with the source or from <ulink url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=src/xjadeo/avinfo.dtd">xjadeo.sf.net</ulink></para>
|
2816 | 3212 |
</listitem>
|
2817 | 3213 |
</varlistentry>
|
2818 | 3214 |
</variablelist>
|
|
2820 | 3216 |
|
2821 | 3217 |
<refsect1>
|
2822 | 3218 |
<title>SEE ALSO</title>
|
2823 | |
<para><xref linkend="xjadeo"/></para>
|
|
3219 |
|
|
3220 |
<para><xref linkend="xjadeo"/></para>
|
2824 | 3221 |
</refsect1>
|
2825 | 3222 |
</refentry>
|
2826 | 3223 |
</appendix>
|
2827 | 3224 |
</article>
|
2828 | |
<!-- vim: set fenc=utf-8 sts=2 sw=2 ts=8 et spell spelllang=en_us : -->
|
2829 | |
<!-- :syn spell toplevel -->
|
|
3225 |
<!-- vim: set fenc=utf-8 sts=2 sw=2 ts=8 et spell spelllang=en_us : -->
|
|
3226 |
<!-- :syn spell toplevel -->
|