frame

Documentation

Overview

package frame wraps raw webcam frames as an image.

Index

• func FourCCToPixelFormat(f FourCC) (webcam.PixelFormat, error)
• func GetFramer(format FourCC, w, h, stride, size int) (func([]byte, func()) (Frame, error), error)
• func RegisterFramer(format FourCC, ...)
• type FourCC
  • func PixelFormatToFourCC(pf webcam.PixelFormat) FourCC
• type Frame

Functions

func FourCCToPixelFormat

func FourCCToPixelFormat(f FourCC) (webcam.PixelFormat, error)

FourCCToPixelFormat converts the four character string to a v4l2 PixelFormat.

func GetFramer

func GetFramer(format FourCC, w, h, stride, size int) (func([]byte, func()) (Frame, error), error)

GetFramer returns a function that wraps the frame for this format.

func RegisterFramer

func RegisterFramer(format FourCC, factory func(int, int, int, int) func([]byte, func()) (Frame, error))

RegisterFramer registers a framer factory for a format. Note that only one handler can be registered for any single format.

Types

type FourCC

type FourCC string

func PixelFormatToFourCC

func PixelFormatToFourCC(pf webcam.PixelFormat) FourCC

PixelFormatToFourCC converts the v4l2 PixelFormat to a FourCC.

type Frame

type Frame interface {
	image.Image
	Release()
}

Release is called when the frame is no longer in use. The implementation may set a finalizer on the frame as a precaution in case Release is not called (which would cause a kernel resource leak).