Contains the LC_LZ2 compression algorithm. More...

Classes
struct	CompressionCommand

struct	CompressionContext

struct	CompressionPiece

Typedefs
using	CommandArgumentArray = std::array<std::array<char, 2>, 5>

using	CommandSizeArray = std::array<uint, 5>

using	DataSizeArray = std::array<uint, 5>

using	CompressionPiece = struct CompressionPiece

using	CompressionPiecePointer = std::shared_ptr<CompressionPiece>

Functions
void	PrintCompressionPiece (const CompressionPiecePointer &piece)

void	PrintCompressionChain (const CompressionPiecePointer &chain_head)

void	CheckByteRepeat (const uint8_t *rom_data, DataSizeArray &data_size_taken, CommandArgumentArray &cmd_args, uint &src_data_pos, const unsigned int last_pos)

void	CheckWordRepeat (const uint8_t *rom_data, DataSizeArray &data_size_taken, CommandArgumentArray &cmd_args, uint &src_data_pos, const unsigned int last_pos)

void	CheckIncByte (const uint8_t *rom_data, DataSizeArray &data_size_taken, CommandArgumentArray &cmd_args, uint &src_data_pos, const unsigned int last_pos)

void	CheckIntraCopy (const uint8_t *rom_data, DataSizeArray &data_size_taken, CommandArgumentArray &cmd_args, uint &src_data_pos, const unsigned int last_pos, unsigned int start)

void	ValidateForByteGain (const DataSizeArray &data_size_taken, const CommandSizeArray &cmd_size, uint &max_win, uint &cmd_with_max)

void	CompressionCommandAlternative (const uint8_t *rom_data, CompressionPiecePointer &compressed_chain, const CommandSizeArray &cmd_size, const CommandArgumentArray &cmd_args, uint &src_data_pos, uint &comp_accumulator, uint &cmd_with_max, uint &max_win)

void	CheckByteRepeatV2 (const uint8_t *data, uint &src_pos, const unsigned int last_pos, CompressionCommand &cmd)

void	CheckWordRepeatV2 (const uint8_t *data, uint &src_pos, const unsigned int last_pos, CompressionCommand &cmd)

void	CheckIncByteV2 (const uint8_t *rom_data, uint &src_data_pos, const unsigned int last_pos, CompressionCommand &cmd)

void	CheckIntraCopyV2 (const uint8_t *rom_data, uint &src_data_pos, const unsigned int last_pos, unsigned int start, CompressionCommand &cmd)

void	ValidateForByteGainV2 (const CompressionCommand &cmd, uint &max_win, uint &cmd_with_max)

void	CompressionCommandAlternativeV2 (const uint8_t *rom_data, const CompressionCommand &cmd, CompressionPiecePointer &compressed_chain, uint &src_data_pos, uint &comp_accumulator, uint &cmd_with_max, uint &max_win)

void	AddAlternativeCompressionCommand (const uint8_t *rom_data, CompressionPiecePointer &compressed_chain, const CompressionCommand &command, uint &source_data_position, uint &uncompressed_data_size, uint &best_command, uint &best_command_gain)

absl::StatusOr< CompressionPiecePointer >	SplitCompressionPiece (CompressionPiecePointer &piece, int mode)

std::vector< uint8_t >	CreateCompressionString (CompressionPiecePointer &start, int mode)

absl::Status	ValidateCompressionResult (CompressionPiecePointer &chain_head, int mode, int start, int src_data_pos)

CompressionPiecePointer	MergeCopy (CompressionPiecePointer &start)

absl::StatusOr< std::vector< uint8_t > >	CompressV2 (const uint8_t *data, const int start, const int length, int mode=1, bool check=false)
	Compresses a buffer of data using the LC_LZ2 algorithm.

absl::StatusOr< std::vector< uint8_t > >	CompressGraphics (const uint8_t *data, const int pos, const int length)

absl::StatusOr< std::vector< uint8_t > >	CompressOverworld (const uint8_t *data, const int pos, const int length)

absl::StatusOr< std::vector< uint8_t > >	CompressOverworld (const std::vector< uint8_t > data, const int pos, const int length)

void	CheckByteRepeatV3 (CompressionContext &context)

void	CheckWordRepeatV3 (CompressionContext &context)

void	CheckIncByteV3 (CompressionContext &context)

void	CheckIntraCopyV3 (CompressionContext &context)

void	InitializeCompression (CompressionContext &context)

void	CheckAvailableCompressionCommands (CompressionContext &context)

void	DetermineBestCompression (CompressionContext &context)

void	HandleDirectCopy (CompressionContext &context)

void	AddCompressionToChain (CompressionContext &context)

absl::Status	ValidateCompressionResultV3 (const CompressionContext &context)

absl::StatusOr< CompressionPiece >	SplitCompressionPieceV3 (CompressionPiece &piece, int mode)

void	FinalizeCompression (CompressionContext &context)

