bam_import.c

   1 #include <zlib.h>
   2 #include <stdio.h>
   3 #include <ctype.h>
   4 #include <string.h>
   5 #include <stdlib.h>
   6 #include <unistd.h>
   7 #include <assert.h>
   8 #include "bam.h"
   9 #include "kseq.h"
  10 #include "khash.h"
  11
  12 KSTREAM_INIT(gzFile, gzread, 8192)
  13 KHASH_MAP_INIT_STR(ref, uint64_t)
  14
  15 void bam_init_header_hash(bam_header_t *header);
  16 void bam_destroy_header_hash(bam_header_t *header);
  17 int32_t bam_get_tid(const bam_header_t *header, const char *seq_name);
  18
  19 unsigned char bam_nt16_table[256] = {
  20         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15,
  21         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15,
  22         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15,
  23          1, 2, 4, 8, 15,15,15,15, 15,15,15,15, 15, 0 /*=*/,15,15,
  24         15, 1,14, 2, 13,15,15, 4, 11,15,15,12, 15, 3,15,15,
  25         15,15, 5, 6,  8,15, 7, 9, 15,10,15,15, 15,15,15,15,
  26         15, 1,14, 2, 13,15,15, 4, 11,15,15,12, 15, 3,15,15,
  27         15,15, 5, 6,  8,15, 7, 9, 15,10,15,15, 15,15,15,15,
  28         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15,
  29         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15,
  30         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15,
  31         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15,
  32         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15,
  33         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15,
  34         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15,
  35         15,15,15,15, 15,15,15,15, 15,15,15,15, 15,15,15,15
  36 };
  37
  38 char *bam_nt16_rev_table = "=ACMGRSVTWYHKDBN";
  39
  40 struct __tamFile_t {
  41         gzFile fp;
  42         kstream_t *ks;
  43         kstring_t *str;
  44         uint64_t n_lines;
  45         int is_first;
  46 };
  47
  48 char **__bam_get_lines(const char *fn, int *_n) // for bam_plcmd.c only
  49 {
  50         char **list = 0, *s;
  51         int n = 0, dret, m = 0;
  52         gzFile fp = (strcmp(fn, "-") == 0)? gzdopen(fileno(stdin), "r") : gzopen(fn, "r");
  53         kstream_t *ks;
  54         kstring_t *str;
  55         str = (kstring_t*)calloc(1, sizeof(kstring_t));
  56         ks = ks_init(fp);
  57         while (ks_getuntil(ks, '\n', str, &dret) > 0) {
  58                 if (n == m) {
  59                         m = m? m << 1 : 16;
  60                         list = (char**)realloc(list, m * sizeof(char*));
  61                 }
  62                 if (str->s[str->l-1] == '\r')
  63                         str->s[--str->l] = '\0';
  64                 s = list[n++] = (char*)calloc(str->l + 1, 1);
  65                 strcpy(s, str->s);
  66         }
  67         ks_destroy(ks);
  68         gzclose(fp);
  69         free(str->s); free(str);
  70         *_n = n;
  71         return list;
  72 }
  73
  74 static bam_header_t *hash2header(const kh_ref_t *hash)
  75 {
  76         bam_header_t *header;
  77         khiter_t k;
  78         header = bam_header_init();
  79         header->n_targets = kh_size(hash);
  80         header->target_name = (char**)calloc(kh_size(hash), sizeof(char*));
  81         header->target_len = (uint32_t*)calloc(kh_size(hash), 4);
  82         for (k = kh_begin(hash); k != kh_end(hash); ++k) {
  83                 if (kh_exist(hash, k)) {
  84                         int i = (int)kh_value(hash, k);
  85                         header->target_name[i] = (char*)kh_key(hash, k);
  86                         header->target_len[i] = kh_value(hash, k)>>32;
  87                 }
  88         }
  89         bam_init_header_hash(header);
  90         return header;
  91 }
  92 bam_header_t *sam_header_read2(const char *fn)
  93 {
  94         bam_header_t *header;
  95         int c, dret, ret;
  96         gzFile fp;
  97         kstream_t *ks;
  98         kstring_t *str;
  99         kh_ref_t *hash;
 100         khiter_t k;
 101         hash = kh_init(ref);
 102         fp = (strcmp(fn, "-") == 0)? gzdopen(fileno(stdin), "r") : gzopen(fn, "r");
 103         assert(fp);
 104         ks = ks_init(fp);
 105         str = (kstring_t*)calloc(1, sizeof(kstring_t));
 106         while (ks_getuntil(ks, 0, str, &dret) > 0) {
 107                 char *s = strdup(str->s);
 108                 int len, i;
 109                 i = kh_size(hash);
 110                 ks_getuntil(ks, 0, str, &dret);
 111                 len = atoi(str->s);
 112                 k = kh_put(ref, hash, s, &ret);
 113                 kh_value(hash, k) = (uint64_t)len<<32 | i;
 114                 if (dret != '\n')
 115                         while ((c = ks_getc(ks)) != '\n' && c != -1);
 116         }
 117         ks_destroy(ks);
 118         gzclose(fp);
 119         free(str->s); free(str);
 120         fprintf(stderr, "[sam_header_read2] %d sequences loaded.\n", kh_size(hash));
 121         header = hash2header(hash);
 122         kh_destroy(ref, hash);
 123         return header;
 124 }
 125 static inline uint8_t *alloc_data(bam1_t *b, int size)
 126 {
 127         if (b->m_data < size) {
 128                 b->m_data = size;
 129                 kroundup32(b->m_data);
 130                 b->data = (uint8_t*)realloc(b->data, b->m_data);
 131         }
 132         return b->data;
 133 }
 134 static inline void parse_error(int64_t n_lines, const char * __restrict msg)
 135 {
 136         fprintf(stderr, "Parse error at line %lld: %s\n", (long long)n_lines, msg);
 137         abort();
 138 }
 139 static inline void append_text(bam_header_t *header, kstring_t *str)
 140 {
 141         int x = header->l_text, y = header->l_text + str->l + 2; // 2 = 1 byte dret + 1 byte null
 142         kroundup32(x); kroundup32(y);
 143         if (x < y) header->text = (char*)realloc(header->text, y);
 144         strncpy(header->text + header->l_text, str->s, str->l+1); // we cannot use strcpy() here.
 145         header->l_text += str->l + 1;
 146         header->text[header->l_text] = 0;
 147 }
 148
 149 int sam_header_parse(bam_header_t *h)
 150 {
 151         int i;
 152         char *s, *p, *q, *r;
 153
 154         // free
 155         free(h->target_len); free(h->target_name);
 156         h->n_targets = 0; h->target_len = 0; h->target_name = 0;
 157         if (h->l_text < 3) return 0;
 158         // count number of @SQ
 159         s = h->text;
 160         while ((s = strstr(s, "@SQ")) != 0) {
 161                 ++h->n_targets;
 162                 s += 3;
 163         }
 164         if (h->n_targets == 0) return 0;
 165         h->target_len = (uint32_t*)calloc(h->n_targets, 4);
 166         h->target_name = (char**)calloc(h->n_targets, sizeof(void*));
 167         // parse @SQ lines
 168         i = 0;
 169         s = h->text;
 170         while ((s = strstr(s, "@SQ")) != 0) {
 171                 s += 3;
 172                 r = s;
 173                 if ((p = strstr(s, "SN:")) != 0) {
 174                         q = p + 3;
 175                         for (p = q; *p && *p != '\t' && *p != '\r' && *p != '\n'; ++p);
 176                         h->target_name[i] = (char*)calloc(p - q + 1, 1);
 177                         strncpy(h->target_name[i], q, p - q);
 178                 } else goto header_err_ret;
 179                 if (r < p) r = p;
 180                 if ((p = strstr(s, "LN:")) != 0) h->target_len[i] = strtol(p + 3, 0, 10);
 181                 else goto header_err_ret;
 182                 if (r < p) r = p;
 183                 s = r + 3;
 184                 ++i;
 185         }
 186         return h->n_targets;
 187
 188 header_err_ret:
 189         fprintf(stderr, "[bam_header_parse] missing SN or LN tag in @SQ lines.\n");
 190         free(h->target_len); free(h->target_name);
 191         h->n_targets = 0; h->target_len = 0; h->target_name = 0;
 192         return 0;
 193 }
 194
 195 bam_header_t *sam_header_read(tamFile fp)
 196 {
 197         int ret, dret;
 198         bam_header_t *header = bam_header_init();
 199         kstring_t *str = fp->str;
 200         while ((ret = ks_getuntil(fp->ks, KS_SEP_TAB, str, &dret)) >= 0 && str->s[0] == '@') { // skip header
 201                 str->s[str->l] = dret; // note that str->s is NOT null terminated!!
 202                 append_text(header, str);
 203                 if (dret != '\n') {
 204                         ret = ks_getuntil(fp->ks, '\n', str, &dret);
 205                         str->s[str->l] = '\n'; // NOT null terminated!!
 206                         append_text(header, str);
 207                 }
 208                 ++fp->n_lines;
 209         }
 210         sam_header_parse(header);
 211         bam_init_header_hash(header);
 212         fp->is_first = 1;
 213         return header;
 214 }
 215
 216 int sam_read1(tamFile fp, bam_header_t *header, bam1_t *b)
 217 {
 218         int ret, doff, doff0, dret, z = 0;
 219         bam1_core_t *c = &b->core;
 220         kstring_t *str = fp->str;
 221         kstream_t *ks = fp->ks;
 222
 223         if (fp->is_first) {
 224                 fp->is_first = 0;
 225                 ret = str->l;
 226         } else {
 227                 do { // special consideration for empty lines
 228                         ret = ks_getuntil(fp->ks, KS_SEP_TAB, str, &dret);
 229                         if (ret >= 0) z += str->l + 1;
 230                 } while (ret == 0);
 231         }
 232         if (ret < 0) return -1;
 233         ++fp->n_lines;
 234         doff = 0;
 235
 236         { // name
 237                 c->l_qname = strlen(str->s) + 1;
 238                 memcpy(alloc_data(b, doff + c->l_qname) + doff, str->s, c->l_qname);
 239                 doff += c->l_qname;
 240         }
 241         { // flag, tid, pos, qual
 242                 ret = ks_getuntil(ks, KS_SEP_TAB, str, &dret); z += str->l + 1; c->flag = atoi(str->s);
 243                 ret = ks_getuntil(ks, KS_SEP_TAB, str, &dret); z += str->l + 1; c->tid = bam_get_tid(header, str->s);
 244                 if (c->tid < 0 && strcmp(str->s, "*"))
 245                         fprintf(stderr, "[sam_read1] reference '%s' is recognized as '*'.\n", str->s);
 246                 ret = ks_getuntil(ks, KS_SEP_TAB, str, &dret); z += str->l + 1; c->pos = isdigit(str->s[0])? atoi(str->s) - 1 : -1;
 247                 ret = ks_getuntil(ks, KS_SEP_TAB, str, &dret); z += str->l + 1; c->qual = isdigit(str->s[0])? atoi(str->s) : 0;
 248                 if (ret < 0) return -2;
 249         }
 250         { // cigar
 251                 char *s, *t;
 252                 int i, op;
 253                 long x;
 254                 c->n_cigar = 0;
 255                 if (ks_getuntil(ks, KS_SEP_TAB, str, &dret) < 0) return -3;
 256                 z += str->l + 1;
 257                 if (str->s[0] != '*') {
 258                         for (s = str->s; *s; ++s) {
 259                                 if (isalpha(*s)) ++c->n_cigar;
 260                                 else if (!isdigit(*s)) parse_error(fp->n_lines, "invalid CIGAR character");
 261                         }
 262                         b->data = alloc_data(b, doff + c->n_cigar * 4);
 263                         for (i = 0, s = str->s; i != c->n_cigar; ++i) {
 264                                 x = strtol(s, &t, 10);
 265                                 op = toupper(*t);
 266                                 if (op == 'M') op = BAM_CMATCH;
 267                                 else if (op == 'I') op = BAM_CINS;
 268                                 else if (op == 'D') op = BAM_CDEL;
 269                                 else if (op == 'N') op = BAM_CREF_SKIP;
 270                                 else if (op == 'S') op = BAM_CSOFT_CLIP;
 271                                 else if (op == 'H') op = BAM_CHARD_CLIP;
 272                                 else if (op == 'P') op = BAM_CPAD;
 273                                 else parse_error(fp->n_lines, "invalid CIGAR operation");
 274                                 s = t + 1;
 275                                 bam1_cigar(b)[i] = x << BAM_CIGAR_SHIFT | op;
 276                         }
 277                         if (*s) parse_error(fp->n_lines, "unmatched CIGAR operation");
 278                         c->bin = bam_reg2bin(c->pos, bam_calend(c, bam1_cigar(b)));
 279                         doff += c->n_cigar * 4;
 280                 } else c->bin = bam_reg2bin(c->pos, c->pos + 1);
 281         }
 282         { // mtid, mpos, isize
 283                 ret = ks_getuntil(ks, KS_SEP_TAB, str, &dret); z += str->l + 1;
 284                 c->mtid = strcmp(str->s, "=")? bam_get_tid(header, str->s) : c->tid;
 285                 ret = ks_getuntil(ks, KS_SEP_TAB, str, &dret); z += str->l + 1;
 286                 c->mpos = isdigit(str->s[0])? atoi(str->s) - 1 : -1;
 287                 ret = ks_getuntil(ks, KS_SEP_TAB, str, &dret); z += str->l + 1;
 288                 c->isize = (str->s[0] == '-' || isdigit(str->s[0]))? atoi(str->s) : 0;
 289                 if (ret < 0) return -4;
 290         }
 291         { // seq and qual
 292                 int i;
 293                 uint8_t *p;
 294                 if (ks_getuntil(ks, KS_SEP_TAB, str, &dret) < 0) return -5; // seq
 295                 z += str->l + 1;
 296                 c->l_qseq = strlen(str->s);
 297                 if (c->n_cigar && c->l_qseq != (int32_t)bam_cigar2qlen(c, bam1_cigar(b)))
 298                         parse_error(fp->n_lines, "CIGAR and sequence length are inconsistent");
 299                 p = (uint8_t*)alloc_data(b, doff + c->l_qseq + (c->l_qseq+1)/2) + doff;
 300                 bzero(p, (c->l_qseq+1)/2);
 301                 for (i = 0; i < c->l_qseq; ++i)
 302                         p[i/2] |= bam_nt16_table[(int)str->s[i]] << 4*(1-i%2);
 303                 if (ks_getuntil(ks, KS_SEP_TAB, str, &dret) < 0) return -6; // qual
 304                 z += str->l + 1;
 305                 if (strcmp(str->s, "*") && c->l_qseq != strlen(str->s))
 306                         parse_error(fp->n_lines, "sequence and quality are inconsistent");
 307                 p += (c->l_qseq+1)/2;
 308                 if (strcmp(str->s, "*") == 0) for (i = 0; i < c->l_qseq; ++i) p[i] = 0xff;
 309                 else for (i = 0; i < c->l_qseq; ++i) p[i] = str->s[i] - 33;
 310                 doff += c->l_qseq + (c->l_qseq+1)/2;
 311         }
 312         doff0 = doff;
 313         if (dret != '\n' && dret != '\r') { // aux
 314                 while (ks_getuntil(ks, KS_SEP_TAB, str, &dret) >= 0) {
 315                         uint8_t *s, type, key[2];
 316                         z += str->l + 1;
 317                         if (str->l < 6 || str->s[2] != ':' || str->s[4] != ':')
 318                                 parse_error(fp->n_lines, "missing colon in auxiliary data");
 319                         key[0] = str->s[0]; key[1] = str->s[1];
 320                         type = str->s[3];
 321                         s = alloc_data(b, doff + 3) + doff;
 322                         s[0] = key[0]; s[1] = key[1]; s += 2; doff += 2;
 323                         if (type == 'A' || type == 'a' || type == 'c' || type == 'C') { // c and C for backward compatibility
 324                                 s = alloc_data(b, doff + 2) + doff;
 325                                 *s++ = 'A'; *s = str->s[5];
 326                                 doff += 2;
 327                         } else if (type == 'I' || type == 'i') {
 328                                 long long x;
 329                                 s = alloc_data(b, doff + 5) + doff;
 330                                 x = (long long)atoll(str->s + 5);
 331                                 if (x < 0) {
 332                                         if (x >= -127) {
 333                                                 *s++ = 'c'; *(int8_t*)s = (int8_t)x;
 334                                                 s += 1; doff += 2;
 335                                         } else if (x >= -32767) {
 336                                                 *s++ = 's'; *(int16_t*)s = (int16_t)x;
 337                                                 s += 2; doff += 3;
 338                                         } else {
 339                                                 *s++ = 'i'; *(int32_t*)s = (int32_t)x;
 340                                                 s += 4; doff += 5;
 341                                                 if (x < -2147483648ll)
 342                                                         fprintf(stderr, "Parse warning at line %lld: integer %lld is out of range.",
 343                                                                         (long long)fp->n_lines, x);
 344                                         }
 345                                 } else {
 346                                         if (x <= 255) {
 347                                                 *s++ = 'C'; *s++ = (uint8_t)x;
 348                                                 doff += 2;
 349                                         } else if (x <= 65535) {
 350                                                 *s++ = 'S'; *(uint16_t*)s = (uint16_t)x;
 351                                                 s += 2; doff += 3;
 352                                         } else {
 353                                                 *s++ = 'I'; *(uint32_t*)s = (uint32_t)x;
 354                                                 s += 4; doff += 5;
 355                                                 if (x > 4294967295ll)
 356                                                         fprintf(stderr, "Parse warning at line %lld: integer %lld is out of range.",
 357                                                                         (long long)fp->n_lines, x);
 358                                         }
 359                                 }
 360                         } else if (type == 'f') {
 361                                 s = alloc_data(b, doff + 5) + doff;
 362                                 *s++ = 'f';
 363                                 *(float*)s = (float)atof(str->s + 5);
 364                                 s += 4; doff += 5;
 365                         } else if (type == 'd') {
 366                                 s = alloc_data(b, doff + 9) + doff;
 367                                 *s++ = 'd';
 368                                 *(float*)s = (float)atof(str->s + 9);
 369                                 s += 8; doff += 9;
 370                         } else if (type == 'Z' || type == 'H') {
 371                                 int size = 1 + (str->l - 5) + 1;
 372                                 if (type == 'H') { // check whether the hex string is valid
 373                                         int i;
 374                                         if ((str->l - 5) % 2 == 1) parse_error(fp->n_lines, "length of the hex string not even");
 375                                         for (i = 0; i < str->l - 5; ++i) {
 376                                                 int c = toupper(str->s[5 + i]);
 377                                                 if (!((c >= '0' && c <= '9') || (c >= 'A' && c <= 'F')))
 378                                                         parse_error(fp->n_lines, "invalid hex character");
 379                                         }
 380                                 }
 381                                 s = alloc_data(b, doff + size) + doff;
 382                                 *s++ = type;
 383                                 memcpy(s, str->s + 5, str->l - 5);
 384                                 s[str->l - 5] = 0;
 385                                 doff += size;
 386                         } else parse_error(fp->n_lines, "unrecognized type");
 387                         if (dret == '\n' || dret == '\r') break;
 388                 }
 389         }
 390         b->l_aux = doff - doff0;
 391         b->data_len = doff;
 392         return z;
 393 }
 394
 395 tamFile sam_open(const char *fn)
 396 {
 397         tamFile fp;
 398         fp = (tamFile)calloc(1, sizeof(struct __tamFile_t));
 399         fp->str = (kstring_t*)calloc(1, sizeof(kstring_t));
 400         fp->fp = (strcmp(fn, "-") == 0)? gzdopen(fileno(stdin), "r") : gzopen(fn, "r");
 401         fp->ks = ks_init(fp->fp);
 402         return fp;
 403 }
 404
 405 void sam_close(tamFile fp)
 406 {
 407         if (fp) {
 408                 ks_destroy(fp->ks);
 409                 gzclose(fp->fp);
 410                 free(fp->str->s); free(fp->str);
 411                 free(fp);
 412         }
 413 }