9 uint64_t len:32, line_len:16, line_blen:16;
12 KHASH_MAP_INIT_STR(s, faidx1_t)
18 #define ftello(fp) ftell(fp)
19 #define fseeko(fp, offset, whence) fseek(fp, offset, whence)
21 extern off_t ftello(FILE *stream);
22 extern int fseeko(FILE *stream, off_t offset, int whence);
25 #define razf_read(fp, buf, size) fread(buf, 1, size, fp)
26 #define razf_open(fn, mode) fopen(fn, mode)
27 #define razf_close(fp) fclose(fp)
28 #define razf_seek(fp, offset, whence) fseeko(fp, offset, whence)
29 #define razf_tell(fp) ftello(fp)
43 #define kroundup32(x) (--(x), (x)|=(x)>>1, (x)|=(x)>>2, (x)|=(x)>>4, (x)|=(x)>>8, (x)|=(x)>>16, ++(x))
46 static inline void fai_insert_index(faidx_t *idx, const char *name, int len, int line_len, int line_blen, uint64_t offset)
51 if (idx->n == idx->m) {
52 idx->m = idx->m? idx->m<<1 : 16;
53 idx->name = (char**)realloc(idx->name, sizeof(void*) * idx->m);
55 idx->name[idx->n] = strdup(name);
56 k = kh_put(s, idx->hash, idx->name[idx->n], &ret);
57 t.len = len; t.line_len = line_len; t.line_blen = line_blen; t.offset = offset;
58 kh_value(idx->hash, k) = t;
62 faidx_t *fai_build_core(RAZF *rz)
65 int l_name, m_name, ret;
66 int len, line_len, line_blen, state;
71 idx = (faidx_t*)calloc(1, sizeof(faidx_t));
72 idx->hash = kh_init(s);
73 name = 0; l_name = m_name = 0;
74 len = line_len = line_blen = -1; state = 0; l1 = l2 = -1; offset = 0;
75 while (razf_read(rz, &c, 1)) {
76 if (c == '\n') { // an empty line
78 offset = razf_tell(rz);
80 } else if ((state == 0 && len < 0) || state == 2) continue;
82 if (c == '>') { // fasta header
84 fai_insert_index(idx, name, len, line_len, line_blen, offset);
86 while ((ret = razf_read(rz, &c, 1)) != 0 && !isspace(c)) {
87 if (m_name < l_name + 2) {
90 name = (char*)realloc(name, m_name);
96 fprintf(stderr, "[fai_build_core] the last entry has no sequence\n");
97 free(name); fai_destroy(idx);
100 if (c != '\n') while (razf_read(rz, &c, 1) && c != '\n');
102 offset = razf_tell(rz);
105 fprintf(stderr, "[fai_build_core] inlined empty line is not allowed in sequence '%s'.\n", name);
106 free(name); fai_destroy(idx);
109 if (state == 2) state = 3;
113 if (isgraph(c)) ++l2;
114 } while ((ret = razf_read(rz, &c, 1)) && c != '\n');
115 if (state == 3 && l2) {
116 fprintf(stderr, "[fai_build_core] different line length in sequence '%s'.\n", name);
117 free(name); fai_destroy(idx);
122 fprintf(stderr, "[fai_build_core] line length exceeds 65535 in sequence '%s'.\n", name);
123 free(name); fai_destroy(idx);
126 if (state == 1) line_len = l1, line_blen = l2, state = 0;
127 else if (state == 0) {
128 if (l1 != line_len || l2 != line_blen) state = 2;
132 fai_insert_index(idx, name, len, line_len, line_blen, offset);
137 void fai_save(const faidx_t *fai, FILE *fp)
141 for (i = 0; i < fai->n; ++i) {
143 k = kh_get(s, fai->hash, fai->name[i]);
144 x = kh_value(fai->hash, k);
146 fprintf(fp, "%s\t%d\t%ld\t%d\t%d\n", fai->name[i], (int)x.len, (long)x.offset, (int)x.line_blen, (int)x.line_len);
148 fprintf(fp, "%s\t%d\t%lld\t%d\t%d\n", fai->name[i], (int)x.len, (long long)x.offset, (int)x.line_blen, (int)x.line_len);
153 faidx_t *fai_read(FILE *fp)
157 int len, line_len, line_blen;
163 fai = (faidx_t*)calloc(1, sizeof(faidx_t));
164 fai->hash = kh_init(s);
165 buf = (char*)calloc(0x10000, 1);
166 while (!feof(fp) && fgets(buf, 0x10000, fp)) {
167 for (p = buf; *p && isgraph(*p); ++p);
170 sscanf(p, "%d%ld%d%d", &len, &offset, &line_blen, &line_len);
172 sscanf(p, "%d%lld%d%d", &len, &offset, &line_blen, &line_len);
174 fai_insert_index(fai, buf, len, line_len, line_blen, offset);
180 void fai_destroy(faidx_t *fai)
183 for (i = 0; i < fai->n; ++i) free(fai->name[i]);
185 kh_destroy(s, fai->hash);
186 if (fai->rz) razf_close(fai->rz);
190 int fai_build(const char *fn)
196 str = (char*)calloc(strlen(fn) + 5, 1);
197 sprintf(str, "%s.fai", fn);
198 rz = razf_open(fn, "r");
200 fprintf(stderr, "[fai_build] fail to open the FASTA file %s\n",fn);
204 fai = fai_build_core(rz);
206 fp = fopen(str, "wb");
208 fprintf(stderr, "[fai_build] fail to write FASTA index %s\n",str);
209 fai_destroy(fai); free(str);
220 FILE *download_and_open(const char *fn)
222 const int buf_size = 1 * 1024 * 1024;
226 const char *url = fn;
229 for (p = fn + l - 1; p >= fn; --p)
230 if (*p == '/') break;
233 // First try to open a local copy
238 // If failed, download from remote and open
239 fp_remote = knet_open(url, "rb");
240 if (fp_remote == 0) {
241 fprintf(stderr, "[download_from_remote] fail to open remote file %s\n",url);
244 if ((fp = fopen(fn, "wb")) == 0) {
245 fprintf(stderr, "[download_from_remote] fail to create file in the working directory %s\n",fn);
246 knet_close(fp_remote);
249 buf = (uint8_t*)calloc(buf_size, 1);
250 while ((l = knet_read(fp_remote, buf, buf_size)) != 0)
251 fwrite(buf, 1, l, fp);
254 knet_close(fp_remote);
256 return fopen(fn, "r");
260 faidx_t *fai_load(const char *fn)
265 str = (char*)calloc(strlen(fn) + 5, 1);
266 sprintf(str, "%s.fai", fn);
269 if (strstr(fn, "ftp://") == fn || strstr(fn, "http://") == fn)
271 fp = download_and_open(str);
274 fprintf(stderr, "[fai_load] failed to open remote FASTA index %s\n", str);
281 fp = fopen(str, "rb");
283 fprintf(stderr, "[fai_load] build FASTA index.\n");
285 fp = fopen(str, "rb");
287 fprintf(stderr, "[fai_load] fail to open FASTA index.\n");
296 fai->rz = razf_open(fn, "rb");
299 fprintf(stderr, "[fai_load] fail to open FASTA file.\n");
305 char *fai_fetch(const faidx_t *fai, const char *str, int *len)
317 p = s = (char*)malloc(l+1);
318 /* squeeze out "," */
319 for (i = k = 0; i != l; ++i)
320 if (str[i] != ',' && !isspace(str[i])) s[k++] = str[i];
322 for (i = 0; i != k; ++i) if (s[i] == ':') break;
324 iter = kh_get(s, h, s); /* get the ref_id */
325 if (iter == kh_end(h)) {
329 val = kh_value(h, iter);
330 if (i == k) { /* dump the whole sequence */
331 beg = 0; end = val.len;
333 for (p = s + i + 1; i != k; ++i) if (s[i] == '-') break;
338 } else end = val.len;
341 if (beg >= val.len) beg = val.len;
342 if (end >= val.len) end = val.len;
343 if (beg > end) beg = end;
346 // now retrieve the sequence
348 s = (char*)malloc(end - beg + 2);
349 razf_seek(fai->rz, val.offset + beg / val.line_blen * val.line_len + beg % val.line_blen, SEEK_SET);
350 while (razf_read(fai->rz, &c, 1) == 1 && l < end - beg && !fai->rz->z_err)
351 if (isgraph(c)) s[l++] = c;
357 int faidx_main(int argc, char *argv[])
360 fprintf(stderr, "Usage: faidx <in.fasta> [<reg> [...]]\n");
363 if (argc == 2) fai_build(argv[1]);
368 fai = fai_load(argv[1]);
369 if (fai == 0) return 1;
370 for (i = 2; i != argc; ++i) {
371 printf(">%s\n", argv[i]);
372 s = fai_fetch(fai, argv[i], &l);
373 for (j = 0; j < l; j += 60) {
374 for (k = 0; k < 60 && k < l - j; ++k)
386 int faidx_fetch_nseq(const faidx_t *fai)
391 char *faidx_fetch_seq(const faidx_t *fai, char *c_name, int p_beg_i, int p_end_i, int *len)
400 iter = kh_get(s, fai->hash, c_name);
401 if(iter == kh_end(fai->hash)) return 0;
402 val = kh_value(fai->hash, iter);
403 if(p_end_i < p_beg_i) p_beg_i = p_end_i;
404 if(p_beg_i < 0) p_beg_i = 0;
405 else if(val.len <= p_beg_i) p_beg_i = val.len - 1;
406 if(p_end_i < 0) p_end_i = 0;
407 else if(val.len <= p_end_i) p_end_i = val.len - 1;
409 // Now retrieve the sequence
411 seq = (char*)malloc(p_end_i - p_beg_i + 2);
412 razf_seek(fai->rz, val.offset + p_beg_i / val.line_blen * val.line_len + p_beg_i % val.line_blen, SEEK_SET);
413 while (razf_read(fai->rz, &c, 1) == 1 && l < p_end_i - p_beg_i + 1)
414 if (isgraph(c)) seq[l++] = c;
421 int main(int argc, char *argv[]) { return faidx_main(argc, argv); }