]> git.decadent.org.uk Git - videolink.git/blobdiff - README
Changed WebDvdWindow to generate temporary files in the proper way, spawn external...
[videolink.git] / README
diff --git a/README b/README
index ec6534a8190cac81e355e5561b980675e26ab820..9e3b82b15c4d60d5c3dae9fd469659ae25ed4f5a 100644 (file)
--- a/README
+++ b/README
@@ -5,26 +5,23 @@ WebDVD is intended to provide a simple way of producing DVDs with
 attractive and usable menus.  It converts HTML pages into DVD menus by
 rendering them in Mozilla and reproducing their link structure.  This
 allows you to design DVDs using familiar HTML editing tools or your
-favourite text editor.  This very early version produces a set of
-files suitable for passing to the "dvdauthor" and "spumux" programs,
-but in future it is intended to run the necessary external programs
-automatically.
+favourite text editor.
 
 Requirements
 ------------
 
 WebDVD depends on the following software:
 
+- dvdauthor
 - Gtkmm 2.0
+- mjpegtools
 - Mozilla 1.7.x (later versions may work but are untested)
+- netpbm
 - Xvfb (from XFree86 or X.org)
 
 To build a complete DVD image you will also need:
 
-- dvdauthor
-- mjpegtools
 - mkisofs
-- netpbm
 
 You will also need a program such as ffmpeg or mencoder for producing
 DVD-suitable MPEG-1 or MPEG-2 video files.
@@ -32,47 +29,23 @@ DVD-suitable MPEG-1 or MPEG-2 video files.
 Usage
 -----
 
-Run "webdvd URL" where URL is the URL for the page that is to be the
-top menu of the DVD.  It will automatically follow links to other
-pages and to video files, rendering each page.  You must be careful
-not to link to pages that you do not want to appear on the disc, such
-as normal web sites.
-
-By default, webdvd uses a frame size of 720x576, which is suitable for
-PAL DVDs.  If you wish to produce NTSC DVDs you must override this
-by adding the option "-geometry 720x480".
-
-This will create the following files (with NNNNNN replaced with each
-successive page number):
-
-- webdvd.dvdauthor: This is an XML file to be passed to dvdauthor.
-- page_NNNNNN.spumux: These are XML files to be passed to spumux.
-- page_NNNNNN_back.png: This is a static image of the page, which
-  becomes the menu background.
-- page_NNNNNN_links.png: This is an image of the change in appearance
-  of each link when the pointer is over it.
-
-Currently, you must run commands along the following lines to produce
-a complete DVD image:
-
-for spumux in page_??????.spumux; do
-    page=$(basename $spumux .spumux)
-    pngtopnm ${page}_back.png                              \
-    | ppmtoy4m -v0 -n 1 -F 25:1 -A 59:54 -I p -S 420_mpeg2 \
-    | mpeg2enc -v0 -f 8 -a 2 -o /dev/stdout                \
-    | mplex -v0 -f 8 -o /dev/stdout /dev/stdin             \
-    | spumux -v0 -m dvd $spumux > ${page}.vob
-done
-rm -rf dvd-temp
-dvdauthor -o dvd-temp -x webdvd.dvdauthor
-mkisofs -dvd-video dvd-temp >dvd.iso
-rm -rf dvd-temp
-
-Adjust the name of the temporary directory (here "dvd-temp") and the
-output file ("dvd.iso") as you please.
-
-If you are using NTSC video, you will need to change the ppmtoy4m
-parameters.  Use "-F 30000:1001 -A 10:11" instead of "-F 25:1 -A 59:54".
+Run "webdvd URL DIR" where URL is the URL for the page that is to be
+the top menu of the DVD and DIR is the directory in which to create
+the DVD filesystem (which should be missing or empty).  It will
+automatically follow links to other pages and to video files,
+rendering each page.  You must be careful not to link to pages that
+you do not want to appear on the disc, such as normal web sites.
+
+By default, webdvd generates PAL/SECAM video.  If you wish to produce
+NTSC DVDs you can override this by adding the option "--video-std ntsc".
+
+If webdvd runs successfully you can use mkisofs to create a DVD image:
+
+    mkisofs -dvd-video DIR > IMAGE
+    rm -rf DIR
+
+Alternately you can write the filesystem directly to a writable DVD
+with growisofs or mkisofs plus a suitable version of cdrecord.
 
 Limitations
 -----------