Humongous CUP - Revision history

Vitor: Link to decoder => !undiscovered

2009-09-03T05:28:48Z

Link to decoder => !undiscovered

← Older revision		Revision as of 22:28, 2 September 2009
Line 144:		Line 144:

	[[Category:Game Formats]]		[[Category:Game Formats]]
	~~[[Category:Undiscovered Game Formats]]~~
	[[Category:Video Codecs]]		[[Category:Video Codecs]]
	[[Category:~~Undiscovered Video Codecs~~]]		[[Category:Formats missing in FFmpeg]]

Sev: Updated link to the format decoder

2008-11-20T20:33:20Z

Updated link to the format decoder

← Older revision		Revision as of 13:33, 20 November 2008
Line 2:		Line 2:
	* Company: [[Humongous Entertainment]]		* Company: [[Humongous Entertainment]]
	* Samples: http://samples.mplayerhq.hu/game-formats/cup/		* Samples: http://samples.mplayerhq.hu/game-formats/cup/
			* Decoder: http://scummvm.svn.sourceforge.net/viewvc/scummvm/scummvm/trunk/engines/scumm/he/cup_player_he.cpp

	Humongous CUP files are used as demo movies for games from Humongous Entertainment. CUP files have the file signature 'BEAN' and are played with an executable called coffee.exe. They appear to contain non-interleaved audio and video data; all of the audio data is stored in the file first and the video data second.		Humongous CUP files are used as demo movies for games from Humongous Entertainment. CUP files have the file signature 'BEAN' and are played with an executable called coffee.exe. They appear to contain non-interleaved audio and video data; all of the audio data is stored in the file first and the video data second.

	~~The source code of a (rather incomplete) player for the CUP format can be found at: http://membres.lycos.fr/cyxdown/scummvm/humongous/~~

	== Data Format ==		== Data Format ==

Cyx at 13:24, 3 October 2006

2006-10-03T13:24:27Z

← Older revision		Revision as of 06:24, 3 October 2006
Line 4:		Line 4:

	Humongous CUP files are used as demo movies for games from Humongous Entertainment. CUP files have the file signature 'BEAN' and are played with an executable called coffee.exe. They appear to contain non-interleaved audio and video data; all of the audio data is stored in the file first and the video data second.		Humongous CUP files are used as demo movies for games from Humongous Entertainment. CUP files have the file signature 'BEAN' and are played with an executable called coffee.exe. They appear to contain non-interleaved audio and video data; all of the audio data is stored in the file first and the video data second.

			The source code of a (rather incomplete) player for the CUP format can be found at: http://membres.lycos.fr/cyxdown/scummvm/humongous/

	== Data Format ==		== Data Format ==
Line 22:		Line 24:
	bytes 0-3 'HEAD' FourCC		bytes 0-3 'HEAD' FourCC
	bytes 4-7 size = 0x0E = 14 bytes		bytes 4-7 size = 0x0E = 14 bytes
	bytes 8-9 ~~unknown, always seems to be 0x0042~~ (66)		bytes 8-9 playback rate in ms (66 by default)
	bytes 10-11 video width		bytes 10-11 video width
	bytes 12-13 video height		bytes 12-13 video height
Line 73:		Line 75:
	** SNDE		** SNDE
	** TOIL		** TOIL
			** FRAM
	** SRLE		** SRLE
			** WRLE
	** LZSS		** LZSS
	The RGBS chunk, already described, indicates that the palette can change during playback. The RATE chunk has the following layout:		The RGBS chunk, already described, indicates that the palette can change during playback. The RATE chunk has the following layout:
Line 79:		Line 83:
	bytes 0-3 'RATE'		bytes 0-3 'RATE'
	bytes 4-7 chunk size = 0xA = 10 bytes		bytes 4-7 chunk size = 0xA = 10 bytes
	bytes 8-9 ~~unknown~~		bytes 8-9 playback rate in milliseconds

	~~It is possible that this defines a~~ change in the playback rate.		This chunk allows to change the playback rate of the movie.

	The SNDE chunk has the following format:		The SNDE chunk has the following format:
