corevideo

Documentation

Overview

Process digital video, including manipulation of individual frames, using a pipeline-based API and support for both Metal and OpenGL.

Apple Documentation

Index

• type AttachmentMode
• type BufferRef
• type DisplayLinkOutputCallback
• type DisplayLinkOutputHandler
• type DisplayLinkRef
• type FillExtendedPixelsCallBack
• type FillExtendedPixelsCallBackData
• type ImageBufferRef
• type MetalTextureCacheRef
• type OpenGLBufferPoolRef
• type OpenGLTextureCacheRef
• type OptionFlags
• type PixelBufferLockFlags
• type PixelBufferPoolFlushFlags
• type PixelBufferPoolRef
• type PixelBufferRef
• type PixelBufferReleaseBytesCallback
• type PixelBufferReleasePlanarBytesCallback
• type PlanarComponentInfo
• type PlanarPixelBufferInfo
• type PlanarPixelBufferInfo_YCbCrBiPlanar
• type PlanarPixelBufferInfo_YCbCrPlanar
• type Return
• type SMPTETime
• type SMPTETimeFlags
• type SMPTETimeType
• type Time
• type TimeFlags
• type TimeStamp
• type TimeStampFlags

Types

type AttachmentMode

type AttachmentMode uint32

The propagation modes of a Core Video buffer attachment. Full Topic

const (
	KAttachmentMode_ShouldNotPropagate AttachmentMode = 0
	KAttachmentMode_ShouldPropagate    AttachmentMode = 1
)

type BufferRef

type BufferRef uintptr //*_Ctype_struct___CVBuffer

A reference to a Core Video buffer. Full Topic

type DisplayLinkOutputCallback

type DisplayLinkOutputCallback = func(displayLink DisplayLinkRef, inNow *TimeStamp, inOutputTime *TimeStamp, flagsIn OptionFlags, flagsOut *OptionFlags, displayLinkContext unsafe.Pointer) Return

A type for a display link callback function that the system invokes when it’s time for the app to output a video frame. Full Topic

type DisplayLinkOutputHandler

type DisplayLinkOutputHandler = func(displayLink DisplayLinkRef, inNow *TimeStamp, inOutputTime *TimeStamp, flagsIn OptionFlags, flagsOut *OptionFlags) Return

[Full Topic]

type DisplayLinkRef

type DisplayLinkRef uintptr

A reference to a display link object. Full Topic

type FillExtendedPixelsCallBack

type FillExtendedPixelsCallBack = func(pixelBuffer PixelBufferRef, refCon unsafe.Pointer) bool

Defines a pointer to a custom extended pixel-fill function, which is called whenever the system needs to pad a buffer holding your custom pixel format. Full Topic

type FillExtendedPixelsCallBackData

type FillExtendedPixelsCallBackData struct {
	Version      int64
	FillCallBack uintptr
	RefCon       uintptr
}

A structure for holding information that describes a custom extended pixel fill algorithm. Full Topic

type ImageBufferRef

type ImageBufferRef BufferRef

type MetalTextureCacheRef

type MetalTextureCacheRef uintptr

A reference to a Core Video Metal texture cache. Full Topic

type OpenGLBufferPoolRef

type OpenGLBufferPoolRef uintptr

A reference to an OpenGL buffer pool object. Full Topic

type OpenGLTextureCacheRef

type OpenGLTextureCacheRef uintptr

[Full Topic]

type OptionFlags

type OptionFlags uint64

The flags to be used for the display link output callback function. Full Topic

type PixelBufferLockFlags

type PixelBufferLockFlags OptionFlags

The flags to pass to corevideo/cvpixelbufferlockbaseaddress and corevideo/cvpixelbufferunlockbaseaddress. Full Topic

const (
	KPixelBufferLock_ReadOnly PixelBufferLockFlags = 1
)

type PixelBufferPoolFlushFlags

type PixelBufferPoolFlushFlags OptionFlags

The flags to pass to flush the pool. Full Topic

const (
	KPixelBufferPoolFlushExcessBuffers PixelBufferPoolFlushFlags = 1
)

type PixelBufferPoolRef

type PixelBufferPoolRef uintptr

A reference to a pixel buffer pool object. Full Topic

type PixelBufferRef

type PixelBufferRef ImageBufferRef

