CLU - Revision history

DonDiego: Add to formats missing in FFmpeg category.

2007-04-10T22:46:39Z

Add to formats missing in FFmpeg category.

← Older revision		Revision as of 15:46, 10 April 2007
Line 77:		Line 77:
	[[Category:ADPCM Audio Codecs]]		[[Category:ADPCM Audio Codecs]]
	[[Category:Game Formats]]		[[Category:Game Formats]]
			[[Category: Formats missing in FFmpeg]]

Dashcloud: Update website address

2007-02-05T04:59:41Z

Update website address

← Older revision		Revision as of 21:59, 4 February 2007
Line 3:		Line 3:

	== Credit ==		== Credit ==
	The information on this page is based on a document found on http://wotsit.org/ and other sites on the internet, and originated on [[GAP]]'s (Game Audio Player) website (now defunct). The information was originally by Valery V. Anisimovsky (no valid email address known)		The information on this page is based on a document found on http://www.wotsit.org/ and other sites on the internet, and originated on [[GAP]]'s (Game Audio Player) website (now defunct). The information was originally by Valery V. Anisimovsky (no valid email address known)

	== CLU Resource Files==		== CLU Resource Files==

Bodhost: /* PC Games using CLU format */

2007-02-03T01:19:07Z

PC Games using CLU format

