git.sesse.net Git - mlt/blob - src/modules/core/transition_luma.yml

   1 schema_version: 0.1
   2 type: transition
   3 identifier: luma
   4 title: Wipe
   5 version: 1
   6 copyright: Ushodaya Enterprises Limited
   7 creator: Dan Dennedy
   8 license: LGPLv2.1
   9 language: en
  10 tags:
  11   - Video
  12 description: >
  13    A generic dissolve and wipe transition processor.
  14
  15    "luma" gets its name from how it uses a grayscale "map" file. As the luma
  16    value varies over time, a threshold filter is applied to the map to
  17    determine what parts of frame A vs. frame B to show. It reads PGM files up
  18    to 16 bits! Alternatively, it can use the first frame from any producer that
  19    outputs yuv, but it will be limited to the luma gamut of 220 values. This
  20    performs field-based rendering unless the A frame property "progressive" or
  21    "consumer_progressive" or the transition property "progressive" is set to 1.
  22 bugs: Assumes lower field first output.
  23 parameters:
  24   - identifier: argument
  25     title: Luma map file
  26     type: string
  27     description: >
  28        Either PGM or any other producable video. If not supplied, a dissolve.
  29   - identifier: factory
  30     title: Factory
  31     type: string
  32     description: >
  33        The name of a factory service used as a non-PGM producer loader.
  34     default: 'loader'
  35   - identifier: softness
  36     title: Softness
  37     type: double
  38     mutable: yes
  39     description: >
  40        Only when using a luma map, how soft to make the edges between A and B.
  41        0.0 = no softness. 1.0 = too soft.
  42   - identifier: reverse
  43     title: Reverse
  44     type: int
  45     mutable: yes
  46     description: >
  47        Reverse the direction of the transition.
  48     default: 0
  49   - identifier: producer.*
  50     title: Producer
  51     mutable: yes
  52     description: >
  53       Properties may be set on the encapsulated producer. Any property starting
  54       with "producer." is passed to the non-PGM luma producer.
  55     readonly: no