render

Documentation

Index

• type Decoder
• type EXR
  • func (e EXR) Compress(b bool) (EXR, error)
  • func (_ EXR) Decode(r io.Reader) (image.Image, error)
  • func (e EXR) Encode(w io.Writer, img image.Image) error
  • func (e EXR) EncodeBytes(img image.Image) ([]byte, error)
  • func (_ EXR) EncodeFFMPEG(_ image.Image) ([]string, error)
  • func (_ EXR) Encoder() RawEncoder
  • func (e EXR) Float16() (EXR, error)
  • func (e EXR) Float32() (EXR, error)
• type Encoder
• type FFMPegSession
  • func (s *FFMPegSession) Close() error
• type FFMPegSessionSource
• type FrameSession
  • func (s *FrameSession) Close() error
• type ImageCodec
• type Iterator
  • func (i *Iterator) HasNext() bool
  • func (i *Iterator) Next() interface{}
• type JPEG
  • func (_ JPEG) Decode(r io.Reader) (image.Image, error)
  • func (_ JPEG) DecodeConfig(r io.Reader) (image.Config, error)
  • func (_ JPEG) Encode(w io.Writer, img image.Image) error
  • func (_ JPEG) EncodeBytes(img image.Image) ([]byte, error)
  • func (_ JPEG) EncodeFFMPEG(img image.Image) ([]string, error)
  • func (_ JPEG) Encoder() RawEncoder
• type PNG
  • func (_ PNG) Decode(r io.Reader) (image.Image, error)
  • func (_ PNG) DecodeConfig(r io.Reader) (image.Config, error)
  • func (_ PNG) Encode(w io.Writer, img image.Image) error
  • func (_ PNG) EncodeBytes(img image.Image) ([]byte, error)
  • func (_ PNG) EncodeFFMPEG(img image.Image) ([]string, error)
  • func (_ PNG) Encoder() RawEncoder
• type Raw
  • func (r Raw) Decode(_ io.Reader) (image.Image, error)
  • func (r Raw) Encode(w io.Writer, img image.Image) error
  • func (r Raw) EncodeBytes(img image.Image) ([]byte, error)
  • func (_ Raw) EncodeFFMPEG(img image.Image) ([]string, error)
  • func (r Raw) Encoder() RawEncoder
• type RawEncoder
• type Render
  • func (r Render) Exr() ImageCodec
  • func (r Render) Jpeg() ImageCodec
  • func (r Render) New(fileName string, frameRate int) (RenderStream, error)
  • func (r Render) Png() ImageCodec
  • func (r Render) Tiff() ImageCodec
  • func (r Render) TimeCode(frameRate int) *time.TimeCode
• type RenderStream
• type RenderStreamBase
  • func (s *RenderStreamBase) EncodeBytes(img image.Image) ([]byte, error)
  • func (s *RenderStreamBase) ForFrames(count int) *Iterator
  • func (s *RenderStreamBase) FrameRate() int
  • func (s *RenderStreamBase) FrameRateF() float64
  • func (s *RenderStreamBase) Init(_ image.Image) error
  • func (s *RenderStreamBase) TimeCode() *time.TimeCode
  • func (s *RenderStreamBase) Until(ts string) (*Iterator, error)
  • func (s *RenderStreamBase) WriteBytes(b []byte) (int, error)
  • func (s *RenderStreamBase) WriteImage(img image.Image) error
  • func (s *RenderStreamBase) WriteImageN(img image.Image, num int) error
• type TIFF
  • func (_ TIFF) Decode(r io.Reader) (image.Image, error)
  • func (_ TIFF) DecodeConfig(r io.Reader) (image.Config, error)
  • func (_ TIFF) Encode(w io.Writer, img image.Image) error
  • func (_ TIFF) EncodeBytes(img image.Image) ([]byte, error)
  • func (_ TIFF) EncodeFFMPEG(img image.Image) ([]string, error)
  • func (_ TIFF) Encoder() RawEncoder
