git.sesse.net Git - casparcg/blob - source/tutorial/file-consumer.rst

   1 .. _tut-file:
   2
   3 *************************
   4 Running the File Consumer
   5 *************************
   6
   7 The file consumer uses ffmpeg to encode video.
   8
   9 The encoding will automatically take advantage of multi-core CPUs.
  10
  11 To start the file consumer send the following command:
  12
  13 ::
  14
  15     ADD 1 FILE myfile.mov
  16
  17 If the "-f"  or "-vcodec/-acodec" option is not supplied then the container format and appropriate codec will be automatically deduced from the file extension.
  18
  19 To stop writing to the file send:
  20
  21 ::
  22
  23     REMOVE 1 FILE
  24
  25
  26 The file consumer follows the commandline argument syntax used by ffmpeg, see ffmpeg.org for more options (note, not all options supported by ffmpeg have been implemented). Some of the available options are:
  27
  28 ::
  29
  30     -f // container format
  31     -vcodec // vicdeo codec
  32     -pix_fmt // pixel_format
  33     -r // video framerate
  34     -s // size
  35     -b // video bitrate
  36     -acodec // audio codec
  37     -ar // audio samplerate
  38     -ab // audio bitrate
  39     -ac // audio channels
  40
  41 ::
  42
  43     ADD 1 FILE myfile.mov -vcodec dnxhd
  44     ADD 1 FILE myfile.mov -vcodec prores
  45     ADD 1 FILE myfile.mov -vcodec dvvideo
  46     ADD 1 FILE myfile.mov -vcodec libx264
  47
  48 For the above formats have already provided high quality default parameters.
  49
  50 Another example:
  51
  52 ::
  53
  54     ADD 1 FILE myfile.mov -vcodec libx264 -preset ultrafast -tune fastdecode -crf 5