From e7efd0452e2d7a850f0c925444934239de0aed54 Mon Sep 17 00:00:00 2001 From: ronag Date: Sun, 11 Mar 2012 18:39:11 +0000 Subject: [PATCH] --- source/_themes/scrolls/static/watermark.png | Bin 107625 -> 107623 bytes source/basic-commands.rst | 30 +-- source/conf.py | 2 +- source/consumers.rst | 275 +++++++++++++++++++- source/data-commands.rst | 10 +- source/faq.rst | 3 + source/index.rst | 8 +- source/misc-commands.rst | 8 +- source/mixer-commands.rst | 24 +- source/producers.rst | 75 ++++-- source/query-commands.rst | 36 +-- source/template-graphics-commands.rst | 18 +- 12 files changed, 401 insertions(+), 88 deletions(-) create mode 100644 source/faq.rst diff --git a/source/_themes/scrolls/static/watermark.png b/source/_themes/scrolls/static/watermark.png index eb1b6be957b2f137a0667b35f43c0d4cb6291cf6..fa87e7b7948a4f641596799c45f22fbff258fcd1 100644 GIT binary patch delta 25 ecmaEPg6;VUwhjI*Og1)~gIaDXfoQ$u)_(z*E(<6C delta 27 gcmaEUg6-uAwhjI*%yxEmn*&>JDuEd~%dP(c0IPNjs{jB1 diff --git a/source/basic-commands.rst b/source/basic-commands.rst index 830ad3281..cfd62311c 100644 --- a/source/basic-commands.rst +++ b/source/basic-commands.rst @@ -14,7 +14,7 @@ Syntax:: Example:: - <<< LOADBG 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip + >> LOADBG 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip ==== LOAD @@ -28,7 +28,7 @@ Syntax:: Example:: - <<< LOAD 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip + >> LOAD 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip ==== PLAY @@ -43,8 +43,8 @@ Syntax:: Example:: - <<< PLAY 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip - <<< PLAY 1-1 + >> PLAY 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip + >> PLAY 1-1 ===== PAUSE @@ -57,7 +57,7 @@ Syntax:: Example:: - <<< PAUSE 1-1 + >> PAUSE 1-1 ===== STOP @@ -70,7 +70,7 @@ Syntax:: Example:: - <<< STOP 1-1 + >> STOP 1-1 ===== CLEAR @@ -83,8 +83,8 @@ Syntax:: Example:: - <<< CLEAR 1-1 - <<< CLEAR 1 + >> CLEAR 1-1 + >> CLEAR 1 ====== CALL @@ -97,7 +97,7 @@ Syntax:: Example:: - <<< CALL 1-1 SEEK 400 + >> CALL 1-1 SEEK 400 ==== SWAP @@ -110,8 +110,8 @@ Syntax:: Example:: - <<< SWAP 1-1 1-2 - <<< SWAP 1-0 2-0 + >> SWAP 1-1 1-2 + >> SWAP 1-0 2-0 === ADD @@ -124,8 +124,8 @@ Syntax:: Example:: - <<< ADD 1 FILE output.mov CODEC DNXHD - <<< ADD 1 DECKLINK 1 + >> ADD 1 FILE output.mov CODEC DNXHD + >> ADD 1 DECKLINK 1 ====== REMOVE @@ -138,5 +138,5 @@ Syntax:: Example:: - <<< REMOVE 1 FILE - <<< REMOVE 1 DECKLINK 1 \ No newline at end of file + >> REMOVE 1 FILE + >> REMOVE 1 DECKLINK 1 \ No newline at end of file diff --git a/source/conf.py b/source/conf.py index 8c03c6d64..713121249 100644 --- a/source/conf.py +++ b/source/conf.py @@ -41,7 +41,7 @@ master_doc = 'index' # 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 diff --git a/source/consumers.rst b/source/consumers.rst index 41d4182a1..c879d26f8 100644 --- a/source/consumers.rst +++ b/source/consumers.rst @@ -1,3 +1,276 @@ ######### Consumers -######### \ No newline at end of file +######### + +============= +File Consumer +============= + +----------- +Diagnostics +----------- + +ffmpeg[*filename*] + ++---------------+-----------------------------------------------+--------+ +| Graph | Description | Scale | ++===============+===============================================+========+ +| frame-time | Time spent decoding the current frame. | fps/2 | ++---------------+-----------------------------------------------+--------+ + +---------- +Parameters +---------- + +The file consumer uses the same option syntax as ffmpeg. + +Note, not all options supported by ffmpeg have been implemented. + + +^^^^^^^^ +FILENAME +^^^^^^^^ + +Target filename. + +Syntax:: + + [filename:string] + +Example:: + + ADD 1 FILE test.mov -vcodec libx264 -crf 5 -preset ultrafast -tune fastdecode -s 1280x720 -r 50 -acodec aac -ab 128k + REMOVE 1 FILE + +================= +Bluefish Consumer +================= + +----------- +Diagnostics +----------- + +ffmpeg[*filename*] + ++---------------+-----------------------------------------------+--------+ +| Graph | Description | Scale | ++===============+===============================================+========+ +| frame-time | Time spent decoding the current frame. | fps/2 | ++---------------+-----------------------------------------------+--------+ +| sync-time | Time spent waiting for sync. | fps/2 | ++---------------+-----------------------------------------------+--------+ +| tick-time | Time between frames frame. | fps/2 | ++---------------+-----------------------------------------------+--------+ + +---------- +Parameters +---------- + +^^^^^^ +DEVICE +^^^^^^ + +Which BlueFish device to attach. + +Syntax:: + + [device:int] + +Configuration Syntax:: + + [1..] + +Example:: + + << ADD 1 BLUEFISH 1 + + +^^^^^^^^^^^^^^ +EMBEDDED_AUDIO +^^^^^^^^^^^^^^ + +Enables embedded-audio. + +Syntax:: + + EMBEDDED_AUDIO + +Default:: + + Disabled + +Configuration Syntax:: + + [true|false] + +Example:: + + << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO + +^^^^^^^^ +KEY_ONLY +^^^^^^^^ + +Displays key as fill. + +Default:: + + Disabled + +Syntax:: + + KEY_ONLY + +Configuration Syntax:: + + [true|false] + +Example:: + + << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO KEY_ONLY + + +================= +Decklink Consumer +================= + +----------- +Diagnostics +----------- + +ffmpeg[*filename*] + ++---------------+-----------------------------------------------+--------------+ +| Graph | Description | Scale | ++===============+===============================================+==============+ +| frame-time | Time spent decoding the current frame. | fps/2 | ++---------------+-----------------------------------------------+--------------+ +| sync-time | Time spent waiting for sync. | fps/2 | ++---------------+-----------------------------------------------+--------------+ +| tick-time | Time between frames frame. | fps/2 | ++---------------+-----------------------------------------------+--------------+ +| dropped-frame | Frame was dropped. | N/A | ++---------------+-----------------------------------------------+--------------+ +| late-frame | Frame was late. | N/A | ++---------------+-----------------------------------------------+--------------+ +| buffered-video| Frame was dropped. | fps | ++---------------+-----------------------------------------------+--------------+ +| buffered-audio| Frame was late. | cadence*2 | ++---------------+-----------------------------------------------+--------------+ + +---------- +Parameters +---------- + +^^^^^^ +DEVICE +^^^^^^ + +Which BlueFish device to attach. + +Syntax:: + + [device:int] + +Configuration Syntax:: + + [1..] + +Example:: + + << ADD 1 BLUEFISH 1 + + +^^^^^^^^^^^^^^ +EMBEDDED_AUDIO +^^^^^^^^^^^^^^ + +Enables embedded-audio. + +Syntax:: + + EMBEDDED_AUDIO + +Default:: + + Disabled + +Configuration Syntax:: + + [true|false] + +Example:: + + << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO + +^^^^^^^^ +KEY_ONLY +^^^^^^^^ + +Displays key as fill. + +Default:: + + Disabled + +Syntax:: + + KEY_ONLY + +Configuration Syntax:: + + [true|false] + +Example:: + + << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO KEY_ONLY + +^^^^^^^ +LATENCY +^^^^^^^ + +Set latency mode. + +Default:: + + normal + +Configuration Syntax:: + + [normal|low|default] + +^^^^^ +KEYER +^^^^^ + +Set keyer mode. + +Default:: + + external + +Configuration Syntax:: + + [external|internal|default] + +^^^^^^^^^^^^ +BUFFER_DEPTH +^^^^^^^^^^^^ + +Set buffer depth. Settings this value to low can cause output distortion. + +Default:: + + 3 + +Configuration Syntax:: + + [1..] + +=============== +Screen Consumer +=============== + +===================== +System Audio Consumer +===================== \ No newline at end of file diff --git a/source/data-commands.rst b/source/data-commands.rst index cfb4de056..702165666 100644 --- a/source/data-commands.rst +++ b/source/data-commands.rst @@ -15,7 +15,7 @@ Syntax:: Example:: - <<< DATA STORE my_data "Some useful data" + >> DATA STORE my_data "Some useful data" ============= DATA RETRIEVE @@ -28,8 +28,8 @@ Syntax:: Example:: - <<< DATA RETRIEVE my_data - >>> "Some usefule data" + >> DATA RETRIEVE my_data + << "Some usefule data" ========= DATA LIST @@ -41,5 +41,5 @@ Syntax:: Example:: - <<< DATA LIST - >>> my_data \ No newline at end of file + >> DATA LIST + << my_data \ No newline at end of file diff --git a/source/faq.rst b/source/faq.rst new file mode 100644 index 000000000..87c23148a --- /dev/null +++ b/source/faq.rst @@ -0,0 +1,3 @@ +### +FAQ +### \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index a36665cde..9c87e8695 100644 --- a/source/index.rst +++ b/source/index.rst @@ -9,12 +9,12 @@ Welcome to CasparCG's documentation! Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 3 :numbered: - producers - consumers - commands + producers.rst + consumers.rst + commands.rst Indices and tables ================== diff --git a/source/misc-commands.rst b/source/misc-commands.rst index 756dcd4b1..dddf5066c 100644 --- a/source/misc-commands.rst +++ b/source/misc-commands.rst @@ -12,7 +12,7 @@ Syntax:: Example:: - <<< DIAG + >> DIAG === BYE @@ -25,7 +25,7 @@ Syntax:: Example - <<< BYE + >> BYE ==== CHANNEL_GRID @@ -34,8 +34,8 @@ Opens a window displaying all the channels currently running on the server. Syntax:: - <<< CHANNEL_GRID + >> CHANNEL_GRID Example:: - <<< CHANNEL_GRID \ No newline at end of file + >> CHANNEL_GRID \ No newline at end of file diff --git a/source/mixer-commands.rst b/source/mixer-commands.rst index c885d59ef..291f6a576 100644 --- a/source/mixer-commands.rst +++ b/source/mixer-commands.rst @@ -14,7 +14,7 @@ Syntax:: Example:: - <<< MIXER 1-1 KEYER 1 + >> MIXER 1-1 KEYER 1 =========== MIXER BLEND @@ -29,7 +29,7 @@ Syntax:: Example:: - <<< MIXER 1-1 BLEND overlay + >> MIXER 1-1 BLEND overlay See:: @@ -46,7 +46,7 @@ Syntax:: Example:: - <<< MIXER 1-1 OPACITY 0.5 + >> MIXER 1-1 OPACITY 0.5 ================ MIXER BRIGTHNESS @@ -60,7 +60,7 @@ Syntax:: Example:: - <<< MIXER 1-1 BRIGTHNESS 0.5 + >> MIXER 1-1 BRIGTHNESS 0.5 ================ MIXER SATURATION @@ -75,7 +75,7 @@ Syntax:: Example:: - <<< MIXER 1-1 SATURATION 0.5 + >> MIXER 1-1 SATURATION 0.5 ============== MIXER CONTRAST @@ -90,7 +90,7 @@ Syntax:: Example:: - <<< MIXER 1-1 CONTRAST 0.5 + >> MIXER 1-1 CONTRAST 0.5 ============ MIXER LEVELS @@ -104,7 +104,7 @@ Syntax:: Example:: - <<< MIXER 1-1 LEVELS 0.1 0.1 1.0 0.9 0.9 + >> MIXER 1-1 LEVELS 0.1 0.1 1.0 0.9 0.9 ========== MIXER FILL @@ -117,7 +117,7 @@ Syntax:: Example:: - <<< MIXER 1-1 FILL 0.25 0.25 0.5 0.5 + >> MIXER 1-1 FILL 0.25 0.25 0.5 0.5 ========== MIXER CLIP @@ -130,7 +130,7 @@ Syntax:: Example:: - <<< MIXER 1-1 CLIP 0.25 0.25 0.5 0.5 + >> MIXER 1-1 CLIP 0.25 0.25 0.5 0.5 ========== MIXER GRID @@ -141,7 +141,7 @@ Creates a grid of video streams in ascending order of the layer index, i.e. if r Example:: - <<< MIXER 1 GRID 2 + >> MIXER 1 GRID 2 ============ MIXER VOLUME @@ -154,7 +154,7 @@ Syntax:: Example:: - <<< MIXER 1-1 VOLUME 0.5 + >> MIXER 1-1 VOLUME 0.5 =========== MIXER CLEAR @@ -170,5 +170,5 @@ Syntax:: Example:: - <<< MIXER 1-1 CLEAR + >> MIXER 1-1 CLEAR \ No newline at end of file diff --git a/source/producers.rst b/source/producers.rst index 89a986682..bd8cbaadd 100644 --- a/source/producers.rst +++ b/source/producers.rst @@ -3,16 +3,14 @@ Producers ######### =============== -FFMPEG Producer +ffmpeg Producer =============== --------------- Supported Media --------------- -The ffmpeg producer supports all files that the ffmpeg library (www.ffmpeg.org) can play. - -Support check is not dependent on file extension. +The ffmpeg producer supports all files that the "ffmpeg" library (www.ffmpeg.org) can play. ------- Filters @@ -24,7 +22,7 @@ The ffmpeg producer supports "libavfilter" filters through the "FILTER" paramete Diagnostics ----------- -ffmpeg[ *filename* | *video-mode* | *file-frame-number* / *file-nb-frames*] +ffmpeg[*filename* | *video-mode* | *file-frame-number* / *file-nb-frames*] +---------------+-----------------------------------------------+--------+ | Graph | Description | Scale | @@ -55,7 +53,7 @@ Syntax:: Example:: - >>> PLAY 1-1 MOVIE LOOP + << PLAY 1-1 MOVIE LOOP ^^^^ SEEK @@ -68,8 +66,21 @@ Syntax:: Example:: - >>> PLAY 1-1 MOVIE SEEK 100 LOOP + << PLAY 1-1 MOVIE SEEK 100 LOOP + +^^^^ +START (CasparCG 2.1) +^^^^ +Sets the start of the file. This point will be used while looping. + +Syntax:: + + START [frames:int] + +Example:: + << PLAY 1-1 MOVIE START 100 LOOP + ^^^^^^ LENGTH ^^^^^^ @@ -81,7 +92,7 @@ Syntax:: Example:: - >>> PLAY 1-1 MOVIE LENGTH 100 + << PLAY 1-1 MOVIE LENGTH 100 ^^^^^^ FILTER @@ -94,7 +105,7 @@ Syntax:: Example:: - >>> PLAY 1-1 MOVIE FILTER hflip:yadif=0:0 + << PLAY 1-1 MOVIE FILTER hflip:yadif=0:0 --------- Functions @@ -115,9 +126,9 @@ Returns Example:: - >>> CALL 1-1 LOOP 1 - >>> CALL 1-1 LOOP // Queries without changing. - <<< 1 + << CALL 1-1 LOOP 1 + << CALL 1-1 LOOP // Queries without changing. + >> 1 ^^^^ SEEK @@ -134,8 +145,34 @@ Returns Example:: - >>> CALL 1-1 SEEK 200 + << CALL 1-1 SEEK 200 +^^^^ +START (CasparCG 2.1) +^^^^ +Sets the start of the file. This point will be used while looping. + +Syntax:: + + START [frames:int] + +Example:: + + << CALL 1-1 START 100 + +^^^^^^ +LENGTH (CasparCG 2.1) +^^^^^^ +Sets the end of the file. + +Syntax:: + + LENGTH [frames:int] + +Example:: + + << CALL 1-1 LENGTH 100P + ============== Flash Producer ============== @@ -158,7 +195,7 @@ Supported Media Diagnostics ----------- -flash[ *template-host* | *video-mode*] +flash[*template-host* | *video-mode*] +---------------+-----------------------------------------------+--------+ | Graph | Description | Scale | @@ -183,7 +220,7 @@ Decklink Producer Diagnostics ----------- -flash[ *model-name* | *device-index* | *video-mode*] +flash[*model-name* | *device-index* | *video-mode*] +---------------+-----------------------------------------------+--------+ | Graph | Description | Scale | @@ -214,7 +251,7 @@ Syntax:: Example:: - >>> PLAY 1-1 DECKLINK 1 + << PLAY 1-1 DECKLINK 1 ^^^^^^ LENGTH @@ -227,7 +264,7 @@ Syntax:: Example:: - >>> PLAY 1-1 DECKLINK 1 LENGTH 100 + << PLAY 1-1 DECKLINK 1 LENGTH 100 ^^^^^^ FILTER @@ -240,7 +277,7 @@ Syntax:: Example:: - >>> PLAY 1-1 DECKLINK 1 FILTER hflip:yadif=0:0 + << PLAY 1-1 DECKLINK 1 FILTER hflip:yadif=0:0 ^^^^^^ FORMAT @@ -253,7 +290,7 @@ Syntax:: Example:: - >>> PLAY 1-1 DECKLINK 1 FORMAT PAL LENGTH 100 + << PLAY 1-1 DECKLINK 1 FORMAT PAL LENGTH 100 ============== Image Producer diff --git a/source/query-commands.rst b/source/query-commands.rst index 99d61851a..0b6d731d7 100644 --- a/source/query-commands.rst +++ b/source/query-commands.rst @@ -13,8 +13,8 @@ Syntax:: Example:: - <<< CINF movie - >>> ... + >> CINF movie + << ... === CLS @@ -27,8 +27,8 @@ Syntax:: Example:: - <<< CLS - >>> ... + >> CLS + << ... === TLS @@ -41,8 +41,8 @@ Syntax:: Example:: - <<< TLS - >>> ... + >> TLS + << ... ======= VERSION @@ -57,10 +57,10 @@ Syntax:: Example:: - <<< VERSION - >>> ... - <<< VERSION FLASH - >>> ... + >> VERSION + << ... + >> VERSION FLASH + << ... ==== INFO @@ -90,11 +90,11 @@ Syntax:: Example:: - <<< INFO - >>> ... - <<< INFO 1 - >>> ... - <<< INFO 1-1 - >>> ... - <<< INFO TEMPLATE my_table_template - >>> ... + >> INFO + << ... + >> INFO 1 + << ... + >> INFO 1-1 + << ... + >> INFO TEMPLATE my_table_template + << ... diff --git a/source/template-graphics-commands.rst b/source/template-graphics-commands.rst index 094ce42e3..57c65525f 100644 --- a/source/template-graphics-commands.rst +++ b/source/template-graphics-commands.rst @@ -37,7 +37,7 @@ Syntax:: Example:: - <<< CG 1-1 ADD 10 svtnews/info 1 + >> CG 1-1 ADD 10 svtnews/info 1 ========= CG REMOVE @@ -50,7 +50,7 @@ Syntax:: Example:: - <<< CG 1-1 REMOVE 1 + >> CG 1-1 REMOVE 1 ======== CG CLEAR @@ -63,7 +63,7 @@ Syntax:: Example:: - <<< CG 1-1 CLEAR + >> CG 1-1 CLEAR ======= CG PLAY @@ -76,7 +76,7 @@ Syntax:: Example:: - <<< CG 1-1 PLAY 1 + >> CG 1-1 PLAY 1 ======= CG STOP @@ -89,7 +89,7 @@ Syntax:: Example:: - <<< CG 1-1 STOP + >> CG 1-1 STOP ======= CG NEXT @@ -102,7 +102,7 @@ Syntax:: Example:: - <<< CG 1-1 NEXT 1 + >> CG 1-1 NEXT 1 ======= CG GOTO @@ -115,7 +115,7 @@ Syntax:: Example:: - <<< CG 1-1 GOTO 1 intro + >> CG 1-1 GOTO 1 intro ========= CG UPDATE @@ -128,7 +128,7 @@ Syntax:: Example:: - <<< CG 1-1 UPDATE 1 "Some data" + >> CG 1-1 UPDATE 1 "Some data" ========= CG INVOKE @@ -141,4 +141,4 @@ Syntax:: Example:: - <<< 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 -- 2.39.2