Documentation/Nightly/Developers/CompressedVideo - Revision history

Sunderlandkyl: Add streaming section

2019-11-14T20:11:02Z

Add streaming section

Sunderlandkyl at 19:56, 14 November 2019

2019-11-14T19:56:10Z

Sunderlandkyl at 19:55, 14 November 2019

2019-11-14T19:55:09Z

Sunderlandkyl at 19:53, 14 November 2019

2019-11-14T19:53:21Z

Sunderlandkyl at 19:50, 14 November 2019

2019-11-14T19:50:31Z

Sunderlandkyl at 19:48, 14 November 2019

2019-11-14T19:48:39Z

Sunderlandkyl: Add compressed video page

2019-11-14T19:47:50Z

Add compressed video page

New page

<noinclude>{{documentation/versioncheck}}</noinclude>
{{Clear}}{{TOC right}}

= Slicer Compressed Video Overview and Acknowledgements =
Slicer provides infrastructure for visualizing, and managing compressed video frames.
Compressed video data is stored in a volume node that performs automatic encoding and decoding as needed.
In conjunction with the Sequences and SlicerIGSIO modules, it is also possible to playback and record video sequences in a compressed format.
These compressed video sequences can be read and written to a video container format that can be played back in any supporting media player.

Authors: 
Kyle Sunderland (PerkLab, Queen's University) 
Andras Lasso (PerkLab, Queen's University) 

Acknowledgements:
Development was funded in part by CANARIE’s Research Software Program.

= Architecture =
== Frame Management ==

; [{{doxygen-class-url|vtkStreamingVolumeFrame}} vtkStreamingVolumeFrame]
: Contains the frame data and metadata information.
: Represents the [https://en.wikipedia.org/wiki/Video_compression_picture_types frame type], codec, decoded frame size, and a vtkUnsignedCharArray representing the encoded frame data.
: The frame also contains a pointer to the previous frame that must be decoded before the current frame can be decoded.
; [{{doxygen-class-url|vtkStreamingVolumeCodec}} vtkStreamingVolumeCodec]
: Decodes/Encodes the vtkStreamingVolumeFrame to convert the contents to/from vtkImageData.
: When decoding a frame, it will compare against the last decoded frame and decode as many previous frames as necessary for the current frame.
; [{{doxygen-class-url|vtkStreamingVolumeCodecFactory}} vtkStreamingVolumeCodecFactory]
: Factory for registering availiable codecs.
: Can create a new codec given a [http://www.fourcc.org/ FOURCC].

== MRML Nodes ==
; [{{doxygen-class-url|vtkMRMLStreamingVolumeNode}} vtkMRMLStreamingVolumeNode]
: Represents a volume created from a compressed video frame.
: Automatically decodes the frame when it is set and GetImageData() is called, or if there are observers on the vtkImageData.

= Available Codecs and Video Containers Formats =
The following codecs and video container formats are available in Slicer.
 

Codecs
* Uncompressed RGB: Included in Slicer
* VP9: Included in the SlicerIGSIO extension
 

Video containers
* MKV: Included in the SlicerIGSIO extension

= Future Work =
* Add support for additional codecs
* Add support for additional video container formats

@@ Line 34: / Line 34: @@
 :Represents a volume created from a compressed video frame.
 :Automatically decodes the frame when it is set and GetImageData() is called, or if there are observers on the vtkImageData.
 =Available codecs and video containers=

@@ Line 36: / Line 36: @@
 =Available codecs and video containers=
-The following codecs and video container formats are available in Slicer.
+The following codecs and video container formats are available in Slicer:
 <br />

@@ Line 20: / Line 20: @@
 ;[{{doxygen-class-url|vtkStreamingVolumeFrame}} vtkStreamingVolumeFrame]
 :Contains the frame data and metadata information.
-:Represents the [https://en.wikipedia.org/wiki/Video_compression_picture_types frame type], codec, decoded frame size, and a vtkUnsignedCharArray representing the encoded frame data.
+:Represents the [https://en.wikipedia.org/wiki/Video_compression_picture_types frame type], codec, decoded frame dimensions, and a vtkUnsignedCharArray representing the encoded frame data.
 :The frame also contains a pointer to the previous frame that must be decoded before the current frame can be decoded.
 ;[{{doxygen-class-url|vtkStreamingVolumeCodec}} vtkStreamingVolumeCodec]
@@ Line 47: / Line 47: @@
 <br />
 <b>Video containers</b>
 *MKV: Included in the SlicerIGSIO extension

@@ Line 39: / Line 39: @@
 <br />
 <b>Codecs</b>
@@ Line 45: / Line 46: @@
 <br />
 <b>Video containers</b>
 *MKV: Included in the SlicerIGSIO extension

@@ Line 2: / Line 2: @@
 {{Clear}}{{TOC right}}
-=Slicer Compressed Video Overview and Acknowledgements=
+=Slicer compressed video overview and acknowledgements=
 Slicer provides infrastructure for visualizing, and managing compressed video frames.
 Compressed video data is stored in a volume node that performs automatic encoding and decoding as needed.
@@ Line 16: / Line 16: @@
 =Architecture=
-==Frame Management==
+==Frame management==
 ;[{{doxygen-class-url|vtkStreamingVolumeFrame}} vtkStreamingVolumeFrame]
@@ Line 29: / Line 29: @@
 :Can create a new codec given a [http://www.fourcc.org/ FOURCC].
-==MRML Nodes==
+==MRML nodes==
 ;[{{doxygen-class-url|vtkMRMLStreamingVolumeNode}} vtkMRMLStreamingVolumeNode]
@@ Line 35: / Line 35: @@
 :Automatically decodes the frame when it is set and GetImageData() is called, or if there are observers on the vtkImageData.
-=Available Codecs and Video Containers Formats=
+=Available codecs and video containers=
 The following codecs and video container formats are available in Slicer.
 <br />
@@ Line 50: / Line 50: @@
 *MKV: Included in the SlicerIGSIO extension
-=Future Work=
+=Future work=
 *Add support for additional codecs
 *Add support for additional video container formats

@@ Line 2: / Line 2: @@
 {{Clear}}{{TOC right}}
-= Slicer Compressed Video Overview and Acknowledgements =
+=Slicer Compressed Video Overview and Acknowledgements=
 Slicer provides infrastructure for visualizing, and managing compressed video frames.
 Compressed video data is stored in a volume node that performs automatic encoding and decoding as needed.
@@ Line 8: / Line 8: @@
 These compressed video sequences can be read and written to a video container format that can be played back in any supporting media player.
-Authors:<br>
+Authors: <br>
 <b>Kyle Sunderland</b> (PerkLab, Queen's University) <br>
 <b>Andras Lasso</b> (PerkLab, Queen's University) <br>
-Acknowledgements:
+Acknowledgements: <br>
 Development was funded in part by CANARIE’s Research Software Program.
-= Architecture =
+=Architecture=
-== Frame Management ==
+==Frame Management==
-; [{{doxygen-class-url|vtkStreamingVolumeFrame}} vtkStreamingVolumeFrame]
+;[{{doxygen-class-url|vtkStreamingVolumeFrame}} vtkStreamingVolumeFrame]
-: Contains the frame data and metadata information.
+:Contains the frame data and metadata information.
-: Represents the [https://en.wikipedia.org/wiki/Video_compression_picture_types frame type], codec, decoded frame size, and a vtkUnsignedCharArray representing the encoded frame data.
+:Represents the [https://en.wikipedia.org/wiki/Video_compression_picture_types frame type], codec, decoded frame size, and a vtkUnsignedCharArray representing the encoded frame data.
-: The frame also contains a pointer to the previous frame that must be decoded before the current frame can be decoded.
+:The frame also contains a pointer to the previous frame that must be decoded before the current frame can be decoded.
-; [{{doxygen-class-url|vtkStreamingVolumeCodec}} vtkStreamingVolumeCodec]
+;[{{doxygen-class-url|vtkStreamingVolumeCodec}} vtkStreamingVolumeCodec]
-: Decodes/Encodes the vtkStreamingVolumeFrame to convert the contents to/from vtkImageData.
+:Decodes/Encodes the vtkStreamingVolumeFrame to convert the contents to/from vtkImageData.
-: When decoding a frame, it will compare against the last decoded frame and decode as many previous frames as necessary for the current frame.
+:When decoding a frame, it will compare against the last decoded frame and decode as many previous frames as necessary for the current frame.
-; [{{doxygen-class-url|vtkStreamingVolumeCodecFactory}} vtkStreamingVolumeCodecFactory]
+;[{{doxygen-class-url|vtkStreamingVolumeCodecFactory}} vtkStreamingVolumeCodecFactory]
-: Factory for registering availiable codecs.
+:Factory for registering availiable codecs.
-: Can create a new codec given a [http://www.fourcc.org/ FOURCC].
+:Can create a new codec given a [http://www.fourcc.org/ FOURCC].
-== MRML Nodes ==
+==MRML Nodes==
-= Available Codecs and Video Containers Formats =
+;[{{doxygen-class-url|vtkMRMLStreamingVolumeNode}} vtkMRMLStreamingVolumeNode]
 The following codecs and video container formats are available in Slicer.
-<br/>
+<br />
 <b>Codecs</b>
 * Uncompressed RGB: Included in Slicer
-* VP9: Included in the SlicerIGSIO extension
+*Uncompressed RGB: Included in Slicer
-<br/>
+*VP9: Included in the SlicerIGSIO extension
 <b>Video containers</b>
-= Future Work =
+*MKV: Included in the SlicerIGSIO extension
 * Add support for additional codecs
-* Add support for additional video container formats
+=Future Work=