absl::StatusOr< std::vector< uint8_t > >	CompressV3 (const std::vector< uint8_t > &data, const int start, const int length, int mode=1, bool check=false)
	Compresses a buffer of data using the LC_LZ2 algorithm.

std::string	SetBuffer (const uint8_t *data, int src_pos, int comp_accumulator)

std::string	SetBuffer (const std::vector< uint8_t > &data, int src_pos, int comp_accumulator)

void	memfill (const uint8_t *data, std::vector< uint8_t > &buffer, int buffer_pos, int offset, int length)

absl::StatusOr< std::vector< uint8_t > >	DecompressV2 (const uint8_t *data, int offset, int size=0x800, int mode=1)
	Decompresses a buffer of data using the LC_LZ2 algorithm.

absl::StatusOr< std::vector< uint8_t > >	DecompressGraphics (const uint8_t *data, int pos, int size)

absl::StatusOr< std::vector< uint8_t > >	DecompressOverworld (const uint8_t *data, int pos, int size)

absl::StatusOr< std::vector< uint8_t > >	DecompressOverworld (const std::vector< uint8_t > data, int pos, int size)

Variables
const std::array< int, 5 >	kCommandSizes = {1, 2, 2, 2, 3}

const int	D_NINTENDO_C_MODE1 = 0

const int	D_NINTENDO_C_MODE2 = 1

const int	D_CMD_COPY = 0

const int	D_CMD_BYTE_REPEAT = 1

const int	D_CMD_WORD_REPEAT = 2

const int	D_CMD_BYTE_INC = 3

const int	D_CMD_COPY_EXISTING = 4

const int	D_MAX_NORMAL_LENGTH = 32

const int	D_MAX_LENGTH = 1024

const int	INITIAL_ALLOC_SIZE = 1024

constexpr int	kCommandDirectCopy = 0

constexpr int	kCommandByteFill = 1

constexpr int	kCommandWordFill = 2

constexpr int	kCommandIncreasingFill = 3

constexpr int	kCommandRepeatingBytes = 4

constexpr int	kCommandLongLength = 7

constexpr int	kMaxLengthNormalHeader = 32

constexpr int	kMaxLengthCompression = 1024

constexpr int	kNintendoMode1 = 0

constexpr int	kNintendoMode2 = 1

constexpr int	kSnesByteMax = 0xFF

constexpr int	kCommandMod = 0x07

constexpr int	kExpandedMod = 0xE0

constexpr int	kExpandedLengthMod = 0x3FF

constexpr int	kNormalLengthMod = 0x1F

constexpr int	kCompressionStringMod = 7 << 5

Detailed Description

Contains the LC_LZ2 compression algorithm.

Typedef Documentation

◆ CommandArgumentArray

using yaze::gfx::lc_lz2::CommandArgumentArray = std::array<std::array<char, 2>, 5>

Definition at line 74 of file compression.h.

◆ CommandSizeArray

using yaze::gfx::lc_lz2::CommandSizeArray = std::array<uint, 5>

Definition at line 75 of file compression.h.

◆ DataSizeArray

using yaze::gfx::lc_lz2::DataSizeArray = std::array<uint, 5>

Definition at line 76 of file compression.h.

◆ CompressionPiece

using yaze::gfx::lc_lz2::CompressionPiece = struct CompressionPiece

Definition at line 89 of file compression.h.

◆ CompressionPiecePointer

using yaze::gfx::lc_lz2::CompressionPiecePointer = std::shared_ptr<CompressionPiece>

Definition at line 90 of file compression.h.

Function Documentation

◆ PrintCompressionPiece()

void yaze::gfx::lc_lz2::PrintCompressionPiece ( const CompressionPiecePointer & piece )

Definition at line 304 of file compression.cc.

Referenced by AddAlternativeCompressionCommand(), CompressionCommandAlternative(), CompressionCommandAlternativeV2(), CreateCompressionString(), MergeCopy(), and PrintCompressionChain().

◆ PrintCompressionChain()

void yaze::gfx::lc_lz2::PrintCompressionChain ( const CompressionPiecePointer & chain_head )

Definition at line 315 of file compression.cc.

References PrintCompressionPiece().

Referenced by CompressV2().

Here is the call graph for this function:

◆ CheckByteRepeat()

void yaze::gfx::lc_lz2::CheckByteRepeat	(	const uint8_t *	rom_data,
		DataSizeArray &	data_size_taken,
		CommandArgumentArray &	cmd_args,
		uint &	src_data_pos,
		const unsigned int	last_pos )

Definition at line 324 of file compression.cc.

References kCommandByteFill.

◆ CheckWordRepeat()

void yaze::gfx::lc_lz2::CheckWordRepeat	(	const uint8_t *	rom_data,
		DataSizeArray &	data_size_taken,
		CommandArgumentArray &	cmd_args,
		uint &	src_data_pos,
		const unsigned int	last_pos )