Line 87:		Line 91:
	bytes 0-3 'SNDE'		bytes 0-3 'SNDE'
	bytes 4-7 chunk size = 0x12 = 18 bytes		bytes 4-7 chunk size = 0x12 = 18 bytes
	bytes 8-17 unknown		bytes 8-11 unknown
			bytes 12-13 unknown
			bytes 13-15 unknown
			bytes 15-17 unknown

	While the purpose of this block is unknown, some of the numbers may reference back into the AUDIO data chunks to specify which piece of audio should be playing at the current time.		While the purpose of this block is unknown, some of the numbers may reference back into the AUDIO data chunks to specify which piece of audio should be playing at the current time.

	The TOIL chunk has the following format:		The TOIL chunk allows to execute special operations, it has the following format:

	bytes 0-3 'TOIL'		bytes 0-3 'TOIL'
	bytes 4-7 chunk size ~~= 0x10 = 16~~ bytes		bytes 4-7 chunk size (variable)
	bytes 8-15 unknown		bytes 8-9 number of opcodes
			bytes 10- opcodes data

			Each TOIL opcode data has the following format :
			byte 0 size of opcode
			byte 1 opcode number

			The purpose of each opcode is :
			1 stop playback
			2 display copyright/information messageBox
			3 unknown
			4 restart playback
			5 disable screen update
			6 enable offscreen buffers swapping
			7 pause playback at specific frame

			The SRLE, WRLE, FRAM and LZSS chunk types indicate video compression types and will be explained in their own sections.

	~~The SRLE and LZSS chunk types indicate video~~ compression ~~types and will be explained~~ in ~~their own sections~~.		== TRLE Compression ==
			TRLE (which presumably stands for "transparent run length encoding") is name of the bitmap compression algorithm used in a FRAM chunk.

	== SRLE Compression ==		== SRLE Compression ==

Dashcloud: Update samples link

2006-08-17T21:57:48Z

Update samples link

← Older revision		Revision as of 14:57, 17 August 2006
Line 1:		Line 1:
	* Extension: cup		* Extension: cup
	* Company: [[Humongous Entertainment]]		* Company: [[Humongous Entertainment]]
	* Samples: http://~~www~~.mplayerhq.hu~~/MPlayer/samples~~/game-formats/cup/		* Samples: http://samples.mplayerhq.hu/game-formats/cup/

	Humongous CUP files are used as demo movies for games from Humongous Entertainment. CUP files have the file signature 'BEAN' and are played with an executable called coffee.exe. They appear to contain non-interleaved audio and video data; all of the audio data is stored in the file first and the video data second.		Humongous CUP files are used as demo movies for games from Humongous Entertainment. CUP files have the file signature 'BEAN' and are played with an executable called coffee.exe. They appear to contain non-interleaved audio and video data; all of the audio data is stored in the file first and the video data second.

Multimedia Mike: /* Data Format */

2006-04-02T21:52:02Z

Data Format

← Older revision		Revision as of 14:52, 2 April 2006
Line 97:		Line 97:
	bytes 8-15 unknown		bytes 8-15 unknown

	SRLE and LZSS ~~indicated~~ video compression types and will be explained in their own sections.		The SRLE and LZSS chunk types indicate video compression types and will be explained in their own sections.

	== SRLE Compression ==		== SRLE Compression ==

Multimedia Mike: /* LZSS Compression */

2006-04-02T21:38:39Z

LZSS Compression

← Older revision		Revision as of 14:38, 2 April 2006
Line 102:		Line 102:
	SRLE is the name of one of the video compression algorithms seen in CUP files. It is suspected to be a simple run length encoding scheme.		SRLE is the name of one of the video compression algorithms seen in CUP files. It is suspected to be a simple run length encoding scheme.

	== LZSS Compression ==		== LZSS (Tri-LZ) Compression ==
	LZSS ~~is the name of~~ one of the video compression algorithms seen in CUP files. It is a variant of the common [[LZ]] algorithm.		LZSS indicates one of the video compression algorithms seen in CUP files. It is a variant of the common [[LZ]] algorithm. An LZSS chunk has the following hierarchical organization:
			* LZSS
			** LZHD
			** DATA
			Thus, the LZSS chunk contains its preamble followed by an LZHD chunk and ''(another type of!)'' DATA chunk. The LZHD chunk has the following layout:

			bytes 0-3 'LZHD' FourCC
			bytes 4-7 size = 0x10 = 16 bytes
			bytes 8-11 compression type
			bytes 12-15 size of decompressed data

			The only valid compression type is 0x2000 which indicates the tri-lz method. The DATA chunk contains the compressed data.

			A block of tri-lz compressed data is stored in 3 parts. In a compressed data block, part 1 starts at byte 8. Part 2 starts at the offset formed from bytes 0-3 of the compressed buffer. Part 3 starts at the offset formed from bytes 4-7 of the compressed buffer.

			'''(TODO: finish description)'''

	[[Category:Game Formats]]		[[Category:Game Formats]]

