ebiten/imageimpl.go

// Copyright 2016 Hajime Hoshi
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package ebiten

import (
	"errors"
	"fmt"
	"image"
	"image/color"
	"image/draw"
	"runtime"
	"sync"

	"github.com/hajimehoshi/ebiten/internal/graphics"
	"github.com/hajimehoshi/ebiten/internal/graphics/opengl"
	"github.com/hajimehoshi/ebiten/internal/restorable"
)

type imageImpl struct {
	image      *graphics.Image
	disposed   bool
	width      int
	height     int
	filter     Filter
	restorable restorable.Image
	volatile   bool
	screen     bool
	m          sync.Mutex
}

func newImageImpl(width, height int, filter Filter, volatile bool) (*imageImpl, error) {
	img, err := graphics.NewImage(width, height, glFilter(filter))
	if err != nil {
		return nil, err
	}
	i := &imageImpl{
		image:    img,
		width:    width,
		height:   height,
		filter:   filter,
		volatile: volatile,
	}
	runtime.SetFinalizer(i, (*imageImpl).Dispose)
	return i, nil
}

func newImageImplFromImage(source image.Image, filter Filter) (*imageImpl, error) {
	size := source.Bounds().Size()
	w, h := size.X, size.Y
	// TODO: Return error when the image is too big!
	// Don't lock while manipulating an image.Image interface.

	// It is necessary to copy the source image since the actual construction of
	// an image is delayed and we can't expect the source image is not modified
	// until the construction.
	origImg := source
	newImg := image.NewRGBA(image.Rect(0, 0, w, h))
	draw.Draw(newImg, newImg.Bounds(), origImg, origImg.Bounds().Min, draw.Src)
	rgbaImg := newImg
	p := make([]uint8, 4*w*h)
	for j := 0; j < h; j++ {
		copy(p[j*w*4:(j+1)*w*4], rgbaImg.Pix[j*rgbaImg.Stride:])
	}
	img, err := graphics.NewImageFromImage(rgbaImg, glFilter(filter))
	if err != nil {
		// TODO: texture should be removed here?
		return nil, err
	}
	i := &imageImpl{
		image:  img,
		width:  w,
		height: h,
		filter: filter,
	}
	i.restorable.ReplacePixels(p)
	runtime.SetFinalizer(i, (*imageImpl).Dispose)
	return i, nil
}

func newScreenImageImpl(width, height int) (*imageImpl, error) {
	img, err := graphics.NewScreenFramebufferImage(width, height)
	if err != nil {
		return nil, err
	}
	i := &imageImpl{
		image:    img,
		width:    width,
		height:   height,
		volatile: true,
		screen:   true,
	}
	runtime.SetFinalizer(i, (*imageImpl).Dispose)
	return i, nil
}

func (i *imageImpl) Fill(clr color.Color) error {
	i.m.Lock()
	defer i.m.Unlock()
	if i.disposed {
		return errors.New("ebiten: image is already disposed")
	}
	rgba := color.RGBAModel.Convert(clr).(color.RGBA)
	i.restorable.Fill(rgba)
	return i.image.Fill(rgba)
}

func (i *imageImpl) clearIfVolatile() error {
	i.m.Lock()
	defer i.m.Unlock()
	if i.disposed {
		return nil
	}
	if !i.volatile {
		return nil
	}
	i.restorable.Clear()
	return i.image.Fill(color.RGBA{})
}

func (i *imageImpl) DrawImage(image *Image, options *DrawImageOptions) error {
	// Calculate vertices before locking because the user can do anything in
	// options.ImageParts interface without deadlock (e.g. Call Image functions).
	if options == nil {
		options = &DrawImageOptions{}
	}
	parts := options.ImageParts
	if parts == nil {
		// Check options.Parts for backward-compatibility.
		dparts := options.Parts
		if dparts != nil {
			parts = imageParts(dparts)
		} else {
			parts = &wholeImage{image.impl.width, image.impl.height}
		}
	}
	quads := &textureQuads{parts: parts, width: image.impl.width, height: image.impl.height}
	// TODO: Reuse one vertices instead of making here, but this would need locking.
	vertices := make([]int16, parts.Len()*16)
	n := quads.vertices(vertices)
	if n == 0 {
		return nil
	}
	if i == image.impl {
		return errors.New("ebiten: Image.DrawImage: image should be different from the receiver")
	}
	i.m.Lock()
	defer i.m.Unlock()
	if i.disposed {
		return errors.New("ebiten: image is already disposed")
	}
	geom := options.GeoM
	colorm := options.ColorM
	mode := opengl.CompositeMode(options.CompositeMode)
	if image.impl.restorable.IsStale() {
		i.restorable.MakeStale()
	} else {
		i.restorable.AppendDrawImageHistory(image.impl.image, vertices, &geom, &colorm, mode)
	}
	if err := i.image.DrawImage(image.impl.image, vertices, &geom, &colorm, mode); err != nil {
		return err
	}
	return nil
}

