gstvideo.global

Global functions for gstvideo1 library

Functions 70

fngobject.types.GType ancillaryMetaApiGetType()

fngstvideo.ancillary_meta.AncillaryMeta bufferAddAncillaryMeta(gst.buffer.Buffer buffer)Adds a new #GstAncillaryMeta to the buffer. The caller is responsible for setting the appropriate fields.

gstvideo.video_afdmeta.VideoAFDMeta bufferAddVideoAfdMeta(gst.buffer.Buffer buffer,  ubyte  field,  gstvideo.types.VideoAFDSpec spec,  gstvideo.types.VideoAFDValue afd)

Attaches #GstVideoAFDMeta metadata to buffer with the given parameters.

gstvideo.video_affine_transformation_meta.VideoAffineTransformationMeta bufferAddVideoAffineTransformationMeta(gst.buffer.Buffer buffer)

Attaches GstVideoAffineTransformationMeta metadata to buffer with the given parameters.

gstvideo.video_bar_meta.VideoBarMeta bufferAddVideoBarMeta(gst.buffer.Buffer buffer,  ubyte  field,  bool  isLetterbox,  uint  barData1,  uint  barData2)

Attaches #GstVideoBarMeta metadata to buffer with the given parameters.

gstvideo.video_caption_meta.VideoCaptionMeta bufferAddVideoCaptionMeta(gst.buffer.Buffer buffer,  gstvideo.types.VideoCaptionType captionType,  ubyte[]  data)

Attaches #GstVideoCaptionMeta metadata to buffer with the given parameters.

gstvideo.video_codec_alpha_meta.VideoCodecAlphaMeta bufferAddVideoCodecAlphaMeta(gst.buffer.Buffer buffer,  gst.buffer.Buffer alphaBuffer)

Attaches a #GstVideoCodecAlphaMeta metadata to buffer with the given alpha buffer.

gstvideo.video_meta.VideoMeta bufferAddVideoMeta(gst.buffer.Buffer buffer,  gstvideo.types.VideoFrameFlags flags,  gstvideo.types.VideoFormat format,  uint  width,  uint  height)

Attaches GstVideoMeta metadata to buffer with the given parameters and the default offsets and strides for format and width x height.

gstvideo.video_meta.VideoMeta bufferAddVideoMetaFull(gst.buffer.Buffer buffer,  gstvideo.types.VideoFrameFlags flags,  gstvideo.types.VideoFormat format,  uint  width,  uint  height,  uint  nPlanes,  size_t[]  offset,  int[]  stride)

Attaches GstVideoMeta metadata to buffer with the given parameters.

gstvideo.video_overlay_composition_meta.VideoOverlayCompositionMeta bufferAddVideoOverlayCompositionMeta(gst.buffer.Buffer buf,  gstvideo.video_overlay_composition.VideoOverlayComposition comp =  null)

Sets an overlay composition on a buffer. The buffer will obtain its own reference to the composition, meaning this function does not take ownership of comp.

gstvideo.video_region_of_interest_meta.VideoRegionOfInterestMeta bufferAddVideoRegionOfInterestMeta(gst.buffer.Buffer buffer,  string roiType,  uint  x,  uint  y,  uint  w,  uint  h)

Attaches #GstVideoRegionOfInterestMeta metadata to buffer with the given parameters.

gstvideo.video_region_of_interest_meta.VideoRegionOfInterestMeta bufferAddVideoRegionOfInterestMetaId(gst.buffer.Buffer buffer,  glib.types.Quark roiType,  uint  x,  uint  y,  uint  w,  uint  h)

Attaches #GstVideoRegionOfInterestMeta metadata to buffer with the given parameters.

gstvideo.video_seiuser_data_unregistered_meta.VideoSEIUserDataUnregisteredMeta bufferAddVideoSeiUserDataUnregisteredMeta(gst.buffer.Buffer buffer,  ubyte[]  uuid,  ubyte[]  data)

Attaches #GstVideoSEIUserDataUnregisteredMeta metadata to buffer with the given parameters.

gstvideo.video_time_code_meta.VideoTimeCodeMeta bufferAddVideoTimeCodeMeta(gst.buffer.Buffer buffer,  gstvideo.video_time_code.VideoTimeCode tc)

Attaches #GstVideoTimeCodeMeta metadata to buffer with the given parameters.

gstvideo.video_time_code_meta.VideoTimeCodeMeta bufferAddVideoTimeCodeMetaFull(gst.buffer.Buffer buffer,  uint  fpsN,  uint  fpsD,  glib.date_time.DateTime latestDailyJam,  gstvideo.types.VideoTimeCodeFlags flags,  uint  hours,  uint  minutes,  uint  seconds,  uint  frames,  uint  fieldCount)

Attaches #GstVideoTimeCodeMeta metadata to buffer with the given parameters.

fngstvideo.video_meta.VideoMeta bufferGetVideoMeta(gst.buffer.Buffer buffer)Find the #GstVideoMeta on buffer with the lowest id.

