sidinfo: sidlib.h annotate

annotate sidlib.h @ 72:d5a34a3a602d

Add C++ include guards.

author	Matti Hamalainen <ccr@tnsp.org>
date	Fri, 01 Jan 2016 03:39:50 +0200
parents	4779bbec2f28
children	2b2376f1b0cc

rev	line source
70 4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	1 /*
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	2 * SIDInfoLib - Way too simplistic PSID/RSID file library
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	3 * Written by Matti 'ccr' Hämäläinen <ccr@tnsp.org>
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	4 * (C) Copyright 2014-2015 Tecnic Software productions (TNSP)
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	5 */
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	6 #ifndef SIDLIB_H
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	7 #define SIDLIB_H 1
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	8
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	9 #include "th_util.h"
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	10 #include "th_crypto.h"
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	11
72 d5a34a3a602d Add C++ include guards. Matti Hamalainen <ccr@tnsp.org> parents: 70 diff changeset	12 #ifdef __cplusplus
d5a34a3a602d Add C++ include guards. Matti Hamalainen <ccr@tnsp.org> parents: 70 diff changeset	13 extern "C" {
d5a34a3a602d Add C++ include guards. Matti Hamalainen <ccr@tnsp.org> parents: 70 diff changeset	14 #endif
d5a34a3a602d Add C++ include guards. Matti Hamalainen <ccr@tnsp.org> parents: 70 diff changeset	15
70 4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	16
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	17 // Some constants
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	18 #define PSID_MAGIC_LEN 4
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	19 #define PSID_STR_LEN 32
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	20 #define PSID_BUFFER_SIZE (1024 * 16)
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	21
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	22
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	23 typedef struct
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	24 {
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	25 char magic[PSID_MAGIC_LEN + 1]; // "PSID" / "RSID" magic identifier
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	26 uint16_t
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	27 version, // Version number
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	28 dataOffset, // Start of actual c64 data in file
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	29 loadAddress, // Loading address
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	30 initAddress, // Initialization address
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	31 playAddress, // Play one frame
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	32 nSongs, // Number of subsongs
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	33 startSong; // Default starting song
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	34 uint32_t speed; // Speed
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	35 char sidName[PSID_STR_LEN + 1]; // Descriptive text-fields, ASCIIZ
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	36 char sidAuthor[PSID_STR_LEN + 1];
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	37 char sidCopyright[PSID_STR_LEN + 1];
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	38
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	39 // PSIDv2 data
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	40 uint16_t flags; // Flags
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	41 uint8_t startPage, pageLength;
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	42 uint16_t reserved;
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	43
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	44 // Extra data
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	45 BOOL isRSID;
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	46 size_t dataSize; // Total size of data - header
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	47 th_md5hash_t hash; // Songlength database hash
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	48
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	49 } PSIDHeader;
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	50
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	51
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	52 enum
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	53 {
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	54 PSF_PLAYER_TYPE = 0x0001, // 0 = built-in, 1 = Compute! SIDPlayer MUS
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	55 PSF_PLAYSID_TUNE = 0x0002, // 0 = Real C64-compatible, 1 = PlaySID specific (v2NG)
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	56
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	57 PSF_CLOCK_UNKNOWN = 0x0000, // Video standard used (v2NG)
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	58 PSF_CLOCK_PAL = 0x0004,
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	59 PSF_CLOCK_NTSC = 0x0008,
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	60 PSF_CLOCK_ANY = 0x000c,
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	61 PSF_CLOCK_MASK = 0x000c,
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	62
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	63 PSF_MODEL_UNKNOWN = 0x0000, // SID model (v2NG)
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	64 PSF_MODEL_MOS6581 = 0x0010,
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	65 PSF_MODEL_MOS8580 = 0x0020,
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	66 PSF_MODEL_ANY = 0x0030,
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	67 PSF_MODEL_MASK = 0x0030,
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	68 };
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	69
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	70 int siReadPSIDFile(FILE inFile, PSIDHeader psid);
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	71 const char *siGetSIDClockStr(const int flags);
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	72 const char *siGetSIDModelStr(const int flags);
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	73
4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	74
72 d5a34a3a602d Add C++ include guards. Matti Hamalainen <ccr@tnsp.org> parents: 70 diff changeset	75 #ifdef __cplusplus
d5a34a3a602d Add C++ include guards. Matti Hamalainen <ccr@tnsp.org> parents: 70 diff changeset	76 }
d5a34a3a602d Add C++ include guards. Matti Hamalainen <ccr@tnsp.org> parents: 70 diff changeset	77 #endif
70 4779bbec2f28 Split some functionality into sidlib.[ch]. Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	78 #endif // SIDLIB_H

Mercurial > hg > sidinfo

annotate sidlib.h @ 72:d5a34a3a602d