func (i *imageImpl) At(x, y int, context *opengl.Context) color.Color {
	if context == nil {
		panic("ebiten: At can't be called when the GL context is not initialized (this panic happens as of version 1.4.0-alpha)")
	}
	i.m.Lock()
	defer i.m.Unlock()
	if i.disposed {
		return color.Transparent
	}
	idx := 4*x + 4*y*i.width
	clr, err := i.restorable.At(idx, i.image, context)
	if err != nil {
		panic(err)
	}
	return clr
}

func (i *imageImpl) resolveStalePixels(context *opengl.Context) error {
	i.m.Lock()
	defer i.m.Unlock()
	if i.disposed {
		return nil
	}
	if i.volatile {
		return nil
	}
	if err := i.restorable.ReadPixelsFromVRAMIfStale(i.image, context); err != nil {
		return err
	}
	return nil
}

func (i *imageImpl) resetPixelsIfDependingOn(target *imageImpl, context *opengl.Context) error {
	i.m.Lock()
	defer i.m.Unlock()
	if i == target {
		return nil
	}
	if i.disposed {
		return nil
	}
	if target.isDisposed() {
		return errors.New("ebiten: target is already disposed")
	}
	// target is an image that is about to be tried mutating.
	// If pixels object is related to that image, the pixels must be reset.
	if !i.restorable.DependsOn(target.image) {
		return nil
	}
	i.restorable.MakeStale()
	return nil
}

func (i *imageImpl) hasDependency() bool {
	i.m.Lock()
	defer i.m.Unlock()
	return i.restorable.HasDependency()
}

func (i *imageImpl) restore(context *opengl.Context) error {
	i.m.Lock()
	defer i.m.Unlock()
	if i.disposed {
		return nil
	}
	if i.screen {
		// The screen image should also be recreated because framebuffer might
		// be changed.
		var err error
		i.image, err = graphics.NewScreenFramebufferImage(i.width, i.height)
		if err != nil {
			return err
		}
		return nil
	}
	if i.volatile {
		var err error
		i.image, err = graphics.NewImage(i.width, i.height, glFilter(i.filter))
		if err != nil {
			return err
		}
		return nil
	}
	var err error
	i.image, err = i.restorable.CreateImage(context, i.width, i.height, glFilter(i.filter))
	if err != nil {
		return err
	}
	return nil
}

func (i *imageImpl) Dispose() error {
	i.m.Lock()
	defer i.m.Unlock()
	if i.disposed {
		return errors.New("ebiten: image is already disposed")
	}
	if !i.screen {
		if err := i.image.Dispose(); err != nil {
			return err
		}
	}
	i.image = nil
	i.disposed = true
	i.restorable.Clear()
	runtime.SetFinalizer(i, nil)
	return nil
}

func (i *imageImpl) ReplacePixels(p []uint8) error {
	if l := 4 * i.width * i.height; len(p) != l {
		return fmt.Errorf("ebiten: p's length must be %d", l)
	}
	i.m.Lock()
	defer i.m.Unlock()
	i.restorable.ReplacePixels(p)
	if i.disposed {
		return errors.New("ebiten: image is already disposed")
	}
	return i.image.ReplacePixels(p)
}

func (i *imageImpl) isDisposed() bool {
	i.m.Lock()
	defer i.m.Unlock()
	return i.disposed
}

func (i *imageImpl) isInvalidated(context *opengl.Context) bool {
	i.m.Lock()
	defer i.m.Unlock()
	return i.image.IsInvalidated(context)
}