10 uint64_t len:32, line_len:16, line_blen:16;
13 KHASH_MAP_INIT_STR(s, faidx1_t)
19 #define ftello(fp) ftell(fp)
20 #define fseeko(fp, offset, whence) fseek(fp, offset, whence)
22 extern off_t ftello(FILE *stream);
23 extern int fseeko(FILE *stream, off_t offset, int whence);
26 #define razf_read(fp, buf, size) fread(buf, 1, size, fp)
27 #define razf_open(fn, mode) fopen(fn, mode)
28 #define razf_close(fp) fclose(fp)
29 #define razf_seek(fp, offset, whence) fseeko(fp, offset, whence)
30 #define razf_tell(fp) ftello(fp)
44 #define kroundup32(x) (--(x), (x)|=(x)>>1, (x)|=(x)>>2, (x)|=(x)>>4, (x)|=(x)>>8, (x)|=(x)>>16, ++(x))
47 static inline void fai_insert_index(faidx_t *idx, const char *name, int len, int line_len, int line_blen, uint64_t offset)
52 if (idx->n == idx->m) {
53 idx->m = idx->m? idx->m<<1 : 16;
54 idx->name = (char**)realloc(idx->name, sizeof(void*) * idx->m);
56 idx->name[idx->n] = strdup(name);
57 k = kh_put(s, idx->hash, idx->name[idx->n], &ret);
58 t.len = len; t.line_len = line_len; t.line_blen = line_blen; t.offset = offset;
59 kh_value(idx->hash, k) = t;
63 faidx_t *fai_build_core(RAZF *rz)
66 int l_name, m_name, ret;
67 int len, line_len, line_blen, state;
72 idx = (faidx_t*)calloc(1, sizeof(faidx_t));
73 idx->hash = kh_init(s);
74 name = 0; l_name = m_name = 0;
75 len = line_len = line_blen = -1; state = 0; l1 = l2 = -1; offset = 0;
76 while (razf_read(rz, &c, 1)) {
77 if (c == '\n') { // an empty line
79 offset = razf_tell(rz);
81 } else if ((state == 0 && len < 0) || state == 2) continue;
83 if (c == '>') { // fasta header
85 fai_insert_index(idx, name, len, line_len, line_blen, offset);
87 while ((ret = razf_read(rz, &c, 1)) != 0 && !isspace(c)) {
88 if (m_name < l_name + 2) {
91 name = (char*)realloc(name, m_name);
97 fprintf(stderr, "[fai_build_core] the last entry has no sequence\n");
98 free(name); fai_destroy(idx);
101 if (c != '\n') while (razf_read(rz, &c, 1) && c != '\n');
103 offset = razf_tell(rz);
106 fprintf(stderr, "[fai_build_core] inlined empty line is not allowed in sequence '%s'.\n", name);
107 free(name); fai_destroy(idx);
110 if (state == 2) state = 3;
114 if (isgraph(c)) ++l2;
115 } while ((ret = razf_read(rz, &c, 1)) && c != '\n');
116 if (state == 3 && l2) {
117 fprintf(stderr, "[fai_build_core] different line length in sequence '%s'.\n", name);
118 free(name); fai_destroy(idx);
123 fprintf(stderr, "[fai_build_core] line length exceeds 65535 in sequence '%s'.\n", name);
124 free(name); fai_destroy(idx);
127 if (state == 1) line_len = l1, line_blen = l2, state = 0;
128 else if (state == 0) {
129 if (l1 != line_len || l2 != line_blen) state = 2;
133 fai_insert_index(idx, name, len, line_len, line_blen, offset);
138 void fai_save(const faidx_t *fai, FILE *fp)
142 for (i = 0; i < fai->n; ++i) {
144 k = kh_get(s, fai->hash, fai->name[i]);
145 x = kh_value(fai->hash, k);
147 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);
149 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);
154 faidx_t *fai_read(FILE *fp)
158 int len, line_len, line_blen;
164 fai = (faidx_t*)calloc(1, sizeof(faidx_t));
165 fai->hash = kh_init(s);
166 buf = (char*)calloc(0x10000, 1);
167 while (!feof(fp) && fgets(buf, 0x10000, fp)) {
168 for (p = buf; *p && isgraph(*p); ++p);
171 sscanf(p, "%d%ld%d%d", &len, &offset, &line_blen, &line_len);
173 sscanf(p, "%d%lld%d%d", &len, &offset, &line_blen, &line_len);
175 fai_insert_index(fai, buf, len, line_len, line_blen, offset);
181 void fai_destroy(faidx_t *fai)
184 for (i = 0; i < fai->n; ++i) free(fai->name[i]);
186 kh_destroy(s, fai->hash);
187 if (fai->rz) razf_close(fai->rz);
191 int fai_build(const char *fn)
197 str = (char*)calloc(strlen(fn) + 5, 1);
198 sprintf(str, "%s.fai", fn);
199 rz = razf_open(fn, "r");
201 fprintf(stderr, "[fai_build] fail to open the FASTA file %s\n",fn);
205 fai = fai_build_core(rz);
207 fp = fopen(str, "wb");
209 fprintf(stderr, "[fai_build] fail to write FASTA index %s\n",str);
210 fai_destroy(fai); free(str);
221 FILE *download_and_open(const char *fn)
223 const int buf_size = 1 * 1024 * 1024;
227 const char *url = fn;
230 for (p = fn + l - 1; p >= fn; --p)
231 if (*p == '/') break;
234 // First try to open a local copy
239 // If failed, download from remote and open
240 fp_remote = knet_open(url, "rb");
241 if (fp_remote == 0) {
242 fprintf(stderr, "[download_from_remote] fail to open remote file %s\n",url);
245 if ((fp = fopen(fn, "wb")) == 0) {
246 fprintf(stderr, "[download_from_remote] fail to create file in the working directory %s\n",fn);
247 knet_close(fp_remote);
250 buf = (uint8_t*)calloc(buf_size, 1);
251 while ((l = knet_read(fp_remote, buf, buf_size)) != 0)
252 fwrite(buf, 1, l, fp);
255 knet_close(fp_remote);
257 return fopen(fn, "r");
261 faidx_t *fai_load(const char *fn)
266 str = (char*)calloc(strlen(fn) + 5, 1);
267 sprintf(str, "%s.fai", fn);
270 if (strstr(fn, "ftp://") == fn || strstr(fn, "http://") == fn)
272 fp = download_and_open(str);
275 fprintf(stderr, "[fai_load] failed to open remote FASTA index %s\n", str);
282 fp = fopen(str, "rb");
284 fprintf(stderr, "[fai_load] build FASTA index.\n");
286 fp = fopen(str, "rb");
288 fprintf(stderr, "[fai_load] fail to open FASTA index.\n");
297 fai->rz = razf_open(fn, "rb");
300 fprintf(stderr, "[fai_load] fail to open FASTA file.\n");
306 char *fai_fetch(const faidx_t *fai, const char *str, int *len)
318 p = s = (char*)malloc(l+1);
319 /* squeeze out "," */
320 for (i = k = 0; i != l; ++i)
321 if (str[i] != ',' && !isspace(str[i])) s[k++] = str[i];
323 for (i = 0; i != k; ++i) if (s[i] == ':') break;
325 iter = kh_get(s, h, s); /* get the ref_id */
326 if (iter == kh_end(h)) {
330 val = kh_value(h, iter);
331 if (i == k) { /* dump the whole sequence */
332 beg = 0; end = val.len;
334 for (p = s + i + 1; i != k; ++i) if (s[i] == '-') break;
339 } else end = val.len;
342 if (beg >= val.len) beg = val.len;
343 if (end >= val.len) end = val.len;
344 if (beg > end) beg = end;
347 // now retrieve the sequence
349 s = (char*)malloc(end - beg + 2);
350 razf_seek(fai->rz, val.offset + beg / val.line_blen * val.line_len + beg % val.line_blen, SEEK_SET);
351 while (razf_read(fai->rz, &c, 1) == 1 && l < end - beg && !fai->rz->z_err)
352 if (isgraph(c)) s[l++] = c;
358 int faidx_main(int argc, char *argv[])
361 fprintf(stderr, "Usage: faidx <in.fasta> [<reg> [...]]\n");
364 if (argc == 2) fai_build(argv[1]);
369 fai = fai_load(argv[1]);
370 if (fai == 0) return 1;
371 for (i = 2; i != argc; ++i) {
372 printf(">%s\n", argv[i]);
373 s = fai_fetch(fai, argv[i], &l);
374 for (j = 0; j < l; j += 60) {
375 for (k = 0; k < 60 && k < l - j; ++k)
387 int faidx_fetch_nseq(const faidx_t *fai)
392 char *faidx_fetch_seq(const faidx_t *fai, char *c_name, int p_beg_i, int p_end_i, int *len)
401 iter = kh_get(s, fai->hash, c_name);
402 if(iter == kh_end(fai->hash)) return 0;
403 val = kh_value(fai->hash, iter);
404 if(p_end_i < p_beg_i) p_beg_i = p_end_i;
405 if(p_beg_i < 0) p_beg_i = 0;
406 else if(val.len <= p_beg_i) p_beg_i = val.len - 1;
407 if(p_end_i < 0) p_end_i = 0;
408 else if(val.len <= p_end_i) p_end_i = val.len - 1;
410 // Now retrieve the sequence
412 seq = (char*)malloc(p_end_i - p_beg_i + 2);
413 razf_seek(fai->rz, val.offset + p_beg_i / val.line_blen * val.line_len + p_beg_i % val.line_blen, SEEK_SET);
414 while (razf_read(fai->rz, &c, 1) == 1 && l < p_end_i - p_beg_i + 1)
415 if (isgraph(c)) seq[l++] = c;
422 int main(int argc, char *argv[]) { return faidx_main(argc, argv); }