README

   1 WebDVD
   2 ======
   3
   4 WebDVD is intended to provide a simple way of producing DVDs with
   5 attractive and usable menus.  It converts HTML pages into DVD menus by
   6 rendering them in Mozilla and reproducing their link structure.  This
   7 allows you to design DVDs using familiar HTML editing tools or your
   8 favourite text editor.
   9
  10 Requirements
  11 ------------
  12
  13 WebDVD depends on the following software:
  14
  15 - dvdauthor
  16 - Gtkmm 2.0
  17 - mjpegtools
  18 - Mozilla 1.7.x (later versions may work but are untested)
  19 - netpbm
  20 - Xvfb (from XFree86 or X.org)
  21
  22 To build a complete DVD image you will also need:
  23
  24 - mkisofs
  25
  26 You will also need a program such as ffmpeg or mencoder for producing
  27 DVD-suitable MPEG-1 or MPEG-2 video files.
  28
  29 Usage
  30 -----
  31
  32 Design your DVD menus as a series of HTML pages linking to each other
  33 and to MPEG-1/2 videos that are suitable for use on a DVD.  Currently
  34 the videos must be local files with filenames ending in ".vob", but no
  35 such restrictions apply to the HTML pages.  You must be careful not to
  36 link to pages that you do not want to appear on the disc, such as
  37 normal web sites.  Also note the limitations listed below.
  38
  39 By default, webdvd generates PAL/SECAM video.  If you wish to produce
  40 NTSC DVDs you can override this by adding the option "--video-std ntsc"
  41 to the following commands.
  42
  43 To get a rough preview of the menus, run "webdvd --preview menu-url"
  44 where menu-url is the URL or filename of the first page to show.
  45 Currently videos cannot be displayed in this preview mode.
  46
  47 To create a DVD filesystem, run "webdvd menu-url output-dir" where
  48 menu-url is the URL or filename of the top menu page and output-dir is
  49 the directory in which to create the filesystem (which should be
  50 either nonexistent or empty).  WebDVD will automatically follow links
  51 to the other pages and to the video files.
  52
  53 If this is successful you can then use mkisofs to create a DVD image
  54 from the output directory.  Alternately you can write this directory
  55 directly to a writable DVD with growisofs or with mkisofs piped to a
  56 suitable version of cdrecord.
  57
  58 Limitations
  59 -----------
  60
  61 Each page must fit within the frame - DVD players do not support
  62 scrolling menus and WebDVD currently is not able to split them into
  63 multiple menus.  Note also that the video frame is somewhat larger
  64 than the visible area of a normal TV.  For this reason WebDVD applies
  65 a stylesheet to all pages that adds 50-60 pixels of padding on all
  66 sides of the body.
  67
  68 DVD players do not have "back" buttons, so you should generally
  69 provide links to "higher" menu pages.  However, they do have a button
  70 for returning to the top menu.
  71
  72 WebDVD sends a "mouseover" event for each link and sets it into its
  73 "hover" state, then records how this changes its appearance.  This
  74 change is then shown when the corresponding button on the DVD menu is
  75 highlighted.  WebDVD applies a stylesheet which changes the colour of
  76 text links in the "hover" state, but this has no effect on image
  77 links.  You must ensure that image links are highlighted in an obvious
  78 way when the mouse pointer is over them.
  79
  80 The DVD specifications limit each menu to having no more than 36
  81 buttons.  In any case, it is poor design to have very large numbers of
  82 buttons on a single menu.  WebDVD will warn you if you use more than
  83 this number of a links on a page, and will ignore any additional ones.
  84
  85 The DVD specification also limits the overlays that are used for
  86 highlighting of buttons to using no more than 4 colours.  WebDVD will
  87 reduce link highlighting to 1 transparent and 3 opaque colours using
  88 Floyd-Steinberg dithering, which is certainly good enough for
  89 anti-alised text but may not be so good for complex highlighting.
  90
  91 Author and copyright
  92 --------------------
  93
  94 WebDVD was written by Ben Hutchings <ben@decadentplace.org.uk>.
  95 Copyright 2005 Ben Hutchings.
  96
  97 This software is based in part on the work of the Independent JPEG Group.
  98 Copyright 1991-1998 Thomas G. Lane.  (This applies to the file jquant2.c.)