mame/video/psikyosh.cpp

// license:BSD-3-Clause
// copyright-holders:David Haywood, Paul Priest
/*
Psikyo PS6406B (PS3v1/PS5/PS5v2):
See src/mame/drivers/psikyosh.cpp for more info

Hardware is extremely flexible (and luckily underused, although we now have a relatively complete implementation :). Many effects are subtle (e.g. fades, scanline effects).

Banks:
There are 32 data banks of 0x800 bytes starting at 0x3000000 (ps3) / 0x4000000 (ps5/ps5v2)

Can be one of:
* a set of adjacent banks for sprites (we always use the first 7 banks currently, looks to be configurable in vidregs
* a sprite draw list (max 1024 sprites, always in bank 07?)
* pre (i.e. screen clear) + post (i.e. drawn with a non-zero priority) line-fill/blend layer (usually bank 08)
* tilemap tiles (or 2 adjacent banks for large tilemaps) (usually banks 0c-1f)
* xscroll/yscroll, pri/xzoom/alpha/bank per-layer (of which there are four) -> which points to another tilebank per-layer (usually bank 0a/0b)
* xscroll/yscroll, pri/xzoom/alpha/bank per-scanline (typically 224) -> which points to another tilebank per-line (usually bank 0c/0d)

Most games use bank 0x0a and 0x0b for the registers for double-buffering, which then refer to other banks for the tiles. If they use line-effects, they tend to populate the per-line registers into one of the other banks e.g. daraku or S1945II test+level 7+level8 boss and S1945III levels 7+8, soldivid final boss.
*/

/*
BG Scroll/Priority/Zoom/Alpha/Tilebank registers:
Either at 0x30053f0/4/8 (For 0a), 0x3005bf0/4/8 (For 0b) etc. (i.e. in the middle of a bank) Or per-line in a bank
   0x?vvv?xxx - v = vertical scroll - x = x scroll
Either at 0x30057f0/4/8 (For 0a), 0x3005ff0/4/8 (For 0b) etc. (i.e. at the end of the bank) Or per-line in a bank
   0xppzzaabb - p = priority, z = zoom/expand(00 is none), a = alpha value/effect, b = tilebank

Video Registers: at 0x305ffe0 for ps3 or 0x405ffe0 for ps5/ps5v2:
0x00 -- ffffffff alpha values for sprites, 8-bits per value (0-0x3f, 0x80 indicates per-pen alpha). sbomberb = 0000 3830 2820 1810
0x04 -- ffffffff above continued.
0x08 -- ffff0000 priority values for sprites, 4-bits per value
        0000ff00 unknown. always 20. number of addressable banks? boards are populated with 20.
        000000f0 unknown. s1945ii/s1945iii/gunbird2/gnbarich/tgm2 sets to c. soldivid/daraku is 0. another bank select?
        0000000f is priority for per-line post-blending
0x0c -- 3f3f3f3f unknown. A table of 4 6-bit values. usually 0f102038. tgm2 is 0a172838.
        c0c00000 unknown. unused?
        0000c000 is flipscreen (currently ignored). presumably flipy<<1|flipx.
        000000c0 is screen size select. 0 is 224 lines, c is 240 (see tgm2, not confirmed).
0x10 -- ffff0000 is always 00aa
        0000f000 number of banks for sprites (not confirmed). mjgtaste/tgm2/sbomberb/s1945ii is 3, gunbird2/s1945iii is 2, soldivid/daraku is b.
        00000fff Controls gfx data bank available to be read by SH-2 for verification.
0x14 -- ffffffff always 83ff000e
0x18 -- ffffffff bank for tilemaps. As follows for the different tilemaps: 11223344. Bit 0x80 indicates use of line effects and the bank should be used to look up the tile-bank per line.
0x1c -- ff000000 controls bank for 'pre'/'post' values
        00ff0000 unknown, always 0?
        0000ffff enable bits for 4 tilemaps. 8 is enable. 4 indicates 8bpp tiles. 1 is size select for tilemap
*/

/*
TODO:
* Correct sprite-sprite priority? Currently this is strictly in the order of the sprites in the sprite list. However, there's an additional priority parameter which looks to split the sprites into 4 discrete sets with decreasing priority. In addition to the sprite-tilemap mixing the only way I can think to emulate this is how the hardware would work. Iterate over the sprite list 4 times rendering the sprites to a bitmap, and then mix each pixel against the tilemaps and other elements with comparable priority. This will be pretty slow though. Justification: The unknown priority bits are used to separate score/enemy bullets from ships/enemies from incidental effects. daraku appears to have a black, screen-filling srite which it uses for a flash immediately efore the screen fade/white flash when doing special moves. Currently obscured behind the other sprites.
* Perform tests on real hardware to document limits and remaining registers
** Fix background line zoom to be pixel-correct. There must be an internal LUT.
** Confirm existence of 4th tilemap layer on real hw by configuring it. No games ever get as far as enabling it.
** Confirm sprite-sprite priority behaviours (two overlapping sprites in sprite list order, with differing priorities etc.)
** Figure out why the sprite zoom is not 100% when we even have a lookup table. See TGM2 MT report. Possibly we should offset calcs by half a pixel (i.e. start in the middle of the first source pixel rather than corner).
** Figure out screen size registers and xflip/yflip
* Hookup configurable sprite banks (not needed? reports of tgm2 dropping sprites when busy on real hw)
* Hookup screen size select
* Flip screen, located but not implemented. wait until tilemaps.
* The stuff might be converted to use the tilemaps once all the features is worked out ...
The only viable way to do this is to have one tilemap per bank (0x0a-0x20), and every pair of adjacent banks for large tilemaps. This is rather than having one per background layer, due to the line effects. Would also need to support all of the logic relating to alpha table blending, row and column scroll/zoom etc.
*/

#include "emu.h"
#include "drawgfxt.ipp"
#include "includes/psikyosh.h"

#include <algorithm>

static constexpr u32 BG_TRANSPEN = 0x00ff00ff; // used for representing transparency in temporary bitmaps

