thumbnailer

Documentation

Overview

Package thumbnailer can be used to create either a series of thumbnail images or a single thumbnail image with the CreateFromLoader() and SingleFrameFromRewindState() functions respsectively.

The CreateFromLodaer() function will run asynchronously and is good for generating just the images from a new emulation.

The SingleFrameFromRewindState() function meanwhile, is more limited and is used to generate a single TV frame starting from the supplied rewind state.

Index

• Constants
• type Anim
  • func NewAnim(prefs *preferences.Preferences, spec string) (*Anim, error)
  • func (thmb *Anim) Create(cartload cartridgeloader.Loader, spec string, numFrames int)
  • func (thmb *Anim) EndCreation()
  • func (thmb *Anim) EndRendering() error
  • func (thmb *Anim) IsEmulating() bool
  • func (thmb *Anim) NewFrame(frameInfo television.FrameInfo) error
  • func (thmb *Anim) NewScanline(scanline int) error
  • func (thmb *Anim) Notify(notice notifications.Notice) error
  • func (thmb *Anim) Reset()
  • func (thmb *Anim) SetPixels(sig []signal.SignalAttributes, last int) error
  • func (thmb *Anim) String() string
  • func (thmb *Anim) UpdateResults() *preview.Results
• type Image
  • func NewImage(prefs *preferences.Preferences, spec string) (*Image, error)
  • func (thmb *Image) CartYield(yield coprocessor.CoProcYield) coprocessor.YieldHookResponse
  • func (thmb *Image) Create(state *rewind.State)
  • func (thmb *Image) EndRendering() error
  • func (thmb *Image) NewFrame(frameInfo television.FrameInfo) error
  • func (thmb *Image) NewScanline(scanline int) error
  • func (thmb *Image) Reset()
  • func (thmb *Image) SetPixels(sig []signal.SignalAttributes, last int) error
  • func (thmb *Image) String() string

Constants

const UndefinedNumFrames = -1

UndefinedNumFrames indicates the that the thumbnailing emulation should run until it is explicitely stopped with the EndCreation() function (or implicitely with a second call to Create())

Types

type Anim

type Anim struct {
	Render chan *image.RGBA
	// contains filtered or unexported fields
}

Anim type handles the emulation necessary for thumbnail image generation.

func NewAnim

func NewAnim(prefs *preferences.Preferences, spec string) (*Anim, error)

NewAnim is the preferred method of initialisation for the Anim type

func (*Anim) Create

func (thmb *Anim) Create(cartload cartridgeloader.Loader, spec string, numFrames int)

Create will cause images to be generated by a running emulation initialised with the specified cartridge loader. The emulation will run for a number of frames before ending

Returns when the preview has completed (so PreviewResults() is safe to call once the function has returned)

func (*Anim) EndCreation

func (thmb *Anim) EndCreation()

EndCreation ends a running emulation that is creating a stream of thumbnails. Safe to use even when no emulation is running

func (*Anim) EndRendering

func (thmb *Anim) EndRendering() error

EndRendering implements the television.PixelRenderer interface

func (*Anim) IsEmulating

func (thmb *Anim) IsEmulating() bool

IsEmulating returns true if the thumbnail emulator is working. Useful for testing whether the cartridgeloader was an emulatable file

func (*Anim) NewFrame

func (thmb *Anim) NewFrame(frameInfo television.FrameInfo) error

NewFrame implements the television.PixelRenderer interface

func (*Anim) NewScanline

func (thmb *Anim) NewScanline(scanline int) error

NewScanline implements the television.PixelRenderer interface

func (*Anim) Notify

func (thmb *Anim) Notify(notice notifications.Notice) error

Notify implements the notifications.Notify interface

func (*Anim) Reset

func (thmb *Anim) Reset()

Reset implements the television.PixelRenderer interface

func (*Anim) SetPixels

func (thmb *Anim) SetPixels(sig []signal.SignalAttributes, last int) error

SetPixels implements the television.PixelRenderer interface

func (*Anim) String

func (thmb *Anim) String() string

func (*Anim) UpdateResults

func (thmb *Anim) UpdateResults() *preview.Results

UpdateResults returns the more recent results of the preview emulation

type Image

type Image struct {
	Render chan *image.RGBA
	// contains filtered or unexported fields
}

Image type handles the emulation necessary for thumbnail image generation.

func NewImage

func NewImage(prefs *preferences.Preferences, spec string) (*Image, error)

NewImage is the preferred method of initialisation for the Image type

func (*Image) CartYield

func (thmb *Image) CartYield(yield coprocessor.CoProcYield) coprocessor.YieldHookResponse

CartYield implements the coprocessor.CartYieldHook interface.

func (*Image) Create

func (thmb *Image) Create(state *rewind.State)

Create will run the thumbnailer emulation for a single frame using the state from another emultion as a starting point

The function must be called in the same goroutine as the emulation that generated the rewind.State

func (*Image) EndRendering

func (thmb *Image) EndRendering() error

EndRendering implements the television.PixelRenderer interface

func (*Image) NewFrame

func (thmb *Image) NewFrame(frameInfo television.FrameInfo) error

NewFrame implements the television.PixelRenderer interface

func (*Image) NewScanline

func (thmb *Image) NewScanline(scanline int) error

NewScanline implements the television.PixelRenderer interface

func (*Image) Reset

func (thmb *Image) Reset()

Reset implements the television.PixelRenderer interface

func (*Image) SetPixels

func (thmb *Image) SetPixels(sig []signal.SignalAttributes, last int) error

SetPixels implements the television.PixelRenderer interface

func (*Image) String

func (thmb *Image) String() string