Multimedia Mike: simplify multi-byte numbers explanation; add sections for video codecs

2006-04-02T21:30:41Z

simplify multi-byte numbers explanation; add sections for video codecs

← Older revision		Revision as of 14:30, 2 April 2006
Line 6:		Line 6:

	== Data Format ==		== Data Format ==
	~~Multi~~-byte numbers ~~may~~ be little ~~or big~~ endian		CUP file use both little and big endian numbers. Big endian numbers are used when encoding the chunk size in the chunk preamble. All other multi-byte numbers appear to be stored in little endian format.

	bytes 0-3 chunk type [[FourCC]]		bytes 0-3 chunk type [[FourCC]]
	bytes 4-7 chunk size (including this 8-byte preamble)~~; big endian~~		bytes 4-7 chunk size (including this 8-byte preamble)
	bytes 8.. chunk payload		bytes 8.. chunk payload

Line 15:		Line 15:

	bytes 0-3 'BEAN' FourCC		bytes 0-3 'BEAN' FourCC
	bytes 4-7 size of entire CUP file (including this preamble)~~; big endian~~		bytes 4-7 size of entire CUP file (including this preamble)
	bytes 8.. CUP file		bytes 8.. CUP file

Line 21:		Line 21:

	bytes 0-3 'HEAD' FourCC		bytes 0-3 'HEAD' FourCC
	bytes 4-7 size = 0x0E = 14 bytes~~; big endian~~		bytes 4-7 size = 0x0E = 14 bytes
	bytes 8-9 unknown, always seems to be 0x0042 (66) ~~in little endian~~		bytes 8-9 unknown, always seems to be 0x0042 (66)
	bytes 10-11 video width		bytes 10-11 video width
	bytes 12-13 video height		bytes 12-13 video height
Line 29:		Line 29:

	bytes 0-3 'RGBS' FourCC		bytes 0-3 'RGBS' FourCC
	bytes 4-7 chunk size = 0x0308 = 776 bytes~~; big endian~~		bytes 4-7 chunk size = 0x0308 = 776 bytes
	bytes 8..775 palette entries		bytes 8..775 palette entries

Line 44:		Line 44:

	bytes 0-3 'OFFS' FourCC		bytes 0-3 'OFFS' FourCC
	bytes 4-7 chunk size~~; big endian~~		bytes 4-7 chunk size
	bytes 8.. DATA chunk offsets~~; little endian~~		bytes 8.. DATA chunk offsets

	The DATA chunk offsets are 4-byte numbers stored in little endian format that fill the remainder of the OFFS chunk after the preamble. They indicate the offsets (and, implicitly, the count) of audio DATA chunks. The offsets are relative to the start of the OFFS chunk. It is instructive to note that since the first DATA chunk immediately follows the OFFS chunk, its offset will be the same as the size of the OFFS chunk, though stored in the opposite byte order. For example, if there were only one audio DATA chunk in the file, and the OFFS chunk began at 0x32E:		The DATA chunk offsets are 4-byte numbers stored in little endian format that fill the remainder of the OFFS chunk after the preamble. They indicate the offsets (and, implicitly, the count) of audio DATA chunks. The offsets are relative to the start of the OFFS chunk. It is instructive to note that since the first DATA chunk immediately follows the OFFS chunk, its offset will be the same as the size of the OFFS chunk, though stored in the opposite byte order. For example, if there were only one audio DATA chunk in the file, and the OFFS chunk began at 0x32E:
Line 60:		Line 60:

	bytes 0-3 'HSHD' FourCC		bytes 0-3 'HSHD' FourCC
	bytes 4-7 chunk size = 0x18 = 24 bytes~~; big endian~~		bytes 4-7 chunk size = 0x18 = 24 bytes
	bytes 8-13 unknown		bytes 8-13 unknown
	bytes 14-15 sample rate~~; little endian~~		bytes 14-15 sample rate
	bytes 16-23 unknown		bytes 16-23 unknown

