Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.GstVideo.Structs.VideoOverlayComposition

Contents

Exported types
Methods

Description

<refsect2> <para> Functions to create and handle overlay compositions on video buffers. </para> <para> An overlay composition describes one or more overlay rectangles to be blended on top of a video buffer. </para> <para> This API serves two main purposes: <itemizedlist> <listitem> it can be used to attach overlay information (subtitles or logos) to non-raw video buffers such as GL/VAAPI/VDPAU surfaces. The actual blending of the overlay can then be done by e.g. the video sink that processes these non-raw buffers. </listitem> <listitem> it can also be used to blend overlay rectangles on top of raw video buffers, thus consolidating blending functionality for raw video in one place. </listitem> Together, this allows existing overlay elements to easily handle raw and non-raw video as input in without major changes (once the overlays have been put into a GstOverlayComposition object anyway) - for raw video the overlay can just use the blending function to blend the data on top of the video, and for surface buffers it can just attach them to the buffer and let the sink render the overlays. </itemizedlist> </para> </refsect2>

Synopsis

Exported types

newtype VideoOverlayComposition Source #

Constructors

VideoOverlayComposition (ManagedPtr VideoOverlayComposition)

Instances

BoxedObject VideoOverlayComposition Source #
Methods boxedType :: VideoOverlayComposition -> IO GType #
((~) * info (ResolveVideoOverlayCompositionMethod t VideoOverlayComposition), MethodInfo * info VideoOverlayComposition p) => IsLabel t (VideoOverlayComposition -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> VideoOverlayComposition -> p #
((~) * info (ResolveVideoOverlayCompositionMethod t VideoOverlayComposition), MethodInfo * info VideoOverlayComposition p) => IsLabelProxy t (VideoOverlayComposition -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> VideoOverlayComposition -> p #
HasAttributeList * VideoOverlayComposition Source #

((~) * signature (m Word32), MonadIO m) => MethodInfo * VideoOverlayCompositionNRectanglesMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionNRectanglesMethodInfo VideoOverlayComposition -> signature -> s #
((~) * signature (m VideoOverlayComposition), MonadIO m) => MethodInfo * VideoOverlayCompositionMakeWritableMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionMakeWritableMethodInfo VideoOverlayComposition -> signature -> s #
((~) * signature (m Word32), MonadIO m) => MethodInfo * VideoOverlayCompositionGetSeqnumMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionGetSeqnumMethodInfo VideoOverlayComposition -> signature -> s #
((~) * signature (Word32 -> m VideoOverlayRectangle), MonadIO m) => MethodInfo * VideoOverlayCompositionGetRectangleMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionGetRectangleMethodInfo VideoOverlayComposition -> signature -> s #
((~) * signature (m VideoOverlayComposition), MonadIO m) => MethodInfo * VideoOverlayCompositionCopyMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionCopyMethodInfo VideoOverlayComposition -> signature -> s #
((~) * signature (VideoFrame -> m Bool), MonadIO m) => MethodInfo * VideoOverlayCompositionBlendMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionBlendMethodInfo VideoOverlayComposition -> signature -> s #
((~) * signature (VideoOverlayRectangle -> m ()), MonadIO m) => MethodInfo * VideoOverlayCompositionAddRectangleMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionAddRectangleMethodInfo VideoOverlayComposition -> signature -> s #
type AttributeList VideoOverlayComposition Source #
type AttributeList VideoOverlayComposition

noVideoOverlayComposition :: Maybe VideoOverlayComposition Source #

Methods

addRectangle

data VideoOverlayCompositionAddRectangleMethodInfo Source #

Instances

((~) * signature (VideoOverlayRectangle -> m ()), MonadIO m) => MethodInfo * VideoOverlayCompositionAddRectangleMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionAddRectangleMethodInfo VideoOverlayComposition -> signature -> s #

videoOverlayCompositionAddRectangle Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoOverlayComposition	`comp`: a `VideoOverlayComposition`
-> VideoOverlayRectangle	`rectangle`: a `VideoOverlayRectangle` to add to the composition
-> m ()

Adds an overlay rectangle to an existing overlay composition object. This must be done right after creating the overlay composition.

blend

data VideoOverlayCompositionBlendMethodInfo Source #

Instances

((~) * signature (VideoFrame -> m Bool), MonadIO m) => MethodInfo * VideoOverlayCompositionBlendMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionBlendMethodInfo VideoOverlayComposition -> signature -> s #

videoOverlayCompositionBlend Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoOverlayComposition	`comp`: a `VideoOverlayComposition`
-> VideoFrame	`videoBuf`: a `VideoFrame` containing raw video data in a supported format. It should be mapped using GST_MAP_READWRITE
-> m Bool

Blends the overlay rectangles in comp on top of the raw video data contained in videoBuf. The data in videoBuf must be writable and mapped appropriately.

Since videoBuf data is read and will be modified, it ought be mapped with flag GST_MAP_READWRITE.

copy

data VideoOverlayCompositionCopyMethodInfo Source #

Instances

((~) * signature (m VideoOverlayComposition), MonadIO m) => MethodInfo * VideoOverlayCompositionCopyMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionCopyMethodInfo VideoOverlayComposition -> signature -> s #

videoOverlayCompositionCopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoOverlayComposition	`comp`: a `VideoOverlayComposition` to copy
-> m VideoOverlayComposition	Returns: a new `VideoOverlayComposition` equivalent to `comp`.

Makes a copy of comp and all contained rectangles, so that it is possible to modify the composition and contained rectangles (e.g. add additional rectangles or change the render co-ordinates or render dimension). The actual overlay pixel data buffers contained in the rectangles are not copied.

getRectangle

data VideoOverlayCompositionGetRectangleMethodInfo Source #

Instances

((~) * signature (Word32 -> m VideoOverlayRectangle), MonadIO m) => MethodInfo * VideoOverlayCompositionGetRectangleMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionGetRectangleMethodInfo VideoOverlayComposition -> signature -> s #

videoOverlayCompositionGetRectangle Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoOverlayComposition	`comp`: a `VideoOverlayComposition`
-> Word32	`n`: number of the rectangle to get
-> m VideoOverlayRectangle	Returns: the `n`-th rectangle, or NULL if `n` is out of bounds. Will not return a new reference, the caller will need to obtain her own reference using `gst_video_overlay_rectangle_ref()` if needed.

Returns the n-th VideoOverlayRectangle contained in comp.

getSeqnum

data VideoOverlayCompositionGetSeqnumMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * VideoOverlayCompositionGetSeqnumMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionGetSeqnumMethodInfo VideoOverlayComposition -> signature -> s #

videoOverlayCompositionGetSeqnum Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoOverlayComposition	`comp`: a `VideoOverlayComposition`
-> m Word32	Returns: the sequence number of `comp`

Returns the sequence number of this composition. Sequence numbers are monotonically increasing and unique for overlay compositions and rectangles (meaning there will never be a rectangle with the same sequence number as a composition).

makeWritable

data VideoOverlayCompositionMakeWritableMethodInfo Source #

Instances

((~) * signature (m VideoOverlayComposition), MonadIO m) => MethodInfo * VideoOverlayCompositionMakeWritableMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionMakeWritableMethodInfo VideoOverlayComposition -> signature -> s #

videoOverlayCompositionMakeWritable Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoOverlayComposition	`comp`: a `VideoOverlayComposition` to copy
-> m VideoOverlayComposition	Returns: a writable `VideoOverlayComposition` equivalent to `comp`.

Takes ownership of comp and returns a version of comp that is writable (i.e. can be modified). Will either return comp right away, or create a new writable copy of comp and unref comp itself. All the contained rectangles will also be copied, but the actual overlay pixel data buffers contained in the rectangles are not copied.

nRectangles

data VideoOverlayCompositionNRectanglesMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * VideoOverlayCompositionNRectanglesMethodInfo VideoOverlayComposition signature Source #
Methods overloadedMethod :: MethodProxy VideoOverlayCompositionNRectanglesMethodInfo VideoOverlayComposition -> signature -> s #

videoOverlayCompositionNRectangles Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoOverlayComposition	`comp`: a `VideoOverlayComposition`
-> m Word32	Returns: the number of rectangles

Returns the number of VideoOverlayRectangles contained in comp.

new

videoOverlayCompositionNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoOverlayRectangle	`rectangle`: a `VideoOverlayRectangle` to add to the composition
-> m VideoOverlayComposition	Returns: a new `VideoOverlayComposition`. Unref with `gst_video_overlay_composition_unref()` when no longer needed.

Creates a new video overlay composition object to hold one or more overlay rectangles.