1schema_version: 0.3
2type: transition
3identifier: luma
4title: Wipe
5version: 1
6copyright: Meltytech, LLC
7creator: Dan Dennedy
8license: LGPLv2.1
9language: en
10tags:
11  - Video
12description: >
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.
22bugs:
23  - Assumes lower field first output.
24parameters:
25  - identifier: resource
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    argument: yes
31
32  - identifier: factory
33    title: Factory
34    type: string
35    description: >
36      The name of a factory service used as a non-PGM producer loader.
37    default: loader
38
39  - identifier: softness
40    title: Softness
41    type: float
42    mutable: yes
43    description: >
44      Only when using a luma map, how soft to make the edges between A and B.
45      0.0 = no softness. 1.0 = too soft.
46
47  - identifier: reverse
48    title: Reverse
49    type: integer
50    mutable: yes
51    description: >
52      Reverse the direction of the transition.
53    default: 0
54
55  - identifier: producer.*
56    title: Producer
57    mutable: yes
58    description: >
59      Properties may be set on the encapsulated producer. Any property starting
60      with "producer." is passed to the non-PGM luma producer.
61    readonly: no
62
63  - identifier: alpha_over
64    title: Use over-blending on the alpha channel
65    type: boolean
66    default: 0
67    mutable: yes
68