Embedding sprite data

[KungPhoo]

I created sprite data with spritemate.com and exported it as a spd Spritepad file.
Then I tried to embed it, but it seems the memory at 0x2800 is all zero.
What I did was:

// make space until 0x2000 for code and data
#pragma region( lower, 0x0a00, 0x2000, , , {code, data} )

// then space for custom charset - copy bitmap bits here to display them
#pragma section( charset, 0)
#pragma region( charset, 0x2000, 0x2800, , , {charset} )

// then space for sprites - see below
#pragma section( sprites, 0)
#pragma region( sprites, 0x2800, 0x3fff, , , {sprites} ) // room for 96 sprites


// everything beyond will be code, data, bss and heap to the end
#pragma region( main, 0x4000, 0xa000, , , {code, data, bss, heap, stack} )

// place the bytes
#pragma data(charset)
static char charset[2048];

#pragma data(sprites)
byte spriteBytes[0x1800 /*0x4000 - 0x2800*/] = {
    #embed spd_sprites "./sprites/mysprites.spd"
};

#pragma data(data)

and the spd file goes

000000  53 50 44 01 07 00 0d 08 06 00 00 00 7c 00 00 7c 00 00 7c 00 00 7c 00 00 7c 00 00 7c 00 00 00 00 00 00  SPD.........|..|..|..|..|..|......
000022  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ..................................
000044  00 00 00 00 12 1e 00 00 7c 00 00 82 00 00 aa 00 00 82 00 00 ba 00 00 82 00 00 7c 00 00 00 00 00 00 00  ........|.....ª.....º.....|.......
000066  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ..................................
000088  00 00 00 00 3c 00 00 3c 00 00 3c 00 00 3c 00 00 3c 00 00 18 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ....<..<..<..<..<.................
0000aa  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 17 0e 00 00  ..................................
0000cc  3c 00 00 42 00 00 56 00 00 42 00 00 24 00 00 24 00 00 18 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  <..B..V..B..$..$..................
0000ee  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0e 00 00 7e 00 00 7e  ..............................~..~
000110  00 00 7e 00 00 7e 00 00 7e 00 00 7e 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ..~..~..~..~......................
000132  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 15 0e 00 00 71 00 00 91 00 00 81 00  ..........................q..‘....
000154  00 a9 00 00 a9 00 00 81 00 00 7e 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  .©..©.....~.......................
000176  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 18 00 00 3c 00 00 3c 00 00 3c 00 00  .........................<..<..<..
000198  3c 00 00 3c 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  <..<..............................
0001ba  00 00 00 00 00 00 00 00 00 00 00 00 00 00 14 40 00 00 30 00 00 38 00 00 24 00 00 22 00 00 56 00 00 42  [email protected]..$.."..V..B
0001dc  00 00 42 00 00 3c 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ..B..<............................
0001fe  00 00 00 00 00 00 00 00 00 00 00 00 00 01 00                                                           ...............                   

[drmortalwombat]

