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
|
/* bam_split.c -- split subcommand.
Copyright (C) 2013-2016,2018-2019 Genome Research Ltd.
Author: Martin Pollard <mp15@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 <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <limits.h>
#include <unistd.h>
#include <regex.h>
#include <assert.h>
#include <htslib/sam.h>
#include <htslib/khash.h>
#include <htslib/kstring.h>
#include <htslib/cram.h>
#include "htslib/thread_pool.h"
#include "sam_opts.h"
#include "samtools.h"
KHASH_MAP_INIT_STR(c2i, int)
struct parsed_opts {
const char *merged_input_name;
const char *unaccounted_header_name;
const char *unaccounted_name;
const char *output_format_string;
bool verbose;
int no_pg;
sam_global_args ga;
};
typedef struct parsed_opts parsed_opts_t;
struct state {
samFile* merged_input_file;
sam_hdr_t* merged_input_header;
samFile* unaccounted_file;
sam_hdr_t* unaccounted_header;
size_t output_count;
char** rg_id;
char **rg_index_file_name;
char **rg_output_file_name;
samFile** rg_output_file;
sam_hdr_t** rg_output_header;
kh_c2i_t* rg_hash;
htsThreadPool p;
int write_index;
};
typedef struct state state_t;
static int cleanup_state(state_t* status, bool check_close);
static void cleanup_opts(parsed_opts_t* opts);
static void usage(FILE *write_to)
{
fprintf(write_to,
"Usage: samtools split [-u <unaccounted.bam>] [-h <unaccounted_header.sam>]\n"
" [-f <format_string>] [-v] <merged.bam>\n"
"Options:\n"
" -f STRING output filename format string [\"%%*_%%#.%%.\"]\n"
" -u FILE1 put reads with no RG tag or an unrecognised RG tag in FILE1\n"
" -h FILE2 ... and override the header with FILE2 (-u file only)\n"
" -v verbose output\n"
" --no-PG do not add a PG line\n");
sam_global_opt_help(write_to, "-....@..");
fprintf(write_to,
"\n"
"Format string expansions:\n"
" %%%% %%\n"
" %%* basename\n"
" %%# @RG index\n"
" %%! @RG ID\n"
" %%. filename extension for output format\n"
);
}
// Takes the command line options and turns them into something we can understand
static parsed_opts_t* parse_args(int argc, char** argv)
{
if (argc == 1) { usage(stdout); return NULL; }
const char *optstring = "vf:h:u:@:";
static const struct option lopts[] = {
SAM_OPT_GLOBAL_OPTIONS('-', 0, 0, 0, 0, '@'),
{"no-PG", no_argument, NULL, 1},
{ NULL, 0, NULL, 0 }
};
parsed_opts_t* retval = calloc(sizeof(parsed_opts_t), 1);
if (! retval ) { perror("cannot allocate option parsing memory"); return NULL; }
sam_global_args_init(&retval->ga);
int opt;
while ((opt = getopt_long(argc, argv, optstring, lopts, NULL)) != -1) {
switch (opt) {
case 'f':
retval->output_format_string = optarg;
break;
case 'h':
retval->unaccounted_header_name = optarg;
break;
case 'v':
retval->verbose = true;
break;
case 'u':
retval->unaccounted_name = optarg;
break;
case 1:
retval->no_pg = 1;
break;
default:
if (parse_sam_global_opt(opt, optarg, lopts, &retval->ga) == 0) break;
/* else fall-through */
case '?':
usage(stdout);
free(retval);
return NULL;
}
}
if (retval->output_format_string == NULL) retval->output_format_string = "%*_%#.%.";
argc -= optind;
argv += optind;
if (argc != 1) {
print_error("split", "Invalid number of arguments: %d", argc);
usage(stderr);
free(retval);
return NULL;
}
retval->merged_input_name = argv[0];
return retval;
}
// Expands a output filename format string
static char* expand_format_string(const char* format_string, const char* basename, const char* rg_id, const int rg_idx, const htsFormat *format)
{
kstring_t str = { 0, 0, NULL };
const char* pointer = format_string;
const char* next;
while ((next = strchr(pointer, '%')) != NULL) {
if (kputsn(pointer, next-pointer, &str) < 0) goto memfail;
++next;
switch (*next) {
case '%':
if (kputc('%', &str) < 0) goto memfail;
break;
case '*':
if (kputs(basename, &str) < 0) goto memfail;
break;
case '#':
if (kputl(rg_idx, &str) < 0) goto memfail;
break;
case '!':
if (kputs(rg_id, &str) < 0) goto memfail;
break;
case '.':
// Only really need to cope with sam, bam, cram
if (format->format != unknown_format) {
if (kputs(hts_format_file_extension(format), &str) < 0)
goto memfail;
} else {
if (kputs("bam", &str) < 0) goto memfail;
}
break;
case '\0':
print_error("split", "Trailing %% in filename format string");
goto fail;
default:
// Error is: fprintf(stderr, "bad format string, unknown format specifier\n");
print_error("split", "Unknown specifier %%%c in filename format string", *next);
goto fail;
}
pointer = next + 1;
}
if (kputs(pointer, &str) < 0) goto memfail;
return ks_release(&str);
memfail:
print_error_errno("split", "Couldn't build output filename");
fail:
free(str.s);
return NULL;
}
// Parse the header, count the number of RG tags and return a list of their names
static bool count_RG(sam_hdr_t* hdr, size_t* count, char*** output_name)
{
char **names = NULL;
kstring_t id_val = KS_INITIALIZE;
int i, n_rg = sam_hdr_count_lines(hdr, "RG");
if (n_rg < 0) {
print_error("split", "Failed to get @RG IDs");
*count = 0;
*output_name = NULL;
return false;
}
if (n_rg == 0) {
*count = 0;
*output_name = NULL;
return true;
}
names = calloc(n_rg, sizeof(names[0]));
if (!names) goto memfail;
for (i = 0; i < n_rg; i++) {
if (sam_hdr_find_tag_pos(hdr, "RG", i, "ID", &id_val) < 0) goto memfail;
names[i] = ks_release(&id_val);
}
*count = n_rg;
*output_name = names;
return true;
memfail:
print_error_errno("split", "Failed to get @RG IDs");
*count = 0;
*output_name = NULL;
ks_free(&id_val);
free(names);
return false;
}
static int header_compatible(sam_hdr_t *hdr1, sam_hdr_t *hdr2)
{
size_t n;
if (sam_hdr_nref(hdr1) != sam_hdr_nref(hdr2)) {
print_error("split",
"Unaccounted header contains wrong number of references");
return -1;
}
for (n = 0; n < sam_hdr_nref(hdr1); n++) {
hts_pos_t h1_len = sam_hdr_tid2len(hdr1, n);
hts_pos_t h2_len = sam_hdr_tid2len(hdr2, n);
if (h1_len != h2_len) {
print_error("split",
"Unaccounted header reference %zu \"%s\" is not the same length as in the input file",
n + 1, sam_hdr_tid2name(hdr2, n));
return -1;
}
}
return 0;
}
// Set the initial state
static state_t* init(parsed_opts_t* opts, const char *arg_list)
{
state_t* retval = calloc(sizeof(state_t), 1);
if (!retval) {
print_error_errno("split", "Initialisation failed");
return NULL;
}
if (opts->ga.nthreads > 0) {
if (!(retval->p.pool = hts_tpool_init(opts->ga.nthreads))) {
fprintf(stderr, "Error creating thread pool\n");
cleanup_state(retval, false);
return NULL;
}
}
retval->merged_input_file = sam_open_format(opts->merged_input_name, "rb", &opts->ga.in);
if (!retval->merged_input_file) {
print_error_errno("split", "Could not open \"%s\"", opts->merged_input_name);
cleanup_state(retval, false);
return NULL;
}
if (retval->p.pool)
hts_set_opt(retval->merged_input_file, HTS_OPT_THREAD_POOL, &retval->p);
retval->merged_input_header = sam_hdr_read(retval->merged_input_file);
if (retval->merged_input_header == NULL) {
print_error("split", "Could not read header from \"%s\"", opts->merged_input_name);
cleanup_state(retval, false);
return NULL;
}
if (opts->unaccounted_name) {
if (opts->unaccounted_header_name) {
samFile* hdr_load = sam_open_format(opts->unaccounted_header_name, "r", &opts->ga.in);
if (!hdr_load) {
print_error_errno("split", "Could not open unaccounted header file \"%s\"", opts->unaccounted_header_name);
cleanup_state(retval, false);
return NULL;
}
retval->unaccounted_header = sam_hdr_read(hdr_load);
if (retval->unaccounted_header == NULL) {
print_error("split", "Could not read header from \"%s\"", opts->unaccounted_header_name);
cleanup_state(retval, false);
sam_close(hdr_load);
return NULL;
}
sam_close(hdr_load);
if (header_compatible(retval->merged_input_header,
retval->unaccounted_header) != 0) {
cleanup_state(retval, false);
return NULL;
}
} else {
retval->unaccounted_header = sam_hdr_dup(retval->merged_input_header);
if (!opts->no_pg && sam_hdr_add_pg(retval->unaccounted_header, "samtools",
"VN", samtools_version(),
arg_list ? "CL": NULL,
arg_list ? arg_list : NULL,
NULL)) {
print_error("split", "Could not rewrite header for \"%s\"", opts->unaccounted_name);
cleanup_state(retval, false);
return NULL;
}
}
retval->unaccounted_file = sam_open_format(opts->unaccounted_name, "wb", &opts->ga.out);
if (retval->unaccounted_file == NULL) {
print_error_errno("split", "Could not open unaccounted output file \"%s\"", opts->unaccounted_name);
cleanup_state(retval, false);
return NULL;
}
if (retval->p.pool)
hts_set_opt(retval->unaccounted_file, HTS_OPT_THREAD_POOL, &retval->p);
}
// Open output files for RGs
if (!count_RG(retval->merged_input_header, &retval->output_count, &retval->rg_id)) return NULL;
if (opts->verbose) fprintf(stderr, "@RG's found %zu\n",retval->output_count);
// Prevent calloc(0, size);
size_t num = retval->output_count ? retval->output_count : 1;
retval->rg_index_file_name = (char **)calloc(num, sizeof(char *));
retval->rg_output_file_name = (char **)calloc(num, sizeof(char *));
retval->rg_output_file = (samFile**)calloc(num, sizeof(samFile*));
retval->rg_output_header = (sam_hdr_t**)calloc(num, sizeof(sam_hdr_t*));
retval->rg_hash = kh_init_c2i();
if (!retval->rg_output_file_name || !retval->rg_output_file || !retval->rg_output_header ||
!retval->rg_hash || !retval->rg_index_file_name) {
print_error_errno("split", "Could not initialise output file array");
cleanup_state(retval, false);
return NULL;
}
char* dirsep = strrchr(opts->merged_input_name, '/');
char* input_base_name = strdup(dirsep? dirsep+1 : opts->merged_input_name);
if (!input_base_name) {
print_error_errno("split", "Filename manipulation failed");
cleanup_state(retval, false);
return NULL;
}
char* extension = strrchr(input_base_name, '.');
if (extension) *extension = '\0';
size_t i;
for (i = 0; i < retval->output_count; i++) {
char* output_filename = NULL;
output_filename = expand_format_string(opts->output_format_string,
input_base_name,
retval->rg_id[i], i,
&opts->ga.out);
if ( output_filename == NULL ) {
cleanup_state(retval, false);
free(input_base_name);
return NULL;
}
retval->rg_output_file_name[i] = output_filename;
retval->rg_output_file[i] = sam_open_format(output_filename, "wb", &opts->ga.out);
if (retval->rg_output_file[i] == NULL) {
print_error_errno("split", "Could not open \"%s\"", output_filename);
cleanup_state(retval, false);
free(input_base_name);
return NULL;
}
if (retval->p.pool)
hts_set_opt(retval->rg_output_file[i], HTS_OPT_THREAD_POOL, &retval->p);
// Record index in hash
int ret;
khiter_t iter = kh_put_c2i(retval->rg_hash, retval->rg_id[i], &ret);
if (ret < 0) {
print_error_errno("split", "Couldn't add @RG ID to look-up table");
cleanup_state(retval, false);
free(input_base_name);
return NULL;
}
kh_val(retval->rg_hash,iter) = i;
// Set and edit header
retval->rg_output_header[i] = sam_hdr_dup(retval->merged_input_header);
if (sam_hdr_remove_except(retval->rg_output_header[i], "RG", "ID", retval->rg_id[i]) ||
(!opts->no_pg &&
sam_hdr_add_pg(retval->rg_output_header[i], "samtools",
"VN", samtools_version(),
arg_list ? "CL": NULL,
arg_list ? arg_list : NULL,
NULL))) {
print_error("split", "Could not rewrite header for \"%s\"", output_filename);
cleanup_state(retval, false);
free(input_base_name);
return NULL;
}
}
free(input_base_name);
retval->write_index = opts->ga.write_index;
return retval;
}
static bool split(state_t* state)
{
if (state->unaccounted_file && sam_hdr_write(state->unaccounted_file, state->unaccounted_header) != 0) {
print_error_errno("split", "Could not write output file header");
return false;
}
size_t i;
for (i = 0; i < state->output_count; i++) {
if (sam_hdr_write(state->rg_output_file[i], state->rg_output_header[i]) != 0) {
print_error_errno("split", "Could not write file header to \"%s\"", state->rg_output_file_name[i]);
return false;
}
if (state->write_index) {
state->rg_index_file_name[i] = auto_index(state->rg_output_file[i],
state->rg_output_file_name[i],
state->rg_output_header[i]);
if (!state->rg_index_file_name[i]) {
print_error_errno("split", "Could not create index for file \"%s\"", state->rg_output_file_name[i]);
return false;
}
}
}
bam1_t* file_read = bam_init1();
// Read the first record
int r;
if ((r=sam_read1(state->merged_input_file, state->merged_input_header, file_read)) < 0) {
// Nothing more to read? Ignore this file
bam_destroy1(file_read);
file_read = NULL;
if (r < -1) {
print_error("split", "Could not read first input record");
return false;
}
}
while (file_read != NULL) {
// Get RG tag from read and look it up in hash to find file to output it to
uint8_t* tag = bam_aux_get(file_read, "RG");
khiter_t iter;
if ( tag != NULL ) {
char* rg = bam_aux2Z(tag);
iter = kh_get_c2i(state->rg_hash, rg);
} else {
iter = kh_end(state->rg_hash);
}
// Write the read out to correct file
if (iter != kh_end(state->rg_hash)) {
// if found write to the appropriate untangled bam
int i = kh_val(state->rg_hash,iter);
if (sam_write1(state->rg_output_file[i], state->rg_output_header[i], file_read) < 0) {
print_error_errno("split", "Could not write to \"%s\"", state->rg_output_file_name[i]);
bam_destroy1(file_read);
return false;
}
} else {
// otherwise write to the unaccounted bam if there is one or fail
if (state->unaccounted_file == NULL) {
if (tag) {
fprintf(stderr, "Read \"%s\" with unaccounted for tag \"%s\".\n", bam_get_qname(file_read), bam_aux2Z(tag));
} else {
fprintf(stderr, "Read \"%s\" has no RG tag.\n", bam_get_qname(file_read));
}
bam_destroy1(file_read);
return false;
} else {
if (sam_write1(state->unaccounted_file, state->unaccounted_header, file_read) < 0) {
print_error_errno("split", "Could not write to unaccounted output file");
bam_destroy1(file_read);
return false;
}
}
}
// Replace written read with the next one to process
if ((r=sam_read1(state->merged_input_file, state->merged_input_header, file_read)) < 0) {
// Nothing more to read? Ignore this file in future
bam_destroy1(file_read);
file_read = NULL;
if (r < -1) {
print_error("split", "Could not read input record");
return false;
}
}
}
if (state->write_index) {
for (i = 0; i < state->output_count; i++) {
if (sam_idx_save(state->rg_output_file[i]) < 0) {
print_error_errno("split", "writing index failed");
return false;
}
free(state->rg_index_file_name[i]);
}
}
return true;
}
static int cleanup_state(state_t* status, bool check_close)
{
int ret = 0;
if (!status) return 0;
if (status->unaccounted_header) sam_hdr_destroy(status->unaccounted_header);
if (status->unaccounted_file) {
if (sam_close(status->unaccounted_file) < 0 && check_close) {
print_error("split", "Error on closing unaccounted file");
ret = -1;
}
}
sam_close(status->merged_input_file);
size_t i;
for (i = 0; i < status->output_count; i++) {
if (status->rg_output_header && status->rg_output_header[i])
sam_hdr_destroy(status->rg_output_header[i]);
if (status->rg_output_file && status->rg_output_file[i]) {
if (sam_close(status->rg_output_file[i]) < 0 && check_close) {
print_error("split", "Error on closing output file \"%s\"", status->rg_output_file_name[i]);
ret = -1;
}
}
if (status->rg_id) free(status->rg_id[i]);
if (status->rg_output_file_name) free(status->rg_output_file_name[i]);
}
if (status->merged_input_header)
sam_hdr_destroy(status->merged_input_header);
free(status->rg_output_header);
free(status->rg_output_file);
free(status->rg_output_file_name);
free(status->rg_index_file_name);
kh_destroy_c2i(status->rg_hash);
free(status->rg_id);
if (status->p.pool)
hts_tpool_destroy(status->p.pool);
free(status);
return ret;
}
static void cleanup_opts(parsed_opts_t* opts)
{
if (!opts) return;
sam_global_args_free(&opts->ga);
free(opts);
}
int main_split(int argc, char** argv)
{
int ret = 1;
char *arg_list = NULL;
parsed_opts_t* opts = parse_args(argc, argv);
if (!opts) goto cleanup_opts;
if (!opts->no_pg && !(arg_list = stringify_argv(argc+1, argv-1)))
goto cleanup_opts;
state_t* status = init(opts, arg_list);
if (!status) goto cleanup_opts;
if (!split(status)) {
cleanup_state(status, false);
goto cleanup_opts;
}
ret = cleanup_state(status, true);
cleanup_opts:
cleanup_opts(opts);
free(arg_list);
return ret;
}
|