Line 78:		Line 78:

	bytes 0-3 'RATE'		bytes 0-3 'RATE'
	bytes 4-7 chunk size = 0xA = 10 bytes~~; big endian~~		bytes 4-7 chunk size = 0xA = 10 bytes
	bytes 8-9 unknown		bytes 8-9 unknown

Line 86:		Line 86:

	bytes 0-3 'SNDE'		bytes 0-3 'SNDE'
	bytes 4-7 chunk size = 0x12 = 18 bytes~~; big endian~~		bytes 4-7 chunk size = 0x12 = 18 bytes
	bytes 8-17 unknown		bytes 8-17 unknown

Line 94:		Line 94:

	bytes 0-3 'TOIL'		bytes 0-3 'TOIL'
	bytes 4-7 chunk size = 0x10 = 16 bytes~~; big endian~~		bytes 4-7 chunk size = 0x10 = 16 bytes
	bytes 8-15 unknown		bytes 8-15 unknown

	SRLE and LZSS indicated video compression types and will be explained in their own sections.		SRLE and LZSS indicated video compression types and will be explained in their own sections.

	== ~~Chunk Types~~ ==		== SRLE Compression ==
			SRLE is the name of one of the video compression algorithms seen in CUP files. It is suspected to be a simple run length encoding scheme.
	~~BEAN: file signature~~

	~~HEAD: contains 10-byte payload including unknown 16-bit quantity and 32-bit width and height stored as little-endian~~

	~~RGBS: palette triplets; payload should be 0x300 (768, 256x3) bytes long; values range from 0~~.~~.255; must~~ be a ~~constant~~ length ~~since it has no provision for palette replacement~~

	~~SFXB~~.~~.WRAP..OFFS: apparently a setup for audio data~~

	~~DATA: audio or video data; audio data is 8-bit, unsigned PCM~~

	~~BLOK: video data block?~~

	~~SRLE: apparently the video compression type, possibly based on lzss.c~~

	~~SNDE: reference into audio data?~~

	~~RATE:~~

			== LZSS Compression ==
			LZSS is the name of one of the video compression algorithms seen in CUP files. It is a variant of the common [[LZ]] algorithm.


	[[Category:Game Formats]]		[[Category:Game Formats]]
	[[Category:Undiscovered Game Formats]]		[[Category:Undiscovered Game Formats]]
			[[Category:Video Codecs]]
			[[Category:Undiscovered Video Codecs]]

Multimedia Mike: /* Data Format */

2006-04-02T21:24:12Z

Data Format

← Older revision		Revision as of 14:24, 2 April 2006
Line 66:		Line 66:

	The SDAT chunk contains uncompressed, unsigned, 8-bit PCM data.		The SDAT chunk contains uncompressed, unsigned, 8-bit PCM data.

			After the SFXB is another chunk marked DATA. DATA has many meanings in this formats. This data chunk encapsulates a number of BLOK chunks. This is the hierarchical organization of BLOCK chunk:
			* BLOK
			** RGBS
			** RATE
			** SNDE
			** TOIL
			** SRLE
			** LZSS
			The RGBS chunk, already described, indicates that the palette can change during playback. The RATE chunk has the following layout:

			bytes 0-3 'RATE'
			bytes 4-7 chunk size = 0xA = 10 bytes; big endian
			bytes 8-9 unknown

			It is possible that this defines a change in the playback rate.

			The SNDE chunk has the following format:

			bytes 0-3 'SNDE'
			bytes 4-7 chunk size = 0x12 = 18 bytes; big endian
			bytes 8-17 unknown

			While the purpose of this block is unknown, some of the numbers may reference back into the AUDIO data chunks to specify which piece of audio should be playing at the current time.

			The TOIL chunk has the following format:

			bytes 0-3 'TOIL'
			bytes 4-7 chunk size = 0x10 = 16 bytes; big endian
			bytes 8-15 unknown

			SRLE and LZSS indicated video compression types and will be explained in their own sections.

	== Chunk Types ==		== Chunk Types ==

Multimedia Mike: /* Data Format */ audio chunks

2006-04-02T21:06:40Z

Data Format: audio chunks

