bam.c

   1 #include <stdio.h>
   2 #include <ctype.h>
   3 #include <errno.h>
   4 #include <assert.h>
   5 #include "bam.h"
   6 #include "bam_endian.h"
   7 #include "kstring.h"
   8 #include "sam_header.h"
   9
  10 int bam_is_be = 0;
  11 char *bam_flag2char_table = "pPuUrR12sfd\0\0\0\0\0";
  12
  13 /**************************
  14  * CIGAR related routines *
  15  **************************/
  16
  17 uint32_t bam_calend(const bam1_core_t *c, const uint32_t *cigar)
  18 {
  19         uint32_t k, end;
  20         end = c->pos;
  21         for (k = 0; k < c->n_cigar; ++k) {
  22                 int op = cigar[k] & BAM_CIGAR_MASK;
  23                 if (op == BAM_CMATCH || op == BAM_CDEL || op == BAM_CREF_SKIP)
  24                         end += cigar[k] >> BAM_CIGAR_SHIFT;
  25         }
  26         return end;
  27 }
  28
  29 int32_t bam_cigar2qlen(const bam1_core_t *c, const uint32_t *cigar)
  30 {
  31         uint32_t k;
  32         int32_t l = 0;
  33         for (k = 0; k < c->n_cigar; ++k) {
  34                 int op = cigar[k] & BAM_CIGAR_MASK;
  35                 if (op == BAM_CMATCH || op == BAM_CINS || op == BAM_CSOFT_CLIP)
  36                         l += cigar[k] >> BAM_CIGAR_SHIFT;
  37         }
  38         return l;
  39 }
  40
  41 /********************
  42  * BAM I/O routines *
  43  ********************/
  44
  45 bam_header_t *bam_header_init()
  46 {
  47         bam_is_be = bam_is_big_endian();
  48         return (bam_header_t*)calloc(1, sizeof(bam_header_t));
  49 }
  50
  51 void bam_header_destroy(bam_header_t *header)
  52 {
  53         int32_t i;
  54         extern void bam_destroy_header_hash(bam_header_t *header);
  55         if (header == 0) return;
  56         if (header->target_name) {
  57                 for (i = 0; i < header->n_targets; ++i)
  58                         free(header->target_name[i]);
  59                 free(header->target_name);
  60                 free(header->target_len);
  61         }
  62         free(header->text);
  63         if (header->dict) sam_header_free(header->dict);
  64         if (header->rg2lib) sam_tbl_destroy(header->rg2lib);
  65         bam_destroy_header_hash(header);
  66         free(header);
  67 }
  68
  69 bam_header_t *bam_header_read(bamFile fp)
  70 {
  71         bam_header_t *header;
  72         char buf[4];
  73         int magic_len;
  74         int32_t i = 1, name_len;
  75         // check EOF
  76         i = bgzf_check_EOF(fp);
  77         if (i < 0) {
  78                 // If the file is a pipe, checking the EOF marker will *always* fail
  79                 // with ESPIPE.  Suppress the error message in this case.
  80                 if (errno != ESPIPE) perror("[bam_header_read] bgzf_check_EOF");
  81         }
  82         else if (i == 0) fprintf(stderr, "[bam_header_read] EOF marker is absent.\n");
  83         // read "BAM1"
  84         magic_len = bam_read(fp, buf, 4);
  85         if (magic_len != 4 || strncmp(buf, "BAM\001", 4) != 0) {
  86                 fprintf(stderr, "[bam_header_read] invalid BAM binary header (this is not a BAM file).\n");
  87                 return 0;
  88         }
  89         header = bam_header_init();
  90         // read plain text and the number of reference sequences
  91         bam_read(fp, &header->l_text, 4);
  92         if (bam_is_be) bam_swap_endian_4p(&header->l_text);
  93         header->text = (char*)calloc(header->l_text + 1, 1);
  94         bam_read(fp, header->text, header->l_text);
  95         bam_read(fp, &header->n_targets, 4);
  96         if (bam_is_be) bam_swap_endian_4p(&header->n_targets);
  97         // read reference sequence names and lengths
  98         header->target_name = (char**)calloc(header->n_targets, sizeof(char*));
  99         header->target_len = (uint32_t*)calloc(header->n_targets, 4);
 100         for (i = 0; i != header->n_targets; ++i) {
 101                 bam_read(fp, &name_len, 4);
 102                 if (bam_is_be) bam_swap_endian_4p(&name_len);
 103                 header->target_name[i] = (char*)calloc(name_len, 1);
 104                 bam_read(fp, header->target_name[i], name_len);
 105                 bam_read(fp, &header->target_len[i], 4);
 106                 if (bam_is_be) bam_swap_endian_4p(&header->target_len[i]);
 107         }
 108         return header;
 109 }
 110
 111 int bam_header_write(bamFile fp, const bam_header_t *header)
 112 {
 113         char buf[4];
 114         int32_t i, name_len, x;
 115         // write "BAM1"
 116         strncpy(buf, "BAM\001", 4);
 117         bam_write(fp, buf, 4);
 118         // write plain text and the number of reference sequences
 119         if (bam_is_be) {
 120                 x = bam_swap_endian_4(header->l_text);
 121                 bam_write(fp, &x, 4);
 122                 if (header->l_text) bam_write(fp, header->text, header->l_text);
 123                 x = bam_swap_endian_4(header->n_targets);
 124                 bam_write(fp, &x, 4);
 125         } else {
 126                 bam_write(fp, &header->l_text, 4);
 127                 if (header->l_text) bam_write(fp, header->text, header->l_text);
 128                 bam_write(fp, &header->n_targets, 4);
 129         }
 130         // write sequence names and lengths
 131         for (i = 0; i != header->n_targets; ++i) {
 132                 char *p = header->target_name[i];
 133                 name_len = strlen(p) + 1;
 134                 if (bam_is_be) {
 135                         x = bam_swap_endian_4(name_len);
 136                         bam_write(fp, &x, 4);
 137                 } else bam_write(fp, &name_len, 4);
 138                 bam_write(fp, p, name_len);
 139                 if (bam_is_be) {
 140                         x = bam_swap_endian_4(header->target_len[i]);
 141                         bam_write(fp, &x, 4);
 142                 } else bam_write(fp, &header->target_len[i], 4);
 143         }
 144         return 0;
 145 }
 146
 147 static void swap_endian_data(const bam1_core_t *c, int data_len, uint8_t *data)
 148 {
 149         uint8_t *s;
 150         uint32_t i, *cigar = (uint32_t*)(data + c->l_qname);
 151         s = data + c->n_cigar*4 + c->l_qname + c->l_qseq + (c->l_qseq + 1)/2;
 152         for (i = 0; i < c->n_cigar; ++i) bam_swap_endian_4p(&cigar[i]);
 153         while (s < data + data_len) {
 154                 uint8_t type;
 155                 s += 2; // skip key
 156                 type = toupper(*s); ++s; // skip type
 157                 if (type == 'C' || type == 'A') ++s;
 158                 else if (type == 'S') { bam_swap_endian_2p(s); s += 2; }
 159                 else if (type == 'I' || type == 'F') { bam_swap_endian_4p(s); s += 4; }
 160                 else if (type == 'D') { bam_swap_endian_8p(s); s += 8; }
 161                 else if (type == 'Z' || type == 'H') { while (*s) ++s; ++s; }
 162         }
 163 }
 164
 165 int bam_read1(bamFile fp, bam1_t *b)
 166 {
 167         bam1_core_t *c = &b->core;
 168         int32_t block_len, ret, i;
 169         uint32_t x[8];
 170
 171         assert(BAM_CORE_SIZE == 32);
 172         if ((ret = bam_read(fp, &block_len, 4)) != 4) {
 173                 if (ret == 0) return -1; // normal end-of-file
 174                 else return -2; // truncated
 175         }
 176         if (bam_read(fp, x, BAM_CORE_SIZE) != BAM_CORE_SIZE) return -3;
 177         if (bam_is_be) {
 178                 bam_swap_endian_4p(&block_len);
 179                 for (i = 0; i < 8; ++i) bam_swap_endian_4p(x + i);
 180         }
 181         c->tid = x[0]; c->pos = x[1];
 182         c->bin = x[2]>>16; c->qual = x[2]>>8&0xff; c->l_qname = x[2]&0xff;
 183         c->flag = x[3]>>16; c->n_cigar = x[3]&0xffff;
 184         c->l_qseq = x[4];
 185         c->mtid = x[5]; c->mpos = x[6]; c->isize = x[7];
 186         b->data_len = block_len - BAM_CORE_SIZE;
 187         if (b->m_data < b->data_len) {
 188                 b->m_data = b->data_len;
 189                 kroundup32(b->m_data);
 190                 b->data = (uint8_t*)realloc(b->data, b->m_data);
 191         }
 192         if (bam_read(fp, b->data, b->data_len) != b->data_len) return -4;
 193         b->l_aux = b->data_len - c->n_cigar * 4 - c->l_qname - c->l_qseq - (c->l_qseq+1)/2;
 194         if (bam_is_be) swap_endian_data(c, b->data_len, b->data);
 195         return 4 + block_len;
 196 }
 197
 198 inline int bam_write1_core(bamFile fp, const bam1_core_t *c, int data_len, uint8_t *data)
 199 {
 200         uint32_t x[8], block_len = data_len + BAM_CORE_SIZE, y;
 201         int i;
 202         assert(BAM_CORE_SIZE == 32);
 203         x[0] = c->tid;
 204         x[1] = c->pos;
 205         x[2] = (uint32_t)c->bin<<16 | c->qual<<8 | c->l_qname;
 206         x[3] = (uint32_t)c->flag<<16 | c->n_cigar;
 207         x[4] = c->l_qseq;
 208         x[5] = c->mtid;
 209         x[6] = c->mpos;
 210         x[7] = c->isize;
 211         if (bam_is_be) {
 212                 for (i = 0; i < 8; ++i) bam_swap_endian_4p(x + i);
 213                 y = block_len;
 214                 bam_write(fp, bam_swap_endian_4p(&y), 4);
 215                 swap_endian_data(c, data_len, data);
 216         } else bam_write(fp, &block_len, 4);
 217         bam_write(fp, x, BAM_CORE_SIZE);
 218         bam_write(fp, data, data_len);
 219         if (bam_is_be) swap_endian_data(c, data_len, data);
 220         return 4 + block_len;
 221 }
 222
 223 int bam_write1(bamFile fp, const bam1_t *b)
 224 {
 225         return bam_write1_core(fp, &b->core, b->data_len, b->data);
 226 }
 227
 228 char *bam_format1_core(const bam_header_t *header, const bam1_t *b, int of)
 229 {
 230         uint8_t *s = bam1_seq(b), *t = bam1_qual(b);
 231         int i;
 232         const bam1_core_t *c = &b->core;
 233         kstring_t str;
 234         str.l = str.m = 0; str.s = 0;
 235
 236         ksprintf(&str, "%s\t", bam1_qname(b));
 237         if (of == BAM_OFDEC) ksprintf(&str, "%d\t", c->flag);
 238         else if (of == BAM_OFHEX) ksprintf(&str, "0x%x\t", c->flag);
 239         else { // BAM_OFSTR
 240                 for (i = 0; i < 16; ++i)
 241                         if ((c->flag & 1<<i) && bam_flag2char_table[i])
 242                                 kputc(bam_flag2char_table[i], &str);
 243                 kputc('\t', &str);
 244         }
 245         if (c->tid < 0) kputs("*\t", &str);
 246         else ksprintf(&str, "%s\t", header->target_name[c->tid]);
 247         ksprintf(&str, "%d\t%d\t", c->pos + 1, c->qual);
 248         if (c->n_cigar == 0) kputc('*', &str);
 249         else {
 250                 for (i = 0; i < c->n_cigar; ++i)
 251                         ksprintf(&str, "%d%c", bam1_cigar(b)[i]>>BAM_CIGAR_SHIFT, "MIDNSHP"[bam1_cigar(b)[i]&BAM_CIGAR_MASK]);
 252         }
 253         kputc('\t', &str);
 254         if (c->mtid < 0) kputs("*\t", &str);
 255         else if (c->mtid == c->tid) kputs("=\t", &str);
 256         else ksprintf(&str, "%s\t", header->target_name[c->mtid]);
 257         ksprintf(&str, "%d\t%d\t", c->mpos + 1, c->isize);
 258         if (c->l_qseq) {
 259                 for (i = 0; i < c->l_qseq; ++i) kputc(bam_nt16_rev_table[bam1_seqi(s, i)], &str);
 260                 kputc('\t', &str);
 261                 if (t[0] == 0xff) kputc('*', &str);
 262                 else for (i = 0; i < c->l_qseq; ++i) kputc(t[i] + 33, &str);
 263         } else ksprintf(&str, "*\t*");
 264         s = bam1_aux(b);
 265         while (s < b->data + b->data_len) {
 266                 uint8_t type, key[2];
 267                 key[0] = s[0]; key[1] = s[1];
 268                 s += 2; type = *s; ++s;
 269                 ksprintf(&str, "\t%c%c:", key[0], key[1]);
 270                 if (type == 'A') { ksprintf(&str, "A:%c", *s); ++s; }
 271                 else if (type == 'C') { ksprintf(&str, "i:%u", *s); ++s; }
 272                 else if (type == 'c') { ksprintf(&str, "i:%d", *(int8_t*)s); ++s; }
 273                 else if (type == 'S') { ksprintf(&str, "i:%u", *(uint16_t*)s); s += 2; }
 274                 else if (type == 's') { ksprintf(&str, "i:%d", *(int16_t*)s); s += 2; }
 275                 else if (type == 'I') { ksprintf(&str, "i:%u", *(uint32_t*)s); s += 4; }
 276                 else if (type == 'i') { ksprintf(&str, "i:%d", *(int32_t*)s); s += 4; }
 277                 else if (type == 'f') { ksprintf(&str, "f:%g", *(float*)s); s += 4; }
 278                 else if (type == 'd') { ksprintf(&str, "d:%lg", *(double*)s); s += 8; }
 279                 else if (type == 'Z' || type == 'H') { ksprintf(&str, "%c:", type); while (*s) kputc(*s++, &str); ++s; }
 280         }
 281         return str.s;
 282 }
 283
 284 char *bam_format1(const bam_header_t *header, const bam1_t *b)
 285 {
 286         return bam_format1_core(header, b, BAM_OFDEC);
 287 }
 288
 289 void bam_view1(const bam_header_t *header, const bam1_t *b)
 290 {
 291         char *s = bam_format1(header, b);
 292         printf("%s\n", s);
 293         free(s);
 294 }
 295
 296 // FIXME: we should also check the LB tag associated with each alignment
 297 const char *bam_get_library(bam_header_t *h, const bam1_t *b)
 298 {
 299         const uint8_t *rg;
 300         if (h->dict == 0) h->dict = sam_header_parse2(h->text);
 301         if (h->rg2lib == 0) h->rg2lib = sam_header2tbl(h->dict, "RG", "ID", "LB");
 302         rg = bam_aux_get(b, "RG");
 303         return (rg == 0)? 0 : sam_tbl_get(h->rg2lib, (const char*)(rg + 1));
 304 }