]> git.sesse.net Git - mlt/blobdiff - demo/README
Add support for more image formats to vid.stab
[mlt] / demo / README
index 62a4be07bbd9efed456152d19a9db207e2d45cc3..5e2fe08a5bc94ebb7f29dddc11da66212e549696 100644 (file)
@@ -2,8 +2,8 @@ MLT Demo Notes
 
 Before running the demo script, make sure you '. setenv' from the parent
 directory. Also, please create clips clip1.dv, clip2.dv, clip3.dv, clip1.mpeg,
-clip2.mpeg, clip3.mpeg, and music1.ogg. It is okay if some of these are
-duplicates. Please make sure clips are at least 500 frames duration.
+clip2.mpeg, clip3.mpeg, and music1.ogg. Please make sure clips are at least 500 
+frames duration.
 
 These notes explain the the concepts presented in each demonstration and
 what details to look for.
@@ -11,14 +11,17 @@ what details to look for.
 First, a note on consumers. When you start the script, the main menu asks
 you to choose a consumer. A consumer is like a viewer, but it could also
 write to a stream/file. The "SDL" consumer is the popular Simple DirectMedia
-Layer audio and video output. The "Westley" consumer generates an XML
+Layer audio and video output. The "xml" consumer generates an XML
 representation of the service network. That can be played directly due to the
-westley producer plugin. See docs/westley.txt for more information. The
-"MainConcept DV" consumer refers to the proprietary MLT plugin required to
-use MLT with MainConcept DV, DVCPro, and MPEG codecs. "/dev/dv1394" refers
-to a device file for transmitting DV over FireWire using the Linux dv1394 kernel
-module. The "BlueFish444" consumer is another proprietary plugin to use
-the BlueFish444 manufactured SDI video/audio output cards with MLT.
+XML producer plugin. See docs/mlt-xml.txt for more information. "/dev/dv1394/0"
+refers to a device file for transmitting DV over FireWire using the Linux
+dv1394 kernel module.
+
+These examples assume the numeric locale LC_NUMERIC decimal separator is a
+period. Therefore, the demo script sets LC_NUMERIC=C for you, but if you are
+running these manually or learning from them, remember to use the appropriate
+separator for your locale.
+
 
 And now the demos...
 
@@ -73,6 +76,8 @@ Clock in and out
        This image can be a 16 bit PGM (grayscale bitmap) or the luma channel of
        any video producer. A number of high quality wipes can be downloaded from
        http://mlt.sf.net/. It also performs field rendering.
+       The second wipe demonstrates the ability to control the direction of the
+       wipe as well.
        
 Obscure
 
@@ -88,7 +93,7 @@ Audio Stuff
 
        A music bed sound track can be mixed with a video. The sound track of the
        video clip has a "floating" amplitude normalisation filter applied.
-       Typically, audio nornmalisation applies a constant gain factor across the
+       Typically, audio normalisation applies a constant gain factor across the
        entire duration of an audio segment from a single source where the 
        gain factor is automatically determined by anaylsing the maximum "power"
        or peak levels. However, in news production, a popular requirement is to
@@ -154,7 +159,7 @@ Title over graphic
 Slideshow
 
        This demo requires any number of JPEG images with the extension ".jpg"
-       in a subdirectory named "Scotland."
+       in a subdirectory named "photos."
 
 Bouncy, Bouncy
 
@@ -166,6 +171,15 @@ Bouncy, Bouncy Ball
 
        A variation on the above Bouncy, Bouncy demo that applies a shape, or
        alpha producer, to the the compositing region.
+       
+Breaking News
+
+       This demonstrates layout capabilities of the compositor.
+
+Squeeze Transitions
+
+       This demonstrates a distorting barndoor-like wipe.
+
 
 J Cut
 
@@ -204,3 +218,14 @@ Ticker tape
        the compositor when viewed on an analog monitor using a DV or BlueFish444
        consumer. The demo also shows the potientional for using and extending the
        existing set of services for a full blown news ticker implementation.
+
+Pango Keyframed Markup
+
+       You can create timed text and subtitles using a .mpl file, which is a
+       properties format file. A properties file contains key=value pairs on
+       separate lines. For .mpl the key is a frame number and the value is
+       Pango Markup Language. A tilde is interpreted as a new line. This
+       example also demonstrates using the watermark and the alignment
+       properties of its encapsulated composite transition where halign
+       is the horizontal, valign is the vertical, c is for center, and m
+       is for middle.