0 Members and 3 Guests are viewing this topic.
//all packets must be long word alignedpacket 0: requiredword: identifier 0x0000word: SDK versionlong: Walnut identifier "wnut"long: file offset to mainlong: checksum of entire file excluding thislong: size of entire filelong: size of mainchar: null terminated program namechar: null terminated description//end of packet 0packet 1: start-up infoword: identifier 0x0001word: execution mode (0x0000: from flash in virtual memory, 0x0001: from ram in virtual memory, 0x0002: from flash in the p1 sector, 0x0003: from ram in the p1 sector, 0x0004: from flash in the p2 sector, 0x0005: from ram in the p2 sector)long: requested origin (should be set to 0xffffffff in most cases for the default origin based off the previous mode choice)long: value to be written to the FRQCR 0xffffffff for don't modify//end of packet 1packet 2: author infoword: identifier 0x0002word: blank for alignmentlong: author's 4 initial identifier eg "z80m"char: null terminated author namechar: author logo compression mode (0x00: no image, 0x01: monochrome, 0x02: 8 color, 0x03: 256 color using Walnut's palatte, 0x04: 256 color with included palatte, 0x05: 16 bit bitmap, 0x06: 16 bit dxt)image data: all author icons are 16x16 pixelschar: null terminated author name//end of packet 2packet 3: program iconword: identifier 0x0003word: heightword: widthchar: icon compression mode (0x00: no image, 0x01: monochrome, 0x02: 8 color, 0x03: 256 color using Walnut's palatte, 0x04: 256 color with included palatte, 0x05: 16 bit bitmap, 0x06: 16 bit dxt)image data://end of packet 3
Based on what you've written in this post as well as the reply to Kerm's post on Cemetech, it seems like you're losing quite a bit of the flexibility that Qwerty.55's format was going to have. You have identifiers for which shell the program is for, and even what version of the SDK it was made with... These don't really have a purpose, unless you plan to treat programs that are for different shells/made with different versions of the SDK in separate ways. This is bad, because then old versions of shells won't be able to read those new files!On the 8x calcs, programs from old shells work in new shells, but not vice-versa. Sometimes someone might want to use an older shell because they like it better, but they won't be able to do that. If we design this format in a good way, we might be able to avoid that problem completely on the Prizm. Programs should be made for all Prizm shells - not a specific shell on the Prizm. The format that Qwerty.55 suggested allowed new shells to add new features in files by adding new packages, while still allowing the files to work correctly with older shells, unless the packet was "critical", as indicated by a list.There are also a few things with the packets that you currently have that I would like to be changed. (It's a good idea to split your packets a bit so that you don't have everything in one packet!)1. Unlike Qwerty.55's format, the size of the packets don't seem to be stored anywhere. How is the shell supposed to know where they end in cases where the size of the packet isn't obvious?2. Like I said before, I don't see the point in storing the SDK version and the program's shell.3. The description of the program shouldn't be in the critical packet, because it's not necessary to include a description for every program.4. The checksum should also be optional. Don't place it in the critical packet.5. It's better to indicate main() by giving it a packet ID. "file offset to main" shouldn't be necessary.6. Does "size of main" have a purpose?7. Why do we need to include the first four characters of the author's name?8. Please don't require programmers to include an author icon if they don't include an author name. The icon should be a separate packet.9. Why is the author's name stored twice, once before the icon and once after?
1. Thinking about it now, to allow for newer programs to run on older shells the size of a packet should be the second word included that way Walnut can skip past unfamiliar packets. Otherwise Walnut was going to rely on knowing the size of the packet based off the SDK version but that can now be fixed.
2. The SDK version number allows for Walnut to know which version of the packet layout is being used. Having an SDK version number higher than the shell number shouldn't prevent a program from running but may cause some errors in displaying data. The way each packet is arranged shouldn't change once Walnut is released so that is why I want to get all the issues out now by making this public.
Also for the "wnut" that is just an identifier that the shell uses so it knows that the file was designed for Walnut and uses the Walnut packet layout. It is just like how java .class files start with 0xcafebabe as an identifier.
3. That can be moved easily to another packet but even if the developer doesn't want to include a description that field will only take 1 byte if blank. The description is like a subtext that can be displayed with the title.
4. The reason for the checksum being there was that if there was a binary error in the header or executable then there is a possibility that the calculator could crash or even brick. For example if the FRQCR field was corrupted Don't forget that the SDK will calculate that on it's own when a project is built similar to what mkg3a already does.
5. A packet for main is also doable. The reason for having the offset was so that it could be quickly located and wouldn't have to be searched for.6. Size of main just means the size of the executable. This is very important as it affects what Walnut will write to the MMU when the program begins.
7. The first 4 letters could also be more like their initials. This data will never be displayed to the user but is so that Walnut has the ability to organize programs by author if the user wishes to do so.
8. They don't have to include an icon. By setting the icon compression mode to 0 it means that there is no image and Walnut will not expect one.
So if future shells want to have backwards compatibility with Walnut, would they need to include the wnut string? Wouldn't it be better to use something that doesn't refer to the name of this shell?
4: The file generator will take care of the details. The problem with the G3A CRC is that we don't know the generator polynomial. z80man's checksum doesn't require that, I believe.
7: What if the author's name is "Adolph Blaine Charles David Earl Frederick Gerald Hubert Irvin John Kenneth Lloyd Martin Nero Oliver Paul Quincy Randolph Sherman Thomas Uncas Victor William Xerxes Yancy Wolfeschlegelsteinhausenbergerdorffwelchevoralternwarengewissenschaftschafe rswessenschafewarenwohlgepflegeundsorgfaltigkeitbeschutzenvonangreifeudurch ihrraubgierigfeindewelchevoralternzwolftausendjahresvorandieerscheinenersch einenvanderersteerdemenschderraumschiffgebrauchlichtalsseinursprungvonkraft gestartseinlangefahrthinzwischensternaitigraumaufdersuchenachdiesternwelche gehabtbewohnbarplanetenkreisedrehensichundwohinderneurassevonverstandigmens chlichkeitkonntefortpflanzenundsicherfeuenanlebenslanglichfreudeundruhemitn icheinfurchtvorangreifenvonandererintelligentgeschopfsvonhinzwischenternart Zeus igraum Senior?" Fixed length names are smaller and infinitely easier to parse.(real name)
How do you know where the name ends, though? If the length isn't fixed, you have to either trawl through the entire name to find the next packet or store the size of the name in the packet.
It'd also take up a lot more space than is necessary, since the user would only ever see the first four letters if they're the only things read. It's much better just to set a hard limit of 4 characters than to allow arbitrary length and deal with potential buffer overflows.
Author
Topic: gxp file format (Read 11720 times)
