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

   1 schema_version: 0.1
   2 type: producer
   3 identifier: pixbuf
   4 title: GDK-PixBuf
   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 still graphics to video generator using gdk-pixbuf
  14 notes: >
  15   Pixbuf has builtin scaling. It will rescale the originally rendered title to
  16   whatever the consumer requests. Therefore, it will lose its aspect ratio if
  17   so requested, and it is up to the consumer to request a proper width and
  18   height that maintains the image aspect.
  19
  20 parameters:
  21   - identifier: argument
  22     title: File
  23     type: string
  24     description: >
  25         The name of a graphics file loadable by a gdk-pixbuf loader.
  26         See /usr/lib/gdk-pixbuf/loaders.
  27         Definitely png, jpeg, tiff, pnm, and xpm will work.
  28
  29         If "%" in filename, the filename is used with sprintf generate a
  30         filename from a counter for multi-file/flipbook animation. The file
  31         sequence ends when numeric discontinuity >100.
  32
  33         If filename contains "/.all.", suffix with an extension to load all
  34         pictures with matching extension from a directory.
  35
  36         If filename contains the string "<svg", then pixbuf tries to load the
  37         filename as inline SVG XML, which is convenient for melt commands.
  38     readonly: no
  39     required: yes
  40     mutable: no
  41     widget: fileopen
  42
  43   - identifier: in
  44     title: In point
  45     type: time
  46     description: Set the start time offset to use within the clip
  47     readonly: no
  48     mutable: no
  49     minimum: 0
  50     default: 0
  51     widget: timecode
  52
  53   - identifier: out
  54     title: Out point
  55     type: time
  56     description: Set the ending time offset to use within the clip
  57     readonly: no
  58     minimum: 0
  59     mutable: no
  60     widget: timecode
  61
  62   - identifier: begin
  63     title: Begin
  64     type: integer
  65     description: When using an image sequence, this sets the starting number.
  66     readonly: no
  67     minimum: 0
  68     mutable: no
  69     widget: spinner
  70
  71   - identifier: ttl
  72     title: Time-to-live
  73     type: integer
  74     description: How long (in frames) to repeat each picture in file sequences.
  75     readonly: no
  76     default: 25
  77     minimum: 0
  78     mutable: yes
  79     widget: spinner
  80
  81   - identifier: resource
  82     title: Resource
  83     type: string
  84     description: File location. See "argument" above.
  85     readonly: yes
  86
  87   - identifier: real_width
  88     title: Real width
  89     type: integer
  90     description: The original, unscaled width of the rendered image.
  91     readonly: yes
  92
  93   - identifier: real_height
  94     title: Real height
  95     type: integer
  96     description: The original, unscaled height of the rendered image.
  97     readonly: yes
  98
  99   - identifier: width
 100     title: Width
 101     type: integer
 102     description: The last requested scaled image width.
 103     readonly: yes
 104
 105   - identifier: height
 106     title: Height
 107     type: integer
 108     description: The last requested scaled image height.
 109     readonly: yes
 110
 111   - identifier: force_reload
 112     type: integer
 113     description: >
 114       Reload the file instead of using its cached image. This property
 115       automatically resets itself once it has been set 1 and processed.
 116     minimum: 0
 117     maximum: 1
 118     mutable: yes
 119
 120   - identifier: disable_exif
 121     title: Disable auto-rotation
 122     type: integer
 123     minimum: 0
 124     maximum: 1
 125     widget: checkbox