SHBIN

From 3dbrew
Revision as of 18:50, 26 February 2014 by Plutooo (talk | contribs) (→‎Encoding)
Jump to navigation Jump to search

Overview

The SHBIN (SHader BINary) file is used to contain compiled and linked shader programs. These can include vertex shaders (typically compiled from .vsh files) and geometry shaders (typically compiled from .gsh files, though .asm have been observed). In commercial games/apps, SHBIN files can be found as standalone files with the extension .shbin, or contained within .bcsdr files. BCSDR files use CGFX as a container, but the underlying DVLB/DVLP/DVLE structure remains unchanged.

A SHBIN's structure starts with a header, then a DVLP, then DVLE(s).

DVLB Header

Offset Size Description
0x0 0x4 Magic "DVLB"
0x4 0x4 N = number of DVLEs in SHBIN
0x8 0x4*N DVLE offset table; each offset is a u32 relative to the start of the DVLB section

The DVLP file comes directly after the header.

DVLP

Offset Size Description
0x0 0x4 Magic "DVLP"
0x4 0x4 ? (Maybe a version number?)
0x8 0x4 Offset (relative to DVLP start) to the compiled shader binary blob
0xC 0x4 Size of compiled shader binary blob, in words
0x10 0x4 Offset (relative to DVLP start) to shader instruction extension table
0x14 0x4 Number of shader instruction extension table entries (each entry is 8-byte long)
0x18 0x4 Offset (relative to DVLP start) to filename symbol table

Instructions

Encoding

Name Description Encoding
DT3 Dot product vec3*vec3 0000 01DD DDDD ??AA AAAA BBBB BBXX XXXX
DT4 Dot product vec4*vec4 0000 10DD DDDD ??AA AAAA BBBB BBXX XXXX
MOV Move register 0010 01DD DDDD ??AA AAAA 0000 00XX XXXX
CALL Call subroutine 1001 R??? 10SS SSSS SSSS SSLL LLLL LLLL
JMP Jump 1001 1110 ??SS SSSS SSSS SS00 0000 0000
JMPB (?) Jump to block (?) 1001 110? ??SS SSSS SSSS SSLL LLLL LLLL
IF???/REP??? Jump to IF/REP-block (?) 1010 00?? ??SS SSSS SSSS SSLL LLLL LLLL
END Ends a block (?) 0b10000100000000000000000000000000

Fields

Name Description
D dest register
A opA register
B opB register
X extension id
S absolute offset for code (in words)
L number of instructions to execute
R R=0 means S is relative, R=1 means S is absolute.

DVLE

Offset Size Description
0x0 0x4 Magic "DVLE"
0x6 0x1 Shader type (0x0 = vertex shader, 0x1 = geometry shader; might contain other flags)
0x8 0x4 Program's main offset in binary blob (in words)
0xC 0x4 Program's endmain offset in binary blob (in words)
0x18 0x4 Offset (relative to DVLE start) to unk1 table
0x1C 0x4 Number of entries in unk1 table (each entry is 0x14-byte long)
0x20 0x4 Offset (relative to DVLE start) to label table
0x24 0x4 Number of entries in label table (each entry is 0x10-byte long)
0x28 0x4 Offset (relative to DVLE start) to unk2 table
0x2C 0x4 Number of entries in unk2 table (each entry is 0x8-byte long)
0x30 0x4 Offset (relative to DVLE start) to variable (?) table
0x34 0x4 Number of entries in variable table (each entry is 0x8-byte long)
0x38 0x4 Offset (relative to DVLE start) to symbol table
0x3C 0x4 Size of symbol table (in bytes)

Label table entry :

Offset Size Description
0x0 0x1 Label ID
0x4 0x4 Offset (relative to shader program blob start) to label's location, in words
0x8 0x4 ?
0xC 0x4 Offset (relative to DVLE symbol table start) to label's symbol

Variable table entry :

Offset Size Description
0x0 0x4 Offset (relative to DVLE symbol table start) to variable's symbol
0x4 0x2 Variable start register
0x6 0x2 Variable end register

Each DVLE is associated to an individual shader shader program contained in the binary blob. A single shader binary blob may contain multiple shader programs of the same kind.

The data contained in unk1 table is sent over to the GPU.