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