Documentation/Nightly/Modules/ScreenCapture - Revision history

Lasso: moved to readthedocs

2021-06-02T21:06:36Z

moved to readthedocs

2016-09-28T16:30:14Z

2016-09-16T02:58:06Z

2016-09-15T20:06:51Z

Added Linux setup instructions

2016-09-15T13:50:39Z

2016-09-14T18:19:20Z

2016-09-14T18:04:30Z

2016-09-14T17:57:40Z

2016-09-14T16:29:58Z

2016-09-12T21:18:10Z

@@ Line 4: / Line 4: @@
 <!-- ---------------------------- -->
-<!-- ---------------------------- -->
+{{documentation/banner
-{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
+| text  = [http://slicer.readthedocs.io/en/latest/user_guide/modules/screencapture.html This page has been moved to read-the-docs.]
-{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
+| background-color = 8FBC8F }}

@@ Line 56: / Line 56: @@
 ** '''Image file name pattern:''' Defines image file naming pattern. %05d will be replaced by the image number (5 numbers, padded with zeros). Only needed if video export is not selected.
 === Setting up ffmpeg ===
-FFmpeg library is not packaged with 3D Slicer due to licensing restrictions. The FFmpeg library has to be downloaded and set up only once and 3D Slicer will remember its location.
+FFmpeg library is not packaged with 3D Slicer due to large package size and licensing requirements for some video compression methods (see https://ffmpeg.org/legal.html). The FFmpeg library has to be downloaded and set up only once and 3D Slicer will remember its location.
 ==== Windows setup instructions ====
 * Download ffmpeg from here: https://ffmpeg.org/download.html (click Windows icon, select a package, for example 'Download FFmpeg64-bit static')

@@ Line 44: / Line 44: @@
 *** Parameters ''-i'' (input files), ''-y'' (overwrite without asking), ''-r'' (frame rate) ''-start_number'' are specified by the module and therefore should not be included in the extra options.
 *** Examples:
-**** Add a watermark image (MyLogo.png, 10 pixels from the top-right corner): ''-vf movie=MyLogo.png[watermark];[in][watermark]overlay=main_w-overlay_w-10:10[out]''
+**** Add a watermark image (MyLogo.png, 10 pixels from the top-right corner) to exported H.264 or MPEG-4 videos:
 **** Set grayscale animated GIF width to 200 pixels: ''-vf format=gray,scale=200:-1''
 **** Set color animated GIF width to 200 pixels: ''-filter_complex [0:v]scale=200:-1[scaled];[0:v]palettegen[pal];[scaled][pal]paletteuse''

@@ Line 55: / Line 55: @@
 === Setting up ffmpeg ===
 FFmpeg library is not packaged with 3D Slicer due to licensing restrictions. The FFmpeg library has to be downloaded and set up only once and 3D Slicer will remember its location.
-* '''Windows''' setup instructions
+==== Windows setup instructions ====
-** Download ffmpeg from here: https://ffmpeg.org/download.html (click Windows icon, select a package, for example 'Download FFmpeg64-bit static')
+* Download ffmpeg from here: https://ffmpeg.org/download.html (click Windows icon, select a package, for example 'Download FFmpeg64-bit static')
-** Extract downloaded package (for example, to ''C:\Users\Public'')
+* Extract downloaded package (for example, to ''C:\Users\Public'')
-** In ''Advanced'' section, ''ffmpeg executable'': select path for ''ffmpeg.exe'' (for example, ''C:\Users\Public\ffmpeg-20160912-bc7066f-win32-static\bin\ffmpeg.exe'')
+* In ''Advanced'' section, ''ffmpeg executable'': select path for ''ffmpeg.exe'' (for example, ''C:\Users\Public\ffmpeg-20160912-bc7066f-win32-static\bin\ffmpeg.exe'')
-* '''MacOS''' setup instructions
-** Install homebrew (from http://brew.sh/)
+==== MacOS setup instructions ====
-** Run: ''brew install ffmpeg''
+* Install homebrew (from http://brew.sh/)
-** In ''Advanced'' section, ''ffmpeg executable'': select ''/usr/local/bin/ffmpeg''.
+* Run: ''brew install ffmpeg''
 <!-- ---------------------------- -->

@@ Line 18: / Line 18: @@
 <!-- ---------------------------- -->
-<!-- {{documentation/{{documentation/version}}/module-section|Use Cases}} -->
+{{documentation/{{documentation/version}}/module-section|Use Cases}}
 <!-- ---------------------------- -->
@@ Line 25: / Line 26: @@
 ** '''View to capture:''' select slice or 3D view that the content will be captured of
 ** '''Animation mode:'''
-*** 3D rotation: Acquire video of a rotating 3D view (for 3D viewer only). For smooth repeated display of a 360-degree rotation it is recommended to choose 31 or 61 as "Number of images". [https://youtu.be/LG5H66ikF1w Sample video on YouTube]<br>[[File:SlicerCaptureRotation.gif]]
+*** 3D rotation: Acquire video of a rotating 3D view (for 3D viewer only). For smooth repeated display of a 360-degree rotation it is recommended to choose 31 or 61 as "Number of images".<br>[[File:SlicerCaptureRotation.gif]]
 *** slice sweep: Acquire video while going through selected range of image frames (for slice viewer only).<br>[[File:SlicerCaptureSweep.gif]]
 *** slice fade: Acquire video while fading between the foreground and background image (for slice viewer only).<br>[[File:SlicerCaptureFade.gif]]

@@ Line 43: / Line 43: @@
 *** Parameters ''-i'' (input files), ''-y'' (overwrite without asking), ''-r'' (frame rate) ''-start_number'' are specified by the module and therefore should not be included in the extra options.
 *** Examples:
-**** Add a logo (MyLogo.png) to the top-left corner of your video: ''-vf movie=MyLogo.png[watermark];[in][watermark]overlay=main_w-overlay_w-10:10[out]''
+**** Add a watermark image (MyLogo.png, 10 pixels from the top-right corner): ''-vf movie=MyLogo.png[watermark];[in][watermark]overlay=main_w-overlay_w-10:10[out]''
 **** Set animated GIF width to 200 pixels: ''-vf format=gray,scale=200:-1''
 *** More information about available options:

@@ Line 42: / Line 42: @@
 ** '''Video extra options:''' Options for ffmpeg that controls video format and quality. Only needed if video export is selected.
 *** Parameters ''-i'' (input files), ''-y'' (overwrite without asking), ''-r'' (frame rate) ''-start_number'' are specified by the module and therefore should not be included in the extra options.
-*** Scaling of output image: use scale filter. For example, set grayscale gif output image width to 200: ''-vf format=gray,scale=200:-1''
+*** Examples:
 *** https://trac.ffmpeg.org/wiki/Encode/H.264
-*** https://trac.ffmpeg.org/wiki/Encode/MPEG-4
+**** https://trac.ffmpeg.org/wiki/Encode/MPEG-4
-*** https://trac.ffmpeg.org/wiki/Encode/YouTube
+**** https://trac.ffmpeg.org/wiki/Encode/YouTube
-*** https://ffmpeg.org/ffmpeg-all.html
+**** https://ffmpeg.org/ffmpeg-all.html
 ** '''Image file name pattern:''' Defines image file naming pattern. %05d will be replaced by the image number (5 numbers, padded with zeros). Only needed if video export is not selected.
 === Setting up ffmpeg ===