bam_aux.c

   1 #include <ctype.h>
   2 #include "bam.h"
   3 #include "khash.h"
   4 typedef char *str_p;
   5 KHASH_MAP_INIT_STR(s, int)
   6 KHASH_MAP_INIT_STR(r2l, str_p)
   7
   8 void bam_aux_append(bam1_t *b, const char tag[2], char type, int len, uint8_t *data)
   9 {
  10         int ori_len = b->data_len;
  11         b->data_len += 3 + len;
  12         b->l_aux += 3 + len;
  13         if (b->m_data < b->data_len) {
  14                 b->m_data = b->data_len;
  15                 kroundup32(b->m_data);
  16                 b->data = (uint8_t*)realloc(b->data, b->m_data);
  17         }
  18         b->data[ori_len] = tag[0]; b->data[ori_len + 1] = tag[1];
  19         b->data[ori_len + 2] = type;
  20         memcpy(b->data + ori_len + 3, data, len);
  21 }
  22 /*
  23 uint8_t *bam_aux_get_core(bam1_t *b, const char tag[2])
  24 {
  25         return bam_aux_get(b, tag);
  26 }
  27 */
  28 uint8_t *bam_aux_get(const bam1_t *b, const char tag[2])
  29 {
  30         uint8_t *s;
  31         int y = tag[0]<<8 | tag[1];
  32         s = bam1_aux(b);
  33         while (s < b->data + b->data_len) {
  34                 int type, x = (int)s[0]<<8 | s[1];
  35                 s += 2;
  36                 if (x == y) return s;
  37                 type = toupper(*s); ++s;
  38                 if (type == 'C') ++s;
  39                 else if (type == 'S') s += 2;
  40                 else if (type == 'I' || type == 'F') s += 4;
  41                 else if (type == 'D') s += 8;
  42                 else if (type == 'Z' || type == 'H') { while (*s) putchar(*s++); ++s; }
  43         }
  44         return 0;
  45 }
  46
  47 void bam_init_header_hash(bam_header_t *header)
  48 {
  49         if (header->hash == 0) {
  50                 int ret, i;
  51                 khiter_t iter;
  52                 khash_t(s) *h;
  53                 header->hash = h = kh_init(s);
  54                 for (i = 0; i < header->n_targets; ++i) {
  55                         iter = kh_put(s, h, header->target_name[i], &ret);
  56                         kh_value(h, iter) = i;
  57                 }
  58         }
  59 }
  60
  61 void bam_destroy_header_hash(bam_header_t *header)
  62 {
  63         if (header->hash)
  64                 kh_destroy(s, (khash_t(s)*)header->hash);
  65 }
  66
  67 int32_t bam_get_tid(const bam_header_t *header, const char *seq_name)
  68 {
  69         khint_t k;
  70         khash_t(s) *h = (khash_t(s)*)header->hash;
  71         k = kh_get(s, h, seq_name);
  72         return k == kh_end(h)? -1 : kh_value(h, k);
  73 }
  74
  75 void bam_parse_region(bam_header_t *header, const char *str, int *ref_id, int *begin, int *end)
  76 {
  77         char *s, *p;
  78         int i, l, k;
  79         khiter_t iter;
  80         khash_t(s) *h;
  81
  82         bam_init_header_hash(header);
  83         h = (khash_t(s)*)header->hash;
  84
  85         l = strlen(str);
  86         p = s = (char*)malloc(l+1);
  87         /* squeeze out "," */
  88         for (i = k = 0; i != l; ++i)
  89                 if (str[i] != ',' && !isspace(str[i])) s[k++] = str[i];
  90         s[k] = 0;
  91         for (i = 0; i != k; ++i) if (s[i] == ':') break;
  92         s[i] = 0;
  93         iter = kh_get(s, h, s); /* get the ref_id */
  94         if (iter == kh_end(h)) { // name not found
  95                 *ref_id = -1; free(s);
  96                 return;
  97         }
  98         *ref_id = kh_value(h, iter);
  99         if (i == k) { /* dump the whole sequence */
 100                 *begin = 0; *end = 1<<29; free(s);
 101                 return;
 102         }
 103         for (p = s + i + 1; i != k; ++i) if (s[i] == '-') break;
 104         *begin = atoi(p);
 105         if (i < k) {
 106                 p = s + i + 1;
 107                 *end = atoi(p);
 108         } else *end = 1<<29;
 109         if (*begin > 0) --*begin;
 110         assert(*begin <= *end);
 111         free(s);
 112 }
 113
 114 int32_t bam_aux2i(const uint8_t *s)
 115 {
 116         int type;
 117         if (s == 0) return 0;
 118         type = *s++;
 119         if (type == 'c') return (int32_t)*(int8_t*)s;
 120         else if (type == 'C') return (int32_t)*(uint8_t*)s;
 121         else if (type == 's') return (int32_t)*(int16_t*)s;
 122         else if (type == 'S') return (int32_t)*(uint16_t*)s;
 123         else if (type == 'i' || type == 'I') return *(int32_t*)s;
 124         else return 0;
 125 }
 126
 127 float bam_aux2f(const uint8_t *s)
 128 {
 129         int type;
 130         type = *s++;
 131         if (s == 0) return 0.0;
 132         if (type == 'f') return *(float*)s;
 133         else return 0.0;
 134 }
 135
 136 double bam_aux2d(const uint8_t *s)
 137 {
 138         int type;
 139         type = *s++;
 140         if (s == 0) return 0.0;
 141         if (type == 'd') return *(double*)s;
 142         else return 0.0;
 143 }
 144
 145 char bam_aux2A(const uint8_t *s)
 146 {
 147         int type;
 148         type = *s++;
 149         if (s == 0) return 0;
 150         if (type == 'A') return *(char*)s;
 151         else return 0;
 152 }
 153
 154 char *bam_aux2Z(const uint8_t *s)
 155 {
 156         int type;
 157         type = *s++;
 158         if (s == 0) return 0;
 159         if (type == 'Z' || type == 'H') return (char*)s;
 160         else return 0;
 161 }
 162
 163 /******************
 164  * rg2lib related *
 165  ******************/
 166
 167 int bam_strmap_put(void *rg2lib, const char *rg, const char *lib)
 168 {
 169         int ret;
 170         khint_t k;
 171         khash_t(r2l) *h = (khash_t(r2l)*)rg2lib;
 172         char *key;
 173         if (h == 0) return 1;
 174         key = strdup(rg);
 175         k = kh_put(r2l, h, key, &ret);
 176         if (ret) kh_val(h, k) = strdup(lib);
 177         else {
 178                 fprintf(stderr, "[bam_rg2lib_put] duplicated @RG ID: %s\n", rg);
 179                 free(key);
 180         }
 181         return 0;
 182 }
 183
 184 const char *bam_strmap_get(const void *rg2lib, const char *rg)
 185 {
 186         const khash_t(r2l) *h = (const khash_t(r2l)*)rg2lib;
 187         khint_t k;
 188         if (h == 0) return 0;
 189         k = kh_get(r2l, h, rg);
 190         if (k != kh_end(h)) return (const char*)kh_val(h, k);
 191         else return 0;
 192 }
 193
 194 void *bam_strmap_dup(const void *rg2lib)
 195 {
 196         const khash_t(r2l) *h = (const khash_t(r2l)*)rg2lib;
 197         khash_t(r2l) *g;
 198         khint_t k, l;
 199         int ret;
 200         if (h == 0) return 0;
 201         g = kh_init(r2l);
 202         for (k = kh_begin(h); k < kh_end(h); ++k) {
 203                 if (kh_exist(h, k)) {
 204                         char *key = strdup(kh_key(h, k));
 205                         l = kh_put(r2l, g, key, &ret);
 206                         kh_val(g, l) = strdup(kh_val(h, k));
 207                 }
 208         }
 209         return g;
 210 }
 211
 212 void *bam_strmap_init()
 213 {
 214         return (void*)kh_init(r2l);
 215 }
 216
 217 void bam_strmap_destroy(void *rg2lib)
 218 {
 219         khash_t(r2l) *h = (khash_t(r2l)*)rg2lib;
 220         khint_t k;
 221         if (h == 0) return;
 222         for (k = kh_begin(h); k < kh_end(h); ++k) {
 223                 if (kh_exist(h, k)) {
 224                         free((char*)kh_key(h, k)); free(kh_val(h, k));
 225                 }
 226         }
 227         kh_destroy(r2l, h);
 228 }
 229
 230 /*** The following routines were implemented by Nils Homer for color-space support in tview ***/
 231
 232 char bam_aux_getCSi(bam1_t *b, int i)
 233 {
 234         uint8_t *c = bam_aux_get(b, "CS");
 235         char *cs = NULL;
 236
 237         // return the base if the tag was not found
 238         if(0 == c) return 0;
 239
 240         cs = bam_aux2Z(c);
 241         // adjust for strandedness and leading adaptor
 242         if(bam1_strand(b)) i = strlen(cs) - 1 - i;
 243         else i++;
 244         return cs[i];
 245 }
 246
 247 char bam_aux_getCQi(bam1_t *b, int i)
 248 {
 249         uint8_t *c = bam_aux_get(b, "CQ");
 250         char *cq = NULL;
 251
 252         // return the base if the tag was not found
 253         if(0 == c) return 0;
 254
 255         cq = bam_aux2Z(c);
 256         // adjust for strandedness
 257         if(bam1_strand(b)) i = strlen(cq) - 1 - i;
 258         return cq[i];
 259 }
 260
 261 char bam_aux_nt2int(char a)
 262 {
 263         switch(toupper(a)) {
 264                 case 'A':
 265                         return 0;
 266                         break;
 267                 case 'C':
 268                         return 1;
 269                         break;
 270                 case 'G':
 271                         return 2;
 272                         break;
 273                 case 'T':
 274                         return 3;
 275                         break;
 276                 default:
 277                         return 4;
 278                         break;
 279         }
 280 }
 281
 282 char bam_aux_ntnt2cs(char a, char b)
 283 {
 284         a = bam_aux_nt2int(a);
 285         b = bam_aux_nt2int(b);
 286         if(4 == a || 4 == b) return '4';
 287         return "0123"[(int)(a ^ b)];
 288 }
 289
 290 char bam_aux_getCEi(bam1_t *b, int i)
 291 {
 292         int cs_i;
 293         uint8_t *c = bam_aux_get(b, "CS");
 294         char *cs = NULL;
 295         char prev_b, cur_b;
 296         char cur_color, cor_color;
 297
 298         // return the base if the tag was not found
 299         if(0 == c) return 0;
 300
 301         cs = bam_aux2Z(c);
 302
 303         // adjust for strandedness and leading adaptor
 304         if(bam1_strand(b)) { //reverse strand
 305                 cs_i = strlen(cs) - 1 - i;
 306                 // get current color
 307                 cur_color = cs[cs_i];
 308                 // get previous base
 309                 prev_b = (0 == cs_i) ? cs[0] : bam_nt16_rev_table[bam1_seqi(bam1_seq(b), i+1)];
 310                 // get current base
 311                 cur_b = bam_nt16_rev_table[bam1_seqi(bam1_seq(b), i)];
 312         }
 313         else {
 314                 cs_i=i+1;
 315                 // get current color
 316                 cur_color = cs[cs_i];
 317                 // get previous base
 318                 prev_b = (0 == i) ? cs[0] : bam_nt16_rev_table[bam1_seqi(bam1_seq(b), i-1)];
 319                 // get current base
 320                 cur_b = bam_nt16_rev_table[bam1_seqi(bam1_seq(b), i)];
 321         }
 322
 323         // corrected color
 324         cor_color = bam_aux_ntnt2cs(prev_b, cur_b);
 325
 326         if(cur_color == cor_color) {
 327                 return '-';
 328         }
 329         else {
 330                 return cur_color;
 331         }
 332 }