Spherical Video PTZ/User Guide/Quick Start Guide: Difference between revisions

Spherical Video PTZ/User Guide/Quick Start Guide (view source)

Revision as of 18:59, 22 March 2024

1,808 bytes added , 22 March

no edit summary

Jmora

264

edits

@@ Line 49: / Line 49: @@
 ===Overview===
 ====Features====
-* CUDA-accelerated PTZ transformations.
+* '''CUDA-accelerated PTZ transformations:''' Leverage the power of NVIDIA CUDA technology. This acceleration helps with a smooth and high-performance video processing.
-* Support for RGBA video format.
+* '''Support for RGBA video format.'''
-* Dynamic parameter adjustments for pan, tilt, and zoom.
+* '''Dynamic parameter adjustments:''' Users can dynamically adjust PTZ parameters such as pan, tilt, and zoom during playback, providing a versatile and interactive video experience.
 ====Properties====
-* Rotate the video on its horizontal axis. Range: -360 to 360 degrees. Default: 0.
+The GstRrPanoramaptz plugin introduces three primary properties for real-time video manipulation:
-* Rotate the video on its vertical axis. Range: -360 to 360 degrees. Default: 0.
-* Dynamic parameter adjustments for pan, tilt, and zoom. ''WIP''
+* Pan (Horizontal Rotation): Adjusts the video feed's horizontal orientation. Pan adjustments allow viewers to rotate the video around its vertical axis, simulating a left or right looking direction.
+** Syntax: <code>pan=<value></code>.
+** Range:  <code>-360 to 360</code>  degrees.
+** Default:  <code>0</code>.
+* Tilt (Vertical Rotation): This property adjusts the vertical viewing angle of the video feed. It simulates a vertical rotation of the camera view.
+** Syntax: <code>tilt=<value></code>.
+** Range:  <code>-360 to 360</code>  degrees.
+** Default:  <code>0</code>.
+* Zoom (Vertical Rotation): This property adjusts the zoom level of the video feed. It simulates moving the camera closer or further away from the scene.
+** Syntax: <code>zoom=<value></code>.
+** Range:  <code>0.1 to 10</code>.
+** Behavior: '''Zoom out''' for <code>zoom < 1</code>, '''Zoom in''' for  <code>zoom > 1</code>.
+** Default:  <code>1</code>.
 ====Caps and Formats====
-* Accepts and outputs video in video/x-raw format with RGBA color space.
+* The plugin accepts and outputs video in the <code>video/x-raw</code> format, utilizing the RGBA color space. This support ensures compatibility with a wide range of video processing scenarios.
-* Supports both system memory and NVMM memory inputs for enhanced performance on NVIDIA hardware.
+* Enhanced performance on NVIDIA hardware is achieved through support for both system memory and NVMM (NVIDIA Multi-Media) memory inputs. This flexibility allows users to optimize their video processing pipelines based on the available hardware resources.
 ====Basic use example====
-To pan a test video source 90 degrees, you can use the following pipeline:
+This pipeline creates a test video, then applies a 0.5-degree rotation to the right, tilts it upwards by 0.5 degrees, and enhances the view with a zoom level of 2.
 <syntaxhighlight>
-gst-launch-1.0 videotestsrc ! rrpanoramaptz zoom=2 ! fakesink
+gst-launch-1.0 videotestsrc ! "video/x-raw,width=1920,height=1080" ! rrpanoramaptz pan=0.5 tilt=0.5 zoom=2 ! videoconvert ! autovideosink
 </syntaxhighlight>
+You should see an output as the one below:
+[[File:equirectangular-mountain-libpanorama-example.png|thumbnail|center|640px|Libpanorama example]]
+The example uses a standard video, not a panoramic one, causing some distortion, but we'll explore distortion-free examples with equirectangular images soon.
 <noinclude>
 {{Spherical Video PTZ/Foot||}}
 </noinclude>