File	Date	Author	Commit
doc	2008-10-09	diego	[02c08c] cosmetics: Remove all trailing whitespace.
examples	2009-01-07	reimar	[bbebd2] Fix compilation of menus.c example after header...
m4	2008-10-09	diego	[02c08c] cosmetics: Remove all trailing whitespace.
misc	2008-10-09	diego	[02c08c] cosmetics: Remove all trailing whitespace.
msvc	2008-10-09	diego	[02c08c] cosmetics: Remove all trailing whitespace.
src	2009-02-02	nicodvb	[267417] implement and export dvdnav_get_serial_string()...
.relignore	2004-04-09	mroi	[a7b3f5] testing some improvements to relchk script
AUTHORS	2004-09-12	mroi	[4ec9b7] patch from Franti¨ek to avoid symbol name clashes
COPYING	2002-03-12	richwareham	[52d456] Initial revision
ChangeLog	2008-10-09	diego	[02c08c] cosmetics: Remove all trailing whitespace.
DEVELOPMENT-POLICY.txt	2007-04-11	nicodvb	[d89641] this->these (I must be really asleep)
INSTALL	2008-06-07	nicodvb	[fc7748] mention to run autoreconf instead of ./autogen.sh
Makefile	2008-12-30	reimar	[576533] Move dvd_types.h, dvdnav_events.h and dvdnav.h ...
Makefile.am	2008-06-18	dan	[5dc71e] Drop depcomp hack now that automake-1.6 is requ...
NEWS	2003-03-31	mroi	[62d1b4] I should not have deleted this, automake demand...
README	2008-04-10	rathann	[575419] Update to reflect current upstream location.
TODO	2007-04-22	nicodvb	[47b48c] mention the new build-system
autogen.sh	2008-09-14	diego	[cad131] Remove useless $Id$ and $Name$ keywords.
configure.ac	2008-10-09	diego	[6c47b8] OS/2 support by KO Myung-Hun, komh chollian net
configure2	2008-10-09	diego	[02c08c] cosmetics: Remove all trailing whitespace.
version.sh	2008-05-01	nicodvb	[ba06be] when building a non-checkout call version.sh wi...

Read Me

What is this all about?
-----------------------

libdvdnav is a library that allows easy use of sophisticated DVD navigation
features such as DVD menus, multiangle playback and even interactive DVD games.
All this functionality is provided through a simple API which provides the
DVD playback as a single logical stream of blocks, intermitted by special
dvdnav events to report certain conditions. The main usage of libdvdnav is a
loop regularly calling a function to get the next block, surrounded by
additional calls to tell the library of user interaction.
The whole DVD virtual machine and internal playback states are completely
encapsulated.

Where does it come from?
------------------------

This library is based on a lot of code and expertise from the Ogle project.
Ogle was the first DVD player who implemented free DVD navigation. The
libdvdnav developers wish to express their gratitude to the Ogle people
for all the valuable research work they have done.

Initially, the dvdnav code was part of a plugin to the xine media player
called xine-dvdnav. Later on, the DVD VM specific code was split
from xine-dvdnav and went into the first version of libdvdnav.

Where is it now?
----------------

libdvdnav is hosted on http://www.mplayerhq.hu/MPlayer/releases/dvdnav/ .
Please report bugs to the developers mailinglist at
mailto:dvdnav-discuss@mplayerhq.hu .

We are still in beta stage, but libdvdnav is already quite usable. With
regular DVD playback, there should not be any serious issues. The library
also makes some limited effort to handle error situations gracefully, but
there are still assertions in the code that may trigger on some DVDs. Please
send a report to the developer mailinglist, if you encounter such problems.

How can I use it?
-----------------

libdvdnav is completely licensed under GPL. You may use it at wish within the
bounds of this license. See the file "COPYING" for a copy of the GPL.

Sources for documentation on libdvdnav are:
* the examples directory contains a simple program using libdvdnav
  this one is well-commented and therefore a good starting point
* the public header dvdnav.h documents the API
* the public header dvdnav_events.h documents the dvdnav events
* doc/library_layout contains some info on the internal working of libdvdnav

Sources for documentation on DVD terminology, structure and surrounding concepts:
* doc/dvd_structures briefly explains DVD terms and organization
* a more detailed description of DVD structures is available at
  http://www.mpucoder.com/dvd/
* the ifo_types.h and nav_types.h headers are also interesting if you
  are already used to the sometimes cryptical abbreviations