mrcrowbar.lib.games.tyrian module¶

File format classes for the Tyrian engine (DOS, 1995).

class mrcrowbar.lib.games.tyrian.MUSFile(*args, **kwargs)[source]¶

Bases: mrcrowbar.blocks.Block

song_count¶

song_offsets¶

songs_raw¶

class mrcrowbar.lib.games.tyrian.Song(source_data: common.BytesReadType | None = None, *, parent: Block | None = None, preload_attrs: dict[str, Any] | None = None, endian: EndianEncoding = None, cache_bytes: bool = False, path_hint: str | None = None, strict: bool = False, cache_refs: bool = True)[source]¶

Bases: mrcrowbar.blocks.Block

Base class for Blocks.

source_data: Source data to construct Block with. Can be a byte string, dictionary of attribute: value pairs, or another Block object.
parent: Parent Block object where this Block is defined. Used for e.g. evaluating Refs.
preload_attrs: Attributes on the Block to set before importing the data. Used for linking in dependencies before loading.
endian: Platform endianness to use when interpreting the Block data. Useful for Blocks which have the same data layout but different endianness for stored numbers. Has no effect on fields with an predefined endianness.
cache_bytes: Cache the bytes equivalent of the Block. Useful for debugging the loading procedure. Defaults to False.
path_hint: Cache a string containing the path of the current Block, relative to the root.
strict: Throw an exception if parsing a BlockField fails, instead of logging a warning and returning an Unknown. Defaults to False.
cache_refs: Pre-cache all the Refs. Defaults to True.

chandelay¶

mode¶

num_digital¶

patch_count¶

patches¶

patterns¶

pattlen¶

position_count¶

positions¶

regbd¶

speed¶

tempo¶

class mrcrowbar.lib.games.tyrian.SongPatch(source_data: common.BytesReadType | None = None, *, parent: Block | None = None, preload_attrs: dict[str, Any] | None = None, endian: EndianEncoding = None, cache_bytes: bool = False, path_hint: str | None = None, strict: bool = False, cache_refs: bool = True)[source]¶

Bases: mrcrowbar.blocks.Block

Base class for Blocks.

source_data: Source data to construct Block with. Can be a byte string, dictionary of attribute: value pairs, or another Block object.
parent: Parent Block object where this Block is defined. Used for e.g. evaluating Refs.
preload_attrs: Attributes on the Block to set before importing the data. Used for linking in dependencies before loading.
endian: Platform endianness to use when interpreting the Block data. Useful for Blocks which have the same data layout but different endianness for stored numbers. Has no effect on fields with an predefined endianness.
cache_bytes: Cache the bytes equivalent of the Block. Useful for debugging the loading procedure. Defaults to False.
path_hint: Cache a string containing the path of the current Block, relative to the root.
strict: Throw an exception if parsing a BlockField fails, instead of logging a warning and returning an Unknown. Defaults to False.
cache_refs: Pre-cache all the Refs. Defaults to True.

arp_tab¶

arpeggio¶

car_ad¶

car_misc¶

car_sr¶

car_trem¶

car_vol¶

car_wave¶

feedback¶

finetune¶

fms¶

glide¶

keyoff¶

middum1¶

middum2¶

midinst¶

midkey¶

midtrans¶

midvelo¶

mod_ad¶

mod_sr¶

mod_trem¶

mod_visc¶

mod_vol¶

mod_wave¶

portamento¶

size¶

start¶

transp¶

tremwait¶

vibdelay¶

vibrato¶

class mrcrowbar.lib.games.tyrian.SongPattern(source_data: common.BytesReadType | None = None, *, parent: Block | None = None, preload_attrs: dict[str, Any] | None = None, endian: EndianEncoding = None, cache_bytes: bool = False, path_hint: str | None = None, strict: bool = False, cache_refs: bool = True)[source]¶

Bases: mrcrowbar.blocks.Block

Base class for Blocks.

source_data: Source data to construct Block with. Can be a byte string, dictionary of attribute: value pairs, or another Block object.
parent: Parent Block object where this Block is defined. Used for e.g. evaluating Refs.
preload_attrs: Attributes on the Block to set before importing the data. Used for linking in dependencies before loading.
endian: Platform endianness to use when interpreting the Block data. Useful for Blocks which have the same data layout but different endianness for stored numbers. Has no effect on fields with an predefined endianness.
cache_bytes: Cache the bytes equivalent of the Block. Useful for debugging the loading procedure. Defaults to False.
path_hint: Cache a string containing the path of the current Block, relative to the root.
strict: Throw an exception if parsing a BlockField fails, instead of logging a warning and returning an Unknown. Defaults to False.
cache_refs: Pre-cache all the Refs. Defaults to True.

func¶

value¶

class mrcrowbar.lib.games.tyrian.SongPosition(source_data: common.BytesReadType | None = None, *, parent: Block | None = None, preload_attrs: dict[str, Any] | None = None, endian: EndianEncoding = None, cache_bytes: bool = False, path_hint: str | None = None, strict: bool = False, cache_refs: bool = True)[source]¶

Bases: mrcrowbar.blocks.Block

Base class for Blocks.

source_data: Source data to construct Block with. Can be a byte string, dictionary of attribute: value pairs, or another Block object.
parent: Parent Block object where this Block is defined. Used for e.g. evaluating Refs.
preload_attrs: Attributes on the Block to set before importing the data. Used for linking in dependencies before loading.
endian: Platform endianness to use when interpreting the Block data. Useful for Blocks which have the same data layout but different endianness for stored numbers. Has no effect on fields with an predefined endianness.
cache_bytes: Cache the bytes equivalent of the Block. Useful for debugging the loading procedure. Defaults to False.
path_hint: Cache a string containing the path of the current Block, relative to the root.
strict: Throw an exception if parsing a BlockField fails, instead of logging a warning and returning an Unknown. Defaults to False.
cache_refs: Pre-cache all the Refs. Defaults to True.

channels¶

class mrcrowbar.lib.games.tyrian.SongPositionChannel(source_data: common.BytesReadType | None = None, *, parent: Block | None = None, preload_attrs: dict[str, Any] | None = None, endian: EndianEncoding = None, cache_bytes: bool = False, path_hint: str | None = None, strict: bool = False, cache_refs: bool = True)[source]¶

Bases: mrcrowbar.blocks.Block

Base class for Blocks.

source_data: Source data to construct Block with. Can be a byte string, dictionary of attribute: value pairs, or another Block object.
parent: Parent Block object where this Block is defined. Used for e.g. evaluating Refs.
preload_attrs: Attributes on the Block to set before importing the data. Used for linking in dependencies before loading.
endian: Platform endianness to use when interpreting the Block data. Useful for Blocks which have the same data layout but different endianness for stored numbers. Has no effect on fields with an predefined endianness.
cache_bytes: Cache the bytes equivalent of the Block. Useful for debugging the loading procedure. Defaults to False.
path_hint: Cache a string containing the path of the current Block, relative to the root.
strict: Throw an exception if parsing a BlockField fails, instead of logging a warning and returning an Unknown. Defaults to False.
cache_refs: Pre-cache all the Refs. Defaults to True.

pattern_num¶

pattern_num_raw¶

transpose¶