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