Definition at line 336 of file compression.cc.

References kCommandWordFill.

◆ CheckIncByte()

void yaze::gfx::lc_lz2::CheckIncByte	(	const uint8_t *	rom_data,
		DataSizeArray &	data_size_taken,
		CommandArgumentArray &	cmd_args,
		uint &	src_data_pos,
		const unsigned int	last_pos )

Definition at line 358 of file compression.cc.

References kCommandIncreasingFill.

◆ CheckIntraCopy()

void yaze::gfx::lc_lz2::CheckIntraCopy	(	const uint8_t *	rom_data,
		DataSizeArray &	data_size_taken,
		CommandArgumentArray &	cmd_args,
		uint &	src_data_pos,
		const unsigned int	last_pos,
		unsigned int	start )

Definition at line 374 of file compression.cc.

References kCommandRepeatingBytes, and kSnesByteMax.

◆ ValidateForByteGain()

void yaze::gfx::lc_lz2::ValidateForByteGain	(	const DataSizeArray &	data_size_taken,
		const CommandSizeArray &	cmd_size,
		uint &	max_win,
		uint &	cmd_with_max )

Definition at line 410 of file compression.cc.

References kCommandRepeatingBytes.

Referenced by CompressV2().

◆ CompressionCommandAlternative()

void yaze::gfx::lc_lz2::CompressionCommandAlternative	(	const uint8_t *	rom_data,
		CompressionPiecePointer &	compressed_chain,
		const CommandSizeArray &	cmd_size,
		const CommandArgumentArray &	cmd_args,
		uint &	src_data_pos,
		uint &	comp_accumulator,
		uint &	cmd_with_max,
		uint &	max_win )

Definition at line 428 of file compression.cc.

References kCommandDirectCopy, and PrintCompressionPiece().

Here is the call graph for this function:

◆ CheckByteRepeatV2()

void yaze::gfx::lc_lz2::CheckByteRepeatV2	(	const uint8_t *	data,
		uint &	src_pos,
		const unsigned int	last_pos,
		CompressionCommand &	cmd )

Definition at line 463 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, yaze::gfx::lc_lz2::CompressionCommand::data_size, and kCommandByteFill.

Referenced by CompressV2().

◆ CheckWordRepeatV2()

void yaze::gfx::lc_lz2::CheckWordRepeatV2	(	const uint8_t *	data,
		uint &	src_pos,
		const unsigned int	last_pos,
		CompressionCommand &	cmd )

Definition at line 473 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, yaze::gfx::lc_lz2::CompressionCommand::data_size, and kCommandWordFill.

Referenced by CompressV2().

◆ CheckIncByteV2()

void yaze::gfx::lc_lz2::CheckIncByteV2	(	const uint8_t *	rom_data,
		uint &	src_data_pos,
		const unsigned int	last_pos,
		CompressionCommand &	cmd )

Definition at line 493 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, yaze::gfx::lc_lz2::CompressionCommand::data_size, and kCommandIncreasingFill.

Referenced by CompressV2().

◆ CheckIntraCopyV2()

void yaze::gfx::lc_lz2::CheckIntraCopyV2	(	const uint8_t *	rom_data,
		uint &	src_data_pos,
		const unsigned int	last_pos,
		unsigned int	start,
		CompressionCommand &	cmd )

Definition at line 508 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, yaze::gfx::lc_lz2::CompressionCommand::data_size, kCommandRepeatingBytes, and kSnesByteMax.

Referenced by CompressV2().

◆ ValidateForByteGainV2()

void yaze::gfx::lc_lz2::ValidateForByteGainV2	(	const CompressionCommand &	cmd,
		uint &	max_win,
		uint &	cmd_with_max )

Definition at line 546 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::data_size, kCommandRepeatingBytes, and kCommandSizes.

◆ CompressionCommandAlternativeV2()

void yaze::gfx::lc_lz2::CompressionCommandAlternativeV2	(	const uint8_t *	rom_data,
		const CompressionCommand &	cmd,
		CompressionPiecePointer &	compressed_chain,
		uint &	src_data_pos,
		uint &	comp_accumulator,
		uint &	cmd_with_max,
		uint &	max_win )

Definition at line 562 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, yaze::gfx::lc_lz2::CompressionCommand::cmd_size, kCommandDirectCopy, and PrintCompressionPiece().

Here is the call graph for this function:

◆ AddAlternativeCompressionCommand()

void yaze::gfx::lc_lz2::AddAlternativeCompressionCommand	(	const uint8_t *	rom_data,
		CompressionPiecePointer &	compressed_chain,
		const CompressionCommand &	command,
		uint &	source_data_position,
		uint &	uncompressed_data_size,
		uint &	best_command,
		uint &	best_command_gain )

Definition at line 596 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, yaze::gfx::lc_lz2::CompressionCommand::cmd_size, kCommandDirectCopy, and PrintCompressionPiece().

