NAME
xjadeo - displays a video clip in sync with an external timing source
SYNOPSIS
xjadeo [-abfFhiIkKLmMoPqQRStvVx] <videofile>
xjadeo -R [-Q] [-abfFhikKLmMoqsStvVx] [<videofile>]
xjadeo -Q [-R] [-abfFhikKLmMoqsStvVx] [<videofile>]
DESCRIPTION
xjadeo displays a video clip in sync with an external time source. It
is a handy tool to help with the synchronization of the soundtrack of a
video file. xjadeo supports different video file formats, video output
libraries and sync sources.
OPTIONS
-a, --ontop
Start xjadeo on top of other windows. (affects XV videomode only).
-b, --letterbox
retain aspect ratio and draw a letterbox around the move if
necessary. Note that this feature is only available with the Xv and
imlib2 video mode.
-C, --midiclk
use midi quarter frame timing for more exact sync.
-f <n>, --fps <n>
Desired refresh rate of the video display in frames per second.
Lower values lighten the CPU load at the cost of video quality.
Admits non-integer values. Defaults to 10.0 fps.
If this value is set to zero (or less), xjadeo will use the
framerate of the video file as its video update frequency. This is
highly recommended when decoding the video-frames continuosly
without seeking (-K)
-F <n>, --filefps <n>
Override the (autodetected) framerate of the videofile.
-h, --help
Prints usage help and exits.
-i <n>, --info <n>
Displays useful info using the OSD (on-screen display.).PP 0
Off.
1
Frame number.
2
SMPTE time code.
3
Both frame number and SMPTE.
The remote interface allows more complete control over the OSD.
-I, --ignorefileoffset
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's
pts/dts. -I 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 -o which
actually changes the SMPTE.)
-k, --keyframes
Instructs the internal algorithm to seek only keyframes. This
option may improve the performance for certain video encodings.
The default behavior (without -k and -K arguments) is to search any
ANY frame.
-K, --continuous
Decode video frame by frame, particularly only useful to read files
where not every frame is a keyframe at cost of CPU usage. Note that
this option adds some extra latency when seeking. combine with -f :
It makes sense to set xjadeo's framerate to equal the framerate of
the video file.
-L, --nolash
Disable LASH support.
-m <port>, --midi <port>
Get sync from MTC (MIDI Time Code) instead of jack.
If compiled with ALSA midi, <port> is the ALSA sequencer id of the
MTC source. A value of -1 will leave xjadeo unconnected.
If using portmidi, <port> is the portnumber of the midi input to
use. value -1 will attempt autoconnect. use -v -m -1 to list midi
ports during autodetection.
-M<n>, --midifps <n>
Conversion between MTC SMPTE and frame number.
0
Use MTC clock frame rate.
2
Use video file frame rate.
3
Resample video frame rate / MTC.
-o <n>, --offset <n>
Offset the video player a certain number of (video) frames relative
to the sync master time base. Admits negative values.
-P, --genpts
This option passed on to ffmpeg and has no effect on older versions
of libavformat.
it can be used to generate "presentation time stamps" if they are
missing in the file, even if it requires parsing future frames.
-q, --quiet, --silent
Suppresses normal output messages.
-Q, --mq
Enable POSIX message queues. Sets up a communication channel for
use with xjremote(1). See the the section called "Remote Control
Interface" in the documentation.
-R, --remote
Enables interactive (stdin/stdout) control mode. Options --quiet
and --verbose have no effect in remote mode.
-s, --fullscreen
Start xjadeo in full-screen mode (affects XV videomode only).
-S, --nosplash
Skip the on screen display startup sequence.
-t, --try-codec
Checks if the video file is encoded in a format suitable for use
with xjadeo and exits. If the video format is not supported the
exit code is 1.
-v, --verbose
Prints additional information during the execution.
-V, --version
Display version and compile-time configuration information and
exit.
-x <n>, --vo <n>, --videomode <n>
Selects the video output driver. Defaults to 0 (autodetect.) A
value of -1 makes the program list the available drivers and exit.
SYNC SOURCES
xjadeo currently supports the following synchronization sources:
o Jack transport.
o MTC (MIDI Time Code) via ALSA sequencer.
o MTC (MIDI Time Code) via portmidi.
o remote-ctrl seeks (not really a sync source).
VIDEO DRIVERS
xjadeo currently supports the following video output drivers:
o xv (YUV / YV12)
o SDL (YUV / YV12)
o X11 + ImLib (RGB / RGBA)
VIDEO FORMATS
xjadeo uses the ffmpeg libraries to decode video files, so a wide range
of codecs is available. Note, however, that not all the formats support
frame seeking. You can use a command like:
mencoder -idx -ovc lavc -lavcopts keyint=1 -nosound input_file.xxx -o output_file.avi
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 out
your disk space.
You may also want to shrink the size of the frame by adding the option
-vf scale=width:height
This will reduce the size of the avi file, will tax less the system
resources when displayed and will leave more space in the screen for
your audio software.
USER INPUT
xjadeo window accepts the following input:
o Resizing the window will resize the movie as well. (CAVEAT:
resizing a video frame to make it fit the window is a CPU expensive
operation unless you are using hardware overlay. If you are not
comfortable with the frame size of your movie it is more CPU
efficient that you re-encode the video file with the desired size
beforehand.)
o Pressing mouse button 1 will resize the window to the original
movie size.
o Mouse button 2 and 3 resize the window to match the movie aspect
ratio.
o Scroll Wheel (buttons 4,5) stepwise decreases/increases the window
size maintaining the original aspect ratio.
o Closing the window or pressing ctrl-C will terminate xjadeo.
o xjadeo >= v0.3.8 supports keyboard events. Pressing 'Esc' and 'q'
will end the program. depending on your display setup xjadeo
supports 'f' toggle fullscreen, 'a' toggle always-on-top and 'm' to
hide mouse cursor keystrokes. see the section called "Monitor
Window - Key bindings" in the documentation for more recent
additions.
REMOTE MODE
xjadeo -Q enables message queues; use xjremote to connect.
When started in remote mode (option -R or --remote) xjadeo will
interactively accept commands and issue responses through its standard
input/output mechanism.
Use the remote command help to get a quick overview of all available
commands. please refer to the docbook documentation for a complete
description of the remote commands.
FILES
xjadeo reads the following resource config files in this order:
1. /@SYSCONFDIR@/xjadeorc (usually /etc/xjadeorc or
/usr/local/etc/xjadeorc, which depends on your distribution and on
the configuration when building xjadeo)
2. $HOME/.xjadeorc
3. $HOME/xjadeorc
Each line in the config file must be in in the format:
KEY=VALUE
. If the first character on a line is either '#' or ';'. the line is
ignored. KEYS are not case sensitive. VALUES can be case sensitive
(fi. filenames) and are parsed identical to the corresponding command
line arguments (eg. -x SDL becomes videomode=SDL). Boolean values are
specified as 'yes' or 'no' (eg. quiet=yes).
currently supported rc KEYS: fps, fontfile, lash, letterbox, midiclk,
midismpte, mq, nosplash, quiet, seek, verbose and videomode. Which are
commented on in the example xjadeorc[1]
SEE ALSO
qjadeo(1)
xjremote(1)
xjinfo(1)
AUTHOR
Robin Gareus
linuxaudio.org
COPYRIGHT
Copyright (C) 2005, 2006, 2007, 2009 Robin Gareus, Luis Garrido
NOTES
1. xjadeorc
http://xjadeo.svn.sourceforge.net/svnroot/xjadeo/trunk/doc/xjadeorc