fngstvideo.video_meta.VideoMeta bufferGetVideoMetaId(gst.buffer.Buffer buffer, int id)Find the #GstVideoMeta on buffer with the given id.

gstvideo.video_region_of_interest_meta.VideoRegionOfInterestMeta bufferGetVideoRegionOfInterestMetaId(gst.buffer.Buffer buffer,  int  id)

Find the #GstVideoRegionOfInterestMeta on buffer with the given id.

fnbool bufferPoolConfigGetVideoAlignment(gst.structure.Structure config, gstvideo.video_alignment.VideoAlignment align_)Get the video alignment from the bufferpool configuration config in in align

fnvoid bufferPoolConfigSetVideoAlignment(gst.structure.Structure config, gstvideo.video_alignment.VideoAlignment align_)Set the video alignment in align to the bufferpool configuration config

fnbool isVideoOverlayPrepareWindowHandleMessage(gst.message.Message msg)Convenience function to check if the given message is a "prepare-window-handle" message from a #GstVideoOverlay.

fngobject.types.GType videoAfdMetaApiGetType()

fngobject.types.GType videoAffineTransformationMetaApiGetType()

fngobject.types.GType videoBarMetaApiGetType()

bool videoBlend(gstvideo.video_frame.VideoFrame dest,  gstvideo.video_frame.VideoFrame src,  int  x,  int  y,  float  globalAlpha)

Lets you blend the src image into the dest image

void videoBlendScaleLinearRGBA(gstvideo.video_info.VideoInfo src,  gst.buffer.Buffer srcBuffer,  int  destHeight,  int  destWidth,  out  gstvideo.video_info.VideoInfo dest,  out  gst.buffer.Buffer destBuffer)

Scales a buffer containing RGBA (or AYUV) video. This is an internal helper function which is used to scale subtitle overlays, and may be deprecated in the near future. Use #GstVideoScaler to scale...

bool videoCalculateDisplayRatio(out  uint  darN,  out  uint  darD,  uint  videoWidth,  uint  videoHeight,  uint  videoParN,  uint  videoParD,  uint  displayParN,  uint  displayParD)

Given the Pixel Aspect Ratio and size of an input video frame, and the pixel aspect ratio of the intended display device, calculates the actual display ratio the video will be rendered with.

fngobject.types.GType videoCaptionMetaApiGetType()

void videoCenterRect(gstvideo.types.VideoRectangle src,  gstvideo.types.VideoRectangle dst,  out  gstvideo.types.VideoRectangle result,  bool  scaling)

Takes src rectangle and position it at the center of dst rectangle with or without scaling. It handles clipping if the src rectangle is bigger than the dst one and scaling is set to FALSE.

fngstvideo.types.VideoChromaSite videoChromaFromString(string s)Convert `s` to a #GstVideoChromaSite

fnstring videoChromaToString(gstvideo.types.VideoChromaSite site)Converts site to its string representation.

fngobject.types.GType videoCodecAlphaMetaApiGetType()

fndouble videoColorTransferDecode(gstvideo.types.VideoTransferFunction func, double val)

fndouble videoColorTransferEncode(gstvideo.types.VideoTransferFunction func, double val)

fngst.sample.Sample videoConvertSample(gst.sample.Sample sample, gst.caps.Caps toCaps, gst.types.ClockTime timeout)Converts a raw video buffer into the specified output caps.

void videoConvertSampleAsync(gst.sample.Sample sample,  gst.caps.Caps toCaps,  gst.types.ClockTime timeout,  gstvideo.types.VideoConvertSampleCallback callback)

Converts a raw video buffer into the specified output caps.

fngobject.types.GType videoCropMetaApiGetType()

fnuint videoDmaDrmFourccFromFormat(gstvideo.types.VideoFormat format)Converting the video format into dma drm fourcc. If no matching fourcc found, then DRMFORMATINVALID is returned.

fnuint videoDmaDrmFourccFromString(string formatStr, out ulong modifier)Convert the formatstr string into the drm fourcc value. The modifier is also parsed if we want. Please note that the formatstr should follow the fourcc:modifier kind style, such as NV12:0x010000000...

fngstvideo.types.VideoFormat videoDmaDrmFourccToFormat(uint fourcc)Converting a dma drm fourcc into the video format. If no matching video format found, then GSTVIDEOFORMAT_UNKNOWN is returned.

fnstring videoDmaDrmFourccToString(uint fourcc, ulong modifier)Returns a string containing drm kind format, such as NV12:0x0100000000000002, or NULL otherwise.

fnbool videoEventIsForceKeyUnit(gst.event.Event event)Checks if an event is a force key unit event. Returns true for both upstream and downstream force key unit events.

gst.event.Event videoEventNewDownstreamForceKeyUnit(gst.types.ClockTime timestamp,  gst.types.ClockTime streamTime,  gst.types.ClockTime runningTime,  bool  allHeaders,  uint  count)

Creates a new downstream force key unit event. A downstream force key unit event can be sent down the pipeline to request downstream elements to produce a key unit. A downstream force key unit even...