type PixelBufferReleaseBytesCallback

type PixelBufferReleaseBytesCallback = func(releaseRefCon unsafe.Pointer, baseAddress unsafe.Pointer)

A type that defines a release callback function. Full Topic

type PixelBufferReleasePlanarBytesCallback

type PixelBufferReleasePlanarBytesCallback = func(releaseRefCon unsafe.Pointer, dataPtr unsafe.Pointer, dataSize uint, numberOfPlanes uint, planeAddresses unsafe.Pointer)

Defines a pointer to a pixel buffer release callback function, which is called when a pixel buffer created by corevideo/cvpixelbuffercreatewithplanarbyt is released. Full Topic

type PlanarComponentInfo

type PlanarComponentInfo struct {
	Offset   int32
	RowBytes uint32
}

A structure for describing planar components. Full Topic

type PlanarPixelBufferInfo

type PlanarPixelBufferInfo struct {
	ComponentInfo [1]PlanarComponentInfo
}

A structure for describing planar buffers. Full Topic

type PlanarPixelBufferInfo_YCbCrBiPlanar

type PlanarPixelBufferInfo_YCbCrBiPlanar struct {
	ComponentInfoY    PlanarComponentInfo
	ComponentInfoCbCr PlanarComponentInfo
}

A structure for describing YCbCr biplanar buffers. Full Topic

type PlanarPixelBufferInfo_YCbCrPlanar

type PlanarPixelBufferInfo_YCbCrPlanar struct {
	ComponentInfoY  PlanarComponentInfo
	ComponentInfoCb PlanarComponentInfo
	ComponentInfoCr PlanarComponentInfo
}

A structure for describing YCbCr planar buffers. Full Topic

type Return

type Return int32

A Core Video error type return value. Full Topic

type SMPTETime

type SMPTETime struct {
	Subframes       int16
	SubframeDivisor int16
	Counter         uint32
	Type            uint32
	Flags           uint32
	Hours           int16
	Minutes         int16
	Seconds         int16
	Frames          int16
}

A structure for holding an SMPTE time. Full Topic

type SMPTETimeFlags

type SMPTETimeFlags uint32

[Full Topic]

const (
	KSMPTETimeRunning SMPTETimeFlags = 2
	KSMPTETimeValid   SMPTETimeFlags = 1
)

type SMPTETimeType

type SMPTETimeType uint32

[Full Topic]

const (
	KSMPTETimeType24       SMPTETimeType = 0
	KSMPTETimeType25       SMPTETimeType = 1
	KSMPTETimeType2997     SMPTETimeType = 4
	KSMPTETimeType2997Drop SMPTETimeType = 5
	KSMPTETimeType30       SMPTETimeType = 3
	KSMPTETimeType30Drop   SMPTETimeType = 2
	KSMPTETimeType5994     SMPTETimeType = 7
	KSMPTETimeType60       SMPTETimeType = 6
)

type Time

type Time struct {
	TimeValue int64
	TimeScale int32
	Flags     int32
}

A structure for reporting Core Video time values. Full Topic

type TimeFlags

type TimeFlags int32

[Full Topic]

const (
	KTimeIsIndefinite TimeFlags = 1
)

type TimeStamp

type TimeStamp struct {
	Version            uint32
	VideoTimeScale     int32
	VideoTime          int64
	HostTime           uint64
	RateScalar         float64
	VideoRefreshPeriod int64
	SmpteTime          SMPTETime
	Flags              uint64
	Reserved           uint64
}

A structure for defining a display timestamp. Full Topic

type TimeStampFlags

type TimeStampFlags uint64

[Full Topic]

const (
	KTimeStampBottomField             TimeStampFlags = 131072
	KTimeStampHostTimeValid           TimeStampFlags = 2
	KTimeStampIsInterlaced            TimeStampFlags = 196608
	KTimeStampRateScalarValid         TimeStampFlags = 16
	KTimeStampSMPTETimeValid          TimeStampFlags = 4
	KTimeStampTopField                TimeStampFlags = 65536
	KTimeStampVideoHostTimeValid      TimeStampFlags = 3
	KTimeStampVideoRefreshPeriodValid TimeStampFlags = 8
	KTimeStampVideoTimeValid          TimeStampFlags = 1
)