]> git.sesse.net Git - mlt/blob - src/modules/gtk2/producer_pixbuf.yml
Convert services.txt to metadata YAML (WIP).
[mlt] / src / modules / gtk2 / producer_pixbuf.yml
1 schema_version: 0.1
2 type: producer
3 identifier: pixbuf
4 title: GDK-PixBuf
5 version: 1
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       - >
26         The name of a graphics file loadable by a gdk-pixbuf loader. 
27         See /usr/lib/gdk-pixbuf/loaders
28         definitely png, jpeg, tiff, pnm, and xpm
29       - >
30         If "%" in filename, the filename is used with sprintf generate a 
31         filename from a counter for multi-file/flipbook animation. The file 
32         sequence ends when numeric discontinuity >100.
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 pixbuf 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 # could provide a button to use a file-open dialog 
43     
44   - identifier: in
45     title: In point
46     type: time
47     description: Set the start time offset to use within the clip
48     readonly: no
49     mutable: no
50     minimum: 0
51     default: 0
52     widget: timecode
53
54   - identifier: out
55     title: Out point
56     type: time
57     description: Set the ending time offset to use within the clip
58     readonly: no
59     minimum: 0
60     mutable: no
61     widget: timecode
62     
63   - identifier: begin
64     title: Begin
65     type: integer
66     description: When using an image sequence, this sets the starting number.
67     readonly: no
68     minimum: 0
69     mutable: no
70     widget: spinner
71     
72   - identifier: ttl
73     title: Time To Live
74     type: integer
75     description: How long (in frames) to repeat each picture in file sequences.
76     readonly: no
77     default: 25
78     minimum: 0
79     mutable: yes
80     widget: spinner
81     
82   - identifier: resource
83     title: Resource
84     type: string
85     description: File location. See "argument" above.
86     readonly: yes
87     
88   - identifier: real_width
89     title: Real Width
90     type: integer
91     description: The original, unscaled width of the rendered title.
92     readonly: yes
93     
94   - identifier: real_height
95     title: Real Height
96     type: integer
97     description: The original, unscaled height of the rendered title.
98     readonly: yes
99     
100   - identifier: width
101     title: Width
102     type: integer
103     description: The last requested scaled image width.
104     readonly: yes
105     
106   - identifier: height
107     title: Height
108     type: integer
109     description: The last requested scaled image height.
110     readonly: yes