Referenced by CompressV2().

Here is the call graph for this function:

◆ SplitCompressionPiece()

absl::StatusOr< CompressionPiecePointer > yaze::gfx::lc_lz2::SplitCompressionPiece	(	CompressionPiecePointer &	piece,
		int	mode )

Definition at line 643 of file compression.cc.

References kCommandByteFill, kCommandDirectCopy, kCommandIncreasingFill, kCommandRepeatingBytes, kCommandWordFill, kMaxLengthCompression, kNintendoMode1, kNintendoMode2, and kSnesByteMax.

Referenced by CreateCompressionString().

◆ CreateCompressionString()

std::vector< uint8_t > yaze::gfx::lc_lz2::CreateCompressionString	(	CompressionPiecePointer &	start,
		int	mode )

Definition at line 696 of file compression.cc.

References BUILD_HEADER, kCommandRepeatingBytes, kCompressionStringMod, kMaxLengthCompression, kMaxLengthNormalHeader, kNintendoMode1, kSnesByteMax, PrintCompressionPiece(), and SplitCompressionPiece().

Referenced by CompressV2(), and ValidateCompressionResult().

Here is the call graph for this function:

◆ ValidateCompressionResult()

absl::Status yaze::gfx::lc_lz2::ValidateCompressionResult	(	CompressionPiecePointer &	chain_head,
		int	mode,
		int	start,
		int	src_data_pos )

Definition at line 756 of file compression.cc.

References ASSIGN_OR_RETURN, yaze::Rom::begin(), CreateCompressionString(), yaze::Rom::data(), DecompressV2(), yaze::Rom::LoadFromData(), RETURN_IF_ERROR, and yaze::Rom::size().

Referenced by CompressV2().

◆ MergeCopy()

CompressionPiecePointer yaze::gfx::lc_lz2::MergeCopy ( CompressionPiecePointer & start )

Definition at line 775 of file compression.cc.

References kCommandDirectCopy, kMaxLengthCompression, and PrintCompressionPiece().

Referenced by CompressV2().

Here is the call graph for this function:

◆ CompressV2()

absl::StatusOr< std::vector< uint8_t > > yaze::gfx::lc_lz2::CompressV2	(	const uint8_t *	data,
		const int	start,
		const int	length,
		int	mode = 1,
		bool	check = false )

Compresses a buffer of data using the LC_LZ2 algorithm.

Deprecated: Use HyruleMagicDecompress instead.

Definition at line 800 of file compression.cc.

References AddAlternativeCompressionCommand(), yaze::gfx::lc_lz2::CompressionCommand::arguments, CheckByteRepeatV2(), CheckIncByteV2(), CheckIntraCopyV2(), CheckWordRepeatV2(), yaze::gfx::lc_lz2::CompressionCommand::cmd_size, CreateCompressionString(), yaze::gfx::lc_lz2::CompressionCommand::data_size, kCommandDirectCopy, MergeCopy(), PrintCompressionChain(), RETURN_IF_ERROR, SetBuffer(), ValidateCompressionResult(), and ValidateForByteGain().

Referenced by CompressGraphics(), and CompressOverworld().

◆ CompressGraphics()

absl::StatusOr< std::vector< uint8_t > > yaze::gfx::lc_lz2::CompressGraphics	(	const uint8_t *	data,
		const int	pos,
		const int	length )

Definition at line 876 of file compression.cc.

References CompressV2(), and kNintendoMode2.

Here is the call graph for this function:

◆ CompressOverworld() [1/2]

absl::StatusOr< std::vector< uint8_t > > yaze::gfx::lc_lz2::CompressOverworld	(	const uint8_t *	data,
		const int	pos,
		const int	length )

Definition at line 882 of file compression.cc.

References CompressV2(), and kNintendoMode1.

Here is the call graph for this function:

◆ CompressOverworld() [2/2]

absl::StatusOr< std::vector< uint8_t > > yaze::gfx::lc_lz2::CompressOverworld	(	const std::vector< uint8_t >	data,
		const int	pos,
		const int	length )

Definition at line 888 of file compression.cc.

References CompressV3(), and kNintendoMode1.

Here is the call graph for this function:

◆ CheckByteRepeatV3()

void yaze::gfx::lc_lz2::CheckByteRepeatV3 ( CompressionContext & context )

Definition at line 893 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, yaze::gfx::lc_lz2::CompressionContext::current_cmd, yaze::gfx::lc_lz2::CompressionContext::data, yaze::gfx::lc_lz2::CompressionCommand::data_size, DEBUG_LOG, kCommandByteFill, yaze::gfx::lc_lz2::CompressionContext::last_pos, and yaze::gfx::lc_lz2::CompressionContext::src_pos.

Referenced by CheckAvailableCompressionCommands().

◆ CheckWordRepeatV3()