//#define DEBUG_KEYS
//#define DEBUG_MESSAGE

// take ARGB pixel with stored alpha and blend in to RGB32 bitmap
#define PIXEL_OP_COPY_TRANSPEN_ARGBRENDER32(DEST, SOURCE)                                           \
do                                                                                                  \
{                                                                                                   \
	const rgb_t srcdata = (SOURCE);                                                                 \
	if (srcdata != transpen)                                                                        \
		(DEST) = alpha_blend_r32((DEST), srcdata, srcdata.a());                                     \
}                                                                                                   \
while (0)
// take RGB pixel with separate alpha and blend in to RGB32 bitmap
#define PIXEL_OP_COPY_TRANSPEN_ALPHARENDER32(DEST, SOURCE)                                          \
do                                                                                                  \
{                                                                                                   \
	const u32 srcdata = (SOURCE);                                                                   \
	if (srcdata != transpen)                                                                        \
		(DEST) = alpha_blend_r32((DEST), srcdata, alpha);                                           \
}                                                                                                   \
while (0)
// take ARGB pixel with stored alpha and copy in to RGB32 bitmap, scipping BG_TRANSPEN
#define PIXEL_OP_COPY_TRANSPEN_RENDER32(DEST, SOURCE)                                               \
do                                                                                                  \
{                                                                                                   \
	const u32 srcdata = (SOURCE);                                                                   \
	if (srcdata != transpen)                                                                        \
		(DEST) = srcdata;                                                                           \
}                                                                                                   \
while (0)

static inline void pixop_transparent_priority(u8 source, u32 *dest, u16 *pri, const pen_t *pal, u16 z)
{
	if (z >= *pri)
	{
		if (source != 0)
		{
			*dest = pal[source];
			*pri = z;
		}
	}
}

static inline void pixop_transparent(u8 source, u32 *dest, const pen_t *pal)
{
	if (source != 0)
		*dest = pal[source];
}

static inline void pixop_transparent_alpha_priority(u8 source, u32 *dest, u16 *pri, const pen_t *pal, u16 z, s16 alpha)
{
	if (z >= *pri)
	{
		if (source != 0)
		{
			*dest = alpha_blend_r32(*dest, pal[source], alpha);
			*pri = z;
		}
	}
}

static inline void pixop_transparent_alpha(u8 source, u32 *dest, const pen_t *pal, s16 alpha)
{
	if (source != 0)
		*dest = alpha_blend_r32(*dest, pal[source], alpha);
}

static inline void pixop_transparent_alphatable_priority(u8 source, u32 *dest, u16 *pri, const pen_t *pal, u16 z, u8 *alphatable)
{
	if (z >= *pri)
	{
		if (source != 0)
		{
			if (alphatable[source] == 0xff)
				*dest = pal[source];
			else
				*dest = alpha_blend_r32(*dest, pal[source], alphatable[source]);

			*pri = z;
		}
	}
}

static inline void pixop_transparent_alphatable(u8 source, u32 *dest, const pen_t *pal, u8 *alphatable)
{
	if (source != 0)
	{
		if (alphatable[source] == 0xff)
			*dest = pal[source];
		else
			*dest = alpha_blend_r32(*dest, pal[source], alphatable[source]);
	}
}
/*-------------------------------------------------
    draw_scanline32_alpha - take an RGB-encoded u32
    scanline and alpha-blend it into the destination bitmap
-------------------------------------------------*/
void psikyosh_state::draw_scanline32_alpha(bitmap_rgb32 &bitmap, s32 destx, s32 desty, s32 length, const u32 *srcptr, int alpha)
{
	drawscanline_core(bitmap, destx, desty, length, srcptr, [alpha, transpen = BG_TRANSPEN](u32 &destp, const u32 &srcp) { PIXEL_OP_COPY_TRANSPEN_ALPHARENDER32(destp, srcp); });
}

/*-------------------------------------------------
    draw_scanline32_argb - take an ARGB-encoded u32
    scanline and alpha-blend it into the destination bitmap
-------------------------------------------------*/
void psikyosh_state::draw_scanline32_argb(bitmap_rgb32 &bitmap, s32 destx, s32 desty, s32 length, const u32 *srcptr)
{
	drawscanline_core(bitmap, destx, desty, length, srcptr, [transpen = BG_TRANSPEN](u32 &destp, const u32 &srcp) { PIXEL_OP_COPY_TRANSPEN_ARGBRENDER32(destp, srcp); });
}

/*-------------------------------------------------
    draw_scanline32_tranpens - take an RGB-encoded u32
    scanline and copy it into the destination bitmap, testing for the special ARGB transpen
-------------------------------------------------*/
void psikyosh_state::draw_scanline32_transpen(bitmap_rgb32 &bitmap, s32 destx, s32 desty, s32 length, const u32 *srcptr)
{
	drawscanline_core(bitmap, destx, desty, length, srcptr, [transpen = BG_TRANSPEN](u32 &destp, const u32 &srcp) { PIXEL_OP_COPY_TRANSPEN_RENDER32(destp, srcp); });
}


/* Psikyo PS6406B */
/* --- BACKGROUNDS --- */