• type TarWriter
  • func (s *TarWriter) Close() (err error)
• type Writer

Types

type Decoder

type Decoder interface {
	Decode(r io.Reader) (image.Image, error)
}

type EXR

type EXR struct {
	// contains filtered or unexported fields
}

func (EXR) Compress

func (e EXR) Compress(b bool) (EXR, error)

func (EXR) Decode

func (_ EXR) Decode(r io.Reader) (image.Image, error)

func (EXR) Encode

func (e EXR) Encode(w io.Writer, img image.Image) error

func (EXR) EncodeBytes

func (e EXR) EncodeBytes(img image.Image) ([]byte, error)

func (EXR) EncodeFFMPEG

func (_ EXR) EncodeFFMPEG(_ image.Image) ([]string, error)

func (EXR) Encoder

func (_ EXR) Encoder() RawEncoder

func (EXR) Float16

func (e EXR) Float16() (EXR, error)

func (EXR) Float32

func (e EXR) Float32() (EXR, error)

type Encoder

type Encoder interface {
	RawEncoder
	Encoder() RawEncoder
	EncodeBytes(img image.Image) ([]byte, error)
	EncodeFFMPEG(img image.Image) ([]string, error)
}

type FFMPegSession

type FFMPegSession struct {
	RenderStreamBase
	// contains filtered or unexported fields
}

FFMPegSession handles sending frames to FFMPeg

func (*FFMPegSession) Close

func (s *FFMPegSession) Close() error

type FFMPegSessionSource

type FFMPegSessionSource interface {
	Encoder
	EncodeFFMPEG(img image.Image) ([]string, error)
}

type FrameSession

type FrameSession struct {
	RenderStreamBase
}

FrameSession handles sending frames to individual images on disk

func (*FrameSession) Close

func (s *FrameSession) Close() error

Close closes the FrameSession. Normally this is handled by try-resources

type ImageCodec

type ImageCodec interface {
	Read(fileName string) (image.Image, error)
	Write(string, image.Image) error
	// contains filtered or unexported methods
}

type Iterator

type Iterator struct {
	// contains filtered or unexported fields
}

Iterator is returned by a renderer to handle spanning over a range of TimeCode's. Unlike the iterator returned by TimeCode, this one does not advance the TimeCode when Next() is called as that's done when writing an image.

func (*Iterator) HasNext

func (i *Iterator) HasNext() bool

func (*Iterator) Next

func (i *Iterator) Next() interface{}

type JPEG

type JPEG struct{}

func (JPEG) Decode

func (_ JPEG) Decode(r io.Reader) (image.Image, error)

func (JPEG) DecodeConfig

func (_ JPEG) DecodeConfig(r io.Reader) (image.Config, error)

func (JPEG) Encode

func (_ JPEG) Encode(w io.Writer, img image.Image) error

func (JPEG) EncodeBytes

func (_ JPEG) EncodeBytes(img image.Image) ([]byte, error)

func (JPEG) EncodeFFMPEG

func (_ JPEG) EncodeFFMPEG(img image.Image) ([]string, error)

func (JPEG) Encoder

func (_ JPEG) Encoder() RawEncoder

type PNG

type PNG struct{}

func (PNG) Decode

func (_ PNG) Decode(r io.Reader) (image.Image, error)

func (PNG) DecodeConfig

func (_ PNG) DecodeConfig(r io.Reader) (image.Config, error)

func (PNG) Encode

func (_ PNG) Encode(w io.Writer, img image.Image) error

func (PNG) EncodeBytes

func (_ PNG) EncodeBytes(img image.Image) ([]byte, error)

func (PNG) EncodeFFMPEG

func (_ PNG) EncodeFFMPEG(img image.Image) ([]string, error)

func (PNG) Encoder

func (_ PNG) Encoder() RawEncoder

type Raw

type Raw struct{}

Raw package handles raw images. Currently, RGBA and RGBA64 are supported as those are the most common and the way they are stored in memory is directly supported by ffmpeg.

func (Raw) Decode