The compiler/linker does only include data/code that is actually used or referenced. So your spriteBytes will only end up in the .prg if the variable spriteBytes is used somewhere. The alternative is to force the linker to include it with the __export keyword: __export const byte spriteBytes[] = {

[drmortalwombat]

The upper address of a region is exclusive, so it should be:
#pragma region( sprites, 0x2800, 0x4000, , , {sprites} ) // room for 96 sprites

[KungPhoo]

Excellent! Now I can see my sprite data in the memory of the C64. I think it's a bit off (like 12 bytes or so?) I have to further investigate.

[drmortalwombat]

Oscar works with SpritePad version 5 files, your file appears to be version 1 which has a smaller header.

[KungPhoo]

I tried to fix it, but my sprite memory lacks the first 2 bytes. I can't find, where you acutally read the sprite data into memory. All searches to fread did not relate to the file loading. I wanted the sprite bytes (which I managed to correctly read into mMemData and starting with 00 00 00 7c) at 0x2800. But when I run and debug, the memory at 0x2800 goes 00 7c.
Here's my change to preprocessor.cpp. Unfortunately, my editor always re-formats C++ code, so I don't want to fork it.

#pragma pack(push, 1)
// 1.8   2.0  5.0         SPD file format information
// -     SPD  SPD         3 bytes "SPD"
// -     01   04          version number of spritepad (1 = 2.0)
// -     -    byte        flags
// -     byte word        number of sprites
// -     byte word        number of animations
// -     -    byte        number of sprite animations
// -     -    byte        number of tile animations
// -     -    byte        tile width
// -     -    byte        tile height
// byte  byte byte        color transparent
// byte  byte byte        color multicolor 1
// byte  byte byte        color multicolor 2
// list of [
// [63]  [63] [63]        63 bytes of sprite data
// byte  byte byte        color byte. Bits: 0-3 color, 4 overlay, 7 multicolor/singlecolor
//         ]
// -     [4]  -      bytes xx = "00", "00", "01", "00" added at the end of file (SpritePad animation info)

struct SPDHeader {
    uint8   mID[3];
    uint8   mVersion[1]; // 1=2.0 5=5.0
};
struct SPDHeader2 {
    uint16  mNumSprites; // minus one
    uint8   mColors[3];
};
struct SPDHeader5 {
    uint8   mFlags;
    uint16  mNumSprites, mNumTiles;
    uint8   mNumSpriteAnmis, mNumTileAnims;
    uint8   mTileWidth, mTileHeight;
    uint8   mColors[3];
    int16   mSpriteOverlayDist, mTileOverlayDist;
};

#pragma pack(pop)

void SourceFile::ReadSpritePad(SourceFileDecoder decoder) {
    uint16 numSprites=0;
    SPDHeader   spdHeader;
    fread(&spdHeader, sizeof(SPDHeader), 1, mFile);

    if(spdHeader.mID[0] != 'S' || spdHeader.mID[1] != 'P' || spdHeader.mID[2] != 'D') {
        // might be 1.8
        spdHeader.mVersion[0] = 0;
        fseek(mFile, 0, SEEK_END);
        size_t filelen = ftell(mFile);
        fseek(mFile, 3, SEEK_SET);
        numSprites = uint16(filelen / 64);
        if(filelen != numSprites*64 + 3) {
            printf("!! Invalid SPD file header");
            // mErrors->Error(mLocation, EERR_UNIMPLEMENTED, "Invalid SPD file header");
        }
    }

    switch(spdHeader.mVersion[0]) {
    case 5: {
        SPDHeader5 spdHeader5;
        fread(&spdHeader5, sizeof(SPDHeader5), 1, mFile);
        numSprites=spdHeader5.mNumSprites;
        break;
    }
    case 1: {
        SPDHeader2 spdHeader2;
        fread(&spdHeader2, sizeof(SPDHeader2), 1, mFile);
        numSprites=spdHeader2.mNumSprites;
        break;
    }
    case 0: {
        break;
    }
    default:
        printf("!! SPD file format not recognized\n");
        // mErrors->Error(mLocation, EERR_UNIMPLEMENTED, "SPD file format not recognized");
    }


    if (decoder == SFD_SPD_SPRITES) {
        // mLimit = 64 * numSprites;

        // Read the sprite bytes to mMemData
        mMemSize = 64 * numSprites;
        mLimit = mMemSize;
        mMemPos = 0;
        mMemData = new uint8[mMemSize];
        fread(mMemData, 64, numSprites, mFile);

        return;
    }

    mLimit = 0;
}

[drmortalwombat]

I integrated your sprite pad version 1 parsing code with the latest checkin. I have no file to test with - so it is untested.

[KungPhoo]

It works very well. Thank you. BTW: The Spritepad version 2.0 writes the version byte 01, and the Spritepad 1.8 does not write the SPR header at all. It just starts with 3 colours and then the bytes. But hey, I can use spritemate.com now :)