bam_sort.c

   1 #include <stdlib.h>
   2 #include <ctype.h>
   3 #include <assert.h>
   4 #include <stdio.h>
   5 #include <string.h>
   6 #include <unistd.h>
   7 #include "bam.h"
   8 #include "ksort.h"
   9
  10 static int g_is_by_qname = 0;
  11
  12 static inline int strnum_cmp(const char *a, const char *b)
  13 {
  14         char *pa, *pb;
  15         pa = (char*)a; pb = (char*)b;
  16         while (*pa && *pb) {
  17                 if (isdigit(*pa) && isdigit(*pb)) {
  18                         long ai, bi;
  19                         ai = strtol(pa, &pa, 10);
  20                         bi = strtol(pb, &pb, 10);
  21                         if (ai != bi) return ai<bi? -1 : ai>bi? 1 : 0;
  22                 } else {
  23                         if (*pa != *pb) break;
  24                         ++pa; ++pb;
  25                 }
  26         }
  27         if (*pa == *pb)
  28                 return (pa-a) < (pb-b)? -1 : (pa-a) > (pb-b)? 1 : 0;
  29         return *pa<*pb? -1 : *pa>*pb? 1 : 0;
  30 }
  31
  32 #define HEAP_EMPTY 0xffffffffffffffffull
  33
  34 typedef struct {
  35         int i;
  36         uint64_t pos;
  37         bam1_t *b;
  38 } heap1_t;
  39
  40 static inline int heap_lt(const heap1_t a, const heap1_t b)
  41 {
  42         if (g_is_by_qname) {
  43                 int t = strnum_cmp(bam1_qname(a.b), bam1_qname(b.b));
  44                 return (t > 0 || (t == 0 && a.pos > b.pos));
  45         } else return (a.pos > b.pos);
  46 }
  47
  48 KSORT_INIT(heap, heap1_t, heap_lt)
  49
  50 /*!
  51   @abstract    Merge multiple sorted BAM.
  52   @param  is_by_qname whether to sort by query name
  53   @param  out  output BAM file name
  54   @param  n    number of files to be merged
  55   @param  fn   names of files to be merged
  56
  57   @discussion Padding information may NOT correctly maintained. This
  58   function is NOT thread safe.
  59  */
  60 void bam_merge_core(int by_qname, const char *out, int n, char * const *fn)
  61 {
  62         bamFile fpout, *fp;
  63         heap1_t *heap;
  64         bam_header_t *hout = 0;
  65         int i, j;
  66
  67         g_is_by_qname = by_qname;
  68         fp = (bamFile*)calloc(n, sizeof(bamFile));
  69         heap = (heap1_t*)calloc(n, sizeof(heap1_t));
  70         for (i = 0; i != n; ++i) {
  71                 heap1_t *h;
  72                 bam_header_t *hin;
  73                 assert(fp[i] = bam_open(fn[i], "r"));
  74                 hin = bam_header_read(fp[i]);
  75                 if (i == 0) hout = hin;
  76                 else { // validate multiple baf
  77                         if (hout->n_targets != hin->n_targets) {
  78                                 fprintf(stderr, "[bam_merge_core] file '%s' has different number of target sequences. Abort!\n", fn[i]);
  79                                 exit(1);
  80                         }
  81                         for (j = 0; j < hout->n_targets; ++j) {
  82                                 if (strcmp(hout->target_name[j], hin->target_name[j])) {
  83                                         fprintf(stderr, "[bam_merge_core] different target sequence name: '%s' != '%s' in file '%s'. Abort!\n",
  84                                                         hout->target_name[j], hin->target_name[j], fn[i]);
  85                                         exit(1);
  86                                 }
  87                                 if (hout->target_len[j] != hin->target_len[j])
  88                                         fprintf(stderr, "[bam_merge_core] different target sequence length: %d != %d in file '%s'. Continue.\n",
  89                                                         hout->target_len[j], hin->target_len[j], fn[i]);
  90                         }
  91                         bam_header_destroy(hin);
  92                 }
  93                 h = heap + i;
  94                 h->i = i;
  95                 h->b = (bam1_t*)calloc(1, sizeof(bam1_t));
  96                 if (bam_read1(fp[i], h->b) >= 0)
  97                         h->pos = ((uint64_t)h->b->core.tid<<32) | (uint32_t)h->b->core.pos<<1 | bam1_strand(h->b);
  98                 else h->pos = HEAP_EMPTY;
  99         }
 100         fpout = strcmp(out, "-")? bam_open(out, "w") : bam_dopen(fileno(stdout), "w");
 101         assert(fpout);
 102         bam_header_write(fpout, hout);
 103         bam_header_destroy(hout);
 104
 105         ks_heapmake(heap, n, heap);
 106         while (heap->pos != HEAP_EMPTY) {
 107                 bam1_t *b = heap->b;
 108                 bam_write1_core(fpout, &b->core, b->data_len, b->data);
 109                 if ((j = bam_read1(fp[heap->i], b)) >= 0)
 110                         heap->pos = ((uint64_t)b->core.tid<<32) | (uint32_t)b->core.pos<<1 | bam1_strand(b);
 111                 else if (j == -1) heap->pos = HEAP_EMPTY;
 112                 else fprintf(stderr, "[bam_merge_core] '%s' is truncated. Continue anyway.\n", fn[heap->i]);
 113                 ks_heapadjust(heap, 0, n, heap);
 114         }
 115
 116         for (i = 0; i != n; ++i) {
 117                 bam_close(fp[i]);
 118                 free(heap[i].b->data);
 119                 free(heap[i].b);
 120         }
 121         bam_close(fpout);
 122         free(fp); free(heap);
 123 }
 124 int bam_merge(int argc, char *argv[])
 125 {
 126         int c, is_by_qname = 0;
 127         while ((c = getopt(argc, argv, "n")) >= 0) {
 128                 switch (c) {
 129                 case 'n': is_by_qname = 1; break;
 130                 }
 131         }
 132         if (optind + 2 >= argc) {
 133                 fprintf(stderr, "Usage: samtools merge [-n] <out.bam> <in1.bam> <in2.bam> [...]\n");
 134                 return 1;
 135         }
 136         bam_merge_core(is_by_qname, argv[optind], argc - optind - 1, argv + optind + 1);
 137         return 0;
 138 }
 139
 140 typedef bam1_t *bam1_p;
 141
 142 static inline int bam1_lt(const bam1_p a, const bam1_p b)
 143 {
 144         if (g_is_by_qname) {
 145                 int t = strnum_cmp(bam1_qname(a), bam1_qname(b));
 146                 return (t < 0 || (t == 0 && (((uint64_t)a->core.tid<<32|a->core.pos) < ((uint64_t)b->core.tid<<32|b->core.pos))));
 147         } else return (((uint64_t)a->core.tid<<32|a->core.pos) < ((uint64_t)b->core.tid<<32|b->core.pos));
 148 }
 149 KSORT_INIT(sort, bam1_p, bam1_lt)
 150
 151 static void sort_blocks(int n, int k, bam1_p *buf, const char *prefix, const bam_header_t *h)
 152 {
 153         char *name;
 154         int i;
 155         bamFile fp;
 156         ks_mergesort(sort, k, buf, 0);
 157         name = (char*)calloc(strlen(prefix) + 20, 1);
 158         if (n >= 0) sprintf(name, "%s.%.4d.bam", prefix, n);
 159         else sprintf(name, "%s.bam", prefix);
 160         assert(fp = bam_open(name, "w"));
 161         free(name);
 162         bam_header_write(fp, h);
 163         for (i = 0; i < k; ++i)
 164                 bam_write1_core(fp, &buf[i]->core, buf[i]->data_len, buf[i]->data);
 165         bam_close(fp);
 166 }
 167
 168 /*!
 169   @abstract Sort an unsorted BAM file based on the chromosome order
 170   and the leftmost position of an alignment
 171
 172   @param  is_by_qname whether to sort by query name
 173   @param  fn       name of the file to be sorted
 174   @param  prefix   prefix of the output and the temporary files; upon
 175                            sucessess, prefix.bam will be written.
 176   @param  max_mem  approxiate maximum memory (very inaccurate)
 177
 178   @discussion It may create multiple temporary subalignment files
 179   and then merge them by calling bam_merge_core(). This function is
 180   NOT thread safe.
 181  */
 182 void bam_sort_core(int is_by_qname, const char *fn, const char *prefix, size_t max_mem)
 183 {
 184         int n, ret, k, i;
 185         size_t mem;
 186         bam_header_t *header;
 187         bamFile fp;
 188         bam1_t *b, **buf;
 189
 190         g_is_by_qname = is_by_qname;
 191         n = k = 0; mem = 0;
 192         fp = strcmp(fn, "-")? bam_open(fn, "r") : bam_dopen(fileno(stdin), "r");
 193         assert(fp);
 194         header = bam_header_read(fp);
 195         buf = (bam1_t**)calloc(max_mem / BAM_CORE_SIZE, sizeof(bam1_t*));
 196         // write sub files
 197         for (;;) {
 198                 if (buf[k] == 0) buf[k] = (bam1_t*)calloc(1, sizeof(bam1_t));
 199                 b = buf[k];
 200                 if ((ret = bam_read1(fp, b)) < 0) break;
 201                 mem += ret;
 202                 ++k;
 203                 if (mem >= max_mem) {
 204                         sort_blocks(n++, k, buf, prefix, header);
 205                         mem = 0; k = 0;
 206                 }
 207         }
 208         if (ret != -1)
 209                 fprintf(stderr, "[bam_sort_core] truncated file. Continue anyway.\n");
 210         if (n == 0) sort_blocks(-1, k, buf, prefix, header);
 211         else { // then merge
 212                 char **fns, *fnout;
 213                 fprintf(stderr, "[bam_sort_core] merging from %d files...\n", n+1);
 214                 sort_blocks(n++, k, buf, prefix, header);
 215                 fnout = (char*)calloc(strlen(prefix) + 20, 1);
 216                 sprintf(fnout, "%s.bam", prefix);
 217                 fns = (char**)calloc(n, sizeof(char*));
 218                 for (i = 0; i < n; ++i) {
 219                         fns[i] = (char*)calloc(strlen(prefix) + 20, 1);
 220                         sprintf(fns[i], "%s.%.4d.bam", prefix, i);
 221                 }
 222                 bam_merge_core(is_by_qname, fnout, n, fns);
 223                 free(fnout);
 224                 for (i = 0; i < n; ++i) {
 225                         unlink(fns[i]);
 226                         free(fns[i]);
 227                 }
 228                 free(fns);
 229         }
 230         for (k = 0; k < max_mem / BAM_CORE_SIZE; ++k) {
 231                 if (buf[k]) {
 232                         free(buf[k]->data);
 233                         free(buf[k]);
 234                 }
 235         }
 236         free(buf);
 237         bam_header_destroy(header);
 238         bam_close(fp);
 239 }
 240
 241 int bam_sort(int argc, char *argv[])
 242 {
 243         size_t max_mem = 500000000;
 244         int c, is_by_qname = 0;
 245         while ((c = getopt(argc, argv, "nm:")) >= 0) {
 246                 switch (c) {
 247                 case 'n': is_by_qname = 1; break;
 248                 case 'm': max_mem = atol(optarg); break;
 249                 }
 250         }
 251         if (optind + 2 > argc) {
 252                 fprintf(stderr, "Usage: samtools sort [-n] [-m <maxMem>] <in.bam> <out.prefix>\n");
 253                 return 1;
 254         }
 255         bam_sort_core(is_by_qname, argv[optind], argv[optind+1], max_mem);
 256         return 0;
 257 }