samtools/bcftools/bcf.c.pysam.c

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