home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 April / PCWorld_2003-04_cd.bin / Software / Vyzkuste / dubmod / readme_AviSynthesizer.txt < prev    next >
Text File  |  2001-08-25  |  6KB  |  138 lines
  1. AVISynthesizer - A tool to make Avisynth usable by mere mortals :)
  2. ~~~~~~~~~~~~~~
  3.  
  4. Intro
  5. ~~~~~
  6.     Avisynth is a powerful video processing tool by Ben Rudiak-Gould.
  7.     AVISynthesizer lets you build Avisynth scripts based on predefined
  8.     templates.  If you aren't the sort that is willing or able to learn
  9.     a computer scripting language, AVISynthesizer makes Avisynth's power
  10.     accessible to you.
  11.  
  12.     If you already know the Avisynth scripting language, AVISynthesizer
  13.     helps you with repetitive scripting chores.  If you have a suitable
  14.     template defined, AVISynthesizer can build complete scripts
  15.     for you.  At the very least, you can use the simple AVISource or
  16.     DirectShowSource templates to generate the repetitive parts that
  17.     begin nearly all one-off scripts.
  18.  
  19.  
  20. Installation
  21. ~~~~~~~~~~~~
  22.     If you downloaded and ran the AVISynthesizer self-installing package,
  23.     it set AVISynthesizer up for you.
  24.  
  25.     If you have built AVISynthesizer from source and now want to install
  26.     it manually, run asynther.exe with the -i command line switch.  If you
  27.     are not using Windows 2000 or Windows XP, you will also need to run
  28.     the shfolder.exe program that came with the package.  This installs
  29.     a compatibility DLL that lets my program use a certain Windows 2000
  30.     function on older OSes.
  31.     
  32.     If for some unfortunate reason you want to manually uninstall the
  33.     package, run asynther.exe with the -u switch.  You can also use
  34.     Windows' Add/Remove Programs function to automatically remove the
  35.     program, of course.
  36.  
  37.  
  38. Usage
  39. ~~~~~
  40.     Right-click on a media file in Explorer, and say "Send to |
  41.     AVISynthesizer".  A small window will pop up listing the available
  42.     Avisynth script templates by description.  Pick one, and hit the
  43.     Generate Script button.  AVISynthesizer will spit out a script named
  44.     after the first file name on the command line and the file name of
  45.     the template you selected.  If there is already a file by that name,
  46.     a number will be appended.  
  47.     
  48.     For example, if you pass foo.avi to AVISynthesizer and select the
  49.     svcd.avst template ("Resize and remove noise for SVCD"), the generated
  50.     script will be named foo--svcd.avs.  If you did the same thing again,
  51.     the next generated script would be named foo--svcd2.avs.
  52.  
  53.     If you send more than one file to AVISynthesizer, another list
  54.     appears to the right of the template list containing the file
  55.     names you selected.  The arrow buttons to the right of that list
  56.     let you reorder the file list, thus affecting the order they're
  57.     named in the generated Avisynth script.  This feature is necessary
  58.     because, in certain situations, Explorer passes the selected files to
  59.     AVISynthesizer in an odd order.  Rather than force users to Ctrl-Click
  60.     each file individually to set the order, I added this feature.
  61.  
  62.  
  63. Template Syntax
  64. ~~~~~~~~~~~~~~~
  65.     AVISynthesizer comes with several sample templates, all of which are
  66.     useful, to various degrees.  If you want to make your own templates,
  67.     you need to know Avisynth's scripting language and the AVISynthesizer
  68.     template rules:
  69.  
  70.         0. The script must contain a specially-formatted comment.  See
  71.            the exmple below for details.
  72.  
  73.         1. The first instance of the string "%f" (without the quotes) is
  74.            replaced with the file name given on the asynther.exe command
  75.            line.
  76.  
  77.         2. If you put a section of the script in [square brackets],
  78.            that section will be repeated once for each file name
  79.            passed on the command line.  Within that repeating section,
  80.            the %f is replaced with a file name from the command
  81.            line, and a plus sign is placed between each repeated
  82.            script section.
  83.  
  84.         3. The template must be placed in a subdirectory called
  85.            template underneath the directory where you put
  86.            asynther.exe.  Each template file must end in .avst.
  87.  
  88.     The effect of these rules is clearer with an example.  Consider
  89.     this simple AVISynthesizer template:
  90.  
  91.         #ASYNTHER Just a simple template
  92.         [AVISource("%f")]
  93.  
  94.     If you run asynther.exe with "1" as the command line argument,
  95.     it will generate a file called 1.avs:
  96.  
  97.         #ASYNTHER Just a simple template
  98.         AVISource("1")
  99.  
  100.     If you run asynther.exe with "1 2" as the command line arguments,
  101.     it will generate a file called 1.avs:
  102.  
  103.         #ASYNTHER Just a simple template
  104.         AVISource("1") + AVISource("2")
  105.  
  106.     Notice that AVISynthesizer names the output script after the
  107.     first input file name.
  108.         
  109.     The "Just a simple template" on the ASYNTHER comment line is used by
  110.     AVISynthesizer to build the list box you see on startup, letting you
  111.     pick a template by description.
  112.  
  113.  
  114. Limitations
  115. ~~~~~~~~~~~
  116.     o  If you set up a repeating section in a script template, there
  117.        must be a "%f" somewhere within that repeating section.
  118.        AVISynthesizer will yell at you if you violate this rule.  If you
  119.        have a good reason to violate this rule, email me about it.  If
  120.        you come up with useful behavior for this situation, I'll probably
  121.        implement it.
  122.  
  123.     o  The program only understands one repeating section per line, and
  124.        it does not understand nested repeating sections.  If there
  125.        is more than one set of brackets on a line, it will use the
  126.        outside-most pair.
  127.  
  128.     o  The closing bracket for a repeating section must be on the same
  129.        line as the opening bracket.
  130.  
  131.  
  132. Addresses
  133. ~~~~~~~~~
  134.     Author's email:      Warren Young <wdyoung@acm.org>
  135.     AVISynthesizer home: http://www.cyberport.com/~tangent/video/asynther.html
  136.     Avisynth home:       http://www.math.berkeley.edu/~benrg/avisynth.html
  137.  
  138.