Codebase list xjadeo / upstream/0.6.0_rc7
Imported Upstream version 0.6.0~rc7 Alessio Treglia 13 years ago
22 changed file(s) with 2464 addition(s) and 1471 deletion(s). Raw diff Collapse all Expand all
00 Luis Garrido <luisgarrido@users.sourceforge.net>
11 Robin Gareus <robin@gareus.org>
2
3 Translations:
4 * French: R. Doursenaud
5 * Russion: Alexandre Prokoudine
238238 /* #undef TTFFONTFILE */
239239
240240 /* Version number of package */
241 #define VERSION "0.6.0-rc6"
241 #define VERSION "0.6.0-rc7"
242242
243243 /* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most
244244 significant byte first (like Motorola and SPARC, unlike Intel). */
25902590
25912591 VERSION_MAJOR=0
25922592 VERSION_MINOR=6
2593 VERSION_SUB=0-rc6
2593 VERSION_SUB=0-rc7
25942594
25952595 am__api_version='1.11'
25962596
77
88 VERSION_MAJOR=0
99 VERSION_MINOR=6
10 VERSION_SUB=0-rc6
10 VERSION_SUB=0-rc7
1111
1212 dnl Every other copy of the package version number gets its value from here
1313 AM_INIT_AUTOMAKE(xjadeo, [${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_SUB}])
2424 (cd html; xsltproc --encoding UTF-8 ../html.xsl ../xjadeo.xml)
2525 cp -f style.css favicon.ico html/
2626 cp -f xjadeo.png html/
27 cp -f qjadeo.png html/
2728
2829 man: validate
2930 xsltproc --encoding UTF-8 man.xsl xjadeo.xml
3435 .PHONY: xjadeo.ps xjadeo.pdf
3536
3637 xjadeo.ps: xjadeo.xml
37 jw -f docbook -b ps xjadeo.xml
38 dblatex -tps -T native \
39 -P newtbl.autowidth=default \
40 -P latex.hyperparam=colorlinks,linkcolor=blue \
41 -P doc.collab.show=0 \
42 -P latex.output.revhistory=0 \
43 -P make.year.ranges=1 \
44 -P doc.lot.show="" \
45 xjadeo.xml
3846
3947 xjadeo.pdf: xjadeo.xml
40 jw -f docbook -b pdf xjadeo.xml
48 dblatex -T native \
49 -P newtbl.autowidth=default \
50 -P latex.hyperparam=colorlinks,linkcolor=blue \
51 -P doc.collab.show=0 \
52 -P latex.output.revhistory=0 \
53 -P make.year.ranges=1 \
54 -P doc.lot.show="" \
55 xjadeo.xml
1010
1111 <xsl:variable name="toc.max.depth">2</xsl:variable>
1212 <xsl:variable name="html.stylesheet">style.css</xsl:variable>
13 <xsl:param name="generate.revhistory.link" select="1"></xsl:param>
14 <xsl:param name="make.year.ranges" select="1"></xsl:param>
15 <xsl:param name="chunk.first.sections" select="1"></xsl:param>
1316 <xsl:template name="user.head.content"><link rel="shortcut icon" href="favicon.ico"/></xsl:template>
1417 <!--<xsl:variable name="admon.graphics">0</xsl:variable>-->
1518 <!--<xsl:variable name="chunk.section.depth">1</xsl:variable>-->
11 .\" Title: qjadeo
22 .\" Author: Robin Gareus <robin@gareus.org>
33 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
4 .\" Date: 11/05/2010
4 .\" Date: 11/24/2010
55 .\" Manual: Manual Pages
66 .\" Source: http://xjadeo.sf.net 0.6.X
77 .\" Language: English
88 .\"
9 .TH "QJADEO" "1" "11/05/2010" "http://xjadeo\&.sf\&.net 0\&.6" "Manual Pages"
9 .TH "QJADEO" "1" "11/24/2010" "http://xjadeo\&.sf\&.net 0\&.6" "Manual Pages"
1010 .\" -----------------------------------------------------------------
1111 .\" * Define some portability stuff
1212 .\" -----------------------------------------------------------------
3333 \fBqjadeo\fR
3434 .SH "DESCRIPTION"
3535 .PP
36 xjadeo
36 Xjadeo
3737 is a software video player that displays a video\-clip in sync with an external time source (MTC, LTC, JACK\-transport)\&.
3838 .PP
3939 \fBqjadeo\fR
40 is a graphical front\-end to xjadeo\&. It communicates with xjadeo either directly (single session) or using
40 is a graphical front\-end to
41 Xjadeo\&. It communicates with
42 Xjadeo
43 either directly (single session) or using
4144 \fBxjremote\fR\&.
4245 .SH "ENVIRONMENT"
4346 .PP
5356 xjadeo(1)
5457 .PP
5558 xjremote(1)
56 .SH "AUTHOR"
59 .SH "AUTHORS"
5760 .PP
5861 \fBRobin Gareus\fR <\&robin@gareus.org\&>
5962 .RS 4
6063 linuxaudio.org
6164 .RE
65 .PP
66 \fBLuis Garrido\fR <\&luisgarrido@users.sourceforge.net\&>
67 .RS 4
68 luisgarrido.users.sourceforge.net
69 .RE
6270 .SH "COPYRIGHT"
6371 .br
6472 Copyright \(co 2005, 2006, 2007, 2009, 2010 Robin Gareus, Luis Garrido
11 .\" Title: xjadeo
22 .\" Author: Robin Gareus <robin@gareus.org>
33 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
4 .\" Date: 11/05/2010
4 .\" Date: 11/24/2010
55 .\" Manual: Manual Pages
66 .\" Source: http://xjadeo.sf.net 0.6.X
77 .\" Language: English
88 .\"
9 .TH "XJADEO" "1" "11/05/2010" "http://xjadeo\&.sf\&.net 0\&.6" "Manual Pages"
9 .TH "XJADEO" "1" "11/24/2010" "http://xjadeo\&.sf\&.net 0\&.6" "Manual Pages"
1010 .\" -----------------------------------------------------------------
1111 .\" * Define some portability stuff
1212 .\" -----------------------------------------------------------------
3737 \fBxjadeo\fR \-Q [options] [\fI<videofile>\fR]
3838 .SH "DESCRIPTION"
3939 .PP
40 xjadeo
40 Xjadeo
4141 is a software video player that displays a video\-clip in sync with an external time source (MTC, LTC, JACK\-transport)\&.
4242 .PP
43 It has applications in soundtrack composition, video monitoring or any task that requires to associate movie frames with audio events\&.
44 .PP
45 xjadeo
43 It has applications in soundtrack composition, video monitoring or any task that requires synchronizing movie frames with audio events\&.
44 .PP
45 Xjadeo
4646 supports different video file formats, video output libraries and sync sources\&.
4747 .SH "OPTIONS"
4848 .PP
4949 \fB\-a\fR, \fB\-\-ontop\fR
5050 .RS 4
51 Start xjadeo always\-on\-top of other windows (this option requires support from window\-manager)\&.
51 Start
52 Xjadeo
53 \*(Aqalways\-on\-top\*(Aq of other windows (this option requires support from your window manager)\&.
5254 .RE
5355 .PP
5456 \fB\-A\fR, \fB\-\-avverbose\fR
6668 Do not use MIDI quarter\-frames for more exact sync\&.
6769 .RE
6870 .PP
69 \fB\-C, \-\-midiclk\fR, \fB\-\-midiclk\fR
71 \fB\-c\fR, \fB\-\-midiclk\fR
7072 .RS 4
7173 Use MIDI quarter\-frame timing for more exact sync (this is enabled by default since version 0\&.4\&.11)\&.
7274 .RE
8789 .RS 4
8890 Desired refresh\-rate of the video display in frames per second\&. Non\-integer values are possible\&. Default: \-1\&.
8991 .sp
90 If this value is set to zero (or less), xjadeo will use the FPS of the video\-file as its screen update frequency\&.
92 If this value is set to zero (or less),
93 Xjadeo
94 will use the FPS of the video\-file as its screen update frequency\&.
9195 .RE
9296 .PP
9397 \fB\-F \fR\fB\fI<n>\fR\fR, \fB\-\-filefps \fR\fB\fI<n>\fR\fR
129133 .PP
130134 \fB\-I\fR, \fB\-\-ignorefileoffset\fR
131135 .RS 4
132 This option is only useful for video files that with a start\-offset, such as split vob files\&. Per default xjadeo will honor offsets specified in the video\-file header and the file\*(Aqs PTS/DTS\&.
136 This option is only useful for video files with a start\-offset, such as split vob files\&. Per default
137 Xjadeo
138 will honor offsets specified in the video\-file header and the file\*(Aqs PTS/DTS\&.
133139 \fB\-I\fR
134 allows to override and subtract this offset and makes the file start at SMPTE position 00:00:00:00\&. (although you can archive the same result, this option is not related to
140 allows you to override and subtract this offset and makes the file start at SMPTE position 00:00:00:00 (although you can archive the same result, this option is not related to
135141 \fB\-o\fR\&.)
136142 .RE
137143 .PP
148154 .PP
149155 \fB\-K\fR, \fB\-\-continuous \fR
150156 .RS 4
151 Decode video frame by frame starting from previous key\-frame\&. This particularly useful to read files where not every frame is a key\-frame at cost of increased CPU usage\&. Note that this option adds some extra latency when seeking\&. Combine with
152 \fB\-f \-1\fR: It makes sense to set
153 xjadeo\*(Aqs screen\-update frequency to match the frame\-rate of the video file\&.
157 Decode video frame by frame starting from previous key\-frame\&. This particularly useful for reading files where not every frame is a key\-frame at the cost of increased CPU usage\&. Note that this option adds some extra latency when seeking\&. Combine it with
158 \fB\-f \-1\fR: it makes sense to set
159 Xjadeo\*(Aqs screen\-update frequency to match the frame\-rate of the video file\&.
154160 .RE
155161 .PP
156162 \fB\-l\fR, \fB\-\-ltc\fR
174180 If using ALSA MIDI back\-end,
175181 \fI<midi\-port>\fR
176182 is the ALSA sequencer\-id to be used as the MTC source\&. A value of \-1 will leave
177 xjadeo
183 Xjadeo
178184 unconnected\&.
179185 .sp
180186 If using portmidi,
206212 .PP
207213 \fB\-n\fR, \fB\-\-nodropframes\fR
208214 .RS 4
209 Prevent xjadeo from detecting drop\-frame\-timecode (usually files with 29\&.97 fps)
215 Prevent
216 Xjadeo
217 from detecting drop\-frame\-timecode (usually files with 29\&.97 fps)
210218 .RE
211219 .PP
212220 \fB\-N\fR, \fB\-\-dropframes\fR
213221 .RS 4
214 Force xjadeo to use drop\-frame\-timecode (drop\-frame\-timecode is only valid for files with 29\&.97 fps but your milage may vary)
222 Force
223 Xjadeo
224 to use drop\-frame\-timecode (drop\-frame\-timecode is only valid for files with 29\&.97 fps but your milage may vary)
215225 .RE
216226 .PP
217227 \fB\-o \fR\fB\fI<n>\fR\fR, \fB\-\-offset \fR\fB\fI<n>\fR\fR
218228 .RS 4
219 Offset the video a certain number of (video) frames relative to the sync master time base\&. Admits negative values\&.
229 Offset the video playback a certain number of (video) frames relative to the sync master time base\&. Admits negative values\&.
220230 \fI<n>\fR
221231 can be specified either as integer frame\-number or SMPTE text\&.
222232 .RE
253263 \fB\-s\fR, \fB\-\-fullscreen\fR
254264 .RS 4
255265 Start
256 xjadeo
266 Xjadeo
257267 in full\-screen mode\&.
258268 .RE
259269 .PP
265275 \fB\-t\fR, \fB\-\-try\-codec\fR
266276 .RS 4
267277 Check if the video file is encoded in a format suitable for use with
268 xjadeo
278 Xjadeo
269279 and exit\&. If the video format is not supported the exit code is 1\&.
270280 .RE
271281 .PP
291301 .RS 4
292302 Selects the video output driver\&. Defaults to
293303 \fB0\fR
294 (auto\-detect)\&. A value of \-1 lists the available modes and exit\&.
304 (auto\-detect)\&. A value of \-1 lists the available modes and exits\&.
295305 .RE
296306 .SH "SYNC SOURCES"
297307 .PP
365375 .RE
366376 .SH "VIDEO FORMATS"
367377 .PP
368 xjadeo
378 Xjadeo
369379 uses ffmpeg to decode video files, so a wide range of formats and codecs are supported\&. Note, however, that not all the formats support seeking\&. To transcode a video\-file into a suitable format we recommend:
370380 .sp
371381 .if n \{\
378388 .RE
379389 .\}
380390 .sp
381 This creates from your input\-file\&.xxx an AVI mpeg4 encoded video file with no sound, an index (\-idx) and no compression between frames (every frame is a keyframe)\&. The file thus can become really BIG, so watch your disk space\&.
382 .PP
383 You may want to shrink the size by scaling the geometry of the video\-frames, which also taxes less system resources while displaying it and leaves more space in the screen for your audio software\&.\&.
391 This creates from your input\-file\&.xxx an AVI mpeg4 encoded video file with no sound, an index (\-idx) and no compression between frames (every frame is a keyframe)\&. The file thus can become really BIG, so watch your disk space!
392 .PP
393 You may want also to shrink the size of the file\*(Aqs video frames by scaling down its geometry\&. This uses fewer system resources while decoding and displaying it and leaves more space in the screen for your audio software\&.
384394 .sp
385395 .if n \{\
386396 .RS 4
405415 .br
406416 .PP
407417 Also note
408 xjadeo\*(Aqs
418 Xjadeo\*(Aqs
409419 \fB\-K\fR
410420 option which allows to seek to frames other than key\-frames and enables
411 xjadeo
412 to play back any file without transcoding at\&. It comes with the expense of increased CPU usage and possibly increased seek latency\&. The latter depends on the key\-frame interval and video\-codec)
421 Xjadeo
422 to play back any file without transcoding it\&. It comes at the expense of increased CPU usage and possibly increased seek latency\&. The latter depends on the key\-frame interval and video\-codec\&.
413423 .PP
414424 The same can be achieved by adding
415425 \fBseek=continuously\fR
463473 .sp -1
464474 .IP \(bu 2.3
465475 .\}
466 xjadeo ≥ v0\&.3\&.8 supports keyboard events\&. Pressing
476 Xjadeo
477 ≥ v0\&.3\&.8 supports keyboard events\&. Pressing
467478 Esc
468479 and
469480 q
505516 \fB\-R\fR
506517 or
507518 \fB\-\-remote\fR)
508 xjadeo
519 Xjadeo
509520 will interactively accept commands and issue responses through its standard input/output mechanism\&.
510521 .PP
511522 Use the remote command
518529 to connect\&.
519530 .SH "FILES"
520531 .PP
521 xjadeo reads the following resource configuration files in this order:
532 Xjadeo
533 reads the following resource configuration files in this order:
522534 .sp
523535 .RS 4
524536 .ie n \{\
605617 xjinfo(1)
606618 .PP
607619 \m[blue]\fBonline\-manual\fR\m[]\&\s-2\u[2]\d\s+2
608 .SH "AUTHOR"
620 .SH "AUTHORS"
609621 .PP
610622 \fBRobin Gareus\fR <\&robin@gareus.org\&>
611623 .RS 4
612624 linuxaudio.org
625 .RE
626 .PP
627 \fBLuis Garrido\fR <\&luisgarrido@users.sourceforge.net\&>
628 .RS 4
629 luisgarrido.users.sourceforge.net
613630 .RE
614631 .SH "COPYRIGHT"
615632 .br
00 <?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">
32 <article lang="en">
43 <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
78 <copyright>
89 <year>2005</year>
10
911 <year>2006</year>
12
1013 <year>2007</year>
14
1115 <year>2009</year>
16
1217 <year>2010</year>
18
1319 <holder>Robin Gareus, Luis Garrido</holder>
1420 </copyright>
15
21
1622 <author>
1723 <firstname>Robin</firstname>
24
1825 <surname>Gareus</surname>
26
1927 <email>robin@gareus.org</email>
28
2029 <personblurb>
2130 <para>linuxaudio.org</para>
2231 </personblurb>
2332 </author>
2433
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
2544 <abstract>
26 <para>
27 <mediaobject>
45 <para><mediaobject>
2846 <imageobject>
29 <imagedata fileref="xjadeo.png" align="center" valign="top"/>
47 <imagedata align="center" fileref="xjadeo.eps" valign="top" format="EPS"/>
3048 </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 &nbsp;&nbsp;&nbsp;
57 <ulink
58 url="http://sourceforge.net/projects/xjadeo/files/">Download</ulink>
59 &nbsp;&nbsp;&nbsp;
60 <ulink
61 url="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo"
62 >Source-Code</ulink>
63 &nbsp;&nbsp;&nbsp;
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>
6876 </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>
6987 </articleinfo>
7088
71 <!-- CHAPTER -->
89 <!-- CHAPTER -->
7290
7391 <section id="about">
7492 <title>About</title>
93
7594 <section id="features">
7695 <title>FEATURES</title>
77 <para><application>xjadeo</application> - video Monitor </para>
96
97 <para><application>Xjadeo</application> - video Monitor</para>
7898
7999 <itemizedlist>
80100 <listitem>
81101 <para>Display: full-screen or windowed mode, letterbox, timecode
82 on-screen-display.
83 <itemizedlist>
102 on-screen-display. <itemizedlist>
84103 <listitem>
85104 <para>XV/X11 (hardware accelerated)</para>
86105 </listitem>
96115 <listitem>
97116 <para>carbon/quartz (hardware accelerated - OSX)</para>
98117 </listitem>
99 </itemizedlist>
100 </para>
118 </itemizedlist></para>
101119 </listitem>
102120
103121 <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>
109125 </listitem>
110126
111127 <listitem>
112128 <para>Sync sources:<itemizedlist>
113129 <listitem>
114130 <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>
116132 </listitem>
133
117134 <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>
121137 </listitem>
138
122139 <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>
126142 </listitem>
127143 </itemizedlist></para>
128 </listitem>
144 </listitem>
129145
130146 <listitem>
131147 <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>
133149 </listitem>
134150
135151 <listitem>
137153 </listitem>
138154
139155 <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>
151174 </listitem>
152175
153176 <listitem>
154177 <para>Optional Qt Graphical User interface to control
155 <application>xjadeo</application>.</para>
178 <application>Xjadeo</application>.</para>
156179 </listitem>
157
158180 </itemizedlist>
159181 </section>
160182
161183 <section id="license">
162184 <title>LICENSE</title>
163185
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>
173195
174196 <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>
177199 </section>
178
179200 </section>
180201
181 <!-- CHAPTER -->
202 <!-- CHAPTER -->
182203
183204 <section id="build_instructions" xreflabel="Build and Install Instructions">
184205 <title>Build and Install Instructions</title>
185206
186207 <section id="system_requirements">
187208 <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>
191213 </section>
192214
193215 <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>
212229 </section>
213230
214 <section id="src" xreflabel="source">
231 <section id="src" xreflabel="source">
215232 <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&amp;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&amp;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>
228241 </section>
229242
230243 <section id="build_depends" xreflabel="build dependencies">
231244 <title>Build Dependencies</title>
232245
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
243254 <listitem>
244255 <para><ulink url="http://ffmpeg.org/">ffmpeg</ulink> (libavcodec,
245 libavformat, libavutil, libswscale)</para>
256 libavformat, libavutil, libswscale)</para>
257
246258 <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>
257267 <listitem>
258268 <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
265276 <listitem>
266277 <para><ulink url="http://www.libsdl.org">SDL 1.2</ulink></para>
267278 </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>
275283 <listitem>
276284 <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
279288 <listitem>
280289 <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
291303 <listitem>
292304 <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 &ge; 2.3.2) - remote-control via POSIX message queue
304 (requires kernel support - Linux &ge; 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> &ge; 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>
336346 </section>
337347
338348 <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>
344353 cd xjadeo/
345 ./autogen.sh</screen>
346 </para>
354 ./autogen.sh</screen></para>
347355
348356 <para>Once you have all the build-dependencies the usual spells apply:
349357 <screen>
350358 ./configure
351359 make
352 make install # (requires root privileges) </screen>
353 </para>
360 make install # (requires root privileges) </screen></para>
354361
355362 <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>
361366 <varlistentry>
362367 <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>
366372 </listitem>
367373 </varlistentry>
368374
369375 <varlistentry>
370376 <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>
374381 </listitem>
375382 </varlistentry>
376383
377384 <varlistentry>
378385 <term><option>--enable-lash</option></term>
386
379387 <listitem>
380388 <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>
384392 </listitem>
385393 </varlistentry>
386394
387395 <varlistentry>
388396 <term><option>--disable-qtgui</option></term>
397
389398 <listitem>
390399 <para>Do not build the QT Graphical User Interface.</para>
391400 </listitem>
394403 </section>
395404 </section>
396405
397 <!-- CHAPTER -->
406 <!-- CHAPTER -->
398407
399408 <section id="usage" xreflabel="xjadeo usage section">
400 <title>Using xjadeo</title>
409 <title>Using <application>Xjadeo</application></title>
401410
402411 <section id="quickstart">
403412 <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>
410420
411421 <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>
415424
416425 <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>
423432 </section>
424433
425434 <section id="video_formats">
426435 <title>Video Formats</title>
427436
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>
448454
449455 <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>
459466
460467 <screen>-vf scale=width:height</screen>
461468
462469 <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>
465472
466473 <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
473481 <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>
476484 </important>
477485 </section>
478486
479487 <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.
502579 </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>).
524660 </para>
525661 </section>
526662
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
565663 <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>
571669
572670 <section id="remote_control_interaction">
573671 <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>
577675 </section>
578676
579677 <section id="x_window_interaction">
580678 <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
584685 <table frame="all" tabstyle="tbl">
585686 <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
590701 <tbody>
591702 <row>
592703 <entry><keycap>Esc</keycap></entry>
593 <entry><para>Terminate xjadeo.</para></entry>
704
705 <entry><para>Terminate <application>Xjadeo</application>.</para></entry>
594706 </row>
707
595708 <row>
596709 <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>
599713 </row>
714
600715 <row>
601716 <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>
604720 </row>
721
605722 <row>
606723 <entry><keycap>A</keycap></entry>
724
607725 <entry><para>Toggle window always-on-top.</para></entry>
608726 </row>
727
609728 <row>
610729 <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>
612733 </row>
734
613735 <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>
616744 </row>
745
617746 <row>
618747 <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>
621751 </row>
752
622753 <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>
625762 </row>
763
626764 <row>
627765 <entry><keycap>F</keycap></entry>
766
628767 <entry><para>Toggle full-screen mode.</para></entry>
629768 </row>
769
630770 <row>
631771 <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>
633775 </row>
776
634777 <row>
635778 <entry><keycap>M</keycap></entry>
779
636780 <entry><para>Toggle mouse pointer visibility.</para></entry>
637781 </row>
782
638783 <row>
639784 <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>
641788 </row>
789
642790 <row>
643791 <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>
645795 </row>
796
646797 <row>
647798 <entry><keycap>S</keycap></entry>
799
648800 <entry><para>Toggle OSD SMPTE display.</para></entry>
649801 </row>
802
650803 <row>
651804 <entry><keycap>V</keycap></entry>
805
652806 <entry><para>Toggle OSD frame-number display.</para></entry>
653807 </row>
808
654809 <row>
655810 <entry><keycap>&lt;</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>
657814 </row>
815
658816 <row>
659817 <entry><keycap>&gt;</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>
661821 </row>
822
662823 <row>
663824 <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>
665828 </row>
829
666830 <row>
667831 <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>
669835 </row>
836
670837 <row>
671838 <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>
673842 </row>
843
674844 <row>
675845 <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>
677849 </row>
850
678851 <row>
679852 <entry><keycap>{</keycap></entry>
853
680854 <entry><para>Decrement A/V offset by 1 minute.</para></entry>
681855 </row>
856
682857 <row>
683858 <entry><keycap>}</keycap></entry>
859
684860 <entry><para>Increment A/V offset by 1 minute.</para></entry>
685861 </row>
862
686863 <row>
687864 <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>
695872 </row>
696 </tbody>
873 </tbody>
697874 </tgroup>
698875 </table>
699876 </section>
704881
705882 <section id="examples" xreflabel="example commandlines">
706883 <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.
711967 </para>
712968 </section>
713969
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>
769970 </section>
770971 </section>
771972
772 <!-- CHAPTER -->
973 <!-- CHAPTER -->
773974
774975 <section id="troubleshoot_and_support">
775976 <title>Troubleshoot &amp; Support</title>
977
776978 <section id="troubleshoot">
777979 <title>Troubleshoot</title>
778980
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>
780982
781983 <itemizedlist>
782984 <listitem>
783985 <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>
786988 </listitem>
989
787990 <listitem>
788991 <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>
794997 </listitem>
998
795999 <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>
8031002 </listitem>
8041003
8051004 <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>
8131009 </listitem>
8141010 </itemizedlist>
8151011 </section>
8191015
8201016 <para>Some Video codecs are known not to work properly on some systems.
8211017 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
8271022 out if it fails to connect or encounters a MIDI buffer overflow. This is
8281023 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>
8371031 Section "Extensions"
8381032 Option "Composite" "Disable"
8391033 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>
8491040 </section>
8501041 </section>
8511042
852 <!-- CHAPTER -->
1043 <!-- CHAPTER -->
8531044
8541045 <section id="remote_control_interface">
8551046 <title>Remote Control Interface</title>
8561047
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
8601051 <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
8621053 mechanism.</para>
8631054
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
8731063 message queues.</para>
8741064
8751065 <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>
8801070 </important>
8811071
8821072 <section id="rc_general">
8851075 <variablelist>
8861076 <varlistentry>
8871077 <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>
8911082 </listitem>
8921083 </varlistentry>
8931084
8941085 <varlistentry>
8951086 <term><option>quit</option></term>
1087
8961088 <listitem>
8971089 <para>exit qjadeo.</para>
8981090 </listitem>
9051097
9061098 <variablelist>
9071099 <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
9101102 <listitem>
9111103 <para>Load a video file, replacing any previous one.</para>
9121104 </listitem>
9141106
9151107 <varlistentry>
9161108 <term><option>unload</option></term>
1109
9171110 <listitem>
9181111 <para>Close the current video file.</para>
9191112 </listitem>
9211114
9221115 <varlistentry>
9231116 <term><option>get filename</option></term>
1117
9241118 <listitem>
9251119 <para>Returns the file name of the current movie.</para>
9261120 </listitem>
9281122
9291123 <varlistentry>
9301124 <term><option>get duration</option></term>
1125
9311126 <listitem>
9321127 <para>Returns the length of the movie in seconds.</para>
9331128 </listitem>
9351130
9361131 <varlistentry>
9371132 <term><option>get frames</option></term>
1133
9381134 <listitem>
9391135 <para>Returns the length of the movie in frames.</para>
9401136 </listitem>
9421138
9431139 <varlistentry>
9441140 <term><option>get frame-rate</option></term>
1141
9451142 <listitem>
9461143 <para>Returns the frame rate of the current movie.</para>
9471144 </listitem>
9491146
9501147 <varlistentry>
9511148 <term><option>get width</option></term>
1149
9521150 <listitem>
9531151 <para>Returns the width of the current movie in pixels.</para>
9541152 </listitem>
9561154
9571155 <varlistentry>
9581156 <term><option>get height</option></term>
1157
9591158 <listitem>
9601159 <para>Returns the height of the current movie in pixels.</para>
9611160 </listitem>
9631162
9641163 <varlistentry>
9651164 <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>
10001206 </listitem>
10011207 </varlistentry>
10021208 </variablelist>
10411247 <variablelist>
10421248 <varlistentry>
10431249 <term><option>ltc connect</option></term>
1250
10441251 <listitem>
10451252 <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>
10471254 </listitem>
10481255 </varlistentry>
10491256
10501257 <varlistentry>
10511258 <term><option>ltc disconnect</option></term>
1259
10521260 <listitem>
10531261 <para>Disconnect from JACK and disable LTC sync.</para>
10541262 </listitem>
10561264
10571265 <varlistentry>
10581266 <term><option>ltc status</option></term>
1267
10591268 <listitem>
10601269 <para>Display status of JACK/LTC connection.</para>
10611270 </listitem>
10691278 <variablelist>
10701279 <varlistentry>
10711280 <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 &lt;port&gt;</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 &lt;port&gt;</command> command.</para>
1287
10771288 <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
10871297 <listitem>
10881298 <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
10991308 <listitem>
11001309 <para>Get sync from MTC (MIDI Time Code) instead of JACK.</para>
11011310
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
11041312 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
11141320 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>
11161322 </listitem>
11171323 </varlistentry>
11181324
11191325 <varlistentry>
11201326 <term><option>midi disconnect </option></term>
1327
11211328 <listitem>
11221329 <para>Close MIDI device.</para>
11231330 </listitem>
11251332
11261333 <varlistentry>
11271334 <term><option>midi status </option></term>
1335
11281336 <listitem>
11291337 <para>Displays the status of the
1130 <application>xjadeo</application> MIDI port connection.</para>
1338 <application>Xjadeo</application> MIDI port connection.</para>
11311339 </listitem>
11321340 </varlistentry>
11331341
11341342 <varlistentry>
11351343 <term><option>get midisync </option></term>
1344
11361345 <listitem>
11371346 <para>Display MIDI SMPTE conversion mode, corresponding to -M
11381347 option.</para>
11401349 </varlistentry>
11411350
11421351 <varlistentry>
1143 <term><option>set midisync <replaceable>n</replaceable></option>
1144 </term>
1352 <term><option>set midisync
1353 <replaceable>n</replaceable></option></term>
1354
11451355 <listitem>
11461356 <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>
11491359 </listitem>
11501360 </varlistentry>
11511361 </variablelist>
11521362 </section>
11531363
11541364 <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>
11561366
11571367 <variablelist>
11581368 <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>
11641374 </listitem>
11651375 </varlistentry>
11661376
11671377 <varlistentry>
11681378 <term><option>get position</option></term>
1379
11691380 <listitem>
11701381 <para>Returns the current frame number.</para>
11711382 </listitem>
11731384
11741385 <varlistentry>
11751386 <term><option>get smpte</option></term>
1387
11761388 <listitem>
11771389 <para>Returns the current head position in SMPTE code.</para>
11781390 </listitem>
11801392
11811393 <varlistentry>
11821394 <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>
11891400 </listitem>
11901401 </varlistentry>
11911402
11921403 <varlistentry>
11931404 <term><option>get fps</option></term>
1405
11941406 <listitem>
11951407 <para>Returns the current window update rate.</para>
11961408 </listitem>
11971409 </varlistentry>
11981410
11991411 <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
12021414 <listitem>
12031415 <para>Set the window update rate.</para>
12041416 </listitem>
12061418
12071419 <varlistentry>
12081420 <term><option>get offset</option></term>
1421
12091422 <listitem>
12101423 <para>Returns the current time offset in frames.</para>
12111424 </listitem>
12121425 </varlistentry>
12131426
12141427 <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
12171430 <listitem>
12181431 <para>Set the time offset in frames.</para>
12191432 </listitem>
12361449
12371450 <varlistentry>
12381451 <term><option>window open</option></term>
1452
12391453 <listitem>
12401454 <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>
12431457 </listitem>
12441458 </varlistentry>
12451459
12461460 <varlistentry>
12471461 <term><option>window mode
1248 <replaceable>video-mode</replaceable></option></term>
1462 <replaceable>video-mode</replaceable></option></term>
1463
12491464 <listitem>
12501465 <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
12601475 <listitem>
12611476 <para>Resizes the monitor window. Value may either be a 2
1262 dimensional vector &lt;width&gt;x&lt;height&gt; 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 &lt;width&gt;x&lt;height&gt; 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
12711486 <listitem>
12721487 <para>Position the monitor window on the desktop. The value is
1273 expected to be: &lt;width&gt;x&lt;height&gt;</para>
1488 expected to be: &lt;width&gt;x&lt;height&gt;</para>
12741489 </listitem>
12751490 </varlistentry>
12761491
12771492 <varlistentry>
12781493 <term><option>get windowsize</option></term>
1494
12791495 <listitem>
12801496 <para>Prints the size of the video window in a 2D vector.
12811497 &lt;width&gt;x&lt;height&gt;</para>
12841500
12851501 <varlistentry>
12861502 <term><option>get videomode</option></term>
1503
12871504 <listitem>
12881505 <para>Returns the current video mode.</para>
12891506 </listitem>
12911508
12921509 <varlistentry>
12931510 <term><option>list videomodes</option></term>
1511
12941512 <listitem>
12951513 <para>Prints a list of available video modes.</para>
12961514 </listitem>
13041522 <variablelist>
13051523 <varlistentry>
13061524 <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>
13121531 </listitem>
13131532 </varlistentry>
13141533
13151534 <varlistentry>
13161535 <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>
13211541 </listitem>
13221542 </varlistentry>
13231543
13241544 <varlistentry>
13251545 <term><option>notify disable </option></term>
1546
13261547 <listitem>
13271548 <para>Stop generating notify messages.</para>
13281549 </listitem>
13321553
13331554 <section id="rc_osd">
13341555 <title>On Screen Display Commands</title>
1556
13351557 <variablelist>
13361558 <varlistentry>
13371559 <term><option>osd frame
1338 <replaceable>ypos</replaceable></option></term>
1560 <replaceable>ypos</replaceable></option></term>
1561
13391562 <listitem>
13401563 <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 &lt;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 &lt;0
1566 disables the frame display.</para>
13441567 </listitem>
13451568 </varlistentry>
13461569
13471570 <varlistentry>
13481571 <term><option>osd smpte
1349 <replaceable>ypos</replaceable></option></term>
1572 <replaceable>ypos</replaceable></option></term>
1573
13501574 <listitem>
13511575 <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 &lt;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 &lt;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>
13641588 </listitem>
13651589 </varlistentry>
13661590
13671591 <varlistentry>
13681592 <term><option>osd text </option></term>
1593
13691594 <listitem>
13701595 <para>Display the previously set OSD text again.</para>
13711596 </listitem>
13731598
13741599 <varlistentry>
13751600 <term><option>osd notext </option></term>
1601
13761602 <listitem>
13771603 <para>Turn off OSD text.</para>
13781604 </listitem>
13801606
13811607 <varlistentry>
13821608 <term><option>osd pos
1383 <replaceable>xalign</replaceable><replaceable>ypos</replaceable>
1609 <replaceable>xalign</replaceable><replaceable>ypos</replaceable>
13841610 </option></term>
1611
13851612 <listitem>
13861613 <para>Set the position of the OSD text</para>
1614
13871615 <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
13911619 <para><replaceable>ypos</replaceable> specifies the vertical
1392 position in percent (0..100).</para>
1620 position in percent (0..100).</para>
13931621 </listitem>
13941622 </varlistentry>
13951623
13961624 <varlistentry>
13971625 <term><option>osd available </option></term>
1626
13981627 <listitem>
13991628 <para>display if freetype support in available.</para>
14001629 </listitem>
14021631
14031632 <varlistentry>
14041633 <term><option>osd font
1405 <replaceable>font-filename</replaceable></option></term>
1634 <replaceable>font-filename</replaceable></option></term>
1635
14061636 <listitem>
14071637 <para>Specify a TrueType Font file to be used when rendering
1408 On-Screen-Display text.</para>
1638 On-Screen-Display text.</para>
14091639 </listitem>
14101640 </varlistentry>
14111641
14121642 <varlistentry>
14131643 <term><option>osd box </option></term>
1644
14141645 <listitem>
14151646 <para>draw a black box around the OSD</para>
14161647 </listitem>
14261657
14271658 <varlistentry>
14281659 <term><option>get osdcfg</option></term>
1660
14291661 <listitem>
14301662 <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 &nbsp;&nbsp;&nbsp;
1435 bit<literal>1</literal> (<literal>2</literal>): SMPTE timecode,
1436 &nbsp;&nbsp;&nbsp;
1437 bit<literal>2</literal> (<literal>4</literal>): Text,
1438 &nbsp;&nbsp;&nbsp;
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>
14411670 </listitem>
14421671 </varlistentry>
14431672 </variablelist>
14451674
14461675 <section id="response_format">
14471676 <title>Response Format</title>
1677
14481678 <para>Each remote command is acknowledged with a response, which you can
14491679 ignore at your option. It is intended to be both human readable and
14501680 machine parse-able. The response is a single line terminated with the
1451 newline character
1452 '\n' formatted as: <screen>@&lt;status-integer&gt; &lt;text&gt;</screen>
1681 newline character '\n' formatted as: <screen>@&lt;status-integer&gt; &lt;text&gt;</screen>
14531682 each line start with an @ followed by an integer that tells if the
14541683 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
14561686 <variablelist>
14571687 <varlistentry>
14581688 <term><option>1xx:</option></term>
1689
14591690 <listitem>
14601691 <para>OK. The command succeeded returning a small text info
1461 message.</para>
1692 message.</para>
14621693 </listitem>
14631694 </varlistentry>
14641695
14651696 <varlistentry>
14661697 <term><option>2xx:</option></term>
1698
14671699 <listitem>
14681700 <para>the command succeeded and the return text is in format
1469 <literal>name=value</literal></para>
1701 <literal>name=value</literal></para>
1702
14701703 <para>This is used for returning variables. 200-299 defines the
14711704 type of the value as follows:</para>
14721705
14731706 <variablelist>
14741707 <varlistentry>
14751708 <term><option>201:</option></term>
1709
14761710 <listitem>
14771711 <para>integer</para>
14781712 </listitem>
14801714
14811715 <varlistentry>
14821716 <term><option>202:</option></term>
1717
14831718 <listitem>
14841719 <para>double</para>
14851720 </listitem>
14871722
14881723 <varlistentry>
14891724 <term><option>210:</option></term>
1725
14901726 <listitem>
14911727 <para>Two dimensional vector &lt;int&gt;x&lt;int&gt;</para>
14921728 </listitem>
14941730
14951731 <varlistentry>
14961732 <term><option>220:</option></term>
1733
14971734 <listitem>
14981735 <para>string</para>
14991736 </listitem>
15011738
15021739 <varlistentry>
15031740 <term><option>228:</option></term>
1741
15041742 <listitem>
15051743 <para>SMPTE-string in format 'HH:MM:SS:FF'</para>
15061744 </listitem>
15111749
15121750 <varlistentry>
15131751 <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
15171756 identical to 2xx messages. Currently the only 3xx message is 301
15181757 position=integer.</para>
15191758 </listitem>
15211760
15221761 <varlistentry>
15231762 <term><option>4xx:</option></term>
1763
15241764 <listitem>
15251765 <para>Error message.</para>
15261766 </listitem>
15281768
15291769 <varlistentry>
15301770 <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>
15351776 </listitem>
15361777 </varlistentry>
15371778 </variablelist>
15381779 </section>
15391780 </section>
15401781
1541 <!-- CHAPTER -->
1782 <!-- CHAPTER -->
15421783
15431784 <section id="open_sound_control_interface">
15441785 <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
15631801 <table frame="all" tabstyle="tbl">
15641802 <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
15701813 <thead>
15711814 <row>
15721815 <entry>Address Pattern</entry>
1816
15731817 <entry>Type Tags</entry>
1818
15741819 <entry>Description - notes in brackes are corresponding remote-ctl
1575 commanands or commandline-options</entry>
1820 commands or commandline-options</entry>
15761821 </row>
15771822 </thead>
1823
15781824 <tbody>
15791825 <row>
15801826 <entry><literal>/jadeo/seek</literal></entry>
1827
15811828 <entry><literal>i</literal></entry>
1829
15821830 <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>
15871833 </row>
1834
15881835 <row>
15891836 <entry><literal>/jadeo/load</literal></entry>
1837
15901838 <entry><literal>s</literal></entry>
1839
15911840 <entry><para>Load a video file, replacing any previous one.
1592 (<literal>load filename</literal>)</para></entry>
1841 (<literal>load filename</literal>)</para></entry>
15931842 </row>
1843
15941844 <row>
15951845 <entry><literal>/jadeo/fps</literal></entry>
1846
15961847 <entry><literal>f</literal></entry>
1848
15971849 <entry><para>set the screen update frequency (<option>-f</option>,
1598 <literal>set fps</literal>)</para></entry>
1850 <literal>set fps</literal>)</para></entry>
15991851 </row>
1852
16001853 <row>
16011854 <entry><literal>/jadeo/framerate</literal></entry>
1855
16021856 <entry><literal>f</literal></entry>
1857
16031858 <entry><para>override video-files frame-rate (<option>-F</option>,
1604 <literal>set framerate</literal>)</para></entry>
1859 <literal>set framerate</literal>)</para></entry>
16051860 </row>
1861
16061862 <row>
16071863 <entry><literal>/jadeo/offset</literal></entry>
1864
16081865 <entry><literal>i</literal></entry>
1866
16091867 <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>
16111869 </row>
1870
16121871 <row>
16131872 <entry><literal>/jadeo/offset</literal></entry>
1873
16141874 <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>
16171878 </row>
1879
16181880 <row>
16191881 <entry><literal>/jadeo/jack/connect</literal></entry>
1620 <entry><literal></literal></entry>
1882
1883 <entry><literal/></entry>
1884
16211885 <entry><para>Connect to JACK and sync to JACK-transport
1622 (<literal>jack connect</literal>)</para></entry>
1886 (<literal>jack connect</literal>)</para></entry>
16231887 </row>
1888
16241889 <row>
16251890 <entry><literal>/jadeo/jack/disconnect</literal></entry>
1626 <entry><literal></literal></entry>
1891
1892 <entry><literal/></entry>
1893
16271894 <entry><para>Stop synchronization with JACK-transport
1628 (<literal>jack disconnect</literal>)</para></entry>
1895 (<literal>jack disconnect</literal>)</para></entry>
16291896 </row>
1897
16301898 <row>
16311899 <entry><literal>/jadeo/osd/font</literal></entry>
1900
16321901 <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>
16361906 </row>
1907
16371908 <row>
16381909 <entry><literal>/jadeo/osd/smtpe</literal></entry>
1910
16391911 <entry><literal>i</literal></entry>
1912
16401913 <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>
16441916 </row>
1917
16451918 <row>
16461919 <entry><literal>/jadeo/osd/frame</literal></entry>
1920
16471921 <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>
16521926 </row>
1927
16531928 <row>
16541929 <entry><literal>/jadeo/osd/box</literal></entry>
1930
16551931 <entry><literal>i</literal></entry>
1932
16561933 <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>
16601936 </row>
1937
16611938 <row>
16621939 <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>
16651944 </row>
16661945
16671946 <row>
16681947 <entry spanname="fw">The following commands are only available if
1669 MIDI is supported.</entry>
1948 MIDI is supported.</entry>
16701949 </row>
1950
16711951 <row>
16721952 <entry><literal>/jadeo/midi/connect</literal></entry>
1953
16731954 <entry><literal>s</literal></entry>
1955
16741956 <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>
16791960 </row>
1961
16801962 <row>
16811963 <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>
16851969 </row>
1970
16861971 <row>
16871972 <entry><literal>/jadeo/midi/quarterframes</literal></entry>
1973
16881974 <entry><literal>i</literal></entry>
1975
16891976 <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>
16921979 </row>
1980
16931981 <row>
16941982 <entry><literal>/jadeo/midi/clkconvert</literal></entry>
1983
16951984 <entry><literal>i</literal></entry>
1985
16961986 <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>
17021991 </row>
17031992
17041993 <row>
17051994 <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>
17081996 </row>
1997
17091998 <row>
17101999 <entry><literal>/jadeo/pan</literal></entry>
2000
17112001 <entry><literal>i</literal></entry>
1712 <entry><para>set the x-offset to the value given in pixels.
1713 0 &le; <replaceable>val</replaceable> &le;
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>
17152006 </row>
17162007
17172008 <row>
17182009 <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>
17212011 </row>
2012
17222013 <row>
17232014 <entry><literal>/jadeo/timescale</literal></entry>
2015
17242016 <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>
17272020 </row>
2021
17282022 <row>
17292023 <entry><literal>/jadeo/timescale</literal></entry>
2024
17302025 <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>
17332029 </row>
2030
17342031 <row>
17352032 <entry><literal>/jadeo/loop</literal></entry>
2033
17362034 <entry><literal>i</literal></entry>
2035
17372036 <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>
17412040 </row>
2041
17422042 <row>
17432043 <entry><literal>/jadeo/reverse</literal></entry>
1744 <entry><literal></literal></entry>
2044
2045 <entry><literal/></entry>
2046
17452047 <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>
17482050 </row>
1749
17502051 </tbody>
17512052 </tgroup>
17522053 </table>
17532054 </section>
17542055
1755
1756 <!-- CHAPTER -->
2056 <!-- CHAPTER -->
17572057
17582058 <section id="advanced_features">
17592059 <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
17642065 <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
17722078 <section>
17732079 <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>
17902099 </section>
2100
17912101 <section>
17922102 <title>Cave/Panorama mode</title>
2103
17932104 <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>
18042112 A B C D
18052113 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>
18102116 </section>
2117
18112118 <section>
18122119 <title>Action Override</title>
2120
18132121 <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
18172125 <table frame="all" tabstyle="tbl">
18182126 <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
18232135 <thead>
18242136 <row>
18252137 <entry>Bit</entry>
2138
18262139 <entry>Value</entry>
2140
18272141 <entry>Description</entry>
18282142 </row>
18292143 </thead>
2144
18302145 <tbody>
18312146 <row>
18322147 <entry><literal>0</literal></entry>
2148
18332149 <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>
18352153 </row>
2154
18362155 <row>
18372156 <entry><literal>1</literal></entry>
2157
18382158 <entry><literal>2</literal></entry>
2159
18392160 <entry><para>ignore window-close event</para></entry>
18402161 </row>
2162
18412163 <row>
18422164 <entry><literal>2</literal></entry>
2165
18432166 <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>
18472170 </row>
2171
18482172 <row>
18492173 <entry><literal>3</literal></entry>
2174
18502175 <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>
18572182 </row>
2183
18582184 <row>
18592185 <entry><literal>4</literal></entry>
2186
18602187 <entry><literal>16</literal></entry>
2188
18612189 <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>
18672192 </row>
18682193 </tbody>
18692194 </tgroup>
18712196 </section>
18722197 </section>
18732198
1874 <!-- MAN PAGES -->
2199 <!-- MAN PAGES -->
18752200
18762201 <appendix id="manual_pages">
18772202 <title>Manual Pages</title>
18782203
18792204 <refentry id="xjadeo">
1880 <refmeta>
2205 <refmeta>
18812206 <refentrytitle>xjadeo</refentrytitle>
2207
18822208 <manvolnum>1</manvolnum>
2209
18832210 <refmiscinfo class="source">http://xjadeo.sf.net</refmiscinfo>
2211
18842212 <refmiscinfo class="version">0.6.X</refmiscinfo>
1885 <!--
1886 -->
1887 </refmeta>
1888
1889 <refnamediv>
2213
2214 </refmeta>
2215
2216 <refnamediv>
18902217 <refname>xjadeo</refname>
18912218
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>
18932221 </refnamediv>
18942222
18952223 <refsynopsisdiv>
18962224 <cmdsynopsis>
18972225 <command>xjadeo</command>
2226
18982227 <arg choice="opt">-aAbcCDhIkKlLnNPqQRsStvV</arg>
2228
18992229 <arg choice="opt">-d <replaceable>midi-driver</replaceable></arg>
2230
19002231 <arg choice="opt">-f <replaceable>fps</replaceable></arg>
2232
19012233 <arg choice="opt">-F <replaceable>fps</replaceable></arg>
2234
19022235 <arg choice="opt">-i <replaceable>int</replaceable></arg>
2236
19032237 <arg choice="opt">-m <replaceable>midi-port</replaceable></arg>
2238
19042239 <arg choice="opt">-M <replaceable>num</replaceable></arg>
2240
19052241 <arg choice="opt">-o <replaceable>frames|SMPTE</replaceable></arg>
2242
19062243 <arg choice="opt">-O <replaceable>osc-port</replaceable></arg>
2244
19072245 <arg choice="opt">-W <replaceable>rpc-id</replaceable></arg>
2246
19082247 <arg choice="opt">-x <replaceable>dpy-mode</replaceable></arg>
2248
19092249 <arg choice="plain"><replaceable>videofile</replaceable></arg>
19102250 </cmdsynopsis>
2251
19112252 <cmdsynopsis>
19122253 <command>xjadeo</command>
2254
19132255 <arg choice="plain">-R</arg>
2256
19142257 <arg choice="opt">options</arg>
2258
19152259 <arg choice="opt"><replaceable>videofile</replaceable></arg>
19162260 </cmdsynopsis>
2261
19172262 <cmdsynopsis>
19182263 <command>xjadeo</command>
2264
19192265 <arg choice="plain">-Q</arg>
2266
19202267 <arg choice="opt">options</arg>
2268
19212269 <arg choice="opt"><replaceable>videofile</replaceable></arg>
19222270 </cmdsynopsis>
19232271 </refsynopsisdiv>
19252273 <refsect1>
19262274 <title>DESCRIPTION</title>
19272275
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>
19312279
19322280 <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>
19382286 </refsect1>
19392287
19402288 <refsect1 id="commandline_options" xreflabel="command-line options">
19412289 <title>OPTIONS</title>
2290
19422291 <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
19652313 <listitem>
19662314 <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
19742322 <listitem>
19752323 <para>Do not use MIDI quarter-frames for more exact sync.</para>
19762324 </listitem>
19772325 </varlistentry>
19782326
19792327 <varlistentry>
1980 <term><option>-C, --midiclk</option>,
1981 <option>--midiclk</option></term>
2328 <term><option>-c</option>, <option>--midiclk</option></term>
2329
19822330 <listitem>
19832331 <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>
19852333 </listitem>
19862334 </varlistentry>
19872335
19882336 <varlistentry>
19892337 <term><option>-d <replaceable>midi-driver</replaceable></option>,
1990 <option>--midi-driver <replaceable>midi-driver</replaceable>
2338 <option>--midi-driver <replaceable>midi-driver</replaceable>
19912339 </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>
20052356 </listitem>
20062357 </varlistentry>
20072358
20082359 <varlistentry>
20092360 <term><option>-f <replaceable>n</replaceable></option>,
20102361 <option>--fps <replaceable>n</replaceable></option></term>
2362
20112363 <listitem>
20122364 <para>Desired refresh-rate of the video display in frames per
20132365 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>,
20212374 <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>
20252379 </listitem>
20262380 </varlistentry>
20272381
20282382 <varlistentry>
20292383 <term><option>-h, --help</option></term>
2384
20302385 <listitem>
20312386 <para>Prints usage help and exits.</para>
20322387 </listitem>
20352390 <varlistentry>
20362391 <term><option>-i <replaceable>n</replaceable></option>,
20372392 <option>--info <replaceable>n</replaceable></option></term>
2393
20382394 <listitem>
20392395 <para>Displays information using the OSD (on-screen display.)
2040 <variablelist>
2396 <variablelist>
20412397 <varlistentry>
20422398 <term><option>0</option></term>
2399
20432400 <listitem>
20442401 <para>Off.</para>
20452402 </listitem>
20462403 </varlistentry>
2404
20472405 <varlistentry>
20482406 <term><option>1</option></term>
2407
20492408 <listitem>
20502409 <para>Frame number.</para>
20512410 </listitem>
20522411 </varlistentry>
2412
20532413 <varlistentry>
20542414 <term><option>2</option></term>
2415
20552416 <listitem>
20562417 <para>SMPTE time code.</para>
20572418 </listitem>
20582419 </varlistentry>
2420
20592421 <varlistentry>
20602422 <term><option>3</option></term>
2423
20612424 <listitem>
20622425 <para>Both frame number and SMPTE.</para>
20632426 </listitem>
20642427 </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>
20692430 </listitem>
20702431 </varlistentry>
20712432
20722433 <varlistentry>
20732434 <term><option>-I</option>,
20742435 <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
20902451 <listitem>
20912452 <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
20942456 <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
21032465 <listitem>
21042466 <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
21182479 <listitem>
21192480 <para>Use LTC as sync-source instead of JACK-transport.</para>
21202481 </listitem>
21212482 </varlistentry>
21222483
21232484 <varlistentry>
2124 <term><option>-L</option>,
2125 <option>--nolash</option></term>
2485 <term><option>-L</option>, <option>--nolash</option></term>
2486
21262487 <listitem>
21272488 <para>Disable LASH support.</para>
21282489 </listitem>
21302491
21312492 <varlistentry>
21322493 <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
21372501 <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>
21412505
21422506 <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>
21522515 </listitem>
21532516 </varlistentry>
21542517
21552518 <varlistentry>
21562519 <term><option>-M <replaceable>n</replaceable></option>,
21572520 <option>--midifps <replaceable>n</replaceable></option></term>
2521
21582522 <listitem>
21592523 <para>Conversion between MTC SMPTE and frame number.
21602524 <variablelist>
21612525 <varlistentry>
21622526 <term><option>0</option> (default)</term>
2527
21632528 <listitem>
21642529 <para>Use MTC clock frame rate.</para>
21652530 </listitem>
21662531 </varlistentry>
2532
21672533 <varlistentry>
21682534 <term><option>1</option></term>
2535
21692536 <listitem>
21702537 <para>Use video-file's frame-rate.</para>
21712538 </listitem>
21722539 </varlistentry>
2540
21732541 <varlistentry>
21742542 <term><option>1</option></term>
2543
21752544 <listitem>
21762545 <para>Resample video frame rate / MTC.</para>
21772546 </listitem>
21812550 </varlistentry>
21822551
21832552 <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>
21992568 </listitem>
22002569 </varlistentry>
22012570
22022571 <varlistentry>
22032572 <term><option>-o <replaceable>n</replaceable></option>,
22042573 <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>,
22282598 <option>--silent</option></term>
2599
22292600 <listitem>
22302601 <para>Suppresses normal output messages.</para>
22312602 </listitem>
22322603 </varlistentry>
22332604
22342605 <varlistentry>
2235 <term><option>-Q</option>,
2236 <option>--mq</option></term>
2606 <term><option>-Q</option>, <option>--mq</option></term>
2607
22372608 <listitem>
22382609 <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
22482618 <listitem>
22492619 <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
22672637 <listitem>
22682638 <para>Skip the on-screen-display startup sequence.</para>
22692639 </listitem>
22702640 </varlistentry>
22712641
22722642 <varlistentry>
2273 <term><option>-t</option>,
2274 <option>--try-codec</option></term>
2643 <term><option>-t</option>, <option>--try-codec</option></term>
2644
22752645 <listitem>
22762646 <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
22852655 <listitem>
22862656 <para>Print additional information.</para>
22872657 </listitem>
22882658 </varlistentry>
22892659
22902660 <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>
22962666 </listitem>
22972667 </varlistentry>
22982668
22992669 <varlistentry>
23002670 <term><option>-W <replaceable>rpc-id</replaceable></option>,
23012671 <option>--ipc <replaceable>rpc-id</replaceable></option></term>
2672
23022673 <listitem>
23032674 <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>
23082678 </listitem>
23092679 </varlistentry>
23102680
23112681 <varlistentry>
23122682 <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
23162687 <listitem>
23172688 <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>
23232693 </variablelist>
23242694 </refsect1>
23252695
23272697 <title>SYNC SOURCES</title>
23282698
23292699 <para><command>xjadeo</command> currently supports the following
2330 synchronization sources:</para>
2700 synchronization sources:</para>
2701
23312702 <itemizedlist>
23322703 <listitem>
23332704 <para>JACK-transport.</para>
23342705 </listitem>
2706
23352707 <listitem>
23362708 <para>LTC (Linear/Longitudinal Time Code) - via JACK audio.</para>
23372709 </listitem>
2710
23382711 <listitem>
23392712 <para>MTC (MIDI Time Code) via JACK-MIDI.</para>
23402713 </listitem>
2714
23412715 <listitem>
23422716 <para>MTC (MIDI Time Code) via ALSA sequencer.</para>
23432717 </listitem>
2718
23442719 <listitem>
23452720 <para>MTC (MIDI Time Code) via portmidi.</para>
23462721 </listitem>
2722
23472723 <listitem>
23482724 <para>remote-ctrl manual seeks (not really a sync source).</para>
23492725 </listitem>
23532729 <refsect1>
23542730 <title>VIDEO FORMATS</title>
23552731
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>
23722745
23732746 <screen>-vf scale=width:height</screen>
23742747
23752748 <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
23832756 <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>
23862759 </important>
23872760 </refsect1>
23882761
23892762 <refsect1>
23902763 <title>USER INPUT</title>
23912764
2392 <para><command>xjadeo</command> window accepts the following input:
2393 </para>
2765 <para><command>xjadeo</command> window accepts the following
2766 input:</para>
23942767
23952768 <itemizedlist>
23962769 <listitem>
23972770 <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
24002774 <listitem>
24012775 <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
24042779 <listitem>
24052780 <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 &ge; 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>&lt;</keycap>, <keycap>&gt;</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> &ge; 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>&lt;</keycap>,
2795 <keycap>&gt;</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>
24272799 </listitem>
24282800 </itemizedlist>
24292801 </refsect1>
24302802
24312803 <refsect1>
24322804 <title>REMOTE MODE</title>
2805
24332806 <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
24352808 interactively accept commands and issue responses through its standard
24362809 input/output mechanism.</para>
24372810
24382811 <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>
24422815
24432816 <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>
24452818 </refsect1>
24462819
24472820 <refsect1>
24482821 <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>
24842857 </refsect1>
2858
24852859 <refsect1>
24862860 <title>ENVIRONMENT</title>
2861
24872862 <variablelist>
24882863 <varlistentry>
24892864 <term><option>JACK_DEFAULT_SERVER</option></term>
2865
24902866 <listitem>
24912867 <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>
24932869 </listitem>
24942870 </varlistentry>
24952871 </variablelist>
24972873
24982874 <refsect1>
24992875 <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>
25042884 </refsect1>
2505
25062885 </refentry>
2507
25082886
25092887 <refentry id="qjadeo">
25102888 <refmeta>
25112889 <refentrytitle>qjadeo</refentrytitle>
2512 <manvolnum>1</manvolnum>
2890
2891 <manvolnum>1</manvolnum>
2892
25132893 <refmiscinfo class="source">http://xjadeo.sf.net</refmiscinfo>
2894
25142895 <refmiscinfo class="version">0.6.X</refmiscinfo>
25152896 </refmeta>
25162897
25232904 <refsynopsisdiv>
25242905 <cmdsynopsis>
25252906 <command>qjadeo</command>
2526
25272907 </cmdsynopsis>
25282908 </refsynopsisdiv>
25292909
25302910 <refsect1>
25312911 <title>DESCRIPTION</title>
25322912
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
25392919 <command>xjremote</command>.</para>
25402920 </refsect1>
25412921
25432923 <title>ENVIRONMENT</title>
25442924
25452925 <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>
25482928 </refsect1>
25492929
25502930 <refsect1>
25512931 <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>
25542936 </refsect1>
25552937 </refentry>
2556
2938
25572939 <refentry id="xjremote">
25582940 <refmeta>
25592941 <refentrytitle>xjremote</refentrytitle>
2560 <manvolnum>1</manvolnum>
2942
2943 <manvolnum>1</manvolnum>
2944
25612945 <refmiscinfo class="source">http://xjadeo.sf.net</refmiscinfo>
2946
25622947 <refmiscinfo class="version">0.6.X</refmiscinfo>
25632948 </refmeta>
25642949
25652950 <refnamediv>
25662951 <refname>xjremote</refname>
25672952
2568 <refpurpose>CLI remote-control to <command>xjadeo</command></refpurpose>
2953 <refpurpose>CLI remote-control to
2954 <command>xjadeo</command></refpurpose>
25692955 </refnamediv>
25702956
25712957 <refsynopsisdiv>
25722958 <cmdsynopsis>
25732959 <command>xjremote</command>
2960
25742961 <arg choice="opt">-fhPquUvV</arg>
2962
25752963 <arg choice="opt">-I <replaceable>mq-queue-id</replaceable></arg>
25762964 </cmdsynopsis>
25772965 </refsynopsisdiv>
25792967 <refsect1 id="xjremote_description">
25802968 <title>DESCRIPTION</title>
25812969
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>
25892977
25902978 <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>
25932981 </refsect1>
25942982
25952983 <refsect1>
25962984 <title>OPTIONS</title>
2985
25972986 <variablelist>
25982987 <varlistentry>
2599 <term><option>-f</option>,
2600 <option>--nofork</option></term>
2988 <term><option>-f</option>, <option>--nofork</option></term>
2989
26012990 <listitem>
26022991 <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
26123001 <listitem>
26133002 <para>Prints usage help and exits.</para>
26143003 </listitem>
26173006 <varlistentry>
26183007 <term><option>-I <replaceable>ipc-id</replaceable></option>,
26193008 <option>--id <replaceable>ipc-id</replaceable></option></term>
3009
26203010 <listitem>
26213011 <para>specify message-queue identifier.</para>
26223012 </listitem>
26233013 </varlistentry>
26243014
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>,
26373025 <option>--silent</option></term>
3026
26383027 <listitem>
26393028 <para>Suppresses normal output messages.</para>
26403029 </listitem>
26423031
26433032 <varlistentry>
26443033 <term><option>-Q</option></term>
3034
26453035 <listitem>
26463036 <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>
26493039 </listitem>
26503040 </varlistentry>
26513041
26523042 <varlistentry>
26533043 <term><option>-R</option></term>
3044
26543045 <listitem>
26553046 <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
26643055 <listitem>
26653056 <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>
26673058 instance after unlinking the queues. Note: active connections
26683059 are not affected.</para>
26693060 </listitem>
26703061 </varlistentry>
26713062
26723063 <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
26853076 <listitem>
26863077 <para>Print additional information.</para>
26873078 </listitem>
26883079 </varlistentry>
26893080
26903081 <varlistentry>
2691 <term><option>-V</option>,
2692 <option>--version</option></term>
3082 <term><option>-V</option>, <option>--version</option></term>
3083
26933084 <listitem>
26943085 <para>Print version information end exit.</para>
26953086 </listitem>
26973088
26983089 <varlistentry>
26993090 <term><option>-W <replaceable>rpc-id</replaceable></option></term>
3091
27003092 <listitem>
27013093 <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>
27073098 </variablelist>
2708
27093099 </refsect1>
27103100
27113101 <refsect1>
27123102 <title>ENVIRONMENT</title>
27133103
27143104 <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>
27173107 </refsect1>
27183108
27193109 <refsect1>
27203110 <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>
27283117 </refsect1>
27293118
27303119 <refsect1>
27313120 <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>
27343125 </refsect1>
2735
27363126 </refentry>
2737
27383127
27393128 <refentry id="xjinfo">
27403129 <refmeta>
27413130 <refentrytitle>xjinfo</refentrytitle>
2742 <manvolnum>1</manvolnum>
3131
3132 <manvolnum>1</manvolnum>
3133
27433134 <refmiscinfo class="source">http://xjadeo.sf.net</refmiscinfo>
3135
27443136 <refmiscinfo class="version">0.6.X</refmiscinfo>
27453137 </refmeta>
27463138
27533145 <refsynopsisdiv>
27543146 <cmdsynopsis>
27553147 <command>xjinfo</command>
3148
27563149 <arg choice="opt">-chtvVx</arg>
3150
27573151 <arg choice="plain"><replaceable>videofile</replaceable></arg>
27583152 </cmdsynopsis>
27593153 </refsynopsisdiv>
27623156 <title>DESCRIPTION</title>
27633157
27643158 <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>
27683161 </refsect1>
27693162
27703163 <refsect1>
27723165
27733166 <variablelist>
27743167 <varlistentry>
2775 <term><option>-c</option>,
2776 <option>--csv</option></term>
3168 <term><option>-c</option>, <option>--csv</option></term>
3169
27773170 <listitem>
27783171 <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
27863180 <listitem>
27873181 <para>Print usage help and exit.</para>
27883182 </listitem>
27893183 </varlistentry>
2790 <varlistentry>
2791 <term><option>-t</option>,
2792 <option>--time</option>,
3184
3185 <varlistentry>
3186 <term><option>-t</option>, <option>--time</option>,
27933187 <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>
28163212 </listitem>
28173213 </varlistentry>
28183214 </variablelist>
28203216
28213217 <refsect1>
28223218 <title>SEE ALSO</title>
2823 <para><xref linkend="xjadeo"/></para>
3219
3220 <para><xref linkend="xjadeo"/></para>
28243221 </refsect1>
28253222 </refentry>
28263223 </appendix>
28273224 </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 -->
11 .\" Title: xjinfo
22 .\" Author: Robin Gareus <robin@gareus.org>
33 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
4 .\" Date: 11/05/2010
4 .\" Date: 11/24/2010
55 .\" Manual: Manual Pages
66 .\" Source: http://xjadeo.sf.net 0.6.X
77 .\" Language: English
88 .\"
9 .TH "XJINFO" "1" "11/05/2010" "http://xjadeo\&.sf\&.net 0\&.6" "Manual Pages"
9 .TH "XJINFO" "1" "11/24/2010" "http://xjadeo\&.sf\&.net 0\&.6" "Manual Pages"
1010 .\" -----------------------------------------------------------------
1111 .\" * Define some portability stuff
1212 .\" -----------------------------------------------------------------
7171 .SH "SEE ALSO"
7272 .PP
7373 xjadeo(1)
74 .SH "AUTHOR"
74 .SH "AUTHORS"
7575 .PP
7676 \fBRobin Gareus\fR <\&robin@gareus.org\&>
7777 .RS 4
7878 linuxaudio.org
79 .RE
80 .PP
81 \fBLuis Garrido\fR <\&luisgarrido@users.sourceforge.net\&>
82 .RS 4
83 luisgarrido.users.sourceforge.net
7984 .RE
8085 .SH "COPYRIGHT"
8186 .br
11 .\" Title: xjremote
22 .\" Author: Robin Gareus <robin@gareus.org>
33 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
4 .\" Date: 11/05/2010
4 .\" Date: 11/24/2010
55 .\" Manual: Manual Pages
66 .\" Source: http://xjadeo.sf.net 0.6.X
77 .\" Language: English
88 .\"
9 .TH "XJREMOTE" "1" "11/05/2010" "http://xjadeo\&.sf\&.net 0\&.6" "Manual Pages"
9 .TH "XJREMOTE" "1" "11/24/2010" "http://xjadeo\&.sf\&.net 0\&.6" "Manual Pages"
1010 .\" -----------------------------------------------------------------
1111 .\" * Define some portability stuff
1212 .\" -----------------------------------------------------------------
3333 \fBxjremote\fR [\-fhPquUvV] [\-I\ \fI<mq\-queue\-id>\fR]
3434 .SH "DESCRIPTION"
3535 .PP
36 xjadeo
36 Xjadeo
3737 is a software video player that displays a video\-clip in sync with an external time source (MTC, LTC, JACK\-transport)\&.
3838 .PP
3939 \fBxjremote\fR
4040 connects to a instance of
41 xjadeo
41 Xjadeo
4242 and allows a user to tweak the running configuration\&.
4343 .PP
44 If it can not connect, xjremote will start a new instance of xjadeo and open a connection to it unless the
44 If it can not connect, xjremote will start a new instance of
45 Xjadeo
46 and open a connection to it unless the
4547 \fB\-f\fR
4648 is given\&.
4749 .SH "OPTIONS"
4951 \fB\-f\fR, \fB\-\-nofork\fR
5052 .RS 4
5153 disable automatic startup of
52 xjadeo\&. Instead xjremote will terminate if it can not connect to a running
53 xjadeo\&.
54 Xjadeo\&. Instead xjremote will terminate if it can not connect to a running
55 Xjadeo\&.
5456 .RE
5557 .PP
5658 \fB\-h\fR, \fB\-\-help\fR
6567 .PP
6668 \fB\-P\fR, \fB\-P, \-\-noping\fR
6769 .RS 4
68 Skip checking for xjadeo live signs (ping)\&.
70 Skip checking for
71 Xjadeo
72 life signs (ping)\&.
6973 .RE
7074 .PP
7175 \fB\-q\fR, \fB\-\-quiet\fR, \fB\-\-silent\fR
9397 .RS 4
9498 remove existing queues\&. Unless combined with
9599 \fB\-f\fR
96 this will launch always a new xjadeo instance after unlinking the queues\&. Note: active connections are not affected\&.
100 this will launch always a new
101 Xjadeo
102 instance after unlinking the queues\&. Note: active connections are not affected\&.
97103 .RE
98104 .PP
99105 \fB\-U\fR, \fB\-\-unlinkonly\fR
100106 .RS 4
101 remove existing message queues and exit\&. If no xjadeo instance is running this is equivalent to
107 remove existing message queues and exit\&. If no
108 Xjadeo
109 instance is running this is equivalent to
102110 \fB\-u \-f\fR\&.
103111 .RE
104112 .PP
126134 variable is set,
127135 xjremote
128136 will assume that it holds the path to the
129 xjadeo
137 Xjadeo
130138 executable\&.
131139 .SH "NOTE"
132140 .PP
133141 Apart from Standard\-I/O,
134 xjadeo
142 Xjadeo
135143 can either use POSIX real\-time message\-queues (MQ) or System\-V IPC communication\&. The decision is made when compiling it\&. Basically GNU/Linux uses MQ (but could use IPC as well)\&. OSX only supports IPC and Windows is limited to standard\-I/O only\&.
136144 .SH "SEE ALSO"
137145 .PP
138146 xjadeo(1)
139147 .PP
140148 qjadeo(1)
141 .SH "AUTHOR"
149 .SH "AUTHORS"
142150 .PP
143151 \fBRobin Gareus\fR <\&robin@gareus.org\&>
144152 .RS 4
145153 linuxaudio.org
146154 .RE
155 .PP
156 \fBLuis Garrido\fR <\&luisgarrido@users.sourceforge.net\&>
157 .RS 4
158 luisgarrido.users.sourceforge.net
159 .RE
147160 .SH "COPYRIGHT"
148161 .br
149162 Copyright \(co 2005, 2006, 2007, 2009, 2010 Robin Gareus, Luis Garrido
33 importdialog.ui prefdialog.ui importprogress.ui \
44 importdialog.h importprogress.h prefdialog.h \
55 importdialog.cpp importprogress.cpp prefdialog.cpp \
6 qjadeo_fr.ts \
6 qjadeo_fr.ts qjadeo_ru.ts \
77 Makefile.am qjadeo.qrc qjadeo.rc
88
99 qmake = @ac_qmake@
2424 importdialog.cpp importprogress.cpp prefdialog.cpp \
2525 importdialog.ui prefdialog.ui importprogress.ui
2626
27 TRANSLATIONS = qjadeo_fr.ts
27 TRANSLATIONS = qjadeo_fr.ts qjadeo_ru.ts
2828
2929 all: $(name)
3030
192192 importdialog.ui prefdialog.ui importprogress.ui \
193193 importdialog.h importprogress.h prefdialog.h \
194194 importdialog.cpp importprogress.cpp prefdialog.cpp \
195 qjadeo_fr.ts \
195 qjadeo_fr.ts qjadeo_ru.ts \
196196 Makefile.am qjadeo.qrc qjadeo.rc
197197
198198 qmake = @ac_qmake@
210210 importdialog.cpp importprogress.cpp prefdialog.cpp \
211211 importdialog.ui prefdialog.ui importprogress.ui
212212
213 TRANSLATIONS = qjadeo_fr.ts
213 TRANSLATIONS = qjadeo_fr.ts qjadeo_ru.ts
214214 all: all-am
215215
216216 .SUFFIXES:
55 <rect>
66 <x>0</x>
77 <y>0</y>
8 <width>381</width>
8 <width>400</width>
99 <height>120</height>
1010 </rect>
1111 </property>
209209 <rect>
210210 <x>0</x>
211211 <y>0</y>
212 <width>381</width>
212 <width>400</width>
213213 <height>21</height>
214214 </rect>
215215 </property>
244244 <addaction name="zoom100Action"/>
245245 <addaction name="zoom200Action"/>
246246 <addaction name="zoomFullScreenAction"/>
247 <addaction name="separator"/>
248 <addaction name="actionLetterbox"/>
249 <addaction name="actionResize_to_aspect_ratio"/>
247250 </widget>
248251 <widget class="QMenu" name="OSD">
249252 <property name="title">
303306 <string>Exit</string>
304307 </property>
305308 <property name="shortcut">
306 <string/>
309 <string>Ctrl+Q</string>
307310 </property>
308311 <property name="name" stdset="0">
309312 <cstring>fileExitAction</cstring>
422425 <property name="iconText">
423426 <string>Disconnect</string>
424427 </property>
428 <property name="shortcut">
429 <string>Ctrl+W</string>
430 </property>
425431 <property name="name" stdset="0">
426432 <cstring>fileDisconnectAction</cstring>
427433 </property>
428434 </action>
429 <action name="seekany_frameAction">
435 <action name="actionLetterbox">
430436 <property name="checkable">
431437 <bool>true</bool>
432438 </property>
433439 <property name="text">
434 <string>to any frame</string>
435 </property>
436 <property name="iconText">
437 <string>to any frame</string>
438 </property>
439 <property name="name" stdset="0">
440 <cstring>seekany_frameAction</cstring>
441 </property>
442 </action>
443 <action name="seekKeyFramesAction">
444 <property name="checkable">
445 <bool>true</bool>
446 </property>
447 <property name="text">
448 <string>keyframes only</string>
449 </property>
450 <property name="iconText">
451 <string>keyframes only</string>
452 </property>
453 <property name="name" stdset="0">
454 <cstring>seekKeyFramesAction</cstring>
455 </property>
456 </action>
457 <action name="seekcontinuouslyAction">
458 <property name="checkable">
459 <bool>true</bool>
460 </property>
461 <property name="text">
462 <string>continuously</string>
463 </property>
464 <property name="iconText">
465 <string>continuously</string>
466 </property>
467 <property name="name" stdset="0">
468 <cstring>seekcontinuouslyAction</cstring>
469 </property>
470 </action>
440 <string>Letterbox</string>
441 </property>
442 </action>
443 <action name="actionResize_to_aspect_ratio">
444 <property name="text">
445 <string>Resize to aspect-ratio</string>
446 </property>
447 </action>
448 <actiongroup name="seekAction">
449 <action name="seekany_frameAction">
450 <property name="checkable">
451 <bool>true</bool>
452 </property>
453 <property name="text">
454 <string>to any frame</string>
455 </property>
456 <property name="iconText">
457 <string>to any frame</string>
458 </property>
459 <property name="name" stdset="0">
460 <cstring>seekany_frameAction</cstring>
461 </property>
462 </action>
463 <action name="seekKeyFramesAction">
464 <property name="checkable">
465 <bool>true</bool>
466 </property>
467 <property name="text">
468 <string>keyframes only</string>
469 </property>
470 <property name="iconText">
471 <string>keyframes only</string>
472 </property>
473 <property name="name" stdset="0">
474 <cstring>seekKeyFramesAction</cstring>
475 </property>
476 </action>
477 <action name="seekcontinuouslyAction">
478 <property name="checkable">
479 <bool>true</bool>
480 </property>
481 <property name="text">
482 <string>continuously</string>
483 </property>
484 <property name="iconText">
485 <string>continuously</string>
486 </property>
487 <property name="name" stdset="0">
488 <cstring>seekcontinuouslyAction</cstring>
489 </property>
490 </action>
491 </actiongroup>
471492 <actiongroup name="syncAction">
472493 <action name="syncJackAction">
473494 <property name="checkable">
712733 </hints>
713734 </connection>
714735 <connection>
736 <sender>actionResize_to_aspect_ratio</sender>
737 <signal>activated()</signal>
738 <receiver>MainWindow</receiver>
739 <slot>zoomAspect()</slot>
740 <hints>
741 <hint type="sourcelabel">
742 <x>-1</x>
743 <y>-1</y>
744 </hint>
745 <hint type="destinationlabel">
746 <x>20</x>
747 <y>20</y>
748 </hint>
749 </hints>
750 </connection>
751 <connection>
752 <sender>actionLetterbox</sender>
753 <signal>toggled(bool)</signal>
754 <receiver>MainWindow</receiver>
755 <slot>zoomLetterbox(bool)</slot>
756 <hints>
757 <hint type="sourcelabel">
758 <x>-1</x>
759 <y>-1</y>
760 </hint>
761 <hint type="destinationlabel">
762 <x>20</x>
763 <y>20</y>
764 </hint>
765 </hints>
766 </connection>
767 <connection>
715768 <sender>syncOffAction</sender>
716769 <signal>activated()</signal>
717770 <receiver>MainWindow</receiver>
8585 void QJadeo::initialize ()
8686 {
8787 if (!m_osdfont.isEmpty()) {
88 xjadeo->write(QString("osd font " + m_osdfont + "\n").toAscii());
88 xjadeo->write(QString("osd font " + m_osdfont + "\n").toUtf8());
8989 }
9090 xjadeo->write(QByteArray("set seekmode 1\n"));
9191 xjadeo->write(QByteArray("osd notext\n"));
9999 xjadeo->write(QByteArray("get syncsource\n"));
100100 xjadeo->write(QByteArray("get position\n"));
101101 xjadeo->write(QByteArray("get seekmode\n"));
102 xjadeo->write(QByteArray("get letterbox\n"));
102103 xjadeo->write(QByteArray("notify frame\n"));
103104 }
104105
182183
183184 void QJadeo::fileOpen()
184185 {
185 QString s = QFileDialog::getOpenFileName(this, "Choose video file", "", 0);
186 QString s = QFileDialog::getOpenFileName(this, tr("Choose video file"), "", 0);
186187
187188 if(!s.isNull())
188189 {
345346 ).toAscii());
346347 }
347348
349 void QJadeo::zoomAspect()
350 {
351 xjadeo->write(QByteArray("window fixaspect\n"));
352 }
353
354 void QJadeo::zoomLetterbox(bool value)
355 {
356 if (value) {
357 xjadeo->write(QByteArray("window letterbox on\n"));
358 } else {
359 xjadeo->write(QByteArray("window letterbox off\n"));
360 }
361 }
362
348363 void QJadeo::syncJack()
349364 {
350365 xjadeo->write(QByteArray("ltc disconnect\n"));
455470
456471 void QJadeo::osdFont()
457472 {
458 QString s = QFileDialog::getOpenFileName(this, "Choose a font", "", "TrueType fonts (*.ttf)");
473 QString s = QFileDialog::getOpenFileName(this, tr("Choose a font"), "", "TrueType fonts (*.ttf)");
459474
460475 if(!s.isNull())
461476 {
462477 m_osdfont = s;
463 xjadeo->write(QString("osd font " + s + "\n").toAscii());
478 xjadeo->write(QString("osd font " + s + "\n").toUtf8());
464479 xjadeo->write(QByteArray("osd text \n"));
465480 }
466481 }
514529 }
515530 }
516531 else if(name == "filename")
517 updateRecentFiles(value);
532 updateRecentFiles(QString::fromUtf8(value.toAscii().data(),-1));
518533 else if(name == "movie_width")
519534 m_movie_width = value.toInt();
520535 else if(name == "movie_height")
565580 {
566581 ;// set default folder and file in
567582 // File selection dialog.
583 }
584 else if(name == "letterbox")
585 {
586 int v= value.toInt();
587 actionLetterbox->setChecked(v&1);
568588 }
569589 else if(name == "osdmode")
570590 {
606626 xjadeo->write(QByteArray("midi driver\n"));
607627 xjadeo->write(QByteArray("get syncsource\n"));
608628 xjadeo->write(QByteArray("get position\n"));
629 xjadeo->write(QByteArray("get letterbox\n"));
609630 }
610631 }
611632 }
622643 m_framerate = 0;
623644 m_mididrv = 0;
624645 bool showtext = osdTextAction->isChecked();
625 xjadeo->write(QString("load " + filename + "\n").toAscii());
626 xjadeo->write(QString("osd text " + filename + "\n").toAscii());
646 xjadeo->write(QString("load " + filename + "\n").toUtf8());
647 xjadeo->write(QString("osd text " + filename + "\n").toUtf8());
627648 xjadeo->write(QByteArray("get filename\n"));
628649 if (!showtext) {
629650 QTimer::singleShot(3000, this, SLOT(osdTextOff()));
634655 {
635656
636657 QApplication a(argc, argv);
658 QString sLocale = QLocale::system().name();
637659 QTranslator translator;
660
661 if (sLocale != "C") {
662 QString sLocName = "qjadeo_" + sLocale;
663 if (!translator.load(sLocName, ".")) {
664 QString sLocPath = CONFIG_PREFIX;
665 if (!translator.load(sLocName, sLocPath)) {
666 fprintf(stderr, "Warning: no locale found: %s/%s.qm\n", sLocPath.toAscii().data(), sLocName.toAscii().data());
667 }
668 }
669 a.installTranslator(&translator);
670 }
671
638672 QJadeo w;
639 QString sLocale = w.locale().name();
640 if (sLocale != "C") {
641 QString sLocName = "qjadeo_" + sLocale;
642 if (!translator.load(sLocName, ".")) {
643 QString sLocPath = CONFIG_PREFIX;
644 if (!translator.load(sLocName, sLocPath))
645 fprintf(stderr, "Warning: no locale found: %s/%s.qm\n", sLocPath.toAscii().data(), sLocName.toAscii().data());
646 }
647 a.installTranslator(&translator);
648 }
649
650
651
652 // Launch xjadeo
653
654673 QString xjadeoPath(getenv("XJREMOTE"));
655674
656675 if(xjadeoPath.isEmpty())
664683 w.xjadeo->start(xjadeoPath, QStringList("-R"));
665684 if(!w.xjadeo->waitForStarted())
666685 {
667 QMessageBox::QMessageBox::critical( &w, "qjadeo","can not execute xjadeo/xjremote.","Exit", QString::null, QString::null, 0, -1);
686 QMessageBox::QMessageBox::critical( &w, "qjadeo", "can not execute xjadeo/xjremote." ,"Exit", QString::null, QString::null, 0, -1);
668687 //qFatal("Could not start xjadeo executable: " + xjadeoPath);
669688 //qFatal("Try to set the XJREMOTE environment variable to point to xjadeo.");
670689 exit(1);
6060 void zoom200();
6161 void zoomFullScreen();
6262
63 void zoomAspect();
64 void zoomLetterbox(bool);
65
6366 void syncJack();
6467 void syncLTCJack();
6568 void syncMTCalsa();
1414
1515 #QMAKE_CXXFLAGS_WARN_ON += -Wno-non-virtual-dtor
1616
17 TRANSLATIONS = qjadeo_fr.ts
17 TRANSLATIONS = qjadeo_fr.ts qjadeo_ru.ts
1818
1919 DEFINES += QT_NO_DEBUG_OUTPUT
2020 #win32-x-g++:DEFINES += QT_NO_DEBUG_OUTPUT
0 <?xml version="1.0" encoding="utf-8"?>
1 <!DOCTYPE TS>
2 <TS version="2.0" language="ru_RU">
3 <context>
4 <name>ImportDialog</name>
5 <message>
6 <location filename="importdialog.ui" line="14"/>
7 <source>Import - Convert Video File</source>
8 <translation>Импорт — Конвертирование видеофайла</translation>
9 </message>
10 <message>
11 <location filename="importdialog.ui" line="23"/>
12 <source>Video File</source>
13 <translation>Видеофайл</translation>
14 </message>
15 <message>
16 <location filename="importdialog.ui" line="29"/>
17 <source>Source:</source>
18 <translation>Источник:</translation>
19 </message>
20 <message>
21 <location filename="importdialog.ui" line="94"/>
22 <source>File Info:</source>
23 <translation>Информация:</translation>
24 </message>
25 <message>
26 <location filename="importdialog.ui" line="107"/>
27 <source>Destination:</source>
28 <translation>Конечный файл:</translation>
29 </message>
30 <message>
31 <location filename="importdialog.ui" line="165"/>
32 <source>Encoder Settings</source>
33 <translation>Параметры кодировщика</translation>
34 </message>
35 <message>
36 <location filename="importdialog.ui" line="171"/>
37 <source>Width:</source>
38 <translation>Ширина:</translation>
39 </message>
40 <message>
41 <location filename="importdialog.ui" line="207"/>
42 <source>Scale</source>
43 <translation>Масштабировать</translation>
44 </message>
45 <message>
46 <location filename="importdialog.ui" line="214"/>
47 <source>Height:</source>
48 <translation>Высота:</translation>
49 </message>
50 <message>
51 <location filename="importdialog.ui" line="253"/>
52 <source>Break Aspect Ratio</source>
53 <translation>Без учёта соотношения сторон</translation>
54 </message>
55 <message>
56 <location filename="importdialog.ui" line="260"/>
57 <source>FPS:</source>
58 <translation>Кадров в секунду:</translation>
59 </message>
60 <message>
61 <location filename="importdialog.ui" line="308"/>
62 <source>24</source>
63 <translation>24</translation>
64 </message>
65 <message>
66 <location filename="importdialog.ui" line="313"/>
67 <source>25</source>
68 <translation>25</translation>
69 </message>
70 <message>
71 <location filename="importdialog.ui" line="318"/>
72 <source>29.97</source>
73 <translation>29.97</translation>
74 </message>
75 <message>
76 <location filename="importdialog.ui" line="323"/>
77 <source>30</source>
78 <translation>30</translation>
79 </message>
80 <message>
81 <location filename="importdialog.ui" line="331"/>
82 <source>Resample</source>
83 <translation>Выполнять ресэмплинг</translation>
84 </message>
85 <message>
86 <location filename="importdialog.ui" line="341"/>
87 <source>extra mencoder options</source>
88 <translation>Дополнительные ключи mencoder</translation>
89 </message>
90 <message>
91 <location filename="importdialog.ui" line="371"/>
92 <source>&amp;Cancel</source>
93 <translation>О&amp;тменить</translation>
94 </message>
95 <message>
96 <location filename="importdialog.ui" line="400"/>
97 <source>&amp;OK</source>
98 <translation>&amp;OK</translation>
99 </message>
100 <message>
101 <location filename="importdialog.cpp" line="17"/>
102 <source>select video file to convert</source>
103 <translation>Выберите конвертируемый видеофайл</translation>
104 </message>
105 <message>
106 <location filename="importdialog.cpp" line="34"/>
107 <source>choose a destinaton filename</source>
108 <translation>Выберите имя конечного файла</translation>
109 </message>
110 </context>
111 <context>
112 <name>ImportProgress</name>
113 <message>
114 <location filename="importprogress.ui" line="14"/>
115 <source>Transcoding Video File</source>
116 <translation>Выполняется конвертирование файла</translation>
117 </message>
118 <message>
119 <location filename="importprogress.ui" line="38"/>
120 <source>Cancel</source>
121 <translation>Отменить</translation>
122 </message>
123 </context>
124 <context>
125 <name>MainWindow</name>
126 <message>
127 <location filename="mainwindow.ui" line="14"/>
128 <source>qjadeo</source>
129 <translation>qjadeo</translation>
130 </message>
131 <message>
132 <location filename="mainwindow.ui" line="33"/>
133 <source>screen updates per sec.</source>
134 <translation>Обновлений в секунду:</translation>
135 </message>
136 <message>
137 <location filename="mainwindow.ui" line="72"/>
138 <source>time offset in video-frames:</source>
139 <translation>Смещение времени в видеокадрах:</translation>
140 </message>
141 <message>
142 <location filename="mainwindow.ui" line="219"/>
143 <source>&amp;File</source>
144 <translation>&amp;Файл</translation>
145 </message>
146 <message>
147 <location filename="mainwindow.ui" line="232"/>
148 <source>&amp;Sync</source>
149 <translation type="unfinished">С&amp;инхронизация</translation>
150 </message>
151 <message>
152 <location filename="mainwindow.ui" line="242"/>
153 <source>&amp;Zoom</source>
154 <translation>&amp;Масштаб</translation>
155 </message>
156 <message>
157 <location filename="mainwindow.ui" line="251"/>
158 <source>&amp;OSD</source>
159 <translation>&amp;OSD</translation>
160 </message>
161 <message>
162 <location filename="mainwindow.ui" line="261"/>
163 <source>&amp;Seek</source>
164 <translation>Пере&amp;ход</translation>
165 </message>
166 <message>
167 <location filename="mainwindow.ui" line="269"/>
168 <source>&amp;Help</source>
169 <translation>&amp;Справка</translation>
170 </message>
171 <message>
172 <location filename="mainwindow.ui" line="287"/>
173 <source>&amp;Open...</source>
174 <translation>&amp;Открыть...</translation>
175 </message>
176 <message>
177 <location filename="mainwindow.ui" line="290"/>
178 <source>Open</source>
179 <translation>Открыть</translation>
180 </message>
181 <message>
182 <location filename="mainwindow.ui" line="293"/>
183 <source>Ctrl+O</source>
184 <translation>Ctrl+O</translation>
185 </message>
186 <message>
187 <location filename="mainwindow.ui" line="301"/>
188 <source>&amp;Close xjadeo and Exit</source>
189 <translation>&amp;Закрыть xjadeo и выйти</translation>
190 </message>
191 <message>
192 <location filename="mainwindow.ui" line="304"/>
193 <source>Exit</source>
194 <translation>Выход</translation>
195 </message>
196 <message>
197 <location filename="mainwindow.ui" line="315"/>
198 <source>&amp;About</source>
199 <translation>&amp;О программе</translation>
200 </message>
201 <message>
202 <location filename="mainwindow.ui" line="318"/>
203 <source>About</source>
204 <translation>О программе</translation>
205 </message>
206 <message>
207 <location filename="mainwindow.ui" line="332"/>
208 <location filename="mainwindow.ui" line="335"/>
209 <source>Frame number</source>
210 <translation>Номер кадра</translation>
211 </message>
212 <message>
213 <location filename="mainwindow.ui" line="346"/>
214 <location filename="mainwindow.ui" line="349"/>
215 <source>SMPTE</source>
216 <translation>SMPTE</translation>
217 </message>
218 <message>
219 <location filename="mainwindow.ui" line="360"/>
220 <location filename="mainwindow.ui" line="363"/>
221 <source>Filename</source>
222 <translation>Имя файла</translation>
223 </message>
224 <message>
225 <location filename="mainwindow.ui" line="374"/>
226 <location filename="mainwindow.ui" line="377"/>
227 <source>Box</source>
228 <translation>Рисовать фон</translation>
229 </message>
230 <message>
231 <location filename="mainwindow.ui" line="385"/>
232 <location filename="mainwindow.ui" line="388"/>
233 <source>Font...</source>
234 <translation>Шрифт...</translation>
235 </message>
236 <message>
237 <location filename="mainwindow.ui" line="396"/>
238 <source>&amp;Import</source>
239 <translation>&amp;Импортировать</translation>
240 </message>
241 <message>
242 <location filename="mainwindow.ui" line="399"/>
243 <source>Import</source>
244 <translation>Импортировать</translation>
245 </message>
246 <message>
247 <location filename="mainwindow.ui" line="402"/>
248 <source>Convert video files.</source>
249 <translation>Сконвертировать видеофайлы</translation>
250 </message>
251 <message>
252 <location filename="mainwindow.ui" line="410"/>
253 <source>&amp;Configure qjadeo</source>
254 <translation>&amp;Настроить qjadeo</translation>
255 </message>
256 <message>
257 <location filename="mainwindow.ui" line="413"/>
258 <source>Configure qjadeo</source>
259 <translation>Настроить qjadeo</translation>
260 </message>
261 <message>
262 <location filename="mainwindow.ui" line="421"/>
263 <source>Disconnect and &amp;Exit</source>
264 <translation>Отсоединиться и в&amp;ыйти</translation>
265 </message>
266 <message>
267 <location filename="mainwindow.ui" line="424"/>
268 <source>Disconnect</source>
269 <translation>Отсоединиться</translation>
270 </message>
271 <message>
272 <location filename="mainwindow.ui" line="435"/>
273 <location filename="mainwindow.ui" line="438"/>
274 <source>to any frame</source>
275 <translation>К любому кадру</translation>
276 </message>
277 <message>
278 <location filename="mainwindow.ui" line="449"/>
279 <location filename="mainwindow.ui" line="452"/>
280 <source>keyframes only</source>
281 <translation>Только по ключевым кадрам</translation>
282 </message>
283 <message>
284 <location filename="mainwindow.ui" line="463"/>
285 <location filename="mainwindow.ui" line="466"/>
286 <source>continuously</source>
287 <translation>Непрерывно</translation>
288 </message>
289 <message>
290 <location filename="mainwindow.ui" line="478"/>
291 <location filename="mainwindow.ui" line="481"/>
292 <source>JACK Transport</source>
293 <translation>Транспорт JACK</translation>
294 </message>
295 <message>
296 <location filename="mainwindow.ui" line="492"/>
297 <location filename="mainwindow.ui" line="495"/>
298 <source>LTC (JACK)</source>
299 <translation>LTC (JACK)</translation>
300 </message>
301 <message>
302 <location filename="mainwindow.ui" line="506"/>
303 <location filename="mainwindow.ui" line="509"/>
304 <source>MTC (JACK MIDI)</source>
305 <translation>MTC (JACK MIDI)</translation>
306 </message>
307 <message>
308 <location filename="mainwindow.ui" line="520"/>
309 <location filename="mainwindow.ui" line="523"/>
310 <source>MTC (ALSA SEQ)</source>
311 <translation>MTC (ALSA SEQ)</translation>
312 </message>
313 <message>
314 <location filename="mainwindow.ui" line="534"/>
315 <source>off (slider)</source>
316 <translation>Выкл (ползунок)</translation>
317 </message>
318 <message>
319 <location filename="mainwindow.ui" line="537"/>
320 <source>off</source>
321 <translation>Выкл</translation>
322 </message>
323 <message>
324 <location filename="mainwindow.ui" line="550"/>
325 <location filename="mainwindow.ui" line="553"/>
326 <source>50%</source>
327 <translation>50%</translation>
328 </message>
329 <message>
330 <location filename="mainwindow.ui" line="561"/>
331 <location filename="mainwindow.ui" line="564"/>
332 <source>100%</source>
333 <translation>100%</translation>
334 </message>
335 <message>
336 <location filename="mainwindow.ui" line="572"/>
337 <location filename="mainwindow.ui" line="575"/>
338 <source>200%</source>
339 <translation>200%</translation>
340 </message>
341 <message>
342 <location filename="mainwindow.ui" line="583"/>
343 <location filename="mainwindow.ui" line="586"/>
344 <source>Maximize</source>
345 <translation>Во весь экран</translation>
346 </message>
347 </context>
348 <context>
349 <name>PrefDialog</name>
350 <message>
351 <location filename="prefdialog.ui" line="14"/>
352 <source>Preferences</source>
353 <translation>Параметры</translation>
354 </message>
355 <message>
356 <location filename="prefdialog.ui" line="23"/>
357 <source>General Settings</source>
358 <translation>Общие</translation>
359 </message>
360 <message>
361 <location filename="prefdialog.ui" line="31"/>
362 <source>Autoconnect ALSA Midi port (MTC):</source>
363 <translation>Автосоединение с портом ALSA MIDI (MTC):</translation>
364 </message>
365 <message>
366 <location filename="prefdialog.ui" line="80"/>
367 <source>Autoconnect JACK Midi port (MTC):</source>
368 <translation>Автосоединение с портом JACK MIDI (MTC):</translation>
369 </message>
370 <message>
371 <location filename="prefdialog.ui" line="129"/>
372 <source>xjadeo/xjremote executable:</source>
373 <translation>Файл xjadeo/xjremote:</translation>
374 </message>
375 <message>
376 <location filename="prefdialog.ui" line="175"/>
377 <source>xjinfo executable:</source>
378 <translation>Файл xjinfo:</translation>
379 </message>
380 <message>
381 <location filename="prefdialog.ui" line="221"/>
382 <source>mencoder executable:</source>
383 <translation>Файл mencoder:</translation>
384 </message>
385 <message>
386 <location filename="prefdialog.ui" line="268"/>
387 <source>Import Settings</source>
388 <translation>Импорт</translation>
389 </message>
390 <message>
391 <location filename="prefdialog.ui" line="274"/>
392 <source>Import to Codec:</source>
393 <translation>Используемый кодек:</translation>
394 </message>
395 <message>
396 <location filename="prefdialog.ui" line="320"/>
397 <source>mpeg4</source>
398 <translation>mpeg4</translation>
399 </message>
400 <message>
401 <location filename="prefdialog.ui" line="325"/>
402 <source>mjpeg</source>
403 <translation>mjpeg</translation>
404 </message>
405 <message>
406 <location filename="prefdialog.ui" line="330"/>
407 <source>msmpeg4</source>
408 <translation>msmpeg4</translation>
409 </message>
410 <message>
411 <location filename="prefdialog.ui" line="335"/>
412 <source>mpeg1video</source>
413 <translation>mpeg1video</translation>
414 </message>
415 <message>
416 <location filename="prefdialog.ui" line="340"/>
417 <source>mpeg2video</source>
418 <translation>mpeg2video</translation>
419 </message>
420 <message>
421 <location filename="prefdialog.ui" line="348"/>
422 <source>mencoder options:</source>
423 <translation>Параметры mencoder:</translation>
424 </message>
425 <message>
426 <location filename="prefdialog.ui" line="396"/>
427 <source>Default Import Destination Path:</source>
428 <translation>Каталог хранения импортированных файлов</translation>
429 </message>
430 <message>
431 <location filename="prefdialog.ui" line="463"/>
432 <source>&amp;Cancel</source>
433 <translation>О&amp;тменить</translation>
434 </message>
435 <message>
436 <location filename="prefdialog.ui" line="492"/>
437 <source>&amp;OK</source>
438 <translation>&amp;OK</translation>
439 </message>
440 <message>
441 <location filename="prefdialog.cpp" line="42"/>
442 <source>Select default destination folder</source>
443 <translation>Выберите папку для хранения импортированных файлов</translation>
444 </message>
445 </context>
446 <context>
447 <name>QJadeo</name>
448 <message>
449 <location filename="qjadeo.cpp" line="136"/>
450 <source>&amp;%1 %2</source>
451 <translation>&amp;%1 %2</translation>
452 </message>
453 </context>
454 </TS>
12901290 ShowWindow (theWindow);
12911291 //SelectWindow (theWindow);
12921292 SetWindowGroupLevel(winGroup, CGWindowLevelForKey(levelList[winLevel]));
1293 GetWindowBounds(theWindow, kWindowContentRgn, &oldWinBounds);
12931294
12941295 if(vo_fs)
12951296 window_fullscreen();
13581359
13591360 void fullscreen_mac (int a) {
13601361 vo_fs=a;
1361 window_fullscreen();
1362 if (vo_fs != vo_mac_fs)
1363 window_fullscreen();
13621364 }
13631365
13641366 int get_fullscreen_mac() {
3232 void close_ltcjack(void);
3333
3434 SMPTEDecoder *ltc_decoder = NULL;
35 long int monotonic_fcnt = 0;
3635 #define LTCFPS (25)
3736
3837 jack_nframes_t j_samplerate = 48000;
5756 SMPTETime stime;
5857 i=0;
5958
60
61 // TODO: use frame.posinfo for latency compensation..
6259 SMPTEFrameToTime(&frame.base,&stime);
6360 SMPTEDecoderErrors(d,&errors);
6461
6562 if (jt) {
6663 *jt=((stime.hours*60+stime.mins)*60 +stime.secs)*j_samplerate
67 + (int)floor(stime.frame*(double)j_samplerate/LTCFPS);
68 //printf("debug %i %lu \n",*jt,frame.posinfo);
64 + (int)floor(stime.frame*(double)j_samplerate/LTCFPS
65 + frame.startpos
66 );
67 //printf("LTC-debug %i %li %li\n",*jt,frame.startpos, frame.endpos);
6968 //TODO: use LTCsmpte's framerate or xjadeo convertor!
7069 }
71 /* TODO use frame.startpos or frame.endpos
72 * if (jf) {
73 *jf= frame.posinfo;
74 }*/
7570
7671 #ifdef DEBUG
7772 int ms;
106101 snd=(int)rint((127.0*val)+128.0);
107102 sound[i] = (unsigned char) (snd&0xff);
108103 }
109 SMPTEDecoderWrite(ltc_decoder,sound,nframes,monotonic_fcnt-j_latency);
104 SMPTEDecoderWrite(ltc_decoder,sound,nframes,-j_latency);
110105 #if 1
111106 myProcess(ltc_decoder,&ltc_position);
112107 #endif
113108
114 monotonic_fcnt += nframes; // XXX we don't need that here - TODO simply use latency as posinfo and subtract it later..
115109 return 0;
116110 }
117111
12421242 struct msgbuf1 txbuf;
12431243 txbuf.mtype=1;
12441244 snprintf(txbuf.mtext, BUFSIZ, "@%i %s\n", id, msg); // XXX
1245 if (msgsnd(msqtx, (const void*) &txbuf, strlen(txbuf.mtext), 0) == -1) {
1245 if (msgsnd(msqtx, (const void*) &txbuf, strlen(txbuf.mtext), IPC_NOWAIT) == -1) {
12461246 fprintf(stderr, "msgsnd failed., Error = %d: %s\n", errno, strerror(errno));
12471247 return -1;
12481248 }
12651265 return (-1);
12661266 }
12671267
1268 // TODO WHILE LOOP..
1269 char *t;
1270 if ((t = strchr(rxbuf.mtext, '\n'))) *t='\0';
1271 //if (strlen(rxbuf.mtext) < 1) return 0; // continue;
1272 exec_remote_cmd_recursive(cmd_root,rxbuf.mtext);
1268 char *t, *s;
1269 s=rxbuf.mtext; // TODO remember end of long messages..
1270 while (s && *s && (t = strchr(s, '\n'))) {
1271 *t='\0';
1272 if (strlen(s) < 1) continue;
1273 exec_remote_cmd_recursive(cmd_root,s);
1274 s=t+1;
1275 }
1276 remote_read_ipc(); // read all queued messages..
12731277 return(0);
12741278 }
12751279
586586
587587 for(i = 0; i<rv; i++)
588588 putchar(rxbuf.mtext[i]);
589 fflush(stdout);
589590
590591 if (!strncmp(rxbuf.mtext,"@100 quit.",9)) {
591592 if (want_verbose)
633634 //strncpy(txbuf.mtext,buf,BUFSIZ-1); // add '\n' and '\0'
634635 txbuf.mtext[BUFSIZ-1]=0;
635636
636 while (--retry && msgsnd(msqid, (const void*) &txbuf, strlen(txbuf.mtext), 0) == -1) {
637 while (--retry && msgsnd(msqid, (const void*) &txbuf, strlen(txbuf.mtext), IPC_NOWAIT) == -1) {
637638 usleep(50000);
638639 }
639640 if (!retry) {
640 printf("CTL: msgsnd failed. Error = %d: %s\n", errno, strerror(errno));
641 fprintf(stderr, "CTL: msgsnd failed. Error = %d: %s\n", errno, strerror(errno));
641642 }
642643
643644 offset-=((++end)-buf);