Class ScaleTempoBlock

Namespace

VisioForge.Core.MediaBlocks.AudioProcessing

Assembly

VisioForge.Core.dll

Audio tempo scaling block that changes playback speed without affecting pitch. This block provides high-quality time-stretching and pitch-shifting capabilities using advanced algorithms to modify audio tempo while preserving pitch quality. Features configurable rate scaling, overlap processing, search windows, and stride lengths for optimal audio quality. Essential for music production, audio editing, speech processing, and media playback applications requiring tempo adjustments without pitch distortion. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class ScaleTempoBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

object

MediaBlock

ScaleTempoBlock

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.ToYAMLBlock()

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

ScaleTempoBlock()

Initializes a new instance of the VisioForge.Core.MediaBlocks.AudioProcessing.ScaleTempoBlock class with default tempo scaling settings.

public ScaleTempoBlock()

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[]

Overlap

Gets or sets the percentage of stride to overlap for smoother transitions. Higher values provide better quality but increased processing overhead. Default: 0.2.

public double Overlap { get; set; }

Property Value

double

Rate

Gets or sets the tempo scaling rate multiplier. Values greater than 1.0 increase playback speed, values less than 1.0 decrease speed.

public double Rate { get; set; }

Property Value

double

Search

Gets or sets the search window duration for finding optimal overlap positions. Longer search times improve quality but increase processing time. Default: 14 ms.

public TimeSpan Search { get; set; }

Property Value

TimeSpan

Stride

Gets or sets the output length for each processing stride. Shorter strides provide better quality but higher CPU usage. Default: 30 ms.

public TimeSpan Stride { get; set; }

Property Value

TimeSpan

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the scale tempo filter and its associated GStreamer elements. This method creates the filter with the specified tempo scaling parameters, establishes input and output pads, and prepares the block for time-stretching audio without pitch distortion.

public override bool Build()

Returns

bool

true if the filter was successfully built and configured; false if initialization failed.

CleanUp()

Releases all resources and performs cleanup operations for this tempo scaling block. This method disposes of 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 that provides additional functionality around the GStreamer scale tempo filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer scale tempo filter.

GetElement()

Gets the underlying GStreamer element that performs the tempo scaling processing.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the scale tempo filter.

IsAvailable()

Determines whether this media block is available. Correct NuGet SDK redist should be included into your project.

public static bool IsAvailable()

Returns

bool

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

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Associates this tempo scaling block with a pipeline and initializes its internal context. This method is called internally when the block is added to a pipeline.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The MediaBlocksPipeline instance that will manage this block.

See Also

MediaBlock

IMediaBlockInternals

IDisposable