sam_view.c

   1 #include <stdlib.h>
   2 #include <string.h>
   3 #include <stdio.h>
   4 #include <unistd.h>
   5 #include "sam.h"
   6
   7 static int g_min_mapQ = 0, g_flag_on = 0, g_flag_off = 0;
   8
   9 #define __g_skip_aln(b) (((b)->core.qual < g_min_mapQ) || ((b->core.flag & g_flag_on) != g_flag_on) \
  10                                                  || (b->core.flag & g_flag_off))
  11
  12 // callback function for bam_fetch()
  13 static int view_func(const bam1_t *b, void *data)
  14 {
  15         if (!__g_skip_aln(b)) samwrite((samfile_t*)data, b);
  16         return 0;
  17 }
  18
  19 static int usage(void);
  20
  21 int main_samview(int argc, char *argv[])
  22 {
  23         int c, is_header = 0, is_header_only = 0, is_bamin = 1, ret = 0, is_uncompressed = 0, is_bamout = 0;
  24         samfile_t *in = 0, *out = 0;
  25         char in_mode[5], out_mode[5], *fn_out = 0, *fn_list = 0;
  26
  27         /* parse command-line options */
  28         strcpy(in_mode, "r"); strcpy(out_mode, "w");
  29         while ((c = getopt(argc, argv, "Sbt:hHo:q:f:F:u")) >= 0) {
  30                 switch (c) {
  31                 case 'S': is_bamin = 0; break;
  32                 case 'b': is_bamout = 1; break;
  33                 case 't': fn_list = strdup(optarg); is_bamin = 0; break;
  34                 case 'h': is_header = 1; break;
  35                 case 'H': is_header_only = 1; break;
  36                 case 'o': fn_out = strdup(optarg); break;
  37                 case 'f': g_flag_on = strtol(optarg, 0, 0); break;
  38                 case 'F': g_flag_off = strtol(optarg, 0, 0); break;
  39                 case 'q': g_min_mapQ = atoi(optarg); break;
  40                 case 'u': is_uncompressed = 1; break;
  41                 default: return usage();
  42                 }
  43         }
  44         if (is_uncompressed) is_bamout = 1;
  45         if (is_header_only) is_header = 1;
  46         if (is_bamout) strcat(out_mode, "b");
  47         if (is_bamin) strcat(in_mode, "b");
  48         if (is_header) strcat(out_mode, "h");
  49         if (is_uncompressed) strcat(out_mode, "u");
  50         if (argc == optind) return usage();
  51
  52         // open file handlers
  53         if ((in = samopen(argv[optind], in_mode, fn_list)) == 0) {
  54                 fprintf(stderr, "[main_samview] fail to open file for reading.\n");
  55                 goto view_end;
  56         }
  57         if ((out = samopen(fn_out? fn_out : "-", out_mode, in->header)) == 0) {
  58                 fprintf(stderr, "[main_samview] fail to open file for writing.\n");
  59                 goto view_end;
  60         }
  61         if (is_header_only) goto view_end; // no need to print alignments
  62
  63         if (argc == optind + 1) { // convert/print the entire file
  64                 bam1_t *b = bam_init1();
  65                 int r;
  66                 while ((r = samread(in, b)) >= 0) // read one alignment from `in'
  67                         if (!__g_skip_aln(b))
  68                                 samwrite(out, b); // write the alignment to `out'
  69                 if (r < -1) fprintf(stderr, "[main_samview] truncated file.\n");
  70                 bam_destroy1(b);
  71         } else { // retrieve alignments in specified regions
  72                 int i;
  73                 bam_index_t *idx = 0;
  74                 if (is_bamin) idx = bam_index_load(argv[optind]); // load BAM index
  75                 if (idx == 0) { // index is unavailable
  76                         fprintf(stderr, "[main_samview] random alignment retrieval only works for indexed BAM files.\n");
  77                         ret = 1;
  78                         goto view_end;
  79                 }
  80                 for (i = optind + 1; i < argc; ++i) {
  81                         int tid, beg, end;
  82                         bam_parse_region(in->header, argv[i], &tid, &beg, &end); // parse a region in the format like `chr2:100-200'
  83                         if (tid < 0) { // reference name is not found
  84                                 fprintf(stderr, "[main_samview] fail to get the reference name. Continue anyway.\n");
  85                                 continue;
  86                         }
  87                         bam_fetch(in->x.bam, idx, tid, beg, end, out, view_func); // fetch alignments
  88                 }
  89                 bam_index_destroy(idx); // destroy the BAM index
  90         }
  91
  92 view_end:
  93         // close files, free and return
  94         free(fn_list); free(fn_out);
  95         samclose(in);
  96         samclose(out);
  97         return ret;
  98 }
  99
 100 static int usage()
 101 {
 102         fprintf(stderr, "\n");
 103         fprintf(stderr, "Usage:   samtools view [options] <in.bam>|<in.sam> [region1 [...]]\n\n");
 104         fprintf(stderr, "Options: -b       output BAM\n");
 105         fprintf(stderr, "         -h       print header for the SAM output\n");
 106         fprintf(stderr, "         -H       print header only (no alignments)\n");
 107         fprintf(stderr, "         -S       input is SAM\n");
 108         fprintf(stderr, "         -u       uncompressed BAM output (force -b)\n");
 109         fprintf(stderr, "         -t FILE  list of reference names and lengths (force -S) [null]\n");
 110         fprintf(stderr, "         -o FILE  output file name [stdout]\n");
 111         fprintf(stderr, "         -f INT   required flag, 0 for unset [0]\n");
 112         fprintf(stderr, "         -F INT   filtering flag, 0 for unset [0]\n");
 113         fprintf(stderr, "         -q INT   minimum mapping quality [0]\n");
 114         fprintf(stderr, "\n\
 115 Notes:\n\
 116 \n\
 117   1. By default, this command assumes the file on the command line is in\n\
 118      the BAM format and it prints the alignments in SAM. If `-t' is\n\
 119      applied, the input file is assumed to be in the SAM format. The\n\
 120      file supplied with `-t' is SPACE/TAB delimited with the first two\n\
 121      fields of each line consisting of the reference name and the\n\
 122      corresponding sequence length. The `.fai' file generated by `faidx'\n\
 123      can be used here. This file may be empty if reads are unaligned.\n\
 124 \n\
 125   2. SAM->BAM conversion: `samtools view -bt ref.fa.fai in.sam.gz'.\n\
 126 \n\
 127   3. BAM->SAM conversion: `samtools view in.bam'.\n\
 128 \n\
 129   4. A region should be presented in one of the following formats:\n\
 130      `chr1', `chr2:1,000' and `chr3:1000-2,000'. When a region is\n\
 131      specified, the input alignment file must be an indexed BAM file.\n\
 132 \n");
 133         return 1;
 134 }
 135
 136 int main_import(int argc, char *argv[])
 137 {
 138         int argc2, ret;
 139         char **argv2;
 140         if (argc != 4) {
 141                 fprintf(stderr, "Usage: bamtk import <in.ref_list> <in.sam> <out.bam>\n");
 142                 return 1;
 143         }
 144         argc2 = 6;
 145         argv2 = calloc(6, sizeof(char*));
 146         argv2[0] = "import", argv2[1] = "-o", argv2[2] = argv[3], argv2[3] = "-bt", argv2[4] = argv[1], argv2[5] = argv[2];
 147         ret = main_samview(argc2, argv2);
 148         free(argv2);
 149         return ret;
 150 }