diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.MINGWCROSS | 6 | ||||
| -rw-r--r-- | doc/README.dvb | 2 | ||||
| -rw-r--r-- | doc/README.dxr3 | 46 | ||||
| -rw-r--r-- | doc/README.freebsd | 6 | ||||
| -rw-r--r-- | doc/README.network_dvd | 6 | ||||
| -rw-r--r-- | doc/README.solaris | 14 | ||||
| -rw-r--r-- | doc/README.syncfb | 68 | ||||
| -rw-r--r-- | doc/faq/faq.sgml | 196 | ||||
| -rw-r--r-- | doc/hackersguide/README | 2 | ||||
| -rw-r--r-- | doc/hackersguide/architecture.fig | 2 | ||||
| -rw-r--r-- | doc/hackersguide/internals.sgml | 60 | ||||
| -rw-r--r-- | doc/hackersguide/intro.sgml | 2 | ||||
| -rw-r--r-- | doc/hackersguide/library.fig | 2 | ||||
| -rw-r--r-- | doc/hackersguide/library.sgml | 94 | ||||
| -rw-r--r-- | doc/hackersguide/output.sgml | 18 | ||||
| -rw-r--r-- | doc/hackersguide/overlays.fig | 2 | ||||
| -rw-r--r-- | doc/hackersguide/overview.sgml | 24 | ||||
| -rw-r--r-- | doc/hackersguide/post_frame.fig | 2 | ||||
| -rw-r--r-- | doc/hackersguide/stream.sgml | 8 | ||||
| -rw-r--r-- | doc/internal/HOWTO.release | 8 |
20 files changed, 284 insertions, 284 deletions
diff --git a/doc/README.MINGWCROSS b/doc/README.MINGWCROSS index 87ae57b60..d721ca941 100644 --- a/doc/README.MINGWCROSS +++ b/doc/README.MINGWCROSS @@ -81,7 +81,7 @@ In the following text are used symbols $PREFIX and $USER with this meaning: # # compile and install the compiler # - # if you'll want rerun this step, I recommend delete + # if you'll want rerun this step, I recommend delete # $PREFIX/i386-mingw32/sys-include # tar xzf gcc-core-3.3.1-20030804-1-src.tar.gz @@ -107,7 +107,7 @@ In the following text are used symbols $PREFIX and $USER with this meaning: 4. recompile w32api and mingw-runtime from sources (optional) - + # # installing must be into $PREFIX/i386-mingw32 # @@ -153,7 +153,7 @@ In the following text are used symbols $PREFIX and $USER with this meaning: tar xzf pthreads-w32-2-7-0-release.tar.gz cd pthreads-w32-2-7-0-release/ - make CROSS=i386-mingw32- PTHREAD_DEF=pthreadGC2.def clean GC + make CROSS=i386-mingw32- PTHREAD_DEF=pthreadGC2.def clean GC # # possibility to use pthread library in M$ Visual C (optional) # diff --git a/doc/README.dvb b/doc/README.dvb index 38ea6613d..e32b980dd 100644 --- a/doc/README.dvb +++ b/doc/README.dvb @@ -130,7 +130,7 @@ file name the recorded stream is being written to. You can select the directory to save to in the xine configuration under the MISC tab, otherwise the plugin will record to your home directory. You can pause the recording at any time by pressing MENU4 (F3 in xine-ui, F4 in gxine). An OSD in the -top left hand corner will notify you of the status of the recording. +top left hand corner will notify you of the status of the recording. Pressing MENU4 again will resume recording. Have fun. diff --git a/doc/README.dxr3 b/doc/README.dxr3 index 41fe9ad74..2800067ff 100644 --- a/doc/README.dxr3 +++ b/doc/README.dxr3 @@ -41,45 +41,45 @@ here: XINE dxr3 plugin ================= -There are two different ways in which xine can make use of the dxr3 +There are two different ways in which xine can make use of the dxr3 card. -1. mpeg-1/mpeg-2 (DVD, VCD, ...) decoding and displaying. +1. mpeg-1/mpeg-2 (DVD, VCD, ...) decoding and displaying. This is the normal use. Instead of doing the mpeg decoding in software, xine sets up the display (TV or overlay) and sends the mpeg data via the kernel driver to the mpeg decoder on the dxr3 card, very much like the Windows player that you problably got with the card. In this mode, you should be using the dxr3 video decoder plugin together -with the dxr3 video out plugin. +with the dxr3 video out plugin. Xine should select the dxr3 video decoder plugin automatically when it encounters an mpeg stream, but it is possible it does not use the dxr3 -video out plugin by default. In that case, start xine with the +video out plugin by default. In that case, start xine with the "-V dxr3" argument to specify the dxr3 video out plugin. If you use another video out driver, such as Xv or XShm, xine won't be able to use the mpeg decoding capability of the dxr3 hardware and will -use libmpeg2 instead. +use libmpeg2 instead. Here's a short overview what happens when you play a dvd with xine using the dxr3 video out driver: -DVD -> split mpeg video and audio and audio streams +DVD -> split mpeg video and audio and audio streams -> send mpeg video to dxr3 -> image appears on screen -2. displaying non-mpeg video on dxr3 hardware. +2. displaying non-mpeg video on dxr3 hardware. -Non-mpeg video may be AVI, quicktime, windows media files or whatever -else xine can decode. +Non-mpeg video may be AVI, quicktime, windows media files or whatever +else xine can decode. -This option must be compiled in and requires a supported mpeg encoder. +This option must be compiled in and requires a supported mpeg encoder. At the moment there are three: - libavcodec from xine-lib's ffmpeg plugin (good quality, quite fast) - libfame from fame.sourceforge.net (very fast, good quality) (currently the 0.9 versions of libfame don't work, use the 0.8 versions) - librte (version 0.4) from zapping.sourceforge.net (fast, very good quality) If configure finds one or both it will compile in encoding support into -the dxr3 driver. +the dxr3 driver. In order to use this driver for output instead of, say, Xv, just start xine with the command line option "-V dxr3", for example @@ -102,7 +102,7 @@ system with at least 128 MB of RAM and a P-III/Athlon at 800 MHz. Here's an overview what happens when you play an AVI this way (compare this with the previous overview!) --> split video and audio streams -> decode video stream +-> split video and audio streams -> decode video stream -> encode video as mpeg-1 -> send mpeg-1 stream to dxr3 -> image appears on screen @@ -146,16 +146,16 @@ engine.decoder_priorities.dxr3-mpeg2: Zooming Feature (TVout Only) ============================ -Pressing the 'z' key enables another tv-only mode which zooms into the -centre of a 16:9 video to display much smaller (or none) black bars -top & bottom. It crops the video on the left and right sides to +Pressing the 'z' key enables another tv-only mode which zooms into the +centre of a 16:9 video to display much smaller (or none) black bars +top & bottom. It crops the video on the left and right sides to maintain the correct aspect ratio. Use SHIFT-z to disable. TV mode Cycling Feature ====================== -Pressing CTRL-o repeatedly will allow you to cycle between tv modes PAL, -PAL60, & NTSC. The format selected will only remain valid for the +Pressing CTRL-o repeatedly will allow you to cycle between tv modes PAL, +PAL60, & NTSC. The format selected will only remain valid for the current xine session, on startup the tv mode will revert to the default in .xine/config @@ -166,7 +166,7 @@ VGA overlay feature In previous versions of xine support, one had to use dxr3view in order to use the em8300 overlay mechanism. Now, since the xine 0.5 version, it is possible to output the em8300 overlay directly in the video -out window. +out window. In order to activate it, "dxr3.output.mode" must be set to "overlay". But it won't work until the old dxr3view works too (just a check). Before @@ -174,11 +174,11 @@ 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. -As of version 0.9.5, you can now switch between overlay and tv-out modes -on-the-fly, simply by hiding the video_out window ('h' key by default, -see the README file). If you want to start xine with video on the tv, -you can run xine with the -H option to auto-hide the vo window, instead -of changing the configuration (although you can still do that instead if you +As of version 0.9.5, you can now switch between overlay and tv-out modes +on-the-fly, simply by hiding the video_out window ('h' key by default, +see the README file). If you want to start xine with video on the tv, +you can run xine with the -H option to auto-hide the vo window, instead +of changing the configuration (although you can still do that instead if you prefer, of course). Have a look at the previous explained configuration options dxr3.output.keycolor diff --git a/doc/README.freebsd b/doc/README.freebsd index 900f60aa1..68dd5d84b 100644 --- a/doc/README.freebsd +++ b/doc/README.freebsd @@ -87,12 +87,12 @@ the file you have to patch is /sys/dev/ata/atapi-cd.c: ! case 2048: ! ccb[0] = ATAPI_READ_BIG; ! break; -! -! case 2352: +! +! case 2352: ! ccb[0] = ATAPI_READ_CD; ! ccb[9] = 0xf8; ! break; -! +! ! default: ! ccb[0] = ATAPI_READ_CD; ! ccb[9] = 0x10; diff --git a/doc/README.network_dvd b/doc/README.network_dvd index 4798b79f8..41c7750ff 100644 --- a/doc/README.network_dvd +++ b/doc/README.network_dvd @@ -86,7 +86,7 @@ installation for dvds (don't forget the trailing slash) - + protocol details ---------------- @@ -110,13 +110,13 @@ cdda commands: cdda_read <start_frame> <num_frames> <error code> <n> <n bytes (frames)> - + cdda_tochdr <error code> 0 <first_track> <last_track> cdda_tocentry <error code> 0 <track_mode> <first_frame_min> <first_frame_sec> <first_frame_frame> - + dvd commands: dvd_open diff --git a/doc/README.solaris b/doc/README.solaris index 9e78287a9..fb1fb408e 100644 --- a/doc/README.solaris +++ b/doc/README.solaris @@ -23,19 +23,19 @@ building xine on solaris GNU C compiler and as a standalone assembler command. A quick workaround when using the GCC from Sun's - "Software Companion" CD is to replace /usr/ccs/bin/as with a + "Software Companion" CD is to replace /usr/ccs/bin/as with a link to GNU as, for example like this: cd /usr/ccs/bin ln -s /opt/sfw/bin/gas gnu-as mv as sun-as ln -s gnu-as as - + (Use "ln -s gnu-as as" or "ln -s sun-as as" to switch between the two assemblers) -* To get VIS accelerated video decoding and colour space conversion +* 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: @@ -101,15 +101,15 @@ Known Problems 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 + or - install an ".imrc" file in your home directory, with the following contents: @@ -123,7 +123,7 @@ Known Problems 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: diff --git a/doc/README.syncfb b/doc/README.syncfb index fc90ff586..be8c2565d 100644 --- a/doc/README.syncfb +++ b/doc/README.syncfb @@ -5,7 +5,7 @@ * WHAT IS THIS PLUGIN ABOUT and WHY SHOULD I EVEN CONSIDER TO USE IT? :) - + This xine video output plugin uses the so called SyncFB driver (from the Teletux project) which provides special hardware features of Matrox G200 and newer cards like hardware deinterlacing, scaling and @@ -14,19 +14,19 @@ available to xine and because all this tasks are done by the graphic 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. :-) - + Ok ok -- why should you want to have your video output synchronized to something called the vertical retrace of your monitor?! Well... :) - + In order to have an optimal DVD playback the update of the image needs to be syncronized with the vertical refresh of the screen. Otherwise you will sometimes see part of frame n and part of frame n+1 during playback of a movie. Resulting in tearing artefacts on moving objects. - + When using this plugin the update of the screen is done during the vertical retrace of your monitor and those tearing artefacts are gone forever. - + Also the SyncFB kernel module and this plugin totally by-pass XFree86 for anything else but some data gathering routines needed to place the overlay at the right spot. So on some machines you will gain some @@ -36,7 +36,7 @@ Last but not least, you may ask what's so special about deinterlacing? There are already several deinterlacing methods available in xine and why should you care about another one? Well (again)... ;-)) - + All current deinterlacers in xine are done in software and therefore will cost you some CPU power. The SyncFB video out plugin will use the hardware deinterlacing support of your graphic card, thus saving your @@ -48,16 +48,16 @@ So far the plugin and the kernel module itself are only being tested on G400 cards by its developers thus we cannot tell about newer or older generation chips. - + Nevertheless we have received positive feedback that the SyncFB kernel module and this plugin work fine with G450 cards too. - + If you have got things working on older/newer chips, please let us know about your success and we will place a note here... :-) - + * AND HOW DOES IT WORK? - + The SyncFB driver is a kernel module you will have to load that makes a special device (e.g. /dev/syncfb) available which is opened by the plugin and controlled with certain ioctl calls. Easy, isn't it? ;-) @@ -79,7 +79,7 @@ Back to the original subject. In order to install and use the SyncFB kernel module, you *will* need a fresh CVS checkout of the sources because the last official release is rather outdated. - + This sounds more complicated than it actually is. You will only have to execute the following two commands to get the sources in a sub-dir called teletux. When you are asked for password, just press return. @@ -90,14 +90,14 @@ Now enter the directory teletux/syncfb, that's where the actual kernel modul sources are located. Before you can compile the module, you will have to change two lines in the Makefile itself to make it work. - + In the second line, there is a phrase like "-I/usr/include" which you have to change to "-I/usr/src/linux/include". In line seven, you need to remove syncfbtv and syncfb_test from the OBJ list. Now execute a "make" and the module will be compiled. Place the resulting syncfb.o in your modules dir which is usually... - + /lib/modules/KERNEL_VERSION/ ... and issue a "depmod -a" after it. That's it - the kernel module is @@ -106,7 +106,7 @@ required /dev/syncfb device if you have devfs support, otherwise you need to issue a "mknod /dev/syncfb c 178 0" once to create the device yourself permanently. - + Once the module is loaded, you can start xine with the "-V SyncFB" option to use this plugin. xine automatically remembers the video out plugin you last used, so you only have to use this option once too. :) @@ -125,14 +125,14 @@ refresh rates (e.g. 50/75/100 Hz for PAL, 60/90/120 Hz for NTSC). You will need to add so called modelines to your XFree86 config to make those modes available, if you don't already have them. - + 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. @@ -141,22 +141,22 @@ Note: If you want to be on the safe side, generate your very own modelines with an application like kvideogen for example. - + 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 - + 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 + Modeline "1152x864ntsc" 80.93 1152 1168 1384 1496 864 864 872 902 # 1280x1024 - + none yet - might be added in the future So before you run xine just turn to the appropriate refresh rate and @@ -166,7 +166,7 @@ * 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 if you are not using the XF86VidMode extension which will properly do @@ -192,18 +192,18 @@ Pressing 'i' during playback will toggle hardware deinterlacing. A decrease in picture quality is a known side effect, yet you won't see any artefacts caused by interlacing anymore. :-) - + One more note, hardware deinterlacing uses BOB as deinterlacing method and is totally independent from the software deinterlacing in xine. So specifing a different deinterlacing method in your .xinerc won't have any effect on this feature. - + Nevertheless we are thinking about making software deinterlacing also available as an option. It's on the TODO list... :) * HEY! THE OVERLAY TURNS OFF WHEN THE WINDOW IS PARTLY OFF THE DESKTOP!? - + That's done on purpose. It prevents possible yet harmless screen corruption. And by the way - why would you want to see a movie just partly?! ;-) @@ -227,7 +227,7 @@ the actual overlay from SyncFB is being displayed because this area in your video memory is constantly over written - so are the changes done by your X Server (like a window graphic that is placed there). - + This is just cosmetical and harmless, so no need to worry. If you want to do something with the xine panel when the video overlay is taking all your screen, just switch back to window mode and do what you have @@ -257,20 +257,20 @@ * WHAT IS ON THE TODO LIST? + fix above listed bugs in the SyncFB kernel module - + + make software deinterlacing available as an option - + + RGB support (unlikely at the moment because there is no need for it) - + + check if the video source is not too big in terms of dimensions for the video memory left (video memory - X reserved video memory) - + + bug fixes + more sanity checks + new features + optimizations - + * CONTACTS and FEEDBACK diff --git a/doc/faq/faq.sgml b/doc/faq/faq.sgml index 48f9b2416..b3490ea2a 100644 --- a/doc/faq/faq.sgml +++ b/doc/faq/faq.sgml @@ -17,7 +17,7 @@ <sect2 id="about"> <title>What is the xine engine?</title> - <para> + <para> The xine engine is a free media player engine. It comes in the form of a shared libarary and is typically used by media player frontends and other multimedia applications for playback of multimedia streams @@ -64,7 +64,7 @@ may have installed on your system. </para> </sect2> - + <sect2 id="pronounce"> <title>How do I pronounce "xine"?</title> <para> @@ -103,7 +103,7 @@ </para> <para> Other modules in CVS are: <filename>xine-plugin</filename> a mozilla browser plugin - for streaming media playback using xine, + for streaming media playback using xine, <filename>xine_www</filename> the xine project website sources. </para> @@ -215,8 +215,8 @@ <sect2 id="buildrequirements"> <title>What do I need to compile everything properly?</title> <para> - First of all an official and stable release of gcc. Also be aware - that patched gcc versions may break parts of xine and are therefore + First of all an official and stable release of gcc. Also be aware + that patched gcc versions may break parts of xine and are therefore not supported by the xine project. </para> <para> @@ -269,7 +269,7 @@ <command>make install</command></screen> </para> <para> - Make sure your <filename>/etc/ld.so.conf</filename> contains + Make sure your <filename>/etc/ld.so.conf</filename> contains <filename>/usr/local/lib</filename> and continue with: <screen> <command>ldconfig</command></screen> </para> @@ -279,7 +279,7 @@ <command>./configure</command> <command>make install</command></screen> </para> - </sect3> + </sect3> <sect3 id="completebuildinstr"> <title>Complete build instructions</title> <para> @@ -309,7 +309,7 @@ <command>make</command> <command>make install</command></screen> </para> - </sect3> + </sect3> </sect2> <sect2 id="rpmbuild"> @@ -454,7 +454,7 @@ <title>The Xv video-out plugin fails to compile!</title> <para> If you want to have Xv support compiled in, make sure you either have - a shared Xv library on your system, e.g. + a shared Xv library on your system, e.g. <command>ls /usr/X11R6/lib/libXv*</command> should give you some .so libs, like this: <screen> @@ -463,7 +463,7 @@ /usr/X11R6/lib/libXv.so.1</screen> </para> <para> - Alternatively you need to have libtool 1.4 or newer installed, then + Alternatively you need to have libtool 1.4 or newer installed, then libXv.a is sufficient. Otherwise you can create the shared versions yourself: <screen> <command>ld --whole-archive -shared -o libXv.so.1 libXv.a</command> @@ -481,7 +481,7 @@ <sect3 id="xinelibnotfound"> <title>I have installed xine-lib but the frontend complains about not finding it!</title> <para> - First of all take a closer look at the compilation instructions above again. + First of all take a closer look at the compilation instructions above again. You will probably find your answer there right away. </para> <para> @@ -511,7 +511,7 @@ <command>export LD_LIBRARY_PATH="$HOME/xine/lib:$LD_LIBRARY_PATH"</command></screen> </para> <para> - Now you can unpack tarballs e.g. in <filename>~/xine/src</filename> + Now you can unpack tarballs e.g. in <filename>~/xine/src</filename> (<command>mkdir ~/xine/src</command> if necessary) and do a <screen> <command>./configure --prefix=$HOME/xine</command> @@ -564,7 +564,7 @@ <filename>/dev/scd1</filename>, … in that case). Also make sure you (as a user) have sufficient (read and write) permissions on your DVD drive. This could mean you either have to change the device - permissions or add your user to a special group + permissions or add your user to a special group (e.g. <command>addgroup cdrom username</command>), depending on your setup and/or distribution. </para> @@ -574,7 +574,7 @@ smooth video output). Use a command like <command>hdparm -d 1 <device></command> on your DVD device. Please note that even if you're using ide-scsi - you will have to set the dma flag on the ide device node (e.g. + you will have to set the dma flag on the ide device node (e.g. <filename>/dev/hdc</filename>), not the mapped <filename>/dev/scd</filename> scsi device. </para> @@ -612,7 +612,7 @@ Once you have everything set up, try something like <command>gxine dvd:/</command> or <command>xine -p dvd:/</command> to start dvd playback. Some frontend also offer so-called autoplay - buttons or menu entries that start dvd playback immediately. + buttons or menu entries that start dvd playback immediately. </para> <para> Important: do not try to mount the DVD. Just insert it and hit the DVD autoplay @@ -643,7 +643,7 @@ drives is limited (usually about 5 times), after that your drive will stay locked to the region you last set it up for. </para> - </sect3> + </sect3> <sect3 id="regionset"> <title>I have problems setting up my RPC-2 drive for the right region!</title> <para> @@ -657,7 +657,7 @@ drives is limited (usually about 5 times), after that your drive will stay locked to the region you last set it up for. </para> - </sect3> + </sect3> </sect2> <sect2 id="vcdsupport"> @@ -718,7 +718,7 @@ <filename>test_svcd_pal.bin</filename>. Run xine with the MRL <!-- FIXME: This MRL needs to be changed --> <filename>vcd:/test_svcd_pal.cue:E0</filename>. - If you see something playing then this is a hardware problem. + If you see something playing then this is a hardware problem. You might also want to try starting playback-control with <!-- FIXME: This MRL needs to be changed --> <filename>vcd:/test_svcd_pal.cue:P1</filename>. @@ -782,7 +782,7 @@ If you have the VideoCD from the last step, then run the MRL <!-- FIXME: This MRL needs to be changed --> <filename>vcd:/test_svcd_pal.cue:P1</filename> - If this shows a still frame, but it just does not show when you + If this shows a still frame, but it just does not show when you hit either the "VCD" autoscan button or give a MRL without the P1 at the end then go to the next step. </para> @@ -797,7 +797,7 @@ </listitem> <listitem> <para> - You have a VideoCD with menu at beginning and can see it using an MRL + You have a VideoCD with menu at beginning and can see it using an MRL with P1 at the end, but you want to see it by hitting the "VCD" autoscan button as well? Check to see that you have the configuration entry <parameter>media.vcd.autoplay</parameter> set to <parameter>playlist</parameter>. @@ -833,7 +833,7 @@ <sect2 id="quicktime"> <title>Can I watch Quicktime (.mov, .mp4) files using xine?</title> <para> - Quicktime is just a system layer (container format) which can contain various + Quicktime is just a system layer (container format) which can contain various different audio and video formats. The system layer itself is fully supported in xine. However, some quicktime audio/video codecs are not natively supported yet. Luckily, if you are using a x86 compatible machine (any recent PC hardware should do) @@ -852,7 +852,7 @@ have to set <parameter>decoder.external.win32_codecs_path</parameter> in your xine config file accordingly). Restart xine then and you should be able to watch Quicktime trailers. - </para> + </para> </sect2> <sect2> @@ -1013,7 +1013,7 @@ Try to use the Xv driver, it greatly improves performance and quality because your graphics card does image scaling and colourspace conversion. The <link linkend="video">video section</link> contains important information - about several Xv drivers. + about several Xv drivers. </para> <para> If Xv cannot be used for some reason, make sure your display is set up @@ -1085,13 +1085,13 @@ Have your X-server (usually X.org or XFree86) running with higher priority. Most recent linux distributions (like RedHat 8.0 or Mandrake 9.0) should do that for you, improving not only xine but desktop responsiveness - in general. + in general. </para> <para> Use the "top" utility and verify under the "NI" column if the X process has a negative value, this indicates a higher priority. - See "The X Window User HOWTO – Performance considerations" for - further instructions + See "The X Window User HOWTO – Performance considerations" for + further instructions <ulink url="http://www.tldp.org/HOWTO/XWindow-User-HOWTO/performance.html"> http://www.tldp.org/HOWTO/XWindow-User-HOWTO/performance.html </ulink>. @@ -1115,7 +1115,7 @@ <listitem> <para> xine needs high speed memory access which depends on your chip set. - Make sure you enable all speed-improving options. + Make sure you enable all speed-improving options. </para> <para> Especially the via apollo pro chipset is known to be quite weird, @@ -1128,7 +1128,7 @@ </para> <para> This website centers around a windows-tool to tweak the chipset, you - can do the same on FreeBSD with <command>pciconf</command>. + can do the same on FreeBSD with <command>pciconf</command>. On some linux distributions there are similar tools. </para> </listitem> @@ -1173,7 +1173,7 @@ <parameter>engine.buffers.video_num_buffers:500</parameter> to a higher value (e.g. 1000 or 2500). </para> - </listitem> + </listitem> </itemizedlist> </para> </sect2> @@ -1225,7 +1225,7 @@ To use it make sure you have aalib installed correctly before you configure/build xine-lib and xine-ui. In addition to the <command>xine</command> binary a binary named <command>aaxine</command> should get built and installed. You can then use - something like: + something like: <screen> <command>aaxine foo.mpg</command></screen> to use aalib video output. </para> @@ -1270,7 +1270,7 @@ <para> You can enable xine's audio compressor. Most frontends have a settings window and in that you'll find a slider for the - compressor setting. The values are percent values, so a + compressor setting. The values are percent values, so a slider setting of 200 means that xine will double the volume of silent parts of the movie (loud parts stay the same). </para> @@ -1297,7 +1297,7 @@ <para> If this happens with any video, first try a different audio driver (<command>gxine -A oss</command>, <command>gxine -A arts</command>, - <command>xine -A alsa</command> …). + <command>xine -A alsa</command> …). </para> <para> If this problem only occurs with one specific stream, maybe switching to @@ -1307,8 +1307,8 @@ <para> If all this doesn't help, maybe you're missing an audio codec or you found a bug. If you decide to post your problem on the xine-user mailing list, - make sure to include all console output xine produced and also clearly - state what type of stream you tried to play back or, even better, make + make sure to include all console output xine produced and also clearly + state what type of stream you tried to play back or, even better, make a test stream available somewhere for developers to download and try. </para> </sect2> @@ -1346,8 +1346,8 @@ <sect2 id="sblivespdif"> <title>Getting SPDIF output from a SBLive 5.1 using OSS drivers</title> <para> - The following explains how to get the above configuration - going with xine. Some parts of it may applicable to other + The following explains how to get the above configuration + going with xine. Some parts of it may applicable to other configurations (cards that use the EMU10k1 chip) as well. </para> <sect3> @@ -1376,24 +1376,24 @@ <para> The OSS driver is maintained by creative and can be downloaded at <ulink url="http://opensource.creative.com/">http://opensource.creative.com/</ulink>. - The driver package contains documentation on how to install it. + The driver package contains documentation on how to install it. Besides that I'd like to add the following notes. </para> <para> In order to compile and install these drivers, you need a valid kernel configuration file. For RedHat Linux's pre-compiled kernels these - configuration files can be found in + configuration files can be found in <filename>/usr/src/linux/configs</filename>. After you've located the correct config file for your kernel, you need to copy it to <filename>/usr/src/linux/.config</filename> For example, when you run the 2.4.18-i686 kernel do : <screen> <command>cp /usr/src/linux/configs/kernel-2.4.18-i686.config /usr/src/linux/.config</command></screen> - Make sure that the emu10k1 module that is currently installed is + Make sure that the emu10k1 module that is currently installed is not loaded. To unload the modules: <screen> <command>/sbin/modprobe -rv emu10k1.o ac97_codec.o</command></screen> - If this mentions that the device is busy, some program is - using the driver. Some example could be a mixer application - or sound daemon like artsd. You'll need to close down the + If this mentions that the device is busy, some program is + using the driver. Some example could be a mixer application + or sound daemon like artsd. You'll need to close down the applications before continuing. At success it should print something like: <screen> @@ -1402,15 +1402,15 @@ # delete soundcore</screen> Run make in the directory where you unpacked the driver and follow the instructions printed at the end of each step. - The last step should be: + The last step should be: <screen> <command>make install-tools</command></screen> - As the README of the driver package mentions the SPDIF AC3 - output doesn't work by default. In the directory + As the README of the driver package mentions the SPDIF AC3 + output doesn't work by default. In the directory <filename>utils/scripts</filename> an <filename>emu10k1.conf</filename> file can be found which need to be placed in the default - installation directory (<filename>/usr/local/etc</filename>). + installation directory (<filename>/usr/local/etc</filename>). After this the <filename>emu10k1.conf</filename> needs to be modified. - The following settings worked fine for me (I don't use the analog + The following settings worked fine for me (I don't use the analog outputs of the card): <programlisting> CARD_IS_5_1=yes @@ -1424,20 +1424,20 @@ ANALOG_FRONT_BOOST=no SURROUND=no PROLOGIC=no - ENABLE_CD_Spdif=yes - ENABLE_OPTICAL_SPDIF=no - ENABLE_LINE2_MIC2=no - ENABLE_RCA_SPDIF=no + ENABLE_CD_Spdif=yes + ENABLE_OPTICAL_SPDIF=no + ENABLE_LINE2_MIC2=no + ENABLE_RCA_SPDIF=no ENABLE_RCA_AUX=no</programlisting> - After modifying the <filename>emu10k1.conf</filename>, + After modifying the <filename>emu10k1.conf</filename>, you need to modify your <filename>/etc/modules.conf</filename> and make sure the following lines are in there. <programlisting> alias sound-slot-0 emu10k1 post-install emu10k1 /usr/local/etc/emu-script</programlisting> - After saving the changes to <filename>modules.conf</filename>, run + After saving the changes to <filename>modules.conf</filename>, run <screen> <command>/sbin/depmod -a</command></screen> - Now, you're ready to load the new modules and set the correct + Now, you're ready to load the new modules and set the correct options for it. To load the modules run: <screen> <command>/sbin/modprobe emu10k1</command></screen> </para> @@ -1453,7 +1453,7 @@ </sect3> <sect3> <title> - The cable used for the SBLive can easily be self-made + The cable used for the SBLive can easily be self-made or buy a stereo 3.5mm jack to dual RCA cable. </title> <para> @@ -1470,10 +1470,10 @@ </para> <para> In order to test it use a DVD with AC3 or DTS track - start xine and select the right audio track - from user interface or start xine as: + start xine and select the right audio track + from user interface or start xine as: <screen> <command>xine dvd:/1 -a 0</command></screen> - The external decoder should display something like + The external decoder should display something like "Dolby Digital" in case the selected audio track contains AC3 data or "DTS" in case the selected audio track contains DTS data. Of course stereo audio also goes @@ -1494,7 +1494,7 @@ <para> Note that recently we added support to "simulate" volume in aRts by changing sample values on-the-fly before delivering them to the driver. - Not as good as having access to sound card's mixer but at least users + Not as good as having access to sound card's mixer but at least users will not complain about lacking of volume bar anymore! :) </para> </sect2> @@ -1503,7 +1503,7 @@ <title>Audio is stuttering and i see a lot of "metronom: fixing sound card drift by -2115 pts" on the console output</title> <para> Might be a soundcard problem, if it only comes in longer intervals. - Your soundcard does not keep it's sampling frequency accurately + Your soundcard does not keep it's sampling frequency accurately enough, which results in audio and video getting out of sync and xine has to compensate. If you see the message only from time to time, you might remedy it by using the resampling sync @@ -1524,7 +1524,7 @@ </para> <para> Occasional messages of "fixing sound card drift" may happen on start and - when playing a long stream (like a movie). This is normal behaviour, + when playing a long stream (like a movie). This is normal behaviour, nothing to worry about. </para> </sect2> @@ -1568,7 +1568,7 @@ questions. </para> </sect2> - + <sect2 id="bluescreen"> <title>I only see a blue (or green or black) video image most of the time.</title> <para> @@ -1582,7 +1582,7 @@ <filename>/etc/X11/xorg.conf</filename> or <filename>/etc/X11/XF86Config</filename>). </para> </sect2> - + <sect2 id="buggyxv"> <title>The image looks strange, it is shifted, cropped or shows weird lines!</title> <para> @@ -1627,18 +1627,18 @@ hardware. Here are some hints for individual gfx chips: <itemizedlist> <listitem> - <para> + <para> 3Dfx: if all you get is a solid black window, upgrade to X.org or XFree 4.1.0 or later. </para> </listitem> <listitem> - <para> + <para> ATI: if you only get "half a picture", try lowering your resolution - or bit depth, disable DRI (looks like you ran out of video RAM) + or bit depth, disable DRI (looks like you ran out of video RAM) </para> </listitem> <listitem> - <para> + <para> Trident card: If you see vertical bands jumbled, upgrade to the latest xfree/experimental trident drivers (for the CyberBlade XP a driver exists here: @@ -1646,61 +1646,61 @@ </para> </listitem> <listitem> - <para> + <para> nVidia: With newer GeForce cards, Xv should work with XFree 4.2.0 or newer, for older RivaTNT cards use the binary drivers from nvidia (of course the binary drivers work as well for GeForce cards) </para> </listitem> <listitem> - <para> + <para> Mach64/Rage3D (not Rage128/Radeon) cards/chips get no XVideo with - standard drivers, try + standard drivers, try <ulink url="http://gatos.sourceforge.net/">GATOS drivers </ulink> instead </para> </listitem> <listitem> - <para> + <para> intel: i815 has Xv support in XFree 4.x, others unknown </para> </listitem> <listitem> - <para> + <para> Permedia 2/3 has Xv support in XFree 4.x </para> </listitem> <listitem> - <para> + <para> Savage: at least some older drivers tend to lock up the whole machine, - try the drivers available from + try the drivers available from <ulink url="http://www.probo.com/timr/savage40.html"> http://www.probo.com/timr/savage40.html </ulink>. </para> </listitem> <listitem> - <para> + <para> SIS: certain controllers (more info needed!) have Xv support in XFree 4.x </para> </listitem> <listitem> - <para> + <para> Chips and Tech 6555x, 68554, 69000, 69030 have Xv support in XFree 4.x </para> </listitem> <listitem> - <para> + <para> NeoMagic: certain controllers (more info needed!) have Xv support in Xfree 4.x </para> </listitem> <listitem> - <para> + <para> SiliconMotion: certain controllers (more info needed!) have Xv support in Xfree 4.x </para> </listitem> <listitem> - <para> + <para> Matrox: G200 or newer (but not Parhelia) have Xv support in XFree 4.x. For Parhelia, use the binary only drivers available from matrox' website. </para> @@ -1758,12 +1758,12 @@ <para> Usually xine discovers the screen aspect ratio by querying the X-server and then adjusts the video automatically - to make it look right. However, if that doesn't work try + to make it look right. However, if that doesn't work try pressing "a" to manually change the aspect ratio. </para> <para> If you have a wide screen monitor, make sure the X-server - is correctly configured. The X-server must know the physical + is correctly configured. The X-server must know the physical size of the screen, which is independent of the resolution being used. </para> @@ -1782,7 +1782,7 @@ For XFree86, the filename is normally <filename>/etc/X11/XF86Config</filename>. </para> <para> - Where <parameter>DisplaySize</parameter> specifies, + Where <parameter>DisplaySize</parameter> specifies, in millimeters, the physical size of the monitor's picture area. </para> </sect2> @@ -1796,7 +1796,7 @@ <para> The difference between these counters is a little subtle for the non developer. There are two threads running in order to display video: - the decoder thread will deliver frames to the video output thread. + the decoder thread will deliver frames to the video output thread. The latter is responsible for scheduling the frames to be displayed at the right time. </para> @@ -1833,7 +1833,7 @@ </para> <para> Please note that some frontends save these settings in their config file - so when you have found a working combination, make sure you exit + so when you have found a working combination, make sure you exit xine cleanly so the values are saved. </para> </sect2> @@ -1852,13 +1852,13 @@ Xv by default. </para> <para> - However some users may want to explore better the available hardware + However some users may want to explore better the available hardware capabilities (eg. syncing frame drawing with monitor refresh). Also some Xv drivers contain slow copies and accessing the video card directly may yield performance gains. </para> <para> - Drivers that access hardware directly includes VIDIX (warning: requires + Drivers that access hardware directly includes VIDIX (warning: requires root priviledges or kernel helper) and SyncFB (requires kernel helper – Matrox only). User may try one of those, but should be warned that with root access they can cause the system to crash hard. The support is also limited to @@ -1898,7 +1898,7 @@ altogether. </para> <para> - Unscaled OSD usage by subtitles and xine-ui is controlled by + Unscaled OSD usage by subtitles and xine-ui is controlled by the following settings (<filename>~/.xine/config</filename> or <filename>~/.gxine/config</filename>): <programlisting> gui.osd_use_unscaled:0</programlisting> @@ -1910,17 +1910,17 @@ <title>I can't see the OSD or it leaves a black box over the image!</title> <para> If you are using xine-lib version 1-rc3 or newer, this is probably - due buggy XV drivers that do not support + due buggy XV drivers that do not support <link linkend="unscaledosd">unscaled OSD</link> (the XShape - extension) properly. + extension) properly. </para> <para> - There have being reports of some ATI drivers that don't allow + There have being reports of some ATI drivers that don't allow displaying anything over the video. The VIA Epia binary drivers is reported to leave a black box where the OSD was displayed. </para> <para> - The problem may be fixed by either updating the video driver, + The problem may be fixed by either updating the video driver, or disabling xine unscaled OSD support. </para> </sect2> @@ -1945,7 +1945,7 @@ <title>Why external subtitles look so ugly?</title> <para> You are probably using a xine-lib version older than 1-rc3. - Try upgrading your copy and read the + Try upgrading your copy and read the <link linkend="unscaledosd">section about unscaled osd</link>. </para> </sect2> @@ -1975,7 +1975,7 @@ </para> <para> Also notice that DVD overlays (including subtitles) are meant to - be displayed in a fixed position, this is how the DVD menu + be displayed in a fixed position, this is how the DVD menu highlighting works. xine does not support moving them. </para> </sect2> @@ -2064,7 +2064,7 @@ <sect2 id="subencoding"> <title>Encoding of external subtitles is bad. What is wrong?</title> <para> - The encoding of the external subtitles is expected to be iso-8859-1 by + The encoding of the external subtitles is expected to be iso-8859-1 by default. You need to set an appropriate encoding in the config option <parameter>subtitles.separate.src_encoding</parameter>. Note that you also need a font which contains all characters from the given encoding. @@ -2150,7 +2150,7 @@ for more information. </para> </sect2> - + <sect2 id="status0x51"> <title>My drive doesn't work and the kernel says "status=0x51 { DriveReady SeekComplete Error }"</title> <para> @@ -2194,7 +2194,7 @@ have two possibilities. Either deactivate ESD (temporarily) by right clicking on the sound monitor applet and selecting "Place Esound in standby" or just kill it. Then xine will use OSS audio output. The other - method is to make xine use ESD for audio output with: + method is to make xine use ESD for audio output with: <screen> <command>gxine -A esd</command></screen> This may result in worse playback – exact syncronization is not possible with esd, so using oss should be preferred. @@ -2264,7 +2264,7 @@ <listitem> <para> Can you reproduce the bug? (e.g. do you remember what you - did and when you do it again it crashes again?) + did and when you do it again it crashes again?) </para> </listitem> <listitem> @@ -2284,7 +2284,7 @@ Your X server just froze on you? unfortunately that's a known problem with some chipsets and drivers (most commonly Savage chipsets) when using Xv. You might want to try running <command>gxine -V XShm</command> - to see if the problem is related to the Xv driver. This will unfortunately + to see if the problem is related to the Xv driver. This will unfortunately be much slower, as lots of things are now done in software instead of hardware scaling/colour space conversion. </para> diff --git a/doc/hackersguide/README b/doc/hackersguide/README index c0c0d944a..ef0ac825a 100644 --- a/doc/hackersguide/README +++ b/doc/hackersguide/README @@ -27,7 +27,7 @@ installed TeX system (for example teTeX). sgmltools-lite examples: ------------------------ -to generate html +to generate html $ sgmltools -b onehtml hackersguide.sgml diff --git a/doc/hackersguide/architecture.fig b/doc/hackersguide/architecture.fig index cc035149d..9e420bf42 100644 --- a/doc/hackersguide/architecture.fig +++ b/doc/hackersguide/architecture.fig @@ -2,7 +2,7 @@ Landscape Center Metric -A4 +A4 100.00 Single -2 diff --git a/doc/hackersguide/internals.sgml b/doc/hackersguide/internals.sgml index 8ffef06cd..58a5a3c37 100644 --- a/doc/hackersguide/internals.sgml +++ b/doc/hackersguide/internals.sgml @@ -15,15 +15,15 @@ </caption> </mediaobject> <para> - Media streams usually consist of audio and video data multiplexed + Media streams usually consist of audio and video data multiplexed into one bitstream in the so-called system-layer (e.g. AVI, Quicktime or MPEG). A demuxer plugin is used to parse the system layer and extract audio and video packages. The demuxer uses an input plugin to read the data and stores it - in pre-allocated buffers from the global buffer pool. + in pre-allocated buffers from the global buffer pool. The buffers are then added to the audio or video stream fifo. </para> <para> - From the other end of these fifos the audio and video decoder threads + From the other end of these fifos the audio and video decoder threads consume the buffers and hand them over to the current audio or video decoder plugin for decompression. These plugins then send the decoded data to the output layer. The buffer holding the encoded @@ -188,7 +188,7 @@ This plugin list is held in an array named <varname>xine_plugin_info</varname>": <programlisting> plugin_info_t xine_plugin_info[] = { - /* type, API, "name", version, special_info, init_function */ + /* type, API, "name", version, special_info, init_function */ { PLUGIN_DEMUX, 20, "flac", XINE_VERSION_CODE, NULL, demux_flac_init_class }, { PLUGIN_AUDIO_DECODER, 13, "flacdec", XINE_VERSION_CODE, &dec_info_audio, init_plugin }, { PLUGIN_NONE, 0, "", 0, NULL, NULL } @@ -236,7 +236,7 @@ same plugin are possible. </para> <para> - If you think this is pretty much an object-oriented aproach, + If you think this is pretty much an object-oriented aproach, then you're right. </para> <para> @@ -278,7 +278,7 @@ <para> Many plugins will need some additional "private" data fields. These should be simply added at the end of the plugin structure. - For example a demuxer plugin called "foo" with two private + For example a demuxer plugin called "foo" with two private fields "xine" and "count" may have a plugin structure declared in the following way: <programlisting> @@ -325,13 +325,13 @@ <para> Metronom serves two purposes: <itemizedlist> - <listitem> + <listitem> <para> Generate vpts (virtual presentation time stamps) from pts (presentation time stamps) for a/v output and synchronization. </para> </listitem> - <listitem> + <listitem> <para> Provide a master clock (system clock reference, scr), possibly provided by external scr plugins (this can be used if some hardware decoder or network @@ -352,7 +352,7 @@ The heuristics used in metronom have always been a field of research. Current metronom's implementation <emphasis>tries</emphasis> to stick to pts values as reported from demuxers, that is, vpts may be obtained by a simple operation of vpts = pts + <varname>vpts_offset</varname>, - where <varname>vpts_offset</varname> takes into account any wraps. Whenever pts is zero, + where <varname>vpts_offset</varname> takes into account any wraps. Whenever pts is zero, metronom will estimate vpts based on previous values. If a difference is found between the estimated and calculated vpts values by above formula, it will be smoothed by using a "drift correction". @@ -369,11 +369,11 @@ delivered for drawing. Unfortunately the same isn't true for audio: all sound systems implement some amount of buffering (or fifo), any data being send to it <emphasis>now</emphasis> will only get played some time in future. audio_out thread - must take this into account for making perfect A-V sync by asking the sound latency + must take this into account for making perfect A-V sync by asking the sound latency to audio driver. </para> <para> - Some audio drivers can't tell the current delay introduced in playback. This is + Some audio drivers can't tell the current delay introduced in playback. This is especially true for most sound servers like ESD or aRts and explain why in such cases the sync is far from perfect. </para> @@ -388,11 +388,11 @@ <itemizedlist> <listitem> <para> - The small sound card errors are feedbacked to metronom. The details + The small sound card errors are feedbacked to metronom. The details are given by <filename>audio_out.c</filename> comments: <programlisting> /* By adding gap errors (difference between reported and expected - * sound card clock) into metronom's vpts_offset we can use its + * sound card clock) into metronom's vpts_offset we can use its * smoothing algorithms to correct sound card clock drifts. * obs: previously this error was added to xine scr. * @@ -438,7 +438,7 @@ <sect1 id="osd"> <title>Overlays and OSD</title> <para> - The roots of xine overlay capabilities are DVD subpictures and subtitles support + The roots of xine overlay capabilities are DVD subpictures and subtitles support (also known as 'spu'). The DVD subtitles are encoded in a RLE (Run Length Encoding - the most simple compressing technique) format, with a palette of colors and transparency levels. You probably thought that subtitles were just simple text saved into DVDs, right? @@ -446,7 +446,7 @@ </para> <para> In order to optimize to the most common case, xine's internal format for screen overlays - is a similar representation to the 'spu' data. This brings not only performance + is a similar representation to the 'spu' data. This brings not only performance benefit (since blending functions may skip large image areas due to RLE) but also compatibility: it's possible to re-encode any xine overlay to the original spu format for displaying with mpeg hardware decoders like DXR3. @@ -456,14 +456,14 @@ is done using the same kind of pts/vpts stuff of a-v sync code. DVD subtitles, for example, may request: show this spu at pts1 and hide it at pts2. This brings the concept of the 'video overlay manager', that is a event-driven module for managing - overlay's showing and hiding. + overlay's showing and hiding. </para> <para> The drawback of using internal RLE format is the difficulty in manipulating it as graphic. To overcome that we created the 'OSD renderer', where OSD stands - for On Screen Display just like in TV sets. The osd renderer is a module + for On Screen Display just like in TV sets. The osd renderer is a module providing simple graphic primitives (lines, rectagles, draw text etc) over - a "virtual" bitmap area. Everytime we want to show that bitmap it will + a "virtual" bitmap area. Everytime we want to show that bitmap it will be RLE encoded and sent to the overlay manager for displaying. </para> <mediaobject> @@ -496,13 +496,13 @@ event.object.overlay->width = 100; event.object.overlay->height = 100; - /* clipping region is mostly used by dvd menus for highlighting buttons */ + /* clipping region is mostly used by dvd menus for highlighting buttons */ event.object.overlay->clip_top = 0; event.object.overlay->clip_bottom = image_height; event.object.overlay->clip_left = 0; event.object.overlay->clip_right = image_width; - /* the hard part: provide a RLE image */ + /* the hard part: provide a RLE image */ event.object.overlay->rle = your_rle; event.object.overlay->data_size = your_size; event.object.overlay->num_rle = your_rle_count; @@ -512,7 +512,7 @@ /* this table contains transparency levels for each color index. 0 = completely transparent, 15 - completely opaque */ - memcpy(event.object.overlay->clip_trans, trans, sizeof(trans)); + memcpy(event.object.overlay->clip_trans, trans, sizeof(trans)); /* set the event type and time for displaying */ event.event_type = EVENT_SHOW_SPU; @@ -527,9 +527,9 @@ to xine plugins and to frontends. </para> <para> - The first thing you need is to allocate a OSD object for drawing from the + The first thing you need is to allocate a OSD object for drawing from the renderer. The code below allocates a 300x200 area. This size can't be changed - during the lifetime of a OSD object, but it's possible to place it anywhere + during the lifetime of a OSD object, but it's possible to place it anywhere over the image. </para> <programlisting> @@ -561,7 +561,7 @@ <programlisting> osd_renderer->render_text(osd, 0, 0, "white text, black border", OSD_TEXT1); osd_renderer->render_text(osd, 0, 30, "white text, no border", OSD_TEXT2); - + osd_renderer->show(osd, 0); /* 0 stands for 'now' */</programlisting> </para> <para> @@ -592,7 +592,7 @@ defined a small convention: </para> <programlisting> - /* + /* Palette entries as used by osd fonts: 0: not used by font, always transparent @@ -603,13 +603,13 @@ 6: font border. if the font is to be displayed without border this will probably be adjusted to font background or near. 7-9: transition between border and foreground - 10: font color (foreground) + 10: font color (foreground) */</programlisting> <para> The so called 'transitions' are used to implement font anti-aliasing. That convention requires that any font file must use only the colors from 1 to 10. When we use the set_text_palette() function we are just copying 11 palette - entries to the specified base index. + entries to the specified base index. </para> <para> That base index is the same we pass to render_text() function to use the @@ -623,7 +623,7 @@ /* draws a box using font background color (translucid) */ renderer->filled_rect(osd, x1, y1, x1+width, y1+height, OSD_TEXT2 + 1); - /* render text */ + /* render text */ renderer->render_text(osd, x1, y1, text, OSD_TEXT2);</programlisting> </sect3> <sect3> @@ -669,8 +669,8 @@ <para> A: osd objects have no shadows by itself, but fonts use 11 colors to produce an anti-aliased effect. - if you set a "text palette" with entries 0-9 being transparent - and 10 being foreground you will get rid of any borders or + if you set a "text palette" with entries 0-9 being transparent + and 10 being foreground you will get rid of any borders or anti-aliasing. </para> </sect3> diff --git a/doc/hackersguide/intro.sgml b/doc/hackersguide/intro.sgml index 4e96d2de1..cd163e2ee 100644 --- a/doc/hackersguide/intro.sgml +++ b/doc/hackersguide/intro.sgml @@ -4,7 +4,7 @@ <sect1> <title>Where am I?</title> <para> - You are currently looking at a piece of documentation for xine. + You are currently looking at a piece of documentation for xine. xine is a free video player. It lives on <ulink url="http://www.xine-project.org/">http://www.xine-project.org/</ulink>. Specifically this document goes under the moniker of the "xine Hackers' Guide". diff --git a/doc/hackersguide/library.fig b/doc/hackersguide/library.fig index 13dc79f0e..ec33d0f32 100644 --- a/doc/hackersguide/library.fig +++ b/doc/hackersguide/library.fig @@ -2,7 +2,7 @@ Landscape Center Metric -A4 +A4 100.00 Single -2 diff --git a/doc/hackersguide/library.sgml b/doc/hackersguide/library.sgml index 1d987d259..eb51baaaf 100644 --- a/doc/hackersguide/library.sgml +++ b/doc/hackersguide/library.sgml @@ -32,7 +32,7 @@ Details on the OSD feature can be found in the <link linkend="osd">OSD section</link>. </para> </sect1> - + <sect1> <title>Writing a new frontend to xine</title> <para> @@ -51,21 +51,21 @@ <programlisting> /* ** Copyright (C) 2003 Daniel Caujolle-Bert <segfault@club-internet.fr> -** +** ** This program is free software; you can redistribute it and/or modify ** it under the terms of the GNU General Public License as published by ** the Free Software Foundation; either version 2 of the License, or ** (at your option) any later version. -** +** ** This program is distributed in the hope that it will be useful, ** but WITHOUT ANY WARRANTY; without even the implied warranty of ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ** GNU General Public License for more details. -** +** ** You should have received a copy of the GNU General Public License ** along with this program; if not, write to the Free Software ** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -** +** */ /* @@ -127,7 +127,7 @@ static void dest_size_cb(void *data, int video_width, int video_height, double v /* this will be called by xine when it's about to draw the frame */ static void frame_output_cb(void *data, int video_width, int video_height, double video_pixel_aspect, int *dest_x, int *dest_y, - int *dest_width, int *dest_height, + int *dest_width, int *dest_height, double *dest_pixel_aspect, int *win_x, int *win_y) { *dest_x = 0; *dest_y = 0; @@ -139,7 +139,7 @@ static void frame_output_cb(void *data, int video_width, int video_height, } static void event_listener(void *user_data, const xine_event_t *event) { - switch(event->type) { + switch(event->type) { case XINE_EVENT_UI_PLAYBACK_FINISHED: running = 0; break; @@ -147,11 +147,11 @@ static void event_listener(void *user_data, const xine_event_t *event) { case XINE_EVENT_PROGRESS: { xine_progress_data_t *pevent = (xine_progress_data_t *) event->data; - + printf("%s [%d%%]\n", pevent->description, pevent->percent); } break; - + /* you can handle a lot of other interesting events here */ } } @@ -175,7 +175,7 @@ int main(int argc, char **argv) { else if (strcmp(argv[i], "-ao") == 0) { ao_driver = argv[++i]; } - else + else mrl = argv[i]; } @@ -195,7 +195,7 @@ int main(int argc, char **argv) { snprintf(configfile, sizeof(configfile), "%s%s", xine_get_homedir(), "/.xine/config"); xine_config_load(xine, configfile); xine_init(xine); - + display = XOpenDisplay(NULL); screen = XDefaultScreen(display); xpos = 0; @@ -212,7 +212,7 @@ int main(int argc, char **argv) { window[1] = XCreateSimpleWindow(display, XDefaultRootWindow(display), 0, 0, (DisplayWidth(display, screen)), (DisplayHeight(display, screen)), 0, 0, 0); - + XSelectInput(display, window[0], INPUT_MOTION); XSelectInput(display, window[1], INPUT_MOTION); @@ -223,14 +223,14 @@ int main(int argc, char **argv) { XChangeProperty(display, window[1], XA_NO_BORDER, XA_NO_BORDER, 32, PropModeReplace, (unsigned char *) &mwmhints, PROP_MWM_HINTS_ELEMENTS); - + XMapRaised(display, window[fullscreen]); - + res_h = (DisplayWidth(display, screen) * 1000 / DisplayWidthMM(display, screen)); res_v = (DisplayHeight(display, screen) * 1000 / DisplayHeightMM(display, screen)); XSync(display, False); XUnlockDisplay(display); - + /* filling in the xine visual struct */ vis.display = display; vis.screen = screen; @@ -239,7 +239,7 @@ int main(int argc, char **argv) { vis.frame_output_cb = frame_output_cb; vis.user_data = NULL; pixel_aspect = res_v / res_h; - + /* opening xine output ports */ vo_port = xine_open_video_driver(xine, vo_driver, XINE_VISUAL_TYPE_X11, (void *)&vis); ao_port = xine_open_audio_driver(xine , ao_driver, NULL); @@ -249,11 +249,11 @@ int main(int argc, char **argv) { /* hook our event handler into the streams events */ event_queue = xine_event_new_queue(stream); xine_event_create_listener_thread(event_queue, event_listener, NULL); - + /* make the video window visible to xine */ xine_port_send_gui_data(vo_port, XINE_GUI_SEND_DRAWABLE_CHANGED, (void *) window[fullscreen]); xine_port_send_gui_data(vo_port, XINE_GUI_SEND_VIDEOWIN_VISIBLE, (void *) 1); - + /* start playback */ if (!xine_open(stream, mrl) || !xine_play(stream, 0, 0)) { printf("Unable to open mrl '%s'\n", mrl); @@ -269,12 +269,12 @@ int main(int argc, char **argv) { if( got_event ) XNextEvent(display, &xevent); XUnlockDisplay(display); - + if( !got_event ) { xine_usec_sleep(20000); continue; } - + switch(xevent.type) { case KeyPress: @@ -283,27 +283,27 @@ int main(int argc, char **argv) { KeySym ksym; char kbuf[256]; int len; - + kevent = xevent.xkey; - + XLockDisplay(display); len = XLookupString(&kevent, kbuf, sizeof(kbuf), &ksym, NULL); XUnlockDisplay(display); - + switch (ksym) { - + case XK_q: case XK_Q: /* user pressed q => quit */ running = 0; break; - + case XK_f: case XK_F: { /* user pressed f => toggle fullscreen */ Window tmp_win; - + XLockDisplay(display); XUnmapWindow(display, window[fullscreen]); fullscreen = !fullscreen; @@ -313,36 +313,36 @@ int main(int argc, char **argv) { DefaultRootWindow(display), 0, 0, &xpos, &ypos, &tmp_win); XUnlockDisplay(display); - - xine_port_send_gui_data(vo_port, XINE_GUI_SEND_DRAWABLE_CHANGED, + + xine_port_send_gui_data(vo_port, XINE_GUI_SEND_DRAWABLE_CHANGED, (void*) window[fullscreen]); } break; - + case XK_Up: /* cursor up => increase volume */ xine_set_param(stream, XINE_PARAM_AUDIO_VOLUME, (xine_get_param(stream, XINE_PARAM_AUDIO_VOLUME) + 1)); break; - + case XK_Down: /* cursor down => decrease volume */ xine_set_param(stream, XINE_PARAM_AUDIO_VOLUME, (xine_get_param(stream, XINE_PARAM_AUDIO_VOLUME) - 1)); break; - + case XK_plus: /* plus => next audio channel */ - xine_set_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL, + xine_set_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL, (xine_get_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL) + 1)); break; - + case XK_minus: /* minus => previous audio channel */ - xine_set_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL, + xine_set_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL, (xine_get_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL) - 1)); break; - + case XK_space: /* space => toggle pause mode */ if (xine_get_param(stream, XINE_PARAM_SPEED) != XINE_SPEED_PAUSE) @@ -350,26 +350,26 @@ int main(int argc, char **argv) { else xine_set_param(stream, XINE_PARAM_SPEED, XINE_SPEED_NORMAL); break; - + } } break; - + case Expose: /* this handles (partial) occlusion of our video window */ if (xevent.xexpose.count != 0) break; xine_port_send_gui_data(vo_port, XINE_GUI_SEND_EXPOSE_EVENT, &xevent); break; - + case ConfigureNotify: { XConfigureEvent *cev = (XConfigureEvent *) &xevent; Window tmp_win; - + width = cev->width; height = cev->height; - + if ((cev->x == 0) && (cev->y == 0)) { XLockDisplay(display); XTranslateCoordinates(display, cev->window, @@ -382,26 +382,26 @@ int main(int argc, char **argv) { } } break; - + } } - + /* cleanup */ xine_close(stream); xine_event_dispose_queue(event_queue); xine_dispose(stream); - xine_close_audio_driver(xine, ao_port); - xine_close_video_driver(xine, vo_port); + xine_close_audio_driver(xine, ao_port); + xine_close_video_driver(xine, vo_port); xine_exit(xine); - + XLockDisplay(display); XUnmapWindow(display, window[fullscreen]); XDestroyWindow(display, window[0]); XDestroyWindow(display, window[1]); XUnlockDisplay(display); - + XCloseDisplay (display); - + return 0; }</programlisting> </sect2> diff --git a/doc/hackersguide/output.sgml b/doc/hackersguide/output.sgml index 57781c05e..64adbd294 100644 --- a/doc/hackersguide/output.sgml +++ b/doc/hackersguide/output.sgml @@ -116,7 +116,7 @@ <programlisting> if (_x_post_dispose(this)) really_free(this);</programlisting> - <function>_x_post_dispose()</function> frees any ressources allocated by any of the + <function>_x_post_dispose()</function> frees any ressources allocated by any of the post plugin helper functions and returns boolean true, if the plugin is not needed any more. </para> @@ -434,7 +434,7 @@ <listitem> <para> This function can only be called by the xine engine, plugins do not have access to it. - It ends ticket revocation and hands out new tickets to all threads that applied with a + It ends ticket revocation and hands out new tickets to all threads that applied with a <function>acquire()</function> or <function>renew()</function>. If you revoked the tickets atomic, you have to issue them atomic. </para> @@ -499,7 +499,7 @@ <function>_x_post_rewire()</function> should be used in prominent locations where it is safe to be suspended. Candidates for such locations are at the beginning of the port's <function>open()</function> and - <function>get_frame()</function>/<function>get_buffer()</function> functions. + <function>get_frame()</function>/<function>get_buffer()</function> functions. The default pass through implementations for intercepted ports already do this. </para> <para> @@ -515,7 +515,7 @@ </sect3> </sect2> </sect1> - + <sect1> <title>Video output</title> <para> @@ -539,13 +539,13 @@ </listitem> <listitem> <para> - Most important, the ability to render/copy a given + Most important, the ability to render/copy a given frame to the output device. </para> </listitem> <listitem> <para> - Optionally the copying of the frame from a file dependant + Optionally the copying of the frame from a file dependant colour-space and depth into the frame structure. This is to allow for on-the fly colour-space conversion and scaling if required (e.g. the XShm ouput plugin uses this mechanism). @@ -569,7 +569,7 @@ The <varname>visual_type</varname> field is used by xine to determine if the GUI used by the client is supported by the plugin (e.g. X11 output plugins require the GUI to be running under the - X Windowing system) and also to determine the type of information passed to the + X Windowing system) and also to determine the type of information passed to the <function>open_plugin()</function> function as its <varname>visual</varname> parameter. </para> <para> @@ -590,7 +590,7 @@ The <varname>visual</varname> is a pointer to a visual-dependant structure/variable. For example, if you had previously claimed your plugin was of the VISUAL_TYPE_X11 type, this would be a pointer - to a <type>x11_visual_t</type>, which amongst other things hold the + to a <type>x11_visual_t</type>, which amongst other things hold the <type>Display</type> variable associated with the X-server xine should display to. See plugin source-code for other VISUAL_TYPE_* constants and associated structures. Note that this @@ -609,7 +609,7 @@ int get_property(vo_driver_t *self, int property); int set_property(vo_driver_t *self, int property, int value); void get_property_min_max(vo_driver_t *self, int property, int *min, int *max);</programlisting> - Handle the getting, setting of properties and define their bounds. + Handle the getting, setting of properties and define their bounds. Valid property IDs can be found in the <filename>video_out.h</filename> header file. </para> diff --git a/doc/hackersguide/overlays.fig b/doc/hackersguide/overlays.fig index 0301aead2..78ecda61c 100644 --- a/doc/hackersguide/overlays.fig +++ b/doc/hackersguide/overlays.fig @@ -2,7 +2,7 @@ Portrait Center Metric -A4 +A4 100.00 Single -2 diff --git a/doc/hackersguide/overview.sgml b/doc/hackersguide/overview.sgml index eb62e5bd3..18cc40396 100644 --- a/doc/hackersguide/overview.sgml +++ b/doc/hackersguide/overview.sgml @@ -201,7 +201,7 @@ <term><filename>libmad</filename> (imported)</term> <listitem> <para> - Mpeg audio decoder plugin (i.e. mp2 and mp3 decoding). + Mpeg audio decoder plugin (i.e. mp2 and mp3 decoding). ISO/IEC compliant decoder using fixed point math. </para> <para></para> @@ -529,7 +529,7 @@ <sect1> <title>Object oriented programming in C</title> <para> - xine uses a lot of design principles normally found in + xine uses a lot of design principles normally found in object oriented designs. As xine is written in C, a few basic principles shall be explained here on how xine is object oriented anyway. @@ -561,7 +561,7 @@ my_stack_t stack; /* public part */ /* private part follows here */ - int values[MAX_STACK_SIZE]; + int values[MAX_STACK_SIZE]; int stack_size; } intstack_t;</programlisting> Each method is implemented as a static method (static to prevent @@ -646,7 +646,7 @@ </para> </sect2> </sect1> - + <sect1> <title>Coding style and guidelines</title> <para> @@ -655,35 +655,35 @@ Contributions will not be rejected if they do not meet these rules but they will be even more appreciated if they do. <itemizedlist> - <listitem> + <listitem> <para> Comment your interfaces directly in the header files. No doxygen comments, ordinary C comments will do. </para> </listitem> - <listitem> + <listitem> <para> Use C-style comments (/* */), not C++-style (//). </para> </listitem> - <listitem> + <listitem> <para> When in doubt, use lower case. BTW: This thing is called xine, never Xine. </para> </listitem> - <listitem> + <listitem> <para> Use expressive variable and function identifiers on all public interfaces. Use underscores to seperate words in identifiers, not uppercase letters (my_function_name is ok, myFunctionName is not ok). </para> </listitem> - <listitem> + <listitem> <para> Avoid macros unless they are really useful. Avoid gotos. </para> </listitem> - <listitem> + <listitem> <para> use something like <programlisting> printf("module: ..."[,…]);</programlisting> @@ -692,7 +692,7 @@ output (see example above). </para> </listitem> - <listitem> + <listitem> <para> Refer to emac's C-mode for all questions of proper indentiation. That first of all means: indent with two spaces. @@ -701,7 +701,7 @@ </itemizedlist> </para> </sect1> - + <sect1> <title>The xine logging system</title> <para> diff --git a/doc/hackersguide/post_frame.fig b/doc/hackersguide/post_frame.fig index 4f576abdd..efafa31d5 100644 --- a/doc/hackersguide/post_frame.fig +++ b/doc/hackersguide/post_frame.fig @@ -2,7 +2,7 @@ Landscape Center Metric -A4 +A4 100.00 Single -2 diff --git a/doc/hackersguide/stream.sgml b/doc/hackersguide/stream.sgml index d9a5471bd..b9690d9fe 100644 --- a/doc/hackersguide/stream.sgml +++ b/doc/hackersguide/stream.sgml @@ -1,11 +1,11 @@ <chapter id="stream"> <title>xine's stream layer</title> - + <sect1> <title>Input layer</title> <para> Many media players expect streams to be stored within files on - some local medium. In actual fact, media may be streamed over a + some local medium. In actual fact, media may be streamed over a network (e.g. via HTTP or RTP), encoded onto a specialized medium (e.g. DVD), etc. To allow you to access all this media, xine supports the concept of an "input plugin". The tasks performed by an @@ -156,7 +156,7 @@ <para> xine's demuxer layer is responsible for taking apart multimedia files or streams so that the engine can decode them and present them to the user. - "Demuxer" is short for demultiplexor, which is the opposite of + "Demuxer" is short for demultiplexor, which is the opposite of multiplexing. This refers to the process of combining 2 or more things into one. Multimedia streams usually, at a minimum, multiplex an audio stream and a video stream together into one stream. Sometimes, there are @@ -329,7 +329,7 @@ <programlisting> void demux_send_headers(demux_plugin_t *this_gen);</programlisting> This function generally reads the headers of the stream, does whatever it has to do to figure out what audio and video codecs are used in the file, - and asks the xine engine to initialize the correct decoders with the + and asks the xine engine to initialize the correct decoders with the proper parameters (like width and height for video, sample rate and channels for audio). </para> diff --git a/doc/internal/HOWTO.release b/doc/internal/HOWTO.release index 38532aac0..2e2adff94 100644 --- a/doc/internal/HOWTO.release +++ b/doc/internal/HOWTO.release @@ -59,7 +59,7 @@ Currently, best practice to get a release out looks like this: which the subminor releases like 1.0.1, 1.0.2,... are made and an unstable branch in CVS head, which is going to become the next minor (1.1) or major (2.0) xine-lib version. - + Make sure you know - what the new release should be called (the "marketing version" part of the tarball name, for example) @@ -88,11 +88,11 @@ Currently, best practice to get a release out looks like this: - does it have the right name? - does it unpack, compile and install correctly? note: make sure to build with as many features as possible - on a Debian box, "apt-get build-dep xine-lib" and + on a Debian box, "apt-get build-dep xine-lib" and "dpkg-buildpackage -rfakeroot" are a good way to do that - test the candidate (and make sure you are running exactly the new version!) This should at least cover the [standard test parcours] - + If you find any errors: fix them (get help on xine-devel or #xine) and go back to step 4) @@ -129,7 +129,7 @@ hands. 12) write the announcement for xine-project.org: You need to have an account on alioth.debian.org and a checked-out copy - of ssh://hg.debian.org//hg/xine-lib/xine-project-www/ (using Mercurial). + of ssh://hg.debian.org//hg/xine-lib/xine-project-www/ (using Mercurial). Add the new news item near the top of pages/news/items.xml (use the provided template), run update.sh (requires xsltproc; if this fails, re-edit), check that it looks fine in a convenient browser, then commit |