void yaze::gfx::lc_lz2::CheckWordRepeatV3 ( CompressionContext & context )

Definition at line 913 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, yaze::gfx::lc_lz2::CompressionContext::current_cmd, yaze::gfx::lc_lz2::CompressionContext::data, yaze::gfx::lc_lz2::CompressionCommand::data_size, DEBUG_LOG, kCommandWordFill, yaze::gfx::lc_lz2::CompressionContext::last_pos, and yaze::gfx::lc_lz2::CompressionContext::src_pos.

Referenced by CheckAvailableCompressionCommands().

◆ CheckIncByteV3()

void yaze::gfx::lc_lz2::CheckIncByteV3 ( CompressionContext & context )

Definition at line 939 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, yaze::gfx::lc_lz2::CompressionContext::current_cmd, yaze::gfx::lc_lz2::CompressionContext::data, yaze::gfx::lc_lz2::CompressionCommand::data_size, DEBUG_LOG, kCommandIncreasingFill, yaze::gfx::lc_lz2::CompressionContext::last_pos, and yaze::gfx::lc_lz2::CompressionContext::src_pos.

Referenced by CheckAvailableCompressionCommands().

◆ CheckIntraCopyV3()

void yaze::gfx::lc_lz2::CheckIntraCopyV3 ( CompressionContext & context )

Definition at line 971 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, yaze::gfx::lc_lz2::CompressionContext::current_cmd, yaze::gfx::lc_lz2::CompressionContext::data, yaze::gfx::lc_lz2::CompressionCommand::data_size, DEBUG_LOG, kCommandRepeatingBytes, kSnesByteMax, and yaze::gfx::lc_lz2::CompressionContext::src_pos.

Referenced by CheckAvailableCompressionCommands().

◆ InitializeCompression()

void yaze::gfx::lc_lz2::InitializeCompression ( CompressionContext & context )

Definition at line 1026 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionContext::current_cmd.

Referenced by CompressV3().

◆ CheckAvailableCompressionCommands()

void yaze::gfx::lc_lz2::CheckAvailableCompressionCommands ( CompressionContext & context )

Definition at line 1033 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::arguments, CheckByteRepeatV3(), CheckIncByteV3(), CheckIntraCopyV3(), CheckWordRepeatV3(), yaze::gfx::lc_lz2::CompressionContext::current_cmd, yaze::gfx::lc_lz2::CompressionCommand::data_size, DEBUG_LOG, and yaze::gfx::lc_lz2::CompressionContext::src_pos.

Referenced by CompressV3().

Here is the call graph for this function:

◆ DetermineBestCompression()

void yaze::gfx::lc_lz2::DetermineBestCompression ( CompressionContext & context )

Definition at line 1046 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionCommand::cmd_size, yaze::gfx::lc_lz2::CompressionContext::cmd_with_max, yaze::gfx::lc_lz2::CompressionContext::current_cmd, yaze::gfx::lc_lz2::CompressionContext::data, yaze::gfx::lc_lz2::CompressionCommand::data_size, DEBUG_LOG, kCommandDirectCopy, and yaze::gfx::lc_lz2::CompressionContext::src_pos.

Referenced by CompressV3().

◆ HandleDirectCopy()

void yaze::gfx::lc_lz2::HandleDirectCopy ( CompressionContext & context )

Definition at line 1083 of file compression.cc.

References BUILD_HEADER, yaze::gfx::lc_lz2::CompressionContext::cmd_with_max, yaze::gfx::lc_lz2::CompressionContext::comp_accumulator, yaze::gfx::lc_lz2::CompressionContext::compressed_data, yaze::gfx::lc_lz2::CompressionContext::data, DEBUG_LOG, kCommandDirectCopy, yaze::gfx::lc_lz2::CompressionContext::last_pos, and yaze::gfx::lc_lz2::CompressionContext::src_pos.

Referenced by CompressV3().

◆ AddCompressionToChain()

void yaze::gfx::lc_lz2::AddCompressionToChain ( CompressionContext & context )

Definition at line 1135 of file compression.cc.

Referenced by CompressV3().

◆ ValidateCompressionResultV3()

absl::Status yaze::gfx::lc_lz2::ValidateCompressionResultV3 ( const CompressionContext & context )

Definition at line 1178 of file compression.cc.

References ASSIGN_OR_RETURN, yaze::Rom::begin(), yaze::gfx::lc_lz2::CompressionContext::compressed_data, yaze::Rom::data(), DecompressV2(), yaze::Rom::LoadFromData(), RETURN_IF_ERROR, yaze::Rom::size(), yaze::gfx::lc_lz2::CompressionContext::src_pos, and yaze::gfx::lc_lz2::CompressionContext::start.

Referenced by CompressV3().

◆ SplitCompressionPieceV3()

absl::StatusOr< CompressionPiece > yaze::gfx::lc_lz2::SplitCompressionPieceV3	(	CompressionPiece &	piece,
		int	mode )

