bam_plcmd.c

   1 #include <math.h>
   2 #include <stdio.h>
   3 #include <unistd.h>
   4 #include <ctype.h>
   5 #include "sam.h"
   6 #include "faidx.h"
   7 #include "bam_maqcns.h"
   8 #include "khash.h"
   9 #include "glf.h"
  10 #include "kstring.h"
  11
  12 typedef int *indel_list_t;
  13 KHASH_MAP_INIT_INT64(64, indel_list_t)
  14
  15 #define BAM_PLF_SIMPLE     0x01
  16 #define BAM_PLF_CNS        0x02
  17 #define BAM_PLF_INDEL_ONLY 0x04
  18 #define BAM_PLF_GLF        0x08
  19 #define BAM_PLF_VAR_ONLY   0x10
  20 #define BAM_PLF_2ND        0x20
  21 #define BAM_PLF_RANBASE    0x40
  22 #define BAM_PLF_1STBASE    0x80
  23 #define BAM_PLF_ALLBASE    0x100
  24 #define BAM_PLF_READPOS    0x200
  25 #define BAM_PLF_NOBAQ      0x400
  26
  27 typedef struct {
  28         bam_header_t *h;
  29         bam_maqcns_t *c;
  30         bam_maqindel_opt_t *ido;
  31         faidx_t *fai;
  32         khash_t(64) *hash;
  33         uint32_t format;
  34         int tid, len, last_pos;
  35         int mask;
  36         int capQ_thres, min_baseQ;
  37     int max_depth;  // for indel calling, ignore reads with the depth too high. 0 for unlimited
  38         char *ref;
  39         glfFile fp_glf; // for glf output only
  40 } pu_data_t;
  41
  42 char **__bam_get_lines(const char *fn, int *_n);
  43 void bam_init_header_hash(bam_header_t *header);
  44 int32_t bam_get_tid(const bam_header_t *header, const char *seq_name);
  45
  46 static khash_t(64) *load_pos(const char *fn, bam_header_t *h)
  47 {
  48         char **list;
  49         int i, j, n, *fields, max_fields;
  50         khash_t(64) *hash;
  51         bam_init_header_hash(h);
  52         list = __bam_get_lines(fn, &n);
  53         hash = kh_init(64);
  54         max_fields = 0; fields = 0;
  55         for (i = 0; i < n; ++i) {
  56                 char *str = list[i];
  57                 int chr, n_fields, ret;
  58                 khint_t k;
  59                 uint64_t x;
  60                 n_fields = ksplit_core(str, 0, &max_fields, &fields);
  61                 if (n_fields < 2) continue;
  62                 chr = bam_get_tid(h, str + fields[0]);
  63                 if (chr < 0) {
  64                         fprintf(stderr, "[load_pos] unknown reference sequence name: %s\n", str + fields[0]);
  65                         continue;
  66                 }
  67                 x = (uint64_t)chr << 32 | (atoi(str + fields[1]) - 1);
  68                 k = kh_put(64, hash, x, &ret);
  69                 if (ret == 0) {
  70                         fprintf(stderr, "[load_pos] position %s:%s has been loaded.\n", str+fields[0], str+fields[1]);
  71                         continue;
  72                 }
  73                 kh_val(hash, k) = 0;
  74                 if (n_fields > 2) {
  75                         // count
  76                         for (j = 2; j < n_fields; ++j) {
  77                                 char *s = str + fields[j];
  78                                 if ((*s != '+' && *s != '-') || !isdigit(s[1])) break;
  79                         }
  80                         if (j > 2) { // update kh_val()
  81                                 int *q, y, z;
  82                                 q = kh_val(hash, k) = (int*)calloc(j - 1, sizeof(int));
  83                                 q[0] = j - 2; z = j; y = 1;
  84                                 for (j = 2; j < z; ++j)
  85                                         q[y++] = atoi(str + fields[j]);
  86                         }
  87                 }
  88                 free(str);
  89         }
  90         free(list); free(fields);
  91         return hash;
  92 }
  93
  94 static inline int printw(int c, FILE *fp)
  95 {
  96         char buf[16];
  97         int l, x;
  98         if (c == 0) return fputc('0', fp);
  99         for (l = 0, x = c < 0? -c : c; x > 0; x /= 10) buf[l++] = x%10 + '0';
 100         if (c < 0) buf[l++] = '-';
 101         buf[l] = 0;
 102         for (x = 0; x < l/2; ++x) {
 103                 int y = buf[x]; buf[x] = buf[l-1-x]; buf[l-1-x] = y;
 104         }
 105         fputs(buf, fp);
 106         return 0;
 107 }
 108
 109 // an analogy to pileup_func() below
 110 static int glt3_func(uint32_t tid, uint32_t pos, int n, const bam_pileup1_t *pu, void *data)
 111 {
 112         pu_data_t *d = (pu_data_t*)data;
 113         bam_maqindel_ret_t *r = 0;
 114         int rb, *proposed_indels = 0;
 115         glf1_t *g;
 116         glf3_t *g3;
 117
 118         if (d->fai == 0) {
 119                 fprintf(stderr, "[glt3_func] reference sequence is required for generating GLT. Abort!\n");
 120                 exit(1);
 121         }
 122         if (d->hash) { // only output a list of sites
 123                 khint_t k = kh_get(64, d->hash, (uint64_t)tid<<32|pos);
 124                 if (k == kh_end(d->hash)) return 0;
 125                 proposed_indels = kh_val(d->hash, k);
 126         }
 127         g3 = glf3_init1();
 128         if (d->fai && (int)tid != d->tid) {
 129                 if (d->ref) { // then write the end mark
 130                         g3->rtype = GLF3_RTYPE_END;
 131                         glf3_write1(d->fp_glf, g3);
 132                 }
 133                 glf3_ref_write(d->fp_glf, d->h->target_name[tid], d->h->target_len[tid]); // write reference
 134                 free(d->ref);
 135                 d->ref = fai_fetch(d->fai, d->h->target_name[tid], &d->len);
 136                 d->tid = tid;
 137                 d->last_pos = 0;
 138         }
 139         rb = (d->ref && (int)pos < d->len)? d->ref[pos] : 'N';
 140         g = bam_maqcns_glfgen(n, pu, bam_nt16_table[rb], d->c);
 141         memcpy(g3, g, sizeof(glf1_t));
 142         g3->rtype = GLF3_RTYPE_SUB;
 143         g3->offset = pos - d->last_pos;
 144         d->last_pos = pos;
 145         glf3_write1(d->fp_glf, g3);
 146     if (pos < d->len) {
 147         int m = (!d->max_depth || d->max_depth>n) ? n : d->max_depth;
 148                 if (proposed_indels)
 149                         r = bam_maqindel(m, pos, d->ido, pu, d->ref, proposed_indels[0], proposed_indels+1);
 150                 else r = bam_maqindel(m, pos, d->ido, pu, d->ref, 0, 0);
 151         }
 152         if (r) { // then write indel line
 153                 int het = 3 * n, min;
 154                 min = het;
 155                 if (min > r->gl[0]) min = r->gl[0];
 156                 if (min > r->gl[1]) min = r->gl[1];
 157                 g3->ref_base = 0;
 158                 g3->rtype = GLF3_RTYPE_INDEL;
 159                 memset(g3->lk, 0, 10);
 160                 g3->lk[0] = r->gl[0] - min < 255? r->gl[0] - min : 255;
 161                 g3->lk[1] = r->gl[1] - min < 255? r->gl[1] - min : 255;
 162                 g3->lk[2] = het - min < 255? het - min : 255;
 163                 g3->offset = 0;
 164                 g3->indel_len[0] = r->indel1;
 165                 g3->indel_len[1] = r->indel2;
 166                 g3->min_lk = min < 255? min : 255;
 167                 g3->max_len = (abs(r->indel1) > abs(r->indel2)? abs(r->indel1) : abs(r->indel2)) + 1;
 168                 g3->indel_seq[0] = strdup(r->s[0]+1);
 169                 g3->indel_seq[1] = strdup(r->s[1]+1);
 170                 glf3_write1(d->fp_glf, g3);
 171                 bam_maqindel_ret_destroy(r);
 172         }
 173         free(g);
 174         glf3_destroy1(g3);
 175         return 0;
 176 }
 177
 178 static inline void pileup_seq(const bam_pileup1_t *p, int pos, int ref_len, const char *ref)
 179 {
 180         int j;
 181         if (p->is_head) {
 182                 putchar('^');
 183                 putchar(p->b->core.qual > 93? 126 : p->b->core.qual + 33);
 184         }
 185         if (!p->is_del) {
 186                 int rb, c = bam_nt16_rev_table[bam1_seqi(bam1_seq(p->b), p->qpos)];
 187                 rb = (ref && pos < ref_len)? ref[pos] : 'N';
 188                 if (c == '=' || toupper(c) == toupper(rb)) c = bam1_strand(p->b)? ',' : '.';
 189                 else c = bam1_strand(p->b)? tolower(c) : toupper(c);
 190                 putchar(c);
 191         } else putchar(p->is_refskip? (bam1_strand(p->b)? '<' : '>') : '*');
 192         if (p->indel > 0) {
 193                 putchar('+'); printw(p->indel, stdout);
 194                 for (j = 1; j <= p->indel; ++j) {
 195                         int c = bam_nt16_rev_table[bam1_seqi(bam1_seq(p->b), p->qpos + j)];
 196                         putchar(bam1_strand(p->b)? tolower(c) : toupper(c));
 197                 }
 198         } else if (p->indel < 0) {
 199                 printw(p->indel, stdout);
 200                 for (j = 1; j <= -p->indel; ++j) {
 201                         int c = (ref && (int)pos+j < ref_len)? ref[pos+j] : 'N';
 202                         putchar(bam1_strand(p->b)? tolower(c) : toupper(c));
 203                 }
 204         }
 205         if (p->is_tail) putchar('$');
 206 }
 207
 208 static int pileup_func(uint32_t tid, uint32_t pos, int n, const bam_pileup1_t *pu, void *data)
 209 {
 210         pu_data_t *d = (pu_data_t*)data;
 211         bam_maqindel_ret_t *r = 0;
 212         int i, rb, rms_mapq = -1, *proposed_indels = 0;
 213         uint64_t rms_aux;
 214         uint32_t cns = 0;
 215
 216         // if GLF is required, suppress -c completely
 217         if (d->format & BAM_PLF_GLF) return glt3_func(tid, pos, n, pu, data);
 218         // if d->hash is initialized, only output the sites in the hash table
 219         if (d->hash) {
 220                 khint_t k = kh_get(64, d->hash, (uint64_t)tid<<32|pos);
 221                 if (k == kh_end(d->hash)) return 0;
 222                 proposed_indels = kh_val(d->hash, k);
 223         }
 224         // update d->ref if necessary
 225         if (d->fai && (int)tid != d->tid) {
 226                 free(d->ref);
 227                 d->ref = faidx_fetch_seq(d->fai, d->h->target_name[tid], 0, 0x7fffffff, &d->len);
 228                 d->tid = tid;
 229         }
 230         rb = (d->ref && (int)pos < d->len)? d->ref[pos] : 'N';
 231         // when the indel-only mode is asked for, return if no reads mapped with indels
 232         if (d->format & BAM_PLF_INDEL_ONLY) {
 233                 for (i = 0; i < n; ++i)
 234                         if (pu[i].indel != 0) break;
 235                 if (i == n) return 0;
 236         }
 237         // call the consensus and indel
 238         if (d->format & BAM_PLF_CNS) { // call consensus
 239                 if (d->format & (BAM_PLF_RANBASE|BAM_PLF_1STBASE)) { // use a random base or the 1st base as the consensus call
 240                         const bam_pileup1_t *p = (d->format & BAM_PLF_1STBASE)? pu : pu + (int)(drand48() * n);
 241                         int q = bam1_qual(p->b)[p->qpos];
 242                         int mapQ = p->b->core.qual < d->c->cap_mapQ? p->b->core.qual : d->c->cap_mapQ;
 243                         uint32_t b = bam1_seqi(bam1_seq(p->b), p->qpos);
 244                         cns = b<<28 | 0xf<<24 | mapQ<<16 | q<<8;
 245                 } else if (d->format & BAM_PLF_ALLBASE) { // collapse all bases
 246                         uint64_t rmsQ = 0;
 247                         uint32_t b = 0;
 248                         for (i = 0; i < n; ++i) {
 249                                 const bam_pileup1_t *p = pu + i;
 250                                 int q = p->b->core.qual < d->c->cap_mapQ? p->b->core.qual : d->c->cap_mapQ;
 251                                 b |= bam1_seqi(bam1_seq(p->b), p->qpos);
 252                                 rmsQ += q * q;
 253                         }
 254                         rmsQ = (uint64_t)(sqrt((double)rmsQ / n) + .499);
 255                         cns = b<<28 | 0xf<<24 | rmsQ<<16 | 60<<8;
 256                 } else {
 257                         glf1_t *g = bam_maqcns_glfgen(n, pu, bam_nt16_table[rb], d->c);
 258                         cns = g->depth == 0? (0xfu<<28 | 0xf<<24) : glf2cns(g, (int)(d->c->q_r + .499));
 259                         free(g);
 260                 }
 261         }
 262     if ((d->format & (BAM_PLF_CNS|BAM_PLF_INDEL_ONLY)) && d->ref && pos < d->len) { // call indels
 263         int m = (!d->max_depth || d->max_depth>n) ? n : d->max_depth;
 264         if (proposed_indels) // the first element gives the size of the array
 265             r = bam_maqindel(m, pos, d->ido, pu, d->ref, proposed_indels[0], proposed_indels+1);
 266         else r = bam_maqindel(m, pos, d->ido, pu, d->ref, 0, 0);
 267         }
 268         // when only variant sites are asked for, test if the site is a variant
 269         if ((d->format & BAM_PLF_CNS) && (d->format & BAM_PLF_VAR_ONLY)) {
 270                 if (!(bam_nt16_table[rb] != 15 && cns>>28 != 15 && cns>>28 != bam_nt16_table[rb])) { // not a SNP
 271                         if (!(r && (r->gt == 2 || strcmp(r->s[r->gt], "*")))) { // not an indel
 272                                 if (r) bam_maqindel_ret_destroy(r);
 273                                 return 0;
 274                         }
 275                 }
 276         }
 277         // print the first 3 columns
 278         fputs(d->h->target_name[tid], stdout); putchar('\t');
 279         printw(pos+1, stdout); putchar('\t'); putchar(rb); putchar('\t');
 280         // print consensus information if required
 281         if (d->format & BAM_PLF_CNS) {
 282                 putchar(bam_nt16_rev_table[cns>>28]); putchar('\t');
 283                 printw(cns>>8&0xff, stdout); putchar('\t');
 284                 printw(cns&0xff, stdout); putchar('\t');
 285                 printw(cns>>16&0xff, stdout); putchar('\t');
 286         }
 287         // print pileup sequences
 288         printw(n, stdout); putchar('\t');
 289         rms_aux = 0; // we need to recalculate rms_mapq when -c is not flagged on the command line
 290         for (i = 0; i < n; ++i) {
 291                 const bam_pileup1_t *p = pu + i;
 292                 int tmp = p->b->core.qual < d->c->cap_mapQ? p->b->core.qual : d->c->cap_mapQ;
 293                 rms_aux += tmp * tmp;
 294                 pileup_seq(p, pos, d->len, d->ref);
 295         }
 296         // finalize rms_mapq
 297         rms_aux = (uint64_t)(sqrt((double)rms_aux / n) + .499);
 298         if (rms_mapq < 0) rms_mapq = rms_aux;
 299         putchar('\t');
 300         // print quality
 301         for (i = 0; i < n; ++i) {
 302                 const bam_pileup1_t *p = pu + i;
 303                 int c = bam1_qual(p->b)[p->qpos] + 33;
 304                 if (c > 126) c = 126;
 305                 putchar(c);
 306         }
 307         if (d->format & BAM_PLF_2ND) { // print 2nd calls and qualities
 308                 const unsigned char *q;
 309                 putchar('\t');
 310                 for (i = 0; i < n; ++i) {
 311                         const bam_pileup1_t *p = pu + i;
 312                         q = bam_aux_get(p->b, "E2");
 313                         putchar(q? q[p->qpos + 1] : 'N');
 314                 }
 315                 putchar('\t');
 316                 for (i = 0; i < n; ++i) {
 317                         const bam_pileup1_t *p = pu + i;
 318                         q = bam_aux_get(p->b, "U2");
 319                         putchar(q? q[p->qpos + 1] : '!');
 320                 }
 321         }
 322         // print mapping quality if -s is flagged on the command line
 323         if (d->format & BAM_PLF_SIMPLE) {
 324                 putchar('\t');
 325                 for (i = 0; i < n; ++i) {
 326                         int c = pu[i].b->core.qual + 33;
 327                         if (c > 126) c = 126;
 328                         putchar(c);
 329                 }
 330         }
 331         // print read position
 332         if (d->format & BAM_PLF_READPOS) {
 333                 putchar('\t');
 334                 for (i = 0; i < n; ++i) {
 335                         int x = pu[i].qpos;
 336                         int l = pu[i].b->core.l_qseq;
 337                         printw(x < l/2? x+1 : -((l-1)-x+1), stdout); putchar(',');
 338                 }
 339         }
 340         putchar('\n');
 341         // print the indel line if r has been calculated. This only happens if:
 342         // a) -c or -i are flagged, AND b) the reference sequence is available
 343         if (r) {
 344                 printf("%s\t%d\t*\t", d->h->target_name[tid], pos + 1);
 345                 if (r->gt < 2) printf("%s/%s\t", r->s[r->gt], r->s[r->gt]);
 346                 else printf("%s/%s\t", r->s[0], r->s[1]);
 347                 printf("%d\t%d\t", r->q_cns, r->q_ref);
 348                 printf("%d\t%d\t", rms_mapq, n);
 349                 printf("%s\t%s\t", r->s[0], r->s[1]);
 350                 //printf("%d\t%d\t", r->gl[0], r->gl[1]);
 351                 printf("%d\t%d\t%d\t", r->cnt1, r->cnt2, r->cnt_anti);
 352                 printf("%d\t%d\n", r->cnt_ref, r->cnt_ambi);
 353                 bam_maqindel_ret_destroy(r);
 354         }
 355         return 0;
 356 }
 357
 358 int bam_pileup(int argc, char *argv[])
 359 {
 360         int c, is_SAM = 0;
 361         char *fn_list = 0, *fn_fa = 0, *fn_pos = 0;
 362         pu_data_t *d = (pu_data_t*)calloc(1, sizeof(pu_data_t));
 363     d->max_depth = 1024; d->tid = -1; d->mask = BAM_DEF_MASK; d->min_baseQ = 13;
 364         d->c = bam_maqcns_init();
 365         d->c->errmod = BAM_ERRMOD_MAQ2; // change the default model
 366         d->ido = bam_maqindel_opt_init();
 367         while ((c = getopt(argc, argv, "st:f:cT:N:r:l:d:im:gI:G:vM:S2aR:PAQ:C:B")) >= 0) {
 368                 switch (c) {
 369                 case 'Q': d->c->min_baseQ = atoi(optarg); break;
 370                 case 'C': d->capQ_thres = atoi(optarg); break;
 371                 case 'B': d->format |= BAM_PLF_NOBAQ; break;
 372                 case 'a': d->c->errmod = BAM_ERRMOD_SOAP; break;
 373                 case 'A': d->c->errmod = BAM_ERRMOD_MAQ; break;
 374                 case 's': d->format |= BAM_PLF_SIMPLE; break;
 375                 case 't': fn_list = strdup(optarg); break;
 376                 case 'l': fn_pos = strdup(optarg); break;
 377                 case 'f': fn_fa = strdup(optarg); break;
 378                 case 'T': d->c->theta = atof(optarg); break;
 379                 case 'N': d->c->n_hap = atoi(optarg); break;
 380                 case 'r': d->c->het_rate = atof(optarg); d->ido->r_snp = d->c->het_rate; break;
 381                 case 'M': d->c->cap_mapQ = atoi(optarg); break;
 382                 case 'd': d->max_depth = atoi(optarg); break;
 383                 case 'c': d->format |= BAM_PLF_CNS; break;
 384                 case 'i': d->format |= BAM_PLF_INDEL_ONLY; break;
 385                 case 'v': d->format |= BAM_PLF_VAR_ONLY; break;
 386                 case 'm': d->mask = strtol(optarg, 0, 0); break;
 387                 case 'g': d->format |= BAM_PLF_GLF; break;
 388                 case '2': d->format |= BAM_PLF_2ND; break;
 389                 case 'P': d->format |= BAM_PLF_READPOS; break;
 390                 case 'I': d->ido->q_indel = atoi(optarg); break;
 391                 case 'G': d->ido->r_indel = atof(optarg); break;
 392                 case 'S': is_SAM = 1; break;
 393                 case 'R':
 394                         if (strcmp(optarg, "random") == 0) d->format |= BAM_PLF_RANBASE;
 395                         else if (strcmp(optarg, "first") == 0) d->format |= BAM_PLF_1STBASE;
 396                         else if (strcmp(optarg, "all") == 0) d->format |= BAM_PLF_ALLBASE;
 397                         else fprintf(stderr, "[bam_pileup] unrecognized -R\n");
 398                         break;
 399                 default: fprintf(stderr, "Unrecognizd option '-%c'.\n", c); return 1;
 400                 }
 401         }
 402         if (d->c->errmod != BAM_ERRMOD_MAQ2) d->c->theta += 0.02;
 403         if (d->c->theta > 1.0) d->c->theta = 1.0;
 404         if (fn_list) is_SAM = 1;
 405         if (optind == argc) {
 406                 fprintf(stderr, "\n");
 407                 fprintf(stderr, "Usage:  samtools pileup [options] <in.bam>|<in.sam>\n\n");
 408                 fprintf(stderr, "Option: -s        simple (yet incomplete) pileup format\n");
 409                 fprintf(stderr, "        -S        the input is in SAM\n");
 410                 fprintf(stderr, "        -B        disable BAQ computation\n");
 411                 fprintf(stderr, "        -A        use the original MAQ model for SNP calling (DEPRECATED)\n");
 412                 fprintf(stderr, "        -2        output the 2nd best call and quality\n");
 413                 fprintf(stderr, "        -i        only show lines/consensus with indels\n");
 414                 fprintf(stderr, "        -Q INT    min base quality (possibly capped by BAQ) [%d]\n", d->c->min_baseQ);
 415                 fprintf(stderr, "        -C INT    coefficient for adjusting mapQ of poor mappings [%d]\n", d->capQ_thres);
 416                 fprintf(stderr, "        -m INT    filtering reads with bits in INT [0x%x]\n", d->mask);
 417                 fprintf(stderr, "        -M INT    cap mapping quality at INT [%d]\n", d->c->cap_mapQ);
 418         fprintf(stderr, "        -d INT    limit maximum depth for indels [%d]\n", d->max_depth);
 419                 fprintf(stderr, "        -t FILE   list of reference sequences (force -S)\n");
 420                 fprintf(stderr, "        -l FILE   list of sites at which pileup is output\n");
 421                 fprintf(stderr, "        -f FILE   reference sequence in the FASTA format\n\n");
 422                 fprintf(stderr, "        -c        compute the consensus sequence\n");
 423                 fprintf(stderr, "        -v        print variants only (for -c)\n");
 424                 fprintf(stderr, "        -g        output in the GLFv3 format (DEPRECATED)\n");
 425                 fprintf(stderr, "        -T FLOAT  theta in maq consensus calling model (for -c) [%.4g]\n", d->c->theta);
 426                 fprintf(stderr, "        -N INT    number of haplotypes in the sample (for -c) [%d]\n", d->c->n_hap);
 427                 fprintf(stderr, "        -r FLOAT  prior of a difference between two haplotypes (for -c) [%.4g]\n", d->c->het_rate);
 428                 fprintf(stderr, "        -G FLOAT  prior of an indel between two haplotypes (for -c) [%.4g]\n", d->ido->r_indel);
 429                 fprintf(stderr, "        -I INT    phred prob. of an indel in sequencing/prep. (for -c) [%d]\n", d->ido->q_indel);
 430                 fprintf(stderr, "\n");
 431                 free(fn_list); free(fn_fa); free(d);
 432                 return 1;
 433         }
 434         if (d->format & (BAM_PLF_RANBASE|BAM_PLF_1STBASE|BAM_PLF_ALLBASE)) d->format |= BAM_PLF_CNS;
 435         if (fn_fa) d->fai = fai_load(fn_fa);
 436         if (d->format & (BAM_PLF_CNS|BAM_PLF_GLF)) bam_maqcns_prepare(d->c); // consensus calling
 437         if (d->format & BAM_PLF_GLF) { // for glf output
 438                 glf3_header_t *h;
 439                 h = glf3_header_init();
 440                 d->fp_glf = bgzf_fdopen(fileno(stdout), "w");
 441                 glf3_header_write(d->fp_glf, h);
 442                 glf3_header_destroy(h);
 443         }
 444         if (d->fai == 0 && (d->format & (BAM_PLF_CNS|BAM_PLF_INDEL_ONLY)))
 445                 fprintf(stderr, "[bam_pileup] indels will not be called when -f is absent.\n");
 446         if (fn_fa && is_SAM && fn_list == 0) fn_list = samfaipath(fn_fa);
 447
 448         {
 449                 samfile_t *fp;
 450                 fp = is_SAM? samopen(argv[optind], "r", fn_list) : samopen(argv[optind], "rb", 0);
 451                 if (fp == 0 || fp->header == 0) {
 452                         fprintf(stderr, "[bam_pileup] fail to read the header: non-exisiting file or wrong format.\n");
 453                         return 1;
 454                 }
 455                 d->h = fp->header;
 456                 if (fn_pos) d->hash = load_pos(fn_pos, d->h);
 457                 { // run pileup
 458                         extern int bam_prob_realn(bam1_t *b, const char *ref);
 459                         extern int bam_cap_mapQ(bam1_t *b, char *ref, int thres);
 460                         bam1_t *b;
 461                         int ret, tid, pos, n_plp;
 462                         bam_plp_t iter;
 463                         const bam_pileup1_t *plp;
 464                         b = bam_init1();
 465                         iter = bam_plp_init(0, 0);
 466                         bam_plp_set_mask(iter, d->mask);
 467                         while ((ret = samread(fp, b)) >= 0) {
 468                                 int skip = 0;
 469                                 // update d->ref if necessary
 470                                 if (d->fai && (int)b->core.tid != d->tid) {
 471                                         free(d->ref);
 472                                         d->ref = faidx_fetch_seq(d->fai, d->h->target_name[b->core.tid], 0, 0x7fffffff, &d->len);
 473                                         d->tid = b->core.tid;
 474                                 }
 475                                 if (d->ref && (d->format&BAM_PLF_CNS) && !(d->format&BAM_PLF_NOBAQ)) bam_prob_realn(b, d->ref);
 476                                 if (d->ref && (d->format&BAM_PLF_CNS) && d->capQ_thres > 10) {
 477                                         int q = bam_cap_mapQ(b, d->ref, d->capQ_thres);
 478                                         if (q < 0) skip = 1;
 479                                         else if (b->core.qual > q) b->core.qual = q;
 480                                 } else if (b->core.flag&BAM_FUNMAP) skip = 1;
 481                                 else if ((d->format&BAM_PLF_CNS) && (b->core.flag&1) && !(b->core.flag&2)) skip = 1;
 482                                 if (skip) continue;
 483                                 bam_plp_push(iter, b);
 484                                 while ((plp = bam_plp_next(iter, &tid, &pos, &n_plp)) != 0)
 485                                         pileup_func(tid, pos, n_plp, plp, d);
 486                         }
 487                         bam_plp_push(iter, 0);
 488                         while ((plp = bam_plp_next(iter, &tid, &pos, &n_plp)) != 0)
 489                                 pileup_func(tid, pos, n_plp, plp, d);
 490                         bam_plp_destroy(iter);
 491                         bam_destroy1(b);
 492                 }
 493                 samclose(fp); // d->h will be destroyed here
 494         }
 495
 496         // free
 497         if (d->format & BAM_PLF_GLF) bgzf_close(d->fp_glf);
 498         if (fn_pos) { // free the hash table
 499                 khint_t k;
 500                 for (k = kh_begin(d->hash); k < kh_end(d->hash); ++k)
 501                         if (kh_exist(d->hash, k)) free(kh_val(d->hash, k));
 502                 kh_destroy(64, d->hash);
 503         }
 504         free(fn_pos); free(fn_list); free(fn_fa);
 505         if (d->fai) fai_destroy(d->fai);
 506         bam_maqcns_destroy(d->c);
 507         free(d->ido); free(d->ref); free(d);
 508         return 0;
 509 }
 510
 511 /***********
 512  * mpileup *
 513  ***********/
 514
 515 #include <assert.h>
 516 #include "bam2bcf.h"
 517 #include "sample.h"
 518
 519 #define MPLP_GLF   0x10
 520 #define MPLP_NO_COMP 0x20
 521 #define MPLP_NO_ORPHAN 0x40
 522 #define MPLP_REALN   0x80
 523
 524 typedef struct {
 525         int max_mq, min_mq, flag, min_baseQ, capQ_thres;
 526         char *reg, *fn_pos;
 527         faidx_t *fai;
 528         kh_64_t *hash;
 529 } mplp_conf_t;
 530
 531 typedef struct {
 532         bamFile fp;
 533         bam_iter_t iter;
 534         int min_mq, flag, ref_id, capQ_thres;
 535         char *ref;
 536 } mplp_aux_t;
 537
 538 typedef struct {
 539         int n;
 540         int *n_plp, *m_plp;
 541         bam_pileup1_t **plp;
 542 } mplp_pileup_t;
 543
 544 static int mplp_func(void *data, bam1_t *b)
 545 {
 546         extern int bam_realn(bam1_t *b, const char *ref);
 547         extern int bam_prob_realn(bam1_t *b, const char *ref);
 548         extern int bam_cap_mapQ(bam1_t *b, char *ref, int thres);
 549         mplp_aux_t *ma = (mplp_aux_t*)data;
 550         int ret, skip = 0;
 551         do {
 552                 int has_ref = (ma->ref && ma->ref_id == b->core.tid)? 1 : 0;
 553                 ret = ma->iter? bam_iter_read(ma->fp, ma->iter, b) : bam_read1(ma->fp, b);
 554                 if (ret < 0) break;
 555                 skip = 0;
 556                 if (has_ref && (ma->flag&MPLP_REALN)) bam_prob_realn(b, ma->ref);
 557                 if (has_ref && ma->capQ_thres > 10) {
 558                         int q = bam_cap_mapQ(b, ma->ref, ma->capQ_thres);
 559                         if (q < 0) skip = 1;
 560                         else if (b->core.qual > q) b->core.qual = q;
 561                 } else if (b->core.flag&BAM_FUNMAP) skip = 1;
 562                 else if (b->core.qual < ma->min_mq) skip = 1;
 563                 else if ((ma->flag&MPLP_NO_ORPHAN) && (b->core.flag&1) && !(b->core.flag&2)) skip = 1;
 564         } while (skip);
 565         return ret;
 566 }
 567
 568 static void group_smpl(mplp_pileup_t *m, bam_sample_t *sm, kstring_t *buf,
 569                                            int n, char *const*fn, int *n_plp, const bam_pileup1_t **plp)
 570 {
 571         int i, j;
 572         memset(m->n_plp, 0, m->n * sizeof(int));
 573         for (i = 0; i < n; ++i) {
 574                 for (j = 0; j < n_plp[i]; ++j) {
 575                         const bam_pileup1_t *p = plp[i] + j;
 576                         uint8_t *q;
 577                         int id = -1;
 578                         q = bam_aux_get(p->b, "RG");
 579                         if (q) id = bam_smpl_rg2smid(sm, fn[i], (char*)q+1, buf);
 580                         if (id < 0) id = bam_smpl_rg2smid(sm, fn[i], 0, buf);
 581                         assert(id >= 0 && id < m->n);
 582                         if (m->n_plp[id] == m->m_plp[id]) {
 583                                 m->m_plp[id] = m->m_plp[id]? m->m_plp[id]<<1 : 8;
 584                                 m->plp[id] = realloc(m->plp[id], sizeof(bam_pileup1_t) * m->m_plp[id]);
 585                         }
 586                         m->plp[id][m->n_plp[id]++] = *p;
 587                 }
 588         }
 589 }
 590
 591 static int mpileup(mplp_conf_t *conf, int n, char **fn)
 592 {
 593         mplp_aux_t **data;
 594         int i, tid, pos, *n_plp, beg0 = 0, end0 = 1u<<29, ref_len, ref_tid;
 595         const bam_pileup1_t **plp;
 596         bam_mplp_t iter;
 597         bam_header_t *h = 0;
 598         char *ref;
 599         khash_t(64) *hash = 0;
 600
 601         bcf_callaux_t *bca = 0;
 602         bcf_callret1_t *bcr = 0;
 603         bcf_call_t bc;
 604         bcf_t *bp = 0;
 605         bcf_hdr_t *bh = 0;
 606
 607         bam_sample_t *sm = 0;
 608         kstring_t buf;
 609         mplp_pileup_t gplp;
 610
 611         memset(&gplp, 0, sizeof(mplp_pileup_t));
 612         memset(&buf, 0, sizeof(kstring_t));
 613         memset(&bc, 0, sizeof(bcf_call_t));
 614         data = calloc(n, sizeof(void*));
 615         plp = calloc(n, sizeof(void*));
 616         n_plp = calloc(n, sizeof(int*));
 617         sm = bam_smpl_init();
 618
 619         // read the header and initialize data
 620         for (i = 0; i < n; ++i) {
 621                 bam_header_t *h_tmp;
 622                 data[i] = calloc(1, sizeof(mplp_aux_t));
 623                 data[i]->min_mq = conf->min_mq;
 624                 data[i]->flag = conf->flag;
 625                 data[i]->capQ_thres = conf->capQ_thres;
 626                 data[i]->fp = strcmp(fn[i], "-") == 0? bam_dopen(fileno(stdin), "r") : bam_open(fn[i], "r");
 627                 h_tmp = bam_header_read(data[i]->fp);
 628                 bam_smpl_add(sm, fn[i], h_tmp->text);
 629                 if (conf->reg) {
 630                         int beg, end;
 631                         bam_index_t *idx;
 632                         idx = bam_index_load(fn[i]);
 633                         if (idx == 0) {
 634                                 fprintf(stderr, "[%s] fail to load index for %d-th input.\n", __func__, i+1);
 635                                 exit(1);
 636                         }
 637                         if (bam_parse_region(h_tmp, conf->reg, &tid, &beg, &end) < 0) {
 638                                 fprintf(stderr, "[%s] malformatted region or wrong seqname for %d-th input.\n", __func__, i+1);
 639                                 exit(1);
 640                         }
 641                         if (i == 0) beg0 = beg, end0 = end;
 642                         data[i]->iter = bam_iter_query(idx, tid, beg, end);
 643                         bam_index_destroy(idx);
 644                 }
 645                 if (i == 0) h = h_tmp;
 646                 else {
 647                         // FIXME: to check consistency
 648                         bam_header_destroy(h_tmp);
 649                 }
 650         }
 651         gplp.n = sm->n;
 652         gplp.n_plp = calloc(sm->n, sizeof(int));
 653         gplp.m_plp = calloc(sm->n, sizeof(int));
 654         gplp.plp = calloc(sm->n, sizeof(void*));
 655
 656         fprintf(stderr, "[%s] %d samples in %d input files\n", __func__, sm->n, n);
 657         if (conf->fn_pos) hash = load_pos(conf->fn_pos, h);
 658         // write the VCF header
 659         if (conf->flag & MPLP_GLF) {
 660                 kstring_t s;
 661                 bh = calloc(1, sizeof(bcf_hdr_t));
 662                 s.l = s.m = 0; s.s = 0;
 663                 bp = bcf_open("-", (conf->flag&MPLP_NO_COMP)? "wu" : "w");
 664                 for (i = 0; i < h->n_targets; ++i) {
 665                         kputs(h->target_name[i], &s);
 666                         kputc('\0', &s);
 667                 }
 668                 bh->l_nm = s.l;
 669                 bh->name = malloc(s.l);
 670                 memcpy(bh->name, s.s, s.l);
 671                 s.l = 0;
 672                 for (i = 0; i < sm->n; ++i) {
 673                         kputs(sm->smpl[i], &s); kputc('\0', &s);
 674                 }
 675                 bh->l_smpl = s.l;
 676                 bh->sname = malloc(s.l);
 677                 memcpy(bh->sname, s.s, s.l);
 678                 bh->l_txt = 0;
 679                 free(s.s);
 680                 bcf_hdr_sync(bh);
 681                 bcf_hdr_write(bp, bh);
 682                 bca = bcf_call_init(-1., conf->min_baseQ);
 683                 bcr = calloc(sm->n, sizeof(bcf_callret1_t));
 684         }
 685         ref_tid = -1; ref = 0;
 686         iter = bam_mplp_init(n, mplp_func, (void**)data);
 687         while (bam_mplp_auto(iter, &tid, &pos, n_plp, plp) > 0) {
 688                 if (conf->reg && (pos < beg0 || pos >= end0)) continue; // out of the region requested
 689                 if (hash) {
 690                         khint_t k;
 691                         k = kh_get(64, hash, (uint64_t)tid<<32 | pos);
 692                         if (k == kh_end(hash)) continue;
 693                 }
 694                 if (tid != ref_tid) {
 695                         free(ref); ref = 0;
 696                         if (conf->fai) ref = fai_fetch(conf->fai, h->target_name[tid], &ref_len);
 697                         for (i = 0; i < n; ++i) data[i]->ref = ref, data[i]->ref_id = tid;
 698                         ref_tid = tid;
 699                 }
 700                 if (conf->flag & MPLP_GLF) {
 701                         int _ref0, ref16;
 702                         bcf1_t *b = calloc(1, sizeof(bcf1_t));
 703                         group_smpl(&gplp, sm, &buf, n, fn, n_plp, plp);
 704                         _ref0 = (ref && pos < ref_len)? ref[pos] : 'N';
 705                         ref16 = bam_nt16_table[_ref0];
 706                         for (i = 0; i < gplp.n; ++i)
 707                                 bcf_call_glfgen(gplp.n_plp[i], gplp.plp[i], ref16, bca, bcr + i);
 708                         bcf_call_combine(gplp.n, bcr, ref16, &bc);
 709                         bcf_call2bcf(tid, pos, &bc, b);
 710                         bcf_write(bp, bh, b);
 711                         bcf_destroy(b);
 712                 } else {
 713                         printf("%s\t%d\t%c", h->target_name[tid], pos + 1, (ref && pos < ref_len)? ref[pos] : 'N');
 714                         for (i = 0; i < n; ++i) {
 715                                 int j;
 716                                 printf("\t%d\t", n_plp[i]);
 717                                 if (n_plp[i] == 0) printf("*\t*");
 718                                 else {
 719                                         for (j = 0; j < n_plp[i]; ++j)
 720                                                 pileup_seq(plp[i] + j, pos, ref_len, ref);
 721                                         putchar('\t');
 722                                         for (j = 0; j < n_plp[i]; ++j) {
 723                                                 const bam_pileup1_t *p = plp[i] + j;
 724                                                 int c = bam1_qual(p->b)[p->qpos] + 33;
 725                                                 if (c > 126) c = 126;
 726                                                 putchar(c);
 727                                         }
 728                                 }
 729                         }
 730                         putchar('\n');
 731                 }
 732         }
 733
 734         bcf_close(bp);
 735         bam_smpl_destroy(sm); free(buf.s);
 736         for (i = 0; i < gplp.n; ++i) free(gplp.plp[i]);
 737         free(gplp.plp); free(gplp.n_plp); free(gplp.m_plp);
 738         if (hash) { // free the hash table
 739                 khint_t k;
 740                 for (k = kh_begin(hash); k < kh_end(hash); ++k)
 741                         if (kh_exist(hash, k)) free(kh_val(hash, k));
 742                 kh_destroy(64, hash);
 743         }
 744         bcf_hdr_destroy(bh); bcf_call_destroy(bca); free(bc.PL); free(bcr);
 745         bam_mplp_destroy(iter);
 746         bam_header_destroy(h);
 747         for (i = 0; i < n; ++i) {
 748                 bam_close(data[i]->fp);
 749                 if (data[i]->iter) bam_iter_destroy(data[i]->iter);
 750                 free(data[i]);
 751         }
 752         free(data); free(plp); free(ref); free(n_plp);
 753         return 0;
 754 }
 755
 756 int bam_mpileup(int argc, char *argv[])
 757 {
 758         int c;
 759         mplp_conf_t mplp;
 760         memset(&mplp, 0, sizeof(mplp_conf_t));
 761         mplp.max_mq = 60;
 762         mplp.min_baseQ = 13;
 763         mplp.capQ_thres = 0;
 764         while ((c = getopt(argc, argv, "gf:r:l:M:q:Q:uaORC:")) >= 0) {
 765                 switch (c) {
 766                 case 'f':
 767                         mplp.fai = fai_load(optarg);
 768                         if (mplp.fai == 0) return 1;
 769                         break;
 770                 case 'r': mplp.reg = strdup(optarg); break;
 771                 case 'l': mplp.fn_pos = strdup(optarg); break;
 772                 case 'g': mplp.flag |= MPLP_GLF; break;
 773                 case 'u': mplp.flag |= MPLP_NO_COMP | MPLP_GLF; break;
 774                 case 'a': mplp.flag |= MPLP_NO_ORPHAN | MPLP_REALN; break;
 775                 case 'O': mplp.flag |= MPLP_NO_ORPHAN; break;
 776                 case 'R': mplp.flag |= MPLP_REALN; break;
 777                 case 'C': mplp.capQ_thres = atoi(optarg); break;
 778                 case 'M': mplp.max_mq = atoi(optarg); break;
 779                 case 'q': mplp.min_mq = atoi(optarg); break;
 780                 case 'Q': mplp.min_baseQ = atoi(optarg); break;
 781                 }
 782         }
 783         if (argc == 1) {
 784                 fprintf(stderr, "\n");
 785                 fprintf(stderr, "Usage:   samtools mpileup [options] in1.bam [in2.bam [...]]\n\n");
 786                 fprintf(stderr, "Options: -f FILE     reference sequence file [null]\n");
 787                 fprintf(stderr, "         -r STR      region in which pileup is generated [null]\n");
 788                 fprintf(stderr, "         -l FILE     list of positions (format: chr pos) [null]\n");
 789                 fprintf(stderr, "         -M INT      cap mapping quality at INT [%d]\n", mplp.max_mq);
 790                 fprintf(stderr, "         -Q INT      min base quality [%d]\n", mplp.min_baseQ);
 791                 fprintf(stderr, "         -q INT      filter out alignment with MQ smaller than INT [%d]\n", mplp.min_mq);
 792                 fprintf(stderr, "         -g          generate BCF output\n");
 793                 fprintf(stderr, "         -u          do not compress BCF output\n");
 794                 fprintf(stderr, "\n");
 795                 fprintf(stderr, "Notes: Assuming diploid individuals.\n\n");
 796                 return 1;
 797         }
 798         mpileup(&mplp, argc - optind, argv + optind);
 799         free(mplp.reg);
 800         if (mplp.fai) fai_destroy(mplp.fai);
 801         return 0;
 802 }