1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
|
#include "bigWig.h"
#include "bwCommon.h"
#include <stdlib.h>
#include <math.h>
#include <string.h>
#include <stdio.h>
static uint64_t readChromBlock(bigWigFile_t *bw, chromList_t *cl, uint32_t keySize);
//Return the position in the file
long bwTell(bigWigFile_t *fp) {
if(fp->URL->type == BWG_FILE) return ftell(fp->URL->x.fp);
return (long) (fp->URL->filePos + fp->URL->bufPos);
}
//Seek to a given position, always from the beginning of the file
//Return 0 on success and -1 on error
//To do, use the return code of urlSeek() in a more useful way.
int bwSetPos(bigWigFile_t *fp, size_t pos) {
CURLcode rv = urlSeek(fp->URL, pos);
if(rv == CURLE_OK) return 0;
return -1;
}
//returns the number of full members read (nmemb on success, something less on error)
size_t bwRead(void *data, size_t sz, size_t nmemb, bigWigFile_t *fp) {
size_t i, rv;
for(i=0; i<nmemb; i++) {
rv = urlRead(fp->URL, data+i*sz, sz);
if(rv != sz) return i;
}
return nmemb;
}
//Initializes curl and sets global variables
//Returns 0 on success and 1 on error
//This should be called only once and bwCleanup() must be called when finished.
int bwInit(size_t defaultBufSize) {
//set the buffer size, number of iterations, sleep time between iterations, etc.
GLOBAL_DEFAULTBUFFERSIZE = defaultBufSize;
//call curl_global_init()
#ifndef NOCURL
CURLcode rv;
rv = curl_global_init(CURL_GLOBAL_ALL);
if(rv != CURLE_OK) return 1;
#endif
return 0;
}
//This should be called before quiting, to release memory acquired by curl
void bwCleanup() {
#ifndef NOCURL
curl_global_cleanup();
#endif
}
static bwZoomHdr_t *bwReadZoomHdrs(bigWigFile_t *bw) {
if(bw->isWrite) return NULL;
uint16_t i;
bwZoomHdr_t *zhdr = malloc(sizeof(bwZoomHdr_t));
if(!zhdr) return NULL;
uint32_t *level = malloc(bw->hdr->nLevels * sizeof(uint64_t));
if(!level) {
free(zhdr);
return NULL;
}
uint32_t padding = 0;
uint64_t *dataOffset = malloc(sizeof(uint64_t) * bw->hdr->nLevels);
if(!dataOffset) {
free(zhdr);
free(level);
return NULL;
}
uint64_t *indexOffset = malloc(sizeof(uint64_t) * bw->hdr->nLevels);
if(!indexOffset) {
free(zhdr);
free(level);
free(dataOffset);
return NULL;
}
for(i=0; i<bw->hdr->nLevels; i++) {
if(bwRead((void*) &(level[i]), sizeof(uint32_t), 1, bw) != 1) goto error;
if(bwRead((void*) &padding, sizeof(uint32_t), 1, bw) != 1) goto error;
if(bwRead((void*) &(dataOffset[i]), sizeof(uint64_t), 1, bw) != 1) goto error;
if(bwRead((void*) &(indexOffset[i]), sizeof(uint64_t), 1, bw) != 1) goto error;
}
zhdr->level = level;
zhdr->dataOffset = dataOffset;
zhdr->indexOffset = indexOffset;
zhdr->idx = calloc(bw->hdr->nLevels, sizeof(bwRTree_t*));
if(!zhdr->idx) goto error;
return zhdr;
error:
for(i=0; i<bw->hdr->nLevels; i++) {
if(zhdr->idx[i]) bwDestroyIndex(zhdr->idx[i]);
}
free(zhdr);
free(level);
free(dataOffset);
free(indexOffset);
return NULL;
}
static void bwHdrDestroy(bigWigHdr_t *hdr) {
int i;
if(hdr->zoomHdrs) {
free(hdr->zoomHdrs->level);
free(hdr->zoomHdrs->dataOffset);
free(hdr->zoomHdrs->indexOffset);
for(i=0; i<hdr->nLevels; i++) {
if(hdr->zoomHdrs->idx[i]) bwDestroyIndex(hdr->zoomHdrs->idx[i]);
}
free(hdr->zoomHdrs->idx);
free(hdr->zoomHdrs);
}
free(hdr);
}
static void bwHdrRead(bigWigFile_t *bw) {
uint32_t magic;
if(bw->isWrite) return;
bw->hdr = calloc(1, sizeof(bigWigHdr_t));
if(!bw->hdr) return;
if(bwRead((void*) &magic, sizeof(uint32_t), 1, bw) != 1) goto error; //0x0
if(magic != BIGWIG_MAGIC && magic != BIGBED_MAGIC) goto error;
if(bwRead((void*) &(bw->hdr->version), sizeof(uint16_t), 1, bw) != 1) goto error; //0x4
if(bwRead((void*) &(bw->hdr->nLevels), sizeof(uint16_t), 1, bw) != 1) goto error; //0x6
if(bwRead((void*) &(bw->hdr->ctOffset), sizeof(uint64_t), 1, bw) != 1) goto error; //0x8
if(bwRead((void*) &(bw->hdr->dataOffset), sizeof(uint64_t), 1, bw) != 1) goto error; //0x10
if(bwRead((void*) &(bw->hdr->indexOffset), sizeof(uint64_t), 1, bw) != 1) goto error; //0x18
if(bwRead((void*) &(bw->hdr->fieldCount), sizeof(uint16_t), 1, bw) != 1) goto error; //0x20
if(bwRead((void*) &(bw->hdr->definedFieldCount), sizeof(uint16_t), 1, bw) != 1) goto error; //0x22
if(bwRead((void*) &(bw->hdr->sqlOffset), sizeof(uint64_t), 1, bw) != 1) goto error; //0x24
if(bwRead((void*) &(bw->hdr->summaryOffset), sizeof(uint64_t), 1, bw) != 1) goto error; //0x2c
if(bwRead((void*) &(bw->hdr->bufSize), sizeof(uint32_t), 1, bw) != 1) goto error; //0x34
if(bwRead((void*) &(bw->hdr->extensionOffset), sizeof(uint64_t), 1, bw) != 1) goto error; //0x38
//zoom headers
if(bw->hdr->nLevels) {
if(!(bw->hdr->zoomHdrs = bwReadZoomHdrs(bw))) goto error;
}
//File summary information
if(bw->hdr->summaryOffset) {
if(urlSeek(bw->URL, bw->hdr->summaryOffset) != CURLE_OK) goto error;
if(bwRead((void*) &(bw->hdr->nBasesCovered), sizeof(uint64_t), 1, bw) != 1) goto error;
if(bwRead((void*) &(bw->hdr->minVal), sizeof(uint64_t), 1, bw) != 1) goto error;
if(bwRead((void*) &(bw->hdr->maxVal), sizeof(uint64_t), 1, bw) != 1) goto error;
if(bwRead((void*) &(bw->hdr->sumData), sizeof(uint64_t), 1, bw) != 1) goto error;
if(bwRead((void*) &(bw->hdr->sumSquared), sizeof(uint64_t), 1, bw) != 1) goto error;
}
//In case of uncompressed remote files, let the IO functions know to request larger chunks
bw->URL->isCompressed = (bw->hdr->bufSize > 0)?1:0;
return;
error:
bwHdrDestroy(bw->hdr);
fprintf(stderr, "[bwHdrRead] There was an error while reading in the header!\n");
bw->hdr = NULL;
}
static void destroyChromList(chromList_t *cl) {
uint32_t i;
if(!cl) return;
if(cl->nKeys && cl->chrom) {
for(i=0; i<cl->nKeys; i++) {
if(cl->chrom[i]) free(cl->chrom[i]);
}
}
if(cl->chrom) free(cl->chrom);
if(cl->len) free(cl->len);
free(cl);
}
static uint64_t readChromLeaf(bigWigFile_t *bw, chromList_t *cl, uint32_t valueSize) {
uint16_t nVals, i;
uint32_t idx;
char *chrom = NULL;
if(bwRead((void*) &nVals, sizeof(uint16_t), 1, bw) != 1) return -1;
chrom = calloc(valueSize+1, sizeof(char));
if(!chrom) return -1;
for(i=0; i<nVals; i++) {
if(bwRead((void*) chrom, sizeof(char), valueSize, bw) != valueSize) goto error;
if(bwRead((void*) &idx, sizeof(uint32_t), 1, bw) != 1) goto error;
if(bwRead((void*) &(cl->len[idx]), sizeof(uint32_t), 1, bw) != 1) goto error;
cl->chrom[idx] = strdup(chrom);
if(!(cl->chrom[idx])) goto error;
}
free(chrom);
return nVals;
error:
free(chrom);
return -1;
}
static uint64_t readChromNonLeaf(bigWigFile_t *bw, chromList_t *cl, uint32_t keySize) {
uint64_t offset , rv = 0, previous;
uint16_t nVals, i;
if(bwRead((void*) &nVals, sizeof(uint16_t), 1, bw) != 1) return -1;
previous = bwTell(bw) + keySize;
for(i=0; i<nVals; i++) {
if(bwSetPos(bw, previous)) return -1;
if(bwRead((void*) &offset, sizeof(uint64_t), 1, bw) != 1) return -1;
if(bwSetPos(bw, offset)) return -1;
rv += readChromBlock(bw, cl, keySize);
previous += 8 + keySize;
}
return rv;
}
static uint64_t readChromBlock(bigWigFile_t *bw, chromList_t *cl, uint32_t keySize) {
uint8_t isLeaf, padding;
if(bwRead((void*) &isLeaf, sizeof(uint8_t), 1, bw) != 1) return -1;
if(bwRead((void*) &padding, sizeof(uint8_t), 1, bw) != 1) return -1;
if(isLeaf) {
return readChromLeaf(bw, cl, keySize);
} else { //I've never actually observed one of these, which is good since they're pointless
return readChromNonLeaf(bw, cl, keySize);
}
}
static chromList_t *bwReadChromList(bigWigFile_t *bw) {
chromList_t *cl = NULL;
uint32_t magic, keySize, valueSize, itemsPerBlock;
uint64_t rv, itemCount;
if(bw->isWrite) return NULL;
if(bwSetPos(bw, bw->hdr->ctOffset)) return NULL;
cl = calloc(1, sizeof(chromList_t));
if(!cl) return NULL;
if(bwRead((void*) &magic, sizeof(uint32_t), 1, bw) != 1) goto error;
if(magic != CIRTREE_MAGIC) goto error;
if(bwRead((void*) &itemsPerBlock, sizeof(uint32_t), 1, bw) != 1) goto error;
if(bwRead((void*) &keySize, sizeof(uint32_t), 1, bw) != 1) goto error;
if(bwRead((void*) &valueSize, sizeof(uint32_t), 1, bw) != 1) goto error;
if(bwRead((void*) &itemCount, sizeof(uint64_t), 1, bw) != 1) goto error;
cl->nKeys = itemCount;
cl->chrom = calloc(itemCount, sizeof(char*));
cl->len = calloc(itemCount, sizeof(uint32_t));
if(!cl->chrom) goto error;
if(!cl->len) goto error;
if(bwRead((void*) &magic, sizeof(uint32_t), 1, bw) != 1) goto error;
if(bwRead((void*) &magic, sizeof(uint32_t), 1, bw) != 1) goto error;
//Read in the blocks
rv = readChromBlock(bw, cl, keySize);
if(rv == (uint64_t) -1) goto error;
if(rv != itemCount) goto error;
return cl;
error:
destroyChromList(cl);
return NULL;
}
//This is here mostly for convenience
static void bwDestroyWriteBuffer(bwWriteBuffer_t *wb) {
if(wb->p) free(wb->p);
if(wb->compressP) free(wb->compressP);
if(wb->firstZoomBuffer) free(wb->firstZoomBuffer);
if(wb->lastZoomBuffer) free(wb->lastZoomBuffer);
if(wb->nNodes) free(wb->nNodes);
free(wb);
}
void bwClose(bigWigFile_t *fp) {
if(!fp) return;
if(bwFinalize(fp)) {
fprintf(stderr, "[bwClose] There was an error while finishing writing a bigWig file! The output is likely truncated.\n");
}
if(fp->URL) urlClose(fp->URL);
if(fp->hdr) bwHdrDestroy(fp->hdr);
if(fp->cl) destroyChromList(fp->cl);
if(fp->idx) bwDestroyIndex(fp->idx);
if(fp->writeBuffer) bwDestroyWriteBuffer(fp->writeBuffer);
free(fp);
}
int bwIsBigWig(char *fname, CURLcode (*callBack) (CURL*)) {
uint32_t magic = 0;
URL_t *URL = NULL;
URL = urlOpen(fname, *callBack, NULL);
if(!URL) return 0;
if(urlRead(URL, (void*) &magic, sizeof(uint32_t)) != sizeof(uint32_t)) magic = 0;
urlClose(URL);
if(magic == BIGWIG_MAGIC) return 1;
return 0;
}
char *bbGetSQL(bigWigFile_t *bw) {
char *o = NULL;
uint64_t len;
if(!bw->hdr->sqlOffset) return NULL;
len = bw->hdr->summaryOffset - bw->hdr->sqlOffset; //This includes the NULL terminator
o = malloc(sizeof(char) * len);
if(!o) goto error;
if(bwSetPos(bw, bw->hdr->sqlOffset)) goto error;
if(bwRead((void*) o, len, 1, bw) != 1) goto error;
return o;
error:
if(o) free(o);
printf("Got an error in bbGetSQL!\n");
return NULL;
}
int bbIsBigBed(char *fname, CURLcode (*callBack) (CURL*)) {
uint32_t magic = 0;
URL_t *URL = NULL;
URL = urlOpen(fname, *callBack, NULL);
if(!URL) return 0;
if(urlRead(URL, (void*) &magic, sizeof(uint32_t)) != sizeof(uint32_t)) magic = 0;
urlClose(URL);
if(magic == BIGBED_MAGIC) return 1;
return 0;
}
bigWigFile_t *bwOpen(char *fname, CURLcode (*callBack) (CURL*), const char *mode) {
bigWigFile_t *bwg = calloc(1, sizeof(bigWigFile_t));
if(!bwg) {
fprintf(stderr, "[bwOpen] Couldn't allocate space to create the output object!\n");
return NULL;
}
if((!mode) || (strchr(mode, 'w') == NULL)) {
bwg->isWrite = 0;
bwg->URL = urlOpen(fname, *callBack, NULL);
if(!bwg->URL) {
fprintf(stderr, "[bwOpen] urlOpen is NULL!\n");
goto error;
}
//Attempt to read in the fixed header
bwHdrRead(bwg);
if(!bwg->hdr) {
fprintf(stderr, "[bwOpen] bwg->hdr is NULL!\n");
goto error;
}
//Read in the chromosome list
bwg->cl = bwReadChromList(bwg);
if(!bwg->cl) {
fprintf(stderr, "[bwOpen] bwg->cl is NULL (%s)!\n", fname);
goto error;
}
//Read in the index
if(bwg->hdr->nBasesCovered) {
bwg->idx = bwReadIndex(bwg, 0);
if(!bwg->idx) {
fprintf(stderr, "[bwOpen] bwg->idx is NULL bwg->hdr->dataOffset 0x%"PRIx64"!\n", bwg->hdr->dataOffset);
goto error;
}
}
} else {
bwg->isWrite = 1;
bwg->URL = urlOpen(fname, NULL, "w+");
if(!bwg->URL) goto error;
bwg->writeBuffer = calloc(1,sizeof(bwWriteBuffer_t));
if(!bwg->writeBuffer) goto error;
bwg->writeBuffer->l = 24;
}
return bwg;
error:
bwClose(bwg);
return NULL;
}
bigWigFile_t *bbOpen(char *fname, CURLcode (*callBack) (CURL*)) {
bigWigFile_t *bb = calloc(1, sizeof(bigWigFile_t));
if(!bb) {
fprintf(stderr, "[bbOpen] Couldn't allocate space to create the output object!\n");
return NULL;
}
//Set the type to 1 for bigBed
bb->type = 1;
bb->URL = urlOpen(fname, *callBack, NULL);
if(!bb->URL) goto error;
//Attempt to read in the fixed header
bwHdrRead(bb);
if(!bb->hdr) goto error;
//Read in the chromosome list
bb->cl = bwReadChromList(bb);
if(!bb->cl) goto error;
//Read in the index
bb->idx = bwReadIndex(bb, 0);
if(!bb->idx) goto error;
return bb;
error:
bwClose(bb);
return NULL;
}
|