fngst.event.Event videoEventNewStillFrame(bool inStill)Creates a new Still Frame event. If in_still is true, then the event represents the start of a still frame sequence. If it is false, then the event ends a still frame sequence.

fngst.event.Event videoEventNewUpstreamForceKeyUnit(gst.types.ClockTime runningTime, bool allHeaders, uint count)Creates a new upstream force key unit event. An upstream force key unit event can be sent to request upstream elements to produce a key unit.

bool videoEventParseDownstreamForceKeyUnit(gst.event.Event event,  out  gst.types.ClockTime timestamp,  out  gst.types.ClockTime streamTime,  out  gst.types.ClockTime runningTime,  out  bool  allHeaders,  out  uint  count)

Get timestamp, stream-time, running-time, all-headers and count in the force key unit event. See [gstvideo.global.videoEventNewDownstreamForceKeyUnit] for a full description of the downstream force...

fnbool videoEventParseStillFrame(gst.event.Event event, out bool inStill)Parse a #GstEvent, identify if it is a Still Frame event, and return the still-frame state from the event if it is. If the event represents the start of a still frame, the instill variable will be ...

bool videoEventParseUpstreamForceKeyUnit(gst.event.Event event,  out  gst.types.ClockTime runningTime,  out  bool  allHeaders,  out  uint  count)

Get running-time, all-headers and count in the force key unit event. See [gstvideo.global.videoEventNewUpstreamForceKeyUnit] for a full description of the upstream force key unit event.

fngstvideo.types.VideoFormat[] videoFormatsAny()Return all the raw video formats supported by GStreamer including special opaque formats such as [gstvideo.types.VideoFormat.DmaDrm] for which no software conversion exists. This should be use for ...

fngstvideo.types.VideoFormat[] videoFormatsRaw()Return all the raw video formats supported by GStreamer. Returns: an array of #GstVideoFormat

fngobject.types.GType videoGlTextureUploadMetaApiGetType()

fnbool videoGuessFramerate(gst.types.ClockTime duration, out int destN, out int destD)Given the nominal duration of one video frame, this function will check some standard framerates for a close match (within 0.1%) and return one if possible,

fnbool videoIsCommonAspectRatio(int width, int height, int parN, int parD)Given a frame's dimensions and pixel aspect ratio, this function will calculate the frame's aspect ratio and compare it against a set of common well-known "standard" aspect ratios.

fnbool videoIsDmaDrmCaps(gst.caps.Caps caps)Check whether the caps is a dma drm kind caps. Please note that the caps should be fixed.

fngst.caps.Caps videoMakeRawCaps(gstvideo.types.VideoFormat[] formats = null)Return a generic raw video caps for formats defined in formats. If formats is null returns a caps for all the supported raw video formats, see [gstvideo.global.videoFormatsRaw].

gst.caps.Caps videoMakeRawCapsWithFeatures(gstvideo.types.VideoFormat[]  formats =  null,  gst.caps_features.CapsFeatures features =  null)

Return a generic raw video caps for formats defined in formats with features features. If formats is null returns a caps for all the supported video formats, see [gstvideo.global.videoFormatsRaw].

fngobject.types.GType videoMetaApiGetType()

fngobject.value.Value videoMultiviewGetDoubledHeightModes()

fngobject.value.Value videoMultiviewGetDoubledSizeModes()

fngobject.value.Value videoMultiviewGetDoubledWidthModes()

fngobject.value.Value videoMultiviewGetMonoModes()

fngobject.value.Value videoMultiviewGetUnpackedModes()

bool videoMultiviewGuessHalfAspect(gstvideo.types.VideoMultiviewMode mvMode,  uint  width,  uint  height,  uint  parN,  uint  parD)

void videoMultiviewVideoInfoChangeMode(gstvideo.video_info.VideoInfo info,  gstvideo.types.VideoMultiviewMode outMviewMode,  gstvideo.types.VideoMultiviewFlags outMviewFlags)

Utility function that transforms the width/height/PAR and multiview mode and flags of a #GstVideoInfo into the requested mode.

fngobject.types.GType videoOverlayCompositionMetaApiGetType()

fngobject.types.GType videoRegionOfInterestMetaApiGetType()

fngobject.types.GType videoSeiUserDataUnregisteredMetaApiGetType()

bool videoSeiUserDataUnregisteredParsePrecisionTimeStamp(gstvideo.video_seiuser_data_unregistered_meta.VideoSEIUserDataUnregisteredMeta userData,  out  ubyte  status,  out  ulong  precisionTimeStamp)

Parses and returns the Precision Time Stamp (ST 0604) from the SEI User Data Unregistered buffer

fnuint videoTileGetIndex(gstvideo.types.VideoTileMode mode, int x, int y, int xTiles, int yTiles)Get the tile index of the tile at coordinates `x` and `y` in the tiled image of `x`tiles by `y`tiles.

fngobject.types.GType videoTimeCodeMetaApiGetType()