Definition at line 1195 of file compression.cc.

References yaze::gfx::lc_lz2::CompressionPiece::argument, yaze::gfx::lc_lz2::CompressionPiece::argument_length, yaze::gfx::lc_lz2::CompressionPiece::command, kCommandByteFill, kCommandDirectCopy, kCommandIncreasingFill, kCommandRepeatingBytes, kCommandWordFill, kMaxLengthCompression, kNintendoMode1, kNintendoMode2, kSnesByteMax, and yaze::gfx::lc_lz2::CompressionPiece::length.

Referenced by FinalizeCompression().

◆ FinalizeCompression()

void yaze::gfx::lc_lz2::FinalizeCompression ( CompressionContext & context )

Definition at line 1246 of file compression.cc.

Referenced by CompressV3().

Here is the call graph for this function:

◆ CompressV3()

absl::StatusOr< std::vector< uint8_t > > yaze::gfx::lc_lz2::CompressV3	(	const std::vector< uint8_t > &	data,
		const int	start,
		const int	length,
		int	mode = 1,
		bool	check = false )

Compresses a buffer of data using the LC_LZ2 algorithm.

Deprecated: Use HyruleMagicCompress

Definition at line 1313 of file compression.cc.

References AddCompressionToChain(), CheckAvailableCompressionCommands(), yaze::gfx::lc_lz2::CompressionContext::cmd_with_max, yaze::gfx::lc_lz2::CompressionContext::compressed_data, DEBUG_LOG, DetermineBestCompression(), FinalizeCompression(), HandleDirectCopy(), InitializeCompression(), kCommandDirectCopy, yaze::gfx::lc_lz2::CompressionContext::last_pos, RETURN_IF_ERROR, yaze::gfx::lc_lz2::CompressionContext::src_pos, and ValidateCompressionResultV3().

Referenced by CompressOverworld().

◆ SetBuffer() [1/2]

std::string yaze::gfx::lc_lz2::SetBuffer	(	const uint8_t *	data,
		int	src_pos,
		int	comp_accumulator )

Definition at line 1345 of file compression.cc.

Referenced by CompressV2().

◆ SetBuffer() [2/2]

std::string yaze::gfx::lc_lz2::SetBuffer	(	const std::vector< uint8_t > &	data,
		int	src_pos,
		int	comp_accumulator )

Definition at line 1353 of file compression.cc.

◆ memfill()

void yaze::gfx::lc_lz2::memfill	(	const uint8_t *	data,
		std::vector< uint8_t > &	buffer,
		int	buffer_pos,
		int	offset,
		int	length )

Definition at line 1362 of file compression.cc.

Referenced by DecompressV2().

◆ DecompressV2()

absl::StatusOr< std::vector< uint8_t > > yaze::gfx::lc_lz2::DecompressV2	(	const uint8_t *	data,
		int	offset,
		int	size = 0x800,
		int	mode = 1 )

Decompresses a buffer of data using the LC_LZ2 algorithm.

Note: Works well for graphics but not overworld data. Prefer Hyrule Magic routines for overworld data.

Definition at line 1372 of file compression.cc.

References kCommandByteFill, kCommandDirectCopy, kCommandIncreasingFill, kCommandMod, kCommandRepeatingBytes, kCommandWordFill, kExpandedLengthMod, kExpandedMod, kNintendoMode1, kNormalLengthMod, kSnesByteMax, and memfill().

Referenced by DecompressGraphics(), yaze::editor::GraphicsEditor::DecompressImportData(), DecompressOverworld(), DecompressOverworld(), yaze::editor::GraphicsEditor::DecompressSuperDonkey(), yaze::editor::GraphicsEditor::DrawTilemapImport(), yaze::Load2BppGraphics(), yaze::LoadAllGraphicsData(), ValidateCompressionResult(), and ValidateCompressionResultV3().

Here is the call graph for this function:

◆ DecompressGraphics()

absl::StatusOr< std::vector< uint8_t > > yaze::gfx::lc_lz2::DecompressGraphics	(	const uint8_t *	data,
		int	pos,
		int	size )

Definition at line 1460 of file compression.cc.

References DecompressV2(), and kNintendoMode2.

Here is the call graph for this function:

◆ DecompressOverworld() [1/2]

absl::StatusOr< std::vector< uint8_t > > yaze::gfx::lc_lz2::DecompressOverworld	(	const uint8_t *	data,
		int	pos,
		int	size )

Definition at line 1465 of file compression.cc.

References DecompressV2(), and kNintendoMode1.

Here is the call graph for this function:

◆ DecompressOverworld() [2/2]

absl::StatusOr< std::vector< uint8_t > > yaze::gfx::lc_lz2::DecompressOverworld	(	const std::vector< uint8_t >	data,
		int	pos,
		int	size )

Definition at line 1470 of file compression.cc.

