BamAux.h

   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: 14 April 2010 (DB)\r
   7 // ---------------------------------------------------------------------------\r
   8 // Provides the basic constants, data structures, etc. for using BAM files\r
   9 // ***************************************************************************\r
  10 \r
  11 #ifndef BAMAUX_H\r
  12 #define BAMAUX_H\r
  13 \r
  14 // C inclues\r
  15 #include <cstdio>\r
  16 #include <cstdlib>\r
  17 #include <cstring>\r
  18 \r
  19 // C++ includes\r
  20 #include <exception>\r
  21 #include <map>\r
  22 #include <string>\r
  23 #include <utility>\r
  24 #include <vector>\r
  25 \r
  26 // Platform-specific type definitions\r
  27 #ifndef BAMTOOLS_TYPES\r
  28 #define BAMTOOLS_TYPES\r
  29     #ifdef _MSC_VER\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
  38     #else\r
  39         #include <stdint.h>\r
  40     #endif\r
  41 #endif // BAMTOOLS_TYPES\r
  42 \r
  43 namespace BamTools {\r
  44 \r
  45 // BAM constants\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
  56 \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
  61 \r
  62 // Explicit variable sizes\r
  63 const int BT_SIZEOF_INT = 4;\r
  64 \r
  65 struct CigarOp;\r
  66 \r
  67 struct BamAlignment {\r
  68 \r
  69     // constructors & destructor\r
  70     public:\r
  71         BamAlignment(void);\r
  72         BamAlignment(const BamAlignment& other);\r
  73         ~BamAlignment(void);\r
  74 \r
  75     // Queries against alignment flags\r
  76     public:        \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
  88 \r
  89     // Manipulate alignment flags\r
  90     public:        \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
 102 \r
 103     // Tag data access methods\r
 104     public:\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
 107         \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
 110 \r
 111     // Additional data access methods\r
 112     public:\r
 113         int GetEndPosition(bool usePadded = false) const;       // calculates alignment end position, based on starting position and CIGAR operations\r
 114 \r
 115     // 'internal' utility methods \r
 116     private:\r
 117         static void SkipToNextTag(const char storageType, char* &pTagData, unsigned int& numBytesParsed);\r
 118 \r
 119     // Data members\r
 120     public:\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
 136 \r
 137     // Alignment flag query constants\r
 138     // Use the get/set methods above instead\r
 139     private:\r
 140         enum { PAIRED        = 1\r
 141              , PROPER_PAIR   = 2\r
 142              , UNMAPPED      = 4\r
 143              , MATE_UNMAPPED = 8\r
 144              , REVERSE       = 16\r
 145              , MATE_REVERSE  = 32\r
 146              , READ_1        = 64\r
 147              , READ_2        = 128\r
 148              , SECONDARY     = 256\r
 149              , QC_FAILED     = 512\r
 150              , DUPLICATE     = 1024 \r
 151              };\r
 152 };\r
 153 \r
 154 // ----------------------------------------------------------------\r
 155 // Auxiliary data structs & typedefs\r
 156 \r
 157 struct CigarOp {\r
 158     char     Type;   // Operation type (MIDNSHP)\r
 159     uint32_t Length; // Operation length (number of bases)\r
 160 };\r
 161 \r
 162 struct RefData {\r
 163    \r
 164     // data members\r
 165     std::string RefName;          // Name of reference sequence\r
 166     int32_t     RefLength;        // Length of reference sequence\r
 167     bool        RefHasAlignments; // True if BAM file contains alignments mapped to reference sequence\r
 168     \r
 169     // constructor\r
 170     RefData(const int32_t& length = 0, \r
 171             bool ok = false)\r
 172         : RefLength(length)\r
 173         , RefHasAlignments(ok)\r
 174     { }\r
 175 };\r
 176 \r
 177 typedef std::vector<RefData>      RefVector;\r
 178 typedef std::vector<BamAlignment> BamAlignmentVector;\r
 179 \r
 180 // ----------------------------------------------------------------\r
 181 // Indexing structs & typedefs\r
 182 \r
 183 struct Chunk {\r
 184 \r
 185     // data members\r
 186     uint64_t Start;\r
 187     uint64_t Stop;\r
 188 \r
 189     // constructor\r
 190     Chunk(const uint64_t& start = 0, \r
 191           const uint64_t& stop = 0)\r
 192         : Start(start)\r
 193         , Stop(stop)\r
 194     { }\r
 195 };\r
 196 \r
 197 inline\r
 198 bool ChunkLessThan(const Chunk& lhs, const Chunk& rhs) {\r
 199     return lhs.Start < rhs.Start;\r
 200 }\r
 201 \r
 202 typedef std::vector<Chunk> ChunkVector;\r
 203 typedef std::map<uint32_t, ChunkVector> BamBinMap;\r
 204 typedef std::vector<uint64_t> LinearOffsetVector;\r
 205 \r
 206 struct ReferenceIndex {\r
 207     // data members\r
 208     BamBinMap Bins;\r
 209     LinearOffsetVector Offsets;\r
 210     // constructor\r
 211     ReferenceIndex(const BamBinMap& binMap = BamBinMap(),\r
 212                    const LinearOffsetVector& offsets = LinearOffsetVector())\r
 213         : Bins(binMap)\r
 214         , Offsets(offsets)\r
 215     { }\r
 216 };\r
 217 \r
 218 typedef std::vector<ReferenceIndex> BamIndex;\r
 219 \r
 220 // ----------------------------------------------------------------\r
 221 // BamAlignment member methods\r
 222 \r
 223 // constructors & destructor\r
 224 inline \r
 225 BamAlignment::BamAlignment(void) { }\r
 226 \r
 227 inline \r
 228 BamAlignment::BamAlignment(const BamAlignment& other)\r
 229     : Name(other.Name)\r
 230     , Length(other.Length)\r
 231     , QueryBases(other.QueryBases)\r
 232     , AlignedBases(other.AlignedBases)\r
 233     , Qualities(other.Qualities)\r
 234     , TagData(other.TagData)\r
 235     , RefID(other.RefID)\r
 236     , Position(other.Position)\r
 237     , Bin(other.Bin)\r
 238     , MapQuality(other.MapQuality)\r
 239     , AlignmentFlag(other.AlignmentFlag)\r
 240     , CigarData(other.CigarData)\r
 241     , MateRefID(other.MateRefID)\r
 242     , MatePosition(other.MatePosition)\r
 243     , InsertSize(other.InsertSize)\r
 244 { }\r
 245 \r
 246 inline \r
 247 BamAlignment::~BamAlignment(void) { }\r
 248 \r
 249 // Queries against alignment flags\r
 250 inline bool BamAlignment::IsDuplicate(void) const         { return ( (AlignmentFlag & DUPLICATE)     != 0 ); }\r
 251 inline bool BamAlignment::IsFailedQC(void) const          { return ( (AlignmentFlag & QC_FAILED)     != 0 ); }\r
 252 inline bool BamAlignment::IsFirstMate(void) const         { return ( (AlignmentFlag & READ_1)        != 0 ); }\r
 253 inline bool BamAlignment::IsMapped(void) const            { return ( (AlignmentFlag & UNMAPPED)      == 0 ); }\r
 254 inline bool BamAlignment::IsMateMapped(void) const        { return ( (AlignmentFlag & MATE_UNMAPPED) == 0 ); }\r
 255 inline bool BamAlignment::IsMateReverseStrand(void) const { return ( (AlignmentFlag & MATE_REVERSE)  != 0 ); }\r
 256 inline bool BamAlignment::IsPaired(void) const            { return ( (AlignmentFlag & PAIRED)        != 0 ); }\r
 257 inline bool BamAlignment::IsPrimaryAlignment(void) const  { return ( (AlignmentFlag & SECONDARY)     == 0 ); }\r
 258 inline bool BamAlignment::IsProperPair(void) const        { return ( (AlignmentFlag & PROPER_PAIR)   != 0 ); }\r
 259 inline bool BamAlignment::IsReverseStrand(void) const     { return ( (AlignmentFlag & REVERSE)       != 0 ); }\r
 260 inline bool BamAlignment::IsSecondMate(void) const        { return ( (AlignmentFlag & READ_2)        != 0 ); }\r
 261 \r
 262 // Manipulate alignment flags \r
 263 inline void BamAlignment::SetIsDuplicate(bool ok)          { if (ok) AlignmentFlag |= DUPLICATE;     else AlignmentFlag &= ~DUPLICATE; }\r
 264 inline void BamAlignment::SetIsFailedQC(bool ok)           { if (ok) AlignmentFlag |= QC_FAILED;     else AlignmentFlag &= ~QC_FAILED; }\r
 265 inline void BamAlignment::SetIsFirstMate(bool ok)          { if (ok) AlignmentFlag |= READ_1;        else AlignmentFlag &= ~READ_1; }\r
 266 inline void BamAlignment::SetIsMateUnmapped(bool ok)       { if (ok) AlignmentFlag |= MATE_UNMAPPED; else AlignmentFlag &= ~MATE_UNMAPPED; }\r
 267 inline void BamAlignment::SetIsMateReverseStrand(bool ok)  { if (ok) AlignmentFlag |= MATE_REVERSE;  else AlignmentFlag &= ~MATE_REVERSE; }\r
 268 inline void BamAlignment::SetIsPaired(bool ok)             { if (ok) AlignmentFlag |= PAIRED;        else AlignmentFlag &= ~PAIRED; }\r
 269 inline void BamAlignment::SetIsProperPair(bool ok)         { if (ok) AlignmentFlag |= PROPER_PAIR;   else AlignmentFlag &= ~PROPER_PAIR; }\r
 270 inline void BamAlignment::SetIsReverseStrand(bool ok)      { if (ok) AlignmentFlag |= REVERSE;       else AlignmentFlag &= ~REVERSE; }\r
 271 inline void BamAlignment::SetIsSecondaryAlignment(bool ok) { if (ok) AlignmentFlag |= SECONDARY;     else AlignmentFlag &= ~SECONDARY; }\r
 272 inline void BamAlignment::SetIsSecondMate(bool ok)         { if (ok) AlignmentFlag |= READ_2;        else AlignmentFlag &= ~READ_2; }\r
 273 inline void BamAlignment::SetIsUnmapped(bool ok)           { if (ok) AlignmentFlag |= UNMAPPED;      else AlignmentFlag &= ~UNMAPPED; }\r
 274 \r
 275 // calculates alignment end position, based on starting position and CIGAR operations\r
 276 inline \r
 277 int BamAlignment::GetEndPosition(bool usePadded) const {\r
 278 \r
 279     // initialize alignment end to starting position\r
 280     int alignEnd = Position;\r
 281 \r
 282     // iterate over cigar operations\r
 283     std::vector<CigarOp>::const_iterator cigarIter = CigarData.begin();\r
 284     std::vector<CigarOp>::const_iterator cigarEnd  = CigarData.end();\r
 285     for ( ; cigarIter != cigarEnd; ++cigarIter) {\r
 286         const char cigarType = (*cigarIter).Type;\r
 287         if ( cigarType == 'M' || cigarType == 'D' || cigarType == 'N' ) {\r
 288             alignEnd += (*cigarIter).Length;\r
 289         } \r
 290         else if ( usePadded && cigarType == 'I' ) {\r
 291             alignEnd += (*cigarIter).Length;\r
 292         }\r
 293     }\r
 294     return alignEnd;\r
 295 }\r
 296 \r
 297 // get "NM" tag data - contributed by Aaron Quinlan\r
 298 // stores data in 'editDistance', returns success/fail\r
 299 inline \r
 300 bool BamAlignment::GetEditDistance(uint8_t& editDistance) const {\r
 301 \r
 302     if ( TagData.empty() ) { return false; }\r
 303 \r
 304     // localize the tag data\r
 305     char* pTagData = (char*)TagData.data();\r
 306     const unsigned int tagDataLen = TagData.size();\r
 307     unsigned int numBytesParsed = 0;\r
 308 \r
 309     bool foundEditDistanceTag = false;\r
 310     while( numBytesParsed < tagDataLen ) {\r
 311 \r
 312         const char* pTagType = pTagData;\r
 313         const char* pTagStorageType = pTagData + 2;\r
 314         pTagData       += 3;\r
 315         numBytesParsed += 3;\r
 316 \r
 317         // check the current tag\r
 318         if ( strncmp(pTagType, "NM", 2) == 0 ) {\r
 319             foundEditDistanceTag = true;\r
 320             break;\r
 321         }\r
 322 \r
 323         // get the storage class and find the next tag\r
 324         if (*pTagStorageType == '\0') { return false; }\r
 325         SkipToNextTag( *pTagStorageType, pTagData, numBytesParsed );\r
 326         if (*pTagData == '\0') { return false; }\r
 327     }\r
 328     // return if the edit distance tag was not present\r
 329     if ( !foundEditDistanceTag ) { return false; }\r
 330 \r
 331     // assign the editDistance value\r
 332     std::memcpy(&editDistance, pTagData, 1);\r
 333     return true;\r
 334 }\r
 335 \r
 336 // get "RG" tag data\r
 337 // stores data in 'readGroup', returns success/fail\r
 338 inline \r
 339 bool BamAlignment::GetReadGroup(std::string& readGroup) const {\r
 340 \r
 341     if ( TagData.empty() ) { return false; }\r
 342 \r
 343     // localize the tag data\r
 344     char* pTagData = (char*)TagData.data();\r
 345     const unsigned int tagDataLen = TagData.size();\r
 346     unsigned int numBytesParsed = 0;\r
 347 \r
 348     bool foundReadGroupTag = false;\r
 349     while( numBytesParsed < tagDataLen ) {\r
 350 \r
 351         const char* pTagType = pTagData;\r
 352         const char* pTagStorageType = pTagData + 2;\r
 353         pTagData       += 3;\r
 354         numBytesParsed += 3;\r
 355 \r
 356         // check the current tag\r
 357         if ( std::strncmp(pTagType, "RG", 2) == 0 ) {\r
 358             foundReadGroupTag = true;\r
 359             break;\r
 360         }\r
 361 \r
 362         // get the storage class and find the next tag\r
 363         if (*pTagStorageType == '\0') { return false; }\r
 364         SkipToNextTag( *pTagStorageType, pTagData, numBytesParsed );\r
 365         if (*pTagData == '\0') { return false; }\r
 366     }\r
 367 \r
 368     // return if the read group tag was not present\r
 369     if ( !foundReadGroupTag ) { return false; }\r
 370 \r
 371     // assign the read group\r
 372     const unsigned int readGroupLen = std::strlen(pTagData);\r
 373     readGroup.resize(readGroupLen);\r
 374     std::memcpy( (char*)readGroup.data(), pTagData, readGroupLen );\r
 375     return true;\r
 376 }\r
 377 \r
 378 inline\r
 379 bool BamAlignment::GetTag(const std::string& tag, std::string& destination) {\r
 380   \r
 381     if ( TagData.empty() ) { return false; }\r
 382 \r
 383     // localize the tag data\r
 384     char* pTagData = (char*)TagData.data();\r
 385     const unsigned int tagDataLen = TagData.size();\r
 386     unsigned int numBytesParsed = 0;\r
 387 \r
 388     bool foundReadGroupTag = false;\r
 389     while( numBytesParsed < tagDataLen ) {\r
 390 \r
 391         const char* pTagType = pTagData;\r
 392         const char* pTagStorageType = pTagData + 2;\r
 393         pTagData       += 3;\r
 394         numBytesParsed += 3;\r
 395 \r
 396         // check the current tag\r
 397         if ( std::strncmp(pTagType, tag.c_str(), 2) == 0 ) {\r
 398             foundReadGroupTag = true;\r
 399             break;\r
 400         }\r
 401 \r
 402         // get the storage class and find the next tag\r
 403         if (*pTagStorageType == '\0') { return false; }\r
 404         SkipToNextTag( *pTagStorageType, pTagData, numBytesParsed );\r
 405         if (*pTagData == '\0') { return false; }\r
 406     }\r
 407 \r
 408     // return if the read group tag was not present\r
 409     if ( !foundReadGroupTag ) { return false; }\r
 410 \r
 411     // assign the read group\r
 412     const unsigned int dataLen = std::strlen(pTagData);\r
 413     destination.resize(dataLen);\r
 414     std::memcpy( (char*)destination.data(), pTagData, dataLen );\r
 415     return true;\r
 416 }\r
 417 \r
 418 template<typename T> \r
 419 bool BamAlignment::GetTag(const std::string& tag, T& destination) {\r
 420   \r
 421     if ( TagData.empty() ) { return false; }\r
 422 \r
 423     // localize the tag data\r
 424     char* pTagData = (char*)TagData.data();\r
 425     const unsigned int tagDataLen = TagData.size();\r
 426     unsigned int numBytesParsed = 0;\r
 427 \r
 428     bool foundDesiredTag = false;\r
 429     while( numBytesParsed < tagDataLen ) {\r
 430 \r
 431         const char* pTagType = pTagData;\r
 432         const char* pTagStorageType = pTagData + 2;\r
 433         pTagData       += 3;\r
 434         numBytesParsed += 3;\r
 435 \r
 436         // check the current tag\r
 437         if ( strncmp(pTagType, tag.c_str(), 2) == 0 ) {\r
 438             foundDesiredTag = true;\r
 439             break;\r
 440         }\r
 441 \r
 442         // get the storage class and find the next tag\r
 443         if (*pTagStorageType == '\0') { return false; }\r
 444         SkipToNextTag( *pTagStorageType, pTagData, numBytesParsed );\r
 445         if (*pTagData == '\0') { return false; }\r
 446     }\r
 447     // return if the edit distance tag was not present\r
 448     if ( !foundDesiredTag ) { return false; }\r
 449 \r
 450     // assign the editDistance value\r
 451     std::memcpy(&destination, pTagData, sizeof(T));\r
 452     return true;\r
 453 }\r
 454 \r
 455 inline\r
 456 void BamAlignment::SkipToNextTag(const char storageType, char* &pTagData, unsigned int& numBytesParsed) {\r
 457     \r
 458     switch(storageType) {\r
 459 \r
 460         case 'A':\r
 461         case 'c':\r
 462         case 'C':\r
 463             ++numBytesParsed;\r
 464             ++pTagData;\r
 465             break;\r
 466 \r
 467         case 's':\r
 468         case 'S':\r
 469             numBytesParsed += 2;\r
 470             pTagData       += 2;\r
 471             break;\r
 472 \r
 473         case 'f':\r
 474         case 'i':\r
 475         case 'I':\r
 476             numBytesParsed += 4;\r
 477             pTagData       += 4;\r
 478             break;\r
 479 \r
 480         case 'Z':\r
 481         case 'H':\r
 482             while(*pTagData) {\r
 483                 ++numBytesParsed;\r
 484                 ++pTagData;\r
 485             }\r
 486         // ---------------------------\r
 487         // Added: 3-25-2010 DWB\r
 488         // Contributed: ARQ\r
 489         // Fixed: error parsing variable length tag data\r
 490             ++pTagData;\r
 491         // ---------------------------\r
 492             break;\r
 493 \r
 494         default:\r
 495             printf("ERROR: Unknown tag storage class encountered: [%c]\n", *pTagData);\r
 496             exit(1);\r
 497     }\r
 498 }\r
 499 \r
 500 // ----------------------------------------------------------------\r
 501 // Added: 3-35-2010 DWB\r
 502 // Fixed: Routines to provide endian-correctness\r
 503 // ----------------------------------------------------------------\r
 504 \r
 505 // returns true if system is big endian\r
 506 inline bool SystemIsBigEndian(void) {\r
 507    const uint16_t one = 0x0001;\r
 508    return ((*(char*) &one) == 0 );\r
 509 }\r
 510 \r
 511 // swaps endianness of 16-bit value 'in place'\r
 512 inline void SwapEndian_16(int16_t& x) {\r
 513     x = ((x >> 8) | (x << 8));\r
 514 }\r
 515 \r
 516 inline void SwapEndian_16(uint16_t& x) {\r
 517     x = ((x >> 8) | (x << 8));\r
 518 }\r
 519 \r
 520 // swaps endianness of 32-bit value 'in-place'\r
 521 inline void SwapEndian_32(int32_t& x) {\r
 522     x = ( (x >> 24) | \r
 523          ((x << 8) & 0x00FF0000) | \r
 524          ((x >> 8) & 0x0000FF00) | \r
 525           (x << 24)\r
 526         );\r
 527 }\r
 528 \r
 529 inline void SwapEndian_32(uint32_t& x) {\r
 530     x = ( (x >> 24) | \r
 531          ((x << 8) & 0x00FF0000) | \r
 532          ((x >> 8) & 0x0000FF00) | \r
 533           (x << 24)\r
 534         );\r
 535 }\r
 536 \r
 537 // swaps endianness of 64-bit value 'in-place'\r
 538 inline void SwapEndian_64(int64_t& x) {\r
 539     x = ( (x >> 56) | \r
 540          ((x << 40) & 0x00FF000000000000ll) |\r
 541          ((x << 24) & 0x0000FF0000000000ll) |\r
 542          ((x << 8)  & 0x000000FF00000000ll) |\r
 543          ((x >> 8)  & 0x00000000FF000000ll) |\r
 544          ((x >> 24) & 0x0000000000FF0000ll) |\r
 545          ((x >> 40) & 0x000000000000FF00ll) |\r
 546           (x << 56)\r
 547         );\r
 548 }\r
 549 \r
 550 inline void SwapEndian_64(uint64_t& x) {\r
 551     x = ( (x >> 56) | \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
 558           (x << 56)\r
 559         );\r
 560 }\r
 561 \r
 562 // swaps endianness of 'next 2 bytes' in a char buffer (in-place)\r
 563 inline void SwapEndian_16p(char* data) {\r
 564     uint16_t& value = (uint16_t&)*data; \r
 565     SwapEndian_16(value);\r
 566 }\r
 567 \r
 568 // swaps endianness of 'next 4 bytes' in a char buffer (in-place)\r
 569 inline void SwapEndian_32p(char* data) {\r
 570     uint32_t& value = (uint32_t&)*data; \r
 571     SwapEndian_32(value);\r
 572 }\r
 573 \r
 574 // swaps endianness of 'next 8 bytes' in a char buffer (in-place)\r
 575 inline void SwapEndian_64p(char* data) {\r
 576     uint64_t& value = (uint64_t&)*data; \r
 577     SwapEndian_64(value);\r
 578 }\r
 579 \r
 580 } // namespace BamTools\r
 581 \r
 582 #endif // BAMAUX_H\r