sam/bam_cat.c

   1 /*\r
   2 \r
   3 bam_cat -- efficiently concatenates bam files\r
   4 \r
   5 bam_cat can be used to concatenate BAM files. Under special\r
   6 circumstances, it can be used as an alternative to 'samtools merge' to\r
   7 concatenate multiple sorted files into a single sorted file. For this\r
   8 to work each file must be sorted, and the sorted files must be given\r
   9 as command line arguments in order such that the final read in file i\r
  10 is less than or equal to the first read in file i+1.\r
  11 \r
  12 This code is derived from the bam_reheader function in samtools 0.1.8\r
  13 and modified to perform concatenation by Chris Saunders on behalf of\r
  14 Illumina.\r
  15 \r
  16 \r
  17 ########## License:\r
  18 \r
  19 The MIT License\r
  20 \r
  21 Original SAMtools work copyright (c) 2008-2009 Genome Research Ltd.\r
  22 Modified SAMtools work copyright (c) 2010 Illumina, Inc.\r
  23 \r
  24 Permission is hereby granted, free of charge, to any person obtaining a copy\r
  25 of this software and associated documentation files (the "Software"), to deal\r
  26 in the Software without restriction, including without limitation the rights\r
  27 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
  28 copies of the Software, and to permit persons to whom the Software is\r
  29 furnished to do so, subject to the following conditions:\r
  30 \r
  31 The above copyright notice and this permission notice shall be included in\r
  32 all copies or substantial portions of the Software.\r
  33 \r
  34 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  35 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  36 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  37 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  38 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  39 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  40 THE SOFTWARE.\r
  41 \r
  42 */\r
  43 \r
  44 \r
  45 /*\r
  46 makefile:\r
  47 """\r
  48 CC=gcc\r
  49 CFLAGS+=-g -Wall -O2 -D_FILE_OFFSET_BITS=64 -D_USE_KNETFILE -I$(SAMTOOLS_DIR)\r
  50 LDFLAGS+=-L$(SAMTOOLS_DIR)\r
  51 LDLIBS+=-lbam -lz\r
  52 \r
  53 all:bam_cat\r
  54 """\r
  55 */\r
  56 \r
  57 \r
  58 #include <stdio.h>\r
  59 #include <stdlib.h>\r
  60 #include <unistd.h>\r
  61 \r
  62 #include "knetfile.h"\r
  63 #include "bgzf.h"\r
  64 #include "bam.h"\r
  65 \r
  66 #define BUF_SIZE 0x10000\r
  67 \r
  68 #define GZIPID1 31\r
  69 #define GZIPID2 139\r
  70 \r
  71 #define BGZF_EMPTY_BLOCK_SIZE 28\r
  72 \r
  73 \r
  74 int bam_cat(int nfn, char * const *fn, const bam_header_t *h, const char* outbam)\r
  75 {\r
  76     BGZF *fp;\r
  77     FILE* fp_file;\r
  78     uint8_t *buf;\r
  79     uint8_t ebuf[BGZF_EMPTY_BLOCK_SIZE];\r
  80     const int es=BGZF_EMPTY_BLOCK_SIZE;\r
  81     int i;\r
  82     \r
  83     fp = strcmp(outbam, "-")? bgzf_open(outbam, "w") : bgzf_fdopen(fileno(stdout), "w");\r
  84     if (fp == 0) {\r
  85         fprintf(stderr, "[%s] ERROR: fail to open output file '%s'.\n", __func__, outbam);\r
  86         return 1;\r
  87     }\r
  88     if (h) bam_header_write(fp, h);\r
  89     \r
  90     buf = (uint8_t*) malloc(BUF_SIZE);\r
  91     for(i = 0; i < nfn; ++i){\r
  92         BGZF *in;\r
  93         bam_header_t *old;\r
  94         int len,j;\r
  95         \r
  96         in = strcmp(fn[i], "-")? bam_open(fn[i], "r") : bam_dopen(fileno(stdin), "r");\r
  97         if (in == 0) {\r
  98             fprintf(stderr, "[%s] ERROR: fail to open file '%s'.\n", __func__, fn[i]);\r
  99             return -1;\r
 100         }\r
 101         if (in->is_write) return -1;\r
 102         \r
 103         old = bam_header_read(in);\r
 104                 if (h == 0 && i == 0) bam_header_write(fp, old);\r
 105         \r
 106         if (in->block_offset < in->block_length) {\r
 107             bgzf_write(fp, in->uncompressed_block + in->block_offset, in->block_length - in->block_offset);\r
 108             bgzf_flush(fp);\r
 109         }\r
 110         \r
 111         j=0;\r
 112 #ifdef _USE_KNETFILE\r
 113         fp_file = fp->fp;\r
 114         while ((len = knet_read(in->fp, buf, BUF_SIZE)) > 0) {\r
 115 #else  \r
 116         fp_file = fp->fp;\r
 117         while (!feof(in->file) && (len = fread(buf, 1, BUF_SIZE, in->file)) > 0) {\r
 118 #endif\r
 119             if(len<es){\r
 120                 int diff=es-len;\r
 121                 if(j==0) {\r
 122                     fprintf(stderr, "[%s] ERROR: truncated file?: '%s'.\n", __func__, fn[i]);\r
 123                     return -1;\r
 124                 }\r
 125                 fwrite(ebuf, 1, len, fp_file);\r
 126                 memcpy(ebuf,ebuf+len,diff);\r
 127                 memcpy(ebuf+diff,buf,len);\r
 128             } else {\r
 129                 if(j!=0) fwrite(ebuf, 1, es, fp_file);\r
 130                 len-= es;\r
 131                 memcpy(ebuf,buf+len,es);\r
 132                 fwrite(buf, 1, len, fp_file);\r
 133             }\r
 134             j=1;\r
 135         }\r
 136 \r
 137         /* check final gzip block */\r
 138         {\r
 139             const uint8_t gzip1=ebuf[0];\r
 140             const uint8_t gzip2=ebuf[1];\r
 141             const uint32_t isize=*((uint32_t*)(ebuf+es-4));\r
 142             if(((gzip1!=GZIPID1) || (gzip2!=GZIPID2)) || (isize!=0)) {\r
 143                 fprintf(stderr, "[%s] WARNING: Unexpected block structure in file '%s'.", __func__, fn[i]);\r
 144                 fprintf(stderr, " Possible output corruption.\n");\r
 145                 fwrite(ebuf, 1, es, fp_file);\r
 146             }\r
 147         }\r
 148         bam_header_destroy(old);\r
 149         bgzf_close(in);\r
 150     }\r
 151     free(buf);\r
 152     bgzf_close(fp);\r
 153     return 0;\r
 154 }\r
 155 \r
 156 \r
 157 \r
 158 int main_cat(int argc, char *argv[])\r
 159 {\r
 160     bam_header_t *h = 0;\r
 161         char *outfn = 0;\r
 162         int c, ret;\r
 163         while ((c = getopt(argc, argv, "h:o:")) >= 0) {\r
 164                 switch (c) {\r
 165                         case 'h': {\r
 166                         tamFile fph = sam_open(optarg);\r
 167                         if (fph == 0) {\r
 168                         fprintf(stderr, "[%s] ERROR: fail to read the header from '%s'.\n", __func__, argv[1]);\r
 169                             return 1;\r
 170                         }\r
 171                     h = sam_header_read(fph);\r
 172                 sam_close(fph);\r
 173                                 break;\r
 174                         }\r
 175                         case 'o': outfn = strdup(optarg); break;\r
 176                 }\r
 177         }\r
 178         if (argc - optind < 2) {\r
 179         fprintf(stderr, "Usage: samtools cat [-h header.sam] [-o out.bam] <in1.bam> <in2.bam> [...]\n");\r
 180         return 1;\r
 181     }\r
 182     ret = bam_cat(argc - optind, argv + optind, h, outfn? outfn : "-");\r
 183         free(outfn);\r
 184         return ret;\r
 185 }\r