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 SVN 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-polling do not activate support for disc polling
--disable-weather do not activate weather support
.
--enable-vdr enable VDR support
--enable-debug enable debugging
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 $HOME/.oxine/config. This file is created the first time you run oxine.
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
misc.polling.devices:/dev/usbstick
in the configuration file it is possible to have oxine look for mountable media in non-standard locations.
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/lircrc. You can customize this file in place or - much better - copy it to $HOME/.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.
To customize the entries you see when entering the music or video section you should create mediamarks files in the oxine configuration directory $HOME/.oxine/.
music_mediamarks.xml video_mediamarks.xml
These files must follow the syntax defined in $PREFIX/share/oxine/DTD/mediamarks.dtd. You can also have a look at $PREFIX/share/oxine/mediamarks_example.xml.
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.use_unscaled_osd:0
in the configuration file.
When pressing the "Shutdown" button in the main menu oxine displays a dialog asking the user what he wishes to do. The standard option will always be 'Quit oxine'.
If the user specifies the necessary commands
shutdown.reboot_command:sudo /sbin/reboot
shutdown.shutdown_command:sudo /sbin/poweroff
shutdown.standby_command:sudo /sbin/standby
in the configuration file, the user can also choose to shutdown or reboot the computer or to switch the computer to standby mode.
This feature can be disabled by setting the key
shutdown.ask:0
in the configuration file.
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 album 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.
Starting with version 0.6 it is possible to configure oxine's main menu. The standard menu file is located in $PREFIX/share/oxine/mainmenu.xml.
This file should not be changed as it will be overwritten if you install oxine again. Instead you should copy this file to $HOME/.oxine/mainmenu.xml and add your changes there. The file must follow the syntax as described in $PREFIX/share/oxine/DTD/menu.dtd
The stardard menu file contains a complete set of allowed parameters and some examples.
Starting with version 0.6 oxine can be used with Klaus Schmidinger's Video Disc Recorder via the vdr-plugin-xine.
This is not enabled by default. You must add --enable-vdr when running configure.
As soon as you've got VDR and vdr-plugin-xine correctly configured, oxine should work with it without any further problems. You should change the digital television entry in mainmenu.xml to use 'vdr' instead of the default 'dvb' and you should also change the TV entry in lircrc to 'VDR'.
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
-X, --xineramascreen [=num] Sets the screen on which the fullscreen window
will be shown.
-F, --no-fullscreen Do no start in fullscreen mode.
-P, --no-polling Do not use automatic polling for removable media.
-L, --no-lirc Do not use remote control (LIRC).
-J, --no-joystick Do not use joystick support.
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.
| Action | Keyboard | LIRC config |
|---|---|---|
| navigate the OSD | arrow keys | up, down, left, right |
| activate an item | Enter | activate |
| select an item in a list | Space | select |
| go back/ up one level | Esc, Backspace | back |
| leave the program | q | shutdown |
| show/ hide playing menu | o | osdmenu |
| jump directly to the playback menu (only in playback mode) | F9 | playbackmenu |
| jump directly to the main menu | F10 | mainmenu |
| jump directly to the music menu | F11 | musicmenu |
| jump directly to the video menu | F12 | videomenu |
| toggle fullscreen mode | f |
| Action | Keyboard | LIRC config |
|---|---|---|
| stop | s | stop |
| eject | e | eject |
| adjust speed | Ctrl + arrow up/ down |
speed [+/-] |
| fast forward/ rewind | Ctrl + arrow right/ left |
fast_forward/ fast_rewind |
| seek in stream | Alt + Ctrl arrow right/ left |
skip [+/- sec] |
| adjust volume | v / V, + / - | volume [+/-] |
| toggle playmode normal, random, repeat |
M | playmode |
| 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 | Alt + Z / z | |
| adjust x-zoom factor | Ctrl + Z / z | |
| reset zoom factor | Ctrl + Alt + Z / z |
| Action | Keyboard | LIRC config |
|---|---|---|
| previous entry | Alt + page up, p |
prev |
| next entry | Alt + page down, n |
next |
| Action | Keyboard | LIRC config |
|---|---|---|
| previous chapter | Alt + page up, p |
prev |
| next chapter | Alt + page down, n |
next |
| escape from the menu | F1 | menu1 |
| go to the title menu | F2 | menu2 |
| go to the root menu | F3 | menu3 |
| go to the subtitle menu | F4 | menu4 |
| go to the audio menu | F5 | menu5 |
| go to the angle menu | F6 | menu6 |
| go to the chapter menu | F7 | menu7 |
| Action | Keyboard | LIRC config |
|---|---|---|
| previous channel | Alt + page up, p |
prev |
| next channel | Alt + page down, n |
next |
| Action | Keyboard | LIRC config |
|---|---|---|
| previous channel | Alt + page up, p |
prev |
| next channel | Alt + page down, n |
next |
| show the VDR main menu | F1 | menu1 |
| show channel menu | F2 | menu2 |
| show schedule menu | F3 | menu3 |
| show recordings menu | F4 | menu4 |
| depends on location | F5 | red |
| depends on location | F6 | green |
| depends on location | F7 | yellow |
| depends on location | F8 | blue |
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.
(c) 2005 by the oxine project - $Id: doc.html 1335 2006-10-13 10:30:29Z mschwerin $