]> git.sesse.net Git - casparcg/blob - source/producers.rst
a1483f474f2070e997b971405bc9025cffe56d06
[casparcg] / source / producers.rst
1 #########\r
2 Producers\r
3 #########\r
4 \r
5 ======\r
6 ffmpeg\r
7 ======\r
8 \r
9 -------\r
10 Filters\r
11 -------\r
12 \r
13 The ffmpeg producer supports "libavfilter" filters through the "FILTER" parameter.\r
14 \r
15 -----------\r
16 Diagnostics\r
17 -----------\r
18 \r
19 ffmpeg[ *filename* | *video-mode* | *file-frame-number* / *file-nb-frames*]\r
20 \r
21 +---------------+-----------------------------------------------+--------+\r
22 | Graph         | Description                                   |  Scale |\r
23 +===============+===============================================+========+\r
24 | frame-time    | Time spent decoding the current frame.        | fps/2  |\r
25 +---------------+-----------------------------------------------+--------+\r
26 | buffer-count  | Number of input packets buffered.             |  100   |\r
27 +---------------+-----------------------------------------------+--------+\r
28 | buffer-count  | Size of buffered input packets.               | 16MB   |\r
29 +---------------+-----------------------------------------------+--------+\r
30 | underflow     | Frame was not ready in time and is skipped.   |  N/A   |\r
31 +---------------+-----------------------------------------------+--------+\r
32 | seek          | Input has seeked.                             |  N/A   |\r
33 +---------------+-----------------------------------------------+--------+\r
34                 \r
35 ----------\r
36 Parameters\r
37 ----------\r
38 \r
39 ^^^^\r
40 LOOP\r
41 ^^^^\r
42 Sets whether file will loop.\r
43 \r
44 Syntax::\r
45 \r
46         {LOOP}\r
47         \r
48 Example::\r
49         \r
50         >>> PLAY 1-1 MOVIE LOOP\r
51         \r
52 ^^^^\r
53 SEEK\r
54 ^^^^\r
55 Sets the start of the file. This point will be used while looping.\r
56 \r
57 Syntax::\r
58 \r
59         SEEK [frames:int]\r
60         \r
61 Example::\r
62         \r
63         >>> PLAY 1-1 MOVIE SEEK 100 LOOP\r
64         \r
65 ^^^^^^\r
66 LENGTH\r
67 ^^^^^^\r
68 Sets the end of the file.\r
69 \r
70 Syntax::\r
71 \r
72         LENGTH [frames:int]\r
73         \r
74 Example::\r
75         \r
76         >>> PLAY 1-1 MOVIE LENGTH 100\r
77         \r
78 ^^^^^^\r
79 FILTER\r
80 ^^^^^^\r
81 Configures libavfilter which will be used.\r
82 \r
83 Syntax::\r
84 \r
85         FILTER [libavfilter-parameters:string]\r
86                 \r
87 Example::\r
88                 \r
89         >>> PLAY 1-1 MOVIE FILTER hflip:yadif=0:0\r
90         \r
91 ---------\r
92 Functions\r
93 ---------\r
94 \r
95 ^^^^\r
96 LOOP\r
97 ^^^^\r
98 Sets whether file will loop. \r
99 \r
100 Syntax::\r
101 \r
102         LOOP [loop:0|1]\r
103         \r
104 Returns\r
105 \r
106         The value of LOOP after the command have completed.\r
107         \r
108 Example::\r
109         \r
110         >>> CALL 1-1 LOOP 1\r
111         >>> CALL 1-1 LOOP   // Queries without changing.\r
112         <<< 1\r
113         \r
114 ^^^^\r
115 SEEK\r
116 ^^^^\r
117 Seeks in the file.\r
118 \r
119 Syntax::\r
120 \r
121         SEEK [frames:int]\r
122         \r
123 Returns\r
124 \r
125         Nothing.\r
126         \r
127 Example::\r
128         \r
129         >>> CALL 1-1 SEEK 200