samtools/bam.c.pysam.c

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