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     title: Font
 130     type: string
 131     description: >
 132       The default typeface to use when not using markup.
 133       FreeType2 renders at 72 dpi.
 134       This property is deprecated. Use family, size and style instead.
 135     readonly: no
 136     mutable: yes
 137     widget: combo
 138
 139   - identifier: family
 140     title: Font family
 141     type: string
 142     description: >
 143       The default typeface to use when not using markup.
 144     default: Sans
 145     readonly: no
 146     mutable: yes
 147     widget: combo
 148
 149   - identifier: size
 150     title: Font size
 151     type: integer
 152     description: >
 153       The size in pixels of the font to use when not using markup.
 154     default: 48
 155     readonly: no
 156     mutable: yes
 157     widget: spinner
 158
 159   - identifier: style
 160     title: Font style
 161     type: string
 162     description: >
 163       The style of the font to use when not using markup.
 164     values:
 165       - normal
 166       - italic
 167     default: normal
 168     readonly: no
 169     mutable: yes
 170     widget: combo
 171
 172   - identifier: weight
 173     title: Font weight
 174     type: integer
 175     description: The weight of the font.
 176     minimum: 100
 177     maximum: 1000
 178     default: 400
 179     readonly: no
 180     mutable: yes
 181     widget: spinner
 182
 183   - identifier: encoding
 184     title: Encoding
 185     type: string
 186     description: >
 187       The text encoding type of the input if not UTF-8.
 188       See 'iconv --list' for a list of possible inputs.
 189     default: UTF-8
 190     readonly: no
 191     mutable: yes
 192     widget: combo
 193
 194   - identifier: real_width
 195     title: Real width
 196     type: integer
 197     description: The original, unscaled width of the rendered title.
 198     readonly: yes
 199
 200   - identifier: real_height
 201     title: Real height
 202     type: integer
 203     description: The original, unscaled height of the rendered title.
 204     readonly: yes
 205
 206   - identifier: width
 207     title: Width
 208     type: integer
 209     description: The last requested scaled image width.
 210     readonly: yes
 211
 212   - identifier: height
 213     title: Height
 214     type: integer
 215     description: The last requested scaled image height.
 216     readonly: yes
 217
 218   - identifier: force_aspect_ratio
 219     title: Sample aspect ratio
 220     type: float
 221     description: Optionally override a (mis)detected aspect ratio
 222     mutable: yes