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: 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 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 the output of gdk-pixbuf-query-loaders.
  27         Definitely png, jpeg, tiff, pnm, and xpm will work.
  28
  29         If "%" in filename, the filename is used with sprintf to generate a
  30         filename from a counter for multi-file/flipbook animation. The file
  31         sequence ends when numeric discontinuity >100. If the file sequence
  32         does not begin with the count of 100, you can also embed the number
  33         of the first image between the "%" and a "d", "i", or "u".
  34
  35         If filename contains "/.all.", suffix with an extension to load all
  36         pictures with matching extension from a directory.
  37
  38         If filename contains the string "<svg", then pixbuf tries to load the
  39         filename as inline SVG XML, which is convenient for melt commands.
  40     readonly: no
  41     required: yes
  42     mutable: no
  43     widget: fileopen
  44
  45   - identifier: begin
  46     title: Begin
  47     type: integer
  48     description: When using an image sequence, this sets the starting number.
  49     readonly: no
  50     minimum: 0
  51     mutable: no
  52     widget: spinner
  53
  54   - identifier: ttl
  55     title: Time-to-live
  56     type: integer
  57     description: How long (in frames) to repeat each picture in file sequences.
  58     readonly: no
  59     default: 25
  60     minimum: 0
  61     mutable: yes
  62     widget: spinner
  63
  64   - identifier: meta.media.width
  65     title: Real width
  66     type: integer
  67     description: The original, unscaled width of the rendered image.
  68     readonly: yes
  69
  70   - identifier: meta.media.height
  71     title: Real height
  72     type: integer
  73     description: The original, unscaled height of the rendered image.
  74     readonly: yes
  75
  76   - identifier: width
  77     title: Width
  78     type: integer
  79     description: The last requested scaled image width.
  80     readonly: yes
  81
  82   - identifier: height
  83     title: Height
  84     type: integer
  85     description: The last requested scaled image height.
  86     readonly: yes
  87
  88   - identifier: force_reload
  89     type: integer
  90     description: >
  91       Reload the file instead of using its cached image. This property
  92       automatically resets itself once it has been set 1 and processed.
  93     minimum: 0
  94     maximum: 1
  95     mutable: yes
  96
  97   - identifier: disable_exif
  98     title: Disable auto-rotation
  99     type: integer
 100     minimum: 0
 101     maximum: 1
 102     widget: checkbox
 103
 104   - identifier: force_aspect_ratio
 105     title: Sample aspect ratio
 106     type: float
 107     description: Optionally override a (mis)detected aspect ratio
 108     mutable: yes