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:
  23   - Assumes lower field first output.
  24 parameters:
  25   - identifier: argument
  26     title: Luma map file
  27     type: string
  28     description: >
  29       Either PGM or any other producable video. If not supplied, performs a dissolve.
  30   - identifier: factory
  31     title: Factory
  32     type: string
  33     description: >
  34       The name of a factory service used as a non-PGM producer loader.
  35     default: loader
  36   - identifier: softness
  37     title: Softness
  38     type: float
  39     mutable: yes
  40     description: >
  41       Only when using a luma map, how soft to make the edges between A and B.
  42       0.0 = no softness. 1.0 = too soft.
  43   - identifier: reverse
  44     title: Reverse
  45     type: int
  46     mutable: yes
  47     description: >
  48       Reverse the direction of the transition.
  49     default: 0
  50   - identifier: producer.*
  51     title: Producer
  52     mutable: yes
  53     description: >
  54       Properties may be set on the encapsulated producer. Any property starting
  55       with "producer." is passed to the non-PGM luma producer.
  56     readonly: no