Bundle (original): Difference between revisions
m (Memory address comments) |
|||
(19 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{hatnote|This page is about the original Bundle format, used only during development. For the version used in retail titles, see [[Bundle 2]].}} |
|||
The Bundle container is the core file format of Criterion's 7th-gen titles with the exception of Burnout Revenge (X360). Each Bundle holds one or more resources (assets) and contains information about each resource, such as its size, type, compression, alignment, and so on. |
|||
The Bundle container is the core file format used in development builds of Burnout 5/Paradise, Black (Xbox 360), and Black 2 (Xbox 360). It is not used in any retail titles. Each Bundle holds one or more resources (assets) and contains information about each resource, such as its size, type, compression, alignment, and so on. |
|||
The Bundle format has two major versions: the original, using the <code>bndl</code> magic, and Bundle 2, using the <code>bnd2</code> magic. The first Bundle format underwent at least five iterations during its use from early 2006 to early-mid 2007, but it was never used in a retail game and can only be found in development builds of games such as Burnout Paradise. It was succeeded by Bundle 2, which ultimately saw use in the retail versions of Burnout Paradise (version 2), Need for Speed Hot Pursuit (version 3), and Need for Speed Most Wanted (version 5). |
|||
At present, only files using Bundle version 3, 4, and 5 have been discovered. |
The Bundle format underwent at least five iterations during its use from early 2006 to early-mid 2007. At present, only files using Bundle version 3, 4, and 5 have been discovered. It was succeeded by the [[Bundle 2]] container. |
||
= |
= Memory types = |
||
Separate data chunks are used to define what memory type resources are loaded into. These chunks are platform specific (see [[#Base resource types|base resource types]]). Keep these in mind when viewing the structures. |
|||
== Memory types == |
|||
Across all Bundle versions, a common theme is the use of separate data chunks to define what memory type resources are loaded into. These chunks are as follows: |
|||
Resources always have data in Main Memory. If the resource is split, headers are loaded into Main Memory, while the other portion is typically loaded into into Graphics Local on PS3 and Physical on Xbox 360. '''In resource documentation, these will be simplified to a "secondary" type.''' Resources only ever have primary and secondary portions. On PS3, some resources' secondary portion may be loaded into Graphics System; in that case, it will be listed separately. |
|||
Bundle: |
|||
# Main Memory |
|||
# Disposable |
|||
# Physical |
|||
# Uninitialized |
|||
# Disposable uninitialized |
|||
= Structures = |
|||
Bundle 2 V2: |
|||
=== CgsResource::Bundle === |
|||
# Main Memory |
|||
==== PlayStation 3 ==== |
|||
# Graphics System |
|||
{| class="wikitable" |
|||
# Graphics Local |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|||
| 0x0 || 0x4 || uint32_t || muMagicNumber || Bundle magic || bndl |
|||
|- |
|||
| 0x4 || 0x4 || uint32_t || muVersion || Bundle version || 3 in base, 4 in V4, 5 in V5 |
|||
|- |
|||
| 0x8 || 0x4 || uint32_t || muNumResources || Number of resources in the bundle || |
|||
|- |
|||
| 0xC || 0x30 || [[#rw::ResourceDescriptor|ResourceDescriptor]][6] || mBundleResourceDescriptor || Size and alignment of each chunk || |
|||
|- |
|||
| 0x3C || 0x18 || [[#rw::Resource|Resource]][6] || mAllocatedResource || Memory address of each chunk || Set at runtime |
|||
|- |
|||
| 0x54 || 0x4 || uint32_t || mHashTableOffset || Resource IDs offset || List of [[Resource ID|resource IDs]] |
|||
|- |
|||
| 0x58 || 0x4 || uint32_t || mResourceEntriesOffset || Resource entries offset || See [[#CgsResource::Bundle::ResourceEntry|ResourceEntry]] |
|||
|- |
|||
| 0x5C || 0x4 || uint32_t || mImportTablesOffset || Imports offset || See [[#CgsResource::Bundle::ImportTable|ImportTable]] |
|||
|- |
|||
| 0x60 || 0x4 || uint32_t || mResourceDataOffset || Resource data offset || |
|||
|- |
|||
| 0x64 || 0x4 || uint32_t || muPlatform || Platform the bundle was built for || See [[#Platform|Platform]] |
|||
|} |
|||
==== Xbox 360 ==== |
|||
Keep these in mind when viewing the specs below. |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|||
| 0x0 || 0x4 || uint32_t || muMagicNumber || Bundle magic || bndl |
|||
|- |
|||
| 0x4 || 0x4 || uint32_t || muVersion || Bundle version || 3 in base, 4 in V4, 5 in V5 |
|||
|- |
|||
| 0x8 || 0x4 || uint32_t || muNumResources || Number of resources in the bundle || |
|||
|- |
|||
| 0xC || 0x28 || [[#rw::ResourceDescriptor|ResourceDescriptor]][5] || mBundleResourceDescriptor || Size and alignment of each chunk || |
|||
|- |
|||
| 0x34 || 0x14 || [[#rw::Resource|Resource]][5] || mAllocatedResource || Memory address of each chunk || Set at runtime |
|||
|- |
|||
| 0x48 || 0x4 || uint32_t || mHashTableOffset || Resource IDs offset || List of [[Resource ID|resource IDs]] |
|||
|- |
|||
| 0x4C || 0x4 || uint32_t || mResourceEntriesOffset || Resource entries offset || See [[#CgsResource::Bundle::ResourceEntry|ResourceEntry]] |
|||
|- |
|||
| 0x50 || 0x4 || uint32_t || mImportTablesOffset || Imports offset || See [[#CgsResource::Bundle::ImportTable|ImportTable]] |
|||
|- |
|||
| 0x54 || 0x4 || uint32_t || mResourceDataOffset || Resource data offset || |
|||
|- |
|||
| 0x58 || 0x4 || uint32_t || muPlatform || Platform the bundle was built for || See [[#Platform|Platform]] |
|||
|} |
|||
== |
==== PC ==== |
||
{| class="wikitable" |
|||
The original Bundle format's versions were treated more like additions to the previous version. Thus, rather than a full structure for each, only their additions are described here. |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|||
| 0x0 || 0x4 || uint32_t || muMagicNumber || Bundle magic || bndl |
|||
|- |
|||
| 0x4 || 0x4 || uint32_t || muVersion || Bundle version || 3 in base, 4 in V4, 5 in V5 |
|||
|- |
|||
| 0x8 || 0x4 || uint32_t || muNumResources || Number of resources in the bundle || |
|||
|- |
|||
| 0xC || 0x20 || [[#rw::ResourceDescriptor|ResourceDescriptor]][4] || mBundleResourceDescriptor || Size and alignment of each chunk || |
|||
|- |
|||
| 0x2C || 0x10 || [[#rw::Resource|Resource]][4] || mAllocatedResource || Memory address of each chunk || Set at runtime |
|||
|- |
|||
| 0x3C || 0x4 || uint32_t || mHashTableOffset || Resource IDs offset || List of [[Resource ID|resource IDs]] |
|||
|- |
|||
| 0x40 || 0x4 || uint32_t || mResourceEntriesOffset || Resource entries offset || See [[#CgsResource::Bundle::ResourceEntry|ResourceEntry]] |
|||
|- |
|||
| 0x44 || 0x4 || uint32_t || mImportTablesOffset || Imports offset || See [[#CgsResource::Bundle::ImportTable|ImportTable]] |
|||
|- |
|||
| 0x48 || 0x4 || uint32_t || mResourceDataOffset || Resource data offset || |
|||
|- |
|||
| 0x4C || 0x4 || uint32_t || muPlatform || Platform the bundle was built for || See [[#Platform|Platform]] |
|||
|} |
|||
=== CgsResource::BundleV4ExtendedData === |
|||
=== Version 3 === |
|||
==== PlayStation 3 ==== |
|||
{| class="wikitable" |
{| class="wikitable" |
||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x68 || CgsResource::BaseBundleExtendedData || Base class || || See [[#CgsResource::Bundle|Bundle]] |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| |
| 0x68 || 0x4 || uint32_t || muFlags || Bundle flags || See [[#CgsResource::EFlags|Flags]] |
||
|- |
|- |
||
| |
| 0x6C || 0x4 || uint32_t || muUncompressedDescriptorCount || Number of compressed resources || |
||
|- |
|- |
||
| 0x70 || 0x4 || [[#rw::ResourceDescriptor|ResourceDescriptor]]* || mpUncompressedResourceDescriptors || Compression information offset || |
|||
| 0x8 || 0x4 || uint32_t || muResourceEntriesCount || Number of resources in the bundle || |
|||
|} |
|||
==== Xbox 360 ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x5C || CgsResource::BaseBundleExtendedData || Base class || || See [[#CgsResource::Bundle|Bundle]] |
|||
| 0xC || 0x28 || SizeAndAlignment[5] || || Size and alignment of each chunk || |
|||
|- |
|- |
||
| |
| 0x5C || 0x4 || uint32_t || muFlags || Bundle flags || See [[#CgsResource::EFlags|Flags]] |
||
|- |
|- |
||
| |
| 0x60 || 0x4 || uint32_t || muUncompressedDescriptorCount || Number of compressed resources || |
||
|- |
|- |
||
| |
| 0x64 || 0x4 || [[#rw::ResourceDescriptor|ResourceDescriptor]]* || mpUncompressedResourceDescriptors || Compression information offset || |
||
|} |
|||
==== PC ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x50 || CgsResource::BaseBundleExtendedData || Base class || || See [[#CgsResource::Bundle|Bundle]] |
|||
| 0x50 || 0x4 || uint32_t || || Imports offset || |
|||
|- |
|- |
||
| |
| 0x50 || 0x4 || uint32_t || muFlags || Bundle flags || See [[#CgsResource::EFlags|Flags]] |
||
|- |
|- |
||
| |
| 0x5C || 0x4 || uint32_t || muUncompressedDescriptorCount || Number of compressed resources || |
||
|- |
|||
| 0x60 || 0x4 || [[#rw::ResourceDescriptor|ResourceDescriptor]]* || mpUncompressedResourceDescriptors || Compression information offset || |
|||
|} |
|} |
||
=== CgsResource::BundleV5ExtendedData === |
|||
=== Version 4 Additions === |
|||
==== PlayStation 3 ==== |
|||
{| class="wikitable" |
{| class="wikitable" |
||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x74 || [[#CgsResource::BundleV4ExtendedData|BundleV4ExtendedData]] || || Base class || |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|- |
|||
| 0x74 || 0x4 || int32_t || miMainMemAlignment || || |
|||
|- |
|||
| 0x78 || 0x4 || int32_t || miGraphicsMemAlignment || || |
|||
|} |
|||
==== Xbox 360 ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x68 || [[#CgsResource::BundleV4ExtendedData|BundleV4ExtendedData]] || || Base class || |
|||
| 0x5C || 0x4 || uint32_t || muFlags || Bundle flags || 1 = IsCompressed |
|||
|- |
|- |
||
| |
| 0x68 || 0x4 || int32_t || miMainMemAlignment || || |
||
|- |
|- |
||
| |
| 0x6C || 0x4 || int32_t || miGraphicsMemAlignment || || |
||
|} |
|} |
||
=== |
==== PC ==== |
||
{| class="wikitable" |
{| class="wikitable" |
||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x5C || [[#CgsResource::BundleV4ExtendedData|BundleV4ExtendedData]] || || Base class || |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| |
| 0x5C || 0x4 || int32_t || miMainMemAlignment || || |
||
|- |
|- |
||
| |
| 0x60 || 0x4 || int32_t || miGraphicsMemAlignment || || |
||
|} |
|} |
||
=== CgsResource::Bundle::ResourceEntry === |
|||
=== Substructures === |
|||
==== |
==== PlayStation 3 ==== |
||
{| class="wikitable" |
{| class="wikitable" |
||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x4 || void* || mpResource || Resource data memory address || Set at runtime |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| |
| 0x4 || 0x4 || [[#CgsResource::Bundle::ImportTable|ImportTable]]* || mpImportTable || Bundle imports offset || |
||
|- |
|- |
||
| 0x8 || 0x4 || CgsResource::Type* || mpType || Resource type || Type ID replaced by pointer at runtime. See [[Resource Types]] |
|||
| 0x4 || 0x4 || uint32_t || muImportOffset || Bundle imports offset || |
|||
|- |
|- |
||
| 0xC || 0x30 || [[#rw::ResourceDescriptor|ResourceDescriptor]][6] || mSerialisedResourceDescriptor || Resource sizes in bundle<br />Compressed size if compression used || |
|||
| 0x8 || 0x4 || uint32_t || muResourceTypeId || Resource type || See [[Resource Types (Burnout Paradise)|Resource Types]] |
|||
|- |
|- |
||
| 0x3C || 0x30 || [[#rw::ResourceDescriptor|ResourceDescriptor]][6] || mSerialisedOffsetResourceDescriptor || Offsets in bundle || Alignment is unused (always 1) |
|||
| 0xC || 0x28 || SizeAndAlignment[5] || mauSizeAndAlignmentOnDisk || || |
|||
|- |
|- |
||
| 0x6C || 0x18 || [[#rw::Resource|Resource]][6] || mSerialisedResource || Memory addresses || Set at runtime |
|||
| 0x34 || 0x28 || SizeAndAlignment[5] || mauDiskOffset || Offsets in bundle || Alignment is unused (always 1) |
|||
|} |
|||
==== Xbox 360 ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| |
| 0x0 || 0x4 || void* || mpResource || Resource data memory address || Set at runtime |
||
|- |
|||
| 0x4 || 0x4 || [[#CgsResource::Bundle::ImportTable|ImportTable]]* || mpImportTable || Bundle imports offset || |
|||
|- |
|||
| 0x8 || 0x4 || CgsResource::Type* || mpType || Resource type || Type ID replaced by pointer at runtime. See [[Resource Types]] |
|||
|- |
|||
| 0xC || 0x28 || [[#rw::ResourceDescriptor|ResourceDescriptor]][5] || mSerialisedResourceDescriptor || Resource sizes in bundle<br />Compressed size if compression used || |
|||
|- |
|||
| 0x34 || 0x28 || [[#rw::ResourceDescriptor|ResourceDescriptor]][5] || mSerialisedOffsetResourceDescriptor || Offsets in bundle || Alignment is unused (always 1) |
|||
|- |
|||
| 0x5C || 0x14 || [[#rw::Resource|Resource]][5] || mSerialisedResource || Memory addresses || Set at runtime |
|||
|} |
|} |
||
==== |
==== PC ==== |
||
{| class="wikitable" |
{| class="wikitable" |
||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|||
| 0x0 || 0x4 || void* || mpResource || Resource data memory address || Set at runtime |
|||
|- |
|||
| 0x4 || 0x4 || [[#CgsResource::Bundle::ImportTable|ImportTable]]* || mpImportTable || Bundle imports offset || |
|||
|- |
|||
| 0x8 || 0x4 || CgsResource::Type* || mpType || Resource type || Type ID replaced by pointer at runtime. See [[Resource Types]] |
|||
|- |
|- |
||
| 0xC || 0x20 || [[#rw::ResourceDescriptor|ResourceDescriptor]][4] || mSerialisedResourceDescriptor || Resource sizes in bundle<br />Compressed size if compression used || |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x2C || 0x20 || [[#rw::ResourceDescriptor|ResourceDescriptor]][4] || mSerialisedOffsetResourceDescriptor || Offsets in bundle || Alignment is unused (always 1) |
|||
| 0x0 || 0x4 || uint32_t || muImportCount || Number of imports || |
|||
|- |
|- |
||
| 0x4C || 0x10 || [[#rw::Resource|Resource]][4] || mSerialisedResource || Memory addresses || Set at runtime |
|||
| 0x8 || || || || Import entries || Aligned 8. See ImportEntry structure |
|||
|} |
|} |
||
=== CgsResource::Bundle::ImportTable === |
|||
==== ImportEntry ==== |
|||
This structure is followed by an [[#CgsResource::Bundle::ImportEntry|ImportEntry]] array. |
|||
{| class="wikitable" |
{| class="wikitable" |
||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x4 || uint32_t || muNumImports || Number of import entries || |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| |
| 0x8 || 0x4 || uint32_t || pad1 || Padding || |
||
|} |
|||
=== CgsResource::Bundle::ImportEntry === |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| |
| 0x0 || 0x8 || [[Resource ID|ID]] || mImportID || Resource name CRC32 || |
||
|- |
|- |
||
| |
| 0x8 || 0x4 || RwUInt32 || muOffset || || |
||
|- |
|||
| 0xC || 0x4 || || || Padding || |
|||
|} |
|} |
||
=== rw::ResourceDescriptor === |
|||
==== Compression Information ==== |
|||
==== PlayStation 3 ==== |
|||
{| class="wikitable" |
{| class="wikitable" |
||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x30 || [[#rw::BaseResourceDescriptors|BaseResourceDescriptors]] || || Base class || |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|} |
|||
==== Xbox 360 ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x28 || |
| 0x0 || 0x28 || [[#rw::BaseResourceDescriptors|BaseResourceDescriptors]] || || Base class || |
||
|} |
|} |
||
==== |
==== PC ==== |
||
{| class="wikitable" |
{| class="wikitable" |
||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x20 || [[#rw::BaseResourceDescriptors|BaseResourceDescriptors]] || || Base class || |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|} |
|||
=== rw::BaseResourceDescriptors === |
|||
==== PlayStation 3 ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x30 || [[#rw::BaseResourceDescriptor|BaseResourceDescriptor]][6] || m_baseResourceDescriptors || || |
|||
| 0x0 || 0x4 || uint32_t || || Size or offset || |
|||
|} |
|||
==== Xbox 360 ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x28 || [[#rw::BaseResourceDescriptor|BaseResourceDescriptor]][5] || m_baseResourceDescriptors || || |
|||
| 0x4 || 0x4 || uint32_t || || Alignment || |
|||
|} |
|} |
||
== |
==== PC ==== |
||
=== Version 2 === |
|||
{| class="wikitable" |
{| class="wikitable" |
||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x20 || [[#rw::BaseResourceDescriptor|BaseResourceDescriptor]][4] || m_baseResourceDescriptors || || |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|} |
|||
=== rw::BaseResourceDescriptor === |
|||
This structure contains fields for size and alignment, though alignment sometimes goes unused. |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x4 || |
| 0x0 || 0x4 || uint32_t || m_size || Size or offset || |
||
|- |
|- |
||
| 0x4 || 0x4 || uint32_t || |
| 0x4 || 0x4 || uint32_t || m_alignment || Alignment || |
||
|} |
|||
=== rw::Resource === |
|||
==== PlayStation 3 ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x18 || [[#rw::BaseResources|BaseResources]] || || Base class || |
|||
| 0x8 || 0x4 || uint32_t || muPlatform || Platform the bundle was built for || 1 = PC/PS4<br>2 = X360<br>3 = PS3 |
|||
|} |
|||
==== Xbox 360 ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x14 || [[#rw::BaseResources|BaseResources]] || || Base class || |
|||
| 0xC || 0x4 || uint32_t || muDebugDataOffset || Bundle debug data offset || ResourceStringTable XML |
|||
|} |
|||
==== PC ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x10 || [[#rw::BaseResources|BaseResources]] || || Base class || |
|||
| 0x10 || 0x4 || uint32_t || muResourceEntriesCount || Number of resources in the bundle || |
|||
|} |
|||
=== rw::BaseResources === |
|||
==== PlayStation 3 ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x18 || [[#rw::BaseResource|BaseResource]][6] || m_baseResources || Per type base resource pointers || |
|||
| 0x14 || 0x4 || uint32_t || muResourceEntriesOffset || Resource entries offset || |
|||
|} |
|||
==== Xbox 360 ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| |
| 0x0 || 0x14 || [[#rw::BaseResource|BaseResource]][5] || m_baseResources || Per type base resource pointers || |
||
|} |
|||
==== PC ==== |
|||
{| class="wikitable" |
|||
! Offset !! Length !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| 0x0 || 0x10 || [[#rw::BaseResource|BaseResource]][4] || m_baseResources || Per type base resource pointers || |
|||
| 0x24 || 0x4 || uint32_t || muFlags || Bundle flags || 1 = IsCompressed<br>2 = IsMainMenOptimised<br>4 = IsGraphicsMemOptimised<br>8 = ContainsDebugData |
|||
|} |
|} |
||
= Typedefs = |
|||
=== Substructures === |
|||
=== rw::BaseResource === |
|||
{| class="wikitable" |
{| class="wikitable" |
||
! Name !! Type !! Length !! Comments |
|||
|- |
|- |
||
| BaseResource || void* || 0x4 || |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|} |
|||
= Enumerations = |
|||
=== Platform === |
|||
Three constants used by the platform field. |
|||
{| class="wikitable" |
|||
! Name !! Value !! Comments |
|||
|- |
|- |
||
| KU_BUNDLE_DX9 || 1 || PC |
|||
| 0x0 || 0x8 || ID || mResourceId || Resource name CRC32 || Hashed names are all lowercase |
|||
|- |
|- |
||
| KU_BUNDLE_X360 || 2 || Xbox 360 |
|||
| 0x8 || 0x8 || uint64_t || muImportHash || Dependency name(s) CRC32(s) || Multiple are combined with a bitwise OR |
|||
|- |
|- |
||
| KU_BUNDLE_PS3 || 3 || PlayStation 3 |
|||
| 0x10 || 0xC || uint32_t[3] || mauUncompressedSizeAndAlignment || Resource sizes (uncompressed) for each chunk || Has high nibble for alignment; changes between platforms<br>1 << [nibble] equals the memory alignment value |
|||
|} |
|||
=== CgsResource::EFlags === |
|||
{| class="wikitable" |
|||
! Name !! Value !! Comments |
|||
|- |
|- |
||
| E_BUNDLEFLAG_HAS_DEBUG_DATA || 0x0 || Has a BundleImports resource.<br>This flag does not work correctly. |
|||
| 0x1C || 0xC || uint32_t[3] || mauSizeAndAlignmentOnDisk || Resource sizes (compressed) for each chunk || See above |
|||
|- |
|- |
||
| E_BUNDLEFLAG_COMPRESSED || 0x1 || Resources are zlib compressed |
|||
| 0x28 || 0xC || uint32_t[3] || mauDiskOffset || Resource offsets for each chunk || |
|||
|} |
|||
= Base resource types = |
|||
Anonymous enumeration with name strings. |
|||
==== PlayStation 3 ==== |
|||
{| class="wikitable" |
|||
! Name !! String !! Index |
|||
|- |
|- |
||
| BASERESOURCE_MAINMEMORY || main memory || 0 |
|||
| 0x34 || 0x4 || uint32_t || muImportOffset || Bundle imports offset || |
|||
|- |
|- |
||
| BASERESOURCE_DISPOSABLE || disposable || 1 |
|||
| 0x38 || 0x4 || uint32_t || muResourceTypeId || Resource type || See [[Resource Types (Burnout Paradise)|Resource Types]] |
|||
|- |
|- |
||
| BASERESOURCE_UNINITIALIZED || uninitialized || 2 |
|||
| 0x3C || 0x2 || uint16_t || muImportCount || Number of imports || |
|||
|- |
|- |
||
| BASERESOURCE_DISPOSABLE_UNINITIALIZED || disposable uninitialized || 3 |
|||
| 0x3E || 0x1 || uint8_t || muFlags || || |
|||
|- |
|- |
||
| BASERESOURCE_GRAPHICS_SYSTEM || graphics system || 4 |
|||
| 0x3F || 0x1 || uint8_t || muStreamIndex || || |
|||
|- |
|||
| BASERESOURCE_GRAPHICS_LOCAL || graphics local || 5 |
|||
|- |
|||
| BASERESOURCE_NUMBEROFBASERESOURCETYPES || || 6 |
|||
|} |
|} |
||
==== |
==== Xbox 360 ==== |
||
{| class="wikitable" |
{| class="wikitable" |
||
! Name !! String !! Index |
|||
|- |
|||
| BASERESOURCE_MAINMEMORY || main memory || 0 |
|||
|- |
|||
| BASERESOURCE_DISPOSABLE || disposable || 1 |
|||
|- |
|||
| BASERESOURCE_PHYSICAL? || physical || 2 |
|||
|- |
|||
| BASERESOURCE_UNINITIALIZED || uninitialized || 3 |
|||
|- |
|||
| BASERESOURCE_DISPOSABLE_UNINITIALIZED || disposable uninitialized || 4 |
|||
|- |
|||
| BASERESOURCE_NUMBEROFBASERESOURCETYPES || || 5 |
|||
|} |
|||
==== PC ==== |
|||
{| class="wikitable" |
|||
! Name !! String !! Index |
|||
|- |
|||
| BASERESOURCE_MAINMEMORY || main memory || 0 |
|||
|- |
|- |
||
| BASERESOURCE_DISPOSABLE || disposable || 1 |
|||
! Offset !! Size !! Type !! Name !! Description !! Comments |
|||
|- |
|- |
||
| BASERESOURCE_UNINITIALIZED || uninitialized || 2 |
|||
| 0x0 || 0x8 || ID || mResourceId || Resource name CRC32 || ImportEntries are appended to the end of resources. |
|||
|- |
|- |
||
| BASERESOURCE_DISPOSABLE_UNINITIALIZED || disposable uninitialized || 3 |
|||
| 0x8 || 0x4 || uint32_t || muOffset || || |
|||
|- |
|- |
||
| BASERESOURCE_NUMBEROFBASERESOURCETYPES || || 4 |
|||
| 0xC || 0x4 || || || padding || |
|||
|} |
|} |
Latest revision as of 07:07, 13 April 2024
The Bundle container is the core file format used in development builds of Burnout 5/Paradise, Black (Xbox 360), and Black 2 (Xbox 360). It is not used in any retail titles. Each Bundle holds one or more resources (assets) and contains information about each resource, such as its size, type, compression, alignment, and so on.
The Bundle format underwent at least five iterations during its use from early 2006 to early-mid 2007. At present, only files using Bundle version 3, 4, and 5 have been discovered. It was succeeded by the Bundle 2 container.
Memory types
Separate data chunks are used to define what memory type resources are loaded into. These chunks are platform specific (see base resource types). Keep these in mind when viewing the structures.
Resources always have data in Main Memory. If the resource is split, headers are loaded into Main Memory, while the other portion is typically loaded into into Graphics Local on PS3 and Physical on Xbox 360. In resource documentation, these will be simplified to a "secondary" type. Resources only ever have primary and secondary portions. On PS3, some resources' secondary portion may be loaded into Graphics System; in that case, it will be listed separately.
Structures
CgsResource::Bundle
PlayStation 3
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x4 | uint32_t | muMagicNumber | Bundle magic | bndl |
0x4 | 0x4 | uint32_t | muVersion | Bundle version | 3 in base, 4 in V4, 5 in V5 |
0x8 | 0x4 | uint32_t | muNumResources | Number of resources in the bundle | |
0xC | 0x30 | ResourceDescriptor[6] | mBundleResourceDescriptor | Size and alignment of each chunk | |
0x3C | 0x18 | Resource[6] | mAllocatedResource | Memory address of each chunk | Set at runtime |
0x54 | 0x4 | uint32_t | mHashTableOffset | Resource IDs offset | List of resource IDs |
0x58 | 0x4 | uint32_t | mResourceEntriesOffset | Resource entries offset | See ResourceEntry |
0x5C | 0x4 | uint32_t | mImportTablesOffset | Imports offset | See ImportTable |
0x60 | 0x4 | uint32_t | mResourceDataOffset | Resource data offset | |
0x64 | 0x4 | uint32_t | muPlatform | Platform the bundle was built for | See Platform |
Xbox 360
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x4 | uint32_t | muMagicNumber | Bundle magic | bndl |
0x4 | 0x4 | uint32_t | muVersion | Bundle version | 3 in base, 4 in V4, 5 in V5 |
0x8 | 0x4 | uint32_t | muNumResources | Number of resources in the bundle | |
0xC | 0x28 | ResourceDescriptor[5] | mBundleResourceDescriptor | Size and alignment of each chunk | |
0x34 | 0x14 | Resource[5] | mAllocatedResource | Memory address of each chunk | Set at runtime |
0x48 | 0x4 | uint32_t | mHashTableOffset | Resource IDs offset | List of resource IDs |
0x4C | 0x4 | uint32_t | mResourceEntriesOffset | Resource entries offset | See ResourceEntry |
0x50 | 0x4 | uint32_t | mImportTablesOffset | Imports offset | See ImportTable |
0x54 | 0x4 | uint32_t | mResourceDataOffset | Resource data offset | |
0x58 | 0x4 | uint32_t | muPlatform | Platform the bundle was built for | See Platform |
PC
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x4 | uint32_t | muMagicNumber | Bundle magic | bndl |
0x4 | 0x4 | uint32_t | muVersion | Bundle version | 3 in base, 4 in V4, 5 in V5 |
0x8 | 0x4 | uint32_t | muNumResources | Number of resources in the bundle | |
0xC | 0x20 | ResourceDescriptor[4] | mBundleResourceDescriptor | Size and alignment of each chunk | |
0x2C | 0x10 | Resource[4] | mAllocatedResource | Memory address of each chunk | Set at runtime |
0x3C | 0x4 | uint32_t | mHashTableOffset | Resource IDs offset | List of resource IDs |
0x40 | 0x4 | uint32_t | mResourceEntriesOffset | Resource entries offset | See ResourceEntry |
0x44 | 0x4 | uint32_t | mImportTablesOffset | Imports offset | See ImportTable |
0x48 | 0x4 | uint32_t | mResourceDataOffset | Resource data offset | |
0x4C | 0x4 | uint32_t | muPlatform | Platform the bundle was built for | See Platform |
CgsResource::BundleV4ExtendedData
PlayStation 3
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x68 | CgsResource::BaseBundleExtendedData | Base class | See Bundle | |
0x68 | 0x4 | uint32_t | muFlags | Bundle flags | See Flags |
0x6C | 0x4 | uint32_t | muUncompressedDescriptorCount | Number of compressed resources | |
0x70 | 0x4 | ResourceDescriptor* | mpUncompressedResourceDescriptors | Compression information offset |
Xbox 360
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x5C | CgsResource::BaseBundleExtendedData | Base class | See Bundle | |
0x5C | 0x4 | uint32_t | muFlags | Bundle flags | See Flags |
0x60 | 0x4 | uint32_t | muUncompressedDescriptorCount | Number of compressed resources | |
0x64 | 0x4 | ResourceDescriptor* | mpUncompressedResourceDescriptors | Compression information offset |
PC
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x50 | CgsResource::BaseBundleExtendedData | Base class | See Bundle | |
0x50 | 0x4 | uint32_t | muFlags | Bundle flags | See Flags |
0x5C | 0x4 | uint32_t | muUncompressedDescriptorCount | Number of compressed resources | |
0x60 | 0x4 | ResourceDescriptor* | mpUncompressedResourceDescriptors | Compression information offset |
CgsResource::BundleV5ExtendedData
PlayStation 3
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x74 | BundleV4ExtendedData | Base class | ||
0x74 | 0x4 | int32_t | miMainMemAlignment | ||
0x78 | 0x4 | int32_t | miGraphicsMemAlignment |
Xbox 360
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x68 | BundleV4ExtendedData | Base class | ||
0x68 | 0x4 | int32_t | miMainMemAlignment | ||
0x6C | 0x4 | int32_t | miGraphicsMemAlignment |
PC
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x5C | BundleV4ExtendedData | Base class | ||
0x5C | 0x4 | int32_t | miMainMemAlignment | ||
0x60 | 0x4 | int32_t | miGraphicsMemAlignment |
CgsResource::Bundle::ResourceEntry
PlayStation 3
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x4 | void* | mpResource | Resource data memory address | Set at runtime |
0x4 | 0x4 | ImportTable* | mpImportTable | Bundle imports offset | |
0x8 | 0x4 | CgsResource::Type* | mpType | Resource type | Type ID replaced by pointer at runtime. See Resource Types |
0xC | 0x30 | ResourceDescriptor[6] | mSerialisedResourceDescriptor | Resource sizes in bundle Compressed size if compression used |
|
0x3C | 0x30 | ResourceDescriptor[6] | mSerialisedOffsetResourceDescriptor | Offsets in bundle | Alignment is unused (always 1) |
0x6C | 0x18 | Resource[6] | mSerialisedResource | Memory addresses | Set at runtime |
Xbox 360
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x4 | void* | mpResource | Resource data memory address | Set at runtime |
0x4 | 0x4 | ImportTable* | mpImportTable | Bundle imports offset | |
0x8 | 0x4 | CgsResource::Type* | mpType | Resource type | Type ID replaced by pointer at runtime. See Resource Types |
0xC | 0x28 | ResourceDescriptor[5] | mSerialisedResourceDescriptor | Resource sizes in bundle Compressed size if compression used |
|
0x34 | 0x28 | ResourceDescriptor[5] | mSerialisedOffsetResourceDescriptor | Offsets in bundle | Alignment is unused (always 1) |
0x5C | 0x14 | Resource[5] | mSerialisedResource | Memory addresses | Set at runtime |
PC
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x4 | void* | mpResource | Resource data memory address | Set at runtime |
0x4 | 0x4 | ImportTable* | mpImportTable | Bundle imports offset | |
0x8 | 0x4 | CgsResource::Type* | mpType | Resource type | Type ID replaced by pointer at runtime. See Resource Types |
0xC | 0x20 | ResourceDescriptor[4] | mSerialisedResourceDescriptor | Resource sizes in bundle Compressed size if compression used |
|
0x2C | 0x20 | ResourceDescriptor[4] | mSerialisedOffsetResourceDescriptor | Offsets in bundle | Alignment is unused (always 1) |
0x4C | 0x10 | Resource[4] | mSerialisedResource | Memory addresses | Set at runtime |
CgsResource::Bundle::ImportTable
This structure is followed by an ImportEntry array.
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x4 | uint32_t | muNumImports | Number of import entries | |
0x8 | 0x4 | uint32_t | pad1 | Padding |
CgsResource::Bundle::ImportEntry
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x8 | ID | mImportID | Resource name CRC32 | |
0x8 | 0x4 | RwUInt32 | muOffset | ||
0xC | 0x4 | Padding |
rw::ResourceDescriptor
PlayStation 3
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x30 | BaseResourceDescriptors | Base class |
Xbox 360
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x28 | BaseResourceDescriptors | Base class |
PC
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x20 | BaseResourceDescriptors | Base class |
rw::BaseResourceDescriptors
PlayStation 3
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x30 | BaseResourceDescriptor[6] | m_baseResourceDescriptors |
Xbox 360
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x28 | BaseResourceDescriptor[5] | m_baseResourceDescriptors |
PC
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x20 | BaseResourceDescriptor[4] | m_baseResourceDescriptors |
rw::BaseResourceDescriptor
This structure contains fields for size and alignment, though alignment sometimes goes unused.
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x4 | uint32_t | m_size | Size or offset | |
0x4 | 0x4 | uint32_t | m_alignment | Alignment |
rw::Resource
PlayStation 3
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x18 | BaseResources | Base class |
Xbox 360
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x14 | BaseResources | Base class |
PC
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x10 | BaseResources | Base class |
rw::BaseResources
PlayStation 3
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x18 | BaseResource[6] | m_baseResources | Per type base resource pointers |
Xbox 360
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x14 | BaseResource[5] | m_baseResources | Per type base resource pointers |
PC
Offset | Length | Type | Name | Description | Comments |
---|---|---|---|---|---|
0x0 | 0x10 | BaseResource[4] | m_baseResources | Per type base resource pointers |
Typedefs
rw::BaseResource
Name | Type | Length | Comments |
---|---|---|---|
BaseResource | void* | 0x4 |
Enumerations
Platform
Three constants used by the platform field.
Name | Value | Comments |
---|---|---|
KU_BUNDLE_DX9 | 1 | PC |
KU_BUNDLE_X360 | 2 | Xbox 360 |
KU_BUNDLE_PS3 | 3 | PlayStation 3 |
CgsResource::EFlags
Name | Value | Comments |
---|---|---|
E_BUNDLEFLAG_HAS_DEBUG_DATA | 0x0 | Has a BundleImports resource. This flag does not work correctly. |
E_BUNDLEFLAG_COMPRESSED | 0x1 | Resources are zlib compressed |
Base resource types
Anonymous enumeration with name strings.
PlayStation 3
Name | String | Index |
---|---|---|
BASERESOURCE_MAINMEMORY | main memory | 0 |
BASERESOURCE_DISPOSABLE | disposable | 1 |
BASERESOURCE_UNINITIALIZED | uninitialized | 2 |
BASERESOURCE_DISPOSABLE_UNINITIALIZED | disposable uninitialized | 3 |
BASERESOURCE_GRAPHICS_SYSTEM | graphics system | 4 |
BASERESOURCE_GRAPHICS_LOCAL | graphics local | 5 |
BASERESOURCE_NUMBEROFBASERESOURCETYPES | 6 |
Xbox 360
Name | String | Index |
---|---|---|
BASERESOURCE_MAINMEMORY | main memory | 0 |
BASERESOURCE_DISPOSABLE | disposable | 1 |
BASERESOURCE_PHYSICAL? | physical | 2 |
BASERESOURCE_UNINITIALIZED | uninitialized | 3 |
BASERESOURCE_DISPOSABLE_UNINITIALIZED | disposable uninitialized | 4 |
BASERESOURCE_NUMBEROFBASERESOURCETYPES | 5 |
PC
Name | String | Index |
---|---|---|
BASERESOURCE_MAINMEMORY | main memory | 0 |
BASERESOURCE_DISPOSABLE | disposable | 1 |
BASERESOURCE_UNINITIALIZED | uninitialized | 2 |
BASERESOURCE_DISPOSABLE_UNINITIALIZED | disposable uninitialized | 3 |
BASERESOURCE_NUMBEROFBASERESOURCETYPES | 4 |