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 foo
  20 parameters:
  21   - identifier: argument
  22         title: File
  23         type: string
  24         description: >
  25                 The name of a graphics file loadable by Qt.
  26
  27                 If "%" in filename, the filename is used with sprintf to generate a
  28                 filename from a counter for multi-file/flipbook animation. The file
  29                 sequence ends when numeric discontinuity >100. If the file sequence
  30                 does not begin with the count of 100, you can also embed the number
  31                 of the first image between the "%" and a "d", "i", or "u".
  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 qimage 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: begin
  44         title: Begin
  45         type: integer
  46         description: When using an image sequence, this sets the starting number.
  47         readonly: no
  48         minimum: 0
  49         mutable: no
  50         widget: spinner
  51
  52   - identifier: ttl
  53         title: Time-to-live
  54         type: integer
  55         description: How long (in frames) to repeat each picture in file sequences.
  56         readonly: no
  57         default: 25
  58         minimum: 0
  59         mutable: yes
  60         widget: spinner
  61
  62   - identifier: meta.media.width
  63         title: Real width
  64         type: integer
  65         description: The original, unscaled width of the rendered image.
  66         readonly: yes
  67
  68   - identifier: meta.media.height
  69         title: Real height
  70         type: integer
  71         description: The original, unscaled height of the rendered image.
  72         readonly: yes
  73
  74   - identifier: width
  75         title: Width
  76         type: integer
  77         description: The last requested scaled image width.
  78         readonly: yes
  79
  80   - identifier: height
  81         title: Height
  82         type: integer
  83         description: The last requested scaled image height.
  84         readonly: yes
  85
  86   - identifier: force_reload
  87         type: integer
  88         description: >
  89           Reload the file instead of using its cached image. This property
  90           automatically resets itself once it has been set 1 and processed.
  91         minimum: 0
  92         maximum: 1
  93         mutable: yes
  94
  95   - identifier: disable_exif
  96         title: Disable auto-rotation
  97         type: integer
  98         minimum: 0
  99         maximum: 1
 100         widget: checkbox
 101
 102   - identifier: force_aspect_ratio
 103         title: Sample aspect ratio
 104         type: float
 105         description: Optionally override a (mis)detected aspect ratio
 106         mutable: yes
 107