git.sesse.net Git - mlt/blob - src/modules/qt/producer_qimage.yml

   1 schema_version: 0.1
   2 type: producer
   3 identifier: qimage
   4 title: Qt QImage
   5 version: 2
   6 copyright: Visual Media ?
   7 creator: Charles Yates
   8 license: GPLv2
   9 language: en
  10 tags:
  11   - Video
  12 description: >
  13     A still graphics to video generator using Qt QImage
  14 notes: >
  15     QImage 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 parameters:
  20   - identifier: argument
  21     title: File
  22     type: string
  23     description: >
  24         The name of a graphics file loadable by Qt.
  25
  26         If "%" in filename, the filename is used with sprintf to generate a
  27         filename from a counter for multi-file/flipbook animation. The file
  28         sequence ends when numeric discontinuity exceeds 100.
  29
  30         If the file sequence does not begin within the count of 100 you
  31         can pass the begin property like a query string parameter, for
  32         example: anim-%04d.png?begin=1000.
  33
  34         If filename contains "/.all.", suffix with an extension to load all
  35         pictures with matching extension from a directory.
  36
  37         If filename contains the string "<svg", then qimage tries to load the
  38         filename as inline SVG XML, which is convenient for melt commands.
  39     readonly: no
  40     required: yes
  41     mutable: no
  42     widget: fileopen
  43
  44   - identifier: begin
  45     title: Begin
  46     type: integer
  47     description: When using an image sequence, this sets the starting number.
  48     readonly: no
  49     minimum: 0
  50     mutable: no
  51     widget: spinner
  52
  53   - identifier: ttl
  54     title: Time-to-live
  55     type: integer
  56     description: How long (in frames) to repeat each picture in file sequences.
  57     readonly: no
  58     default: 25
  59     minimum: 0
  60     mutable: yes
  61     widget: spinner
  62
  63   - identifier: meta.media.width
  64     title: Real width
  65     type: integer
  66     description: The original, unscaled width of the rendered image.
  67     readonly: yes
  68
  69   - identifier: meta.media.height
  70     title: Real height
  71     type: integer
  72     description: The original, unscaled height of the rendered image.
  73     readonly: yes
  74
  75   - identifier: width
  76     title: Width
  77     type: integer
  78     description: The last requested scaled image width.
  79     readonly: yes
  80
  81   - identifier: height
  82     title: Height
  83     type: integer
  84     description: The last requested scaled image height.
  85     readonly: yes
  86
  87   - identifier: force_reload
  88     type: integer
  89     description: >
  90       Reload the file instead of using its cached image. This property
  91       automatically resets itself once it has been set 1 and processed.
  92     minimum: 0
  93     maximum: 1
  94     mutable: yes
  95
  96   - identifier: disable_exif
  97     title: Disable auto-rotation
  98     type: integer
  99     minimum: 0
 100     maximum: 1
 101     widget: checkbox
 102
 103   - identifier: force_aspect_ratio
 104     title: Sample aspect ratio
 105     type: float
 106     description: Optionally override a (mis)detected aspect ratio
 107     mutable: yes
 108