git.sesse.net Git - casparcg/blob - source/producers.rst

   1 #########\r
   2 Producers\r
   3 #########\r
   4 \r
   5 ===============\r
   6 FFMPEG Producer\r
   7 ===============\r
   8 \r
   9 ---------------\r
  10 Supported Media\r
  11 ---------------\r
  12 \r
  13 The ffmpeg producer supports all files that the ffmpeg library (www.ffmpeg.org) can play. \r
  14 \r
  15 Support check is not dependent on file extension.\r
  16 \r
  17 -------\r
  18 Filters\r
  19 -------\r
  20 \r
  21 The ffmpeg producer supports "libavfilter" filters through the "FILTER" parameter.\r
  22 \r
  23 -----------\r
  24 Diagnostics\r
  25 -----------\r
  26 \r
  27 ffmpeg[ *filename* | *video-mode* | *file-frame-number* / *file-nb-frames*]\r
  28 \r
  29 +---------------+-----------------------------------------------+--------+\r
  30 | Graph         | Description                                   |  Scale |\r
  31 +===============+===============================================+========+\r
  32 | frame-time    | Time spent decoding the current frame.        | fps/2  |\r
  33 +---------------+-----------------------------------------------+--------+\r
  34 | buffer-count  | Number of input packets buffered.             |  100   |\r
  35 +---------------+-----------------------------------------------+--------+\r
  36 | buffer-size   | Size of buffered input packets.               | 64MB   |\r
  37 +---------------+-----------------------------------------------+--------+\r
  38 | underflow     | Frame was not ready in time and is skipped.   |  N/A   |\r
  39 +---------------+-----------------------------------------------+--------+\r
  40 | seek          | Input has seeked.                             |  N/A   |\r
  41 +---------------+-----------------------------------------------+--------+\r
  42                 \r
  43 ----------\r
  44 Parameters\r
  45 ----------\r
  46 \r
  47 ^^^^\r
  48 LOOP\r
  49 ^^^^\r
  50 Sets whether file will loop.\r
  51 \r
  52 Syntax::\r
  53 \r
  54         {LOOP}\r
  55         \r
  56 Example::\r
  57         \r
  58         >>> PLAY 1-1 MOVIE LOOP\r
  59         \r
  60 ^^^^\r
  61 SEEK\r
  62 ^^^^\r
  63 Sets the start of the file. This point will be used while looping.\r
  64 \r
  65 Syntax::\r
  66 \r
  67         SEEK [frames:int]\r
  68         \r
  69 Example::\r
  70         \r
  71         >>> PLAY 1-1 MOVIE SEEK 100 LOOP\r
  72         \r
  73 ^^^^^^\r
  74 LENGTH\r
  75 ^^^^^^\r
  76 Sets the end of the file.\r
  77 \r
  78 Syntax::\r
  79 \r
  80         LENGTH [frames:int]\r
  81         \r
  82 Example::\r
  83         \r
  84         >>> PLAY 1-1 MOVIE LENGTH 100\r
  85         \r
  86 ^^^^^^\r
  87 FILTER\r
  88 ^^^^^^\r
  89 Configures libavfilter which will be used.\r
  90 \r
  91 Syntax::\r
  92 \r
  93         FILTER [libavfilter-parameters:string]\r
  94                 \r
  95 Example::\r
  96                 \r
  97         >>> PLAY 1-1 MOVIE FILTER hflip:yadif=0:0\r
  98         \r
  99 ---------\r
 100 Functions\r
 101 ---------\r
 102 \r
 103 ^^^^\r
 104 LOOP\r
 105 ^^^^\r
 106 Sets whether file will loop. \r
 107 \r
 108 Syntax::\r
 109 \r
 110         LOOP [loop:0|1]\r
 111         \r
 112 Returns\r
 113 \r
 114         The value of LOOP after the command have completed.\r
 115         \r
 116 Example::\r
 117         \r
 118         >>> CALL 1-1 LOOP 1\r
 119         >>> CALL 1-1 LOOP   // Queries without changing.\r
 120         <<< 1\r
 121         \r
 122 ^^^^\r
 123 SEEK\r
 124 ^^^^\r
 125 Seeks in the file.\r
 126 \r
 127 Syntax::\r
 128 \r
 129         SEEK [frames:int]\r
 130         \r
 131 Returns\r
 132 \r
 133         Nothing.\r
 134         \r
 135 Example::\r
 136         \r
 137         >>> CALL 1-1 SEEK 200\r
 138         \r
 139 ==============\r
 140 Flash Producer\r
 141 ==============\r
 142 \r
 143 ---------------\r
 144 Supported Media\r
 145 ---------------\r
 146 \r
 147 +---------------+-----------------------------------------------+\r
 148 | Extension     | Description                                   |\r
 149 +===============+===============================================+\r
 150 | .ft           | Flash-template.                               |\r
 151 +---------------+-----------------------------------------------+\r
 152 | .ct           | Compressed-template.                          |\r
 153 +---------------+-----------------------------------------------+\r
 154 | .swf          | Flash file.                                   |\r
 155 +---------------+-----------------------------------------------+\r
 156 \r
 157 -----------\r
 158 Diagnostics\r
 159 -----------\r
 160 \r
 161 flash[ *template-host* | *video-mode*]\r
 162 \r
 163 +---------------+-----------------------------------------------+--------+\r
 164 | Graph         | Description                                   |  Scale |\r
 165 +===============+===============================================+========+\r
 166 | frame-time    | Time spent rendering the current frame.       | fps/2  |\r
 167 +---------------+-----------------------------------------------+--------+\r
 168 | tick-time     | Time between rendering two frames.            | fps/2  |\r
 169 +---------------+-----------------------------------------------+--------+\r
 170 | param         | Invoked flash command.                        |  N/A   |\r
 171 +---------------+-----------------------------------------------+--------+\r
 172 | late-frame    | Frame was not ready in time and is skipped.   |  N/A   |\r
 173 +---------------+-----------------------------------------------+--------+\r
 174 | sync          | Synced time between rendering two frames.     | fps/2  |\r
 175 +---------------+-----------------------------------------------+--------+\r
 176 \r
 177 \r
 178 =================\r
 179 Decklink Producer\r
 180 =================\r
 181 \r
 182 -----------\r
 183 Diagnostics\r
 184 -----------\r
 185 \r
 186 flash[ *model-name* | *device-index* | *video-mode*]\r
 187 \r
 188 +---------------+-----------------------------------------------+--------+\r
 189 | Graph         | Description                                   |  Scale |\r
 190 +===============+===============================================+========+\r
 191 | frame-time    | Time spent rendering the current frame.       | fps/2  |\r
 192 +---------------+-----------------------------------------------+--------+\r
 193 | tick-time     | Time between rendering two frames.            | fps/2  |\r
 194 +---------------+-----------------------------------------------+--------+\r
 195 | dropped-frame | Dropped an input frame.                       |  N/A   |\r
 196 +---------------+-----------------------------------------------+--------+\r
 197 | late-frame    | Frame was not ready in time and is skipped.   |  N/A   |\r
 198 +---------------+-----------------------------------------------+--------+\r
 199 | output-buffer | Buffering.                                     |        |\r
 200 +---------------+-----------------------------------------------+--------+\r
 201 ----------\r
 202 Parameters\r
 203 ----------\r
 204 \r
 205 ^^^^^^\r
 206 DEVICE\r
 207 ^^^^^^\r
 208 \r
 209 Which BlackMagic device to attach.\r
 210 \r
 211 Syntax::\r
 212 \r
 213         [device:int]\r
 214         \r
 215 Example::\r
 216         \r
 217         >>> PLAY 1-1 DECKLINK 1\r
 218     \r
 219 ^^^^^^\r
 220 LENGTH\r
 221 ^^^^^^\r
 222 Sets the end of the file.\r
 223 \r
 224 Syntax::\r
 225 \r
 226         LENGTH [frames:int]\r
 227         \r
 228 Example::\r
 229         \r
 230         >>> PLAY 1-1 DECKLINK 1 LENGTH 100\r
 231         \r
 232 ^^^^^^\r
 233 FILTER\r
 234 ^^^^^^\r
 235 Configures libavfilter which will be used.\r
 236 \r
 237 Syntax::\r
 238 \r
 239         FILTER [libavfilter-parameters:string]\r
 240                 \r
 241 Example::\r
 242                 \r
 243         >>> PLAY 1-1 DECKLINK 1 FILTER hflip:yadif=0:0\r
 244         \r
 245 ^^^^^^\r
 246 FORMAT\r
 247 ^^^^^^\r
 248 Sets the video-mode. If no video-mode is provided then the parent channels video-mode will be used.\r
 249 \r
 250 Syntax::\r
 251 \r
 252         FORMAT [video-mode:string]\r
 253         \r
 254 Example::\r
 255         \r
 256         >>> PLAY 1-1 DECKLINK 1 FORMAT PAL LENGTH 100\r
 257         \r
 258 ==============\r
 259 Image Producer\r
 260 ==============\r
 261 \r
 262 ---------------\r
 263 Supported Media\r
 264 ---------------\r
 265 \r
 266 +-----------------------+-----------------------------------------------+\r
 267 | Extension             | Description                                   |\r
 268 +=======================+===============================================+\r
 269 | .png                  |                                               |\r
 270 +-----------------------+-----------------------------------------------+\r
 271 | .tga                  |                                               |\r
 272 +-----------------------+-----------------------------------------------+\r
 273 | .bmp                  |                                               |\r
 274 +-----------------------+-----------------------------------------------+\r
 275 | .jpg, .jpeg, .j2k     |                                               |\r
 276 +-----------------------+-----------------------------------------------+\r
 277 | .gif                  |                                               |\r
 278 +-----------------------+-----------------------------------------------+\r
 279 | .tif, tiff            |                                               |\r
 280 +-----------------------+-----------------------------------------------+\r
 281 \r
 282 =====================\r
 283 Image Scroll-Producer\r
 284 =====================