README

   1 VideoLink
   2 =========
   3
   4 VideoLink 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 Prior to version 0.8, VideoLink was called WebDVD, but that name is
  11 also used for an extended DVD format.
  12
  13 Requirements
  14 ------------
  15
  16 VideoLink depends on the following software:
  17
  18 - dvdauthor
  19 - expat 1.x
  20 - Gtkmm 2.4 or later
  21 - either of:
  22   - ffmpeg including mpeg2video encoding
  23     ("ffmpeg -formats" should show "DEVSDT mpeg2video" in the codecs section)
  24   - both of:
  25     - mjpegtools 1.8 or later
  26     - netpbm
  27 - Mozilla 1.8 or later, or XULRunner
  28 - Xvfb (from XFree86 or X.org)
  29
  30 To build a complete DVD image you will also need:
  31
  32 - mkisofs
  33
  34 You will also need a program for producing DVD-suitable MPEG-1 or
  35 MPEG-2 video files.
  36
  37 Usage
  38 -----
  39
  40 Design your DVD menus as a series of HTML pages linking to each other
  41 and to MPEG-1/2 videos that are suitable for use on a DVD.  You must
  42 be careful not to link to pages that you do not want to appear on the
  43 disc, such as normal web sites.  Also note the limitations listed
  44 below.
  45
  46 Linking to video
  47
  48 You can link directly to local MPEG video files whose names end in
  49 ".mpeg", ".mpeg2", ".mpg" or ".vob".  If you wish to combine multiple
  50 files into a single video sequence ("title" in DVD terminology) or to
  51 add chapter marks to a video sequence, create and link to a VOB-list
  52 file (explained below) whose name ends in ".voblist".
  53
  54 VOB-lists
  55
  56 A VOB-list file is an XML file with the document element <vob-list>
  57 and containing <vob> elements as described in the dvdauthor manual
  58 page.  The file names in a VOB-list file are resolved relative to the
  59 directory containing the list file.  For example:
  60
  61     <vob-list>
  62         <vob file="main.vob" chapters="0:00,4:55,12:13,17:45"/>
  63         <vob file="credits.vob"/>
  64     </vob-list>
  65
  66 This will result in a title with the following chapters:
  67
  68     1: main.vob  0:00- 4:55
  69     2: main.vob  4:55-12:13
  70     3: main.vob 12:13-17:45
  71     4: main.vob 17:45-  end
  72     5: credits.vob
  73
  74 You can link to the start of a chapter by adding "#" and the chapter
  75 number after the VOB-list's file name.  For example:
  76
  77     <a href="movie.voblist#1">Chapter 1</a><br>
  78     <a href="movie.voblist#2">Chapter 2</a><br>
  79     <a href="movie.voblist#3">Chapter 3</a><br>
  80     <a href="movie.voblist#4">Chapter 4</a>
  81
  82 Video standards
  83
  84 The encoding of analogue TV and video signals varies in many different
  85 ways between countries.  Happily there are only two parameters that
  86 matter for standard-definition digital video, and two different pairs
  87 of values.  You can choose between these with the --video-std option:
  88
  89 Analogue parameters   | Region of world              | --video-std | Frame
  90                       |                              | argument    | size
  91 ----------------------+------------------------------+-------------+--------
  92 59.94 fields/second,  | Americas except Argentina,   | 525         | 720x576
  93 interlaced;           | Paraguay, Uruguay;           | or 525/60   |
  94 525 lines/frame       | Japan; Laos; Myanmar;        | or NTSC     |
  95 (commonly called      | Philippines; South Korea;    | or ntsc     |
  96  NTSC)                | Taiwan; some Pacific islands |             |
  97 ----------------------+------------------------------+-------------+--------
  98 50 fields/second,     | Rest of world                | 625         | 720x480
  99 interlaced;           |                              | or 625/50   |
 100 625 lines/frame       |                              | or PAL      |
 101 (commonly called PAL) |                              | or pal      |
 102
 103 The default is to use "PAL" parameters.
 104
 105 Preview
 106
 107 To get a rough preview of the menus, run "videolink --preview menu-url"
 108 where menu-url is the URL or filename of the first page to show.
 109 Currently videos cannot be displayed in this preview mode.
 110
 111 Press T to go to the "top" (main) menu or Q to quit.
 112
 113 Processing
 114
 115 To create a DVD filesystem, run "videolink menu-url output-dir" where
 116 menu-url is the URL or filename of the top menu page and output-dir is
 117 the directory in which to create the filesystem (which should be
 118 either nonexistent or empty).  VideoLink will automatically follow links
 119 to the other pages and to the video files.
 120
 121 By default, VideoLink now calls ffmpeg to generate MPEG-2 streams for
 122 menus.  If you want it to use mjpegtools as it previously did, you
 123 must add the option "--encoder mjpegtools".
 124
 125 If this is successful you can then use mkisofs to create a DVD image
 126 from the output directory.  Alternately you can write this directory
 127 directly to a writable DVD with growisofs or with mkisofs piped to a
 128 suitable version of cdrecord.
 129
 130 Example
 131 -------
 132
 133 A live example set of menus can currently be found at
 134 <http://womble.decadent.org.uk/software/debconf5-dvd/menus/main.html>.
 135 Note that this has large background images that will take some time to
 136 load.
 137
 138 Limitations
 139 -----------
 140
 141 Each page must fit within the frame - DVD players do not support
 142 scrolling menus and VideoLink currently is not able to split them into
 143 multiple menus.  The frame size is dictated by the video standard; see
 144 above.  The exact visible area varies between TVs so the background
 145 should cover all or very nearly all the frame whereas the important
 146 content such as text must not be placed near the edge.  For this
 147 reason VideoLink applies a stylesheet to all pages that adds padding
 148 equal to 10% of the frame dimension on each side of the body; this
 149 doesn't apply to the background.
 150
 151 DVD players do not have "back" buttons, so you should generally
 152 provide links to "higher" menu pages.  However, they do have a button
 153 for returning to the top menu.
 154
 155 VideoLink sends a "mouseover" event for each link and sets it into its
 156 "hover" state, then records how this changes its appearance.  This
 157 change is then shown when the corresponding button on the DVD menu is
 158 highlighted.  VideoLink applies a stylesheet which changes the colour of
 159 text links in the "hover" state, but this has no effect on image
 160 links.  You must ensure that image links are highlighted in an obvious
 161 way when the mouse pointer is over them.
 162
 163 The DVD specifications limit each menu to having no more than 36
 164 buttons.  In any case, it is poor design to have very large numbers of
 165 buttons on a single menu.  VideoLink will warn you if you use more than
 166 this number of a links on a page, and will ignore any additional ones.
 167
 168 The DVD specification also limits the overlays that are used for
 169 highlighting of buttons to using no more than 4 colours.  VideoLink will
 170 reduce link highlighting to 1 transparent and 3 opaque colours using
 171 Floyd-Steinberg dithering, which is certainly good enough for
 172 anti-aliased text but may not be so good for complex highlighting.
 173
 174 There is a limit of 99 "titles" on a DVD.  If you need to include more
 175 than this number of video sequences, you could arrange them as
 176 chapters of a title, so long as they use the same codecs, resolution,
 177 aspect ratio and sample rate.  However, each chapter will run into the
 178 next.  If this is a real problem, let me know, and I may be able to
 179 provide a better solution in a later version of VideoLink.
 180
 181 Currently VideoLink code can generate up to 999 menus but it may be
 182 possible for me to raise this internal limit if you want more.  There
 183 appears to be an absolute limit of 12800 menus on a DVD.
 184
 185 Bugs
 186 ----
 187
 188 VideoLink should set the assumed screen resolution to 40 dpi, which I
 189 reckon to be the average resolution of a standard definition TV
 190 display.  This would mean that text with a font size expressed in
 191 millimetres or points will appear around the specified size.
 192 Earlier versions of VideoLink did this when built to use Mozilla 1.7.
 193 Unfortunately the resolution setting in Mozilla 1.8 actually affects
 194 measurements in pixels and not measurements in millimetres or points!
 195 The assumed screen resolution is always 96 dpi.
 196
 197 Please specify measurements such as font sizes in pixels because
 198 measurements in millimetres or points are liable to change if and when
 199 I can override the assumed screen resolution again.
 200
 201 Author and copyright
 202 --------------------
 203
 204 VideoLink was written by Ben Hutchings <ben@decadent.org.uk>.
 205 Copyright 2005-2006 Ben Hutchings.
 206
 207 This software is based in part on the work of the Independent JPEG Group.
 208 Copyright 1991-1998 Thomas G. Lane.  (This applies to the file jquant2.c.)