View Source Evision.CUDACodec.NVSurfaceToColorConverter (Evision v0.2.16-pre)

Summary

Types

t()

Type that represents an CUDACodec.NVSurfaceToColorConverter struct.

Functions

Variant 1:

Performs the conversion from the raw YUV Surface output from VideoReader to the requested color format. Use this function when you want to convert the raw YUV Surface output from VideoReader to more than one color format or you want both the raw Surface output in addition to a color frame.

Variant 1:

Performs the conversion from the raw YUV Surface output from VideoReader to the requested color format. Use this function when you want to convert the raw YUV Surface output from VideoReader to more than one color format or you want both the raw Surface output in addition to a color frame.

Types

@type t() :: %Evision.CUDACodec.NVSurfaceToColorConverter{ref: reference()}

Type that represents an CUDACodec.NVSurfaceToColorConverter struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

@spec convert(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

convert(self, yuv, surfaceFormat, outputFormat)

View Source
@spec convert(
  Evision.CUDACodec.CUDACodec.NVSurfaceToColorConverter.t(),
  Evision.Mat.maybe_mat_in(),
  Evision.CUDACodec.SurfaceFormat.t(),
  Evision.CUDACodec.ColorFormat.t()
) :: Evision.Mat.t() | false | {:error, String.t()}
@spec convert(
  Evision.CUDACodec.CUDACodec.NVSurfaceToColorConverter.t(),
  Evision.CUDA.GpuMat.t(),
  Evision.CUDACodec.SurfaceFormat.t(),
  Evision.CUDACodec.ColorFormat.t()
) :: Evision.CUDA.GpuMat.t() | false | {:error, String.t()}

Variant 1:

Performs the conversion from the raw YUV Surface output from VideoReader to the requested color format. Use this function when you want to convert the raw YUV Surface output from VideoReader to more than one color format or you want both the raw Surface output in addition to a color frame.

Positional Arguments
  • self: Evision.CUDACodec.NVSurfaceToColorConverter.t()

  • yuv: Evision.Mat.

    The raw YUV Surface output from VideoReader see @ref SurfaceFormat.

  • surfaceFormat: SurfaceFormat.

    The surface format of the input YUV data.

  • outputFormat: ColorFormat.

    The requested output color format.

Keyword Arguments
  • bitDepth: BitDepth.

    The requested bit depth of the output frame.

  • planar: bool.

    Request seperate planes for each color plane.

  • stream: cuda_Stream.

    Stream for the asynchronous version.

Return
  • retval: bool

  • color: Evision.Mat.t().

    The converted frame.

Python prototype (for reference only):

convert(yuv, surfaceFormat, outputFormat[, color[, bitDepth[, planar[, stream]]]]) -> retval, color

Variant 2:

Performs the conversion from the raw YUV Surface output from VideoReader to the requested color format. Use this function when you want to convert the raw YUV Surface output from VideoReader to more than one color format or you want both the raw Surface output in addition to a color frame.

Positional Arguments
  • self: Evision.CUDACodec.NVSurfaceToColorConverter.t()

  • yuv: Evision.CUDA.GpuMat.t().

    The raw YUV Surface output from VideoReader see @ref SurfaceFormat.

  • surfaceFormat: SurfaceFormat.

    The surface format of the input YUV data.

  • outputFormat: ColorFormat.

    The requested output color format.

Keyword Arguments
  • bitDepth: BitDepth.

    The requested bit depth of the output frame.

  • planar: bool.

    Request seperate planes for each color plane.

  • stream: cuda_Stream.

    Stream for the asynchronous version.

Return
  • retval: bool

  • color: Evision.CUDA.GpuMat.t().

    The converted frame.

Python prototype (for reference only):

convert(yuv, surfaceFormat, outputFormat[, color[, bitDepth[, planar[, stream]]]]) -> retval, color
Link to this function

convert(self, yuv, surfaceFormat, outputFormat, opts)

View Source
@spec convert(
  Evision.CUDACodec.CUDACodec.NVSurfaceToColorConverter.t(),
  Evision.Mat.maybe_mat_in(),
  Evision.CUDACodec.SurfaceFormat.t(),
  Evision.CUDACodec.ColorFormat.t(),
  [bitDepth: term(), planar: term(), stream: term()] | nil
) :: Evision.Mat.t() | false | {:error, String.t()}
@spec convert(
  Evision.CUDACodec.CUDACodec.NVSurfaceToColorConverter.t(),
  Evision.CUDA.GpuMat.t(),
  Evision.CUDACodec.SurfaceFormat.t(),
  Evision.CUDACodec.ColorFormat.t(),
  [bitDepth: term(), planar: term(), stream: term()] | nil
) :: Evision.CUDA.GpuMat.t() | false | {:error, String.t()}

Variant 1:

Performs the conversion from the raw YUV Surface output from VideoReader to the requested color format. Use this function when you want to convert the raw YUV Surface output from VideoReader to more than one color format or you want both the raw Surface output in addition to a color frame.

Positional Arguments
  • self: Evision.CUDACodec.NVSurfaceToColorConverter.t()

  • yuv: Evision.Mat.

    The raw YUV Surface output from VideoReader see @ref SurfaceFormat.

  • surfaceFormat: SurfaceFormat.

    The surface format of the input YUV data.

  • outputFormat: ColorFormat.

    The requested output color format.

Keyword Arguments
  • bitDepth: BitDepth.

    The requested bit depth of the output frame.

  • planar: bool.

    Request seperate planes for each color plane.

  • stream: cuda_Stream.

    Stream for the asynchronous version.

Return
  • retval: bool

  • color: Evision.Mat.t().

    The converted frame.

Python prototype (for reference only):

convert(yuv, surfaceFormat, outputFormat[, color[, bitDepth[, planar[, stream]]]]) -> retval, color

Variant 2:

Performs the conversion from the raw YUV Surface output from VideoReader to the requested color format. Use this function when you want to convert the raw YUV Surface output from VideoReader to more than one color format or you want both the raw Surface output in addition to a color frame.

Positional Arguments
  • self: Evision.CUDACodec.NVSurfaceToColorConverter.t()

  • yuv: Evision.CUDA.GpuMat.t().

    The raw YUV Surface output from VideoReader see @ref SurfaceFormat.

  • surfaceFormat: SurfaceFormat.

    The surface format of the input YUV data.

  • outputFormat: ColorFormat.

    The requested output color format.

Keyword Arguments
  • bitDepth: BitDepth.

    The requested bit depth of the output frame.

  • planar: bool.

    Request seperate planes for each color plane.

  • stream: cuda_Stream.

    Stream for the asynchronous version.

Return
  • retval: bool

  • color: Evision.CUDA.GpuMat.t().

    The converted frame.

Python prototype (for reference only):

convert(yuv, surfaceFormat, outputFormat[, color[, bitDepth[, planar[, stream]]]]) -> retval, color