Installation

The installation is quite straight forward. Make sure that you have installed the latest version of xine-lib. At least version 1.0 is required. Then download and unpack oxine source tarball, change to the directory created and type.

./configure --prefix=/some/path
make
make install

If you checked oxine out of CVS make sure that you have recent versions of autoconf and automake installed. (Tested with: automake 1.7.2 and autoconf 2.57.) Then type

./autogen.sh --prefix=/some/path
make
make install

oxine can be configured at build time. These are some of the parameters ./configure accepts:

./configure --help
    .
  --disable-lirc          do not activate LIRC support
  --disable-joystick      do not activate joystick support
    .
  --disable-dvb           do not activate DVB support
  --disable-v4l           do not activate V4L support
  --disable-polling       do not activate support for disc polling
    .
  --enable-debug          enable debugging

Configuration

You should make sure, that your CDROM or DVD drive is mountable by the user running oxine and that the correct mountpoints are set in the oxine configuration file in ~/.oxine/config. This file is created the first time you run oxine.

LIRC

If you use LIRC, make sure that you don't have irxevent daemon running. Otherwise oxine may get all LIRC events twice which is quite annoying. There is a default lircrc file installed in $PREFIX/share/oxine. You can customize this file in place or - much better - copy it to ~/.oxine where it will not be overwritten if oxine is reinstalled. If you upgrade oxine, read the ChangeLog - the LIRC file config options may change from time to time.

Mediamarks

To customize the entries you see when entering the music, video or image section you should create mediamarks files (music_mediamarks.xml, video_mediamarks.xml and image_mediamarks.xml) in the oxine configuration directory /home/yourname/.oxine/. These files must follow the syntax defined in $PREFIX/share/oxine/mediamarks.dtd. You can also have a look at $PREFIX/share/oxine/mediamarks_example.xml.

Unscaled OSD

Since xine-lib version 1-rc3 a new method for rendering OSD (On Screen Display) and subtitles is supported. This method uses a X11 extension called XShape that allows using screen resolution instead of stream resolution. It is called "unscaled" OSD because it does not scale with the video being played.

Unscaled OSD is enabled by for oxine. Because scaled OSD gets really ugly with small video sizes. One major drawback is, that unscaled OSD does not support transparent colors. If you prefer transparent colors you can disable unscaled OSD by setting the key

gui.osd_use_unscaled:0

in the configuration file.

Shutdown Command

When pressing the "Shutdown" button in the main menu oxine executes a command that can be configured in the configuration file

misc.shutdown_command:/sbin/poweroff

This command can be used to shut off the computer.

Polling

If not disabled at compile time oxine looks for new media in all CDROM drives once every second. Whenever a disc is inserted or removed the disc automagically appears or disappears from the file lists.

Using the key

gui.discs.extra_devices:/dev/usbstick

in the configuration file it is possible to have oxine look for mountable media in non-standard locations.

Thumbnail Images

There are two ways to make oxine display thumbnail images in the filelist menu. The first way is to place the thumbnail image (call it title.jpg, title.png or title.gif) in the directory it belongs to. This makes sense if you have one MP3 albums per directory.

The second possibility is to add a thumbnail link to an entry in a mediamarks file:

<entry>
    <mrl href="dvd:/home/public/lotr.iso" />
    <title>[Lord Of The Rings (ISO)]</title>
    <thumbnail href="/home/public/lotr.png" />
</entry>

This feature is only available if you have ImageMagick installed on your computer.

Usage

Start oxine with...

Usage: oxine [OPTIONS] [MRL]

OPTIONS are:
  -v, --version                Display version.
      --verbose [=level]       Set verbosity level. Default is 0.
  -V, --video-driver <drv>     Select video driver by ID.
                               Available drivers:
                               auto xv xshm sdl
  -A, --audio-driver <drv>     Select audio driver by ID.
                               Available drivers:
                               alsa esd file none
  -f, --fullscreen             Start in fullscreen mode.
  -P, --no-polling             Disable disc polling.
  -L, --no-lirc                Turn off LIRC support.
  -J, --no-joystick            Turn off joystick support.

Controls

oxine can be controlled using a keyboard, a mouse or a remote control via LIRC. oxine comes with a configuration file for LIRC which should work on most systems.

Menu Navigation

Action	Keyboard	LIRC config
navigate the OSD	keypad arrow keys	up, down, left, right
first, last item in a list	keypad Home, End
activate an item	Enter	activate
select an item in a list	Space	select
go back up one level	Backspace	back
leave the program	q	shutdown
show/ hide playing menu	o	menu
jump directly to the main menu	Esc	mainmenu
toggle fullscreen mode	f

Stream Control

Action	Keyboard	LIRC config
stop	s	stop
eject	e	eject
adjust speed	arrow up/ down	speedup/ speeddown
seek in stream	arrow right/ left	fforward/ rewind
adjust volume	v / V, + / -	volume [+/-]
toggle mute/ unmute	m	volmute
toggle aspect ratio	a	toggle_aspect_ratio
toggle deinterlace	i	toggle_deinterlace
toggle pause/ play	Space	pplay
change audio channel	x / X	audio_channel [+/-]
adjust audio offset	c / C	audio_offset [+/-]
change subtitle channel	r / R	spu_channel [+/-]
adjust subtitle offset	t / T	spu_offset [+/-]
adjust zoom factor	Z / z	zoom [+/-]
adjust y-zoom factor	Z / z + ALT
adjust x-zoom factor	Z / z + CTRL
reset zoom factor	Z / z + CTRL + ALT

Playlist

Action	Keyboard	LIRC config
previous entry	p, Page-Up	prev
next entry	n, Page-Down	next

DVD

Action	Keyboard	LIRC config
next chapter	n, Page-Down	next
previous chapter	p, Page-Up	prev
jump directly to the DVD menus	F1-F7	menu1-menu7

Analog and Digital Television

Action	Keyboard	LIRC config
next channel	n, Page-Down	next
previous channel	p, Page-Up	prev

Keyboard Layouts

The keys on QUERTY keyboards

oxine keys on QUERTY keyboards

The keys on QUERTZ keyboards

oxine keys on QUERTZ keyboards

Problems

If you have trouble doing something with oxine please try to do the same thing with xine before reporting it as a bug. If it doesn't work in xine it will normally not work in oxine. This is not true the other way around as many things implemented in xine have not been added to oxine yet.

If you do find a bug please report it to the oxine-devel mailing list or send a mail to one of the developers directly. Good patches are very welcome.