Cool_Tools/vgmstream
1
0
Fork 0
mirror of https://github.com/vgmstream/vgmstream.git synced 2024-11-24 06:50:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rename TXTH subsong_offset to subsong_spacing for clarity

Browse Source 
Also add loop_start/end aliases for easier typing
This commit is contained in:
bnnm 2020-11-09 17:35:38 +01:00
parent 6e82819aa9
commit abb8d3fa1d
2 changed files with 37 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/TXTH.md
View File

@ -49,7 +49,7 @@ The following can be used in place of `(value)` for `(key) = (value)` commands.
* `$1|2|3|4`: value has size of 8/16/24/32 bit (optional, defaults to 4)
* Example: `@0x10:BE$2` means `get big endian 16b value at 0x10`
- `(field)`: uses current value of some fields. Accepted strings:
- `interleave, interleave_last, channels, sample_rate, start_offset, data_size, num_samples, loop_start_sample, loop_end_sample, subsong_count, subsong_offset, subfile_offset, subfile_size, base_offset, name_valueX`
- `interleave, interleave_last, channels, sample_rate, start_offset, data_size, num_samples, loop_start_sample, loop_end_sample, subsong_count, subsong_spacing, subfile_offset, subfile_size, base_offset, name_valueX`
- `(other)`: other special values for certain keys, described per key
@ -256,8 +256,12 @@ sample_type = samples|bytes|blocks
```
#### SAMPLE VALUES [REQUIRED (num_samples)]
Those tell vgmstream how long the song is. Define loop points for the track to repeat at those points (if plugin is configured to loop).
You can use `loop_start` and `loop_end` instead as aliases of `loop_start_sample` and `loop_end_sample` (no difference).
Special values:
- `data_size`: automatically converts bytes-to-samples
- `data_size`: automatically converts bytes-to-samples (a few codecs don't allow this)
```
num_samples = (value)|data_size
loop_start_sample = (value)
@ -347,12 +351,14 @@ body_file = (filename)|*.(extension)|null
```
#### SUBSONGS
Sets the number of subsongs in the file, adjusting reads per subsong N: `value = @(offset) + subsong_offset*N`. number/constants values aren't adjusted though.
Sets the number of subsongs in the file, adjusting reads per subsong N: `value = @(offset) + subsong_spacing*N`. Number/constants values aren't adjusted though.
Instead of `subsong_spacing` you can use `subsong_offset` (older alias).
Mainly for bigfiles with consecutive headers per subsong, set subsong_offset to 0 when done as it affects any reads. The current subsong number is handled externally by plugins or TXTP.
```
subsong_count = (value)
subsong_offset = (value)
subsong_spacing = (value)
```
#### NAMES
@ -360,7 +366,7 @@ Sets the name of the stream, most useful when used with subsongs. TXTH will read
`name_size` defaults to 0, which reads until null-terminator or a non-ascii character is found.
`name_offset` can be a (number) value, but being an offset it's also adjusted by subsong_offset.
`name_offset` can be a (number) value, but being an offset it's also adjusted by `subsong_spacing`.
```
name_offset = (value)
name_size = (value)
@ -513,7 +519,7 @@ Note that DSP coefs are special in that aren't read immediately, and will use *l
Values may need to be reset (to 0 or other sensible value) when done. Subsong example:
```
subsong_count = 5
subsong_offset = 0x20 # there are 5 subsong headers, 0x20 each
subsong_spacing = 0x20 # there are 5 subsong headers, 0x20 each
channel_count = @0x10 # reads channels at 0x10+0x20*subsong
# 1st subsong: 0x10+0x20*0: 0x10
# 2nd subsong: 0x10+0x20*1: 0x30
@ -521,7 +527,7 @@ channel_count = @0x10 # reads channels at 0x10+0x20*subsong
# ...
start_offset = @0x14 # reads offset within data at 0x14+0x20*subsong
subsong_offset = 0 # reset value
subsong_spacing = 0 # reset value
sample_rate = 0x04 # sample rate is the same for all subsongs
# Nth subsong ch: 0x04+0x00*N: 0x08
```
@ -784,7 +790,7 @@ channels = 2
# subsong headers at 0x1A5A40, entry size 0x14, total 58 * 0x14 = 0x488
subsong_count = 58
subsong_offset = 0x14
subsong_spacing = 0x14
base_offset = 0x1A5A40
sample_rate = @0x00
@ -854,7 +860,7 @@ header_file = GM1.IDX
body_file = GM1.STZ
subsong_count = 394 #last doesn't have size though
subsong_offset = 0x04
subsong_spacing = 0x04
subfile_offset = (@0x00 & 0xFFFFF) * 0x800
subfile_extension = seb
@ -968,12 +974,12 @@ body_file = ALL_AUDIO.sfx
# read stream header using table3
subsong_count = @0x114
base_offset = @0x110
subsong_offset = 0xc8
subsong_spacing = 0xc8
name_offset = 0x00
#0xc0: file number
base_offset = @0xc4 #absolute jump
subsong_offset = 0 #stop offsetting for next vals
subsong_spacing = 0 #stop offsetting for next vals
channels = @0xC0
sample_rate = @0xC4
@ -983,7 +989,7 @@ num_samples = data_size
# read stream offset using table4
base_offset = 0 #reset current jump
base_offset = @0x118
subsong_offset = 0xc8
subsong_spacing = 0xc8
start_offset = @0xc4 + 0xc0
```
@ -1005,12 +1011,12 @@ body_file = EnglishStreamData.stm
# read stream header using table1
subsong_count = @0x104
base_offset = @0x100
subsong_offset = 0xc8
subsong_spacing = 0xc8
name_offset = 0x00
#0xc0: file number
base_offset = @0xc4 #absolute jump
subsong_offset = 0 #stop offsetting for next vals
subsong_spacing = 0 #stop offsetting for next vals
channels = @0xC0
sample_rate = @0xC4
@ -1020,7 +1026,7 @@ num_samples = data_size
# read stream offset using table1
base_offset = 0 #reset current jump
base_offset = @0x108
subsong_offset = 0xc8
subsong_spacing = 0xc8
start_offset = @0xc4 + 0xc0
```

