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