func (r Raw) Decode(_ io.Reader) (image.Image, error)

func (Raw) Encode

func (r Raw) Encode(w io.Writer, img image.Image) error

func (Raw) EncodeBytes

func (r Raw) EncodeBytes(img image.Image) ([]byte, error)

func (Raw) EncodeFFMPEG

func (_ Raw) EncodeFFMPEG(img image.Image) ([]string, error)

func (Raw) Encoder

func (r Raw) Encoder() RawEncoder

type RawEncoder

type RawEncoder interface {
	Encode(w io.Writer, img image.Image) error
}

type Render

type Render struct {
	// contains filtered or unexported fields
}

func (Render) Exr

func (r Render) Exr() ImageCodec

func (Render) Jpeg

func (r Render) Jpeg() ImageCodec

func (Render) New

func (r Render) New(fileName string, frameRate int) (RenderStream, error)

func (Render) Png

func (r Render) Png() ImageCodec

func (Render) Tiff

func (r Render) Tiff() ImageCodec

func (Render) TimeCode

func (r Render) TimeCode(frameRate int) *time.TimeCode

type RenderStream

type RenderStream interface {
	Writer
	TimeCode() *time.TimeCode
	EncodeBytes(img image.Image) ([]byte, error)
}

type RenderStreamBase

type RenderStreamBase struct {
	Writer
	// contains filtered or unexported fields
}

func (*RenderStreamBase) EncodeBytes

func (s *RenderStreamBase) EncodeBytes(img image.Image) ([]byte, error)

func (*RenderStreamBase) ForFrames

func (s *RenderStreamBase) ForFrames(count int) *Iterator

func (*RenderStreamBase) FrameRate

func (s *RenderStreamBase) FrameRate() int

func (*RenderStreamBase) FrameRateF

func (s *RenderStreamBase) FrameRateF() float64

func (*RenderStreamBase) Init

func (s *RenderStreamBase) Init(_ image.Image) error

func (*RenderStreamBase) TimeCode

func (s *RenderStreamBase) TimeCode() *time.TimeCode

func (*RenderStreamBase) Until

func (s *RenderStreamBase) Until(ts string) (*Iterator, error)

func (*RenderStreamBase) WriteBytes

func (s *RenderStreamBase) WriteBytes(b []byte) (int, error)

func (*RenderStreamBase) WriteImage

func (s *RenderStreamBase) WriteImage(img image.Image) error

WriteImage writes an image to the stream.

func (*RenderStreamBase) WriteImageN

func (s *RenderStreamBase) WriteImageN(img image.Image, num int) error

WriteImageN writes an image to stream multiple times

type TIFF

type TIFF struct{}

func (TIFF) Decode

func (_ TIFF) Decode(r io.Reader) (image.Image, error)

func (TIFF) DecodeConfig

func (_ TIFF) DecodeConfig(r io.Reader) (image.Config, error)

func (TIFF) Encode

func (_ TIFF) Encode(w io.Writer, img image.Image) error

func (TIFF) EncodeBytes

func (_ TIFF) EncodeBytes(img image.Image) ([]byte, error)

func (TIFF) EncodeFFMPEG

func (_ TIFF) EncodeFFMPEG(img image.Image) ([]string, error)

func (TIFF) Encoder

func (_ TIFF) Encoder() RawEncoder

type TarWriter

type TarWriter struct {
	RenderStreamBase
	// contains filtered or unexported fields
}

TarWriter writes frames to a tar file rather than a directory.

func (*TarWriter) Close

func (s *TarWriter) Close() (err error)

type Writer

type Writer interface {
	// Close the Writer, normally used in try-resources
	Close() error
	// WriteBytes the byte slice as a frame
	WriteBytes(b []byte) (int, error)
	// WriteImage writes the image as a frame
	WriteImage(img image.Image) error
	// WriteImageMulti writes the image as num frames
	WriteImageN(img image.Image, num int) error
}

Writer exposes the interface provided by FFMPegSession and FrameSession to scripts