git.sesse.net Git - mlt/blob - src/modules/gtk2/producer_pango.yml

   1 schema_version: 0.1
   2 type: producer
   3 identifier: pango
   4 title: Pango
   5 version: 2
   6 copyright: Ushodaya Enterprises Limited
   7 creator: Dan Dennedy
   8 license: LGPLv2.1
   9 language: en
  10 tags:
  11   - Video
  12 description: >
  13   A title generator that uses the Pango international text layout and Freetype2
  14   font renderer.
  15 notes: >
  16   Supplying a filename with extension ".txt" causes the loader producer to load
  17   with pango. If the filename begins with "+" the pango producer interprets the
  18   filename as pango text. This is a shortcut to embed titles in melt commands.
  19   For MLT XML, it is recommended that you embed the title text in the property
  20   value.
  21
  22   Pango has builtin scaling. It will rescale the originally rendered title to
  23   whatever the consumer requests. Therefore, it will lose its aspect ratio if
  24   so requested, and it is up to the consumer to request a proper width and
  25   height that maintains the image aspect.
  26
  27 parameters:
  28   - identifier: argument
  29     title: File
  30     type: string
  31     description: |
  32       A text file containing Pango markup, see:
  33       http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
  34       requires xml-like encoding special chars from:
  35       <, >, &   -to-   &lt;, &gt;, &amp;
  36     readonly: no
  37     required: yes
  38     mutable: no
  39     widget: fileopen
  40
  41   - identifier: markup
  42     title: Markup
  43     type: string
  44     description: |
  45       A string containing Pango markup see:
  46       http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
  47       requires xml-like encoding special chars from:
  48       <, >, &   -to-   &lt;, &gt;, &amp;
  49     readonly: no
  50     mutable: yes
  51     widget: textbox
  52
  53   - identifier: fgcolour
  54     title: Foreground color
  55     type: string
  56     description: >
  57       A color value is a hexadecimal representation of RGB plus alpha channel
  58       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  59       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  60     readonly: no
  61     mutable: yes
  62     widget: color
  63
  64   - identifier: bgcolour
  65     title: Background color
  66     type: string
  67     description: >
  68       A color value is a hexadecimal representation of RGB plus alpha channel
  69       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  70       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  71     readonly: no
  72     mutable: yes
  73     widget: color
  74
  75   - identifier: olcolour
  76     title: Outline color
  77     type: string
  78     description: >
  79       A color value is a hexadecimal representation of RGB plus alpha channel
  80       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  81       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  82     readonly: no
  83     mutable: yes
  84     widget: color
  85
  86   - identifier: outline
  87     title: Outline Width
  88     type: string
  89     description: >
  90       The width of the outline in pixels.
  91     readonly: no
  92     default: 0
  93     minimum: 0
  94     maximum: 3
  95     mutable: yes
  96     widget: spinner
  97
  98   - identifier: align
  99     title: Paragraph alignment
 100     type: string
 101     description: >
 102       left, centre, right (also, numbers 0, 1 and 2 can be used respectively)
 103     readonly: no
 104     default: left
 105     mutable: yes
 106     widget: combo
 107
 108   - identifier: pad
 109     title: Padding
 110     type: integer
 111     description: >
 112       The number of pixels to pad the background rectangle beyond edges of text.
 113     readonly: no
 114     default: 0
 115     mutable: yes
 116     widget: spinner
 117
 118   - identifier: text
 119     title: Text
 120     type: string
 121     description: |
 122       A non-markup string in UTF-8 encoding
 123       (can contain markup chars un-encoded)
 124     readonly: no
 125     mutable: yes
 126     widget: textbox
 127
 128   - identifier: font
 129     deprecated: yes
 130     title: Font
 131     type: string
 132     description: >
 133       The default typeface to use when not using markup.
 134       FreeType2 renders at 72 dpi.
 135       This property is deprecated. Use family, size and style instead.
 136     readonly: no
 137     mutable: yes
 138     widget: combo
 139
 140   - identifier: family
 141     title: Font family
 142     type: string
 143     description: >
 144       The default typeface to use when not using markup.
 145     default: Sans
 146     readonly: no
 147     mutable: yes
 148     widget: combo
 149
 150   - identifier: size
 151     title: Font size
 152     type: integer
 153     description: >
 154       The size in pixels of the font to use when not using markup.
 155     default: 48
 156     readonly: no
 157     mutable: yes
 158     widget: spinner
 159
 160   - identifier: style
 161     title: Font style
 162     type: string
 163     description: >
 164       The style of the font to use when not using markup.
 165     values:
 166       - normal
 167       - italic
 168     default: normal
 169     readonly: no
 170     mutable: yes
 171     widget: combo
 172
 173   - identifier: weight
 174     title: Font weight
 175     type: integer
 176     description: The weight of the font.
 177     minimum: 100
 178     maximum: 1000
 179     default: 400
 180     readonly: no
 181     mutable: yes
 182     widget: spinner
 183
 184   - identifier: encoding
 185     title: Encoding
 186     type: string
 187     description: >
 188       The text encoding type of the input if not UTF-8.
 189       See 'iconv --list' for a list of possible inputs.
 190     default: UTF-8
 191     readonly: no
 192     mutable: yes
 193     widget: combo
 194
 195   - identifier: real_width
 196     title: Real width
 197     type: integer
 198     description: The original, unscaled width of the rendered title.
 199     readonly: yes
 200
 201   - identifier: real_height
 202     title: Real height
 203     type: integer
 204     description: The original, unscaled height of the rendered title.
 205     readonly: yes
 206
 207   - identifier: width
 208     title: Width
 209     type: integer
 210     description: The last requested scaled image width.
 211     readonly: yes
 212
 213   - identifier: height
 214     title: Height
 215     type: integer
 216     description: The last requested scaled image height.
 217     readonly: yes