1 /*************************************************************************** 2 3 chd.h 4 5 MAME Compressed Hunks of Data file format 6 7 **************************************************************************** 8 9 Copyright Aaron Giles 10 All rights reserved. 11 12 Redistribution and use in source and binary forms, with or without 13 modification, are permitted provided that the following conditions are 14 met: 15 16 * Redistributions of source code must retain the above copyright 17 notice, this list of conditions and the following disclaimer. 18 * Redistributions in binary form must reproduce the above copyright 19 notice, this list of conditions and the following disclaimer in 20 the documentation and/or other materials provided with the 21 distribution. 22 * Neither the name 'MAME' nor the names of its contributors may be 23 used to endorse or promote products derived from this software 24 without specific prior written permission. 25 26 THIS SOFTWARE IS PROVIDED BY AARON GILES ''AS IS'' AND ANY EXPRESS OR 27 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 28 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 29 DISCLAIMED. IN NO EVENT SHALL AARON GILES BE LIABLE FOR ANY DIRECT, 30 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 31 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 32 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 34 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 35 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 POSSIBILITY OF SUCH DAMAGE. 37 38 ***************************************************************************/ 39 40 #pragma once 41 42 #ifndef __CHD_H__ 43 #define __CHD_H__ 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 #include "coretypes.h" 50 #include <streams/file_stream.h> 51 52 /*************************************************************************** 53 54 Compressed Hunks of Data header format. All numbers are stored in 55 Motorola (big-endian) byte ordering. The header is 76 (V1) or 80 (V2) 56 bytes long. 57 58 V1 header: 59 60 [ 0] char tag[8]; // 'MComprHD' 61 [ 8] UINT32 length; // length of header (including tag and length fields) 62 [ 12] UINT32 version; // drive format version 63 [ 16] UINT32 flags; // flags (see below) 64 [ 20] UINT32 compression; // compression type 65 [ 24] UINT32 hunksize; // 512-byte sectors per hunk 66 [ 28] UINT32 totalhunks; // total # of hunks represented 67 [ 32] UINT32 cylinders; // number of cylinders on hard disk 68 [ 36] UINT32 heads; // number of heads on hard disk 69 [ 40] UINT32 sectors; // number of sectors on hard disk 70 [ 44] UINT8 md5[16]; // MD5 checksum of raw data 71 [ 60] UINT8 parentmd5[16]; // MD5 checksum of parent file 72 [ 76] (V1 header length) 73 74 V2 header: 75 76 [ 0] char tag[8]; // 'MComprHD' 77 [ 8] UINT32 length; // length of header (including tag and length fields) 78 [ 12] UINT32 version; // drive format version 79 [ 16] UINT32 flags; // flags (see below) 80 [ 20] UINT32 compression; // compression type 81 [ 24] UINT32 hunksize; // seclen-byte sectors per hunk 82 [ 28] UINT32 totalhunks; // total # of hunks represented 83 [ 32] UINT32 cylinders; // number of cylinders on hard disk 84 [ 36] UINT32 heads; // number of heads on hard disk 85 [ 40] UINT32 sectors; // number of sectors on hard disk 86 [ 44] UINT8 md5[16]; // MD5 checksum of raw data 87 [ 60] UINT8 parentmd5[16]; // MD5 checksum of parent file 88 [ 76] UINT32 seclen; // number of bytes per sector 89 [ 80] (V2 header length) 90 91 V3 header: 92 93 [ 0] char tag[8]; // 'MComprHD' 94 [ 8] UINT32 length; // length of header (including tag and length fields) 95 [ 12] UINT32 version; // drive format version 96 [ 16] UINT32 flags; // flags (see below) 97 [ 20] UINT32 compression; // compression type 98 [ 24] UINT32 totalhunks; // total # of hunks represented 99 [ 28] UINT64 logicalbytes; // logical size of the data (in bytes) 100 [ 36] UINT64 metaoffset; // offset to the first blob of metadata 101 [ 44] UINT8 md5[16]; // MD5 checksum of raw data 102 [ 60] UINT8 parentmd5[16]; // MD5 checksum of parent file 103 [ 76] UINT32 hunkbytes; // number of bytes per hunk 104 [ 80] UINT8 sha1[20]; // SHA1 checksum of raw data 105 [100] UINT8 parentsha1[20];// SHA1 checksum of parent file 106 [120] (V3 header length) 107 108 V4 header: 109 110 [ 0] char tag[8]; // 'MComprHD' 111 [ 8] UINT32 length; // length of header (including tag and length fields) 112 [ 12] UINT32 version; // drive format version 113 [ 16] UINT32 flags; // flags (see below) 114 [ 20] UINT32 compression; // compression type 115 [ 24] UINT32 totalhunks; // total # of hunks represented 116 [ 28] UINT64 logicalbytes; // logical size of the data (in bytes) 117 [ 36] UINT64 metaoffset; // offset to the first blob of metadata 118 [ 44] UINT32 hunkbytes; // number of bytes per hunk 119 [ 48] UINT8 sha1[20]; // combined raw+meta SHA1 120 [ 68] UINT8 parentsha1[20];// combined raw+meta SHA1 of parent 121 [ 88] UINT8 rawsha1[20]; // raw data SHA1 122 [108] (V4 header length) 123 124 Flags: 125 0x00000001 - set if this drive has a parent 126 0x00000002 - set if this drive allows writes 127 128 ========================================================================= 129 130 V5 header: 131 132 [ 0] char tag[8]; // 'MComprHD' 133 [ 8] uint32_t length; // length of header (including tag and length fields) 134 [ 12] uint32_t version; // drive format version 135 [ 16] uint32_t compressors[4];// which custom compressors are used? 136 [ 32] uint64_t logicalbytes; // logical size of the data (in bytes) 137 [ 40] uint64_t mapoffset; // offset to the map 138 [ 48] uint64_t metaoffset; // offset to the first blob of metadata 139 [ 56] uint32_t hunkbytes; // number of bytes per hunk (512k maximum) 140 [ 60] uint32_t unitbytes; // number of bytes per unit within each hunk 141 [ 64] uint8_t rawsha1[20]; // raw data SHA1 142 [ 84] uint8_t sha1[20]; // combined raw+meta SHA1 143 [104] uint8_t parentsha1[20];// combined raw+meta SHA1 of parent 144 [124] (V5 header length) 145 146 If parentsha1 != 0, we have a parent (no need for flags) 147 If compressors[0] == 0, we are uncompressed (including maps) 148 149 V5 uncompressed map format: 150 151 [ 0] uint32_t offset; // starting offset / hunk size 152 153 V5 compressed map format header: 154 155 [ 0] uint32_t length; // length of compressed map 156 [ 4] UINT48 datastart; // offset of first block 157 [ 10] uint16_t crc; // crc-16 of the map 158 [ 12] uint8_t lengthbits; // bits used to encode complength 159 [ 13] uint8_t hunkbits; // bits used to encode self-refs 160 [ 14] uint8_t parentunitbits; // bits used to encode parent unit refs 161 [ 15] uint8_t reserved; // future use 162 [ 16] (compressed header length) 163 164 Each compressed map entry, once expanded, looks like: 165 166 [ 0] uint8_t compression; // compression type 167 [ 1] UINT24 complength; // compressed length 168 [ 4] UINT48 offset; // offset 169 [ 10] uint16_t crc; // crc-16 of the data 170 171 ***************************************************************************/ 172 173 /*************************************************************************** 174 CONSTANTS 175 ***************************************************************************/ 176 177 /* header information */ 178 #define CHD_HEADER_VERSION 5 179 #define CHD_V1_HEADER_SIZE 76 180 #define CHD_V2_HEADER_SIZE 80 181 #define CHD_V3_HEADER_SIZE 120 182 #define CHD_V4_HEADER_SIZE 108 183 #define CHD_V5_HEADER_SIZE 124 184 185 #define CHD_MAX_HEADER_SIZE CHD_V5_HEADER_SIZE 186 187 /* checksumming information */ 188 #define CHD_MD5_BYTES 16 189 #define CHD_SHA1_BYTES 20 190 191 /* CHD global flags */ 192 #define CHDFLAGS_HAS_PARENT 0x00000001 193 #define CHDFLAGS_IS_WRITEABLE 0x00000002 194 #define CHDFLAGS_UNDEFINED 0xfffffffc 195 196 /* compression types */ 197 #define CHDCOMPRESSION_NONE 0 198 #define CHDCOMPRESSION_ZLIB 1 199 #define CHDCOMPRESSION_ZLIB_PLUS 2 200 #define CHDCOMPRESSION_AV 3 201 202 /* A/V codec configuration parameters */ 203 #define AV_CODEC_COMPRESS_CONFIG 1 204 #define AV_CODEC_DECOMPRESS_CONFIG 2 205 206 /* metadata parameters */ 207 #define CHDMETATAG_WILDCARD 0 208 #define CHD_METAINDEX_APPEND ((UINT32)-1) 209 210 /* metadata flags */ 211 #define CHD_MDFLAGS_CHECKSUM 0x01 /* indicates data is checksummed */ 212 213 /* standard hard disk metadata */ 214 #define HARD_DISK_METADATA_TAG 0x47444444 /* 'GDDD' */ 215 #define HARD_DISK_METADATA_FORMAT "CYLS:%d,HEADS:%d,SECS:%d,BPS:%d" 216 217 /* hard disk identify information */ 218 #define HARD_DISK_IDENT_METADATA_TAG 0x49444e54 /* 'IDNT' */ 219 220 /* hard disk key information */ 221 #define HARD_DISK_KEY_METADATA_TAG 0x4b455920 /* 'KEY ' */ 222 223 /* pcmcia CIS information */ 224 #define PCMCIA_CIS_METADATA_TAG 0x43495320 /* 'CIS ' */ 225 226 /* standard CD-ROM metadata */ 227 #define CDROM_OLD_METADATA_TAG 0x43484344 /* 'CHCD' */ 228 #define CDROM_TRACK_METADATA_TAG 0x43485452 /* 'CHTR' */ 229 #define CDROM_TRACK_METADATA_FORMAT "TRACK:%d TYPE:%s SUBTYPE:%s FRAMES:%d" 230 #define CDROM_TRACK_METADATA2_TAG 0x43485432 /* 'CHT2' */ 231 #define CDROM_TRACK_METADATA2_FORMAT "TRACK:%d TYPE:%s SUBTYPE:%s FRAMES:%d PREGAP:%d PGTYPE:%s PGSUB:%s POSTGAP:%d" 232 #define GDROM_TRACK_METADATA_TAG 0x43484744 /* 'CHTD' */ 233 #define GDROM_TRACK_METADATA_FORMAT "TRACK:%d TYPE:%s SUBTYPE:%s FRAMES:%d PAD:%d PREGAP:%d PGTYPE:%s PGSUB:%s POSTGAP:%d" 234 235 /* standard A/V metadata */ 236 #define AV_METADATA_TAG 0x41564156 /* 'AVAV' */ 237 #define AV_METADATA_FORMAT "FPS:%d.%06d WIDTH:%d HEIGHT:%d INTERLACED:%d CHANNELS:%d SAMPLERATE:%d" 238 239 /* A/V laserdisc frame metadata */ 240 #define AV_LD_METADATA_TAG 0x41564C44 /* 'AVLD' */ 241 242 /* CHD open values */ 243 #define CHD_OPEN_READ 1 244 #define CHD_OPEN_READWRITE 2 245 246 /* error types */ 247 enum _chd_error 248 { 249 CHDERR_NONE, 250 CHDERR_NO_INTERFACE, 251 CHDERR_OUT_OF_MEMORY, 252 CHDERR_INVALID_FILE, 253 CHDERR_INVALID_PARAMETER, 254 CHDERR_INVALID_DATA, 255 CHDERR_FILE_NOT_FOUND, 256 CHDERR_REQUIRES_PARENT, 257 CHDERR_FILE_NOT_WRITEABLE, 258 CHDERR_READ_ERROR, 259 CHDERR_WRITE_ERROR, 260 CHDERR_CODEC_ERROR, 261 CHDERR_INVALID_PARENT, 262 CHDERR_HUNK_OUT_OF_RANGE, 263 CHDERR_DECOMPRESSION_ERROR, 264 CHDERR_COMPRESSION_ERROR, 265 CHDERR_CANT_CREATE_FILE, 266 CHDERR_CANT_VERIFY, 267 CHDERR_NOT_SUPPORTED, 268 CHDERR_METADATA_NOT_FOUND, 269 CHDERR_INVALID_METADATA_SIZE, 270 CHDERR_UNSUPPORTED_VERSION, 271 CHDERR_VERIFY_INCOMPLETE, 272 CHDERR_INVALID_METADATA, 273 CHDERR_INVALID_STATE, 274 CHDERR_OPERATION_PENDING, 275 CHDERR_NO_ASYNC_OPERATION, 276 CHDERR_UNSUPPORTED_FORMAT 277 }; 278 typedef enum _chd_error chd_error; 279 280 /*************************************************************************** 281 TYPE DEFINITIONS 282 ***************************************************************************/ 283 284 /* opaque types */ 285 typedef struct _chd_file chd_file; 286 287 /* extract header structure (NOT the on-disk header structure) */ 288 typedef struct _chd_header chd_header; 289 struct _chd_header 290 { 291 UINT32 length; /* length of header data */ 292 UINT32 version; /* drive format version */ 293 UINT32 flags; /* flags field */ 294 UINT32 compression[4]; /* compression type */ 295 UINT32 hunkbytes; /* number of bytes per hunk */ 296 UINT32 totalhunks; /* total # of hunks represented */ 297 UINT64 logicalbytes; /* logical size of the data */ 298 UINT64 metaoffset; /* offset in file of first metadata */ 299 UINT64 mapoffset; /* TOOD V5 */ 300 UINT8 md5[CHD_MD5_BYTES]; /* overall MD5 checksum */ 301 UINT8 parentmd5[CHD_MD5_BYTES]; /* overall MD5 checksum of parent */ 302 UINT8 sha1[CHD_SHA1_BYTES]; /* overall SHA1 checksum */ 303 UINT8 rawsha1[CHD_SHA1_BYTES]; /* SHA1 checksum of raw data */ 304 UINT8 parentsha1[CHD_SHA1_BYTES]; /* overall SHA1 checksum of parent */ 305 UINT32 unitbytes; /* TODO V5 */ 306 UINT64 unitcount; /* TODO V5 */ 307 UINT32 hunkcount; /* TODO V5 */ 308 309 /* map information */ 310 UINT32 mapentrybytes; /* length of each entry in a map (V5) */ 311 UINT8* rawmap; /* raw map data */ 312 313 UINT32 obsolete_cylinders; /* obsolete field -- do not use! */ 314 UINT32 obsolete_sectors; /* obsolete field -- do not use! */ 315 UINT32 obsolete_heads; /* obsolete field -- do not use! */ 316 UINT32 obsolete_hunksize; /* obsolete field -- do not use! */ 317 }; 318 319 /* structure for returning information about a verification pass */ 320 typedef struct _chd_verify_result chd_verify_result; 321 struct _chd_verify_result 322 { 323 UINT8 md5[CHD_MD5_BYTES]; /* overall MD5 checksum */ 324 UINT8 sha1[CHD_SHA1_BYTES]; /* overall SHA1 checksum */ 325 UINT8 rawsha1[CHD_SHA1_BYTES]; /* SHA1 checksum of raw data */ 326 UINT8 metasha1[CHD_SHA1_BYTES]; /* SHA1 checksum of metadata */ 327 }; 328 329 /*************************************************************************** 330 FUNCTION PROTOTYPES 331 ***************************************************************************/ 332 333 /* ----- CHD file management ----- */ 334 335 /* create a new CHD file fitting the given description */ 336 /* chd_error chd_create(const char *filename, UINT64 logicalbytes, UINT32 hunkbytes, UINT32 compression, chd_file *parent); */ 337 338 /* same as chd_create(), but accepts an already-opened core_file object */ 339 /* chd_error chd_create_file(core_file *file, UINT64 logicalbytes, UINT32 hunkbytes, UINT32 compression, chd_file *parent); */ 340 341 /* open an existing CHD file */ 342 chd_error chd_open_file(RFILE *file, int mode, chd_file *parent, chd_file **chd); 343 344 chd_error chd_open(const char *filename, int mode, chd_file *parent, chd_file **chd); 345 346 /* precache underlying file */ 347 chd_error chd_precache(chd_file *chd); 348 349 /* close a CHD file */ 350 void chd_close(chd_file *chd); 351 352 /* return the associated core_file */ 353 RFILE *chd_core_file(chd_file *chd); 354 355 /* return an error string for the given CHD error */ 356 const char *chd_error_string(chd_error err); 357 358 /* ----- CHD header management ----- */ 359 360 /* return a pointer to the extracted CHD header data */ 361 const chd_header *chd_get_header(chd_file *chd); 362 363 /* ----- core data read/write ----- */ 364 365 /* read one hunk from the CHD file */ 366 chd_error chd_read(chd_file *chd, UINT32 hunknum, void *buffer); 367 368 /* ----- metadata management ----- */ 369 370 /* get indexed metadata of a particular sort */ 371 chd_error chd_get_metadata(chd_file *chd, UINT32 searchtag, UINT32 searchindex, void *output, UINT32 outputlen, UINT32 *resultlen, UINT32 *resulttag, UINT8 *resultflags); 372 373 /* ----- codec interfaces ----- */ 374 375 /* set internal codec parameters */ 376 chd_error chd_codec_config(chd_file *chd, int param, void *config); 377 378 /* return a string description of a codec */ 379 const char *chd_get_codec_name(UINT32 codec); 380 381 extern const uint8_t s_cd_sync_header[12]; 382 383 #ifdef __cplusplus 384 } 385 #endif 386 387 #endif /* __CHD_H__ */ 388