/* 'Normal' layers, no line/columnscroll. No per-line effects.
Zooming isn't supported just because it's not used and it would be slow */
void psikyosh_state::draw_bglayer(u8 const layer, bitmap_rgb32 &bitmap, const rectangle &cliprect, u8 const req_pri)
{
	assert(!BG_LINE(layer));

	gfx_element *gfx = BG_DEPTH_8BPP(layer) ? m_gfxdecode->gfx(1) : m_gfxdecode->gfx(0);
	u8 const size = BG_LARGE(layer) ? 32 : 16;
	u16 const height = 16 * size;

	u8 const regbank = BG_TYPE(layer);

	u16 const scrollx = (m_spriteram[(regbank * 0x800) / 4 + 0x3f0 / 4 + (layer * 0x04) / 4] & 0x000001ff) >> 0;
	u16 const scrolly = (m_spriteram[(regbank * 0x800) / 4 + 0x3f0 / 4 + (layer * 0x04) / 4] & 0x03ff0000) >> 16;

	u8 const tilebank = (m_spriteram[(regbank * 0x800) / 4 + 0x7f0 / 4 + (layer * 0x04) / 4] & 0x000000ff) >> 0;
	s16 alpha         = (m_spriteram[(regbank * 0x800) / 4 + 0x7f0 / 4 + (layer * 0x04) / 4] & 0x00003f00) >> 8;
	u8 const alphamap = (m_spriteram[(regbank * 0x800) / 4 + 0x7f0 / 4 + (layer * 0x04) / 4] & 0x00008000) >> 15;
	u8 const zoom     = (m_spriteram[(regbank * 0x800) / 4 + 0x7f0 / 4 + (layer * 0x04) / 4] & 0x00ff0000) >> 16;
	u8 const pri      = (m_spriteram[(regbank * 0x800) / 4 + 0x7f0 / 4 + (layer * 0x04) / 4] & 0xff000000) >> 24;

	if (pri != req_pri)
		return;

	if (alphamap) /* alpha values are per-pen */
		alpha = -1;
	else
		alpha = pal6bit(0x3f - alpha);  /* 0x3f-0x00 maps to 0x00-0xff */

	if (zoom)
		popmessage("draw_bglayer() zoom not implemented\nContact MAMEDEV");

	if ((tilebank >= 0x0a) && (tilebank <= 0x1f)) /* 20 banks of 0x800 bytes. filter garbage. */
	{
		u8 basey = ((0x400 - scrolly + cliprect.top() - 1) & (height - 1)) >> 4;
		for (int sy = (cliprect.top() - 1) >> 4; sy <= cliprect.bottom() >> 4; sy++)
		{
			u8 basex = ((0x200 - scrollx + cliprect.left() - 1) & 0x1ff) >> 4;
			for (int sx = (cliprect.left() - 1) >> 4; sx <= cliprect.right() >> 4; sx++)
			{
				u32 const tileno = (m_spriteram[(tilebank * 0x800) / 4 + (((basey & 0x1f) << 5) | (basex & 0x1f))] & 0x0007ffff);
				u8 const colour  = (m_spriteram[(tilebank * 0x800) / 4 + (((basey & 0x1f) << 5) | (basex & 0x1f))] & 0xff000000) >> 24;

				gfx->alphatable(bitmap, cliprect, tileno, colour, 0, 0, (16 * sx) + (scrollx & 0xf), (16 * sy) + (scrolly & 0xf), alpha, m_alphatable.get()); /* normal */

				basex++;
			}
			basey = ((basey + 1) & ((height >> 4) - 1));
		}
	}
}


/* populate bg_bitmap for the given bank if it's not already */
void psikyosh_state::cache_bitmap(s16 const scanline, gfx_element *gfx, u8 const size, u8 const tilebank, s16 const alpha, u8 *last_bank)
{
	// test if the tile row is the cached one or not
	u8 const sy = scanline / 16;

	assert(sy >= 0 && sy < 32);

	if (tilebank != last_bank[sy])
	{
		rectangle cliprect;
		u16 const minsy = sy * 16;
		u16 const maxsy = minsy + 16 - 1;

		cliprect.set(0, m_bg_bitmap.width() - 1, minsy, maxsy );
		cliprect &= m_bg_bitmap.cliprect();

		m_bg_bitmap.fill(BG_TRANSPEN, cliprect);
		u16 const height = size * 16;

		u32 offs = 32 * sy;
		for (int sx = 0; sx < 32; sx++)
		{
			u32 const tileno = (m_spriteram[(tilebank * 0x800) / 4 + offs] & 0x0007ffff);
			u32 const colour = (m_spriteram[(tilebank * 0x800) / 4 + offs] & 0xff000000) >> 24;
			int need_alpha = alpha < 0 ? -1 : 0xff; // store per-pen alpha in bitmap, otherwise don't since we'll need it per-line

			if (tileno) // valid tile, but blank in all games?
				gfx->alphastore(m_bg_bitmap, m_bg_bitmap.cliprect(), tileno, colour, 0, 0, (16 * sx) & 0x1ff, ((16 * sy) & (height - 1)), need_alpha, m_alphatable.get());

			offs++;
		}
		last_bank[sy] = tilebank;
	}
}