References DecompressV2(), and kNintendoMode1.

Here is the call graph for this function:

Variable Documentation

◆ kCommandSizes

const std::array<int, 5> yaze::gfx::lc_lz2::kCommandSizes = {1, 2, 2, 2, 3}

Definition at line 543 of file compression.cc.

Referenced by ValidateForByteGainV2().

◆ D_NINTENDO_C_MODE1

const int yaze::gfx::lc_lz2::D_NINTENDO_C_MODE1 = 0

Definition at line 31 of file compression.h.

◆ D_NINTENDO_C_MODE2

const int yaze::gfx::lc_lz2::D_NINTENDO_C_MODE2 = 1

Definition at line 32 of file compression.h.

◆ D_CMD_COPY

const int yaze::gfx::lc_lz2::D_CMD_COPY = 0

Definition at line 34 of file compression.h.

◆ D_CMD_BYTE_REPEAT

const int yaze::gfx::lc_lz2::D_CMD_BYTE_REPEAT = 1

Definition at line 35 of file compression.h.

◆ D_CMD_WORD_REPEAT

const int yaze::gfx::lc_lz2::D_CMD_WORD_REPEAT = 2

Definition at line 36 of file compression.h.

◆ D_CMD_BYTE_INC

const int yaze::gfx::lc_lz2::D_CMD_BYTE_INC = 3

Definition at line 37 of file compression.h.

◆ D_CMD_COPY_EXISTING

const int yaze::gfx::lc_lz2::D_CMD_COPY_EXISTING = 4

Definition at line 38 of file compression.h.

◆ D_MAX_NORMAL_LENGTH

const int yaze::gfx::lc_lz2::D_MAX_NORMAL_LENGTH = 32

Definition at line 40 of file compression.h.

◆ D_MAX_LENGTH

const int yaze::gfx::lc_lz2::D_MAX_LENGTH = 1024

Definition at line 41 of file compression.h.

◆ INITIAL_ALLOC_SIZE

const int yaze::gfx::lc_lz2::INITIAL_ALLOC_SIZE = 1024

Definition at line 43 of file compression.h.

◆ kCommandDirectCopy

int yaze::gfx::lc_lz2::kCommandDirectCopy = 0

constexpr

Definition at line 45 of file compression.h.

Referenced by AddAlternativeCompressionCommand(), AddCompressionToChain(), CompressionCommandAlternative(), CompressionCommandAlternativeV2(), CompressV2(), CompressV3(), DecompressV2(), DetermineBestCompression(), HandleDirectCopy(), MergeCopy(), SplitCompressionPiece(), and SplitCompressionPieceV3().

◆ kCommandByteFill

int yaze::gfx::lc_lz2::kCommandByteFill = 1

constexpr

Definition at line 46 of file compression.h.

Referenced by CheckByteRepeat(), CheckByteRepeatV2(), CheckByteRepeatV3(), DecompressV2(), SplitCompressionPiece(), and SplitCompressionPieceV3().

◆ kCommandWordFill

int yaze::gfx::lc_lz2::kCommandWordFill = 2

constexpr

Definition at line 47 of file compression.h.

Referenced by CheckWordRepeat(), CheckWordRepeatV2(), CheckWordRepeatV3(), DecompressV2(), SplitCompressionPiece(), and SplitCompressionPieceV3().

◆ kCommandIncreasingFill

int yaze::gfx::lc_lz2::kCommandIncreasingFill = 3

constexpr

Definition at line 48 of file compression.h.

Referenced by CheckIncByte(), CheckIncByteV2(), CheckIncByteV3(), DecompressV2(), SplitCompressionPiece(), and SplitCompressionPieceV3().

◆ kCommandRepeatingBytes

int yaze::gfx::lc_lz2::kCommandRepeatingBytes = 4

constexpr

Definition at line 49 of file compression.h.

Referenced by CheckIntraCopy(), CheckIntraCopyV2(), CheckIntraCopyV3(), CreateCompressionString(), DecompressV2(), FinalizeCompression(), SplitCompressionPiece(), SplitCompressionPieceV3(), ValidateForByteGain(), and ValidateForByteGainV2().

◆ kCommandLongLength

int yaze::gfx::lc_lz2::kCommandLongLength = 7

constexpr

Definition at line 50 of file compression.h.

◆ kMaxLengthNormalHeader

int yaze::gfx::lc_lz2::kMaxLengthNormalHeader = 32

constexpr

Definition at line 51 of file compression.h.

Referenced by CreateCompressionString(), and FinalizeCompression().

◆ kMaxLengthCompression

int yaze::gfx::lc_lz2::kMaxLengthCompression = 1024

constexpr

Definition at line 52 of file compression.h.

Referenced by CreateCompressionString(), FinalizeCompression(), MergeCopy(), SplitCompressionPiece(), and SplitCompressionPieceV3().

◆ kNintendoMode1

