src/api/internal/BamStandardIndex_p.cpp

   1 // ***************************************************************************
   2 // BamStandardIndex.cpp (c) 2010 Derek Barnett
   3 // Marth Lab, Department of Biology, Boston College
   4 // All rights reserved.
   5 // ---------------------------------------------------------------------------
   6 // Last modified: 27 April 2011 (DB)
   7 // ---------------------------------------------------------------------------
   8 // Provides index operations for the standardized BAM index format (".bai")
   9 // ***************************************************************************
  10
  11 #include <api/BamAlignment.h>
  12 #include <api/internal/BamReader_p.h>
  13 #include <api/internal/BamStandardIndex_p.h>
  14 using namespace BamTools;
  15 using namespace BamTools::Internal;
  16
  17 #include <cstdio>
  18 #include <cstdlib>
  19 #include <cstring>
  20 #include <algorithm>
  21 #include <iostream>
  22 using namespace std;
  23
  24 // static BamStandardIndex constants
  25 const int BamStandardIndex::MAX_BIN               = 37450;  // =(8^6-1)/7+1
  26 const int BamStandardIndex::BAM_LIDX_SHIFT        = 14;
  27 const string BamStandardIndex::BAI_EXTENSION      = ".bai";
  28 const char* const BamStandardIndex::BAI_MAGIC     = "BAI\1";
  29 const int BamStandardIndex::SIZEOF_ALIGNMENTCHUNK = sizeof(uint64_t)*2;
  30 const int BamStandardIndex::SIZEOF_BINCORE        = sizeof(uint32_t) + sizeof(int32_t);
  31 const int BamStandardIndex::SIZEOF_LINEAROFFSET   = sizeof(uint64_t);
  32
  33 // ctor
  34 BamStandardIndex::BamStandardIndex(Internal::BamReaderPrivate* reader)
  35     : BamIndex(reader)
  36     , m_indexStream(0)
  37     , m_cacheMode(BamIndex::LimitedIndexCaching)
  38     , m_buffer(0)
  39     , m_bufferLength(0)
  40 {
  41      m_isBigEndian = BamTools::SystemIsBigEndian();
  42 }
  43
  44 // dtor
  45 BamStandardIndex::~BamStandardIndex(void) {
  46     CloseFile();
  47 }
  48
  49 bool BamStandardIndex::AdjustRegion(const BamRegion& region, uint32_t& begin, uint32_t& end) {
  50
  51     // retrieve references from reader
  52     const RefVector& references = m_reader->GetReferenceData();
  53
  54     // make sure left-bound position is valid
  55     if ( region.LeftPosition > references.at(region.LeftRefID).RefLength )
  56         return false;
  57
  58     // set region 'begin'
  59     begin = (unsigned int)region.LeftPosition;
  60
  61     // if right bound specified AND left&right bounds are on same reference
  62     // OK to use right bound position as region 'end'
  63     if ( region.isRightBoundSpecified() && ( region.LeftRefID == region.RightRefID ) )
  64         end = (unsigned int)region.RightPosition;
  65
  66     // otherwise, set region 'end' to last reference base
  67     else end = (unsigned int)references.at(region.LeftRefID).RefLength - 1;
  68
  69     // return success
  70     return true;
  71 }
  72
  73 void BamStandardIndex::CalculateCandidateBins(const uint32_t& begin,
  74                                               const uint32_t& end,
  75                                               set<uint16_t>& candidateBins)
  76 {
  77     // initialize list, bin '0' is always a valid bin
  78     candidateBins.insert(0);
  79
  80     // get rest of bins that contain this region
  81     unsigned int k;
  82     for (k =    1 + (begin>>26); k <=    1 + (end>>26); ++k) { candidateBins.insert(k); }
  83     for (k =    9 + (begin>>23); k <=    9 + (end>>23); ++k) { candidateBins.insert(k); }
  84     for (k =   73 + (begin>>20); k <=   73 + (end>>20); ++k) { candidateBins.insert(k); }
  85     for (k =  585 + (begin>>17); k <=  585 + (end>>17); ++k) { candidateBins.insert(k); }
  86     for (k = 4681 + (begin>>14); k <= 4681 + (end>>14); ++k) { candidateBins.insert(k); }
  87 }
  88
  89 bool BamStandardIndex::CalculateCandidateOffsets(const BaiReferenceSummary& refSummary,
  90                                                  const uint64_t& minOffset,
  91                                                  set<uint16_t>& candidateBins,
  92                                                  vector<int64_t>& offsets)
  93 {
  94     // attempt seek to first bin
  95     if ( !Seek(refSummary.FirstBinFilePosition, SEEK_SET) )
  96         return false;
  97
  98     // iterate over reference bins
  99     uint32_t binId;
 100     int32_t numAlignmentChunks;
 101     set<uint16_t>::iterator candidateBinIter;
 102     for ( int i = 0; i < refSummary.NumBins; ++i ) {
 103
 104         // read bin contents (if successful, alignment chunks are now in m_buffer)
 105         if ( !ReadBinIntoBuffer(binId, numAlignmentChunks) )
 106             return false;
 107
 108         // see if bin is a 'candidate bin'
 109         candidateBinIter = candidateBins.find(binId);
 110
 111         // if not, move on to next bin
 112         if ( candidateBinIter == candidateBins.end() )
 113             continue;
 114
 115         // otherwise, check bin's contents against for overlap
 116         else {
 117
 118             unsigned int offset = 0;
 119             uint64_t chunkStart;
 120             uint64_t chunkStop;
 121
 122             // iterate over alignment chunks
 123             for (int j = 0; j < numAlignmentChunks; ++j ) {
 124
 125                 // read chunk start & stop from buffer
 126                 memcpy((char*)&chunkStart, m_buffer+offset, sizeof(uint64_t));
 127                 offset += sizeof(uint64_t);
 128                 memcpy((char*)&chunkStop, m_buffer, sizeof(uint64_t));
 129                 offset += sizeof(uint64_t);
 130
 131                 // swap endian-ness if necessary
 132                 if ( m_isBigEndian ) {
 133                     SwapEndian_64(chunkStart);
 134                     SwapEndian_64(chunkStop);
 135                 }
 136
 137                 // store alignment chunk's start offset
 138                 // if its stop offset is larger than our 'minOffset'
 139                 if ( chunkStop > minOffset )
 140                     offsets.push_back(chunkStart);
 141             }
 142
 143             // 'pop' bin ID from candidate bins set
 144             candidateBins.erase(candidateBinIter);
 145
 146             // quit if no more candidates
 147             if ( candidateBins.empty() )
 148                 break;
 149         }
 150     }
 151
 152     // return success/failure on calculating at least 1 offset
 153     return ( !offsets.empty() );
 154 }
 155
 156 uint64_t BamStandardIndex::CalculateMinOffset(const BaiReferenceSummary& refSummary,
 157                                               const uint32_t& begin)
 158 {
 159     // if no linear offsets exist, return 0
 160     if ( refSummary.NumLinearOffsets == 0 )
 161         return 0;
 162
 163     // if 'begin' starts beyond last linear offset, use the last linear offset as minimum
 164     // else use the offset corresponding to the requested start position
 165     const int shiftedBegin = begin>>BamStandardIndex::BAM_LIDX_SHIFT;
 166     if ( shiftedBegin >= refSummary.NumLinearOffsets )
 167         return LookupLinearOffset( refSummary, refSummary.NumLinearOffsets-1 );
 168     else
 169         return LookupLinearOffset( refSummary, shiftedBegin );
 170 }
 171
 172 void BamStandardIndex::CheckBufferSize(char*& buffer,
 173                                        unsigned int& bufferLength,
 174                                        const unsigned int& requestedBytes)
 175 {
 176     try {
 177         if ( requestedBytes > bufferLength ) {
 178             bufferLength = requestedBytes + 10;
 179             delete[] buffer;
 180             buffer = new char[bufferLength];
 181         }
 182     } catch ( std::bad_alloc ) {
 183         cerr << "BamStandardIndex ERROR: out of memory when allocating "
 184              << requestedBytes << " byes" << endl;
 185         exit(1);
 186     }
 187 }
 188
 189 void BamStandardIndex::CheckBufferSize(unsigned char*& buffer,
 190                                        unsigned int& bufferLength,
 191                                        const unsigned int& requestedBytes)
 192 {
 193     try {
 194         if ( requestedBytes > bufferLength ) {
 195             bufferLength = requestedBytes + 10;
 196             delete[] buffer;
 197             buffer = new unsigned char[bufferLength];
 198         }
 199     } catch ( std::bad_alloc ) {
 200         cerr << "BamStandardIndex ERROR: out of memory when allocating "
 201              << requestedBytes << " byes" << endl;
 202         exit(1);
 203     }
 204 }
 205
 206 bool BamStandardIndex::CheckMagicNumber(void) {
 207
 208     // check 'magic number' to see if file is BAI index
 209     char magic[4];
 210     size_t elementsRead = fread(magic, sizeof(char), 4, m_indexStream);
 211     if ( elementsRead != 4 ) {
 212         cerr << "BamStandardIndex ERROR: could not read format 'magic number'" << endl;
 213         return false;
 214     }
 215
 216     // compare to expected value
 217     if ( strncmp(magic, BamStandardIndex::BAI_MAGIC, 4) != 0 ) {
 218         cerr << "BamStandardIndex ERROR: invalid format" << endl;
 219         return false;
 220     }
 221
 222     // otherwise OK
 223     return true;
 224 }
 225
 226 void BamStandardIndex::ClearReferenceEntry(BaiReferenceEntry& refEntry) {
 227     refEntry.ID = -1;
 228     refEntry.Bins.clear();
 229     refEntry.LinearOffsets.clear();
 230 }
 231
 232 void BamStandardIndex::CloseFile(void) {
 233
 234     // close file stream
 235     if ( IsFileOpen() )
 236         fclose(m_indexStream);
 237
 238     // clear index file summary data
 239     m_indexFileSummary.clear();
 240
 241     // clean up I/O buffer
 242     delete[] m_buffer;
 243     m_buffer = 0;
 244     m_bufferLength = 0;
 245 }
 246
 247 // builds index from associated BAM file & writes out to index file
 248 bool BamStandardIndex::Create(void) {
 249
 250     // return false if BamReader is invalid or not open
 251     if ( m_reader == 0 || !m_reader->IsOpen() ) {
 252         cerr << "BamStandardIndex ERROR: BamReader is not open"
 253              << ", aborting index creation" << endl;
 254         return false;
 255     }
 256
 257     // rewind BamReader
 258     if ( !m_reader->Rewind() ) {
 259         cerr << "BamStandardIndex ERROR: could not rewind BamReader to create index"
 260              << ", aborting index creation" << endl;
 261         return false;
 262     }
 263
 264     // open new index file (read & write)
 265     string indexFilename = m_reader->Filename() + Extension();
 266     if ( !OpenFile(indexFilename, "w+b") ) {
 267         cerr << "BamStandardIndex ERROR: could not open ouput index file: " << indexFilename
 268              << ", aborting index creation" << endl;
 269         return false;
 270     }
 271
 272     // initialize BaiFileSummary with number of references
 273     const int& numReferences = m_reader->GetReferenceCount();
 274     ReserveForSummary(numReferences);
 275
 276     // initialize output file
 277     bool createdOk = true;
 278     createdOk &= WriteHeader();
 279
 280     // set up bin, ID, offset, & coordinate markers
 281     const uint32_t defaultValue = 0xffffffffu;
 282     uint32_t currentBin    = defaultValue;
 283     uint32_t lastBin       = defaultValue;
 284     int32_t  currentRefID  = defaultValue;
 285     int32_t  lastRefID     = defaultValue;
 286     uint64_t currentOffset = (uint64_t)m_reader->Tell();
 287     uint64_t lastOffset    = currentOffset;
 288     int32_t  lastPosition  = defaultValue;
 289
 290     // iterate through alignments in BAM file
 291     BamAlignment al;
 292     BaiReferenceEntry refEntry;
 293     while ( m_reader->LoadNextAlignment(al) ) {
 294
 295         // changed to new reference
 296         if ( lastRefID != al.RefID ) {
 297
 298             // if not first reference, save previous reference data
 299             if ( lastRefID != (int32_t)defaultValue ) {
 300
 301                 SaveAlignmentChunkToBin(refEntry.Bins, currentBin, currentOffset, lastOffset);
 302                 createdOk &= WriteReferenceEntry(refEntry);
 303                 ClearReferenceEntry(refEntry);
 304
 305                 // write any empty references between (but *NOT* including) lastRefID & al.RefID
 306                 for ( int i = lastRefID+1; i < al.RefID; ++i ) {
 307                     BaiReferenceEntry emptyEntry(i);
 308                     createdOk &= WriteReferenceEntry(emptyEntry);
 309                 }
 310
 311                 // update bin markers
 312                 currentOffset = lastOffset;
 313                 currentBin    = al.Bin;
 314                 lastBin       = al.Bin;
 315                 currentRefID  = al.RefID;
 316             }
 317
 318             // first pass
 319             // write any empty references up to (but *NOT* including) al.RefID
 320             else {
 321                 for ( int i = 0; i < al.RefID; ++i ) {
 322                     BaiReferenceEntry emptyEntry(i);
 323                     createdOk &= WriteReferenceEntry(emptyEntry);
 324                 }
 325             }
 326
 327             // update reference markers
 328             refEntry.ID = al.RefID;
 329             lastRefID   = al.RefID;
 330             lastBin     = defaultValue;
 331         }
 332
 333         // if lastPosition greater than current alignment position - file not sorted properly
 334         else if ( lastPosition > al.Position ) {
 335             cerr << "BamStandardIndex ERROR: BAM file is not properly sorted by coordinate"
 336                  << ", aborting index creation"
 337                  << endl
 338                  << "At alignment: " << al.Name
 339                  << " : previous position " << lastPosition
 340                  << " > this alignment position " << al.Position
 341                  << " on reference id: " << al.RefID << endl;
 342             return false;
 343         }
 344
 345         // if alignment's ref ID is valid & its bin is not a 'leaf'
 346         if ( (al.RefID >= 0) && (al.Bin < 4681) )
 347             SaveLinearOffsetEntry(refEntry.LinearOffsets, al.Position, al.GetEndPosition(), lastOffset);
 348
 349         // changed to new BAI bin
 350         if ( al.Bin != lastBin ) {
 351
 352             // if not first bin on reference, save previous bin data
 353             if ( currentBin != defaultValue )
 354                 SaveAlignmentChunkToBin(refEntry.Bins, currentBin, currentOffset, lastOffset);
 355
 356             // update markers
 357             currentOffset = lastOffset;
 358             currentBin    = al.Bin;
 359             lastBin       = al.Bin;
 360             currentRefID  = al.RefID;
 361
 362             // if invalid RefID, break out
 363             if ( currentRefID < 0 )
 364                 break;
 365         }
 366
 367         // make sure that current file pointer is beyond lastOffset
 368         if ( m_reader->Tell() <= (int64_t)lastOffset ) {
 369             cerr << "BamStandardIndex ERROR: calculating offsets failed"
 370                  << ", aborting index creation" << endl;
 371             return false;
 372         }
 373
 374         // update lastOffset & lastPosition
 375         lastOffset   = m_reader->Tell();
 376         lastPosition = al.Position;
 377     }
 378
 379     // after finishing alignments, if any data was read, check:
 380     if ( currentRefID >= 0 ) {
 381
 382         // store last alignment chunk to its bin, then write last reference entry with data
 383         SaveAlignmentChunkToBin(refEntry.Bins, currentBin, currentOffset, lastOffset);
 384         createdOk &= WriteReferenceEntry(refEntry);
 385
 386         // then write any empty references remaining at end of file
 387         for ( int i = currentRefID+1; i < numReferences; ++i ) {
 388             BaiReferenceEntry emptyEntry(i);
 389             createdOk &= WriteReferenceEntry(emptyEntry);
 390         }
 391     }
 392
 393     // rewind reader now that we're done building
 394     createdOk &= m_reader->Rewind();
 395
 396     // return result
 397     return createdOk;
 398 }
 399
 400 // returns format's file extension
 401 const string BamStandardIndex::Extension(void) {
 402     return BamStandardIndex::BAI_EXTENSION;
 403 }
 404
 405 bool BamStandardIndex::GetOffsets(const BamRegion& region, vector<int64_t>& offsets) {
 406
 407     // cannot calculate offsets if unknown/invalid reference ID requested
 408     if ( region.LeftRefID < 0 || region.LeftRefID >= (int)m_indexFileSummary.size() )
 409         return false;
 410
 411     // retrieve index summary for left bound reference
 412     const BaiReferenceSummary& refSummary = m_indexFileSummary.at(region.LeftRefID);
 413
 414     // set up region boundaries based on actual BamReader data
 415     uint32_t begin;
 416     uint32_t end;
 417     if ( !AdjustRegion(region, begin, end) )
 418         return false;
 419
 420     // retrieve all candidate bin IDs for region
 421     set<uint16_t> candidateBins;
 422     CalculateCandidateBins(begin, end, candidateBins);
 423
 424     // use reference's linear offsets to calculate the minimum offset
 425     // that must be considered to find overlap
 426     const uint64_t& minOffset = CalculateMinOffset(refSummary, begin);
 427
 428     // attempt to use reference summary, minOffset, & candidateBins to calculate offsets
 429     if ( !CalculateCandidateOffsets(refSummary, minOffset, candidateBins, offsets) )
 430         return false;
 431
 432     // ensure that offsets are sorted before returning
 433     sort( offsets.begin(), offsets.end() );
 434
 435     // return succes
 436     return true;
 437 }
 438
 439 // returns whether reference has alignments or no
 440 bool BamStandardIndex::HasAlignments(const int& referenceID) const {
 441     if ( referenceID < 0 || referenceID >= (int)m_indexFileSummary.size() )
 442         return false;
 443     const BaiReferenceSummary& refSummary = m_indexFileSummary.at(referenceID);
 444     return ( refSummary.NumBins > 0 );
 445 }
 446
 447 bool BamStandardIndex::IsFileOpen(void) const {
 448     return ( m_indexStream != 0 );
 449 }
 450
 451 // attempts to use index data to jump to @region, returns success/fail
 452 // a "successful" jump indicates no error, but not whether this region has data
 453 //   * thus, the method sets a flag to indicate whether there are alignments
 454 //     available after the jump position
 455 bool BamStandardIndex::Jump(const BamRegion& region, bool* hasAlignmentsInRegion) {
 456
 457     // skip if reader is not valid or is not open
 458     if ( m_reader == 0 || !m_reader->IsOpen() )
 459         return false;
 460
 461     // calculate offsets for this region
 462     // if failed, print message, set flag, and return failure
 463     vector<int64_t> offsets;
 464     if ( !GetOffsets(region, offsets) ) {
 465         cerr << "BamStandardIndex ERROR: could not jump"
 466              << ", unable to retrieve offsets for region" << endl;
 467         *hasAlignmentsInRegion = false;
 468         return false;
 469     }
 470
 471     // if no offsets retrieved, set flag
 472     if ( offsets.empty() )
 473         *hasAlignmentsInRegion = false;
 474
 475     // iterate through candidate offsets
 476     BamAlignment al;
 477     bool result = true;
 478     vector<int64_t>::const_iterator offsetIter = offsets.begin();
 479     vector<int64_t>::const_iterator offsetEnd  = offsets.end();
 480     for ( ; offsetIter != offsetEnd; ++offsetIter) {
 481
 482         // attempt seek & load first available alignment
 483         // set flag to true if data exists
 484         result &= m_reader->Seek(*offsetIter);
 485         *hasAlignmentsInRegion = m_reader->LoadNextAlignment(al);
 486
 487         // if this alignment corresponds to desired position
 488         // return success of seeking back to the offset before the 'current offset' (to cover overlaps)
 489         if ( ((al.RefID == region.LeftRefID) &&
 490              ((al.Position + al.Length) > region.LeftPosition)) ||
 491              (al.RefID > region.LeftRefID) )
 492         {
 493             if ( offsetIter != offsets.begin() )
 494                 --offsetIter;
 495             return m_reader->Seek(*offsetIter);
 496         }
 497     }
 498
 499     // if error in jumping, print message & set flag
 500     if ( !result ) {
 501         cerr << "BamStandardIndex ERROR: could not jump"
 502              << ", there was a problem seeking in BAM file" << endl;
 503         *hasAlignmentsInRegion = false;
 504     }
 505
 506     // return success/failure
 507     return result;
 508 }
 509
 510 // loads existing data from file into memory
 511 bool BamStandardIndex::Load(const std::string& filename) {
 512
 513     // attempt open index file (read-only)
 514     if ( !OpenFile(filename, "rb") ) {
 515         cerr << "BamStandardIndex ERROR: could not open input index file: " << filename
 516              << ", aborting index load" << endl;
 517         return false;
 518     }
 519
 520     // if invalid format 'magic number', close & return failure
 521     if ( !CheckMagicNumber() ) {
 522         cerr << "BamStandardIndex ERROR: unexpected format for index file: " << filename
 523              << ", aborting index load" << endl;
 524         CloseFile();
 525         return false;
 526     }
 527
 528     // attempt to load index file summary, return success/failure
 529     if ( !SummarizeIndexFile() ) {
 530         cerr << "BamStandardIndex ERROR: could not generate a summary of index file " << filename
 531              << ", aborting index load" << endl;
 532         CloseFile();
 533         return false;
 534     }
 535
 536     // if we get here, index summary is loaded OK
 537     return true;
 538 }
 539
 540 uint64_t BamStandardIndex::LookupLinearOffset(const BaiReferenceSummary& refSummary, const int& index) {
 541
 542     // attempt seek to proper index file position
 543     const int64_t linearOffsetFilePosition = (int64_t)refSummary.FirstLinearOffsetFilePosition +
 544                                              index*BamStandardIndex::SIZEOF_LINEAROFFSET;
 545     if ( !Seek(linearOffsetFilePosition, SEEK_SET) )
 546         return 0;
 547
 548     // read linear offset from BAI file
 549     uint64_t linearOffset(0);
 550     if ( !ReadLinearOffset(linearOffset) )
 551         return 0;
 552     return linearOffset;
 553 }
 554
 555 void BamStandardIndex::MergeAlignmentChunks(BaiAlignmentChunkVector& chunks) {
 556
 557     // skip if chunks are empty, nothing to merge
 558     if ( chunks.empty() )
 559         return;
 560
 561     // set up merged alignment chunk container
 562     BaiAlignmentChunkVector mergedChunks;
 563     mergedChunks.push_back( chunks[0] );
 564
 565     // iterate over chunks
 566     int i = 0;
 567     BaiAlignmentChunkVector::iterator chunkIter = chunks.begin();
 568     BaiAlignmentChunkVector::iterator chunkEnd  = chunks.end();
 569     for ( ++chunkIter; chunkIter != chunkEnd; ++chunkIter) {
 570
 571         // get 'currentMergeChunk' based on numeric index
 572         BaiAlignmentChunk& currentMergeChunk = mergedChunks[i];
 573
 574         // get sourceChunk based on source vector iterator
 575         BaiAlignmentChunk& sourceChunk = (*chunkIter);
 576
 577         // if currentMergeChunk ends where sourceChunk starts, then merge the two
 578         if ( currentMergeChunk.Stop>>16 == sourceChunk.Start>>16 )
 579             currentMergeChunk.Stop = sourceChunk.Stop;
 580
 581         // otherwise
 582         else {
 583             // append sourceChunk after currentMergeChunk
 584             mergedChunks.push_back(sourceChunk);
 585
 586             // update i, so the next iteration will consider the
 587             // recently-appended sourceChunk as new mergeChunk candidate
 588             ++i;
 589         }
 590     }
 591
 592     // saved newly-merged chunks into (parameter) chunks
 593     chunks = mergedChunks;
 594 }
 595
 596 bool BamStandardIndex::OpenFile(const std::string& filename, const char* mode) {
 597
 598     // make sure any previous index file is closed
 599     CloseFile();
 600
 601     // attempt to open file
 602     m_indexStream = fopen(filename.c_str(), mode);
 603     return IsFileOpen();
 604 }
 605
 606 bool BamStandardIndex::ReadBinID(uint32_t& binId) {
 607     size_t elementsRead = 0;
 608     elementsRead += fread(&binId, sizeof(binId), 1, m_indexStream);
 609     if ( m_isBigEndian ) SwapEndian_32(binId);
 610     return ( elementsRead == 1 );
 611 }
 612
 613 bool BamStandardIndex::ReadBinIntoBuffer(uint32_t& binId, int32_t& numAlignmentChunks) {
 614
 615     bool readOk = true;
 616
 617     // read bin header
 618     readOk &= ReadBinID(binId);
 619     readOk &= ReadNumAlignmentChunks(numAlignmentChunks);
 620
 621     // read bin contents
 622     const unsigned int bytesRequested = numAlignmentChunks*BamStandardIndex::SIZEOF_ALIGNMENTCHUNK;
 623     readOk &= ReadIntoBuffer(bytesRequested);
 624
 625     // return success/failure
 626     return readOk;
 627 }
 628
 629 bool BamStandardIndex::ReadIntoBuffer(const unsigned int& bytesRequested) {
 630
 631     // ensure that our buffer is big enough for request
 632     BamStandardIndex::CheckBufferSize(m_buffer, m_bufferLength, bytesRequested);
 633
 634     // read from BAI file stream
 635     size_t bytesRead = fread( m_buffer, sizeof(char), bytesRequested, m_indexStream );
 636     return ( bytesRead == (size_t)bytesRequested );
 637 }
 638
 639 bool BamStandardIndex::ReadLinearOffset(uint64_t& linearOffset) {
 640     size_t elementsRead = 0;
 641     elementsRead += fread(&linearOffset, sizeof(linearOffset), 1, m_indexStream);
 642     if ( m_isBigEndian ) SwapEndian_64(linearOffset);
 643     return ( elementsRead == 1 );
 644 }
 645
 646 bool BamStandardIndex::ReadNumAlignmentChunks(int& numAlignmentChunks) {
 647     size_t elementsRead = 0;
 648     elementsRead += fread(&numAlignmentChunks, sizeof(numAlignmentChunks), 1, m_indexStream);
 649     if ( m_isBigEndian ) SwapEndian_32(numAlignmentChunks);
 650     return ( elementsRead == 1 );
 651 }
 652
 653 bool BamStandardIndex::ReadNumBins(int& numBins) {
 654     size_t elementsRead = 0;
 655     elementsRead += fread(&numBins, sizeof(numBins), 1, m_indexStream);
 656     if ( m_isBigEndian ) SwapEndian_32(numBins);
 657     return ( elementsRead == 1 );
 658 }
 659
 660 bool BamStandardIndex::ReadNumLinearOffsets(int& numLinearOffsets) {
 661     size_t elementsRead = 0;
 662     elementsRead += fread(&numLinearOffsets, sizeof(numLinearOffsets), 1, m_indexStream);
 663     if ( m_isBigEndian ) SwapEndian_32(numLinearOffsets);
 664     return ( elementsRead == 1 );
 665 }
 666
 667 bool BamStandardIndex::ReadNumReferences(int& numReferences) {
 668     size_t elementsRead = 0;
 669     elementsRead += fread(&numReferences, sizeof(numReferences), 1, m_indexStream);
 670     if ( m_isBigEndian ) SwapEndian_32(numReferences);
 671     return ( elementsRead == 1 );
 672 }
 673
 674 void BamStandardIndex::ReserveForSummary(const int& numReferences) {
 675     m_indexFileSummary.clear();
 676     m_indexFileSummary.assign( numReferences, BaiReferenceSummary() );
 677 }
 678
 679 void BamStandardIndex::SaveAlignmentChunkToBin(BaiBinMap& binMap,
 680                                     const uint32_t& currentBin,
 681                                     const uint64_t& currentOffset,
 682                                     const uint64_t& lastOffset)
 683 {
 684     // create new alignment chunk
 685     BaiAlignmentChunk newChunk(currentOffset, lastOffset);
 686
 687     // if no entry exists yet for this bin, create one and store alignment chunk
 688     BaiBinMap::iterator binIter = binMap.find(currentBin);
 689     if ( binIter == binMap.end() ) {
 690         BaiAlignmentChunkVector newChunks;
 691         newChunks.push_back(newChunk);
 692         binMap.insert( pair<uint32_t, BaiAlignmentChunkVector>(currentBin, newChunks));
 693     }
 694
 695     // otherwise, just append alignment chunk
 696     else {
 697         BaiAlignmentChunkVector& binChunks = (*binIter).second;
 698         binChunks.push_back( newChunk );
 699     }
 700 }
 701
 702 void BamStandardIndex::SaveBinsSummary(const int& refId, const int& numBins) {
 703     BaiReferenceSummary& refSummary = m_indexFileSummary.at(refId);
 704     refSummary.NumBins = numBins;
 705     refSummary.FirstBinFilePosition = Tell();
 706 }
 707
 708 void BamStandardIndex::SaveLinearOffsetEntry(BaiLinearOffsetVector& offsets,
 709                                              const int& alignmentStartPosition,
 710                                              const int& alignmentStopPosition,
 711                                              const uint64_t& lastOffset)
 712 {
 713     // get converted offsets
 714     const int beginOffset = alignmentStartPosition >> BamStandardIndex::BAM_LIDX_SHIFT;
 715     const int endOffset   = (alignmentStopPosition - 1) >> BamStandardIndex::BAM_LIDX_SHIFT;
 716
 717     // resize vector if necessary
 718     int oldSize = offsets.size();
 719     int newSize = endOffset + 1;
 720     if ( oldSize < newSize )
 721         offsets.resize(newSize, 0);
 722
 723     // store offset
 724     for( int i = beginOffset + 1; i <= endOffset; ++i ) {
 725         if ( offsets[i] == 0 )
 726             offsets[i] = lastOffset;
 727     }
 728 }
 729
 730 void BamStandardIndex::SaveLinearOffsetsSummary(const int& refId, const int& numLinearOffsets) {
 731     BaiReferenceSummary& refSummary = m_indexFileSummary.at(refId);
 732     refSummary.NumLinearOffsets = numLinearOffsets;
 733     refSummary.FirstLinearOffsetFilePosition = Tell();
 734 }
 735
 736 // seek to position in index file stream
 737 bool BamStandardIndex::Seek(const int64_t& position, const int& origin) {
 738     return ( fseek64(m_indexStream, position, origin) == 0 );
 739 }
 740
 741 // change the index caching behavior
 742 void BamStandardIndex::SetCacheMode(const BamIndex::IndexCacheMode& mode) {
 743     m_cacheMode = mode;
 744     // do nothing else here ? cache mode will be ignored from now on, most likely
 745 }
 746
 747 bool BamStandardIndex::SkipBins(const int& numBins) {
 748     uint32_t binId;
 749     int32_t numAlignmentChunks;
 750     bool skippedOk = true;
 751     for (int i = 0; i < numBins; ++i)
 752         skippedOk &= ReadBinIntoBuffer(binId, numAlignmentChunks); // results & buffer ignored
 753     return skippedOk;
 754 }
 755
 756 bool BamStandardIndex::SkipLinearOffsets(const int& numLinearOffsets) {
 757     const unsigned int bytesRequested = numLinearOffsets*BamStandardIndex::SIZEOF_LINEAROFFSET;
 758     return ReadIntoBuffer(bytesRequested);
 759 }
 760
 761 void BamStandardIndex::SortLinearOffsets(BaiLinearOffsetVector& linearOffsets) {
 762     sort( linearOffsets.begin(), linearOffsets.end() );
 763 }
 764
 765 bool BamStandardIndex::SummarizeBins(BaiReferenceSummary& refSummary) {
 766
 767     // load number of bins
 768     int numBins;
 769     if ( !ReadNumBins(numBins) )
 770         return false;
 771
 772     // store bins summary for this reference
 773     refSummary.NumBins = numBins;
 774     refSummary.FirstBinFilePosition = Tell();
 775
 776     // attempt skip reference bins, return success/failure
 777     if ( !SkipBins(numBins) )
 778         return false;
 779
 780     // if we get here, bin summarized OK
 781     return true;
 782 }
 783
 784 bool BamStandardIndex::SummarizeIndexFile(void) {
 785
 786     // load number of reference sequences
 787     int numReferences;
 788     if ( !ReadNumReferences(numReferences) )
 789         return false;
 790
 791     // initialize file summary data
 792     ReserveForSummary(numReferences);
 793
 794     // iterate over reference entries
 795     bool loadedOk = true;
 796     BaiFileSummary::iterator summaryIter = m_indexFileSummary.begin();
 797     BaiFileSummary::iterator summaryEnd  = m_indexFileSummary.end();
 798     for ( int i = 0; summaryIter != summaryEnd; ++summaryIter, ++i )
 799         loadedOk &= SummarizeReference(*summaryIter);
 800
 801     // return result
 802     return loadedOk;
 803 }
 804
 805 bool BamStandardIndex::SummarizeLinearOffsets(BaiReferenceSummary& refSummary) {
 806
 807     // load number of linear offsets
 808     int numLinearOffsets;
 809     if ( !ReadNumLinearOffsets(numLinearOffsets) )
 810         return false;
 811
 812     // store bin summary data for this reference
 813     refSummary.NumLinearOffsets = numLinearOffsets;
 814     refSummary.FirstLinearOffsetFilePosition = Tell();
 815
 816     // skip linear offsets in index file
 817     if ( !SkipLinearOffsets(numLinearOffsets) )
 818         return false;
 819
 820     // if get here, linear offsets summarized OK
 821     return true;
 822 }
 823
 824 bool BamStandardIndex::SummarizeReference(BaiReferenceSummary& refSummary) {
 825     bool loadedOk = true;
 826     loadedOk &= SummarizeBins(refSummary);
 827     loadedOk &= SummarizeLinearOffsets(refSummary);
 828     return loadedOk;
 829 }
 830
 831 // return position of file pointer in index file stream
 832 int64_t BamStandardIndex::Tell(void) const {
 833     return ftell64(m_indexStream);
 834 }
 835
 836 bool BamStandardIndex::WriteAlignmentChunk(const BaiAlignmentChunk& chunk) {
 837
 838     size_t elementsWritten = 0;
 839
 840     // localize alignment chunk offsets
 841     uint64_t start = chunk.Start;
 842     uint64_t stop  = chunk.Stop;
 843
 844     // swap endian-ness if necessary
 845     if ( m_isBigEndian ) {
 846         SwapEndian_64(start);
 847         SwapEndian_64(stop);
 848     }
 849
 850     // write to index file
 851     elementsWritten += fwrite(&start, sizeof(start), 1, m_indexStream);
 852     elementsWritten += fwrite(&stop,  sizeof(stop),  1, m_indexStream);
 853
 854     // return success/failure of write
 855     return ( elementsWritten == 2 );
 856 }
 857
 858 bool BamStandardIndex::WriteAlignmentChunks(BaiAlignmentChunkVector& chunks) {
 859
 860     // make sure chunks are merged (simplified) before writing & saving summary
 861     MergeAlignmentChunks(chunks);
 862
 863     size_t elementsWritten = 0;
 864
 865     // write chunks
 866     int32_t chunkCount = chunks.size();
 867     if ( m_isBigEndian ) SwapEndian_32(chunkCount);
 868     elementsWritten += fwrite(&chunkCount, sizeof(chunkCount), 1, m_indexStream);
 869
 870     // iterate over chunks
 871     bool chunksOk = true;
 872     BaiAlignmentChunkVector::const_iterator chunkIter = chunks.begin();
 873     BaiAlignmentChunkVector::const_iterator chunkEnd  = chunks.end();
 874     for ( ; chunkIter != chunkEnd; ++chunkIter )
 875         chunksOk &= WriteAlignmentChunk( (*chunkIter) );
 876
 877     // return success/failure of write
 878     return ( (elementsWritten == 1) && chunksOk );
 879 }
 880
 881 bool BamStandardIndex::WriteBin(const uint32_t& binId, BaiAlignmentChunkVector& chunks) {
 882
 883     size_t elementsWritten = 0;
 884
 885     // write BAM bin ID
 886     uint32_t binKey = binId;
 887     if ( m_isBigEndian ) SwapEndian_32(binKey);
 888     elementsWritten += fwrite(&binKey, sizeof(binKey), 1, m_indexStream);
 889
 890     // write bin's alignment chunks
 891     bool chunksOk = WriteAlignmentChunks(chunks);
 892
 893     // return success/failure of write
 894     return ( (elementsWritten == 1) && chunksOk );
 895 }
 896
 897 bool BamStandardIndex::WriteBins(const int& refId, BaiBinMap& bins) {
 898
 899     size_t elementsWritten = 0;
 900
 901     // write number of bins
 902     int32_t binCount = bins.size();
 903     if ( m_isBigEndian ) SwapEndian_32(binCount);
 904     elementsWritten += fwrite(&binCount, sizeof(binCount), 1, m_indexStream);
 905
 906     // save summary for reference's bins
 907     SaveBinsSummary(refId, bins.size());
 908
 909     // iterate over bins
 910     bool binsOk = true;
 911     BaiBinMap::iterator binIter = bins.begin();
 912     BaiBinMap::iterator binEnd  = bins.end();
 913     for ( ; binIter != binEnd; ++binIter )
 914         binsOk &= WriteBin( (*binIter).first, (*binIter).second );
 915
 916     // return success/failure of write
 917     return ( (elementsWritten == 1) && binsOk );
 918 }
 919
 920 bool BamStandardIndex::WriteHeader(void) {
 921
 922     size_t elementsWritten = 0;
 923
 924     // write magic number
 925     elementsWritten += fwrite(BamStandardIndex::BAI_MAGIC, sizeof(char), 4, m_indexStream);
 926
 927     // write number of reference sequences
 928     int32_t numReferences = m_indexFileSummary.size();
 929     if ( m_isBigEndian ) SwapEndian_32(numReferences);
 930     elementsWritten += fwrite(&numReferences, sizeof(numReferences), 1, m_indexStream);
 931
 932     // return success/failure of write
 933     return (elementsWritten == 5);
 934 }
 935
 936 bool BamStandardIndex::WriteLinearOffsets(const int& refId, BaiLinearOffsetVector& linearOffsets) {
 937
 938     // make sure linear offsets are sorted before writing & saving summary
 939     SortLinearOffsets(linearOffsets);
 940
 941     size_t elementsWritten = 0;
 942
 943     // write number of linear offsets
 944     int32_t offsetCount = linearOffsets.size();
 945     if ( m_isBigEndian ) SwapEndian_32(offsetCount);
 946     elementsWritten += fwrite(&offsetCount, sizeof(offsetCount), 1, m_indexStream);
 947
 948     // save summary for reference's linear offsets
 949     SaveLinearOffsetsSummary(refId, linearOffsets.size());
 950
 951     // iterate over linear offsets
 952     BaiLinearOffsetVector::const_iterator offsetIter = linearOffsets.begin();
 953     BaiLinearOffsetVector::const_iterator offsetEnd  = linearOffsets.end();
 954     for ( ; offsetIter != offsetEnd; ++offsetIter ) {
 955
 956         // write linear offset
 957         uint64_t linearOffset = (*offsetIter);
 958         if ( m_isBigEndian ) SwapEndian_64(linearOffset);
 959         elementsWritten += fwrite(&linearOffset, sizeof(linearOffset), 1, m_indexStream);
 960     }
 961
 962     // return success/failure of write
 963     return ( elementsWritten == (size_t)(linearOffsets.size() + 1) );
 964 }
 965
 966 bool BamStandardIndex::WriteReferenceEntry(BaiReferenceEntry& refEntry) {
 967     bool refOk = true;
 968     refOk &= WriteBins(refEntry.ID, refEntry.Bins);
 969     refOk &= WriteLinearOffsets(refEntry.ID, refEntry.LinearOffsets);
 970     return refOk;
 971 }