sam_view.c

   1 #include <stdlib.h>
   2 #include <string.h>
   3 #include <stdio.h>
   4 #include <unistd.h>
   5 #include <math.h>
   6 #include "sam_header.h"
   7 #include "sam.h"
   8 #include "faidx.h"
   9 #include "kstring.h"
  10 #include "khash.h"
  11 KHASH_SET_INIT_STR(rg)
  12
  13 // When counting records instead of printing them,
  14 // data passed to the bam_fetch callback is encapsulated in this struct.
  15 typedef struct {
  16         bam_header_t *header;
  17         int *count;
  18 } count_func_data_t;
  19
  20 typedef khash_t(rg) *rghash_t;
  21
  22 // FIXME: we'd better use no global variables...
  23 static rghash_t g_rghash = 0;
  24 static int g_min_mapQ = 0, g_flag_on = 0, g_flag_off = 0, g_qual_scale = 0;
  25 static uint32_t g_subsam_seed = 0;
  26 static double g_subsam_frac = -1.;
  27 static char *g_library, *g_rg;
  28 static void *g_bed;
  29
  30 void *bed_read(const char *fn);
  31 void bed_destroy(void *_h);
  32 int bed_overlap(const void *_h, const char *chr, int beg, int end);
  33
  34 static int process_aln(const bam_header_t *h, bam1_t *b)
  35 {
  36         if (g_qual_scale > 1) {
  37                 int i;
  38                 uint8_t *qual = bam1_qual(b);
  39                 for (i = 0; i < b->core.l_qseq; ++i) {
  40                         int c = qual[i] * g_qual_scale;
  41                         qual[i] = c < 93? c : 93;
  42                 }
  43         }
  44         if (b->core.qual < g_min_mapQ || ((b->core.flag & g_flag_on) != g_flag_on) || (b->core.flag & g_flag_off))
  45                 return 1;
  46         if (g_bed && b->core.tid >= 0 && !bed_overlap(g_bed, h->target_name[b->core.tid], b->core.pos, bam_calend(&b->core, bam1_cigar(b))))
  47                 return 1;
  48         if (g_subsam_frac > 0.) {
  49                 uint32_t k = __ac_X31_hash_string(bam1_qname(b)) + g_subsam_seed;
  50                 if ((double)(k&0xffffff) / 0x1000000 >= g_subsam_frac) return 1;
  51         }
  52         if (g_rg || g_rghash) {
  53                 uint8_t *s = bam_aux_get(b, "RG");
  54                 if (s) {
  55                         if (g_rg) return (strcmp(g_rg, (char*)(s + 1)) == 0)? 0 : 1;
  56                         if (g_rghash) {
  57                                 khint_t k = kh_get(rg, g_rghash, (char*)(s + 1));
  58                                 return (k != kh_end(g_rghash))? 0 : 1;
  59                         }
  60                 }
  61         }
  62         if (g_library) {
  63                 const char *p = bam_get_library((bam_header_t*)h, b);
  64                 return (p && strcmp(p, g_library) == 0)? 0 : 1;
  65         }
  66         return 0;
  67 }
  68
  69 static char *drop_rg(char *hdtxt, rghash_t h, int *len)
  70 {
  71         char *p = hdtxt, *q, *r, *s;
  72         kstring_t str;
  73         memset(&str, 0, sizeof(kstring_t));
  74         while (1) {
  75                 int toprint = 0;
  76                 q = strchr(p, '\n');
  77                 if (q == 0) q = p + strlen(p);
  78                 if (q - p < 3) break; // the line is too short; then stop
  79                 if (strncmp(p, "@RG\t", 4) == 0) {
  80                         int c;
  81                         khint_t k;
  82                         if ((r = strstr(p, "\tID:")) != 0) {
  83                                 r += 4;
  84                                 for (s = r; *s != '\0' && *s != '\n' && *s != '\t'; ++s);
  85                                 c = *s; *s = '\0';
  86                                 k = kh_get(rg, h, r);
  87                                 *s = c;
  88                                 if (k != kh_end(h)) toprint = 1;
  89                         }
  90                 } else toprint = 1;
  91                 if (toprint) {
  92                         kputsn(p, q - p, &str); kputc('\n', &str);
  93                 }
  94                 p = q + 1;
  95         }
  96         *len = str.l;
  97         return str.s;
  98 }
  99
 100 // callback function for bam_fetch() that prints nonskipped records
 101 static int view_func(const bam1_t *b, void *data)
 102 {
 103         if (!process_aln(((samfile_t*)data)->header, (bam1_t*)b))
 104                 samwrite((samfile_t*)data, b);
 105         return 0;
 106 }
 107
 108 // callback function for bam_fetch() that counts nonskipped records
 109 static int count_func(const bam1_t *b, void *data)
 110 {
 111         if (!process_aln(((count_func_data_t*)data)->header, (bam1_t*)b)) {
 112                 (*((count_func_data_t*)data)->count)++;
 113         }
 114         return 0;
 115 }
 116
 117 static int usage(int is_long_help);
 118
 119 int main_samview(int argc, char *argv[])
 120 {
 121         int c, is_header = 0, is_header_only = 0, is_bamin = 1, ret = 0, compress_level = -1, is_bamout = 0, is_count = 0;
 122         int of_type = BAM_OFDEC, is_long_help = 0;
 123         int count = 0;
 124         samfile_t *in = 0, *out = 0;
 125         char in_mode[5], out_mode[5], *fn_out = 0, *fn_list = 0, *fn_ref = 0, *fn_rg = 0, *q;
 126
 127         /* parse command-line options */
 128         strcpy(in_mode, "r"); strcpy(out_mode, "w");
 129         while ((c = getopt(argc, argv, "SbBct:h1Ho:q:f:F:ul:r:xX?T:R:L:s:Q:")) >= 0) {
 130                 switch (c) {
 131                 case 's':
 132                         if ((g_subsam_seed = strtol(optarg, &q, 10)) != 0) {
 133                                 srand(g_subsam_seed);
 134                                 g_subsam_seed = rand();
 135                         }
 136                         g_subsam_frac = strtod(q, &q);
 137                         break;
 138                 case 'c': is_count = 1; break;
 139                 case 'S': is_bamin = 0; break;
 140                 case 'b': is_bamout = 1; break;
 141                 case 't': fn_list = strdup(optarg); is_bamin = 0; break;
 142                 case 'h': is_header = 1; break;
 143                 case 'H': is_header_only = 1; break;
 144                 case 'o': fn_out = strdup(optarg); break;
 145                 case 'f': g_flag_on = strtol(optarg, 0, 0); break;
 146                 case 'F': g_flag_off = strtol(optarg, 0, 0); break;
 147                 case 'q': g_min_mapQ = atoi(optarg); break;
 148                 case 'u': compress_level = 0; break;
 149                 case '1': compress_level = 1; break;
 150                 case 'l': g_library = strdup(optarg); break;
 151                 case 'L': g_bed = bed_read(optarg); break;
 152                 case 'r': g_rg = strdup(optarg); break;
 153                 case 'R': fn_rg = strdup(optarg); break;
 154                 case 'x': of_type = BAM_OFHEX; break;
 155                 case 'X': of_type = BAM_OFSTR; break;
 156                 case '?': is_long_help = 1; break;
 157                 case 'T': fn_ref = strdup(optarg); is_bamin = 0; break;
 158                 case 'B': bam_no_B = 1; break;
 159                 case 'Q': g_qual_scale = atoi(optarg); break;
 160                 default: return usage(is_long_help);
 161                 }
 162         }
 163         if (compress_level >= 0) is_bamout = 1;
 164         if (is_header_only) is_header = 1;
 165         if (is_bamout) strcat(out_mode, "b");
 166         else {
 167                 if (of_type == BAM_OFHEX) strcat(out_mode, "x");
 168                 else if (of_type == BAM_OFSTR) strcat(out_mode, "X");
 169         }
 170         if (is_bamin) strcat(in_mode, "b");
 171         if (is_header) strcat(out_mode, "h");
 172         if (compress_level >= 0) {
 173                 char tmp[2];
 174                 tmp[0] = compress_level + '0'; tmp[1] = '\0';
 175                 strcat(out_mode, tmp);
 176         }
 177         if (argc == optind) return usage(is_long_help); // potential memory leak...
 178
 179         // read the list of read groups
 180         if (fn_rg) {
 181                 FILE *fp_rg;
 182                 char buf[1024];
 183                 int ret;
 184                 g_rghash = kh_init(rg);
 185                 fp_rg = fopen(fn_rg, "r");
 186                 while (!feof(fp_rg) && fscanf(fp_rg, "%s", buf) > 0) // this is not a good style, but bear me...
 187                         kh_put(rg, g_rghash, strdup(buf), &ret); // we'd better check duplicates...
 188                 fclose(fp_rg);
 189         }
 190
 191         // generate the fn_list if necessary
 192         if (fn_list == 0 && fn_ref) fn_list = samfaipath(fn_ref);
 193         // open file handlers
 194         if ((in = samopen(argv[optind], in_mode, fn_list)) == 0) {
 195                 fprintf(stderr, "[main_samview] fail to open \"%s\" for reading.\n", argv[optind]);
 196                 ret = 1;
 197                 goto view_end;
 198         }
 199         if (in->header == 0) {
 200                 fprintf(stderr, "[main_samview] fail to read the header from \"%s\".\n", argv[optind]);
 201                 ret = 1;
 202                 goto view_end;
 203         }
 204         if (g_rghash) { // FIXME: I do not know what "bam_header_t::n_text" is for...
 205                 char *tmp;
 206                 int l;
 207                 tmp = drop_rg(in->header->text, g_rghash, &l);
 208                 free(in->header->text);
 209                 in->header->text = tmp;
 210                 in->header->l_text = l;
 211         }
 212         if (!is_count && (out = samopen(fn_out? fn_out : "-", out_mode, in->header)) == 0) {
 213                 fprintf(stderr, "[main_samview] fail to open \"%s\" for writing.\n", fn_out? fn_out : "standard output");
 214                 ret = 1;
 215                 goto view_end;
 216         }
 217         if (is_header_only) goto view_end; // no need to print alignments
 218
 219         if (argc == optind + 1) { // convert/print the entire file
 220                 bam1_t *b = bam_init1();
 221                 int r;
 222                 while ((r = samread(in, b)) >= 0) { // read one alignment from `in'
 223                         if (!process_aln(in->header, b)) {
 224                                 if (!is_count) samwrite(out, b); // write the alignment to `out'
 225                                 count++;
 226                         }
 227                 }
 228                 if (r < -1) {
 229                         fprintf(stderr, "[main_samview] truncated file.\n");
 230                         ret = 1;
 231                 }
 232                 bam_destroy1(b);
 233         } else { // retrieve alignments in specified regions
 234                 int i;
 235                 bam_index_t *idx = 0;
 236                 if (is_bamin) idx = bam_index_load(argv[optind]); // load BAM index
 237                 if (idx == 0) { // index is unavailable
 238                         fprintf(stderr, "[main_samview] random alignment retrieval only works for indexed BAM files.\n");
 239                         ret = 1;
 240                         goto view_end;
 241                 }
 242                 for (i = optind + 1; i < argc; ++i) {
 243                         int tid, beg, end, result;
 244                         bam_parse_region(in->header, argv[i], &tid, &beg, &end); // parse a region in the format like `chr2:100-200'
 245                         if (tid < 0) { // reference name is not found
 246                                 fprintf(stderr, "[main_samview] region \"%s\" specifies an unknown reference name. Continue anyway.\n", argv[i]);
 247                                 continue;
 248                         }
 249                         // fetch alignments
 250                         if (is_count) {
 251                                 count_func_data_t count_data = { in->header, &count };
 252                                 result = bam_fetch(in->x.bam, idx, tid, beg, end, &count_data, count_func);
 253                         } else
 254                                 result = bam_fetch(in->x.bam, idx, tid, beg, end, out, view_func);
 255                         if (result < 0) {
 256                                 fprintf(stderr, "[main_samview] retrieval of region \"%s\" failed due to truncated file or corrupt BAM index file\n", argv[i]);
 257                                 ret = 1;
 258                                 break;
 259                         }
 260                 }
 261                 bam_index_destroy(idx); // destroy the BAM index
 262         }
 263
 264 view_end:
 265         if (is_count && ret == 0) {
 266                 printf("%d\n", count);
 267         }
 268         // close files, free and return
 269         free(fn_list); free(fn_ref); free(fn_out); free(g_library); free(g_rg); free(fn_rg);
 270         if (g_bed) bed_destroy(g_bed);
 271         if (g_rghash) {
 272                 khint_t k;
 273                 for (k = 0; k < kh_end(g_rghash); ++k)
 274                         if (kh_exist(g_rghash, k)) free((char*)kh_key(g_rghash, k));
 275                 kh_destroy(rg, g_rghash);
 276         }
 277         samclose(in);
 278         if (!is_count)
 279                 samclose(out);
 280         return ret;
 281 }
 282
 283 static int usage(int is_long_help)
 284 {
 285         fprintf(stderr, "\n");
 286         fprintf(stderr, "Usage:   samtools view [options] <in.bam>|<in.sam> [region1 [...]]\n\n");
 287         fprintf(stderr, "Options: -b       output BAM\n");
 288         fprintf(stderr, "         -h       print header for the SAM output\n");
 289         fprintf(stderr, "         -H       print header only (no alignments)\n");
 290         fprintf(stderr, "         -S       input is SAM\n");
 291         fprintf(stderr, "         -u       uncompressed BAM output (force -b)\n");
 292         fprintf(stderr, "         -1       fast compression (force -b)\n");
 293         fprintf(stderr, "         -x       output FLAG in HEX (samtools-C specific)\n");
 294         fprintf(stderr, "         -X       output FLAG in string (samtools-C specific)\n");
 295         fprintf(stderr, "         -c       print only the count of matching records\n");
 296         fprintf(stderr, "         -B       collapse the backward CIGAR operation\n");
 297         fprintf(stderr, "         -L FILE  output alignments overlapping the input BED FILE [null]\n");
 298         fprintf(stderr, "         -t FILE  list of reference names and lengths (force -S) [null]\n");
 299         fprintf(stderr, "         -T FILE  reference sequence file (force -S) [null]\n");
 300         fprintf(stderr, "         -o FILE  output file name [stdout]\n");
 301         fprintf(stderr, "         -R FILE  list of read groups to be outputted [null]\n");
 302         fprintf(stderr, "         -f INT   required flag, 0 for unset [0]\n");
 303         fprintf(stderr, "         -F INT   filtering flag, 0 for unset [0]\n");
 304         fprintf(stderr, "         -q INT   minimum mapping quality [0]\n");
 305         fprintf(stderr, "         -l STR   only output reads in library STR [null]\n");
 306         fprintf(stderr, "         -r STR   only output reads in read group STR [null]\n");
 307         fprintf(stderr, "         -s FLOAT fraction of templates to subsample; integer part as seed [-1]\n");
 308         fprintf(stderr, "         -?       longer help\n");
 309         fprintf(stderr, "\n");
 310         if (is_long_help)
 311                 fprintf(stderr, "Notes:\n\
 312 \n\
 313   1. By default, this command assumes the file on the command line is in\n\
 314      the BAM format and it prints the alignments in SAM. If `-t' is\n\
 315      applied, the input file is assumed to be in the SAM format. The\n\
 316      file supplied with `-t' is SPACE/TAB delimited with the first two\n\
 317      fields of each line consisting of the reference name and the\n\
 318      corresponding sequence length. The `.fai' file generated by `faidx'\n\
 319      can be used here. This file may be empty if reads are unaligned.\n\
 320 \n\
 321   2. SAM->BAM conversion: `samtools view -bT ref.fa in.sam.gz'.\n\
 322 \n\
 323   3. BAM->SAM conversion: `samtools view in.bam'.\n\
 324 \n\
 325   4. A region should be presented in one of the following formats:\n\
 326      `chr1', `chr2:1,000' and `chr3:1000-2,000'. When a region is\n\
 327      specified, the input alignment file must be an indexed BAM file.\n\
 328 \n\
 329   5. Option `-u' is preferred over `-b' when the output is piped to\n\
 330      another samtools command.\n\
 331 \n\
 332   6. In a string FLAG, each character represents one bit with\n\
 333      p=0x1 (paired), P=0x2 (properly paired), u=0x4 (unmapped),\n\
 334      U=0x8 (mate unmapped), r=0x10 (reverse), R=0x20 (mate reverse)\n\
 335      1=0x40 (first), 2=0x80 (second), s=0x100 (not primary), \n\
 336      f=0x200 (failure) and d=0x400 (duplicate). Note that `-x' and\n\
 337      `-X' are samtools-C specific. Picard and older samtools do not\n\
 338      support HEX or string flags.\n\
 339 \n");
 340         return 1;
 341 }
 342
 343 int main_import(int argc, char *argv[])
 344 {
 345         int argc2, ret;
 346         char **argv2;
 347         if (argc != 4) {
 348                 fprintf(stderr, "Usage: bamtk import <in.ref_list> <in.sam> <out.bam>\n");
 349                 return 1;
 350         }
 351         argc2 = 6;
 352         argv2 = calloc(6, sizeof(char*));
 353         argv2[0] = "import", argv2[1] = "-o", argv2[2] = argv[3], argv2[3] = "-bt", argv2[4] = argv[1], argv2[5] = argv[2];
 354         ret = main_samview(argc2, argv2);
 355         free(argv2);
 356         return ret;
 357 }
 358
 359 int8_t seq_comp_table[16] = { 0, 8, 4, 12, 2, 10, 9, 14, 1, 6, 5, 13, 3, 11, 7, 15 };
 360
 361 int main_bam2fq(int argc, char *argv[])
 362 {
 363         bamFile fp;
 364         bam_header_t *h;
 365         bam1_t *b;
 366         int8_t *buf;
 367         int max_buf;
 368         if (argc == 1) {
 369                 fprintf(stderr, "Usage: samtools bam2fq <in.bam>\n");
 370                 return 1;
 371         }
 372         fp = strcmp(argv[1], "-")? bam_open(argv[1], "r") : bam_dopen(fileno(stdin), "r");
 373         if (fp == 0) return 1;
 374         h = bam_header_read(fp);
 375         b = bam_init1();
 376         buf = 0;
 377         max_buf = 0;
 378         while (bam_read1(fp, b) >= 0) {
 379                 int i, qlen = b->core.l_qseq;
 380                 uint8_t *seq;
 381                 putchar('@'); fputs(bam1_qname(b), stdout);
 382                 if ((b->core.flag & 0x40) && !(b->core.flag & 0x80)) puts("/1");
 383                 else if ((b->core.flag & 0x80) && !(b->core.flag & 0x40)) puts("/2");
 384                 else putchar('\n');
 385                 if (max_buf < qlen + 1) {
 386                         max_buf = qlen + 1;
 387                         kroundup32(max_buf);
 388                         buf = realloc(buf, max_buf);
 389                 }
 390                 buf[qlen] = 0;
 391                 seq = bam1_seq(b);
 392                 for (i = 0; i < qlen; ++i)
 393                         buf[i] = bam1_seqi(seq, i);
 394                 if (b->core.flag & 16) { // reverse complement
 395                         for (i = 0; i < qlen>>1; ++i) {
 396                                 int8_t t = seq_comp_table[buf[qlen - 1 - i]];
 397                                 buf[qlen - 1 - i] = seq_comp_table[buf[i]];
 398                                 buf[i] = t;
 399                         }
 400                         if (qlen&1) buf[i] = seq_comp_table[buf[i]];
 401                 }
 402                 for (i = 0; i < qlen; ++i)
 403                         buf[i] = bam_nt16_rev_table[buf[i]];
 404                 puts((char*)buf);
 405                 puts("+");
 406                 seq = bam1_qual(b);
 407                 for (i = 0; i < qlen; ++i)
 408                         buf[i] = 33 + seq[i];
 409                 if (b->core.flag & 16) { // reverse
 410                         for (i = 0; i < qlen>>1; ++i) {
 411                                 int8_t t = buf[qlen - 1 - i];
 412                                 buf[qlen - 1 - i] = buf[i];
 413                                 buf[i] = t;
 414                         }
 415                 }
 416                 puts((char*)buf);
 417         }
 418         free(buf);
 419         bam_destroy1(b);
 420         bam_header_destroy(h);
 421         bam_close(fp);
 422         return 0;
 423 }