int yaze::gfx::lc_lz2::kNintendoMode1 = 0

constexpr

Definition at line 53 of file compression.h.

Referenced by CompressOverworld(), CompressOverworld(), CreateCompressionString(), DecompressOverworld(), DecompressOverworld(), DecompressV2(), yaze::editor::GraphicsEditor::DrawTilemapImport(), FinalizeCompression(), SplitCompressionPiece(), and SplitCompressionPieceV3().

◆ kNintendoMode2

int yaze::gfx::lc_lz2::kNintendoMode2 = 1

constexpr

Definition at line 54 of file compression.h.

Referenced by CompressGraphics(), DecompressGraphics(), SplitCompressionPiece(), and SplitCompressionPieceV3().

◆ kSnesByteMax

int yaze::gfx::lc_lz2::kSnesByteMax = 0xFF

constexpr

Definition at line 55 of file compression.h.

Referenced by CheckIntraCopy(), CheckIntraCopyV2(), CheckIntraCopyV3(), CreateCompressionString(), DecompressV2(), FinalizeCompression(), SplitCompressionPiece(), and SplitCompressionPieceV3().

◆ kCommandMod

int yaze::gfx::lc_lz2::kCommandMod = 0x07

constexpr

Definition at line 56 of file compression.h.

Referenced by DecompressV2().

◆ kExpandedMod

int yaze::gfx::lc_lz2::kExpandedMod = 0xE0

constexpr

Definition at line 57 of file compression.h.

Referenced by DecompressV2().

◆ kExpandedLengthMod

int yaze::gfx::lc_lz2::kExpandedLengthMod = 0x3FF

constexpr

Definition at line 58 of file compression.h.

Referenced by DecompressV2().

◆ kNormalLengthMod

int yaze::gfx::lc_lz2::kNormalLengthMod = 0x1F

constexpr

Definition at line 59 of file compression.h.

Referenced by DecompressV2().

◆ kCompressionStringMod

int yaze::gfx::lc_lz2::kCompressionStringMod = 7 << 5

constexpr

Definition at line 60 of file compression.h.

Referenced by CreateCompressionString(), and FinalizeCompression().

	yaze 0.2.2 Link to the Past ROM Editor

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ CommandArgumentArray

◆ CommandSizeArray

◆ DataSizeArray

◆ CompressionPiece

◆ CompressionPiecePointer

Function Documentation

◆ PrintCompressionPiece()

◆ PrintCompressionChain()

◆ CheckByteRepeat()

◆ CheckWordRepeat()

◆ CheckIncByte()

◆ CheckIntraCopy()

◆ ValidateForByteGain()

◆ CompressionCommandAlternative()

◆ CheckByteRepeatV2()

◆ CheckWordRepeatV2()

◆ CheckIncByteV2()

◆ CheckIntraCopyV2()

◆ ValidateForByteGainV2()

◆ CompressionCommandAlternativeV2()

◆ AddAlternativeCompressionCommand()

◆ SplitCompressionPiece()

◆ CreateCompressionString()

◆ ValidateCompressionResult()

◆ MergeCopy()

◆ CompressV2()

◆ CompressGraphics()

◆ CompressOverworld() [1/2]

◆ CompressOverworld() [2/2]

◆ CheckByteRepeatV3()

◆ CheckWordRepeatV3()

◆ CheckIncByteV3()

◆ CheckIntraCopyV3()

◆ InitializeCompression()

◆ CheckAvailableCompressionCommands()

◆ DetermineBestCompression()

◆ HandleDirectCopy()

◆ AddCompressionToChain()

◆ ValidateCompressionResultV3()

◆ SplitCompressionPieceV3()

◆ FinalizeCompression()

◆ CompressV3()

◆ SetBuffer() [1/2]

◆ SetBuffer() [2/2]

◆ memfill()

◆ DecompressV2()

◆ DecompressGraphics()

◆ DecompressOverworld() [1/2]

◆ DecompressOverworld() [2/2]

Variable Documentation

◆ kCommandSizes

◆ D_NINTENDO_C_MODE1

◆ D_NINTENDO_C_MODE2

◆ D_CMD_COPY

◆ D_CMD_BYTE_REPEAT

◆ D_CMD_WORD_REPEAT

◆ D_CMD_BYTE_INC

◆ D_CMD_COPY_EXISTING

◆ D_MAX_NORMAL_LENGTH

◆ D_MAX_LENGTH

◆ INITIAL_ALLOC_SIZE

◆ kCommandDirectCopy

◆ kCommandByteFill

◆ kCommandWordFill

◆ kCommandIncreasingFill

◆ kCommandRepeatingBytes

◆ kCommandLongLength

◆ kMaxLengthNormalHeader

◆ kMaxLengthCompression

◆ kNintendoMode1

◆ kNintendoMode2

◆ kSnesByteMax

◆ kCommandMod

◆ kExpandedMod