samtools/sam_view.c.pysam.c

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