1 // ***************************************************************************
\r
2 // BamAux.h (c) 2009 Derek Barnett, Michael Str�mberg
\r
3 // Marth Lab, Department of Biology, Boston College
\r
4 // All rights reserved.
\r
5 // ---------------------------------------------------------------------------
\r
6 // Last modified: 16 June 2010 (DB)
\r
7 // ---------------------------------------------------------------------------
\r
8 // Provides the basic constants, data structures, etc. for using BAM files
\r
9 // ***************************************************************************
\r
20 #include <exception>
\r
26 // Platform-specific type definitions
\r
27 #ifndef BAMTOOLS_TYPES
\r
28 #define BAMTOOLS_TYPES
\r
30 typedef char int8_t;
\r
31 typedef unsigned char uint8_t;
\r
32 typedef short int16_t;
\r
33 typedef unsigned short uint16_t;
\r
34 typedef int int32_t;
\r
35 typedef unsigned int uint32_t;
\r
36 typedef long long int64_t;
\r
37 typedef unsigned long long uint64_t;
\r
41 #endif // BAMTOOLS_TYPES
\r
43 namespace BamTools {
\r
46 const int BAM_CORE_SIZE = 32;
\r
47 const int BAM_CMATCH = 0;
\r
48 const int BAM_CINS = 1;
\r
49 const int BAM_CDEL = 2;
\r
50 const int BAM_CREF_SKIP = 3;
\r
51 const int BAM_CSOFT_CLIP = 4;
\r
52 const int BAM_CHARD_CLIP = 5;
\r
53 const int BAM_CPAD = 6;
\r
54 const int BAM_CIGAR_SHIFT = 4;
\r
55 const int BAM_CIGAR_MASK = ((1 << BAM_CIGAR_SHIFT) - 1);
\r
57 // BAM index constants
\r
58 const int MAX_BIN = 37450; // =(8^6-1)/7+1
\r
59 const int BAM_MIN_CHUNK_GAP = 32768;
\r
60 const int BAM_LIDX_SHIFT = 14;
\r
62 // Explicit variable sizes
\r
63 const int BT_SIZEOF_INT = 4;
\r
67 struct BamAlignment {
\r
69 // constructors & destructor
\r
72 BamAlignment(const BamAlignment& other);
\r
73 ~BamAlignment(void);
\r
75 // Queries against alignment flags
\r
77 bool IsDuplicate(void) const; // Returns true if this read is a PCR duplicate
\r
78 bool IsFailedQC(void) const; // Returns true if this read failed quality control
\r
79 bool IsFirstMate(void) const; // Returns true if alignment is first mate on read
\r
80 bool IsMapped(void) const; // Returns true if alignment is mapped
\r
81 bool IsMateMapped(void) const; // Returns true if alignment's mate is mapped
\r
82 bool IsMateReverseStrand(void) const; // Returns true if alignment's mate mapped to reverse strand
\r
83 bool IsPaired(void) const; // Returns true if alignment part of paired-end read
\r
84 bool IsPrimaryAlignment(void) const; // Returns true if reported position is primary alignment
\r
85 bool IsProperPair(void) const; // Returns true if alignment is part of read that satisfied paired-end resolution
\r
86 bool IsReverseStrand(void) const; // Returns true if alignment mapped to reverse strand
\r
87 bool IsSecondMate(void) const; // Returns true if alignment is second mate on read
\r
89 // Manipulate alignment flags
\r
91 void SetIsDuplicate(bool ok); // Sets "PCR duplicate" flag
\r
92 void SetIsFailedQC(bool ok); // Sets "failed quality control" flag
\r
93 void SetIsFirstMate(bool ok); // Sets "alignment is first mate" flag
\r
94 void SetIsMateUnmapped(bool ok); // Sets "alignment's mate is mapped" flag
\r
95 void SetIsMateReverseStrand(bool ok); // Sets "alignment's mate mapped to reverse strand" flag
\r
96 void SetIsPaired(bool ok); // Sets "alignment part of paired-end read" flag
\r
97 void SetIsProperPair(bool ok); // Sets "alignment is part of read that satisfied paired-end resolution" flag
\r
98 void SetIsReverseStrand(bool ok); // Sets "alignment mapped to reverse strand" flag
\r
99 void SetIsSecondaryAlignment(bool ok); // Sets "position is primary alignment" flag
\r
100 void SetIsSecondMate(bool ok); // Sets "alignment is second mate on read" flag
\r
101 void SetIsUnmapped(bool ok); // Sets "alignment is mapped" flag
\r
103 // Tag data access methods
\r
105 bool GetEditDistance(uint8_t& editDistance) const; // get "NM" tag data - contributed by Aaron Quinlan
\r
106 bool GetReadGroup(std::string& readGroup) const; // get "RG" tag data
\r
108 bool GetTag(const std::string& tag, std::string& destination);
\r
109 template<typename T> bool GetTag(const std::string& tag, T& destination);
\r
111 // Additional data access methods
\r
113 int GetEndPosition(bool usePadded = false) const; // calculates alignment end position, based on starting position and CIGAR operations
\r
115 // 'internal' utility methods
\r
117 static void SkipToNextTag(const char storageType, char* &pTagData, unsigned int& numBytesParsed);
\r
121 std::string Name; // Read name
\r
122 int32_t Length; // Query length
\r
123 std::string QueryBases; // 'Original' sequence (as reported from sequencing machine)
\r
124 std::string AlignedBases; // 'Aligned' sequence (includes any indels, padding, clipping)
\r
125 std::string Qualities; // FASTQ qualities (ASCII characters, not numeric values)
\r
126 std::string TagData; // Tag data (accessor methods will pull the requested information out)
\r
127 int32_t RefID; // ID number for reference sequence
\r
128 int32_t Position; // Position (0-based) where alignment starts
\r
129 uint16_t Bin; // Bin in BAM file where this alignment resides
\r
130 uint16_t MapQuality; // Mapping quality score
\r
131 uint32_t AlignmentFlag; // Alignment bit-flag - see Is<something>() methods to query this value, SetIs<something>() methods to manipulate
\r
132 std::vector<CigarOp> CigarData; // CIGAR operations for this alignment
\r
133 int32_t MateRefID; // ID number for reference sequence where alignment's mate was aligned
\r
134 int32_t MatePosition; // Position (0-based) where alignment's mate starts
\r
135 int32_t InsertSize; // Mate-pair insert size
\r
137 struct BamAlignmentSupportData {
\r
140 std::string AllCharData;
\r
141 uint32_t BlockLength;
\r
142 uint32_t NumCigarOperations;
\r
143 uint32_t QueryNameLength;
\r
144 uint32_t QuerySequenceLength;
\r
148 BamAlignmentSupportData(void)
\r
150 , NumCigarOperations(0)
\r
151 , QueryNameLength(0)
\r
152 , QuerySequenceLength(0)
\r
157 BamAlignmentSupportData SupportData; // Contains raw character data & lengths
\r
159 // Alignment flag query constants
\r
160 // Use the get/set methods above instead
\r
165 , MATE_UNMAPPED = 8
\r
167 , MATE_REVERSE = 32
\r
172 , DUPLICATE = 1024
\r
176 // ----------------------------------------------------------------
\r
177 // Auxiliary data structs & typedefs
\r
182 char Type; // Operation type (MIDNSHP)
\r
183 uint32_t Length; // Operation length (number of bases)
\r
186 CigarOp(const char type = '\0',
\r
187 const uint32_t length = 0)
\r
196 std::string RefName; // Name of reference sequence
\r
197 int32_t RefLength; // Length of reference sequence
\r
198 bool RefHasAlignments; // True if BAM file contains alignments mapped to reference sequence
\r
201 RefData(const int32_t& length = 0,
\r
203 : RefLength(length)
\r
204 , RefHasAlignments(ok)
\r
208 typedef std::vector<RefData> RefVector;
\r
209 typedef std::vector<BamAlignment> BamAlignmentVector;
\r
220 BamRegion(const int& leftID = -1,
\r
221 const int& leftPos = -1,
\r
222 const int& rightID = -1,
\r
223 const int& rightPos = -1)
\r
224 : LeftRefID(leftID)
\r
225 , LeftPosition(leftPos)
\r
226 , RightRefID(rightID)
\r
227 , RightPosition(rightPos)
\r
231 // ----------------------------------------------------------------
\r
232 // BamAlignment member methods
\r
234 // constructors & destructor
\r
236 BamAlignment::BamAlignment(void) { }
\r
239 BamAlignment::BamAlignment(const BamAlignment& other)
\r
241 , Length(other.Length)
\r
242 , QueryBases(other.QueryBases)
\r
243 , AlignedBases(other.AlignedBases)
\r
244 , Qualities(other.Qualities)
\r
245 , TagData(other.TagData)
\r
246 , RefID(other.RefID)
\r
247 , Position(other.Position)
\r
249 , MapQuality(other.MapQuality)
\r
250 , AlignmentFlag(other.AlignmentFlag)
\r
251 , CigarData(other.CigarData)
\r
252 , MateRefID(other.MateRefID)
\r
253 , MatePosition(other.MatePosition)
\r
254 , InsertSize(other.InsertSize)
\r
255 , SupportData(other.SupportData)
\r
259 BamAlignment::~BamAlignment(void) { }
\r
261 // Queries against alignment flags
\r
262 inline bool BamAlignment::IsDuplicate(void) const { return ( (AlignmentFlag & DUPLICATE) != 0 ); }
\r
263 inline bool BamAlignment::IsFailedQC(void) const { return ( (AlignmentFlag & QC_FAILED) != 0 ); }
\r
264 inline bool BamAlignment::IsFirstMate(void) const { return ( (AlignmentFlag & READ_1) != 0 ); }
\r
265 inline bool BamAlignment::IsMapped(void) const { return ( (AlignmentFlag & UNMAPPED) == 0 ); }
\r
266 inline bool BamAlignment::IsMateMapped(void) const { return ( (AlignmentFlag & MATE_UNMAPPED) == 0 ); }
\r
267 inline bool BamAlignment::IsMateReverseStrand(void) const { return ( (AlignmentFlag & MATE_REVERSE) != 0 ); }
\r
268 inline bool BamAlignment::IsPaired(void) const { return ( (AlignmentFlag & PAIRED) != 0 ); }
\r
269 inline bool BamAlignment::IsPrimaryAlignment(void) const { return ( (AlignmentFlag & SECONDARY) == 0 ); }
\r
270 inline bool BamAlignment::IsProperPair(void) const { return ( (AlignmentFlag & PROPER_PAIR) != 0 ); }
\r
271 inline bool BamAlignment::IsReverseStrand(void) const { return ( (AlignmentFlag & REVERSE) != 0 ); }
\r
272 inline bool BamAlignment::IsSecondMate(void) const { return ( (AlignmentFlag & READ_2) != 0 ); }
\r
274 // Manipulate alignment flags
\r
275 inline void BamAlignment::SetIsDuplicate(bool ok) { if (ok) AlignmentFlag |= DUPLICATE; else AlignmentFlag &= ~DUPLICATE; }
\r
276 inline void BamAlignment::SetIsFailedQC(bool ok) { if (ok) AlignmentFlag |= QC_FAILED; else AlignmentFlag &= ~QC_FAILED; }
\r
277 inline void BamAlignment::SetIsFirstMate(bool ok) { if (ok) AlignmentFlag |= READ_1; else AlignmentFlag &= ~READ_1; }
\r
278 inline void BamAlignment::SetIsMateUnmapped(bool ok) { if (ok) AlignmentFlag |= MATE_UNMAPPED; else AlignmentFlag &= ~MATE_UNMAPPED; }
\r
279 inline void BamAlignment::SetIsMateReverseStrand(bool ok) { if (ok) AlignmentFlag |= MATE_REVERSE; else AlignmentFlag &= ~MATE_REVERSE; }
\r
280 inline void BamAlignment::SetIsPaired(bool ok) { if (ok) AlignmentFlag |= PAIRED; else AlignmentFlag &= ~PAIRED; }
\r
281 inline void BamAlignment::SetIsProperPair(bool ok) { if (ok) AlignmentFlag |= PROPER_PAIR; else AlignmentFlag &= ~PROPER_PAIR; }
\r
282 inline void BamAlignment::SetIsReverseStrand(bool ok) { if (ok) AlignmentFlag |= REVERSE; else AlignmentFlag &= ~REVERSE; }
\r
283 inline void BamAlignment::SetIsSecondaryAlignment(bool ok) { if (ok) AlignmentFlag |= SECONDARY; else AlignmentFlag &= ~SECONDARY; }
\r
284 inline void BamAlignment::SetIsSecondMate(bool ok) { if (ok) AlignmentFlag |= READ_2; else AlignmentFlag &= ~READ_2; }
\r
285 inline void BamAlignment::SetIsUnmapped(bool ok) { if (ok) AlignmentFlag |= UNMAPPED; else AlignmentFlag &= ~UNMAPPED; }
\r
287 // calculates alignment end position, based on starting position and CIGAR operations
\r
289 int BamAlignment::GetEndPosition(bool usePadded) const {
\r
291 // initialize alignment end to starting position
\r
292 int alignEnd = Position;
\r
294 // iterate over cigar operations
\r
295 std::vector<CigarOp>::const_iterator cigarIter = CigarData.begin();
\r
296 std::vector<CigarOp>::const_iterator cigarEnd = CigarData.end();
\r
297 for ( ; cigarIter != cigarEnd; ++cigarIter) {
\r
298 const char cigarType = (*cigarIter).Type;
\r
299 if ( cigarType == 'M' || cigarType == 'D' || cigarType == 'N' ) {
\r
300 alignEnd += (*cigarIter).Length;
\r
302 else if ( usePadded && cigarType == 'I' ) {
\r
303 alignEnd += (*cigarIter).Length;
\r
309 // get "NM" tag data - contributed by Aaron Quinlan
\r
310 // stores data in 'editDistance', returns success/fail
\r
312 bool BamAlignment::GetEditDistance(uint8_t& editDistance) const {
\r
314 if ( TagData.empty() ) { return false; }
\r
316 // localize the tag data
\r
317 char* pTagData = (char*)TagData.data();
\r
318 const unsigned int tagDataLen = TagData.size();
\r
319 unsigned int numBytesParsed = 0;
\r
321 bool foundEditDistanceTag = false;
\r
322 while( numBytesParsed < tagDataLen ) {
\r
324 const char* pTagType = pTagData;
\r
325 const char* pTagStorageType = pTagData + 2;
\r
327 numBytesParsed += 3;
\r
329 // check the current tag
\r
330 if ( strncmp(pTagType, "NM", 2) == 0 ) {
\r
331 foundEditDistanceTag = true;
\r
335 // get the storage class and find the next tag
\r
336 if (*pTagStorageType == '\0') { return false; }
\r
337 SkipToNextTag( *pTagStorageType, pTagData, numBytesParsed );
\r
338 if (*pTagData == '\0') { return false; }
\r
340 // return if the edit distance tag was not present
\r
341 if ( !foundEditDistanceTag ) { return false; }
\r
343 // assign the editDistance value
\r
344 std::memcpy(&editDistance, pTagData, 1);
\r
348 // get "RG" tag data
\r
349 // stores data in 'readGroup', returns success/fail
\r
351 bool BamAlignment::GetReadGroup(std::string& readGroup) const {
\r
353 if ( TagData.empty() ) { return false; }
\r
355 // localize the tag data
\r
356 char* pTagData = (char*)TagData.data();
\r
357 const unsigned int tagDataLen = TagData.size();
\r
358 unsigned int numBytesParsed = 0;
\r
360 bool foundReadGroupTag = false;
\r
361 while( numBytesParsed < tagDataLen ) {
\r
363 const char* pTagType = pTagData;
\r
364 const char* pTagStorageType = pTagData + 2;
\r
366 numBytesParsed += 3;
\r
368 // check the current tag
\r
369 if ( std::strncmp(pTagType, "RG", 2) == 0 ) {
\r
370 foundReadGroupTag = true;
\r
374 // get the storage class and find the next tag
\r
375 if (*pTagStorageType == '\0') { return false; }
\r
376 SkipToNextTag( *pTagStorageType, pTagData, numBytesParsed );
\r
377 if (*pTagData == '\0') { return false; }
\r
380 // return if the read group tag was not present
\r
381 if ( !foundReadGroupTag ) { return false; }
\r
383 // assign the read group
\r
384 const unsigned int readGroupLen = std::strlen(pTagData);
\r
385 readGroup.resize(readGroupLen);
\r
386 std::memcpy( (char*)readGroup.data(), pTagData, readGroupLen );
\r
391 bool BamAlignment::GetTag(const std::string& tag, std::string& destination) {
\r
393 if ( TagData.empty() ) { return false; }
\r
395 // localize the tag data
\r
396 char* pTagData = (char*)TagData.data();
\r
397 const unsigned int tagDataLen = TagData.size();
\r
398 unsigned int numBytesParsed = 0;
\r
400 bool foundReadGroupTag = false;
\r
401 while( numBytesParsed < tagDataLen ) {
\r
403 const char* pTagType = pTagData;
\r
404 const char* pTagStorageType = pTagData + 2;
\r
406 numBytesParsed += 3;
\r
408 // check the current tag
\r
409 if ( std::strncmp(pTagType, tag.c_str(), 2) == 0 ) {
\r
410 foundReadGroupTag = true;
\r
414 // get the storage class and find the next tag
\r
415 if (*pTagStorageType == '\0') { return false; }
\r
416 SkipToNextTag( *pTagStorageType, pTagData, numBytesParsed );
\r
417 if (*pTagData == '\0') { return false; }
\r
420 // return if the read group tag was not present
\r
421 if ( !foundReadGroupTag ) { return false; }
\r
423 // assign the read group
\r
424 const unsigned int dataLen = std::strlen(pTagData);
\r
425 destination.resize(dataLen);
\r
426 std::memcpy( (char*)destination.data(), pTagData, dataLen );
\r
430 template<typename T>
\r
431 bool BamAlignment::GetTag(const std::string& tag, T& destination) {
\r
433 if ( TagData.empty() ) { return false; }
\r
435 // localize the tag data
\r
436 char* pTagData = (char*)TagData.data();
\r
437 const unsigned int tagDataLen = TagData.size();
\r
438 unsigned int numBytesParsed = 0;
\r
440 bool foundDesiredTag = false;
\r
441 while( numBytesParsed < tagDataLen ) {
\r
443 const char* pTagType = pTagData;
\r
444 const char* pTagStorageType = pTagData + 2;
\r
446 numBytesParsed += 3;
\r
448 // check the current tag
\r
449 if ( strncmp(pTagType, tag.c_str(), 2) == 0 ) {
\r
450 foundDesiredTag = true;
\r
454 // get the storage class and find the next tag
\r
455 if (*pTagStorageType == '\0') { return false; }
\r
456 SkipToNextTag( *pTagStorageType, pTagData, numBytesParsed );
\r
457 if (*pTagData == '\0') { return false; }
\r
459 // return if the edit distance tag was not present
\r
460 if ( !foundDesiredTag ) { return false; }
\r
462 // assign the editDistance value
\r
463 std::memcpy(&destination, pTagData, sizeof(T));
\r
468 void BamAlignment::SkipToNextTag(const char storageType, char* &pTagData, unsigned int& numBytesParsed) {
\r
470 switch(storageType) {
\r
481 numBytesParsed += 2;
\r
488 numBytesParsed += 4;
\r
498 // ---------------------------
\r
499 // Added: 3-25-2010 DWB
\r
500 // Contributed: ARQ
\r
501 // Fixed: error parsing variable length tag data
\r
503 // ---------------------------
\r
507 printf("ERROR: Unknown tag storage class encountered: [%c]\n", *pTagData);
\r
512 // ----------------------------------------------------------------
\r
513 // Added: 3-35-2010 DWB
\r
514 // Fixed: Routines to provide endian-correctness
\r
515 // ----------------------------------------------------------------
\r
517 // returns true if system is big endian
\r
518 inline bool SystemIsBigEndian(void) {
\r
519 const uint16_t one = 0x0001;
\r
520 return ((*(char*) &one) == 0 );
\r
523 // swaps endianness of 16-bit value 'in place'
\r
524 inline void SwapEndian_16(int16_t& x) {
\r
525 x = ((x >> 8) | (x << 8));
\r
528 inline void SwapEndian_16(uint16_t& x) {
\r
529 x = ((x >> 8) | (x << 8));
\r
532 // swaps endianness of 32-bit value 'in-place'
\r
533 inline void SwapEndian_32(int32_t& x) {
\r
535 ((x << 8) & 0x00FF0000) |
\r
536 ((x >> 8) & 0x0000FF00) |
\r
541 inline void SwapEndian_32(uint32_t& x) {
\r
543 ((x << 8) & 0x00FF0000) |
\r
544 ((x >> 8) & 0x0000FF00) |
\r
549 // swaps endianness of 64-bit value 'in-place'
\r
550 inline void SwapEndian_64(int64_t& x) {
\r
552 ((x << 40) & 0x00FF000000000000ll) |
\r
553 ((x << 24) & 0x0000FF0000000000ll) |
\r
554 ((x << 8) & 0x000000FF00000000ll) |
\r
555 ((x >> 8) & 0x00000000FF000000ll) |
\r
556 ((x >> 24) & 0x0000000000FF0000ll) |
\r
557 ((x >> 40) & 0x000000000000FF00ll) |
\r
562 inline void SwapEndian_64(uint64_t& x) {
\r
564 ((x << 40) & 0x00FF000000000000ll) |
\r
565 ((x << 24) & 0x0000FF0000000000ll) |
\r
566 ((x << 8) & 0x000000FF00000000ll) |
\r
567 ((x >> 8) & 0x00000000FF000000ll) |
\r
568 ((x >> 24) & 0x0000000000FF0000ll) |
\r
569 ((x >> 40) & 0x000000000000FF00ll) |
\r
574 // swaps endianness of 'next 2 bytes' in a char buffer (in-place)
\r
575 inline void SwapEndian_16p(char* data) {
\r
576 uint16_t& value = (uint16_t&)*data;
\r
577 SwapEndian_16(value);
\r
580 // swaps endianness of 'next 4 bytes' in a char buffer (in-place)
\r
581 inline void SwapEndian_32p(char* data) {
\r
582 uint32_t& value = (uint32_t&)*data;
\r
583 SwapEndian_32(value);
\r
586 // swaps endianness of 'next 8 bytes' in a char buffer (in-place)
\r
587 inline void SwapEndian_64p(char* data) {
\r
588 uint64_t& value = (uint64_t&)*data;
\r
589 SwapEndian_64(value);
\r
592 } // namespace BamTools
\r