/* Row Scroll/Zoom and/or Column Zoom, has per-column Alpha/Bank/Priority
Bitmap is first rendered to an ARGB image, taking into account the per-pen alpha (if used).
From there we extract data as we compose the image, one scanline at a time, blending the ARGB pixels
into the RGB32 bitmap (with either the alpha information from the ARGB, or per-line alpha */
void psikyosh_state::draw_bglayerscroll(u8 const layer, bitmap_rgb32 &bitmap, const rectangle &cliprect, u8 const req_pri)
{
	assert(BG_LINE(layer));

	gfx_element *gfx = BG_DEPTH_8BPP(layer) ? m_gfxdecode->gfx(1) : m_gfxdecode->gfx(0);
	u8 const size = BG_LARGE(layer) ? 32 : 16;
	u16 const height = size * 16;

	u8 const linebank = BG_TYPE(layer);

	/* cache rendered bitmap */
	u8 last_bank[32]; // corresponds to bank of bitmap in m_bg_bitmap. bg_bitmap is split into 16/32-rows of one-tile high each
	for (auto & elem : last_bank) elem = -1;

	int const scr_width = cliprect.width();
	u32 *scroll_reg = &m_spriteram[(linebank * 0x800) / 4 + cliprect.top()];
	u32 *pzab_reg   = &m_spriteram[(linebank * 0x800) / 4 + cliprect.top() + 0x400 / 4]; // pri, zoom, alpha, bank

// now, for each scanline, check priority,
// extract the relevant scanline from the bitmap, after applying per-scanline vscroll,
// stretch it and scroll it into another buffer
// write it with alpha
	for (int scanline = cliprect.top(); scanline <= cliprect.bottom(); scanline++)
	{
		u8 const pri = (*pzab_reg & 0xff000000) >> 24;

		if (pri == req_pri)
		{
			u16 const scrollx  = (*scroll_reg & 0x000001ff) >> 0;
			u16 const scrolly  = (*scroll_reg & 0x03ff0000) >> 16;

			u8 const zoom      = (*pzab_reg & 0x00ff0000) >> 16;
			u8 const alphamap  = (*pzab_reg & 0x00008000) >> 15;
			s16 alpha          = (*pzab_reg & 0x00003f00) >> 8;
			u8 const tilebank  = (*pzab_reg & 0x000000ff) >> 0;

			if (alphamap) /* alpha values are per-pen */
				alpha = -1;
			else
				alpha = pal6bit(0x3f - alpha);

			if ((tilebank >= 0x0a) && (tilebank <= 0x1f)) /* 20 banks of 0x800 bytes. filter garbage. */
			{
				u16 const tilemap_scanline = (scanline - scrolly + 0x400) & (height - 1);

				// render reelvant tiles to temp bitmap, assume bank changes infrequently/never. render alpha as per-pen
				cache_bitmap(tilemap_scanline, gfx, size, tilebank, alpha, last_bank);

				/* zoomy and 'wibbly' effects - extract an entire row from tilemap */
				g_profiler.start(PROFILER_USER2);
				u32 tilemap_line[32 * 16];
				u32 scr_line[64 * 8];
				std::copy_n(&m_bg_bitmap.pix(tilemap_scanline, 0), 0x200, tilemap_line);
				g_profiler.stop();

				/* slow bit, needs optimising. apply scrollx and zoomx by assembling scanline from row */
				g_profiler.start(PROFILER_USER3);
				if (zoom)
				{
					u16 const step = m_bg_zoom[zoom];
					int jj = (0x400 << 10) + (step * cliprect.left()); // ensure +ve for mod
					for (int ii = cliprect.left(); ii <= cliprect.right(); ii++)
					{
						scr_line[ii] = tilemap_line[((jj>>10) - scrollx) & 0x1ff];
						jj += step;
					}
				}
				else
				{
					for (int ii = cliprect.left(); ii <= cliprect.right(); ii++)
						scr_line[ii] = tilemap_line[(ii - scrollx + 0x400) & 0x1ff];
				}
				g_profiler.stop();

				/* blend line into output */
				g_profiler.start(PROFILER_USER4);
				if (alpha == 0xff)
					draw_scanline32_transpen(bitmap, cliprect.left(), scanline, scr_width, &scr_line[cliprect.left()]);
				else if (alpha > 0)
					draw_scanline32_alpha(bitmap, cliprect.left(), scanline, scr_width, &scr_line[cliprect.left()], alpha);
				else if (alpha < 0)
					draw_scanline32_argb(bitmap, cliprect.left(), scanline, scr_width, &scr_line[cliprect.left()]);

				g_profiler.stop();
			}
		}

		scroll_reg++;
		pzab_reg++;
	}
}

/* 3 BG layers, with priority */
void psikyosh_state::draw_background(bitmap_rgb32 &bitmap, const rectangle &cliprect, u8 const req_pri)
{
	int i;

#ifdef DEBUG_KEYS
	const int lay_keys[8] = {KEYCODE_Q, KEYCODE_W, KEYCODE_E, KEYCODE_R};
	bool lay_debug = false;
	for (i = 0; i <= 3; i++)
	{
		if (machine().input().code_pressed(lay_keys[i]))
			lay_debug = true;

	}
#endif

	/* 1st-4th layers */
	for (i = 0; i <= 3; i++)
	{
#ifdef DEBUG_KEYS
		if (lay_debug && !machine().input().code_pressed(lay_keys[i]))
			continue;
#endif

		if (!BG_LAYER_ENABLE(i))
			continue;

		if (BG_LINE(i)) /* per-line alpha, scroll, zoom etc. check the priority for the first scanline */
			draw_bglayerscroll(i, bitmap, cliprect, req_pri);
		else /* not per-line alpha, scroll, zoom etc. */
			draw_bglayer(i, bitmap, cliprect, req_pri);

	}
}

/* --- SPRITES --- */

