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