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

   1 schema_version: 0.1
   2 type: filter
   3 identifier: watermark
   4 title: Overlay
   5 version: 1
   6 copyright: Ushodaya Enterprises Limited
   7 creator: Charles Yates
   8 license: LGPLv2.1
   9 language: en
  10 tags:
  11   - Video
  12 description: Overlay text or images onto the video
  13 notes: >
  14   The watermark filter combines a frame producer and a composite transition to
  15   overlay the specified text or image onto the video.
  16
  17   Supplying a filename with extension ".txt" causes the loader to load a pango
  18   producer. Supplying a file name with an extension supported by gtk-pixbuf
  19   causes the loader to load a pixbuf producer. See the pango and pixbuf
  20   producers for details.
  21
  22   Note: If the filename begins with "+" the pango producer interprets the
  23   filename as pango text.
  24
  25   Text Example:
  26   melt colour:red -filter watermark:"+First Line~Second Line.txt" composite.progressive=1 producer.align=centre composite.valign=c composite.halign=c
  27
  28   Image Example:
  29   melt clip.dv -filter watermark:logo.png
  30
  31 parameters:
  32   - identifier: argument
  33     title: File/URL
  34     type: string
  35     description: The file to overlay.
  36     required: no
  37     readonly: no
  38     default: unset
  39     widget: fileopen
  40
  41   - identifier: resource
  42     title: File/URL
  43     type: string
  44     description: The file to overlay.
  45     required: no
  46     readonly: no
  47     default: unset
  48     widget: fileopen
  49
  50   - identifier: distort
  51     title: Allow distorted scaling
  52     type: integer
  53     default: 0
  54     minimum: 0
  55     maximum: 1
  56     widget: checkbox
  57
  58   - identifier: producer.*
  59     title: Producer
  60     description: |
  61       Properties may be set on the encapsulated producer.
  62       e.g.: producer.align=centre
  63       See "pango" and "pixbuf" producers for details.
  64     readonly: no
  65
  66   - identifier: composite.*
  67     title: Composite
  68     description: |
  69       Properties may be set on the encapsulated composite.
  70       e.g.: composite.valign=c
  71       See "composite" transition for details.
  72     readonly: no
  73
  74   - identifier: reverse
  75     title: Reverse
  76     type: integer
  77     description: Overlay the video to which the filter is applied atop the supplied file.
  78     minimum: 0
  79     maximum: 1
  80     mutable: yes
  81     widget: checkbox
  82
  83   - identifier: deinterlace
  84     description: Force the supplied file to be be deinterlaced if it is interlaced.
  85     type: integer
  86     description:
  87     minimum: 0
  88     maximum: 1
  89     mutable: yes
  90     widget: checkbox