Skip to content

Commit b1db6dd

Browse files
committed
docs: refine manifest terminology and technical notes
1 parent b98c0e5 commit b1db6dd

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,18 +63,22 @@ The manifest text file must be in the following format:
6363
```
6464
chunk,type,file,null_trailing,xa_file_number,xa_channel_number,xa_null_subheader
6565
```
66-
| Field | Value | Information |
66+
| Field | Value | Description |
6767
|-------------------|------------------|-------------------------------------------------------------------------------------------------|
68-
|`chunk` |`1`-`<stride>` |Sector chunk size to write between strides. Cannot be higher than the `<stride>` command. |
69-
|`type` |`xa` `xacd` `null`|`xa` for 2336 sector file. `xacd` for 2352 sector file. `null` for empty sectors. |
70-
|`file` |`my file.xa` |File name or path. Can be a relative or absolute path, but without "quotes". (omitted for `null`)|
68+
|`chunk` |`1`-`[stride]` |Number of sectors per chunk within a stride. Cannot exceed the `[stride]` command value. |
69+
|`type` |`xa` `xacd` `null`|`xa` for 2336-sector file. `xacd` for 2352-sector file. `null` for empty sectors. |
70+
|`file` |`my file.xa` |File name or path without quotation marks (can be relative or absolute). Omitted for `null`. |
7171
|`null_trailing` |`0` or more |***OPTIONAL*** number of trailing null sectors after the end of the file. Defaults to `0`. |
7272
|`xa_file_number` |`0`-`255` |***OPTIONAL*** subheader file number identifier. Defaults to `file` original value (RAW copy). |
7373
|`xa_channel_number`|`0`-`254` |***OPTIONAL*** subheader channel number identifier. Defaults to `file` original value (RAW copy).|
7474
|`xa_null_subheader`|`0xFFFFFFFF` |***OPTIONAL*** subheader value for `null_trailing` sectors. Defaults to 0x`xa_file_number`000000.|
7575

7676
>[!NOTE]
77-
>The deinterleaver's `sector_beg-end` and `stride` fields are purely informative and do not affect interleaving.
77+
>Deinterleaver's `.csv` fields, `sector_beg-end` and `stride`, are purely informative and do not affect interleaving.
78+
>
79+
>Typical `chunk` value is 1 for audio and 7 for video streams.
80+
>
81+
>Typical `null_trailing` value is 15 or more to account for CD-ROM command latency and prevent drive overread.
7882
><details>
7983
><summary>Example.csv manifest for Megaman X6 BGM.XA:</summary>
8084
>

0 commit comments

Comments
 (0)