Class D3D12FisheyeDewarpBlock

Namespace

VisioForge.Core.MediaBlocks.VideoProcessing

Assembly

VisioForge.Core.dll

Direct3D 12 block that dewarps a fisheye image on the GPU into an equirectangular, panorama or perspective view, set by VisioForge.Core.Types.X.VideoEffects.D3D12FisheyeDewarpSettings.Projection. The view (rotation, field of view, region of interest, viewport) can be changed while the pipeline runs: change VisioForge.Core.MediaBlocks.VideoProcessing.D3D12FisheyeDewarpBlock.Settings and call VisioForge.Core.MediaBlocks.VideoProcessing.D3D12FisheyeDewarpBlock.Update. The output has the input's size, format and frame rate; add a resize block after it for another size. The block moves frames to and from the GPU itself: its input and its output each take system, D3D11 or D3D12 memory, whichever the neighbouring block uses, and D3D12 memory on the block's own adapter passes through without a copy on both sides. Requires a Direct3D 12 capable GPU. VisioForge.Core.MediaBlocks.OpenCV.CVDewarpBlock is the CPU alternative. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals.

public class D3D12FisheyeDewarpBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

object

MediaBlock

D3D12FisheyeDewarpBlock

Implements

IMediaBlock

IDisposable

IMediaBlockInternals

Inherited Members

MediaBlock._isBuilt

MediaBlock._pipeline

MediaBlock._pipelineCtx

MediaBlock.GetPipelineContext()

MediaBlock.SetPipelineContext(BlockPipelineContext)

MediaBlock.SetPipeline(MediaBlocksPipeline)

MediaBlock.Context

MediaBlock.Name

MediaBlock.IsBuilt

MediaBlock.Owner

MediaBlock.Type

MediaBlock.ID

MediaBlock.Input

MediaBlock.Inputs

MediaBlock.Output

MediaBlock.Outputs

MediaBlock.HasInputs

MediaBlock.HasOutputs

MediaBlock.Build()

MediaBlock.CreateElements()

MediaBlock.AddElementsToPipeline()

MediaBlock.RemoveElementsFromPipeline()

MediaBlock.DeepCopy(string)

MediaBlock.Reset()

MediaBlock.ClearPads()

MediaBlock.Dispose(bool)

MediaBlock.Dispose()

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Extension Methods

MediaBlockExtensions.GetInputPadByType(IMediaBlock, MediaBlockPadMediaType)

MediaBlockExtensions.GetOutputPadByType(IMediaBlock, MediaBlockPadMediaType)

MediaBlockHelper.SendEndOfStream(MediaBlock)

MediaBlockHelper.SendEvent(MediaBlock, Event)

MediaBlockHelper.SetState(MediaBlock, State)

Constructors

D3D12FisheyeDewarpBlock(D3D12FisheyeDewarpSettings)

Initializes a new instance of the VisioForge.Core.MediaBlocks.VideoProcessing.D3D12FisheyeDewarpBlock class.

public D3D12FisheyeDewarpBlock(D3D12FisheyeDewarpSettings settings)

Parameters

settings D3D12FisheyeDewarpSettings

The dewarping settings.

Exceptions

ArgumentNullException

settings is null.

Properties

Input

Gets the input.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets the inputs.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the output.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets the outputs.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Settings

Gets the dewarping settings. They are applied when the block is built, and again by VisioForge.Core.MediaBlocks.VideoProcessing.D3D12FisheyeDewarpBlock.Update.

public D3D12FisheyeDewarpSettings Settings { get; }

Property Value

D3D12FisheyeDewarpSettings

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Builds the block.

public override bool Build()

Returns

bool

true if successful, false otherwise.

CleanUp()

Releases the GStreamer elements and resets the build state.

public void CleanUp()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetCore()

Gets the core BaseElement wrapper.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper of the upload, dewarp and download elements.

GetElement()

Gets the underlying GStreamer d3d12fisheyedewarp element. VisioForge.Core.MediaBlocks.VideoProcessing.D3D12FisheyeDewarpBlock.Update writes only the settings that changed since its own last write, so a property set directly on this element is not restored by an VisioForge.Core.MediaBlocks.VideoProcessing.D3D12FisheyeDewarpBlock.Update that leaves that setting unchanged.

public Element GetElement()

Returns

Element

The d3d12fisheyedewarp element, or null before the block is built.

IsAvailable()

Determines whether this media block is available. Correct NuGet SDK redist should be included into your project. It does not check for a Direct3D 12 GPU: a missing device is reported as a pipeline error on start.

public static bool IsAvailable()

Returns

bool

true if this media block is available; otherwise, false.

Update()

Applies the current VisioForge.Core.MediaBlocks.VideoProcessing.D3D12FisheyeDewarpBlock.Settings to the running dewarper. The element takes them one property at a time, so a frame rendered during the call may show part of the change; the next one shows all of it. VisioForge.Core.Types.X.VideoEffects.D3D12FisheyeDewarpSettings.AdapterIndex is not changed after the block is built. Before the block is built it only checks the settings: the build applies them, the adapter as it is when the build starts.

public bool Update()

Returns

bool

true if the settings were applied, or are valid and the block is not running; false if they are invalid, with the cause reported as a pipeline error once the block is in a pipeline.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Associates this block with a pipeline.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The pipeline.

See Also

MediaBlock

IMediaBlockInternals