diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/FAQ.in | 450 | ||||
-rw-r--r-- | doc/MRL.txt | 13 | ||||
-rw-r--r-- | doc/Makefile.am | 41 | ||||
-rw-r--r-- | doc/README | 335 | ||||
-rw-r--r-- | doc/README.freebsd | 66 | ||||
-rw-r--r-- | doc/README.syncfb | 144 | ||||
-rw-r--r-- | doc/bug_report_form | 62 | ||||
-rw-r--r-- | doc/dataflow.dia | bin | 0 -> 2799 bytes | |||
-rw-r--r-- | doc/man/Makefile.am | 9 | ||||
-rw-r--r-- | doc/man/en/Makefile.am | 11 | ||||
-rw-r--r-- | doc/man/en/xine.1.in | 173 | ||||
-rw-r--r-- | doc/man/fr/Makefile.am | 46 | ||||
-rw-r--r-- | doc/man/fr/xine.1.in | 165 |
13 files changed, 1515 insertions, 0 deletions
diff --git a/doc/FAQ.in b/doc/FAQ.in new file mode 100644 index 000000000..66966a82d --- /dev/null +++ b/doc/FAQ.in @@ -0,0 +1,450 @@ + + ---------------------- + xine FAQ + ---------------------- + + +how do I build this beast? +-------------------------- + +first make sure you use a stable, official release of gcc to compile. +You can try patched gcc versions, but these are not supported and will +probably not work (pgcc for example is known to make libmpeg break). + +./autogen.sh <--- only neccessary if you checked xine out of CVS +./configure +make +make install + + +how can I supply additional CFLAGS for the compilation ? +-------------------------------------------------------- + +you can do so by setting the GLOBAL_CFLAGS variable and then run +configure again. + +This can be usefull to specify additional include paths or library +paths to the compiler. Example: + +export GLOBAL_CFLAGS="-I/usr/include -L/home/guenter/xine_libs" + + +Are there binaries for my K7 available? Can I build them? +--------------------------------------------------------- + +At the moment we do not provide K7 binaries, since the latest +stable gcc version (2.92.2 at the time of this writing) doesn't +have K7 support. Use the 686 binaries instead. These binaries +should run ok and will use 3DNow! + +If you have a newer gcc you can try to compile "more" k7 support +in (esp. better instruction sheduling). If the configure script +should fail to detect your processor/gcc correctly, try setting the +XINE_BUILD envvar explicitly to a valid description string for +your configuration, e.g. + +export XINE_BUILD=k7-pc-linux-gnu +rm -f config.cache +./autogen.sh +make +make install + + +xine fails with "no video port found" +------------------------------------- + +you got the Xv extension, but your video card driver doesn't +support it. First try to find a driver that does support Xv on +your hardware (check your graphics card vendor). If your driver +has Xv support but you can't get it working, try at a lower +resultion (1024x768 is still enough even for anamorphic mpeg-2). + +If all that fails, supply the "-s" option so xine will be forced +to use Xshm output (remember to switch to 16bpp for speed) + +xine -s foo.vob + + +xine fails complaining about audio drivers/devices +-------------------------------------------------- + +You can select the audio driver using the -A option. So try + +xine -A null + +If you have ALSA drivers installed, try + +xine -A alsa + +If you run ESD, try + +xine -A esd + + +xine displays it's logo but I don't see my video? +------------------------------------------------- + +use the play button of the gui or press RETURN for PLAY. + + +xine plays audio but I don't see a picture +------------------------------------------ + +If you see lot's of "rejected" messages, your hardware isn't +set up right for xine. It might be your sound card doesn't +support the "realtime" feature (xine tests that on startup +so you might want to look at the messages again). Try to +find better drivers then. + +Perhaps your hardware is simply to slow - see "xine drops a +lot of frames" below for speed tips. + +If you're using Xv and the video output stays blank, try +moving the window around or toggling fullscreen ("F" key). +There is a bug in overlay setup [FIXME]. + + +Where should I put the windows codec dlls for xine? +--------------------------------------------------- + +store them in + +@w32_path@ + + +xine crashes when I try to play AVI files +----------------------------------------- + +win32codec support is still experimental. It should work ok if +your system meets these requirements: + +- Xv driver is working +- the AVI file contains mpeg audio +- you've got the right codecs installed correctly in + @w32_path@ + + +I get this message: demux error! 00 00 00 (should be 0x000001) +-------------------------------------------------------------- + +Probably xine can't access your input source. Most commonly this happens +when you're trying to play locked/encrypted DVDs. Remember that xine +can't play such DVDs out-of-the box (for legal reasons). + +You could use an css-enabled DVD input plugin to avoid this. + +Another reason could be that your (RPC-2) DVD drive isn't set up +for the right region. + + +I get messages such as "Ouch! lastPTS : 100657583 current pts : 100652798" +-------------------------------------------------------------------------- + +Looks like your sond card / driver fails to provide exact timing +information. Try to find better drivers (oss <-> alsa). + +If you're using alsa, make sure xine is using the native alsa API and +_not_ the oss emulation. Use + +xine -A alsa + +I get lots of "200 frames delivered, 200 frames skipped, 0 frames discarded" +---------------------------------------------------------------------------- + +looks like you've selected the wrong audio channel or you're trying to +play a stream that uses features xine doesn't support (yet). + + +when I play this stream, xine shows some pictures but there's no audio +---------------------------------------------------------------------- + +Try another audio channel: + +xine -a channel stream.vob + +some .vob files have audio on strange channels (e.g. 3, 7, 10) + + +can xine play SVCDs ? +--------------------- + +Yes, but you'll have to experiment with the audio channels + +xine -a channel VCD://<track number> + +Normally, you should find an audio track #8 and, for bilingual SVCDs #9, so + +xine -a 8 + +shoud allow you to press the "vcd" button and play your SVCDs + + +xine drops a lot of frames +-------------------------- + +Your hardware is too slow for xine. Make sure you turn on all +speed optimizing options. A few point you should check: + +- use a recent kernel optimized for your hardware + +- use the latest gas/gcc + +- close other applications (use a tool like "top" to find out + what applications are using up CPU power) + +- if you are not using Xv, make sure your display is set up + to 16bpp, not 24 or higher (reduces memory bandwith) + +- make sure the hard drive which supplies the video data + is in DMA mode (if supported) + Under linux, you can use hdparm to check this, for example + + hdparm /dev/hda + + => + ... + using_dma = 1 (on) + + more information about this may be found here: + + http://oreilly.linux.com/pub/a/linux/2000/06/29/hdparm.html + +- xine needs high speed memory access which depends on your chip set. + Make sure you enable all speed-improving options. + + especially the via apollo pro chipset is known to be quite weird, + (most of all on my gigabyte board). If you can't configure the ram + access thoroughly using the bios you might want to try some really + nasty tricks, as explained on (for example) + http://www.overclockers.com/tips105/index03.asp + this website centers around a windows-tool to tweak the chipset, + you can do the same on FreeBSD with pciconf. On some linux + distributions there are similar tools. + + please contact heiko if you have any problems or tips about via + apollo pro chipset tweaking. + +- a nice performance tuning tool can be found here: + + http://powertweak.sourceforge.net + +- enable MTRR support in your kernel. If you are still using XFree 3.x, + you'll have to tell the kernel yourself where the graphics memory is. + You'll find details about that in the linux dvd howto. + + If you're using XFree 4.x enabling MTRR support should be enough. + + Try a cat /proc/mtrr - if the file exists and you find an entry + corresponding to the amount of graphics memory you have, everything + should be fine. + +- set up and use raw devices for dvd access + + raw devices should be available in linux kernel 2.4.x and there + are patches for older kernels available from + + ftp://ftp.kernel.org/pub/linux/kernel/people/sct/raw-io/ + + to use raw devices, first connect a free raw device to your dvd + device, use something like + + raw /dev/raw1 /dev/hdc + + then create a link named "rdvd" pointing to that raw device + + ln -s /dev/raw1 /dev/rdvd + + +Now how do I get this Xv extension to work? +------------------------------------------- + +First you need to install/use XFree 4.x. Once you got that you have to +make sure the XFree drivers you're using are supporting Xv on your +hardware. Here are some locations to look for suitable drivers: + +g200/g400 : xfree 4.x supports these out-of-the-box +nvidia cards : www.nvidia.com (the've got binary drivers) +ATI cards : GATOS www.linuxvideo.org/gatos/ +i815 : the latest xfree 4.x code supports these +3dfx (voodoo): the latest xfree 4.x code supports these + + +The AC3 via S/PDIF does not work with my soundcard +--------------------------------------------------- + +The AC3 via S/PDIF is supported by ALSA only for soundcards +with Trident 4DWaveNX and YMF chips. So if you have a +soundcard with one of these chips use + +xine -S -A alsa + +The -S switch disables the internal AC3 decoder. For very +slow machines you could improve video playback (without +sound) when you start xine as + +xine -S -A null + + + +where and how do I get the latest development version? +------------------------------------------------------ + +check it out of our CVS: + +cvs -d :pserver:anonymous@cvs.xine.sourceforge.net:/cvsroot/xine login + +<empty password> + +cvs -d :pserver:anonymous@cvs.xine.sourceforge.net:/cvsroot/xine co xine + + + +How do I use the dvd plugin? +---------------------------- + +First of all: +The dvd plugin delivered with xine currently does not support playback +of locked and/or encrypted dvds. You will need external programs +or something like an "improved" xine_dvd_plugin to view these +DVDs with xine directly. Of course you could +play back the decrypted mpeg2 stream (technically speaking) that is the +movie on the dvd with xine with the help of additional programs. +Due to the uncertain legal situation regarding css encryption we do +not include anything of that nature in the xine distribution, nor do +we generally endorse the use of such software (you should check if +the use of such software is legal where you live). +We hope that this situation will change soon. + +For unlocked/unencrypted dvds it is a good idea first to check what +files are on the dvd by mounting it. The files are called something +like .../VIDEO_TS/VTS_xx_x.VOB, where x are numbers. +If you look for the big .VOB files on a dvd these are probably where the +movie is in. Currently we don't support seamless playback of complete +movies - you will have to play back all of its individual parts. + +To play that VOB file use something like + +xine dvd://VTS_xx_x.VOB + +make sure you do not supply any path name (no VIDEO_TS/) and use +capital letters for the file name. + +xine tries to open the dvd using /dev/cdrom. On freebsd this will only +work if you create a symlink to your dvd-devicenode for the time being. + + +unable to open dvd drive (/dev/dvd) +----------------------------------- + +You probalby don't have /dev/dvd (check that). If so, simply +create a link /dev/dvd that points to your DVD device. +Something like + +cd /dev +ln -s hdc dvd + +should do the job. + + +The aspect ratio is wrong! +-------------------------- + +Try pressing "A" (preferable when xine is stopped, otherwise +you may experience a segfault). + + +How do I play streams from STDIN ? +---------------------------------- + +use something like + +cat stream.mpg | xine stdin://mpeg1 + +or, if you've got an mpeg-2 stream use + +cat stream.vob | xine stdin://mpeg2 + + +How do I change the skin? +------------------------- + +Run xine at least once - it should write it's config file +.xinerc to your home directory. Now edit that file and change +the line "skin:default" to mach the skin you would like to use. + + +How can I change color/brightness/contrast? +------------------------------------------- + +At the moment this is only supported on some Xv drivers. You'll find +three entries like these in our ~/.xinerc: + +brightness:0 +saturation:0 +contrast:128 + +the values and possible ranges depend on your Xv driver so you'll have +to experiment a bit to get a good picture. + + +Some parts of my X Desktop get transparent when xine plays the video! +--------------------------------------------------------------------- + +Looks like some colors on your GUI match the colorkey Xv uses. You can +change the colorkey value to avoid this. There should be a line like + +colorkey:2110 + +to your ~/.xinerc where you can change the color that's used by xine +for the video overlay. + + +I get no sound, but "audio driver 'oss' failed, using null driver instead." +--------------------------------------------------------------------------- + +First of all, make sure that your OSS Audio drivers are working (ie you can +play music with other software). + +The most common reason for this is that some other program is accesing your +audio device. If you're using linux, the command "fuser /dev/dsp" should give +you the PID of the process. + +If you are using GNOME, chances are, that this is caused by ESD. Now you +have two possibilities. Either deactivate ESD (temporarily) by right +clicking on the sound monitor applet and selecting "Place Esound in +standby". Then xine will use OSS audio output. The other method is to make +xine use ESD for audio output with + +xine -A esd + +This may result in more jerkier playback, so the first method is the +preferred one. + + +after running xine several times it fail's to allocated shared memory! +---------------------------------------------------------------------- + +This should be fixed in xine 0.3.3 or later. However, this can only work if +you exit xine the "correct" way (e.g. using the panel or pressing "q"). +Do _not_ simply close the video output window using your window manager - +xine won't release shared memory in this case (!). + + +i have problems when using xine on FreeBSD +------------------------------------------ + +check if you find what you are looking for in the file README.freebsd + + +I think I found a bug! +---------------------- + +xine is in it's early developement stages. Please be patient. +If you got time, please contact us and send us a full bug report. +Please include all xine console output and some details about +your hardware and operating system. + +You can reach us via email: + + Xine Mailing List <xine-user@lists.sourceforge.net> + diff --git a/doc/MRL.txt b/doc/MRL.txt new file mode 100644 index 000000000..fa084c3b3 --- /dev/null +++ b/doc/MRL.txt @@ -0,0 +1,13 @@ + MRL - Media Resource Locator + ============================ + + +File : path/foo.vob + /path/foo.vob + file://path/foo.vob + +DVD : dvd://VTS_01_2.VOB + +VCD : vcd://1 + + diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 000000000..a463f1b98 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,41 @@ + +SUBDIRS = man + +EXTRA_DIST = $(docs_DOCS) MRL.txt dataflow.dia + +docdir = $(prefix)/share/doc/xine +docs_DOCS = README README.syncfb README.freebsd FAQ bug_report_form + + +install-data-local: + @documentations='$(docs_DOCS)'; \ + for doc in $$documentations; do \ + destdir=$(docdir); \ + name=`echo $$doc` \ + dir=$$destdir; \ + $(mkinstalldirs) $$dir; \ + $(INSTALL_DATA) $$doc $$dir/$$name; \ + echo "installing $$doc as $$dir/$$name"; \ + done + + +uninstall-local: + @documentations='$(docs_DOCS)'; \ + for doc in $$documentations; do \ + destdir=$(docdir); \ + name=`echo $$doc` \ + dir=$$destdir; \ + rm -f $$dir/$$name; \ + echo "removing $$dir/$$name" ; \ + done + + +debug: + +mostlyclean-generic: + -rm -f *~ \#* .*~ .\#* + +maintainer-clean-generic: + -@echo "This command is intended for maintainers to use;" + -@echo "it deletes files that may require special tools to rebuild." + -rm -f Makefile.in diff --git a/doc/README b/doc/README new file mode 100644 index 000000000..ff41e9421 --- /dev/null +++ b/doc/README @@ -0,0 +1,335 @@ + + ---------------------- + xine + ---------------------- + + a unix video player + + + +about xine: +----------- + +xine is a free gpl-licensed video player for unix-like systems. +We support mpeg-2 and mpeg-1 system (audio + video multiplexed) streams, +mpg audio files and AVI files (using win32 codec dlls). + +xine plays the video and audio data of the stream and synchronizes +the playback of both. Depending on the properties of the stream, +playback will need more or less processor power, full frame rate +for mpeg-2 has been seen on a 400 MHz P II system. + +xine can play Video CDs, SVCDs and DVDs directly. Unfortunately the legal +status of encrypted/locked DVD playback is uncertain in some countries +so we cannot include any DVD unlock/decrypt code with xine. To play back +such DVDs you'll need external programs or something like a +xine_dvd_plugin that can handle DVD authentification/descrambling. + +xine tries to be straightforward and effective. ...no bells and +whistles are being developed at this time ;-) first we want to achieve +good playback of video. + + +supported platforms / requirements: +---------------------------------- + +- xine needs a locally attached graphics device and monitor (playback over + x is not supported at the moment and will probably never be really useful + because of the enormous bandwidth of decoded video streams). +- xine needs either MIT-SHM (The MIT Shared Memory Extension), which is + supported in XFree86 for quite some time (3.3.x will be fine), + or X-Video Extension (Xv) which is faster and supports fullscreen + operation but is only provided by some XFree86 4.x drivers. + nVidia chips and Matrox G200 and G400 are known to work. +- if you can't get Xv to run on your platform you should use 16bpp + colordepth for speed. Xv seems to work nicely for 16 and 24bpp. +- if you have a mga 200 / 400 graphics adaptor you can optionally + use the sybcfb/teletux video ouput driver. See README.syncfb for + details. +- you need a sound driver that is realtime capable (not all + OSS/ALSA drivers support that feature) or ESD + +xine has so far been sucessfully used on the following systems: + +- Linux on a Pentium III 667 + using XFree86 4.01 on a nVidia Riva TNT 2 +- Linux on a Pentium II 400 + using XFree86 3.3.6, 4.0, 4.01 and 4.02 on a nVidia Riva TNT +- FreeBSD 4.1-Release on a Celeron 400 + using XFree86 3.3.6 and 4.0.1 on a Matrox G400 +- Linux on a Pentium 120 (no MMX) + using XFree86 3.3.5 on a Trident 9660 +- Linux on an AMD K6-266 + using XFree86 3.3.5 on a ATI AIW M64-8Mb PCI +- Linux on an AMD K6-III 450 + using XFree86 3.3.6 on a ATI RageII 8MB +- Linux on a Celeron 633 + using XFree86 4.0.1 on a ATI AIW Rage128-16MB +- Linux on a Amd K7@550 + using Xfree 4.0.1 on a Ati Rage 128 16 Mb + (Xv is working on this configuration with drivers from GATOS project) +- Linux on a Celeron 667 + using XFree86 4.0.2 on a Riva TNT 16Mb + (Xv is working on this configuration with closed-sources drivers + version 0.9.5 from NVidia). + +Work for non-Intel platforms has started but has not yet reached a +working state. + +usage: +------ + +You can start xine without any command line parameters or you can +specify one or more input streams directly. Xine tries to detect wheter +it can use the Xv extension and will fall back to XShm, but that +detection might fail. +If you don't see any video, first check your X11 drivers (for example +only the binary drivers from nVidia have Xv support for their chips). +If you can't get Xv to work, use the "-s" option and xine will be +forced to use Xshm. +If you get very sloppy video ouput your sound driver may not be +realtime capable. Try to use ALSA instead or, if you're already using +ALSA you might want to give OSS a try. +If you want to send the sound over a network with ESD, set the ESPEAKER +environment variable before starting xine. + +The input stream can be a filename or something we call +"MediaResourceLocator" MRL, which looks similar to a URL. First you +specify an input source which is followed by "://" and an input-source +specific identifier. What input sources you can use depends on the +input plugins you have (for plain files you can omit the input-source +identifier). Try + +$ xine --help + +to get the complete usage. + +Unfortunately the gui does not yet support the MRL concept to any +great extend, so to use any other input source than plain files you'll +have to use the command line at the moment. That will change soon :-) + +Example usage: + +$ xine + +$ xine /path/foo.vob + +$ xine -s /foo/test.mpg + +xine supports the xdnd protocol (Version 3) so if you have a file browser +application supporting that protocol (e.g. gmc) you can drop video files +on xine for playback. + +Playing track 3 from a VCD: + +$ xine vcd://3 + +Example for direct DVD access: + +$ xine dvd://VTS_01_1.VOB + +Keyboard shortcuts: +------------------- + +Key action + +RETURN play +F toggle fullscreen mode +Q quit +0 jump start of current stream +1-9 jump to 10-90% of current stream +SPACE pause +PgUp/Prior jump to previous playlist entry +PgDown/Next jump to next playlist entry +A toggle aspect ratio (AUTO/16:9/4:3/DVB) +Ctrl show/hide mouse cursor + +more to come. + +Click right on the video window to toggle panel visibility. + +selecting audio channels: +------------------------- + +Supply the -a option to select the desired audio track: + +xine -a 3 test.mpg + +plays the third mpg audio track (and the video, of course). + +For mpeg-1, only mpeg audio (layer 1, 2 and 3) is supported. + +Mpeg-2 streams can have different types of audio streams, though. +Xine supports ac3 (dolby digital), mpeg and LPCM sound. These +are mapped to the following tracks: + +Track selected audio stream + + 0- 7 ac3 stream 0-7 + 8-15 mpg audio stream 0-7 +16-23 pcm audio stram 0-7 + +example: to play pcm stream 0 use + +xine -a 16 file.vob + +selecting subtitles: +-------------------- + +Subtitles are embedded in different tracks like audio. In general, +track 0 is the default language subtitle. Use the -u option to +select the desired subtitle track: + +xine -u 0 test.vob + +displays the subtitles from stream 0. + +controlling xine via CORBA: +--------------------------- + +Xine implements a CORBA server interface to enable remote control and +scripting. For this, you need ORBit which should already be installed if +you are using GNOME. Otherwise you can get it from + + http://orbit-resource.sourceforge.net/ + +Any version of ORBit >= 0.4.0 should work fine. + +To enable the CORBA interface, you need to supply the "--enable-corba" +argument to the ./configure script and recompile xine. + +The xine server interface definition can be found in "corba/xine.idl" which +gets installed to "/usr/share/idl/xine.idl" by default. + +To communicate with xine via CORBA, you need to get its IOR (Interoperable +Object Reference). Upon startup, xine writes it to the file ~/.xine.ior +where you can read it from. If the ORBit name service is running, xine +also registers itself there under the name "Xine". Unfortunately, the +ORBit name server is usually not activated by default. You have to run +it manually like this: + + orbit-name-server >/tmp/name-service-ior & + +See the ORBit docs for more information. + +Two example client programs are provided: + 1. "xine-remote" is an example client written in C which can be used to + send play/stop/pause commands to a running instance of xine + 2. "example.py" is a small Python script that demonstrates how to easily + control xine from a scripting language + +using LIRC with xine: +--------------------- + +Xine can be remotly controlled with by IR. For this, you should have +LIRC installed (http://www.lirc.org), you should get latest CVS snapshot +if you're running latest Linux kernels (2.2 or 2.4 series). + +You should add some entries in your ~/.lircrc, like this: +begin + remote = SAMSUNG + button = Button_Play + prog = xine + repeat = 0 + config = PLAY +end +begin + remote = SAMSUNG + button = Button_Src + prog = xine + repeat = 0 + config = DVD +end +begin + remote = SAMSUNG + button = Button_1 + prog = xine + repeat = 0 + config = 10% +end +... + +All valids strings orders are: + + - for quiting: + quit + - for set the current position in current stream playback: + 0%, 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90% + - for play or stop: + play + - for pausing: + pause + - for eject: + eject + - for next/previous MRL in the playlist: + next, prev + - for next/previous audio track selection: + audio+, audio- + - for next/previous sub-title selection: + spu+, spu- + - to get the playlist from a DVD/VCD: + dvd, vcd + - to hide/show the GUI, the output video window: + hidegui, hideoutput + - to toggle the output video window<->fullscreen + fullscr + +All of orders are not case sensitive. + +used software: +-------------- + +xine uses software from the following free software projects: + +- libac3 by Aaron Holtzman +- libmpeg2 by Aaron Holtzman +- libmpg123 of the mpg123 project by Michael Hipp + (see http://www.mpg123.de/) + +...without these great pieces of software xine would of course not +be where it is now. + +also many thanks to the Linux Video and DVD Project "LiViD" +(http://www.linuxvideo.org/), where the original ideas for the xine +video player came from. + +developers of xine: +------------------- + + main xine developer: + Guenter Bartsch + + various suggestions, bug and build fixes, alsa plugin, gui + Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> + + audio programming + Siegfried Langauf <siggi@users.sourceforge.net> + + contributes great libmpeg2 hacks: + Michael Lespinasse + + ...plus various other contributors, see the AUTHORS file + + +contacting the xine project: +---------------------------- + + the xine project website is + + http://xine.sourceforge.net + + feedback or offers for help are greatly appreciated, please contact + + + The Xine User Mailing List <xine-user@lists.sourceforge.net> + ================================= + + + If, for some reason, you can't post to the list, you may contact the authors + directly: + + Guenter Bartsch <guenter@users.sourceforge.net> + Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> + Siegfried Langauf <siggi@users.sourceforge.net> + + $Id: README,v 1.1 2001/04/18 22:36:13 f1rmb Exp $ diff --git a/doc/README.freebsd b/doc/README.freebsd new file mode 100644 index 000000000..eec8c5bac --- /dev/null +++ b/doc/README.freebsd @@ -0,0 +1,66 @@ +xine fails when allocating images +--------------------------------- + +Make sure you have enough shared memory enabled. This is very +limited by default. + +Edit your /etc/sysctl.conf: + +kern.ipc.shmmax=67108864 +kern.ipc.shmall=32768 + + + +playing video cd on freebsd +--------------------------- + +currently (because of issues with the freebsd kernel) xine can only +play video cd from atapi cdrom drives. not for scsi drives! + +currently (Jan 2001), FreeBSD-stable (and thus the current releases also) +needs a patch to the kernel sources to make video cd work (please check +the freebsd documentation if you are unsure on how to build a custom +kernel with this patch included). + +the file you have to patch is /sys/dev/ata/atapi-cd.c: + +*** atapi-cd.c.orig Sun Jan 21 14:42:57 2001 +--- atapi-cd.c Sun Jan 21 14:47:13 2001 +*************** +*** 1163,1174 **** + return; + } + } +! if (blocksize == 2048) +! ccb[0] = ATAPI_READ_BIG; +! else { +! ccb[0] = ATAPI_READ_CD; +! ccb[9] = 0x10; +! } + } + else + ccb[0] = ATAPI_WRITE_BIG; +--- 1163,1182 ---- + return; + } + } +! switch (blocksize) { +! case 2048: +! ccb[0] = ATAPI_READ_BIG; +! break; +! +! case 2352: +! ccb[0] = ATAPI_READ_CD; +! ccb[9] = 0xf8; +! break; +! +! default: +! ccb[0] = ATAPI_READ_CD; +! ccb[9] = 0x10; +! } + } + else + ccb[0] = ATAPI_WRITE_BIG; + +------------------------------------------------------------------------ + diff --git a/doc/README.syncfb b/doc/README.syncfb new file mode 100644 index 000000000..092188eb3 --- /dev/null +++ b/doc/README.syncfb @@ -0,0 +1,144 @@ + + ===== ===== + XINE video output plugin for MATROX G400 / G200 cards *only* + ===== ===== + + + +* WHAT IS THIS PLUGIN ABOUT and WHY SHOULD I EVEN CONSIDER TO USE IT? :) + + This XINE video output plugin uses the so called Teletux driver which + provides special hardware features of the Matrox G400 and G200 cards + like deinterlacing, scaling and YUV data to RGB conversion --- just to + name a few. The plugin makes all those features available to XINE and + because all this tasks are done by the graphics card there is no need + for XINE to do them in software -- so you save precious CPU time which + you may gonna need for other things. :-) + + Another feature of this plugin is the synchronisation of the video + picture with the refresh of your screen. Before you ask why you would + need that - here the explanation... :) + + In order to have an optimal DVD playback the update of the image needs + to be syncronized with the refresh of the screen. Otherwise you will + sometimes see part of frame n and part of frame n+1 during an refresh. + This results in tearing artefacts on moving objects. + + When using this plugin the update of the screen is done in the V-SYNC + phase of your screen - and the tearing artefacts are gone forever. + + +* AND HOW DOES IT WORK? + + The Teletux driver is a module you will have to load that makes a + special device (/dev/syncfb) available which is opened by the plugin + and controlled with certain ioctl calls. Quite easy, isn't it? ;) + + That module is based on the mga_vid driver from Aaron Holzmann and was + advanced (and reworked) by Matthias Oelmann. + + +* OK I HEARD ENOUGH - HOW DO I INSTALL and USE IT? :) + + First of all you will need to get the Teletux driver itself. It's + available at http://teletux.sourceforge.net. Once you downloaded it, + unpack it to some directory of your choice, please read the README and + compile it (a normal "make" should work out-of-the-box). Now there are + only a few things left for you to do... + + 1) Become root. Hey now you can take over the world *evil laugh* :-))) + 2) Create a device called /dev/syncfb ===> mknod /dev/syncfb c 178 0 + 3) Copy the file "syncfb.o" to your modules directory (usually this is + /lib/modules/YOUR_KERNEL_VERSION/) and do a "depmod -a". + + This should be it. In order to use the Teletux driver you will have to + load it with the command "insmod syncfb.o" - please note that you will + have to load it every time you reboot if you wanna use the driver. + + XINE autodetects the driver and automaticly uses this plugin. + + It is possible now that the image during video playback is jerking. + This could be caused by the syncronisiation of the video image with + your screen refresh. You can easily fix that by switching your monitor + to the appropriate refresh rates (50 Hz for PAL, 60 Hz for NTSC). You + will need to add so called modelines to your XFree86 config to make + those 50 Hz/60 Hz modes available. + + Here is is a short listing of some sample modelines. Please add only + those two lines (for NTSC and PAL) which exactly fit the screensize + you are running your X Server with. You need to add those lines to the + monitor section of your XF86Config file as well as include their names + in the screen section (subsection display of the color depth your are + using). + + USE THE FOLLOWING MODELINES AT YOUR OWN RISK. THEY COULD DAMAGE YOUR + MONITOR PERMANTELY - PLEASE TAKE CAUTION AND DON'T BLAME US. YOU HAVE + BEEN WARNED. + + So much for the standard disclaimer. :) + + Note: If you want to be on the safe side, generate your very own + modelines with an application like kvideogen or use a service + like http://zaph.com/Modeline/ on the web. + + Also the modelines may need some fine tuning for your setup. You + can use xvidtune (comes with XFree86) to do that. + + # 1024x768 + + Modeline "1024x768pal" 64.94 1024 1040 1216 1328 768 768 775 802 + Modeline "1024x768ntsc" 54.32 1024 1040 1216 1328 768 768 774 802 + + # 1152x864 + + Modeline "1152x864pal" 68.82 1152 1168 1384 1496 864 864 871 902 + Modeline "1152x864ntsc" 80.93 1152 1168 1384 1496 864 864 872 902 + + # 1280x1024 + + none yet - will be added soon + + So before you run XINE please turn to the appropriate refresh rate and + the jerking should be gone. + + +* WHAT SCREENSIZE SHOULD I PREFER? + + Well. It is important that the screensize you choose for DVD playback + is exactly the same screensize you're starting up your X Server with. + So you shouldn't switch down to 1024x768 if you are running 1280x1024 + because that gives you a virtual screensize of 1280x1024 in a + resolution of 1024x768 - and the plugin cannot handle that yet. + + Now back to the question. A screensize of 1024x768 should be it. A DVD + is always 720x576 for pal and 720x480 for ntsc. If you've an anamorphe + DVD the image only has to be horizontally scaled to get back to the + original geometry of 16:9 which is easier to be done. + + +* WHERE IS THE WINDOW A VIDEO IS USUALLY DISPLAYED IN? + + The Teletux driver is writing directly to the video memory of the G400 + or G200 card and bypasses your X server. Getting that overlay into a + real window isn't as easy as you might think. + + For now a borderless window is being used which lays under the overlay + so you can click on the overlay (for the panel to appear) or issue any + command XINE supports by keyboard while you're over the overlay with + your mouse cursor. + + +* WHAT IS ON THE TODO LIST? + + The plugin does not yet activate the hardware deinterlacing. + The mouse cursor doesn't disappear yet when it should be disappearing. + Prevent the panel from hidding behind the overlay by moving it out of range. + Bug fixes, new features and optimizations. :-) + + +* CONTACTS and FEEDBACK + + Joachim Koening <joachim.koenig@gmx.net> + Matthias Dahl <matthew2k@web.de> + + or use the XINE User Mailinglist. (more infos see the general README) diff --git a/doc/bug_report_form b/doc/bug_report_form new file mode 100644 index 000000000..054071117 --- /dev/null +++ b/doc/bug_report_form @@ -0,0 +1,62 @@ +this is a generic bug report form that should help you making bug reports +(e.g. to post them on the xine-user mailing list at + <xine-user@lists.sourceforge.net>) + +Just use it as a checklist or copy/paste it into your bug report and replace +the quoted lines ("> ...") with the corresponding information! + + +> subject +> ------- +> +> _please_ give a meaningful subject! Something like "horizontal bars while +> playing" is good, something like "xine bug" is not. + + +bug description +--------------- + +> short, but complete, problem description + + +xine console output +------------------- + +> please _always_ include the complete console output xine produces. +> It contains important information about the hardware xine detected and +> what modules are used for audio/video output on your configuration. + +> you can produce a suitable log file with these command(s): +> xine [options] 2>&1 |tee /tmp/xine.log +> if the resulting /tmp/xine.log is very big, you may compress it with +> "gzip -9 /tmp/xine.log" before attaching it to your bug report. + + +xine version used +----------------- + +> release/CVS ? is it a debug version (did you a make debug?) +> Is the bug new with this release? +> If you don't use the current release: Why not?/Please recheck with the +> current version, first! + + +information about your operating system/software +------------------------------------------------ + +> operating system, e.g. linux, kernel 2.2.16 + +> X server, e.g. xfree 4.01, mga drivers + +> audio driver, e.g. alsa 0.5.9d + + +information about your hardware configuration +--------------------------------------------- + +> CPU, e.g. P II 400 + +> graphics card, e.g. Matrox G400, 32 MB RAM + +> sound card, e.g. SB Live + diff --git a/doc/dataflow.dia b/doc/dataflow.dia Binary files differnew file mode 100644 index 000000000..b4d470bf2 --- /dev/null +++ b/doc/dataflow.dia diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am new file mode 100644 index 000000000..de46beca4 --- /dev/null +++ b/doc/man/Makefile.am @@ -0,0 +1,9 @@ +SUBDIRS = fr en + +mostlyclean-generic: + -rm -f *~ \#* .*~ .\#* + +maintainer-clean-generic: + -@echo "This command is intended for maintainers to use;" + -@echo "it deletes files that may require special tools to rebuild." + -rm -f Makefile.in diff --git a/doc/man/en/Makefile.am b/doc/man/en/Makefile.am new file mode 100644 index 000000000..b70881881 --- /dev/null +++ b/doc/man/en/Makefile.am @@ -0,0 +1,11 @@ +man_MANS = xine.1 + +EXTRA_DIST = $(man_MANS) xine.1.in + +mostlyclean-generic: + -rm -f *~ \#* .*~ .\#* + +maintainer-clean-generic: + -@echo "This command is intended for maintainers to use;" + -@echo "it deletes files that may require special tools to rebuild." + -rm -f Makefile.in xine.1 diff --git a/doc/man/en/xine.1.in b/doc/man/en/xine.1.in new file mode 100644 index 000000000..2739c44c0 --- /dev/null +++ b/doc/man/en/xine.1.in @@ -0,0 +1,173 @@ +.\" -*-Nroff-*- +.\"" +.TH XINE 1x 2000-11-19 "The xine project" +.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection +.\" other parms are allowed: see man(7), man(1) +.\"" +.SH NAME +xine \- MPEG2/MPEG1 audio/video player +.SH SYNOPSIS +.B xine +.I "[options] [MRL] ..." +.SH "DESCRIPTION" +This manual page documents briefly the +.BR xine +audio/video player. +.PP +.B xine +plays MPEG system streams, synchronizing audio and video substreams. It +can play streams from files, Video CDs, DVDs and other sources. +.SH OPTIONS +The programs follow the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options are included below. +For a complete description, see the README and FAQ in @prefix@/share/doc/xine +or on the xine home page. +.TP +.B \-h, \-\-help +Show summary of options. +.TP +.B \-s, \-\-shared\-memory +Use X shared memory extension for output. +.br +This may be useful if you experience +problems using the Xv extension. Xv is used as default, if it is available. +Since Xv is hardware accelerated, it usually provides more features and +better performance. +.TP +.B \-a, \-\-audio\-channel <num> +Select the given audio channel. <num> is the audio channel number, default +is "0". +.br +For MPEG2-Streams, AC3 audio streams are numbered from 0 to 7, while MPEG +audio streams are numbered from 8 to 15 and lpcm audio streams are +numbered 16 to 23 (provided that there are this many audio substreams, +of course). Finding the right audio stream might needs some experimenting, +as some mp2-streams contain audio in strange tracks (track 0 and 1 may +be empty but track 2 contains valid audio, for example). +.TP +.B \-A, \-\-audio\-driver <drv> +Select audio driver. Valid drivers are "oss", "alsa", "esd" or "null". The +default is to use ESD when the "ESPEAKER" environment variable is set, +otherwise ALSA if present, otherwise OSS. The "null" driver may be used to +disable audio output, eg. if there are problems with your sound card. +.TP +.B \-u, \-\-spu\-channel <num> +Select subpicture (subtitle) channel. <num> is the subpicture channel +id, default is no subtitle (-1). +.TP +.B \-S, \-\-spdif +Enable AC3 output via SPDIF. Works only on some ALSA drivers that support +the AC3 passthrough feature. +.TP +.B \-p[f][h][q][d][v] +Start playing immediately after start. Can be followed by "f" to turn +on fullscreen mode and/or "h" to hide GUI, and/or by "q" for quitting +at the end. It is also possible to request the playlist from DVD 'd', +or VCD 'v'. +.TP +.B MRL (media resource locator) +.br +MRLs are similar to URLs in your web browser. They describe the media +to read from. valid MRLs may be plain file names or one of the following: +.BR file://<path> +.br +.BR fifo://<path> +.br +.BR stdin://mpeg1 +or +.BR "stdin://mpeg2" +.br +.BR dvd://VTS_xx_y.VOB +.br +.BR "vcd://<track number>" +.br +.BR "net://???" +.LP +Several MRLs may be specified in order to play a number of consecutive +streams. +.LP +If you don't specify any MRL, you'll have to select a file by drag'n-drop. +Dragging files from the GNOME Midnight Commander (gmc) is known to work. +.SH "SEE ALSO" +The programs are documented fully on the xine home page: +.IR "http://xine.sourceforge.net/" +.SH CONTROL KEYS +Many features can be controlled by pressing control keys. The Key bindings are: +.LP +.BR RETURN : +Play +.br +.BR SPACE +or +.BR P : +Pause +.br +.BR F : +Toggle fullscreen mode (Xv only) +.br +.BR G : +Hide/show the gui. +.br +.BR H : +Hide/show the video output window. +.br +.BR A : +Toggle aspect ratio (AUTO/16:9/4:3/DVB) +.br +.BR C : +Show/hide the video settings window. +.br +.BR E : +Eject the current media. +.br +.BR 0 : +Jump to start of current stream +.br +.BR 1..9 : +Jump to 10%..90% of current stream +.br +.BR PgUp : +Jump to previous stream in playlist +.br +.BR PgDown : +Jump to next stream in playlist +.br +.BR + : +Select next audio channel (may take up to a few seconds to take effect) +.br +.BR - : +Select prev audio channel +.br +.BR Ctrl +Show/hide mouse cursor (only when the GUI is hide) +.br +.BR > +or +.BR . : +Select next sub-title channel. +.br +.BR < +or +.BR , : +Select previous sub-title channel. +.br +.SH Synchronization fine tuning +Some streams have bad timestamps, so synchronization fails. This can be +tweaked using arrow keys: +.br +.BR Left : +press if video runs ahead of audio +.br +.BR Right : +press if video lags behind audio +.br +.BR Home : +press to reset audio/video offset to 0, so stream timestamps are unchanged. + +.SH AUTHOR +This manual page was written by Siggi Langauf <siggi@debian.org>, +for the xine project. Lots of additions by +Guenter Bartsch <guenter@users.sourceforge.net> and +Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> + diff --git a/doc/man/fr/Makefile.am b/doc/man/fr/Makefile.am new file mode 100644 index 000000000..0335fd786 --- /dev/null +++ b/doc/man/fr/Makefile.am @@ -0,0 +1,46 @@ +mansubdir=/fr/man1 + +man_MANS = xine.1 + +EXTRA_DIST = $(man_MANS) xine.1.in + +install-man1: + $(mkinstalldirs) $(DESTDIR)$(mandir)$(mansubdir) + @list='$(man1_MANS)'; \ + l2='$(man_MANS)'; for i in $$l2; do \ + case "$$i" in \ + *.1*) list="$$list $$i" ;; \ + esac; \ + done; \ + for i in $$list; do \ + if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \ + else file=$$i; fi; \ + ext=`echo $$i | sed -e 's/^.*\\.//'`; \ + inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ + inst=`echo $$inst | sed '$(transform)'`.$$ext; \ + echo " $(INSTALL_DATA) $$file $(DESTDIR)$(mandir)$(mansubdir)/$$inst"; \ + $(INSTALL_DATA) $$file $(DESTDIR)$(mandir)$(mansubdir)/$$inst; \ + done + +uninstall-man1: + @list='$(man1_MANS)'; \ + l2='$(man_MANS)'; for i in $$l2; do \ + case "$$i" in \ + *.1*) list="$$list $$i" ;; \ + esac; \ + done; \ + for i in $$list; do \ + ext=`echo $$i | sed -e 's/^.*\\.//'`; \ + inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ + inst=`echo $$inst | sed '$(transform)'`.$$ext; \ + echo " rm -f $(DESTDIR)$(mandir)$(mansubdir)/$$inst"; \ + rm -f $(DESTDIR)$(mandir)$(mansubdir)/$$inst; \ + done + +mostlyclean-generic: + -rm -f *~ \#* .*~ .\#* + +maintainer-clean-generic: + -@echo "This command is intended for maintainers to use;" + -@echo "it deletes files that may require special tools to rebuild." + -rm -f Makefile.in xine.1 diff --git a/doc/man/fr/xine.1.in b/doc/man/fr/xine.1.in new file mode 100644 index 000000000..708880d67 --- /dev/null +++ b/doc/man/fr/xine.1.in @@ -0,0 +1,165 @@ +.\" -*-Nroff-*- +.\"" +.TH XINE 1x 2000-11-19 "Le projet xine" +.SH NOM +xine \- Lecteur audio/vidéo MPEG2/MPEG1. +.SH SYNOPSIS +.B xine +.I "[options] [MRL] ..." +.SH DESCRIPTION +Cette page de manuel documente brièvement le lecteur audio/vidéo \fBxine\fP. +.PP +\fBxine\fP lis les flux système MPEG, synchronise les flux audio et vidèo. +Il peux lire les flux a partir de fichiers, CD Vidéo, DVD et d'autres sources. +.SH OPTIONS +Ce programme suis la syntaxe de ligne de commande GNU, avec les longues +options commençant par deux tirets ('-'). +Une list de ces options est incluse plus bas. +Pour une description complète, lisez les fichiers README et FAQ +dans @prefix@/share/doc/xine ou sur la homepage. +.TP +.B \-h, \-\-help +Affiche la liste des options. +.TP +.B \-s, \-\-shared\-memory +utilise l'extension 'X Shared Memory' pour la sortie. +.br +Cela peut être utile si vous rencontrez des problèmes en utilisant +l'extension 'Xv', Xv est utilisée par defaut, si elle est disponible. +Comme Xv est accélérée materiellement, elle offre plus de fonctionnalitées +et de meilleurs performances. +.TP +.B \-a, \-\-audio\-channel <num> +Sélectionne le canal audio spécifié. <num> est le numéro du canal, la valeur +par defaut est '0'. +.br +Pour les flux MPEG2, les flux audio AC3 sont numérotés de 0 à 7, tandis +que les flux MPEG sont numérotés de 8 à 39 (si il y a plusieurs sous +flux audio, bien entendu) +.TP +.B \-A, \-\-audio\-driver <drv> +Sélectionne le pilote audio. Les pilotes valides sont "oss" (defaut), +"alsa", "esd" ou "null". +Par defaut ESD est utilisé si la variable d'environnement "ESPEAKER" +est positionnée, sinon ALSA si présent, ou alors OSS. Le pilote "null" +peut être utilisé pour supprimer la sortie audio, par exemple, si il y +a des problemes avec la carte son. +.TP +.B \-u, \-\-spu\-channel <num> +Sélectionne le canal de subpicture (sous-titres). <num> est le numéro +du canal de subpicture, par défaut il n'y a pas de sous-titre (\-1) +.TP +.B \-S, \-\-spdif +Met en fonction la sortie AC3 via SPDIF. Ne fonctionne qu'avec +certains pilotes ALSA supportant la fonctionnalité AC3 taversante. +.TP +.B \-p[f][h][q][d][v], +Démarre la lecture immédiatement apres l'execution. Peut être suivi +par 'f' pour passer en mode plein écran, et/ou par 'h' pour +masquer le panneau de contrôle, et/ou par 'q' pour quitter +à la fin de la lecture. Il est possible d'obtenir automatiquement +les listes de lecture à partir d'un DVD 'd', ou d'un VCD 'v'. +.TP +.B MRL (media resource locator) +.br +Les MRLs sont similaires aux URLs de votre navigateur internet. Elles +définissent le média à utiliser comme source de lecture. +Les MRLs valides peuvent être les noms de fichiers ou un de ceux qui suis: +.br +.BR file://<chemin> +.br +.BR fifo://<chemin> +.br +.BR stdin://mpeg1 +or +.BR "stdin://mpeg2" +.br +.BR dvd://VTS_xx_y.VOB +.br +.BR "vcd://<numéro piste>" +.br +.BR "net://???" +.LP +Plusieurs MRLs peuvent être spécifiées pour lire un nombre consecutif +de flux. +.LP +Si vous ne spécifiez aucune MRL, vous pourrez sélectionner un fichier +par glisser-lacher. +Glisser des fichiers depuis GNOME Midnight Commander (gmc) est connu +pour fonctionner. +.SH "VOIR AUSSI" +Le programme est complement documenté sur la homepage de xine: +.IR "http://xine.sourceforge.net/" +.SH TOUCHES DE CONTROLE +Beaucoup de fonctions peuvent êtres contrôlées en pressant certaines touches. +La liste de ces touches sont: +.LP +.BR ENTREE : +Lecture +.br +.BR ESPACE +ou +.BR P : +Pause +.br +.BR F : +Bascule plein écran (Xv seulement). +.br +.BR G : +Affiche/masque le panneau de contrôle. +.br +.BR H : +Affiche/masque la fenêtre de sortie. +.br +.BR A : +Bascule du ratio d'aspect (AUTO/16:9/4:3/DVB) +.br +.BR C : +Affiche/masque la fenêtre des réglages vidéo. +.br +.BR E : +Ejecte le média courant. +.br +.BR 0 : +Saute au début du flux courant. +.br +.BR 1..9 : +Saute à 10%..90% du flux courant. +.br +.BR PgUp : +Saute au flux precédent dans la liste de lecture. +.br +.BR PgDown : +Saute au flux suivant dans la liste de lecture. +.br +.BR + : +Sélectionne le canal audio suivant (peux prendre quelques secondes +avant effet). +.br +.BR - : +Sélectionne le canal audio precédent. +.br +.BR Ctrl +Affiche/masque le pointeur de souris (uniquement quand le panneau de +contrôle est masqué). +.br +.BR > +ou +.BR . : +Sélectionne le canal de sous-titres suivant. +.br +.BR < +ou +.BR , : +Sélectionne le canal de sous-titres precédant. +.br +.BR Gauche : +Change négativement la synchronisation A/V. +.br +.BR Droit : +Change positivement la synchronisation A/V. +.br +.BR Début : +Remise à zéro de la synchronisation A/V. +.SH AUTEURS +Cette page de manuel a été écrite par Siggi Langauf <siggi@users.sourceforge.net>, traduite par Daniel Caujolle-Bert <f1rmb@users.sourceforge.net>, pour le projet xine. |