Changed video standard nomenclature to be completely pedantic.

[videolink.git] / README

diff --git a/README b/README
index 8c840b238673ae146c7d10be64d2b7b1da915f33..e209fff39fb72ca49e0330a233c33f8a2caf236f 100644 (file)
--- a/README
+++ b/README
@@ -15,7 +15,7 @@ WebDVD depends on the following software:
 - dvdauthor
 - expat 1.x
 - Gtkmm 2.0
 - dvdauthor
 - expat 1.x
 - Gtkmm 2.0

-- mjpegtools
+- ffmpeg or mjpegtools

 - Mozilla 1.7.x (later versions may work but are untested)
 - netpbm
 - Xvfb (from XFree86 or X.org)
 - Mozilla 1.7.x (later versions may work but are untested)
 - netpbm
 - Xvfb (from XFree86 or X.org)


@@ -24,8 +24,8 @@ To build a complete DVD image you will also need:
 
 - mkisofs
 
 
 - mkisofs
 

-You will also need a program such as ffmpeg or mencoder for producing
-DVD-suitable MPEG-1 or MPEG-2 video files.
+You will also need a program for producing DVD-suitable MPEG-1 or
+MPEG-2 video files.

 
 Usage
 -----
 
 Usage
 -----


@@ -66,9 +66,28 @@ This will result in a title with the following chapters:
 
 Video standards
 
 
 Video standards
 

-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"
-to the following commands.
+The encoding of analogue TV and video signals varies in many different
+ways between countries.  Happily there are only two parameters that
+matter for standard-definition digital video, and two different pairs
+of values.  You can choose between these with the --video-std option:
+
+Analogue parameters   | Region of world              | --video-std | Frame
+                      |                              | argument    | size
+----------------------+------------------------------+-------------+--------
+59.94 fields/second,  | Americas except Argentina,   | 525         | 720x576
+interlaced;           | Paraguay, Uruguay;           | or 525/60   |
+525 lines/frame       | Japan; Laos; Myanmar;        | or NTSC     |
+(commonly called      | Philippines; South Korea;    | or ntsc     |
+ NTSC)                | Taiwan; some Pacific islands |             |
+----------------------+------------------------------+-------------+--------
+50 fields/second,     | Rest of world                | 625         | 720x480
+interlaced;           |                              | or 625/50   |
+625 lines/frame       |                              | or PAL      |
+(commonly called PAL) |                              | or pal      |
+
+The default is to use "PAL" parameters.
+
+Currently 

 
 Preview
 
 
 Preview
 


@@ -84,9 +103,12 @@ the directory in which to create the filesystem (which should be
 either nonexistent or empty).  WebDVD will automatically follow links
 to the other pages and to the video files.
 
 either nonexistent or empty).  WebDVD will automatically follow links
 to the other pages and to the video files.
 

-If you use mjpegtools 1.6.2 or earlier you must add the option
-"--encoder mjpegtools-old".  This is due to an incompatible change in
-the syntax of the ppmtoy4m command between versions 1.6.2 and 1.8.
+By default, WebDVD now calls ffmpeg to generate MPEG-2 streams for
+menus.  If you want it to use mjpegtools as it previously did, you
+must add the option "--encoder mjpegtools".  If you use mjpegtools
+1.6.2 or earlier you must instead use "--encoder mjpegtools-old".
+This is due to an incompatible change in the syntax of the ppmtoy4m
+command between versions 1.6.2 and 1.8.

 
 If this is successful you can then use mkisofs to create a DVD image
 from the output directory.  Alternately you can write this directory
 
 If this is successful you can then use mkisofs to create a DVD image
 from the output directory.  Alternately you can write this directory


@@ -97,7 +119,7 @@ Example
 -------
 
 A live example set of menus can currently be found at
 -------
 
 A live example set of menus can currently be found at

-<http://womble.decadentplace.org.uk/software/debconf5-dvd/menus/main.html>.
+<http://womble.decadent.org.uk/software/debconf5-dvd/menus/main.html>.

 Note that this has large background images that will take some time to
 load.
 
 Note that this has large background images that will take some time to
 load.
 


@@ -106,13 +128,13 @@ Limitations
 
 Each page must fit within the frame - DVD players do not support
 scrolling menus and WebDVD currently is not able to split them into
 
 Each page must fit within the frame - DVD players do not support
 scrolling menus and WebDVD currently is not able to split them into

-multiple menus.  The standard frame size for PAL and SECAM is 720x576
-pixels; for NTSC it is 720x480 pixels.  The exact visible area varies
-between TVs so the background should cover all or very nearly all the
-frame whereas the important content such as text must not be placed
-near the edge.  For this reason WebDVD applies a stylesheet to all
-pages that adds 60 pixels of padding on all sides of the body; this
-doesn't apply to the background.
+multiple menus.  The frame size is dictated by the video standard; see
+above.  The exact visible area varies between TVs so the background
+should cover all or very nearly all the frame whereas the important
+content such as text must not be placed near the edge.  For this
+reason WebDVD applies a stylesheet to all pages that adds 60 pixels of
+padding on all sides of the body; this doesn't apply to the
+background.

 
 Prior to Mozilla version 1.8, which I have not yet tested, Mozilla may
 signal that a page is completely loaded before any background images
 
 Prior to Mozilla version 1.8, which I have not yet tested, Mozilla may
 signal that a page is completely loaded before any background images


@@ -154,7 +176,7 @@ provide a better solution in a later version of WebDVD.
 Author and copyright
 --------------------
 
 Author and copyright
 --------------------
 

-WebDVD was written by Ben Hutchings <ben@decadentplace.org.uk>.
+WebDVD was written by Ben Hutchings <ben@decadent.org.uk>.

 Copyright 2005-2006 Ben Hutchings.
 
 This software is based in part on the work of the Independent JPEG Group.
 Copyright 2005-2006 Ben Hutchings.
 
 This software is based in part on the work of the Independent JPEG Group.