/* 32-bit ONLY */
/* zoomx/y are pixel slopes in 6.10 fixed point, not scale. 0x400 is 1:1. drawgfx zoom algorithm doesn't produce identical results to hardware. */
/* high/wide are number of tiles wide/high up to max size of zoom_bitmap in either direction */
/* code is index of first tile and incremented across rows then down columns (adjusting for flip obviously) */
/* sx and sy is top-left of entire sprite regardless of flip */
/* Note that Level 5-4 of sbomberb boss is perfect! (Alpha blended zoomed) as well as S1945II logo */
/* pixel is only plotted if z is >= priority_buffer[y][x] */
void psikyosh_state::psikyosh_drawgfxzoom(bitmap_rgb32 &dest_bmp, const rectangle &clip, gfx_element *gfx,
		u32 const code, u16 const color, u8 const flipx, u8 const flipy, s32 const offsx, s32 const offsy,
		s16 const alpha, u32 const zoomx, u32 const zoomy, u8 const wide, u8 const high, u16 const z)
{
	rectangle myclip; /* Clip to screen boundaries */
	int code_offset = 0;

	if (!zoomx || !zoomy)
		return;

	g_profiler.start(PROFILER_DRAWGFX);

	assert(dest_bmp.bpp() == 32);

	/* KW 991012 -- Added code to force clip to bitmap boundary */
	myclip = clip;
	myclip &= dest_bmp.cliprect();

	/* Temporary fallback for non-zoomed, needs z-buffer. Note that this is probably a lot slower than drawgfx.c, especially if there was separate code for flipped cases */
	if (zoomx == 0x400 && zoomy == 0x400)
	{
		int xstart, ystart, xend, yend, xinc, yinc;

		if (flipx)  { xstart = wide - 1; xend = -1;   xinc = -1; }
		else        { xstart = 0;        xend = wide; xinc = +1; }

		if (flipy)  { ystart = high - 1; yend = -1;   yinc = -1; }
		else        { ystart = 0;        yend = high; yinc = +1; }

		/* Start drawing */
		if (gfx)
		{
			for (int ytile = ystart; ytile != yend; ytile += yinc)
			{
				for (int xtile = xstart; xtile != xend; xtile += xinc)
				{
					const pen_t *pal = &m_palette->pen(gfx->colorbase() + gfx->granularity() * (color % gfx->colors()));
					const u8 *code_base = gfx->get_data((code + code_offset++) % gfx->elements());

					int x_index_base, y_index;

					if (flipx)  { x_index_base = gfx->width() - 1; }
					else        { x_index_base = 0; }

					if (flipy)  { y_index = gfx->height()-1; }
					else        { y_index = 0; }

					/* start coordinates */
					int sx = offsx + xtile * gfx->width();
					int sy = offsy + ytile * gfx->height();

					/* end coordinates */
					int ex = sx + gfx->width();
					int ey = sy + gfx->height();

					if (sx < myclip.left())
					{ /* clip left */
						const int pixels = myclip.left() - sx;
						sx += pixels;
						x_index_base += xinc * pixels;
					}
					if (sy < myclip.top())
					{ /* clip top */
						const int pixels = myclip.top() - sy;
						sy += pixels;
						y_index += yinc * pixels;
					}
					/* NS 980211 - fixed incorrect clipping */
					if (ex > myclip.right() + 1)
					{ /* clip right */
						const int pixels = ex - myclip.right() - 1;
						ex -= pixels;
					}
					if (ey > myclip.bottom() + 1)
					{ /* clip bottom */
						const int pixels = ey - myclip.bottom() - 1;
						ey -= pixels;
					}

					if (ex > sx)
					{ /* skip if inner loop doesn't draw anything */

						/* case 1: no alpha */
						if (alpha == 0xff)
						{
							if (z > 0)
							{
								const u8 *source = code_base + (y_index) * gfx->rowbytes() + x_index_base;
								u32 *dest = &dest_bmp.pix(sy, sx);
								u16 *pri = &m_z_bitmap.pix(sy, sx);
								const int src_modulo = yinc * gfx->rowbytes() - xinc * (ex - sx);
								const int dst_modulo = dest_bmp.rowpixels() - (ex - sx);

								for (int y = sy; y < ey; y++)
								{
									for (int x = sx; x < ex; x++)
									{
										pixop_transparent_priority(*source, dest, pri, pal, z);
										dest++;
										pri++;
										source += xinc;
									}
									dest += dst_modulo;
									pri += dst_modulo;
									source += src_modulo;
								}
							}
							else
							{
								const u8 *source = code_base + y_index * gfx->rowbytes() + x_index_base;
								u32 *dest = &dest_bmp.pix(sy, sx);
								const int src_modulo = yinc * gfx->rowbytes() - xinc * (ex - sx);
								const int dst_modulo = dest_bmp.rowpixels() - (ex - sx);

								for (int y = sy; y < ey; y++)
								{
									for (int x = sx; x < ex; x++)
									{
										pixop_transparent(*source, dest, pal);
										dest++;
										source += xinc;
									}
									dest += dst_modulo;
									source += src_modulo;
								}
							}
						}

						/* case 6: alpha-blended */
						else if (alpha >= 0)
						{
							if (z > 0)
							{
								const u8 *source = code_base + y_index * gfx->rowbytes() + x_index_base;
								u32 *dest = &dest_bmp.pix(sy, sx);
								u16 *pri = &m_z_bitmap.pix(sy, sx);
								const int src_modulo = yinc * gfx->rowbytes() - xinc * (ex - sx);
								const int dst_modulo = dest_bmp.rowpixels() - (ex - sx);

								for (int y = sy; y < ey; y++)
								{
									for (int x = sx; x < ex; x++)
									{
										pixop_transparent_alpha_priority(*source, dest, pri, pal, z, alpha);
										dest++;
										pri++;
										source += xinc;
									}
									dest += dst_modulo;
									pri += dst_modulo;
									source += src_modulo;
								}
							}
							else
							{
								const u8 *source = code_base + y_index * gfx->rowbytes() + x_index_base;
								u32 *dest = &dest_bmp.pix(sy, sx);
								const int src_modulo = yinc * gfx->rowbytes() - xinc * (ex - sx);
								const int dst_modulo = dest_bmp.rowpixels() - (ex - sx);

								for (int y = sy; y < ey; y++)
								{
									for (int x = sx; x < ex; x++)
									{
										pixop_transparent_alpha(*source, dest, pal, alpha);
										dest++;
										source += xinc;
									}
									dest += dst_modulo;
									source += src_modulo;
								}
							}
						}

						/* pjp 31/5/02 */
						/* case 7: TRANSPARENCY_ALPHARANGE */
						else
						{
							if (z > 0)
							{
								const u8 *source = code_base + y_index * gfx->rowbytes() + x_index_base;
								u32 *dest = &dest_bmp.pix(sy, sx);
								u16 *pri = &m_z_bitmap.pix(sy, sx);
								const int src_modulo = yinc * gfx->rowbytes() - xinc * (ex - sx);
								const int dst_modulo = dest_bmp.rowpixels() - (ex - sx);

								for (int y = sy; y < ey; y++)
								{
									for (int x = sx; x < ex; x++)
									{
										pixop_transparent_alphatable_priority(*source, dest, pri, pal, z, m_alphatable.get());
										dest++;
										pri++;
										source += xinc;
									}
									dest += dst_modulo;
									pri += dst_modulo;
									source += src_modulo;
								}
							}
							else
							{
								const u8 *source = code_base + y_index * gfx->rowbytes() + x_index_base;
								u32 *dest = &dest_bmp.pix(sy, sx);
								const int src_modulo = yinc * gfx->rowbytes() - xinc * (ex - sx);
								const int dst_modulo = dest_bmp.rowpixels() - (ex - sx);

								for (int y = sy; y < ey; y++)
								{
									for (int x = sx; x < ex; x++)
									{
										pixop_transparent_alphatable(*source, dest, pal, m_alphatable.get());
										dest++;
										source += xinc;
									}
									dest += dst_modulo;
									source += src_modulo;
								}
							}
						}

					}
				}
			}
		}
	}
	else /* Zoomed */
	{
		/* Make a copy of complete sprite at top-left of zoom_bitmap */
		/* Because I'm too slow to get it to work on the fly */
		for (int ytile = 0; ytile < high; ytile++)
		{
			for (int xtile = 0; xtile < wide; xtile++)
			{
				const u8 *code_base = gfx->get_data((code + code_offset++) % gfx->elements());
				for (int ypixel = 0; ypixel < gfx->height(); ypixel++)
				{
					const u8 *source = code_base + ypixel * gfx->rowbytes();
					u8 *dest = &m_zoom_bitmap.pix(ypixel + ytile*gfx->height());

					for (int xpixel = 0; xpixel < gfx->width(); xpixel++)
					{
						dest[xpixel + xtile*gfx->width()] = source[xpixel];
					}
				}
			}
		}

		/* Start drawing */
		if (gfx)
		{
			const pen_t *pal = &m_palette->pen(gfx->colorbase() + gfx->granularity() * (color % gfx->colors()));

			const int sprite_screen_height = ((high * gfx->height() * (0x400 * 0x400)) / zoomy + 0x200) >> 10; /* Round up to nearest pixel */
			const int sprite_screen_width = ((wide * gfx->width() * (0x400 * 0x400)) / zoomx + 0x200) >> 10;

			if (sprite_screen_width && sprite_screen_height)
			{
				/* start coordinates */
				int sx = offsx;
				int sy = offsy;

				/* end coordinates */
				int ex = sx + sprite_screen_width;
				int ey = sy + sprite_screen_height;

				int x_index_base;
				int y_index;

				int dx, dy;

				if (flipx)  { x_index_base = (sprite_screen_width - 1) * zoomx; dx = -zoomx; }
				else        { x_index_base = 0; dx = zoomx; }

				if (flipy)  { y_index = (sprite_screen_height - 1) * zoomy; dy = -zoomy; }
				else        { y_index = 0; dy = zoomy; }

				if (sx < myclip.left())
				{ /* clip left */
					const int pixels = myclip.left() - sx;
					sx += pixels;
					x_index_base += pixels * dx;
				}
				if (sy < myclip.top())
				{ /* clip top */
					const int pixels = myclip.top() - sy;
					sy += pixels;
					y_index += pixels * dy;
				}
				/* NS 980211 - fixed incorrect clipping */
				if (ex > myclip.right() + 1)
				{ /* clip right */
					const int pixels = ex-myclip.right() - 1;
					ex -= pixels;
				}
				if (ey > myclip.bottom() + 1)
				{ /* clip bottom */
					const int pixels = ey-myclip.bottom() - 1;
					ey -= pixels;
				}

				if (ex > sx)
				{ /* skip if inner loop doesn't draw anything */

					/* case 1: no alpha */
					/* Note: adjusted to >>10 and draws from zoom_bitmap not gfx */
					if (alpha == 0xff)
					{
						if (z > 0)
						{
							for (int y = sy; y < ey; y++)
							{
								const u8 *source = &m_zoom_bitmap.pix(y_index >> 10);
								u32 *dest = &dest_bmp.pix(y);
								u16 *pri = &m_z_bitmap.pix(y);

								int x_index = x_index_base;
								for (int x = sx; x < ex; x++)
								{
									pixop_transparent_priority(source[x_index >> 10], &dest[x], &pri[x], pal, z);
									x_index += dx;
								}

								y_index += dy;
							}
						}
						else
						{
							for (int y = sy; y < ey; y++)
							{
								const u8 *source = &m_zoom_bitmap.pix(y_index >> 10);
								u32 *dest = &dest_bmp.pix(y);

								int x_index = x_index_base;
								for (int x = sx; x < ex; x++)
								{
									pixop_transparent(source[x_index >> 10], &dest[x], pal);
									x_index += dx;
								}

								y_index += dy;
							}
						}
					}

					/* case 6: alpha-blended */
					else if (alpha >= 0)
					{
						if (z > 0)
						{
							for (int y = sy; y < ey; y++)
							{
								const u8 *source = &m_zoom_bitmap.pix(y_index >> 10);
								u32 *dest = &dest_bmp.pix(y);
								u16 *pri = &m_z_bitmap.pix(y);

								int x_index = x_index_base;
								for (int x = sx; x < ex; x++)
								{
									pixop_transparent_alpha_priority(source[x_index >> 10], &dest[x], &pri[x], pal, z, alpha);
									x_index += dx;
								}

								y_index += dy;
							}
						}
						else
						{
							for (int y = sy; y < ey; y++)
							{
								const u8 *source = &m_zoom_bitmap.pix(y_index >> 10);
								u32 *dest = &dest_bmp.pix(y);

								int x_index = x_index_base;
								for (int x = sx; x < ex; x++)
								{
									pixop_transparent_alpha(source[x_index >> 10], &dest[x], pal, alpha);
									x_index += dx;
								}

								y_index += dy;
							}
						}
					}

					/* case 7: TRANSPARENCY_ALPHARANGE */
					else
					{
						if (z > 0)
						{
							for (int y = sy; y < ey; y++)
							{
								const u8 *source = &m_zoom_bitmap.pix(y_index >> 10);
								u32 *dest = &dest_bmp.pix(y);
								u16 *pri = &m_z_bitmap.pix(y);

								int x_index = x_index_base;
								for (int x = sx; x < ex; x++)
								{
									pixop_transparent_alphatable_priority(source[x_index >> 10], &dest[x], &pri[x], pal, z, m_alphatable.get());
									x_index += dx;
								}

								y_index += dy;
							}
						}
						else
						{
							for (int y = sy; y < ey; y++)
							{
								const u8 *source = &m_zoom_bitmap.pix(y_index >> 10);
								u32 *dest = &dest_bmp.pix(y);

								int x_index = x_index_base;
								for (int x = sx; x < ex; x++)
								{
									pixop_transparent_alphatable(source[x_index >> 10], &dest[x], pal, m_alphatable.get());
									x_index += dx;
								}

								y_index += dy;
							}
						}
					}
				}
			}
		}
	}
	g_profiler.stop();
}


