Tree [4ec9b7] /
History



File Date Author Commit
debian 2003-05-30 pmhahn pmhahn [209b28] +automake
doc 2004-07-03 mroi mroi [4348b4] differentiate between sectors and blocks
examples 2004-01-31 jcdutton jcdutton [42a460] Patch to compile with mingw32 from: -
m4 2004-03-05 mroi mroi [bb7f9e] use AC_HELP_STRING properly
misc 2004-04-09 mroi mroi [a7b3f5] testing some improvements to relchk script
msvc 2004-08-01 mroi mroi [61e24b] almost forgotten patch for MSVC compilation by ...
src 2004-09-12 mroi mroi [4ec9b7] patch from Franti¨ek to avoid symbol name clashes
.cvsignore 2004-01-11 mroi mroi [5f87d2] big build system changes
.relignore 2004-04-09 mroi mroi [a7b3f5] testing some improvements to relchk script
AUTHORS 2004-09-12 mroi mroi [4ec9b7] patch from Franti¨ek to avoid symbol name clashes
COPYING 2002-03-12 richwareham richwareham [52d456] Initial revision
ChangeLog 2004-09-12 mroi mroi [d40901] document fix
INSTALL 2004-02-17 mroi mroi [3752c0] update INSTALL text to autoconf 2.57
Makefile.am 2004-02-13 mroi mroi [e411fb] include two missing files
NEWS 2003-03-31 mroi mroi [62d1b4] I should not have deleted this, automake demand...
README 2003-06-06 mroi mroi [a9aee9] explain what the various files are for
TODO 2003-11-10 jcdutton jcdutton [087837] Don't forget this one.
autogen.sh 2004-06-25 mroi mroi [05576b] ported autogen fixes from xine-lib by André Pang
configure.ac 2004-06-10 jcdutton jcdutton [dac90a] Get ready for new version.

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://dvd.sourceforge.net/. Please report bugs to the
developers mailinglist at mailto:dvd-devel@lists.sourceforge.net

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