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