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

   1 schema_version: 0.1
   2 type: transition
   3 identifier: composite
   4 title: Composite
   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 key-framable alpha-channel compositor for two frames.
  14 notes: >
  15   Performs dissolves and luma wipes in addition to alpha compositing.
  16
  17   By default, the aspect ratio of the B frame is respected and the size
  18   portion of the geometry specification simply defines a bounding rectangle.
  19
  20   This performs field-based rendering unless the A frame property
  21   "progressive" or "consumer_progressive" or the transition property
  22   "progressive" is set to 1.
  23 bugs:
  24   - Assumes lower field first during field rendering.
  25 parameters:
  26   - identifier: factory
  27     title: Factory
  28     type: string
  29     description: >
  30       The name of a factory service used as a non-PGM producer loader.
  31     default: loader
  32   - identifier: geometry
  33     title: Geometry
  34     type: geometry
  35     description: >
  36       Key frame specification. This is a ";" delimited form of the deprecated
  37       start, key[n], end properties.
  38     mutable: yes
  39   - identifier: progressive
  40     title: Progressive
  41     description: >
  42       Enable or disable field-based rendering.
  43     type: integer
  44     minimum: 0
  45     maximum: 1
  46     mutable: yes
  47     widget: checkbox
  48   - identifier: distort
  49     title: Allow distorted scaling
  50     description: >
  51       When set, causes the B frame image to fill the WxH completely with no
  52       regard to B's aspect ratio.
  53     type: integer
  54     default: 0
  55     minimum: 0
  56     maximum: 1
  57     mutable: yes
  58     widget: checkbox
  59   - identifier: halign
  60     title: Horizontal alignment
  61     description: >
  62       When not distorting, set the horizontal alignment of B within the
  63       geometry rectangle.
  64     type: string
  65     default: left
  66     values:
  67       - left
  68       - centre
  69       - right
  70     mutable: yes
  71     widget: combo
  72   - identifier: valign
  73     title: Vertical alignment
  74     description: >
  75       When not distorting, set the vertical alignment of B within the
  76       geometry rectangle.
  77     type: string
  78     default: top
  79     values:
  80       - top
  81       - middle
  82       - bottom
  83     mutable: yes
  84     widget: combo
  85   - identifier: luma
  86     title: Luma map
  87     description: >
  88       The luma map file name. If not supplied, a dissolve.
  89     type: string
  90     default: unset
  91     mutable: yes
  92     widget: fileopen
  93   - identifier: softness
  94     title: Softness
  95     description: >
  96       Only when using a luma map, how soft to make the edges between A and B.
  97     type: float
  98     default: 0.0
  99     minimum: 0.0
 100     maximum: 1.0
 101     mutable: yes
 102   - identifier: luma.*
 103     title: Luma producer
 104     description: >
 105       Properties may be set on the encapsulated producer. Any property starting
 106       with "luma." is passed to the non-PGM luma producer.
 107     readonly: no
 108     mutable: yes
 109   - identifier: start
 110     title: Start geometry
 111     description: >
 112       A geometry specification as X/Y:WxH[!][:mix]
 113
 114       X, Y, W, H are assumed to pixel units unless they have the suffix '%'.
 115
 116       '!' is a shortcut to specify distort.
 117
 118       Mix is always a 2 digit percentage, defaults to 100.
 119     type: geometry
 120     default: "85%/5%:10%x10%"
 121     readonly: no
 122     mutable: yes
 123   - identifier: end
 124     title: End geometry
 125     description: >
 126       X/Y:WxH[:mix] - The end geometry specification (see "start").
 127     type: geometry
 128     readonly: no
 129     mutable: yes
 130   - identifier: key[F]
 131     title: Key frame geometry
 132     description: >
 133       X/Y:WxH[:mix] - set a key frame for geometry between the in and out. F is
 134       a frame number and can be negative to make it relative to the out point.
 135     type: geometry
 136     readonly: no
 137     mutable: yes