BamMultiReader.cpp

   1 // ***************************************************************************
   2 // BamMultiReader.cpp (c) 2010 Erik Garrison
   3 // Marth Lab, Department of Biology, Boston College
   4 // All rights reserved.
   5 // ---------------------------------------------------------------------------
   6 // Last modified: 23 Februrary 2010 (EG)
   7 // ---------------------------------------------------------------------------
   8 // Uses BGZF routines were adapted from the bgzf.c code developed at the Broad
   9 // Institute.
  10 // ---------------------------------------------------------------------------
  11 // Functionality for simultaneously reading multiple BAM files.
  12 //
  13 // This functionality allows applications to work on very large sets of files
  14 // without requiring intermediate merge, sort, and index steps for each file
  15 // subset.  It also improves the performance of our merge system as it
  16 // precludes the need to sort merged files.
  17 // ***************************************************************************
  18
  19 // C++ includes
  20 #include <algorithm>
  21 #include <iterator>
  22 #include <string>
  23 #include <vector>
  24 #include <iostream>
  25 #include <sstream>
  26
  27 // BamTools includes
  28 #include "BGZF.h"
  29 #include "BamMultiReader.h"
  30 using namespace BamTools;
  31 using namespace std;
  32
  33 // -----------------------------------------------------
  34 // BamMultiReader implementation
  35 // -----------------------------------------------------
  36
  37 // constructor
  38 BamMultiReader::BamMultiReader(void)
  39     : CurrentRefID(0)
  40     , CurrentLeft(0)
  41 { }
  42
  43 // destructor
  44 BamMultiReader::~BamMultiReader(void) {
  45     Close(); // close the bam files
  46     // clean up reader objects
  47     for (vector<pair<BamReader*, BamAlignment*> >::iterator it = readers.begin(); it != readers.end(); ++it) {
  48         delete it->first;
  49         delete it->second;
  50     }
  51 }
  52
  53 // close the BAM files
  54 void BamMultiReader::Close(void) {
  55     for (vector<pair<BamReader*, BamAlignment*> >::iterator it = readers.begin(); it != readers.end(); ++it) {
  56         BamReader* reader = it->first;
  57         reader->Close();  // close the reader
  58     }
  59 }
  60
  61 // updates the reference id stored in the BamMultiReader
  62 // to reflect the current state of the readers
  63 void BamMultiReader::UpdateReferenceID(void) {
  64     // the alignments are sorted by position, so the first alignment will always have the lowest reference ID
  65     if (alignments.begin()->second.second->RefID != CurrentRefID) {
  66         // get the next reference id
  67         // while there aren't any readers at the next ref id
  68         // increment the ref id
  69         int nextRefID = CurrentRefID;
  70         while (alignments.begin()->second.second->RefID != nextRefID) {
  71             ++nextRefID;
  72         }
  73         //cerr << "updating reference id from " << CurrentRefID << " to " << nextRefID << endl;
  74         CurrentRefID = nextRefID;
  75     }
  76 }
  77
  78 // checks if any readers still have alignments
  79 bool BamMultiReader::HasOpenReaders() {
  80     return alignments.size() > 0;
  81 }
  82
  83 // get next alignment among all files
  84 bool BamMultiReader::GetNextAlignment(BamAlignment& nextAlignment) {
  85
  86     // bail out if we are at EOF in all files, means no more alignments to process
  87     if (!HasOpenReaders())
  88         return false;
  89
  90     // when all alignments have stepped into a new target sequence, update our
  91     // current reference sequence id
  92     UpdateReferenceID();
  93
  94     // our lowest alignment and reader will be at the front of our alignment index
  95     BamAlignment* alignment = alignments.begin()->second.second;
  96     BamReader* reader = alignments.begin()->second.first;
  97
  98     // now that we have the lowest alignment in the set, save it by copy to our argument
  99     nextAlignment = BamAlignment(*alignment);
 100
 101     // remove this alignment index entry from our alignment index
 102     alignments.erase(alignments.begin());
 103
 104     // and add another entry if we can get another alignment from the reader
 105     if (reader->GetNextAlignment(*alignment)) {
 106         alignments.insert(make_pair(make_pair(alignment->RefID, alignment->Position),
 107                                     make_pair(reader, alignment)));
 108     } else { // do nothing
 109         //cerr << "reached end of file " << lowestReader->GetFilename() << endl;
 110     }
 111
 112     return true;
 113
 114 }
 115
 116 // get next alignment among all files without parsing character data from alignments
 117 bool BamMultiReader::GetNextAlignmentCore(BamAlignment& nextAlignment) {
 118
 119     // bail out if we are at EOF in all files, means no more alignments to process
 120     if (!HasOpenReaders())
 121         return false;
 122
 123     // when all alignments have stepped into a new target sequence, update our
 124     // current reference sequence id
 125     UpdateReferenceID();
 126
 127     // our lowest alignment and reader will be at the front of our alignment index
 128     BamAlignment* alignment = alignments.begin()->second.second;
 129     BamReader* reader = alignments.begin()->second.first;
 130
 131     // now that we have the lowest alignment in the set, save it by copy to our argument
 132     nextAlignment = BamAlignment(*alignment);
 133     //memcpy(&nextAlignment, alignment, sizeof(BamAlignment));
 134
 135     // remove this alignment index entry from our alignment index
 136     alignments.erase(alignments.begin());
 137
 138     // and add another entry if we can get another alignment from the reader
 139     if (reader->GetNextAlignmentCore(*alignment)) {
 140         alignments.insert(make_pair(make_pair(alignment->RefID, alignment->Position),
 141                                     make_pair(reader, alignment)));
 142     } else { // do nothing
 143         //cerr << "reached end of file " << lowestReader->GetFilename() << endl;
 144     }
 145
 146     return true;
 147
 148 }
 149
 150 // jumps to specified region(refID, leftBound) in BAM files, returns success/fail
 151 bool BamMultiReader::Jump(int refID, int position) {
 152
 153     //if ( References.at(refID).RefHasAlignments && (position <= References.at(refID).RefLength) ) {
 154     CurrentRefID = refID;
 155     CurrentLeft  = position;
 156
 157     bool result = true;
 158     for (vector<pair<BamReader*, BamAlignment*> >::iterator it = readers.begin(); it != readers.end(); ++it) {
 159         BamReader* reader = it->first;
 160         result &= reader->Jump(refID, position);
 161         if (!result) {
 162             cerr << "ERROR: could not jump " << reader->GetFilename() << " to " << refID << ":" << position << endl;
 163             exit(1);
 164         }
 165     }
 166     if (result) UpdateAlignments();
 167     return result;
 168 }
 169
 170 bool BamMultiReader::SetRegion(const int& leftRefID, const int& leftPosition, const int& rightRefID, const int& rightPosition) {
 171
 172     BamRegion region(leftRefID, leftPosition, rightRefID, rightPosition);
 173
 174     return SetRegion(region);
 175
 176 }
 177
 178 bool BamMultiReader::SetRegion(const BamRegion& region) {
 179
 180     Region = region;
 181
 182     bool result = true;
 183     for (vector<pair<BamReader*, BamAlignment*> >::iterator it = readers.begin(); it != readers.end(); ++it) {
 184         BamReader* reader = it->first;
 185         result &= reader->SetRegion(region);
 186         if (!result) {
 187             cerr << "ERROR: could not set region " << reader->GetFilename() << " to "
 188                 << region.LeftRefID << ":" << region.LeftPosition << ".." << region.RightRefID << ":" << region.RightPosition
 189                 << endl;
 190             exit(1);
 191         }
 192     }
 193     if (result) UpdateAlignments();
 194     return result;
 195
 196 }
 197
 198 void BamMultiReader::UpdateAlignments(void) {
 199     // Update Alignments
 200     alignments.clear();
 201     for (vector<pair<BamReader*, BamAlignment*> >::iterator it = readers.begin(); it != readers.end(); ++it) {
 202         BamReader* br = it->first;
 203         BamAlignment* ba = it->second;
 204         if (br->GetNextAlignment(*ba)) {
 205             alignments.insert(make_pair(make_pair(ba->RefID, ba->Position),
 206                                         make_pair(br, ba)));
 207         } else {
 208             // assume BamReader end of region / EOF
 209         }
 210     }
 211 }
 212
 213 // opens BAM files
 214 void BamMultiReader::Open(const vector<string> filenames, bool openIndexes, bool coreMode) {
 215     // for filename in filenames
 216     fileNames = filenames; // save filenames in our multireader
 217     for (vector<string>::const_iterator it = filenames.begin(); it != filenames.end(); ++it) {
 218         string filename = *it;
 219         BamReader* reader = new BamReader;
 220         if (openIndexes) {
 221             reader->Open(filename, filename + ".bai");
 222         } else {
 223             reader->Open(filename); // for merging, jumping is disallowed
 224         }
 225         BamAlignment* alignment = new BamAlignment;
 226         if (coreMode) {
 227             reader->GetNextAlignmentCore(*alignment);
 228         } else {
 229             reader->GetNextAlignment(*alignment);
 230         }
 231         readers.push_back(make_pair(reader, alignment)); // store pointers to our readers for cleanup
 232         alignments.insert(make_pair(make_pair(alignment->RefID, alignment->Position),
 233                                     make_pair(reader, alignment)));
 234     }
 235     ValidateReaders();
 236 }
 237
 238 void BamMultiReader::PrintFilenames(void) {
 239     for (vector<pair<BamReader*, BamAlignment*> >::iterator it = readers.begin(); it != readers.end(); ++it) {
 240         BamReader* reader = it->first;
 241         cout << reader->GetFilename() << endl;
 242     }
 243 }
 244
 245 // for debugging
 246 void BamMultiReader::DumpAlignmentIndex(void) {
 247     for (AlignmentIndex::const_iterator it = alignments.begin(); it != alignments.end(); ++it) {
 248         cerr << it->first.first << ":" << it->first.second << " " << it->second.first->GetFilename() << endl;
 249     }
 250 }
 251
 252 // returns BAM file pointers to beginning of alignment data
 253 bool BamMultiReader::Rewind(void) {
 254     bool result = true;
 255     for (vector<pair<BamReader*, BamAlignment*> >::iterator it = readers.begin(); it != readers.end(); ++it) {
 256         BamReader* reader = it->first;
 257         result &= reader->Rewind();
 258     }
 259     return result;
 260 }
 261
 262 // saves index data to BAM index files (".bai") where necessary, returns success/fail
 263 bool BamMultiReader::CreateIndexes(void) {
 264     bool result = true;
 265     for (vector<pair<BamReader*, BamAlignment*> >::iterator it = readers.begin(); it != readers.end(); ++it) {
 266         BamReader* reader = it->first;
 267         result &= reader->CreateIndex();
 268     }
 269     return result;
 270 }
 271
 272 // makes a virtual, unified header for all the bam files in the multireader
 273 const string BamMultiReader::GetHeaderText(void) const {
 274
 275     string mergedHeader = "";
 276     map<string, bool> readGroups;
 277
 278     // foreach extraction entry (each BAM file)
 279     for (vector<pair<BamReader*, BamAlignment*> >::const_iterator rs = readers.begin(); rs != readers.end(); ++rs) {
 280
 281         map<string, bool> currentFileReadGroups;
 282
 283         BamReader* reader = rs->first;
 284
 285         stringstream header(reader->GetHeaderText());
 286         vector<string> lines;
 287         string item;
 288         while (getline(header, item))
 289             lines.push_back(item);
 290
 291         for (vector<string>::const_iterator it = lines.begin(); it != lines.end(); ++it) {
 292
 293             // get next line from header, skip if empty
 294             string headerLine = *it;
 295             if ( headerLine.empty() ) { continue; }
 296
 297             // if first file, save HD & SQ entries
 298             if ( rs == readers.begin() ) {
 299                 if ( headerLine.find("@HD") == 0 || headerLine.find("@SQ") == 0) {
 300                     mergedHeader.append(headerLine.c_str());
 301                     mergedHeader.append(1, '\n');
 302                 }
 303             }
 304
 305             // (for all files) append RG entries if they are unique
 306             if ( headerLine.find("@RG") == 0 ) {
 307                 stringstream headerLineSs(headerLine);
 308                 string part, readGroupPart, readGroup;
 309                 while(std::getline(headerLineSs, part, '\t')) {
 310                     stringstream partSs(part);
 311                     string subtag;
 312                     std::getline(partSs, subtag, ':');
 313                     if (subtag == "ID") {
 314                         std::getline(partSs, readGroup, ':');
 315                         break;
 316                     }
 317                 }
 318                 if (readGroups.find(readGroup) == readGroups.end()) { // prevents duplicate @RG entries
 319                     mergedHeader.append(headerLine.c_str() );
 320                     mergedHeader.append(1, '\n');
 321                     readGroups[readGroup] = true;
 322                     currentFileReadGroups[readGroup] = true;
 323                 } else {
 324                     // warn iff we are reading one file and discover duplicated @RG tags in the header
 325                     // otherwise, we emit no warning, as we might be merging multiple BAM files with identical @RG tags
 326                     if (currentFileReadGroups.find(readGroup) != currentFileReadGroups.end()) {
 327                         cerr << "WARNING: duplicate @RG tag " << readGroup
 328                             << " entry in header of " << reader->GetFilename() << endl;
 329                     }
 330                 }
 331             }
 332         }
 333     }
 334
 335     // return merged header text
 336     return mergedHeader;
 337 }
 338
 339 // ValidateReaders checks that all the readers point to BAM files representing
 340 // alignments against the same set of reference sequences, and that the
 341 // sequences are identically ordered.  If these checks fail the operation of
 342 // the multireader is undefined, so we force program exit.
 343 void BamMultiReader::ValidateReaders(void) const {
 344     int firstRefCount = readers.front().first->GetReferenceCount();
 345     BamTools::RefVector firstRefData = readers.front().first->GetReferenceData();
 346     for (vector<pair<BamReader*, BamAlignment*> >::const_iterator it = readers.begin(); it != readers.end(); ++it) {
 347         BamReader* reader = it->first;
 348         BamTools::RefVector currentRefData = reader->GetReferenceData();
 349         BamTools::RefVector::const_iterator f = firstRefData.begin();
 350         BamTools::RefVector::const_iterator c = currentRefData.begin();
 351         if (reader->GetReferenceCount() != firstRefCount || firstRefData.size() != currentRefData.size()) {
 352             cerr << "ERROR: mismatched number of references in " << reader->GetFilename()
 353                       << " expected " << firstRefCount
 354                       << " reference sequences but only found " << reader->GetReferenceCount() << endl;
 355             exit(1);
 356         }
 357         // this will be ok; we just checked above that we have identically-sized sets of references
 358         // here we simply check if they are all, in fact, equal in content
 359         while (f != firstRefData.end()) {
 360             if (f->RefName != c->RefName || f->RefLength != c->RefLength) {
 361                 cerr << "ERROR: mismatched references found in " << reader->GetFilename()
 362                           << " expected: " << endl;
 363                 for (BamTools::RefVector::const_iterator a = firstRefData.begin(); a != firstRefData.end(); ++a)
 364                     cerr << a->RefName << " " << a->RefLength << endl;
 365                 cerr << "but found: " << endl;
 366                 for (BamTools::RefVector::const_iterator a = currentRefData.begin(); a != currentRefData.end(); ++a)
 367                     cerr << a->RefName << " " << a->RefLength << endl;
 368                 exit(1);
 369             }
 370             ++f; ++c;
 371         }
 372     }
 373 }
 374
 375 // NB: The following functions assume that we have identical references for all
 376 // BAM files.  We enforce this by invoking the above validation function
 377 // (ValidateReaders) to verify that our reference data is the same across all
 378 // files on Open, so we will not encounter a situation in which there is a
 379 // mismatch and we are still live.
 380
 381 // returns the number of reference sequences
 382 const int BamMultiReader::GetReferenceCount(void) const {
 383     return readers.front().first->GetReferenceCount();
 384 }
 385
 386 // returns vector of reference objects
 387 const BamTools::RefVector BamMultiReader::GetReferenceData(void) const {
 388     return readers.front().first->GetReferenceData();
 389 }
 390
 391 const int BamMultiReader::GetReferenceID(const string& refName) const {
 392     return readers.front().first->GetReferenceID(refName);
 393 }