ebiten/internal/shareable/shareable.go

// Copyright 2018 The Ebiten Authors
//
// 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 shareable

import (
	"fmt"
	"image/color"
	"runtime"

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

type backend struct {
	restorable *restorable.Image

	// If page is nil, the backend is not shared.
	page *packing.Page
}

func (b *backend) TryAlloc(width, height int) (*packing.Node, bool) {
	for {
		if n := b.page.Alloc(width, height); n != nil {
			return n, true
		}

		// Break without extending the backend since the current Extend
		// implementation includes a bug #562.
		// TODO: Fix #562 and implement Extend correctly
		break

		if !b.page.Extend() {
			break
		}

		s := b.page.Size()
		newImg := restorable.NewImage(s, s, false)
		newImg.DrawImage(b.restorable, 0, 0, s, s, nil, nil, opengl.CompositeModeCopy, graphics.FilterNearest)

		b.restorable.Dispose()
		b.restorable = newImg
	}
	return nil, false
}

var (
	// backendsM is a mutex for critical sections of the backend and packing.Node objects.
	backendsM sync.Mutex

	// theBackends is a set of actually shared images.
	theBackends = []*backend{}
)

type Image struct {
	backend *backend

	// If node is nil, the image is not shared.
	node *packing.Node
}

func (s *Image) ensureNotShared() {
	if s.node == nil {
		return
	}

	x, y, w, h := s.region()
	newImg := restorable.NewImage(w, h, false)
	newImg.DrawImage(s.backend.restorable, x, y, w, h, nil, nil, opengl.CompositeModeCopy, graphics.FilterNearest)

	s.dispose()
	s.backend = &backend{
		restorable: newImg,
	}
}

func (s *Image) region() (x, y, width, height int) {
	if s.node == nil {
		w, h := s.backend.restorable.Size()
		return 0, 0, w, h
	}
	return s.node.Region()
}

func (s *Image) Size() (width, height int) {
	backendsM.Lock()
	_, _, w, h := s.region()
	backendsM.Unlock()
	return w, h
}

func (s *Image) DrawImage(img *Image, sx0, sy0, sx1, sy1 int, geom *affine.GeoM, colorm *affine.ColorM, mode opengl.CompositeMode, filter graphics.Filter) {
	backendsM.Lock()
	defer backendsM.Unlock()
	s.drawImage(img, sx0, sy0, sx1, sy1, geom, colorm, mode, filter)
}

func (s *Image) drawImage(img *Image, sx0, sy0, sx1, sy1 int, geom *affine.GeoM, colorm *affine.ColorM, mode opengl.CompositeMode, filter graphics.Filter) {
	s.ensureNotShared()

	// Compare i and img after ensuring i is not shared, or
	// i and img might share the same texture even though i != img.
	if s.backend.restorable == img.backend.restorable {
		panic("shareable: Image.DrawImage: img must be different from the receiver")
	}

	dx, dy, _, _ := img.region()
	sx0 += dx
	sy0 += dy
	sx1 += dx
	sy1 += dy
	s.backend.restorable.DrawImage(img.backend.restorable, sx0, sy0, sx1, sy1, geom, colorm, mode, filter)
}

func (s *Image) ReplacePixels(p []byte) {
	backendsM.Lock()
	defer backendsM.Unlock()

	x, y, w, h := s.region()
	if l := 4 * w * h; len(p) != l {
		panic(fmt.Sprintf("shareable: len(p) was %d but must be %d", len(p), l))
	}
	s.backend.restorable.ReplacePixels(p, x, y, w, h)
}

func (s *Image) At(x, y int) (color.Color, error) {
	backendsM.Lock()

	ox, oy, w, h := s.region()
	if x < 0 || y < 0 || x >= w || y >= h {
		backendsM.Unlock()
		return color.RGBA{}, nil
	}

	clr, err := s.backend.restorable.At(x+ox, y+oy)
	backendsM.Unlock()
	return clr, err
}

func (s *Image) isDisposed() bool {
	return s.backend == nil
}

func (s *Image) Dispose() {
	backendsM.Lock()
	defer backendsM.Unlock()
	s.dispose()
}

func (s *Image) dispose() {
	if s.isDisposed() {
		return
	}

	defer func() {
		s.backend = nil
		s.node = nil
		runtime.SetFinalizer(s, nil)
	}()

	if s.node == nil {
		s.backend.restorable.Dispose()
		return
	}

	s.backend.page.Free(s.node)
	if !s.backend.page.IsEmpty() {
		return
	}

	index := -1
	for i, sh := range theBackends {
		if sh == s.backend {
			index = i
			break
		}
	}
	if index == -1 {
		panic("not reached")
	}
	theBackends = append(theBackends[:index], theBackends[index+1:]...)
}

func (s *Image) IsInvalidated() (bool, error) {
	backendsM.Lock()
	v, err := s.backend.restorable.IsInvalidated()
	backendsM.Unlock()
	return v, err
}

func NewImage(width, height int) *Image {
	const (
		initSize = 1024
		maxSize  = 4096
	)

	backendsM.Lock()
	defer backendsM.Unlock()

	if width > maxSize || height > maxSize {
		s := &backend{
			restorable: restorable.NewImage(width, height, false),
		}
		return &Image{
			backend: s,
		}
	}

	for _, b := range theBackends {
		if n, ok := b.TryAlloc(width, height); ok {
			return &Image{
				backend: b,
				node:    n,
			}
		}
	}
	size := initSize
	for width > size || height > size {
		if size == maxSize {
			panic("not reached")
		}
		size *= 2
	}

	b := &backend{
		restorable: restorable.NewImage(size, size, false),
		page:       packing.NewPage(size, maxSize),
	}
	theBackends = append(theBackends, b)

	n := b.page.Alloc(width, height)
	if n == nil {
		panic("not reached")
	}
	i := &Image{
		backend: b,
		node:    n,
	}
	runtime.SetFinalizer(i, (*Image).Dispose)
	return i
}

func NewVolatileImage(width, height int) *Image {
	r := restorable.NewImage(width, height, true)
	i := &Image{
		backend: &backend{
			restorable: r,
		},
	}
	runtime.SetFinalizer(i, (*Image).Dispose)
	return i
}

func NewScreenFramebufferImage(width, height int) *Image {
	r := restorable.NewScreenFramebufferImage(width, height)
	i := &Image{
		backend: &backend{
			restorable: r,
		},
	}
	runtime.SetFinalizer(i, (*Image).Dispose)
	return i
}