]> git.decadent.org.uk Git - videolink.git/blob - README
Changed WebDvdWindow to generate temporary files in the proper way, spawn external...
[videolink.git] / 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 Run "webdvd URL DIR" where URL is the URL for the page that is to be
33 the top menu of the DVD and DIR is the directory in which to create
34 the DVD filesystem (which should be missing or empty).  It will
35 automatically follow links to other pages and to video files,
36 rendering each page.  You must be careful not to link to pages that
37 you do not want to appear on the disc, such as normal web sites.
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
42 If webdvd runs successfully you can use mkisofs to create a DVD image:
43
44     mkisofs -dvd-video DIR > IMAGE
45     rm -rf DIR
46
47 Alternately you can write the filesystem directly to a writable DVD
48 with growisofs or mkisofs plus a suitable version of cdrecord.
49
50 Limitations
51 -----------
52
53 Each page must fit within the frame - DVD players do not support
54 scrolling menus and WebDVD currently is not able to split them into
55 multiple menus.  Note also that the video frame is somewhat larger
56 than the visible area of a normal TV.  For this reason WebDVD applies
57 a stylesheet to all pages that adds 50-60 pixels of padding on all
58 sides of the body.
59
60 WebDVD sends a "mouseover" event for each link and sets it into its
61 "hover" state, then records how this changes its appearance.  This
62 change is then shown when the corresponding button on the DVD menu is
63 highlighted.  WebDVD applies a stylesheet which changes the colour of
64 text links in the "hover" state, but this has no effect on image
65 links.  You must ensure that image links are highlighted in an obvious
66 way when the mouse pointer is over them.
67
68 The DVD specifications limit each menu to having no more than 36
69 buttons.  In any case, it is poor design to have very large numbers of
70 buttons on a single menu.  WebDVD will warn you if you use more than
71 this number of a links on a page, and will ignore any additional ones.
72
73 The DVD specification also limits the overlays that are used for
74 highlighting of buttons to using no more than 4 colours.  WebDVD will
75 reduce link highlighting to 1 transparent and 3 opaque colours using
76 Floyd-Steinberg dithering, which is certainly good enough for
77 anti-alised text but may not be so good for complex highlighting.
78
79 Author and copyright
80 --------------------
81
82 WebDVD was written by Ben Hutchings <ben@decadentplace.org.uk>.
83 Copyright 2005 Ben Hutchings.
84
85 This software is based in part on the work of the Independent JPEG Group.
86 Copyright 1991-1998 Thomas G. Lane.  (This applies to the file jquant2.c.)