← Older revision		Revision as of 18:19, 2 February 2007
Line 71:		Line 71:

	== PC Games using CLU format ==		== PC Games using CLU format ==
			*[http://bodhost.com/web-hosting/index.php/2006/11/09/clu/ CLU Historic Basics]
	*[http://www.mobygames.com/game/windows/broken-sword-the-smoking-mirror Broken Sword 2: The Smoking Mirror]		*[http://www.mobygames.com/game/windows/broken-sword-the-smoking-mirror Broken Sword 2: The Smoking Mirror]

Multimedia Mike: /* CLUSFX Music/Speech/Sound Files */ typo

2006-08-15T17:17:38Z

CLUSFX Music/Speech/Sound Files: typo

← Older revision		Revision as of 10:17, 15 August 2006
Line 49:		Line 49:

	== CLUSFX Music/Speech/Sound Files ==		== CLUSFX Music/Speech/Sound Files ==
	All of the music/speech/sfx files are of the same format which ~~are~~ referred to here as CLUSFX. A CLUSFX file has a simple ~~header~~ -- just a 16-bit initial predictor value followed by a compressed waveform stream. When decompressed, all music/speech/sfx files are 16-bit mono [[PCM]] samples replayed at 22050 Hz. ''(signed or unsigned? presumably signed --[[User:Multimedia Mike\|Multimedia Mike]])''		All of the music/speech/sfx files are of the same format which is referred to here as CLUSFX. A CLUSFX file has a simple format -- just a 16-bit initial predictor value followed by a compressed waveform stream. When decompressed, all music/speech/sfx files are 16-bit mono [[PCM]] samples replayed at 22050 Hz. ''(signed or unsigned? presumably signed --[[User:Multimedia Mike\|Multimedia Mike]])''

	All CLUSFX files are compressed using CLU ADPCM compression algorithm.		All CLUSFX files are compressed using CLU ADPCM compression algorithm.

Multimedia Mike: rework ADPCM algorithm into simple pseudocode description

2006-08-15T17:13:49Z

rework ADPCM algorithm into simple pseudocode description

← Older revision		Revision as of 10:13, 15 August 2006
Line 49:		Line 49:

	== CLUSFX Music/Speech/Sound Files ==		== CLUSFX Music/Speech/Sound Files ==
	All of the music/speech/sfx files are of the same format which are referred to here as CLUSFX. A CLUSFX file has a simple header -- just a ~~starting~~ value ~~of the sample~~ followed by a compressed waveform stream. When decompressed, all music/speech/sfx files ~~in Broken Sword 2~~ are 16-bit mono [[PCM]] samples replayed at 22050 Hz.		All of the music/speech/sfx files are of the same format which are referred to here as CLUSFX. A CLUSFX file has a simple header -- just a 16-bit initial predictor value followed by a compressed waveform stream. When decompressed, all music/speech/sfx files are 16-bit mono [[PCM]] samples replayed at 22050 Hz. ''(signed or unsigned? presumably signed --[[User:Multimedia Mike\|Multimedia Mike]])''

	All CLUSFX files are compressed using CLU ADPCM compression algorithm.		All CLUSFX files are compressed using CLU ADPCM compression algorithm.

	== CLU ADPCM Decompression Algorithm==		== CLU ADPCM Decompression Algorithm==
	~~During~~ the ~~decompression SHORT variable should be maintained~~. ~~This~~ is		A CLU file begins with a 16-bit initial predictor value that is not sent to the output. The compressed stream is comprised of a sequence of bytes. The 8 bits of each byte have the following meaning:
	~~the current value~~ of the ~~audio sample which is initialized to the CLUSFX~~
	~~header value in the beginning.~~

	~~This is the C code which decompresses CLU ADPCM compressed stream:~~		bits 7-4 delta magnifier
			bit 3 sign bit
			bits 2-0 delta base

	~~int i;~~		For each byte:
	~~signed short iCurSample; /* needs to be 16 bits */~~		delta = (delta base) << (delta magnifier)
	~~BYTE *inputBuffer[dwSize];~~		if the sign bit is cleared
			predictor += delta
	~~iCurSample~~=~~iFirstSample; // from the CLUSFX header~~

	~~for~~ (~~i=0;i~~<~~dwSize;i++~~)
	{
	if ~~(inputBuffer[i] & 0x8)~~
	~~iCurSample-~~=~~((SHORT)(inputBuffer[i] & 7)) << (inputBuffer[i]>>4);~~
	else		else
	~~iCurSample+~~=~~((SHORT)(inputBuffer[i] & 7)) << (inputBuffer[i]>>4);~~		predictor -= delta
	~~Output(iCurSample);~~		send predictor to the output as the next audio sample
	}

	~~Output() is just a placeholder for any action you would like to perform for decompressed~~ sample value.		Presumably, the output sample should be saturated within an appropriate value range.

	== PC Games using CLU format ==		== PC Games using CLU format ==

Multimedia Mike: some English and style edits

2006-08-15T16:55:54Z

some English and style edits

← Older revision		Revision as of 09:55, 15 August 2006
Line 2:		Line 2:
	* Company: [[Revolution Studios]]		* Company: [[Revolution Studios]]

	==Credit==		== Credit ==
	~~This~~ document ~~comes from~~ wotsit.org, and originated on GAP's (Game Audio Player) website (now defunct).		The information on this page is based on a document found on http://wotsit.org/ and other sites on the internet, and originated on [[GAP]]'s (Game Audio Player) website (now defunct). The information was originally by Valery V. Anisimovsky (no valid email address known)
	By Valery V. Anisimovsky (no valid email address known)



	== CLU Resource Files==		== CLU Resource Files==
	All numbers in all structures described ~~in this document~~ are stored in files		All numbers in all structures described are stored in files using little-endian (Intel) byte order.
	using little-endian (Intel) byte order.

	Music/speech/sound files of Broken Sword 2 are stored in CLU resource		Music/speech/sound files of Broken Sword 2 are stored in CLU resource
Line 52:		Line 48:
	format. It's not described here.		format. It's not described here.

	== CLUSFX Music/Speech/Sound Files==		== CLUSFX Music/Speech/Sound Files ==
			All of the music/speech/sfx files are of the same format which are referred to here as CLUSFX. A CLUSFX file has a simple header -- just a starting value of the sample followed by a compressed waveform stream. When decompressed, all music/speech/sfx files in Broken Sword 2 are 16-bit mono [[PCM]] samples replayed at 22050 Hz.

	All ~~of the music/speech/sfx files are of the same format which I refer~~		All CLUSFX files are compressed using CLU ADPCM compression algorithm.
	~~to as CLUSFX. CLUSFX file has a simple header -- just a starting value~~
	~~of the sample, after which the compressed waveform stream begins. All~~
	~~music/speech/sfx files in Broken Sword 2 are 16-bit mono 22050 Hz.~~
	~~ALL~~ CLUSFX files are compressed using CLU ADPCM compression algorithm.
	~~Refer to the following section for the description of CLU ADPCM~~
	~~decompression scheme~~.

	== CLU ADPCM Decompression Algorithm==		== CLU ADPCM Decompression Algorithm==

	During the decompression SHORT variable should be maintained. This is		During the decompression SHORT variable should be maintained. This is
	the current value of the audio sample which is initialized to the CLUSFX		the current value of the audio sample which is initialized to the CLUSFX
	header value in the beginning.		header value in the beginning.

	~~Here's~~ the code which decompresses CLU ADPCM compressed stream:		This is the C code which decompresses CLU ADPCM compressed stream:

	~~DWORD~~ i;		int i;
	~~SHORT~~ iCurSample;		signed short iCurSample; /* needs to be 16 bits */
	BYTE *inputBuffer[dwSize];		BYTE *inputBuffer[dwSize];

Line 85:		Line 75:
	}		}

	Output() is just a placeholder for any action you would like to perform for		Output() is just a placeholder for any action you would like to perform for decompressed sample value.
	decompressed sample value.

	==PC Games using CLU format==		== PC Games using CLU format ==
	*[http://www.mobygames.com/game/windows/broken-sword-the-smoking-mirror Broken Sword 2: The Smoking Mirror]		*[http://www.mobygames.com/game/windows/broken-sword-the-smoking-mirror Broken Sword 2: The Smoking Mirror]

			[[Category:Audio Codecs]]
			[[Category:ADPCM Audio Codecs]]
	[[Category:Game Formats]]		[[Category:Game Formats]]

Multimedia Mike: /* CLU ADPCM Decompression Algorithm */ no breaks

2006-08-15T04:13:19Z

CLU ADPCM Decompression Algorithm: no breaks

← Older revision		Revision as of 21:13, 14 August 2006
Line 69:		Line 69:

	Here's the code which decompresses CLU ADPCM compressed stream:		Here's the code which decompresses CLU ADPCM compressed stream:


	DWORD i;		DWORD i;
	SHORT iCurSample;		SHORT iCurSample;
	BYTE *inputBuffer[dwSize];		BYTE *inputBuffer[dwSize];

	iCurSample=iFirstSample; // from the CLUSFX header		iCurSample=iFirstSample; // from the CLUSFX header

	for (i=0;i<dwSize;i++)		for (i=0;i<dwSize;i++)
	{		{

Dashcloud: Correct formatting on page

2006-08-14T20:20:30Z

Correct formatting on page

← Older revision		Revision as of 13:20, 14 August 2006
Line 22:		Line 22:


	szID -- string ID is always "\xFF\xF0\xFF\xF0".		''szID'' -- string ID is always "\xFF\xF0\xFF\xF0".

	dwNumber -- the number of files stored in CLU file.		''dwNumber'' -- the number of files stored in CLU file.

	After the header comes the array of (dwNumber) directory entries.		After the header comes the array of (''dwNumber'') directory entries.
	Each directory entry contains the info on a file in CLU archive. Each such		Each directory entry contains the info on a file in CLU archive. Each such
	entry has the following format:		entry has the following format:
Line 36:		Line 36:
	} CLUDirEntry;		} CLUDirEntry;

	dwStart -- the starting position of the file relative to the beginning of the		''dwStart'' -- the starting position of the file relative to the beginning of the
	CLU archive.		CLU archive.

	dwSize -- the size of the file.		''dwSize'' -- the size of the file.

	Note that there're some entries with zero (dwStart) or (dwSize) --		Note that there're some entries with zero (''dwStart'') or (''dwSize'') --
	they correspond to the files absent in the given CLU archive (the files		they correspond to the files absent in the given CLU archive (the files
	with the same numbers may be found in the corresponding CLU archive on		with the same numbers may be found in the corresponding CLU archive on

Dashcloud: Clean-up formatting

2006-08-14T20:04:46Z

Clean-up formatting

← Older revision		Revision as of 13:04, 14 August 2006
Line 15:		Line 15:
	files. Each music/speech/sound CLU file has the following header:		files. Each music/speech/sound CLU file has the following header:

	struct tagCLUHeader		struct tagCLUHeader
	{		{
	DWORD dwNumber;		DWORD dwNumber;
	char szID[4];		char szID[4];
	} CLUHeader;		} CLUHeader;


Line 30:		Line 30:
	entry has the following format:		entry has the following format:

	struct tagCLUDirEntry		struct tagCLUDirEntry
	{		{
	DWORD dwStart;		DWORD dwStart;
	DWORD dwSize;		DWORD dwSize;
	} CLUDirEntry;		} CLUDirEntry;

	dwStart -- the starting position of the file relative to the beginning of the		dwStart -- the starting position of the file relative to the beginning of the
Line 71:		Line 71:


	DWORD i;		DWORD i;
	SHORT iCurSample;		SHORT iCurSample;
	BYTE *inputBuffer[dwSize];		BYTE *inputBuffer[dwSize];

	iCurSample=iFirstSample; // from the CLUSFX header		iCurSample=iFirstSample; // from the CLUSFX header

	for (i=0;i<dwSize;i++)		for (i=0;i<dwSize;i++)
	{		{
	if (inputBuffer[i] & 0x8)		if (inputBuffer[i] & 0x8)
	iCurSample-=((SHORT)(inputBuffer[i] & 7)) << (inputBuffer[i]>>4);		iCurSample-=((SHORT)(inputBuffer[i] & 7)) << (inputBuffer[i]>>4);
Line 84:		Line 84:
	iCurSample+=((SHORT)(inputBuffer[i] & 7)) << (inputBuffer[i]>>4);		iCurSample+=((SHORT)(inputBuffer[i] & 7)) << (inputBuffer[i]>>4);
	Output(iCurSample);		Output(iCurSample);
	}		}

	Output() is just a placeholder for any action you would like to perform for		Output() is just a placeholder for any action you would like to perform for

Dashcloud: Adding CLU format

2006-08-13T18:32:13Z

Adding CLU format

New page

* Extension: clu
* Company: [[Revolution Studios]]

==Credit==
This document comes from wotsit.org, and originated on GAP's (Game Audio Player) website (now defunct).
By Valery V. Anisimovsky (no valid email address known)

== CLU Resource Files==
All numbers in all structures described in this document are stored in files
using little-endian (Intel) byte order.

Music/speech/sound files of Broken Sword 2 are stored in CLU resource
files. Each music/speech/sound CLU file has the following header:

struct tagCLUHeader
{
DWORD dwNumber;
char szID[4];
} CLUHeader;

szID -- string ID is always "\xFF\xF0\xFF\xF0".

dwNumber -- the number of files stored in CLU file.

After the header comes the array of (dwNumber) directory entries.
Each directory entry contains the info on a file in CLU archive. Each such
entry has the following format:

struct tagCLUDirEntry
{
DWORD dwStart;
DWORD dwSize;
} CLUDirEntry;

dwStart -- the starting position of the file relative to the beginning of the
CLU archive.

dwSize -- the size of the file.

Note that there're some entries with zero (dwStart) or (dwSize) --
they correspond to the files absent in the given CLU archive (the files
with the same numbers may be found in the corresponding CLU archive on
the other game CD).

After the array of directory entries come the files contained in CLU
archive.

NOTE: The CLU files containing other types of game data have different
format. It's not described here.

== CLUSFX Music/Speech/Sound Files==

All of the music/speech/sfx files are of the same format which I refer
to as CLUSFX. CLUSFX file has a simple header -- just a starting value
of the sample, after which the compressed waveform stream begins. All
music/speech/sfx files in Broken Sword 2 are 16-bit mono 22050 Hz.
ALL CLUSFX files are compressed using CLU ADPCM compression algorithm.
Refer to the following section for the description of CLU ADPCM
decompression scheme.

== CLU ADPCM Decompression Algorithm==

During the decompression SHORT variable should be maintained. This is
the current value of the audio sample which is initialized to the CLUSFX
header value in the beginning.

Here's the code which decompresses CLU ADPCM compressed stream:

DWORD i;
SHORT iCurSample;
BYTE *inputBuffer[dwSize];

iCurSample=iFirstSample; // from the CLUSFX header

for (i=0;i<dwSize;i++)
{
if (inputBuffer[i] & 0x8)
iCurSample-=((SHORT)(inputBuffer[i] & 7)) << (inputBuffer[i]>>4);
else
iCurSample+=((SHORT)(inputBuffer[i] & 7)) << (inputBuffer[i]>>4);
Output(iCurSample);
}

Output() is just a placeholder for any action you would like to perform for
decompressed sample value.

==PC Games using CLU format==
*[http://www.mobygames.com/game/windows/broken-sword-the-smoking-mirror Broken Sword 2: The Smoking Mirror]

[[Category:Game Formats]]