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