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.  You must
  34 be careful not to link to pages that you do not want to appear on the
  35 disc, such as normal web sites.  Also note the limitations listed
  36 below.
  37
  38 Linking to video
  39
  40 You can link directly to local MPEG video files whose names end in
  41 ".vob".  If you wish to combine multiple files into a single video
  42 sequence ("title" in DVD terminology) or to add chapter marks to a
  43 video sequence, create a text file whose name ends in ".voblist" and
  44 containg <vob> elements as described in the dvdauthor manual page, and
  45 link to that.  Note that these list files are currently included
  46 directly in the control file that WebDVD passes to dvdauthor, which
  47 means that file names in them will be resolved relative to the current
  48 directory rather than the directory containing the list file.  This is
  49 probably a bug.
  50
  51 You can link to a title and begin playback at the beginning of a
  52 specific chapter by adding "#" and then the chapter number to the end
  53 of the URL.
  54
  55 Video standards
  56
  57 By default, webdvd generates PAL/SECAM video.  If you wish to produce
  58 NTSC DVDs you can override this by adding the option "--video-std ntsc"
  59 to the following commands.
  60
  61 Preview
  62
  63 To get a rough preview of the menus, run "webdvd --preview menu-url"
  64 where menu-url is the URL or filename of the first page to show.
  65 Currently videos cannot be displayed in this preview mode.
  66
  67 Processing
  68
  69 To create a DVD filesystem, run "webdvd menu-url output-dir" where
  70 menu-url is the URL or filename of the top menu page and output-dir is
  71 the directory in which to create the filesystem (which should be
  72 either nonexistent or empty).  WebDVD will automatically follow links
  73 to the other pages and to the video files.
  74
  75 If this is successful you can then use mkisofs to create a DVD image
  76 from the output directory.  Alternately you can write this directory
  77 directly to a writable DVD with growisofs or with mkisofs piped to a
  78 suitable version of cdrecord.
  79
  80 Example
  81 -------
  82
  83 A live example set of menus can currently be found at
  84 <http://womble.decadentplace.org.uk/software/debconf5-dvd/menus/main.html>.
  85 Note that this has large background images that will take some time to
  86 load.
  87
  88 Limitations
  89 -----------
  90
  91 Each page must fit within the frame - DVD players do not support
  92 scrolling menus and WebDVD currently is not able to split them into
  93 multiple menus.  Note also that the video frame is somewhat larger
  94 than the visible area of a normal TV.  For this reason WebDVD applies
  95 a stylesheet to all pages that adds 60 pixels of padding on all sides
  96 of the body.
  97
  98 Prior to Mozilla version 1.8, which I have not yet tested, Mozilla may
  99 signal that a page is completely loaded before any background images
 100 are loaded and displayed.  This results in snapshots that do not
 101 include background images.  You can work around this by using
 102 absolutely-positioned "inline" images, or attempt to build WebDVD
 103 against Mozilla 1.8.
 104
 105 DVD players do not have "back" buttons, so you should generally
 106 provide links to "higher" menu pages.  However, they do have a button
 107 for returning to the top menu.
 108
 109 WebDVD sends a "mouseover" event for each link and sets it into its
 110 "hover" state, then records how this changes its appearance.  This
 111 change is then shown when the corresponding button on the DVD menu is
 112 highlighted.  WebDVD applies a stylesheet which changes the colour of
 113 text links in the "hover" state, but this has no effect on image
 114 links.  You must ensure that image links are highlighted in an obvious
 115 way when the mouse pointer is over them.
 116
 117 The DVD specifications limit each menu to having no more than 36
 118 buttons.  In any case, it is poor design to have very large numbers of
 119 buttons on a single menu.  WebDVD will warn you if you use more than
 120 this number of a links on a page, and will ignore any additional ones.
 121
 122 The DVD specification also limits the overlays that are used for
 123 highlighting of buttons to using no more than 4 colours.  WebDVD will
 124 reduce link highlighting to 1 transparent and 3 opaque colours using
 125 Floyd-Steinberg dithering, which is certainly good enough for
 126 anti-aliased text but may not be so good for complex highlighting.
 127
 128 There is a limit of 99 "titlesets" (groups of video sequences) on a
 129 DVD.  Currently WebDVD does not attempt to group video sequences
 130 together, so there is a limit of 99 video sequences altogether.
 131
 132 Author and copyright
 133 --------------------
 134
 135 WebDVD was written by Ben Hutchings <ben@decadentplace.org.uk>.
 136 Copyright 2005 Ben Hutchings.
 137
 138 This software is based in part on the work of the Independent JPEG Group.
 139 Copyright 1991-1998 Thomas G. Lane.  (This applies to the file jquant2.c.)