1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
|
/* bam_reheader.c -- reheader subcommand.
Copyright (C) 2010 Broad Institute.
Copyright (C) 2012-2019 Genome Research Ltd.
Author: Heng Li <lh3@sanger.ac.uk>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE. */
#include <config.h>
#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include <getopt.h>
#include <unistd.h>
#include "htslib/bgzf.h"
#include "htslib/sam.h"
#include "htslib/hfile.h"
#include "htslib/cram.h"
#include "samtools.h"
#define BUF_SIZE 0x10000
/*
* Reads a file and outputs a new BAM file to fd with 'h' replaced as
* the header. No checks are made to the validity.
*/
int bam_reheader(BGZF *in, sam_hdr_t *h, int fd,
const char *arg_list, int no_pg, int skip_header)
{
BGZF *fp = NULL;
ssize_t len;
uint8_t *buf = NULL;
sam_hdr_t *tmp;
if (!h)
return -1;
if (in->is_write) return -1;
buf = malloc(BUF_SIZE);
if (!buf) {
fprintf(stderr, "Out of memory\n");
return -1;
}
if (!skip_header) {
if ((tmp = bam_hdr_read(in)) == NULL) {
fprintf(stderr, "Couldn't read header\n");
goto fail;
}
sam_hdr_destroy(tmp);
}
fp = bgzf_fdopen(fd, "w");
if (!fp) {
print_error_errno("reheader", "Couldn't open output file");
goto fail;
}
if (!no_pg && sam_hdr_add_pg(h, "samtools",
"VN", samtools_version(),
arg_list ? "CL": NULL,
arg_list ? arg_list : NULL,
NULL) != 0)
goto fail;
if (bam_hdr_write(fp, h) < 0) {
print_error_errno("reheader", "Couldn't write header");
goto fail;
}
if (in->block_offset < in->block_length) {
if (bgzf_write(fp, (char *)in->uncompressed_block + in->block_offset, in->block_length - in->block_offset) < 0) goto write_fail;
if (bgzf_flush(fp) < 0) goto write_fail;
}
while ((len = bgzf_raw_read(in, buf, BUF_SIZE)) > 0) {
if (bgzf_raw_write(fp, buf, len) < 0) goto write_fail;
}
if (len < 0) {
fprintf(stderr, "[%s] Error reading input file\n", __func__);
goto fail;
}
free(buf);
fp->block_offset = in->block_offset = 0;
if (bgzf_close(fp) < 0) {
fprintf(stderr, "[%s] Error closing output file\n", __func__);
return -1;
}
return 0;
write_fail:
print_error_errno("reheader", "Error writing to output file");
fail:
bgzf_close(fp);
free(buf);
return -1;
}
/*
* Reads a file and outputs a new CRAM file to stdout with 'h'
* replaced as the header. No checks are made to the validity.
*
* FIXME: error checking
*/
int cram_reheader(cram_fd *in, sam_hdr_t *h, const char *arg_list, int no_pg)
{
htsFile *h_out = hts_open("-", "wc");
cram_fd *out = h_out->fp.cram;
cram_container *c = NULL;
int ret = -1;
if (!h)
return ret;
// Attempt to fill out a cram->refs[] array from @SQ headers
sam_hdr_t *cram_h = sam_hdr_dup(h);
if (!cram_h)
return -1;
cram_fd_set_header(out, cram_h);
if (!no_pg && sam_hdr_add_pg(cram_fd_get_header(out), "samtools",
"VN", samtools_version(),
arg_list ? "CL": NULL,
arg_list ? arg_list : NULL,
NULL))
goto err;
if (sam_hdr_write(h_out, cram_h) != 0)
goto err;
cram_set_option(out, CRAM_OPT_REFERENCE, NULL);
while ((c = cram_read_container(in))) {
int32_t i, num_blocks = cram_container_get_num_blocks(c);
if (cram_write_container(out, c) != 0)
goto err;
for (i = 0; i < num_blocks; i++) {
cram_block *blk = cram_read_block(in);
if (!blk || cram_write_block(out, blk) != 0) {
if (blk) cram_free_block(blk);
goto err;
}
cram_free_block(blk);
}
cram_free_container(c);
}
ret = 0;
err:
if (hts_close(h_out) != 0)
ret = -1;
return ret;
}
/*
* Reads a version 2 CRAM file and replaces the header in-place,
* provided the header is small enough to fit without growing the
* entire file.
*
* Version 2 format has an uncompressed SAM header with multiple nul
* termination bytes to permit inline header editing.
*
* Returns 0 on success;
* -1 on general failure;
* -2 on failure due to insufficient size
*/
int cram_reheader_inplace2(cram_fd *fd, sam_hdr_t *h, const char *arg_list,
int no_pg)
{
cram_container *c = NULL;
cram_block *b = NULL;
sam_hdr_t *cram_h = NULL;
off_t start;
int ret = -1;
if (!h)
goto err;
if (cram_major_vers(fd) < 2 ||
cram_major_vers(fd) > 3) {
fprintf(stderr, "[%s] unsupported CRAM version %d\n", __func__,
cram_major_vers(fd));
goto err;
}
cram_h = sam_hdr_dup(h);
if (!cram_h)
goto err;
if (!no_pg && sam_hdr_add_pg(cram_h, "samtools", "VN", samtools_version(),
arg_list ? "CL": NULL,
arg_list ? arg_list : NULL,
NULL))
goto err;
int header_len = sam_hdr_length(cram_h);
/* Fix M5 strings? Maybe out of scope for this tool */
// Load the existing header
if ((start = hseek(cram_fd_get_fp(fd), 26, SEEK_SET)) != 26)
goto err;
if (!(c = cram_read_container(fd)))
goto err;
// Version 2.1 has a single uncompressed block which is nul
// terminated with many nuls to permit growth.
//
// So load old block and keep all contents identical bar the
// header text itself
if (!(b = cram_read_block(fd)))
goto err;
if (cram_block_get_uncomp_size(b) < header_len+4) {
fprintf(stderr, "New header will not fit. Use non-inplace version (%d > %d)\n",
header_len+4, cram_block_get_uncomp_size(b));
ret = -2;
goto err;
}
cram_block_set_offset(b, 0); // rewind block
int32_put_blk(b, header_len);
cram_block_append(b, (void *)sam_hdr_str(cram_h), header_len);
// Zero the remaining block
memset((char *)cram_block_get_data(b)+cram_block_get_offset(b), 0,
cram_block_get_uncomp_size(b) - cram_block_get_offset(b));
// Make sure all sizes and byte-offsets are consistent after memset
cram_block_set_offset(b, cram_block_get_uncomp_size(b));
cram_block_set_comp_size(b, cram_block_get_uncomp_size(b));
if (hseek(cram_fd_get_fp(fd), start, SEEK_SET) != start)
goto err;
if (cram_write_container(fd, c) == -1)
goto err;
if (cram_write_block(fd, b) == -1)
goto err;
ret = 0;
err:
if (c) cram_free_container(c);
if (b) cram_free_block(b);
if (cram_h) sam_hdr_destroy(cram_h);
return ret;
}
/*
* Reads a version 3 CRAM file and replaces the header in-place,
* provided the header is small enough to fit without growing the
* entire file.
*
* Version 3 format has a SAM header held as an (optionally)
* compressed block within the header container. Additional
* uncompressed blocks or simply unallocated space (the difference
* between total block sizes and the container size) are used to
* provide room for growth or contraction of the compressed header.
*
* Returns 0 on success;
* -1 on general failure;
* -2 on failure due to insufficient size
*/
int cram_reheader_inplace3(cram_fd *fd, sam_hdr_t *h, const char *arg_list,
int no_pg)
{
cram_container *c = NULL;
cram_block *b = NULL;
sam_hdr_t *cram_h = NULL;
off_t start, sz, end;
int container_sz, max_container_sz;
char *buf = NULL;
int ret = -1;
if (!h)
goto err;
if (cram_major_vers(fd) < 2 ||
cram_major_vers(fd) > 3) {
fprintf(stderr, "[%s] unsupported CRAM version %d\n", __func__,
cram_major_vers(fd));
goto err;
}
cram_h = sam_hdr_dup(h);
if (!cram_h)
goto err;
if (!no_pg && sam_hdr_add_pg(cram_h, "samtools", "VN", samtools_version(),
arg_list ? "CL": NULL,
arg_list ? arg_list : NULL,
NULL))
goto err;
int header_len = sam_hdr_length(cram_h);
/* Fix M5 strings? Maybe out of scope for this tool */
// Find current size of SAM header block
if ((start = hseek(cram_fd_get_fp(fd), 26, SEEK_SET)) != 26)
goto err;
if (!(c = cram_read_container(fd)))
goto err;
// +5 allows num_landmarks to increase from 0 to 1 (Cramtools)
max_container_sz = cram_container_size(c)+5;
sz = htell(cram_fd_get_fp(fd)) + cram_container_get_length(c) - start;
end = htell(cram_fd_get_fp(fd)) + cram_container_get_length(c);
// We force 1 block instead of (optionally) 2. C CRAM
// implementations for v3 were writing 1 compressed block followed
// by 1 uncompressed block. However this is tricky to deal with
// as changing block sizes can mean the block header also changes
// size due to itf8 and variable size integers.
//
// If we had 1 block, this doesn't change anything.
// If we had 2 blocks, the new container header will be smaller by
// 1+ bytes, requiring the cram_container_get_length(c) to be larger in value.
// However this is an int32 instead of itf8 so the container
// header structure stays the same size. This means we can always
// reduce the number of blocks without running into size problems.
cram_container_set_num_blocks(c, 1);
int32_t *landmark;
int32_t num_landmarks;
landmark = cram_container_get_landmarks(c, &num_landmarks);
if (num_landmarks && landmark) {
num_landmarks = 1;
landmark[0] = 0;
} else {
num_landmarks = 0;
}
cram_container_set_landmarks(c, num_landmarks, landmark);
buf = malloc(max_container_sz);
container_sz = max_container_sz;
if (cram_store_container(fd, c, buf, &container_sz) != 0)
goto err;
if (!buf)
goto err;
// Proposed new length, but changing cram_container_get_length(c) may change the
// container_sz and thus the remainder (cram_container_get_length(c) itself).
cram_container_set_length(c, sz - container_sz);
int old_container_sz = container_sz;
container_sz = max_container_sz;
if (cram_store_container(fd, c, buf, &container_sz) != 0)
goto err;
if (old_container_sz != container_sz) {
fprintf(stderr, "Quirk of fate makes this troublesome! "
"Please use non-inplace version.\n");
goto err;
}
// Version 3.0 supports compressed header
b = cram_new_block(FILE_HEADER, 0);
int32_put_blk(b, header_len);
cram_block_append(b, (void *)sam_hdr_str(cram_h), header_len);
cram_block_update_size(b);
cram_compress_block(fd, b, NULL, -1, -1);
if (hseek(cram_fd_get_fp(fd), 26, SEEK_SET) != 26)
goto err;
if (cram_block_size(b) > cram_container_get_length(c)) {
fprintf(stderr, "New header will not fit. Use non-inplace version"
" (%d > %d)\n",
(int)cram_block_size(b), cram_container_get_length(c));
ret = -2;
goto err;
}
if (cram_write_container(fd, c) == -1)
goto err;
if (cram_write_block(fd, b) == -1)
goto err;
// Blank out the remainder
int rsz = end - htell(cram_fd_get_fp(fd));
assert(rsz >= 0);
if (rsz) {
char *rem = calloc(1, rsz);
ret = hwrite(cram_fd_get_fp(fd), rem, rsz) == rsz ? 0 : -1;
free(rem);
}
err:
if (c) cram_free_container(c);
if (buf) free(buf);
if (b) cram_free_block(b);
if (cram_h) sam_hdr_destroy(cram_h);
return ret;
}
int cram_reheader_inplace(cram_fd *fd, sam_hdr_t *h, const char *arg_list,
int no_pg)
{
switch (cram_major_vers(fd)) {
case 2: return cram_reheader_inplace2(fd, h, arg_list, no_pg);
case 3: return cram_reheader_inplace3(fd, h, arg_list, no_pg);
default:
fprintf(stderr, "[%s] unsupported CRAM version %d\n", __func__,
cram_major_vers(fd));
return -1;
}
}
static void usage(FILE *fp, int ret) {
fprintf(fp,
"Usage: samtools reheader [-P] in.header.sam in.bam > out.bam\n"
" or samtools reheader [-P] -i in.header.sam file.cram\n"
" or samtools reheader -c CMD in.bam\n"
" or samtools reheader -c CMD in.cram\n"
"\n"
"Options:\n"
" -P, --no-PG Do not generate a @PG header line.\n"
" -i, --in-place Modify the CRAM file directly, if possible.\n"
" (Defaults to outputting to stdout.)\n"
" -c, --command CMD Pass the header in SAM format to external program CMD.\n");
exit(ret);
}
static sam_hdr_t* external_reheader(samFile* in, const char* external) {
char *command = NULL;
sam_hdr_t* h = NULL;
sam_hdr_t* ih = sam_hdr_read(in);
if (ih == NULL) {
fprintf(stderr, "[%s] failed to read the header for '%s'.\n", __func__, in->fn);
return NULL;
}
char tmp_fn[] = "reheaderXXXXXX";
int tmp_fd = mkstemp(tmp_fn);
if (tmp_fd < 0) {
print_error_errno("reheader", "fail to open temp file '%s'", tmp_fn);
return NULL;
}
hFILE* tmp_hf = hdopen(tmp_fd, "w");
if (!tmp_hf) {
fprintf(stderr, "[%s] failed to convert to hFILE.\n", __func__);
goto cleanup;
}
samFile* tmp_sf = hts_hopen(tmp_hf, tmp_fn, "w");
if (!tmp_sf) {
fprintf(stderr, "[%s] failed to convert to samFile.\n", __func__);
goto cleanup;
}
if (-1 == sam_hdr_write(tmp_sf, ih)) {
fprintf(stderr, "[%s] failed to write the header to the temp file.\n", __func__);
goto cleanup;
}
sam_close(tmp_sf);
sam_hdr_destroy(ih);
int comm_len = strlen(external) + strlen(tmp_fn) + 8;
command = calloc(comm_len, 1);
if (!command || snprintf(command, comm_len, "( %s ) < %s", external, tmp_fn) != comm_len - 1) {
fprintf(stderr, "[%s] failed to create command string.\n", __func__);
goto cleanup;
}
FILE* nh = popen(command, "r");
if (!nh) {
print_error_errno("reheader", "[%s] failed to run external command '%s'.\n", __func__, command);
goto cleanup;
}
int nh_fd = dup(fileno(nh));
if (nh_fd < 0) {
fprintf(stderr, "[%s] failed to get the file descriptor.\n", __func__);
goto cleanup;
}
hFILE* nh_hf = hdopen(nh_fd, "r");
if (!nh_hf) {
fprintf(stderr, "[%s] failed to convert to hFILE.\n", __func__);
goto cleanup;
}
samFile* nh_sf = hts_hopen(nh_hf, tmp_fn, "r");
if (!nh_sf) {
fprintf(stderr, "[%s] failed to convert to samFile.\n", __func__);
goto cleanup;
}
h = sam_hdr_read(nh_sf);
sam_close(nh_sf);
if (h == NULL) {
fprintf(stderr, "[%s] failed to read the header from the temp file.\n", __func__);
}
int res = pclose(nh);
if (res != 0) {
if (res < 0) {
print_error_errno("reheader",
"Error on closing pipe from command '%s'.\n",
command);
} else {
print_error("reheader",
"Non-zero exit code returned by command '%s'\n",
command);
}
if (h) sam_hdr_destroy(h);
h = NULL;
}
cleanup:
free(command);
if (unlink(tmp_fn) != 0) {
print_error_errno("reheader", "failed to remove the temp file '%s'", tmp_fn);
}
return h;
}
int main_reheader(int argc, char *argv[])
{
int inplace = 0, r, no_pg = 0, c, skip_header = 0;
sam_hdr_t *h;
samFile *in;
char *arg_list = NULL, *external = NULL;
static const struct option lopts[] = {
{"help", no_argument, NULL, 'h'},
{"in-place", no_argument, NULL, 'i'},
{"no-PG", no_argument, NULL, 'P'},
{"command", required_argument, NULL, 'c'},
{NULL, 0, NULL, 0}
};
while ((c = getopt_long(argc, argv, "hiPc:", lopts, NULL)) >= 0) {
switch (c) {
case 'P': no_pg = 1; break;
case 'i': inplace = 1; break;
case 'c': external = optarg; break;
case 'h': usage(stdout, 0); break;
default:
fprintf(stderr, "Invalid option '%c'\n", c);
usage(stderr, 1);
}
}
if ((argc - optind != 2 || external) && (argc - optind != 1 || !external))
usage(stderr, 1);
if (!no_pg && !(arg_list = stringify_argv(argc+1, argv-1))) {
print_error("reheader", "failed to create arg_list");
return 1;
}
if (external) {
skip_header = 1;
in = sam_open(argv[optind], inplace?"r+":"r");
if (in == 0) {
print_error_errno("reheader", "fail to open file '%s'", argv[optind]);
return 1;
}
h = external_reheader(in, external);
if (h == NULL) {
fprintf(stderr, "[%s] failed to read the header from '%s'.\n", __func__, external);
sam_close(in);
return 1;
}
} else { // read the header from a separate file
samFile *fph = sam_open(argv[optind], "r");
if (fph == 0) {
print_error_errno("reheader", "fail to read the header from '%s'", argv[optind]);
return 1;
}
h = sam_hdr_read(fph);
sam_close(fph);
if (h == NULL) {
fprintf(stderr, "[%s] failed to read the header for '%s'.\n",
__func__, argv[1]);
return 1;
}
in = sam_open(argv[optind+1], inplace?"r+":"r");
if (in == 0) {
print_error_errno("reheader", "fail to open file '%s'", argv[optind+1]);
return 1;
}
}
if (hts_get_format(in)->format == bam) {
if (inplace) {
print_error("reheader", "cannot reheader BAM '%s' in-place", argv[optind+1]);
r = -1;
} else {
r = bam_reheader(in->fp.bgzf, h, fileno(stdout), arg_list, no_pg, skip_header);
}
} else if (hts_get_format(in)->format == cram) {
if (inplace)
r = cram_reheader_inplace(in->fp.cram, h, arg_list, no_pg);
else
r = cram_reheader(in->fp.cram, h, arg_list, no_pg);
} else {
print_error("reheader", "input file '%s' must be BAM or CRAM", argv[optind+1]);
r = -1;
}
if (sam_close(in) != 0)
r = -1;
sam_hdr_destroy(h);
if (arg_list)
free(arg_list);
return -r;
}
|