diff options
| -rw-r--r-- | doc/README | 12 | ||||
| -rw-r--r-- | doc/README.dxr3 | 138 | ||||
| -rw-r--r-- | doc/README.freebsd | 93 | ||||
| -rw-r--r-- | doc/README.irix | 20 | ||||
| -rw-r--r-- | doc/README.solaris | 78 |
5 files changed, 12 insertions, 329 deletions
diff --git a/doc/README b/doc/README new file mode 100644 index 000000000..0a8f8fda6 --- /dev/null +++ b/doc/README @@ -0,0 +1,12 @@ + + ---------------------- + xine + ---------------------- + + a free video player + + + +this directory contains technical documentation and stuff of interest +for developers. please see the directory "doc/" in the package +xine-ui for end-user documentation. diff --git a/doc/README.dxr3 b/doc/README.dxr3 deleted file mode 100644 index afab4bc5f..000000000 --- a/doc/README.dxr3 +++ /dev/null @@ -1,138 +0,0 @@ -Introduction -============ - -This documentation is intended for users of a dxr3 decoder card -from creative labs or a hollywood plus decoder card from sigma -designs. - -This version of xine contains a plugin for the mentioned hardware -decoders "out of the box". The missing part is the linux kernel -driver. The driver can be obtained from the main dxr3/hw+ linux -development site at - - http://dxr3.sourceforge.net/ - -The various release formats (tarball, RPMs) are listed on - - http://dxr3.sourceforge.net/download.html - -As setting up the dxr3/hw+ driver is a little bit tricky, please -consult also the HOWTO: - - http://dxr3.sourceforge.net/howto.html - -The xine dxr3 plugin requires at least the version - - em8300-0.8.1 of the linux drivers. - - -Compilation -=========== - -It is important to compile and install the dxr3/hw+ driver -*before* compiling xine-lib. No doing so will cause the -configure script to exclude dxr3 support with a warning. - -In order to activate the plugin, em8300.h must be available in -/usr/src/linux/include/linux. If you have non-standard linux -directory like /usr/src/linux-2.4.5, you can specify the -location with - -./configure --with-linux-path=/usr/src/linux-2.4.5 - -otherwise a ./configure without parameters will do. - - -XINE run-time configuration -=========================== - -XINE has several configuration options in $HOME/.xinerc -(see also doc/README.xinerc) - -Some of them are important for dxr3 playback: -*) dxr3_tvmode: - default Keep the current driver setting - ntsc NTSC 60Hz - pal PAL 50Hz - pal60 PAL 60Hz - overlay Video output on the VGA screen - -*) dxr3_keycolor: (overlay only) - 0x80a040 Hexadecimal RGB value of the key color. Should - not need to be changed. - -*) dxr3_color_interval: (overlay only) - 50.0 Tolerance for keycolor. A higher value allows higher - range of keycolors. Intended for compensation of - color errors on VGA output. Smaller value is better - for not using the "wrong" colors as overlay. - Meaningful range: 20.0 - 200.0 - -*) dxr3_scr_prio: - 10 Priority of the dxr3 scr plugin. <5 means that the - unix system timer will be used. >5 forces to use - dxr3 as sync source. If you don't understand this - keep the default value. - -*) video_driver_name: - dxr3 Needed for setting the tv_mode, brightness, contrast, - saturation and the aspect ratio. If not, these features - will be missing but playback will still work. - - This is only a "dummy" driver which cannot output - frames. The frames are done by the hardware decoder. - When *not* playing MPEG1/2 content, it must be set - to a "real" video driver like "Xv" or "Xshm". - -*) audio_driver_name: - oss The em8300 audio output is available as an usual - OSS device. Therefore the audio driver must be - set to oss. Can also be specified using "-A oss" - on the command line. - -*) oss_device_num: - 0-16 Machines with a dxr3 installed often have an usual - soundcard too. If audio playback occurs on the - wrong device, the demanded device can be set using - this option. - -It is recommented to run XINE one time before editing the config, -since all options get written in .xinerc and have their default -values. The dxr3 video driver can be forced using the "-V dxr3" -command line option. Only the tvmode value has to be edited -if the default driver setting is not correct. - - -Running XINE with dxr3/hw+ -========================== - -The hardware decoder is activated automatically if the driver -can be opened correctly. Mpeg1/2 videos (e.g. DVDs) are played -on the hardware decoder, whereas other content is played on the -screen. Remember to activate a different video out than "dxr3" -in that case! - - -VGA overlay feature -=================== - -In previous versions of xine support, one had to use dxr3view in order -to use the em8300 overlay mechanism. Now, with the xine 0.5 version, -it is possible to output the em8300 overlay directly in the video -out window. - -The initial idea and the first working sample code came from -Mike Lampard <mjl@datafast.net.au>. Kudos to him for this new feature. - -In order to activate it, "dxr3_tvmode" must be set to "overlay". But -it won't work until the old dxr3view works too (just a check). Before -a first use, "autocal" has to be run. This will store the right overlay -parameters in "~/.overlay". For more information, please consult the -dxr3 howto too. - -Have a look at the previous explained xinerc options dxr3_keycolor -and dxr3_color_interval too. - -________________________ -docu version information -$Id: README.dxr3,v 1.5 2001/08/14 10:31:50 ehasenle Exp $ diff --git a/doc/README.freebsd b/doc/README.freebsd deleted file mode 100644 index 72d5f2e65..000000000 --- a/doc/README.freebsd +++ /dev/null @@ -1,93 +0,0 @@ -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 - - -mtrr on freebsd ---------------- - -setting up the caching behaviour of the memory on the graphics board. - -what is being done with the mtrr support on linux is to set the caching -type of the memory of the graphics board to 'write-combine' mode. -that way the performance of big writes into this memory should be faster. - -it seems that the same can be achieved on freebsd by executing: - - memcontrol set -b <base-address> -l <length> write-combine - -for example on my system i executed: - - memcontrol set -n 0xd8000000 -l 0x02000000 write-combine - -i got the base-adress by executing 'startx' and looking at the output. - -it seems to be dangerous to change the cache setting of the graphics memory -while xfree is running - at least i managed to have my system freeze that -way. so better do it on the commandline. - -this tip is still subject of research, so it might be incorrect - please -report any further information on this topic to the xine-user list. -please also report success or non-success on xine-user if you have the time. - - -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.irix b/doc/README.irix deleted file mode 100644 index b87820083..000000000 --- a/doc/README.irix +++ /dev/null @@ -1,20 +0,0 @@ -building xine on IRIX ---------------------- - -* Compile xine with GNU make (gmake). - - -Known Problems --------------- - -* Cannot compile with IRIX cc - - This is an unresolved issue with automake and dependencies. - -* xine crashes upon startup - - Some graphics cards (e.g. V8) seem to have problems with xine-ui. - This is being worked on. - - -Matthias Hopf <mat@mshopf.de> diff --git a/doc/README.solaris b/doc/README.solaris deleted file mode 100644 index 3e094af04..000000000 --- a/doc/README.solaris +++ /dev/null @@ -1,78 +0,0 @@ -building xine on solaris ------------------------- - -* Compile xine with GNU make (gmake, /opt/sfw/bin/gmake) - -* On Solaris x86: The xine code tries to use MMX/SSE/3DNOW! instructions - of x86 CPUs, which may not assemble using Solaris' /usr/ccs/bin/as. - Make sure to use the GNU assembler as the assembler backend for the - GNU C compiler and as a standalone assembler command - (env AS=gas configure ...). - -* If you get a "fatal: relocation error" ... "symbol __divdi3: - referenced symbol not found" error when running xine, re-configure - xine-lib with gcc as the linker command (env LD=gcc configure ...) - -* To get VIS accelerated video decoding and colour space conversion - on Solaris SPARC with an UltraSPARC cpu, download and install Sun's - mediaLib 2.0 before compiling xine. mediaLib is available here: - - http://www.sun.com/sparc/vis/mediaLib.html - - -Known Problems --------------- - -* Can't use MIT shared memory for local video display - - The default value for the maximum allowed shared memory segment size - (1MByte) and the number of allowed shared memory segments (6) - is very small on solaris. You may want to increase both parameters. - Add the following lines to /etc/system to increase the shmmax parameter - to 8MBytes and the shmseg parameter to 32: - - set shmsys:shminfo_shmmax=8388608 - set shmsys:shminfo_shmseg=32 - - Reboot the machine after modifying /etc/system to activate the new - shared memory defaults. - - -* When using an 8-bit display, xine aborts with the error message: - - IMLIB ERROR: Cannot Find Palette. A Palette is required for this mode - Unable to initialize Imlib - - xine expects an installed Imlib package, installed using the "prefix" / - xine is looking for the global Imlib config file in /etc/imrc. - - If you have the solaris 8 companion CD installed, an Imlib package is - already installed on your system, but it uses the "prefix" /opt/sfw. - - To work around the problem: - - - install a symbolic link /etc/imrc, pointing to /opt/sfw/etc/imrc - (needs root permission) - - # ln -s /opt/sfw/etc/imrc /etc - - or - - - install an ".imrc" file in your home directory, - with the following contents: - - PaletteFile /opt/sfw/etc/im_palette.pal - - -* On Solaris x86, you cannot reliably play DVDs using a capacity >4GB: - - The sd(7D) driver on solaris x86 has a bug when accessing a disk - block >4GB on a device using a logical blocksize != DEV_BSIZE (i.e. - CDROM and DVD media). Due to a 32bit int overflow, a disk address - modulo 4GB is accessed. - - There's no workaround available. - - See the following message for more details about this bug: - - http://groups.yahoo.com/group/solarisonintel/message/22516 |