void psikyosh_state::get_sprites()
{
	/*- Sprite Format 0x0000 - 0x37ff -**

	0 ---- --yy yyyy yyyy | ---- --xx xxxx xxxx  1  F-?? hhhh ZZZZ ZZZZ | f-PP wwww zzzz zzzz
	2 pppp pppp -aaa -nnn | nnnn nnnn nnnn nnnn  3  ---- ---- ---- ---- | ---- ---- ---- ----

	y = ypos
	x = xpos

	h = height
	w = width

	F = flip (y)
	f = flip (x)

	Z = zoom (y)
	z = zoom (x)

	n = tile number

	p = palette

	a = alpha blending, selects which of the 8 alpha values in vid_regs[0-1] to use

	P = priority
	Points to a 4-bit entry in vid_regs[2] which provides a priority comparable with the bg layer's priorities.
	However, sprite-sprite priority needs to be preserved.
	daraku and soldivid only use the lsb

	? = unknown
	Could be a sprite-sprite priority, tests seem to back this up

	**- End Sprite Format -*/

	const u16 *list = (u16 *)(m_spriteram.target()) + 0x3800 / 2;
	u16 const listlen = 0x800 / 2;

	struct sprite_t *sprite_ptr = m_spritelist.get();
	u16 listcntr = 0;
	while (listcntr < listlen)
	{
		u16 const listdat = list[BYTE_XOR_BE(listcntr)];
		u16 const sprnum = (listdat & 0x03ff) * 4;

		s32 ypos = (m_spriteram[sprnum + 0] & 0x03ff0000) >> 16;
		s32 xpos = (m_spriteram[sprnum + 0] & 0x000003ff) >> 00;

		if (ypos & 0x200) ypos -= 0x400;
		if (xpos & 0x200) xpos -= 0x400;

		sprite_ptr->ypos    = ypos;
		sprite_ptr->xpos    = xpos;
		sprite_ptr->high    = ((m_spriteram[sprnum + 1] & 0x0f000000) >> 24) + 1;
		sprite_ptr->wide    = ((m_spriteram[sprnum + 1] & 0x00000f00) >> 8) + 1;

		sprite_ptr->flpy    = (m_spriteram[sprnum + 1] & 0x80000000) >> 31;
		sprite_ptr->spr_pri = (m_spriteram[sprnum + 1] & 0x30000000) >> 28;
		sprite_ptr->flpx    = (m_spriteram[sprnum + 1] & 0x00008000) >> 15;
		sprite_ptr->bg_pri  = (m_spriteram[sprnum + 1] & 0x00003000) >> 12;

		sprite_ptr->zoomy   = (m_spriteram[sprnum + 1] & 0x00ff0000) >> 16;
		sprite_ptr->zoomx   = (m_spriteram[sprnum + 1] & 0x000000ff) >> 00;

		sprite_ptr->tnum    = (m_spriteram[sprnum + 2] & 0x0007ffff) >> 00;
		sprite_ptr->dpth    = (m_spriteram[sprnum + 2] & 0x00800000) >> 23;
		sprite_ptr->colr    = (m_spriteram[sprnum + 2] & 0xff000000) >> 24;

		sprite_ptr->alpha   = (m_spriteram[sprnum + 2] & 0x00700000) >> 20;

		sprite_ptr++;
		listcntr++;
		if (listdat & 0x4000) break;
	}
	m_sprite_end = sprite_ptr;
}

