ikaruga/NinjaTexture.py

"""

 MIT License

 Copyright (c) 2020 Benjamin Collins (kion @ dashgl.com)

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

"""

import os
import sys
import struct

class NinjaTexture: # {

	# Color Formats
	ARGB_1555           = 0x00
	RGB_565             = 0x01
	ARGB_4444           = 0x02
	YUV_422             = 0x03
	BUMP                = 0x04
	RGB_555             = 0x05
	ARGB_8888           = 0x06
	YUV_420             = 0x06

	# Data Formats
	TWIDDLED            = 0x01
	TWIDDLED_MM         = 0x02
	VQ                  = 0x03
	VQ_MM               = 0x04
	PALETTIZE4          = 0x05
	PALETTIZE4_MM       = 0x06
	PALETTIZE8          = 0x07
	PALETTIZE8_MM       = 0x08
	RECTANGLE           = 0x09
	STRIDE              = 0x0B
	TWIDDLED_RECTANGLE  = 0x0D
	ABGR                = 0x0E
	ABGR_MM             = 0x0F
	SMALLVQ             = 0x10
	SMALLVQ_MM          = 0x11
	TWIDDLED_MM_ALIAS   = 0x12

	def __init__(self, filename): # {

		# File Information
		self.path = 'input/' + filename
		self.file = open(self.path, 'rb')
		self.length = os.path.getsize(self.path)

		# Textures
		self.tex_list = []
		self.pal_list = []

		return None

	def parse(self):
		print("Parsing the texture file")
		bytes = self.file.read(4)

		if bytes == 'PVMH':
			self.readPvm()
		elif bytes == 'PVRT':
			bytes = self.file.read(4)
			p = struct.unpack('I', bytes)
			pvrt_len = p[0]
			self.readPvr()
		
		return None

	def readPvm(self):
		
		bytes = self.file.read(4)
		p = struct.unpack('I', bytes)
		pvmh_len = p[0]
		save_pos = self.file.tell()
		
		bytes = self.file.read(4)
		p = struct.unpack('HH', bytes)
		flags = p[0]
		tex_count = p[1]
		
		local_list = []
		for i in range(tex_count):
			bytes = self.file.read(2)
			p = struct.unpack('H', bytes)
			tex = { 'id' : p[0] }

			if flags & 0x08:
				bytes = self.file.read(0x1c)
				tex['name'] = bytes.replace('\x00', '')
			if flags & 0x04:
				bytes = self.file.read(2)
				p = struct.unpack('H', bytes)
				tex['format'] = p[0] >> 8
			if flags & 0x02:
				bytes = self.file.read(2)
				p = struct.unpack('H', bytes)
				tex['size'] = p[0]
				lo_bytes = tex['size'] & 0x0f
				hi_bytes = (tex['size'] >> 4) & 0x0f
				tex['width'] = (1 << (lo_bytes + 2))
				tex['height'] = (1 << (hi_bytes + 2))
			if flags & 0x01:
				bytes = self.file.read(4)
				p = struct.unpack('I', bytes)
				tex['guid'] = p[0]

			local_list.append(tex)
		self.file.seek(pvmh_len + save_pos, 0)

		for tex in local_list:
			while self.file.tell() < self.length:
				bytes = self.file.read(4)
				if bytes != 'PVRT':
					continue
				break
			bytes = self.file.read(4)
			p = struct.unpack('I', bytes)
			save_pos = self.file.tell()
			pvrt_len = p[0]
			print("Reading Texture: %d" % tex['id'])
			self.readPvr(tex)
			self.file.seek(pvrt_len + save_pos, 0)

		return None

	def readPvr(self, info):
		print(info)

		# Read Header
		bytes = self.file.read(8)
		p = struct.unpack('BBHHH', bytes)

		self.color_format = p[0]
		self.data_format = p[1]
		self.width = p[3]
		self.height = p[4]

		print("Color Format: %d" % self.color_format)
		print("Data Format: %d" % self.data_format)
		print("Width: %d" % self.width)
		print("Height: %d" % self.height)

		self.isTwiddled = False
		self.isMipmap = False
		self.isCompressed = False
		self.codebook_size = 0
		self.mipWidth = self.width
		self.mipHeight = self.height

		twiddled = (
			NinjaTexture.TWIDDLED,
			NinjaTexture.TWIDDLED_MM,
			NinjaTexture.TWIDDLED_RECTANGLE,
			NinjaTexture.TWIDDLED_MM_ALIAS
		)
		
		mipmap = (
			NinjaTexture.TWIDDLED_MM,
			NinjaTexture.PALETTIZE4_MM,
			NinjaTexture.PALETTIZE8_MM,
			NinjaTexture.ABGR_MM,
			NinjaTexture.VQ_MM,
			NinjaTexture.SMALLVQ_MM
		)
		
		palette = (
			NinjaTexture.PALETTIZE4,
			NinjaTexture.PALETTIZE4_MM,
			NinjaTexture.PALETTIZE8,
			NinjaTexture.PALETTIZE8_MM
		)

		not_supported = (
			NinjaTexture.STRIDE,
			NinjaTexture.ABGR,
			NinjaTexture.ABGR_MM
		)

		if self.data_format in twiddled:
			self.isTwiddled = True

		if self.data_format in mipmap:
			self.isMipmap = True
		
		if self.data_format == NinjaTexture.VQ:
			self.isCompressed = true
			self.mipWidth = self.width / 2
			self.mipHeight = self.height / 2
			if self.width <= 16:
				self.codebook_size = 16
			elif self.width == 32:
				self.codebook_size = 32
			elif self.width == 64:
				self.codebook_size = 128
			else:
				self.codebook_size = 256
		elif self.data_format == NinjaTexture.VQ_MM:
			self.isCompressed = true
			self.mipWidth = self.width / 2
			self.mipHeight = self.height / 2
			if self.width <= 16:
				self.codebook_size = 16
			elif self.width == 32:
				self.codebook_size = 64
			else:
				self.codebook_size = 256

		if self.data_format in palette:
			print("NEED TO DEFINE A PALETTE!!!")
			sys.exit()

		if self.data_format in not_supported:
			print("THIS DATA FORMAT IS NOT SUPPORTED")
			sys.exit()

		if self.isCompressed:
			print("Reading codebook")
			cb_len = 2 * 4 * self.codebook_size
			self.codebook = self.file.read(cb_len)

		if self.isMipmap:
			print("Seeking passed mipmaps")
			seek_ofs = self.get_mipmap_size()
			self.file.read(seek_ofs)

		if self.isTwiddled:
			print("Reading twiddled texture")
			sys.exit()


		return None

	def get_mipmap_size(self):
		mipCount = 0
		seek_ofs = 0
		width = self.width

		while width :
			mipCount = mipCount + 1
			width = int(width / 2)

		while mipCount:
			mipWidth = (self.width >> (mipCount - 1))
			mipHeight = (self.height >> (mipCount - 1))
			mipSize = mipWidth * mipHeight

			mipCount = mipCount - 1

			if mipCount > 0:
				if self.isCompressed:
					seek_ofs = seek_ofs + int(mipSize / 4)
				else:
					seek_ofs = seek_ofs + (2 * mipSize)
			else:
				if self.isCompressed:
					seek_ofs = seek_ofs + 1
				else:
					seek_ofs = seek_ofs + 2
		return seek_ofs