29
src/meta/txth.c
View File

@ -95,7 +95,7 @@ typedef struct {
int target_subsong;
uint32_t subsong_count;
uint32_t subsong_offset;
uint32_t subsong_spacing;
uint32_t name_offset_set;
uint32_t name_offset;
@ -1017,7 +1017,7 @@ static int parse_keyval(STREAMFILE* sf_, txth_header* txth, const char * key, ch
txth->num_samples = get_bytes_to_samples(txth, txth->num_samples * (txth->interleave*txth->channels));
}
}
else if (is_string(key,"loop_start_sample")) {
else if (is_string(key,"loop_start_sample") || is_string(key,"loop_start")) {
if (!parse_num(txth->sf_head,txth,val, &txth->loop_start_sample)) goto fail;
if (txth->sample_type==1)
txth->loop_start_sample = get_bytes_to_samples(txth, txth->loop_start_sample);
@ -1026,7 +1026,7 @@ static int parse_keyval(STREAMFILE* sf_, txth_header* txth, const char * key, ch
if (txth->loop_adjust)
txth->loop_start_sample += txth->loop_adjust;
}
else if (is_string(key,"loop_end_sample")) {
else if (is_string(key,"loop_end_sample") || is_string(key,"loop_end")) {
if (is_string(val,"data_size")) {
txth->loop_end_sample = get_bytes_to_samples(txth, txth->data_size);
}
@ -1098,8 +1098,8 @@ static int parse_keyval(STREAMFILE* sf_, txth_header* txth, const char * key, ch
if (!parse_num(txth->sf_head,txth,val, &txth->coef_offset)) goto fail;
/* special adjustments */
txth->coef_offset += txth->base_offset;
if (txth->subsong_offset)
txth->coef_offset += txth->subsong_offset * (txth->target_subsong - 1);
if (txth->subsong_spacing)
txth->coef_offset += txth->subsong_spacing * (txth->target_subsong - 1);
}
else if (is_string(key,"coef_spacing")) {
if (!parse_num(txth->sf_head,txth,val, &txth->coef_spacing)) goto fail;
@ -1125,8 +1125,8 @@ static int parse_keyval(STREAMFILE* sf_, txth_header* txth, const char * key, ch
txth->hist_set = 1;
/* special adjustment */
txth->hist_offset += txth->hist_offset;
if (txth->subsong_offset)
txth->hist_offset += txth->subsong_offset * (txth->target_subsong - 1);
if (txth->subsong_spacing)
txth->hist_offset += txth->subsong_spacing * (txth->target_subsong - 1);
}
else if (is_string(key,"hist_spacing")) {
if (!parse_num(txth->sf_head,txth,val, &txth->hist_spacing)) goto fail;
@ -1143,16 +1143,16 @@ static int parse_keyval(STREAMFILE* sf_, txth_header* txth, const char * key, ch
else if (is_string(key,"subsong_count")) {
if (!parse_num(txth->sf_head,txth,val, &txth->subsong_count)) goto fail;
}
else if (is_string(key,"subsong_offset")) {
if (!parse_num(txth->sf_head,txth,val, &txth->subsong_offset)) goto fail;
else if (is_string(key,"subsong_spacing") || is_string(key,"subsong_offset")) {
if (!parse_num(txth->sf_head,txth,val, &txth->subsong_spacing)) goto fail;
}
else if (is_string(key,"name_offset")) {
if (!parse_num(txth->sf_head,txth,val, &txth->name_offset)) goto fail;
txth->name_offset_set = 1;
/* special adjustment */
txth->name_offset += txth->base_offset;
if (txth->subsong_offset)
txth->name_offset += txth->subsong_offset * (txth->target_subsong - 1);
if (txth->subsong_spacing)
txth->name_offset += txth->subsong_spacing * (txth->target_subsong - 1);
}
else if (is_string(key,"name_size")) {
if (!parse_num(txth->sf_head,txth,val, &txth->name_size)) goto fail;
@ -1561,7 +1561,7 @@ static int parse_num(STREAMFILE* sf, txth_header* txth, const char * val, uint32
uint32_t value_div = txth->value_div;
uint32_t value_add = txth->value_add;
uint32_t value_sub = txth->value_sub;
uint32_t subsong_offset = txth->subsong_offset;
uint32_t subsong_offset = txth->subsong_spacing;
char op = ' ';
int brackets = 0;
@ -1654,9 +1654,12 @@ static int parse_num(STREAMFILE* sf, txth_header* txth, const char * val, uint32
else if ((n = is_string_field(val,"data_size"))) value = txth->data_size;
else if ((n = is_string_field(val,"num_samples"))) value = txth->num_samples;
else if ((n = is_string_field(val,"loop_start_sample"))) value = txth->loop_start_sample;
else if ((n = is_string_field(val,"loop_start"))) value = txth->loop_start_sample;
else if ((n = is_string_field(val,"loop_end_sample"))) value = txth->loop_end_sample;
else if ((n = is_string_field(val,"loop_end"))) value = txth->loop_end_sample;
else if ((n = is_string_field(val,"subsong_count"))) value = txth->subsong_count;
else if ((n = is_string_field(val,"subsong_offset"))) value = txth->subsong_offset;
else if ((n = is_string_field(val,"subsong_offset"))) value = txth->subsong_spacing;
else if ((n = is_string_field(val,"subsong_spacing"))) value = txth->subsong_spacing;
else if ((n = is_string_field(val,"subfile_offset"))) value = txth->subfile_offset;
else if ((n = is_string_field(val,"subfile_size"))) value = txth->subfile_size;
else if ((n = is_string_field(val,"base_offset"))) value = txth->base_offset;