void psikyosh_state::draw_sprites(bitmap_rgb32 &bitmap, const rectangle &cliprect, u8 const req_pri)
{
	const input_code spr_keys[8] = {KEYCODE_Y, KEYCODE_U, KEYCODE_I, KEYCODE_O};
	bool spr_debug = false;
#ifdef DEBUG_KEYS
	for (int i = 0; i <= 3; i++)
	{
		if (machine().input().code_pressed(spr_keys[i]))
			spr_debug = true;

	}
#endif

	gfx_element *gfx;
	const u16 *zoom_table = (u16 *)m_zoomram.target();
	const u8 *alpha_table = (u8 *)&(m_vidregs[0]);

	int i = 0;
	struct sprite_t *sprite_ptr = m_spritelist.get();

	while (sprite_ptr != m_sprite_end)
	{
		u8 const bg_pri = SPRITE_PRI(sprite_ptr->bg_pri);
		// sprite vs backgrounds pri
		if (bg_pri == req_pri)
		{
			u32 const zoomy   = zoom_table[BYTE_XOR_BE(sprite_ptr->zoomy)];
			u32 const zoomx   = zoom_table[BYTE_XOR_BE(sprite_ptr->zoomx)];
			s16 alpha         = sprite_ptr->alpha;

			u8 const alphamap = (alpha_table[BYTE4_XOR_BE(alpha)] & 0x80)? 1:0;
			alpha = alpha_table[BYTE4_XOR_BE(alpha)] & 0x3f;

			gfx = sprite_ptr->dpth ? m_gfxdecode->gfx(1) : m_gfxdecode->gfx(0);

			if (alphamap) /* alpha values are per-pen */
				alpha = -1;
			else
				alpha = pal6bit(0x3f - alpha); /* 0x3f-0x00 maps to 0x00-0xff */

			if (!spr_debug || machine().input().code_pressed(spr_keys[sprite_ptr->spr_pri]))
			{
				/* start drawing */
				if (zoomy && zoomx) /* Avoid division-by-zero when table contains 0 (Uninitialised/Bug) */
				{
					psikyosh_drawgfxzoom(bitmap, cliprect, gfx,
										sprite_ptr->tnum, sprite_ptr->colr,
										sprite_ptr->flpx, sprite_ptr->flpy,
										sprite_ptr->xpos, sprite_ptr->ypos, alpha,
										zoomx, zoomy, sprite_ptr->wide, sprite_ptr->high, i);
				}
				/* end drawing */
			}
		}
		i++;
		sprite_ptr++;
	}
}