← Older revision		Revision as of 14:06, 2 April 2006
Line 33:		Line 33:

	The palette entries are 256 3-byte triplets of red-green-blue palette components. Each component is 8 bits (as opposed to 6 bits which is often seen in palettized formats).		The palette entries are 256 3-byte triplets of red-green-blue palette components. Each component is 8 bits (as opposed to 6 bits which is often seen in palettized formats).

			The RGBS chunk is generally followed by the SFXB chunk which contains audio data. This is the typical hierarchical organization of the SFXB chunk and its constituent chunks:
			* SFXB
			** WRAP
			*** OFFS
			*** DATA
			*** DATA
			*** ..
			The SFXB chunk contains its preamble and the WRAP chunk. The WRAP chunk contains its preamble, an OFFS chunk and a series of DATA chunks. The OFFS chunk has the following format:

			bytes 0-3 'OFFS' FourCC
			bytes 4-7 chunk size; big endian
			bytes 8.. DATA chunk offsets; little endian

			The DATA chunk offsets are 4-byte numbers stored in little endian format that fill the remainder of the OFFS chunk after the preamble. They indicate the offsets (and, implicitly, the count) of audio DATA chunks. The offsets are relative to the start of the OFFS chunk. It is instructive to note that since the first DATA chunk immediately follows the OFFS chunk, its offset will be the same as the size of the OFFS chunk, though stored in the opposite byte order. For example, if there were only one audio DATA chunk in the file, and the OFFS chunk began at 0x32E:

			0x32E 4F 46 46 53 00 00 00 0C 0C 00 00 00 44 41 54 41 OFFS........DATA
			0x33E ....

			The audio DATA chunks usually contain uncompressed [[PCM]] in 8-bit, unsigned format. But they sometimes contain the following hierarchical organizations:
			* DATA
			** TALK
			*** HSHD
			*** SDAT
			In this case, the DATA chunk contains its preamble and the TALK chunk. The TALK chunk contains its preamble followed by the HSHD and SDAT chunks. The HSHD chunk has the following layout:

			bytes 0-3 'HSHD' FourCC
			bytes 4-7 chunk size = 0x18 = 24 bytes; big endian
			bytes 8-13 unknown
			bytes 14-15 sample rate; little endian
			bytes 16-23 unknown

			The SDAT chunk contains uncompressed, unsigned, 8-bit PCM data.

	== Chunk Types ==		== Chunk Types ==

Multimedia Mike: /* Data Format */

2006-04-02T19:26:55Z

Data Format

← Older revision		Revision as of 12:26, 2 April 2006
Line 8:		Line 8:
	Multi-byte numbers may be little or big endian		Multi-byte numbers may be little or big endian

	bytes 0-3 chunk type [[FourCC]]		bytes 0-3 chunk type [[FourCC]]
	bytes 4-7 chunk size (including this 8-byte preamble); big endian		bytes 4-7 chunk size (including this 8-byte preamble); big endian
	bytes 8.. chunk payload		bytes 8.. chunk payload

	The top-level chunk in a CUP file is the 'BEAN' chunk which encapsulates the entire file and can also serve as a file signature:		The top-level chunk in a CUP file is the BEAN chunk which encapsulates the entire file and can also serve as a file signature:

	bytes 0..3 'BEAN' FourCC		bytes 0-3 'BEAN' FourCC
	bytes 4..7 size of entire CUP file (including this preamble)		bytes 4-7 size of entire CUP file (including this preamble); big endian
	bytes 8.. ~~CPU~~ file		bytes 8.. CUP file

	~~An RGBS chunk~~ is ~~often the first to appear in~~ a ~~CUP file after the signature. It has~~ the following ~~layout~~:		Following the BEAN signature is a HEAD chunk with the following format:

	bytes 0..3 'RGBS' FourCC		bytes 0-3 'HEAD' FourCC
	bytes 4..7 chunk size = 0x0308 = 776		bytes 4-7 size = 0x0E = 14 bytes; big endian
			bytes 8-9 unknown, always seems to be 0x0042 (66) in little endian
			bytes 10-11 video width
			bytes 12-13 video height

			An RGBS chunk often appears after the HEAD chunk in a CUP file. It has the following layout:

			bytes 0-3 'RGBS' FourCC
			bytes 4-7 chunk size = 0x0308 = 776 bytes; big endian
	bytes 8..775 palette entries		bytes 8..775 palette entries