bcftools/bcf.c

   1 #include <string.h>
   2 #include <ctype.h>
   3 #include <stdio.h>
   4 #include "kstring.h"
   5 #include "bcf.h"
   6
   7 bcf_t *bcf_open(const char *fn, const char *mode)
   8 {
   9         bcf_t *b;
  10         b = calloc(1, sizeof(bcf_t));
  11         if (strchr(mode, 'w')) {
  12                 b->fp = strcmp(fn, "-")? bgzf_open(fn, mode) : bgzf_fdopen(fileno(stdout), mode);
  13         } else {
  14                 b->fp = strcmp(fn, "-")? bgzf_open(fn, mode) : bgzf_fdopen(fileno(stdin), mode);
  15         }
  16 #ifndef BCF_LITE
  17         b->fp->owned_file = 1;
  18 #endif
  19         return b;
  20 }
  21
  22 int bcf_close(bcf_t *b)
  23 {
  24         int ret;
  25         if (b == 0) return 0;
  26         ret = bgzf_close(b->fp);
  27         free(b);
  28         return ret;
  29 }
  30
  31 int bcf_hdr_write(bcf_t *b, const bcf_hdr_t *h)
  32 {
  33         if (b == 0 || h == 0) return -1;
  34         bgzf_write(b->fp, "BCF\4", 4);
  35         bgzf_write(b->fp, &h->l_nm, 4);
  36         bgzf_write(b->fp, h->name, h->l_nm);
  37         bgzf_write(b->fp, &h->l_smpl, 4);
  38         bgzf_write(b->fp, h->sname, h->l_smpl);
  39         bgzf_write(b->fp, &h->l_txt, 4);
  40         bgzf_write(b->fp, h->txt, h->l_txt);
  41         bgzf_flush(b->fp);
  42         return 16 + h->l_nm + h->l_smpl + h->l_txt;
  43 }
  44
  45 bcf_hdr_t *bcf_hdr_read(bcf_t *b)
  46 {
  47         uint8_t magic[4];
  48         bcf_hdr_t *h;
  49         if (b == 0) return 0;
  50         h = calloc(1, sizeof(bcf_hdr_t));
  51         bgzf_read(b->fp, magic, 4);
  52         bgzf_read(b->fp, &h->l_nm, 4);
  53         h->name = malloc(h->l_nm);
  54         bgzf_read(b->fp, h->name, h->l_nm);
  55         bgzf_read(b->fp, &h->l_smpl, 4);
  56         h->sname = malloc(h->l_smpl);
  57         bgzf_read(b->fp, h->sname, h->l_smpl);
  58         bgzf_read(b->fp, &h->l_txt, 4);
  59         h->txt = malloc(h->l_txt);
  60         bgzf_read(b->fp, h->txt, h->l_txt);
  61         bcf_hdr_sync(h);
  62         return h;
  63 }
  64
  65 void bcf_hdr_destroy(bcf_hdr_t *h)
  66 {
  67         if (h == 0) return;
  68         free(h->name); free(h->sname); free(h->txt); free(h->ns); free(h->sns);
  69         free(h);
  70 }
  71
  72 static inline char **cnt_null(int l, char *str, int *_n)
  73 {
  74         int n = 0;
  75         char *p, **list;
  76         *_n = 0;
  77         if (l == 0 || str == 0) return 0;
  78         for (p = str; p != str + l; ++p)
  79                 if (*p == 0) ++n;
  80         *_n = n;
  81         list = calloc(n, sizeof(void*));
  82         list[0] = str;
  83         for (p = str, n = 1; p < str + l - 1; ++p)
  84                 if (*p == 0) list[n++] = p + 1;
  85         return list;
  86 }
  87
  88 int bcf_hdr_sync(bcf_hdr_t *b)
  89 {
  90         if (b == 0) return -1;
  91         if (b->ns) free(b->ns);
  92         if (b->sns) free(b->sns);
  93         if (b->l_nm) b->ns = cnt_null(b->l_nm, b->name, &b->n_ref);
  94         else b->ns = 0, b->n_ref = 0;
  95         b->sns = cnt_null(b->l_smpl, b->sname, &b->n_smpl);
  96         return 0;
  97 }
  98
  99 int bcf_sync(bcf1_t *b)
 100 {
 101         char *p, *tmp[5];
 102         int i, n, n_smpl = b->n_smpl;
 103         ks_tokaux_t aux;
 104         // set ref, alt, flt, info, fmt
 105         b->ref = b->alt = b->flt = b->info = b->fmt = 0;
 106         for (p = b->str, n = 0; p < b->str + b->l_str; ++p)
 107                 if (*p == 0 && p+1 != b->str + b->l_str) tmp[n++] = p + 1;
 108         if (n != 5) {
 109                 fprintf(stderr, "[%s] incorrect number of fields (%d != 5). Corrupted file?\n", __func__, n);
 110                 return -1;
 111         }
 112         b->ref = tmp[0]; b->alt = tmp[1]; b->flt = tmp[2]; b->info = tmp[3]; b->fmt = tmp[4];
 113         // set n_alleles
 114         if (*b->alt == 0) b->n_alleles = 1;
 115         else {
 116                 for (p = b->alt, n = 1; *p; ++p)
 117                         if (*p == ',') ++n;
 118                 b->n_alleles = n + 1;
 119         }
 120         // set n_gi and gi[i].fmt
 121         for (p = b->fmt, n = 1; *p; ++p)
 122                 if (*p == ':') ++n;
 123         if (n > b->m_gi) {
 124                 int old_m = b->m_gi;
 125                 b->m_gi = n;
 126                 kroundup32(b->m_gi);
 127                 b->gi = realloc(b->gi, b->m_gi * sizeof(bcf_ginfo_t));
 128                 memset(b->gi + old_m, 0, (b->m_gi - old_m) * sizeof(bcf_ginfo_t));
 129         }
 130         b->n_gi = n;
 131         for (p = kstrtok(b->fmt, ":", &aux), n = 0; p; p = kstrtok(0, 0, &aux))
 132                 b->gi[n++].fmt = bcf_str2int(p, aux.p - p);
 133         // set gi[i].len
 134         for (i = 0; i < b->n_gi; ++i) {
 135                 if (b->gi[i].fmt == bcf_str2int("PL", 2)) {
 136                         b->gi[i].len = b->n_alleles * (b->n_alleles + 1) / 2;
 137                 } else if (b->gi[i].fmt == bcf_str2int("DP", 2) || b->gi[i].fmt == bcf_str2int("HQ", 2)) {
 138                         b->gi[i].len = 2;
 139                 } else if (b->gi[i].fmt == bcf_str2int("GQ", 2) || b->gi[i].fmt == bcf_str2int("GT", 2)
 140                                    || b->gi[i].fmt == bcf_str2int("SP", 2))
 141                 {
 142                         b->gi[i].len = 1;
 143                 } else if (b->gi[i].fmt == bcf_str2int("GL", 2)) {
 144                         b->gi[i].len = b->n_alleles * (b->n_alleles + 1) / 2 * 4;
 145                 }
 146                 b->gi[i].data = realloc(b->gi[i].data, n_smpl * b->gi[i].len);
 147         }
 148         return 0;
 149 }
 150
 151 int bcf_write(bcf_t *bp, const bcf_hdr_t *h, const bcf1_t *b)
 152 {
 153         int i, l = 0;
 154         if (b == 0) return -1;
 155         bgzf_write(bp->fp, &b->tid, 4);
 156         bgzf_write(bp->fp, &b->pos, 4);
 157         bgzf_write(bp->fp, &b->qual, 4);
 158         bgzf_write(bp->fp, &b->l_str, 4);
 159         bgzf_write(bp->fp, b->str, b->l_str);
 160         l = 12 + b->l_str;
 161         for (i = 0; i < b->n_gi; ++i) {
 162                 bgzf_write(bp->fp, b->gi[i].data, b->gi[i].len * h->n_smpl);
 163                 l += b->gi[i].len * h->n_smpl;
 164         }
 165         return l;
 166 }
 167
 168 int bcf_read(bcf_t *bp, const bcf_hdr_t *h, bcf1_t *b)
 169 {
 170         int i, l = 0;
 171         if (b == 0) return -1;
 172         if (bgzf_read(bp->fp, &b->tid, 4) == 0) return -1;
 173         b->n_smpl = h->n_smpl;
 174         bgzf_read(bp->fp, &b->pos, 4);
 175         bgzf_read(bp->fp, &b->qual, 4);
 176         bgzf_read(bp->fp, &b->l_str, 4);
 177         if (b->l_str > b->m_str) {
 178                 b->m_str = b->l_str;
 179                 kroundup32(b->m_str);
 180                 b->str = realloc(b->str, b->m_str);
 181         }
 182         bgzf_read(bp->fp, b->str, b->l_str);
 183         l = 12 + b->l_str;
 184         bcf_sync(b);
 185         for (i = 0; i < b->n_gi; ++i) {
 186                 bgzf_read(bp->fp, b->gi[i].data, b->gi[i].len * h->n_smpl);
 187                 l += b->gi[i].len * h->n_smpl;
 188         }
 189         return l;
 190 }
 191
 192 int bcf_destroy(bcf1_t *b)
 193 {
 194         int i;
 195         if (b == 0) return -1;
 196         free(b->str);
 197         for (i = 0; i < b->m_gi; ++i)
 198                 free(b->gi[i].data);
 199         free(b->gi);
 200         free(b);
 201         return 0;
 202 }
 203
 204 static inline void fmt_str(const char *p, kstring_t *s)
 205 {
 206         if (*p == 0) kputc('.', s);
 207         else kputs(p, s);
 208 }
 209
 210 void bcf_fmt_core(const bcf_hdr_t *h, bcf1_t *b, kstring_t *s)
 211 {
 212         int i, j, x;
 213         s->l = 0;
 214         if (h->n_ref) kputs(h->ns[b->tid], s);
 215         else kputw(b->tid, s);
 216         kputc('\t', s);
 217         kputw(b->pos + 1, s); kputc('\t', s);
 218         fmt_str(b->str, s); kputc('\t', s);
 219         fmt_str(b->ref, s); kputc('\t', s);
 220         fmt_str(b->alt, s); kputc('\t', s);
 221         ksprintf(s, "%.3g", b->qual); kputc('\t', s);
 222         fmt_str(b->flt, s); kputc('\t', s);
 223         fmt_str(b->info, s);
 224         if (b->fmt[0]) {
 225                 kputc('\t', s);
 226                 fmt_str(b->fmt, s);
 227         }
 228         x = b->n_alleles * (b->n_alleles + 1) / 2;
 229         if (b->n_gi == 0) return;
 230         for (j = 0; j < h->n_smpl; ++j) {
 231                 kputc('\t', s);
 232                 for (i = 0; i < b->n_gi; ++i) {
 233                         if (i) kputc(':', s);
 234                         if (b->gi[i].fmt == bcf_str2int("PL", 2)) {
 235                                 uint8_t *d = (uint8_t*)b->gi[i].data + j * x;
 236                                 int k;
 237                                 for (k = 0; k < x; ++k) {
 238                                         if (k > 0) kputc(',', s);
 239                                         kputw(d[k], s);
 240                                 }
 241                         } else if (b->gi[i].fmt == bcf_str2int("DP", 2)) {
 242                                 kputw(((uint16_t*)b->gi[i].data)[j], s);
 243                         } else if (b->gi[i].fmt == bcf_str2int("GQ", 2) || b->gi[i].fmt == bcf_str2int("SP", 2)) {
 244                                 kputw(((uint8_t*)b->gi[i].data)[j], s);
 245                         } else if (b->gi[i].fmt == bcf_str2int("GT", 2)) {
 246                                 int y = ((uint8_t*)b->gi[i].data)[j];
 247                                 if (y>>7&1) {
 248                                         kputsn("./.", 3, s);
 249                                 } else {
 250                                         kputc('0' + (y>>3&7), s);
 251                                         kputc("/|"[y>>6&1], s);
 252                                         kputc('0' + (y&7), s);
 253                                 }
 254                         } else if (b->gi[i].fmt == bcf_str2int("GL", 2)) {
 255                                 float *d = (float*)b->gi[i].data + j * x;
 256                                 int k;
 257                                 //printf("- %lx\n", d);
 258                                 for (k = 0; k < x; ++k) {
 259                                         if (k > 0) kputc(',', s);
 260                                         ksprintf(s, "%.2f", d[k]);
 261                                 }
 262                         }
 263                 }
 264         }
 265 }
 266
 267 char *bcf_fmt(const bcf_hdr_t *h, bcf1_t *b)
 268 {
 269         kstring_t s;
 270         s.l = s.m = 0; s.s = 0;
 271         bcf_fmt_core(h, b, &s);
 272         return s.s;
 273 }
 274
 275 int bcf_append_info(bcf1_t *b, const char *info, int l)
 276 {
 277         int shift = b->fmt - b->str;
 278         int l_fmt = b->l_str - shift;
 279         char *ori = b->str;
 280         if (b->l_str + l > b->m_str) { // enlarge if necessary
 281                 b->m_str = b->l_str + l;
 282                 kroundup32(b->m_str);
 283                 b->str = realloc(b->str, b->m_str);
 284         }
 285         memmove(b->str + shift + l, b->str + shift, l_fmt); // move the FORMAT field
 286         memcpy(b->str + shift - 1, info, l); // append to the INFO field
 287         b->str[shift + l - 1] = '\0';
 288         b->fmt = b->str + shift + l;
 289         b->l_str += l;
 290         if (ori != b->str) bcf_sync(b); // synchronize when realloc changes the pointer
 291         return 0;
 292 }
 293
 294 int bcf_cpy(bcf1_t *r, const bcf1_t *b)
 295 {
 296         char *t1 = r->str;
 297         bcf_ginfo_t *t2 = r->gi;
 298         int i, t3 = r->m_str, t4 = r->m_gi;
 299         *r = *b;
 300         r->str = t1; r->gi = t2; r->m_str = t3; r->m_gi = t4;
 301         if (r->m_str < b->m_str) {
 302                 r->m_str = b->m_str;
 303                 r->str = realloc(r->str, r->m_str);
 304         }
 305         memcpy(r->str, b->str, r->m_str);
 306         bcf_sync(r); // calling bcf_sync() is simple but inefficient
 307         for (i = 0; i < r->n_gi; ++i)
 308                 memcpy(r->gi[i].data, b->gi[i].data, r->n_smpl * r->gi[i].len);
 309         return 0;
 310 }
 311
 312 int bcf_is_indel(const bcf1_t *b)
 313 {
 314         char *p;
 315         if (strlen(b->ref) > 1) return 1;
 316         for (p = b->alt; *p; ++p)
 317                 if (*p != ',' && p[1] != ',' && p[1] != '\0')
 318                         return 1;
 319         return 0;
 320 }