void psikyosh_state::prelineblend(bitmap_rgb32 &bitmap, const rectangle &cliprect )
{
	/* There are 224 values for pre-lineblending. Using one for every row currently */
	/* I suspect that it should be blended against black by the amount specified as
	   gnbarich sets the 0x000000ff to 0x7f in test mode whilst the others use 0x80.
	   tgm2 sets it to 0x00 on warning screen. Likely has no effect. */
	u8 const bank = (m_vidregs[7] & 0xff000000) >> 24; /* bank is always 8 (0x4000) except for daraku/soldivid */
	u32 const *linefill = &m_spriteram[(bank * 0x800) / 4]; /* Per row */

	assert(bitmap.bpp() == 32);

	g_profiler.start(PROFILER_USER8);
	for (int y = cliprect.top(); y <= cliprect.bottom(); y++)
	{
		u32 *dstline = &bitmap.pix(y);

		/* linefill[y] & 0xff does what? */
		for (int x = cliprect.left(); x <= cliprect.right(); x++)
			dstline[x] = linefill[y] >> 8;
	}
	g_profiler.stop();
}


void psikyosh_state::postlineblend(bitmap_rgb32 &bitmap, const rectangle &cliprect, u8 const req_pri)
{
	/* There are 224 values for post-lineblending. Using one for every row currently */
	u8 const bank  = (m_vidregs[7] & 0xff000000) >> 24; /* bank is always 8 (i.e. 0x4000) except for daraku/soldivid */
	u32 const *lineblend = &m_spriteram[(bank * 0x800) / 4 + 0x400 / 4]; /* Per row */

	assert(bitmap.bpp() == 32);

	if ((m_vidregs[2] & 0xf) != req_pri)
		return;

	g_profiler.start(PROFILER_USER8);
	for (int y = cliprect.top(); y <= cliprect.bottom(); y++)
	{
		u32 *dstline = &bitmap.pix(y);

		if (lineblend[y] & 0x80) /* solid */
		{
			for (int x = cliprect.left(); x <= cliprect.right(); x++)
				dstline[x] = lineblend[y] >> 8;
		}
		else if (lineblend[y] & 0x7f) /* blended */
		{
			for (int x = cliprect.left(); x <= cliprect.right(); x++)
				dstline[x] = alpha_blend_r32(dstline[x], lineblend[y] >> 8, 2 * (lineblend[y] & 0x7f));
		}
	}
	g_profiler.stop();
}


void psikyosh_state::video_start()
{
	m_spritelist = std::make_unique<struct sprite_t []>(0x800/2);
	m_sprite_end = m_spritelist.get();

	m_screen->register_screen_bitmap(m_z_bitmap); /* z-buffer */
	m_zoom_bitmap.allocate(16*16, 16*16); /* temp buffer for assembling sprites */
	m_bg_bitmap.allocate(32*16, 32*16); /* temp buffer for assembling tilemaps */
	m_bg_zoom = std::make_unique<u16[]>(256);
	m_alphatable = std::make_unique<u8[]>(256);

	m_gfxdecode->gfx(1)->set_granularity(16); /* 256 colour sprites with palette selectable on 16 colour boundaries */

	/* Pens 0xc0-0xff have a gradient of alpha values associated with them */
	int i;
	for (i = 0; i < 0xc0; i++)
	{
		m_alphatable[i] = 0xff;
	}
	for (i = 0; i < 0x40; i++)
	{
		int const alpha = pal6bit(0x3f - i);
		m_alphatable[i + 0xc0] = alpha;
	}

	/* precompute the background zoom table. verified against hardware.
	   unsure of the precision, we use .10 fixed point like the sprites */
	for (i = 0; i < 0x100; i++)
	{
		m_bg_zoom[i] = (64 * 0x400) / (i + 64);
	}

	save_item(NAME(m_z_bitmap));
	save_item(NAME(m_zoom_bitmap));
	save_item(NAME(m_bg_bitmap));
	save_pointer(NAME(m_bg_zoom), 256);
}


u32 psikyosh_state::screen_update(screen_device &screen, bitmap_rgb32 &bitmap, const rectangle &cliprect)/* Note the z-buffer on each sprite to get correct priority */
{
	int i;

	// show only the priority associated with a given keypress(s) and/or hide sprites/tilemaps
	int pri_debug = false;
	int sprites = true;
	int backgrounds = true;
	const input_code pri_keys[8] = {KEYCODE_Z, KEYCODE_X, KEYCODE_C, KEYCODE_V, KEYCODE_B, KEYCODE_N, KEYCODE_M, KEYCODE_K};
#ifdef DEBUG_KEYS
	for (i = 0; i <= 7; i++)
	{
		if (machine().input().code_pressed(pri_keys[i]))
			pri_debug = true;

	}
	if (machine().input().code_pressed(KEYCODE_G))
		sprites = false;

	if (machine().input().code_pressed(KEYCODE_H))
		backgrounds = false;

#endif

#ifdef DEBUG_MESSAGE
popmessage   ("%08x %08x %08x %08x\n%08x %08x %08x %08x",
	m_vidregs[0], m_vidregs[1],
	m_vidregs[2], m_vidregs[3],
	m_vidregs[4], m_vidregs[5],
	m_vidregs[6], m_vidregs[7]);
#endif

	m_z_bitmap.fill(0, cliprect); /* z-buffer */

	prelineblend(bitmap, cliprect); // fills screen
	for (i = 0; i <= 7; i++)
	{
		if (!pri_debug || machine().input().code_pressed(pri_keys[i]))
		{
			if (sprites)
				draw_sprites(bitmap, cliprect, i); // When same priority bg's have higher pri

			if (backgrounds)
				draw_background(bitmap, cliprect, i);

			postlineblend(bitmap, cliprect, i); // assume this has highest priority at same priority level
		}
	}
	return 0;
}

WRITE_LINE_MEMBER(psikyosh_state::screen_vblank)
{
	if (state)
	{
		get_sprites();
	}
}