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