\r
Example::\r
\r
- <<< LOADBG 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
+ >> LOADBG 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
\r
====\r
LOAD\r
\r
Example:: \r
\r
- <<< LOAD 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
+ >> LOAD 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
\r
====\r
PLAY\r
\r
Example::\r
\r
- <<< PLAY 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
- <<< PLAY 1-1\r
+ >> PLAY 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
+ >> PLAY 1-1\r
\r
=====\r
PAUSE\r
\r
Example::\r
\r
- <<< PAUSE 1-1\r
+ >> PAUSE 1-1\r
\r
=====\r
STOP\r
\r
Example::\r
\r
- <<< STOP 1-1\r
+ >> STOP 1-1\r
\r
=====\r
CLEAR\r
\r
Example::\r
\r
- <<< CLEAR 1-1\r
- <<< CLEAR 1\r
+ >> CLEAR 1-1\r
+ >> CLEAR 1\r
\r
======\r
CALL\r
\r
Example::\r
\r
- <<< CALL 1-1 SEEK 400\r
+ >> CALL 1-1 SEEK 400\r
\r
====\r
SWAP\r
\r
Example::\r
\r
- <<< SWAP 1-1 1-2\r
- <<< SWAP 1-0 2-0 \r
+ >> SWAP 1-1 1-2\r
+ >> SWAP 1-0 2-0 \r
\r
===\r
ADD\r
\r
Example::\r
\r
- <<< ADD 1 FILE output.mov CODEC DNXHD\r
- <<< ADD 1 DECKLINK 1\r
+ >> ADD 1 FILE output.mov CODEC DNXHD\r
+ >> ADD 1 DECKLINK 1\r
\r
======\r
REMOVE\r
\r
Example::\r
\r
- <<< REMOVE 1 FILE \r
- <<< REMOVE 1 DECKLINK 1
\ No newline at end of file
+ >> REMOVE 1 FILE \r
+ >> REMOVE 1 DECKLINK 1
\ No newline at end of file
# General information about the project.
project = u'CasparCG'
-copyright = u'2011, Robert Nagy'
+copyright = u'2011, Robert Nagy (ronag89@gmail.com)'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
#########\r
Consumers\r
-#########
\ No newline at end of file
+#########\r
+\r
+=============\r
+File Consumer\r
+=============\r
+\r
+-----------\r
+Diagnostics\r
+-----------\r
+\r
+ffmpeg[*filename*]\r
+\r
++---------------+-----------------------------------------------+--------+\r
+| Graph | Description | Scale |\r
++===============+===============================================+========+\r
+| frame-time | Time spent decoding the current frame. | fps/2 |\r
++---------------+-----------------------------------------------+--------+\r
+ \r
+----------\r
+Parameters\r
+----------\r
+\r
+The file consumer uses the same option syntax as ffmpeg. \r
+\r
+Note, not all options supported by ffmpeg have been implemented.\r
+\r
+ \r
+^^^^^^^^\r
+FILENAME\r
+^^^^^^^^\r
+\r
+Target filename.\r
+\r
+Syntax::\r
+\r
+ [filename:string]\r
+ \r
+Example::\r
+\r
+ ADD 1 FILE test.mov -vcodec libx264 -crf 5 -preset ultrafast -tune fastdecode -s 1280x720 -r 50 -acodec aac -ab 128k \r
+ REMOVE 1 FILE \r
+ \r
+=================\r
+Bluefish Consumer\r
+=================\r
+\r
+-----------\r
+Diagnostics\r
+-----------\r
+\r
+ffmpeg[*filename*]\r
+\r
++---------------+-----------------------------------------------+--------+\r
+| Graph | Description | Scale |\r
++===============+===============================================+========+\r
+| frame-time | Time spent decoding the current frame. | fps/2 |\r
++---------------+-----------------------------------------------+--------+\r
+| sync-time | Time spent waiting for sync. | fps/2 |\r
++---------------+-----------------------------------------------+--------+\r
+| tick-time | Time between frames frame. | fps/2 |\r
++---------------+-----------------------------------------------+--------+\r
+ \r
+----------\r
+Parameters\r
+----------\r
+\r
+^^^^^^\r
+DEVICE\r
+^^^^^^\r
+\r
+Which BlueFish device to attach.\r
+\r
+Syntax::\r
+\r
+ [device:int]\r
+ \r
+Configuration Syntax::\r
+\r
+ <device>[1..]</device>\r
+ \r
+Example::\r
+ \r
+ << ADD 1 BLUEFISH 1\r
+ \r
+ \r
+^^^^^^^^^^^^^^\r
+EMBEDDED_AUDIO\r
+^^^^^^^^^^^^^^\r
+\r
+Enables embedded-audio.\r
+\r
+Syntax::\r
+\r
+ EMBEDDED_AUDIO\r
+ \r
+Default::\r
+\r
+ Disabled\r
+ \r
+Configuration Syntax::\r
+\r
+ <embedded-audio>[true|false]</embedded-audio>\r
+ \r
+Example::\r
+ \r
+ << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO\r
+ \r
+^^^^^^^^\r
+KEY_ONLY\r
+^^^^^^^^\r
+\r
+Displays key as fill.\r
+\r
+Default::\r
+\r
+ Disabled\r
+\r
+Syntax::\r
+\r
+ KEY_ONLY\r
+ \r
+Configuration Syntax::\r
+\r
+ <key-only>[true|false]</key-only>\r
+ \r
+Example::\r
+ \r
+ << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO KEY_ONLY\r
+ \r
+\r
+=================\r
+Decklink Consumer\r
+=================\r
+\r
+-----------\r
+Diagnostics\r
+-----------\r
+\r
+ffmpeg[*filename*]\r
+\r
++---------------+-----------------------------------------------+--------------+\r
+| Graph | Description | Scale |\r
++===============+===============================================+==============+\r
+| frame-time | Time spent decoding the current frame. | fps/2 |\r
++---------------+-----------------------------------------------+--------------+\r
+| sync-time | Time spent waiting for sync. | fps/2 |\r
++---------------+-----------------------------------------------+--------------+\r
+| tick-time | Time between frames frame. | fps/2 |\r
++---------------+-----------------------------------------------+--------------+\r
+| dropped-frame | Frame was dropped. | N/A |\r
++---------------+-----------------------------------------------+--------------+\r
+| late-frame | Frame was late. | N/A |\r
++---------------+-----------------------------------------------+--------------+\r
+| buffered-video| Frame was dropped. | fps |\r
++---------------+-----------------------------------------------+--------------+\r
+| buffered-audio| Frame was late. | cadence*2 |\r
++---------------+-----------------------------------------------+--------------+\r
+ \r
+----------\r
+Parameters\r
+----------\r
+\r
+^^^^^^\r
+DEVICE\r
+^^^^^^\r
+\r
+Which BlueFish device to attach.\r
+\r
+Syntax::\r
+\r
+ [device:int]\r
+ \r
+Configuration Syntax::\r
+\r
+ <device>[1..]</device>\r
+ \r
+Example::\r
+ \r
+ << ADD 1 BLUEFISH 1\r
+ \r
+ \r
+^^^^^^^^^^^^^^\r
+EMBEDDED_AUDIO\r
+^^^^^^^^^^^^^^\r
+\r
+Enables embedded-audio.\r
+\r
+Syntax::\r
+\r
+ EMBEDDED_AUDIO\r
+ \r
+Default::\r
+\r
+ Disabled\r
+ \r
+Configuration Syntax::\r
+\r
+ <embedded-audio>[true|false]</embedded-audio>\r
+ \r
+Example::\r
+ \r
+ << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO\r
+ \r
+^^^^^^^^\r
+KEY_ONLY\r
+^^^^^^^^\r
+\r
+Displays key as fill.\r
+\r
+Default::\r
+\r
+ Disabled\r
+\r
+Syntax::\r
+\r
+ KEY_ONLY\r
+ \r
+Configuration Syntax::\r
+\r
+ <key-only>[true|false]</key-only>\r
+ \r
+Example::\r
+ \r
+ << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO KEY_ONLY \r
+ \r
+^^^^^^^\r
+LATENCY\r
+^^^^^^^\r
+\r
+Set latency mode.\r
+\r
+Default::\r
+\r
+ normal\r
+\r
+Configuration Syntax::\r
+\r
+ <latency>[normal|low|default]</latency>\r
+ \r
+^^^^^\r
+KEYER\r
+^^^^^\r
+\r
+Set keyer mode.\r
+\r
+Default::\r
+\r
+ external\r
+\r
+Configuration Syntax::\r
+\r
+ <keyer>[external|internal|default]</keyer>\r
+ \r
+^^^^^^^^^^^^\r
+BUFFER_DEPTH\r
+^^^^^^^^^^^^\r
+\r
+Set buffer depth. Settings this value to low can cause output distortion.\r
+\r
+Default::\r
+\r
+ 3\r
+\r
+Configuration Syntax::\r
+\r
+ <buffer-depth>[1..]</buffer-depth>\r
+ \r
+===============\r
+Screen Consumer\r
+===============\r
+\r
+=====================\r
+System Audio Consumer\r
+=====================
\ No newline at end of file
\r
Example::\r
\r
- <<< DATA STORE my_data "Some useful data"\r
+ >> DATA STORE my_data "Some useful data"\r
\r
=============\r
DATA RETRIEVE\r
\r
Example::\r
\r
- <<< DATA RETRIEVE my_data\r
- >>> "Some usefule data"\r
+ >> DATA RETRIEVE my_data\r
+ << "Some usefule data"\r
\r
=========\r
DATA LIST\r
\r
Example::\r
\r
- <<< DATA LIST\r
- >>> my_data
\ No newline at end of file
+ >> DATA LIST\r
+ << my_data
\ No newline at end of file
--- /dev/null
+###
+FAQ
+###
\ No newline at end of file
Contents:
.. toctree::
- :maxdepth: 2
+ :maxdepth: 3
:numbered:
- producers
- consumers
- commands
+ producers.rst
+ consumers.rst
+ commands.rst
Indices and tables
==================
\r
Example::\r
\r
- <<< DIAG\r
+ >> DIAG\r
\r
===\r
BYE\r
\r
Example\r
\r
- <<< BYE\r
+ >> BYE\r
\r
====\r
CHANNEL_GRID\r
\r
Syntax::\r
\r
- <<< CHANNEL_GRID\r
+ >> CHANNEL_GRID\r
\r
Example::\r
\r
- <<< CHANNEL_GRID
\ No newline at end of file
+ >> CHANNEL_GRID
\ No newline at end of file
\r
Example::\r
\r
- <<< MIXER 1-1 KEYER 1\r
+ >> MIXER 1-1 KEYER 1\r
\r
===========\r
MIXER BLEND\r
\r
Example::\r
\r
- <<< MIXER 1-1 BLEND overlay\r
+ >> MIXER 1-1 BLEND overlay\r
\r
See:: \r
\r
\r
Example::\r
\r
- <<< MIXER 1-1 OPACITY 0.5\r
+ >> MIXER 1-1 OPACITY 0.5\r
\r
================\r
MIXER BRIGTHNESS\r
\r
Example::\r
\r
- <<< MIXER 1-1 BRIGTHNESS 0.5\r
+ >> MIXER 1-1 BRIGTHNESS 0.5\r
\r
================\r
MIXER SATURATION\r
\r
Example::\r
\r
- <<< MIXER 1-1 SATURATION 0.5\r
+ >> MIXER 1-1 SATURATION 0.5\r
\r
==============\r
MIXER CONTRAST\r
\r
Example::\r
\r
- <<< MIXER 1-1 CONTRAST 0.5\r
+ >> MIXER 1-1 CONTRAST 0.5\r
\r
============\r
MIXER LEVELS\r
\r
Example::\r
\r
- <<< MIXER 1-1 LEVELS 0.1 0.1 1.0 0.9 0.9\r
+ >> MIXER 1-1 LEVELS 0.1 0.1 1.0 0.9 0.9\r
\r
==========\r
MIXER FILL\r
\r
Example::\r
\r
- <<< MIXER 1-1 FILL 0.25 0.25 0.5 0.5\r
+ >> MIXER 1-1 FILL 0.25 0.25 0.5 0.5\r
\r
==========\r
MIXER CLIP\r
\r
Example::\r
\r
- <<< MIXER 1-1 CLIP 0.25 0.25 0.5 0.5\r
+ >> MIXER 1-1 CLIP 0.25 0.25 0.5 0.5\r
\r
==========\r
MIXER GRID\r
\r
Example::\r
\r
- <<< MIXER 1 GRID 2\r
+ >> MIXER 1 GRID 2\r
\r
============\r
MIXER VOLUME\r
\r
Example::\r
\r
- <<< MIXER 1-1 VOLUME 0.5\r
+ >> MIXER 1-1 VOLUME 0.5\r
\r
===========\r
MIXER CLEAR\r
\r
Example::\r
\r
- <<< MIXER 1-1 CLEAR\r
+ >> MIXER 1-1 CLEAR\r
\ No newline at end of file
#########\r
\r
===============\r
-FFMPEG Producer\r
+ffmpeg Producer\r
===============\r
\r
---------------\r
Supported Media\r
---------------\r
\r
-The ffmpeg producer supports all files that the ffmpeg library (www.ffmpeg.org) can play. \r
-\r
-Support check is not dependent on file extension.\r
+The ffmpeg producer supports all files that the "ffmpeg" library (www.ffmpeg.org) can play. \r
\r
-------\r
Filters\r
Diagnostics\r
-----------\r
\r
-ffmpeg[ *filename* | *video-mode* | *file-frame-number* / *file-nb-frames*]\r
+ffmpeg[*filename* | *video-mode* | *file-frame-number* / *file-nb-frames*]\r
\r
+---------------+-----------------------------------------------+--------+\r
| Graph | Description | Scale |\r
\r
Example::\r
\r
- >>> PLAY 1-1 MOVIE LOOP\r
+ << PLAY 1-1 MOVIE LOOP\r
\r
^^^^\r
SEEK\r
\r
Example::\r
\r
- >>> PLAY 1-1 MOVIE SEEK 100 LOOP\r
+ << PLAY 1-1 MOVIE SEEK 100 LOOP\r
+ \r
+^^^^\r
+START (CasparCG 2.1)\r
+^^^^\r
+Sets the start of the file. This point will be used while looping.\r
+\r
+Syntax::\r
+\r
+ START [frames:int]\r
+ \r
+Example::\r
\r
+ << PLAY 1-1 MOVIE START 100 LOOP\r
+ \r
^^^^^^\r
LENGTH\r
^^^^^^\r
\r
Example::\r
\r
- >>> PLAY 1-1 MOVIE LENGTH 100\r
+ << PLAY 1-1 MOVIE LENGTH 100\r
\r
^^^^^^\r
FILTER\r
\r
Example::\r
\r
- >>> PLAY 1-1 MOVIE FILTER hflip:yadif=0:0\r
+ << PLAY 1-1 MOVIE FILTER hflip:yadif=0:0\r
\r
---------\r
Functions\r
\r
Example::\r
\r
- >>> CALL 1-1 LOOP 1\r
- >>> CALL 1-1 LOOP // Queries without changing.\r
- <<< 1\r
+ << CALL 1-1 LOOP 1\r
+ << CALL 1-1 LOOP // Queries without changing.\r
+ >> 1\r
\r
^^^^\r
SEEK\r
\r
Example::\r
\r
- >>> CALL 1-1 SEEK 200\r
+ << CALL 1-1 SEEK 200\r
\r
+^^^^\r
+START (CasparCG 2.1)\r
+^^^^\r
+Sets the start of the file. This point will be used while looping.\r
+\r
+Syntax::\r
+\r
+ START [frames:int]\r
+ \r
+Example::\r
+ \r
+ << CALL 1-1 START 100\r
+ \r
+^^^^^^\r
+LENGTH (CasparCG 2.1)\r
+^^^^^^\r
+Sets the end of the file.\r
+\r
+Syntax::\r
+\r
+ LENGTH [frames:int]\r
+ \r
+Example::\r
+ \r
+ << CALL 1-1 LENGTH 100P\r
+ \r
==============\r
Flash Producer\r
==============\r
Diagnostics\r
-----------\r
\r
-flash[ *template-host* | *video-mode*]\r
+flash[*template-host* | *video-mode*]\r
\r
+---------------+-----------------------------------------------+--------+\r
| Graph | Description | Scale |\r
Diagnostics\r
-----------\r
\r
-flash[ *model-name* | *device-index* | *video-mode*]\r
+flash[*model-name* | *device-index* | *video-mode*]\r
\r
+---------------+-----------------------------------------------+--------+\r
| Graph | Description | Scale |\r
\r
Example::\r
\r
- >>> PLAY 1-1 DECKLINK 1\r
+ << PLAY 1-1 DECKLINK 1\r
\r
^^^^^^\r
LENGTH\r
\r
Example::\r
\r
- >>> PLAY 1-1 DECKLINK 1 LENGTH 100\r
+ << PLAY 1-1 DECKLINK 1 LENGTH 100\r
\r
^^^^^^\r
FILTER\r
\r
Example::\r
\r
- >>> PLAY 1-1 DECKLINK 1 FILTER hflip:yadif=0:0\r
+ << PLAY 1-1 DECKLINK 1 FILTER hflip:yadif=0:0\r
\r
^^^^^^\r
FORMAT\r
\r
Example::\r
\r
- >>> PLAY 1-1 DECKLINK 1 FORMAT PAL LENGTH 100\r
+ << PLAY 1-1 DECKLINK 1 FORMAT PAL LENGTH 100\r
\r
==============\r
Image Producer\r
\r
Example::\r
\r
- <<< CINF movie\r
- >>> ...\r
+ >> CINF movie\r
+ << ...\r
\r
===\r
CLS\r
\r
Example::\r
\r
- <<< CLS\r
- >>> ...\r
+ >> CLS\r
+ << ...\r
\r
===\r
TLS\r
\r
Example::\r
\r
- <<< TLS\r
- >>> ...\r
+ >> TLS\r
+ << ...\r
\r
=======\r
VERSION\r
\r
Example::\r
\r
- <<< VERSION\r
- >>> ...\r
- <<< VERSION FLASH\r
- >>> ...\r
+ >> VERSION\r
+ << ...\r
+ >> VERSION FLASH\r
+ << ...\r
\r
====\r
INFO\r
\r
Example::\r
\r
- <<< INFO\r
- >>> ...\r
- <<< INFO 1\r
- >>> ...\r
- <<< INFO 1-1\r
- >>> ...\r
- <<< INFO TEMPLATE my_table_template\r
- >>> ...\r
+ >> INFO\r
+ << ...\r
+ >> INFO 1\r
+ << ...\r
+ >> INFO 1-1\r
+ << ...\r
+ >> INFO TEMPLATE my_table_template\r
+ << ...\r
\r
Example::\r
\r
- <<< CG 1-1 ADD 10 svtnews/info 1\r
+ >> CG 1-1 ADD 10 svtnews/info 1\r
\r
=========\r
CG REMOVE\r
\r
Example::\r
\r
- <<< CG 1-1 REMOVE 1\r
+ >> CG 1-1 REMOVE 1\r
\r
========\r
CG CLEAR\r
\r
Example::\r
\r
- <<< CG 1-1 CLEAR\r
+ >> CG 1-1 CLEAR\r
\r
=======\r
CG PLAY\r
\r
Example::\r
\r
- <<< CG 1-1 PLAY 1\r
+ >> CG 1-1 PLAY 1\r
\r
=======\r
CG STOP\r
\r
Example::\r
\r
- <<< CG 1-1 STOP\r
+ >> CG 1-1 STOP\r
\r
=======\r
CG NEXT\r
\r
Example::\r
\r
- <<< CG 1-1 NEXT 1\r
+ >> CG 1-1 NEXT 1\r
\r
=======\r
CG GOTO\r
\r
Example::\r
\r
- <<< CG 1-1 GOTO 1 intro\r
+ >> CG 1-1 GOTO 1 intro\r
\r
=========\r
CG UPDATE\r
\r
Example::\r
\r
- <<< CG 1-1 UPDATE 1 "Some data"\r
+ >> CG 1-1 UPDATE 1 "Some data"\r
\r
=========\r
CG INVOKE\r
\r
Example::\r
\r
- <<< CG 1-1 INVOKE 1 start_intro
\ No newline at end of file
+ >> CG 1-1 INVOKE 1 start_intro
\ No newline at end of file