Merge commit 'upstream/0.1.7a.dfsg'
[samtools.git] / 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
10 static int g_min_mapQ = 0, g_flag_on = 0, g_flag_off = 0;
11 static char *g_library, *g_rg;
12 static int g_sol2sanger_tbl[128];
13
14 static void sol2sanger(bam1_t *b)
15 {
16         int l;
17         uint8_t *qual = bam1_qual(b);
18         if (g_sol2sanger_tbl[30] == 0) {
19                 for (l = 0; l != 128; ++l) {
20                         g_sol2sanger_tbl[l] = (int)(10.0 * log(1.0 + pow(10.0, (l - 64 + 33) / 10.0)) / log(10.0) + .499);
21                         if (g_sol2sanger_tbl[l] >= 93) g_sol2sanger_tbl[l] = 93;
22                 }
23         }
24         for (l = 0; l < b->core.l_qseq; ++l) {
25                 int q = qual[l];
26                 if (q > 127) q = 127;
27                 qual[l] = g_sol2sanger_tbl[q];
28         }
29 }
30
31 static inline int __g_skip_aln(const bam_header_t *h, const bam1_t *b)
32 {
33         if (b->core.qual < g_min_mapQ || ((b->core.flag & g_flag_on) != g_flag_on) || (b->core.flag & g_flag_off))
34                 return 1;
35         if (g_rg) {
36                 uint8_t *s = bam_aux_get(b, "RG");
37                 if (s && strcmp(g_rg, (char*)(s + 1)) == 0) return 0;
38         }
39         if (g_library) {
40                 const char *p = bam_get_library((bam_header_t*)h, b);
41                 return (p && strcmp(p, g_library) == 0)? 0 : 1;
42         }
43         return 0;
44 }
45
46 // callback function for bam_fetch()
47 static int view_func(const bam1_t *b, void *data)
48 {
49         if (!__g_skip_aln(((samfile_t*)data)->header, b))
50                 samwrite((samfile_t*)data, b);
51         return 0;
52 }
53
54 static int usage(int is_long_help);
55
56 int main_samview(int argc, char *argv[])
57 {
58         int c, is_header = 0, is_header_only = 0, is_bamin = 1, ret = 0, is_uncompressed = 0, is_bamout = 0, slx2sngr = 0;
59         int of_type = BAM_OFDEC, is_long_help = 0;
60         samfile_t *in = 0, *out = 0;
61         char in_mode[5], out_mode[5], *fn_out = 0, *fn_list = 0, *fn_ref = 0;
62
63         /* parse command-line options */
64         strcpy(in_mode, "r"); strcpy(out_mode, "w");
65         while ((c = getopt(argc, argv, "Sbt:hHo:q:f:F:ul:r:xX?T:C")) >= 0) {
66                 switch (c) {
67                 case 'C': slx2sngr = 1; break;
68                 case 'S': is_bamin = 0; break;
69                 case 'b': is_bamout = 1; break;
70                 case 't': fn_list = strdup(optarg); is_bamin = 0; break;
71                 case 'h': is_header = 1; break;
72                 case 'H': is_header_only = 1; break;
73                 case 'o': fn_out = strdup(optarg); break;
74                 case 'f': g_flag_on = strtol(optarg, 0, 0); break;
75                 case 'F': g_flag_off = strtol(optarg, 0, 0); break;
76                 case 'q': g_min_mapQ = atoi(optarg); break;
77                 case 'u': is_uncompressed = 1; break;
78                 case 'l': g_library = strdup(optarg); break;
79                 case 'r': g_rg = strdup(optarg); break;
80                 case 'x': of_type = BAM_OFHEX; break;
81                 case 'X': of_type = BAM_OFSTR; break;
82                 case '?': is_long_help = 1; break;
83                 case 'T': fn_ref = strdup(optarg); is_bamin = 0; break;
84                 default: return usage(is_long_help);
85                 }
86         }
87         if (is_uncompressed) is_bamout = 1;
88         if (is_header_only) is_header = 1;
89         if (is_bamout) strcat(out_mode, "b");
90         else {
91                 if (of_type == BAM_OFHEX) strcat(out_mode, "x");
92                 else if (of_type == BAM_OFSTR) strcat(out_mode, "X");
93         }
94         if (is_bamin) strcat(in_mode, "b");
95         if (is_header) strcat(out_mode, "h");
96         if (is_uncompressed) strcat(out_mode, "u");
97         if (argc == optind) return usage(is_long_help);
98
99         // generate the fn_list if necessary
100         if (fn_list == 0 && fn_ref) fn_list = samfaipath(fn_ref);
101         // open file handlers
102         if ((in = samopen(argv[optind], in_mode, fn_list)) == 0) {
103                 fprintf(stderr, "[main_samview] fail to open file for reading.\n");
104                 goto view_end;
105         }
106         if (in->header == 0) {
107                 fprintf(stderr, "[main_samview] fail to read the header.\n");
108                 goto view_end;
109         }
110         if ((out = samopen(fn_out? fn_out : "-", out_mode, in->header)) == 0) {
111                 fprintf(stderr, "[main_samview] fail to open file for writing.\n");
112                 goto view_end;
113         }
114         if (is_header_only) goto view_end; // no need to print alignments
115
116         if (argc == optind + 1) { // convert/print the entire file
117                 bam1_t *b = bam_init1();
118                 int r;
119                 while ((r = samread(in, b)) >= 0) { // read one alignment from `in'
120                         if (!__g_skip_aln(in->header, b)) {
121                                 if (slx2sngr) sol2sanger(b);
122                                 samwrite(out, b); // write the alignment to `out'
123                         }
124                 }
125                 if (r < -1) fprintf(stderr, "[main_samview] truncated file.\n");
126                 bam_destroy1(b);
127         } else { // retrieve alignments in specified regions
128                 int i;
129                 bam_index_t *idx = 0;
130                 if (is_bamin) idx = bam_index_load(argv[optind]); // load BAM index
131                 if (idx == 0) { // index is unavailable
132                         fprintf(stderr, "[main_samview] random alignment retrieval only works for indexed BAM files.\n");
133                         ret = 1;
134                         goto view_end;
135                 }
136                 for (i = optind + 1; i < argc; ++i) {
137                         int tid, beg, end;
138                         bam_parse_region(in->header, argv[i], &tid, &beg, &end); // parse a region in the format like `chr2:100-200'
139                         if (tid < 0) { // reference name is not found
140                                 fprintf(stderr, "[main_samview] fail to get the reference name. Continue anyway.\n");
141                                 continue;
142                         }
143                         bam_fetch(in->x.bam, idx, tid, beg, end, out, view_func); // fetch alignments
144                 }
145                 bam_index_destroy(idx); // destroy the BAM index
146         }
147
148 view_end:
149         // close files, free and return
150         free(fn_list); free(fn_ref); free(fn_out); free(g_library); free(g_rg);
151         samclose(in);
152         samclose(out);
153         return ret;
154 }
155
156 static int usage(int is_long_help)
157 {
158         fprintf(stderr, "\n");
159         fprintf(stderr, "Usage:   samtools view [options] <in.bam>|<in.sam> [region1 [...]]\n\n");
160         fprintf(stderr, "Options: -b       output BAM\n");
161         fprintf(stderr, "         -h       print header for the SAM output\n");
162         fprintf(stderr, "         -H       print header only (no alignments)\n");
163         fprintf(stderr, "         -S       input is SAM\n");
164         fprintf(stderr, "         -u       uncompressed BAM output (force -b)\n");
165         fprintf(stderr, "         -x       output FLAG in HEX (samtools-C specific)\n");
166         fprintf(stderr, "         -X       output FLAG in string (samtools-C specific)\n");
167         fprintf(stderr, "         -t FILE  list of reference names and lengths (force -S) [null]\n");
168         fprintf(stderr, "         -T FILE  reference sequence file (force -S) [null]\n");
169         fprintf(stderr, "         -o FILE  output file name [stdout]\n");
170         fprintf(stderr, "         -f INT   required flag, 0 for unset [0]\n");
171         fprintf(stderr, "         -F INT   filtering flag, 0 for unset [0]\n");
172         fprintf(stderr, "         -q INT   minimum mapping quality [0]\n");
173         fprintf(stderr, "         -l STR   only output reads in library STR [null]\n");
174         fprintf(stderr, "         -r STR   only output reads in read group STR [null]\n");
175         fprintf(stderr, "         -?       longer help\n");
176         fprintf(stderr, "\n");
177         if (is_long_help)
178                 fprintf(stderr, "Notes:\n\
179 \n\
180   1. By default, this command assumes the file on the command line is in\n\
181      the BAM format and it prints the alignments in SAM. If `-t' is\n\
182      applied, the input file is assumed to be in the SAM format. The\n\
183      file supplied with `-t' is SPACE/TAB delimited with the first two\n\
184      fields of each line consisting of the reference name and the\n\
185      corresponding sequence length. The `.fai' file generated by `faidx'\n\
186      can be used here. This file may be empty if reads are unaligned.\n\
187 \n\
188   2. SAM->BAM conversion: `samtools view -bT ref.fa in.sam.gz'.\n\
189 \n\
190   3. BAM->SAM conversion: `samtools view in.bam'.\n\
191 \n\
192   4. A region should be presented in one of the following formats:\n\
193      `chr1', `chr2:1,000' and `chr3:1000-2,000'. When a region is\n\
194      specified, the input alignment file must be an indexed BAM file.\n\
195 \n\
196   5. Option `-u' is preferred over `-b' when the output is piped to\n\
197      another samtools command.\n\
198 \n\
199   6. In a string FLAG, each character represents one bit with\n\
200      p=0x1 (paired), P=0x2 (properly paired), u=0x4 (unmapped),\n\
201      U=0x8 (mate unmapped), r=0x10 (reverse), R=0x20 (mate reverse)\n\
202      1=0x40 (first), 2=0x80 (second), s=0x100 (not primary), \n\
203      f=0x200 (failure) and d=0x400 (duplicate). Note that `-x' and\n\
204      `-X' are samtools-C specific. Picard and older samtools do not\n\
205      support HEX or string flags.\n\
206 \n");
207         return 1;
208 }
209
210 int main_import(int argc, char *argv[])
211 {
212         int argc2, ret;
213         char **argv2;
214         if (argc != 4) {
215                 fprintf(stderr, "Usage: bamtk import <in.ref_list> <in.sam> <out.bam>\n");
216                 return 1;
217         }
218         argc2 = 6;
219         argv2 = calloc(6, sizeof(char*));
220         argv2[0] = "import", argv2[1] = "-o", argv2[2] = argv[3], argv2[3] = "-bt", argv2[4] = argv[1], argv2[5] = argv[2];
221         ret = main_samview(argc2, argv2);
222         free(argv2);
223         return ret;
224 }