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

   1 *****************\r
   2 FFMPEG Producer\r
   3 *****************\r
   4 \r
   5 ---------------\r
   6 Supported Media\r
   7 ---------------\r
   8 \r
   9 The ffmpeg producer supports all files that the "ffmpeg" library (www.ffmpeg.org) can play. \r
  10 \r
  11 -------\r
  12 Filters\r
  13 -------\r
  14 \r
  15 The ffmpeg producer supports "libavfilter" filters through the "FILTER" parameter.\r
  16 \r
  17 -----------\r
  18 Diagnostics\r
  19 -----------\r
  20 \r
  21 ffmpeg[*filename* | *video-mode* | *file-frame-number* / *file-nb-frames*]\r
  22 \r
  23 +---------------+-----------------------------------------------+--------+\r
  24 | Graph         | Description                                   |  Scale |\r
  25 +===============+===============================================+========+\r
  26 | frame-time    | Time spent decoding the current frame.        | fps/2  |\r
  27 +---------------+-----------------------------------------------+--------+\r
  28 | buffer-count  | Number of input packets buffered.             |  100   |\r
  29 +---------------+-----------------------------------------------+--------+\r
  30 | buffer-size   | Size of buffered input packets.               | 64MB   |\r
  31 +---------------+-----------------------------------------------+--------+\r
  32 | underflow     | Frame was not ready in time and is skipped.   |  N/A   |\r
  33 +---------------+-----------------------------------------------+--------+\r
  34 | seek          | Input has seeked.                             |  N/A   |\r
  35 +---------------+-----------------------------------------------+--------+\r
  36                 \r
  37 ----------\r
  38 Parameters\r
  39 ----------\r
  40 \r
  41 ^^^^\r
  42 LOOP\r
  43 ^^^^\r
  44 Sets whether file will loop.\r
  45 \r
  46 Syntax::\r
  47 \r
  48         {LOOP}\r
  49         \r
  50 Example::\r
  51         \r
  52         << PLAY 1-1 MOVIE LOOP\r
  53         \r
  54 ^^^^\r
  55 SEEK\r
  56 ^^^^\r
  57 Sets the start of the file. This point will be used while looping.\r
  58 \r
  59 Syntax::\r
  60 \r
  61         SEEK [frames:int]\r
  62         \r
  63 Example::\r
  64         \r
  65         << PLAY 1-1 MOVIE SEEK 100 LOOP\r
  66             \r
  67 ^^^^\r
  68 START (CasparCG 2.1)\r
  69 ^^^^\r
  70 Sets the start of the file. This point will be used while looping.\r
  71 \r
  72 Syntax::\r
  73 \r
  74         START [frames:int]\r
  75         \r
  76 Example::\r
  77         \r
  78         << PLAY 1-1 MOVIE START 100 LOOP\r
  79     \r
  80 ^^^^^^\r
  81 LENGTH\r
  82 ^^^^^^\r
  83 Sets the end of the file.\r
  84 \r
  85 Syntax::\r
  86 \r
  87         LENGTH [frames:int]\r
  88         \r
  89 Example::\r
  90         \r
  91         << PLAY 1-1 MOVIE LENGTH 100\r
  92         \r
  93 ^^^^^^\r
  94 FILTER\r
  95 ^^^^^^\r
  96 Configures libavfilter which will be used.\r
  97 \r
  98 Syntax::\r
  99 \r
 100         FILTER [libavfilter-parameters:string]\r
 101                 \r
 102 Example::\r
 103                 \r
 104         << PLAY 1-1 MOVIE FILTER hflip:yadif=0:0\r
 105         \r
 106 ---------\r
 107 Functions\r
 108 ---------\r
 109 \r
 110 ^^^^\r
 111 LOOP\r
 112 ^^^^\r
 113 Sets whether file will loop. \r
 114 \r
 115 Syntax::\r
 116 \r
 117         LOOP [loop:0|1]\r
 118         \r
 119 Returns\r
 120 \r
 121         The value of LOOP after the command have completed.\r
 122         \r
 123 Example::\r
 124         \r
 125         << CALL 1-1 LOOP 1\r
 126         << CALL 1-1 LOOP   // Queries without changing.\r
 127         >> 1\r
 128         \r
 129 ^^^^\r
 130 SEEK\r
 131 ^^^^\r
 132 Seeks in the file.\r
 133 \r
 134 Syntax::\r
 135 \r
 136         SEEK [frames:int]\r
 137         \r
 138 Returns\r
 139 \r
 140         Nothing.\r
 141         \r
 142 Example::\r
 143         \r
 144         << CALL 1-1 SEEK 200\r
 145         \r
 146 ^^^^\r
 147 START (CasparCG 2.1)\r
 148 ^^^^\r
 149 Sets the start of the file. This point will be used while looping.\r
 150 \r
 151 Syntax::\r
 152 \r
 153         START [frames:int]\r
 154         \r
 155 Example::\r
 156         \r
 157         << CALL 1-1 START 100\r
 158     \r
 159 ^^^^^^\r
 160 LENGTH (CasparCG 2.1)\r
 161 ^^^^^^\r
 162 Sets the end of the file.\r
 163 \r
 164 Syntax::\r
 165 \r
 166         LENGTH [frames:int]\r
 167         \r
 168 Example::\r
 169         \r
 170         << CALL 1-1 LENGTH 100P