* samtools-0.1.7-12 (r589)

[samtools.git] / bam.h

/* The MIT License

   Copyright (c) 2008 Genome Research Ltd (GRL).

   Permission is hereby granted, free of charge, to any person obtaining
   a copy of this software and associated documentation files (the
   "Software"), to deal in the Software without restriction, including
   without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense, and/or sell copies of the Software, and to
   permit persons to whom the Software is furnished to do so, subject to
   the following conditions:

   The above copyright notice and this permission notice shall be
   included in all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
   BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
   ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE.
*/

/* Contact: Heng Li <lh3@sanger.ac.uk> */

#ifndef BAM_BAM_H
#define BAM_BAM_H

/*!
  @header

  BAM library provides I/O and various operations on manipulating files
  in the BAM (Binary Alignment/Mapping) or SAM (Sequence Alignment/Map)
  format. It now supports importing from or exporting to TAM, sorting,
  merging, generating pileup, and quickly retrieval of reads overlapped
  with a specified region.

  @copyright Genome Research Ltd.
 */

#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>

#ifndef BAM_LITE
#define BAM_VIRTUAL_OFFSET16
#include "bgzf.h"
/*! @abstract BAM file handler */
typedef BGZF *bamFile;
#define bam_open(fn, mode) bgzf_open(fn, mode)
#define bam_dopen(fd, mode) bgzf_fdopen(fd, mode)
#define bam_close(fp) bgzf_close(fp)
#define bam_read(fp, buf, size) bgzf_read(fp, buf, size)
#define bam_write(fp, buf, size) bgzf_write(fp, buf, size)
#define bam_tell(fp) bgzf_tell(fp)
#define bam_seek(fp, pos, dir) bgzf_seek(fp, pos, dir)
#else
#define BAM_TRUE_OFFSET
#include <zlib.h>
typedef gzFile bamFile;
#define bam_open(fn, mode) gzopen(fn, mode)
#define bam_dopen(fd, mode) gzdopen(fd, mode)
#define bam_close(fp) gzclose(fp)
#define bam_read(fp, buf, size) gzread(fp, buf, size)
/* no bam_write/bam_tell/bam_seek() here */
#endif

/*! @typedef
  @abstract Structure for the alignment header.
  @field n_targets   number of reference sequences
  @field target_name names of the reference sequences
  @field target_len  lengths of the referene sequences
  @field dict        header dictionary
  @field hash        hash table for fast name lookup
  @field rg2lib      hash table for @RG-ID -> LB lookup
  @field l_text      length of the plain text in the header
  @field text        plain text

  @discussion Field hash points to null by default. It is a private
  member.
 */
typedef struct {
        int32_t n_targets;
        char **target_name;
        uint32_t *target_len;
        void *dict, *hash, *rg2lib;
        size_t l_text, n_text;
        char *text;
} bam_header_t;

/*! @abstract the read is paired in sequencing, no matter whether it is mapped in a pair */
#define BAM_FPAIRED        1
/*! @abstract the read is mapped in a proper pair */
#define BAM_FPROPER_PAIR   2
/*! @abstract the read itself is unmapped; conflictive with BAM_FPROPER_PAIR */
#define BAM_FUNMAP         4
/*! @abstract the mate is unmapped */
#define BAM_FMUNMAP        8
/*! @abstract the read is mapped to the reverse strand */
#define BAM_FREVERSE      16
/*! @abstract the mate is mapped to the reverse strand */
#define BAM_FMREVERSE     32
/*! @abstract this is read1 */
#define BAM_FREAD1        64
/*! @abstract this is read2 */
#define BAM_FREAD2       128
/*! @abstract not primary alignment */
#define BAM_FSECONDARY   256
/*! @abstract QC failure */
#define BAM_FQCFAIL      512
/*! @abstract optical or PCR duplicate */
#define BAM_FDUP        1024

#define BAM_OFDEC          0
#define BAM_OFHEX          1
#define BAM_OFSTR          2

/*! @abstract defautl mask for pileup */
#define BAM_DEF_MASK (BAM_FUNMAP | BAM_FSECONDARY | BAM_FQCFAIL | BAM_FDUP)

#define BAM_CORE_SIZE   sizeof(bam1_core_t)

/**
 * Describing how CIGAR operation/length is packed in a 32-bit integer.
 */
#define BAM_CIGAR_SHIFT 4
#define BAM_CIGAR_MASK  ((1 << BAM_CIGAR_SHIFT) - 1)

/*
  CIGAR operations.
 */
/*! @abstract CIGAR: match */
#define BAM_CMATCH      0
/*! @abstract CIGAR: insertion to the reference */
#define BAM_CINS        1
/*! @abstract CIGAR: deletion from the reference */
#define BAM_CDEL        2
/*! @abstract CIGAR: skip on the reference (e.g. spliced alignment) */
#define BAM_CREF_SKIP   3
/*! @abstract CIGAR: clip on the read with clipped sequence present in qseq */
#define BAM_CSOFT_CLIP  4
/*! @abstract CIGAR: clip on the read with clipped sequence trimmed off */
#define BAM_CHARD_CLIP  5
/*! @abstract CIGAR: padding */
#define BAM_CPAD        6

/*! @typedef
  @abstract Structure for core alignment information.
  @field  tid     chromosome ID, defined by bam_header_t
  @field  pos     0-based leftmost coordinate
  @field  strand  strand; 0 for forward and 1 otherwise
  @field  bin     bin calculated by bam_reg2bin()
  @field  qual    mapping quality
  @field  l_qname length of the query name
  @field  flag    bitwise flag
  @field  n_cigar number of CIGAR operations
  @field  l_qseq  length of the query sequence (read)
 */
typedef struct {
        int32_t tid;
        int32_t pos;
        uint32_t bin:16, qual:8, l_qname:8;
        uint32_t flag:16, n_cigar:16;
        int32_t l_qseq;
        int32_t mtid;
        int32_t mpos;
        int32_t isize;
} bam1_core_t;

/*! @typedef
  @abstract Structure for one alignment.
  @field  core       core information about the alignment
  @field  l_aux      length of auxiliary data
  @field  data_len   current length of bam1_t::data
  @field  m_data     maximum length of bam1_t::data
  @field  data       all variable-length data, concatenated; structure: cigar-qname-seq-qual-aux

  @discussion Notes:
 
   1. qname is zero tailing and core.l_qname includes the tailing '\0'.
   2. l_qseq is calculated from the total length of an alignment block
      on reading or from CIGAR.
 */
typedef struct {
        bam1_core_t core;
        int l_aux, data_len, m_data;
        uint8_t *data;
} bam1_t;

typedef struct __bam_iterf_t *bam_iterf_t;

#define bam1_strand(b) (((b)->core.flag&BAM_FREVERSE) != 0)
#define bam1_mstrand(b) (((b)->core.flag&BAM_FMREVERSE) != 0)

/*! @function
  @abstract  Get the CIGAR array
  @param  b  pointer to an alignment
  @return    pointer to the CIGAR array

  @discussion In the CIGAR array, each element is a 32-bit integer. The
  lower 4 bits gives a CIGAR operation and the higher 28 bits keep the
  length of a CIGAR.
 */
#define bam1_cigar(b) ((uint32_t*)((b)->data + (b)->core.l_qname))

/*! @function
  @abstract  Get the name of the query
  @param  b  pointer to an alignment
  @return    pointer to the name string, null terminated
 */
#define bam1_qname(b) ((char*)((b)->data))

/*! @function
  @abstract  Get query sequence
  @param  b  pointer to an alignment
  @return    pointer to sequence

  @discussion Each base is encoded in 4 bits: 1 for A, 2 for C, 4 for G,
  8 for T and 15 for N. Two bases are packed in one byte with the base
  at the higher 4 bits having smaller coordinate on the read. It is
  recommended to use bam1_seqi() macro to get the base.
 */
#define bam1_seq(b) ((b)->data + (b)->core.n_cigar*4 + (b)->core.l_qname)

/*! @function
  @abstract  Get query quality
  @param  b  pointer to an alignment
  @return    pointer to quality string
 */
#define bam1_qual(b) ((b)->data + (b)->core.n_cigar*4 + (b)->core.l_qname + ((b)->core.l_qseq + 1)/2)

/*! @function
  @abstract  Get a base on read
  @param  s  Query sequence returned by bam1_seq()
  @param  i  The i-th position, 0-based
  @return    4-bit integer representing the base.
 */
#define bam1_seqi(s, i) ((s)[(i)/2] >> 4*(1-(i)%2) & 0xf)

/*! @function
  @abstract  Get query sequence and quality
  @param  b  pointer to an alignment
  @return    pointer to the concatenated auxiliary data
 */
#define bam1_aux(b) ((b)->data + (b)->core.n_cigar*4 + (b)->core.l_qname + (b)->core.l_qseq + ((b)->core.l_qseq + 1)/2)

#ifndef kroundup32
/*! @function
  @abstract  Round an integer to the next closest power-2 integer.
  @param  x  integer to be rounded (in place)
  @discussion x will be modified.
 */
#define kroundup32(x) (--(x), (x)|=(x)>>1, (x)|=(x)>>2, (x)|=(x)>>4, (x)|=(x)>>8, (x)|=(x)>>16, ++(x))
#endif

/*!
  @abstract Whether the machine is big-endian; modified only in
  bam_header_init().
 */
extern int bam_is_be;

/*! @abstract Table for converting a nucleotide character to the 4-bit encoding. */
extern unsigned char bam_nt16_table[256];

/*! @abstract Table for converting a 4-bit encoded nucleotide to a letter. */
extern char *bam_nt16_rev_table;

extern char bam_nt16_nt4_table[];

#ifdef __cplusplus
extern "C" {
#endif

        /*! @abstract TAM file handler */
        typedef struct __tamFile_t *tamFile;

        /*!
          @abstract   Open a SAM file for reading, either uncompressed or compressed by gzip/zlib.
          @param  fn  SAM file name
          @return     SAM file handler
         */
        tamFile sam_open(const char *fn);

        /*!
          @abstract   Close a SAM file handler
          @param  fp  SAM file handler
         */
        void sam_close(tamFile fp);

        /*!
          @abstract      Read one alignment from a SAM file handler
          @param  fp     SAM file handler
          @param  header header information (ordered names of chromosomes)
          @param  b      read alignment; all members in b will be updated
          @return        0 if successful; otherwise negative
         */
        int sam_read1(tamFile fp, bam_header_t *header, bam1_t *b);

        /*!
          @abstract       Read header information from a TAB-delimited list file.
          @param  fn_list file name for the list
          @return         a pointer to the header structure

          @discussion Each line in this file consists of chromosome name and
          the length of chromosome.
         */
        bam_header_t *sam_header_read2(const char *fn_list);

        /*!
          @abstract       Read header from a SAM file (if present)
          @param  fp      SAM file handler
          @return         pointer to header struct; 0 if no @SQ lines available
         */
        bam_header_t *sam_header_read(tamFile fp);

        /*!
          @abstract       Parse @SQ lines a update a header struct
          @param  h       pointer to the header struct to be updated
          @return         number of target sequences

          @discussion bam_header_t::{n_targets,target_len,target_name} will
          be destroyed in the first place.
         */
        int sam_header_parse(bam_header_t *h);

        /*!
          @abstract       Parse @RG lines a update a header struct
          @param  h       pointer to the header struct to be updated
          @return         number of @RG lines

          @discussion bam_header_t::rg2lib will be destroyed in the first
          place.
         */
        int sam_header_parse_rg(bam_header_t *h);

#define sam_write1(header, b) bam_view1(header, b)

        int bam_strmap_put(void *strmap, const char *rg, const char *lib);
        const char *bam_strmap_get(const void *strmap, const char *rg);
        void *bam_strmap_dup(const void*);
        void *bam_strmap_init();
        void bam_strmap_destroy(void *strmap);

        /*!
          @abstract Initialize a header structure.
          @return   the pointer to the header structure

          @discussion This function also modifies the global variable
          bam_is_be.
         */
        bam_header_t *bam_header_init();

        /*!
          @abstract        Destroy a header structure.
          @param  header  pointer to the header
         */
        void bam_header_destroy(bam_header_t *header);

        /*!
          @abstract   Read a header structure from BAM.
          @param  fp  BAM file handler, opened by bam_open()
          @return     pointer to the header structure

          @discussion The file position indicator must be placed at the
          beginning of the file. Upon success, the position indicator will
          be set at the start of the first alignment.
         */
        bam_header_t *bam_header_read(bamFile fp);

        /*!
          @abstract      Write a header structure to BAM.
          @param  fp     BAM file handler
          @param  header pointer to the header structure
          @return        always 0 currently
         */
        int bam_header_write(bamFile fp, const bam_header_t *header);

        /*!
          @abstract   Read an alignment from BAM.
          @param  fp  BAM file handler
          @param  b   read alignment; all members are updated.
          @return     number of bytes read from the file

          @discussion The file position indicator must be
          placed right before an alignment. Upon success, this function
          will set the position indicator to the start of the next
          alignment. This function is not affected by the machine
          endianness.
         */
        int bam_read1(bamFile fp, bam1_t *b);

        /*!
          @abstract Write an alignment to BAM.
          @param  fp       BAM file handler
          @param  c        pointer to the bam1_core_t structure
          @param  data_len total length of variable size data related to
                           the alignment
          @param  data     pointer to the concatenated data
          @return          number of bytes written to the file

          @discussion This function is not affected by the machine
          endianness.
         */
        int bam_write1_core(bamFile fp, const bam1_core_t *c, int data_len, uint8_t *data);

        /*!
          @abstract   Write an alignment to BAM.
          @param  fp  BAM file handler
          @param  b   alignment to write
          @return     number of bytes written to the file

          @abstract It is equivalent to:
            bam_write1_core(fp, &b->core, b->data_len, b->data)
         */
        int bam_write1(bamFile fp, const bam1_t *b);

        /*! @function
          @abstract  Initiate a pointer to bam1_t struct
         */
#define bam_init1() ((bam1_t*)calloc(1, sizeof(bam1_t)))

        /*! @function
          @abstract  Free the memory allocated for an alignment.
          @param  b  pointer to an alignment
         */
#define bam_destroy1(b) do {                                    \
                if (b) { free((b)->data); free(b); }    \
        } while (0)

        /*!
          @abstract       Format a BAM record in the SAM format
          @param  header  pointer to the header structure
          @param  b       alignment to print
          @return         a pointer to the SAM string
         */
        char *bam_format1(const bam_header_t *header, const bam1_t *b);

        char *bam_format1_core(const bam_header_t *header, const bam1_t *b, int of);

        const char *bam_get_library(bam_header_t *header, const bam1_t *b);

        /*! @typedef
          @abstract Structure for one alignment covering the pileup position.
          @field  b      pointer to the alignment
          @field  qpos   position of the read base at the pileup site, 0-based
          @field  indel  indel length; 0 for no indel, positive for ins and negative for del
          @field  is_del 1 iff the base on the padded read is a deletion
          @field  level  the level of the read in the "viewer" mode

          @discussion See also bam_plbuf_push() and bam_lplbuf_push(). The
          difference between the two functions is that the former does not
          set bam_pileup1_t::level, while the later does. Level helps the
          implementation of alignment viewers, but calculating this has some
          overhead.
         */
        typedef struct {
                bam1_t *b;
                int32_t qpos;
                int indel, level;
                uint32_t is_del:1, is_head:1, is_tail:1;
        } bam_pileup1_t;

        struct __bam_plp_t;
        typedef struct __bam_plp_t *bam_plp_t;

        bam_plp_t bam_plp_init();
        int bam_plp_push(bam_plp_t iter, const bam1_t *b);
        const bam_pileup1_t *bam_plp_next(bam_plp_t iter, int *_n_plp, int *_tid, int *_pos);
        void bam_plp_set_mask(bam_plp_t iter, int mask);
        void bam_plp_reset(bam_plp_t iter);
        void bam_plp_destroy(bam_plp_t iter);

        /*! @typedef
          @abstract    Type of function to be called by bam_plbuf_push().
          @param  tid  chromosome ID as is defined in the header
          @param  pos  start coordinate of the alignment, 0-based
          @param  n    number of elements in pl array
          @param  pl   array of alignments
          @param  data user provided data
          @discussion  See also bam_plbuf_push(), bam_plbuf_init() and bam_pileup1_t.
         */
        typedef int (*bam_pileup_f)(uint32_t tid, uint32_t pos, int n, const bam_pileup1_t *pl, void *data);

        typedef struct {
                bam_plp_t iter;
                bam_pileup_f func;
                void *data;
        } bam_plbuf_t;

        void bam_plbuf_set_mask(bam_plbuf_t *buf, int mask);
        void bam_plbuf_reset(bam_plbuf_t *buf);
        bam_plbuf_t *bam_plbuf_init(bam_pileup_f func, void *data);
        void bam_plbuf_destroy(bam_plbuf_t *buf);
        int bam_plbuf_push(const bam1_t *b, bam_plbuf_t *buf);

        int bam_pileup_file(bamFile fp, int mask, bam_pileup_f func, void *func_data);

        struct __bam_lplbuf_t;
        typedef struct __bam_lplbuf_t bam_lplbuf_t;

        void bam_lplbuf_reset(bam_lplbuf_t *buf);

        /*! @abstract  bam_plbuf_init() equivalent with level calculated. */
        bam_lplbuf_t *bam_lplbuf_init(bam_pileup_f func, void *data);

        /*! @abstract  bam_plbuf_destroy() equivalent with level calculated. */
        void bam_lplbuf_destroy(bam_lplbuf_t *tv);

        /*! @abstract  bam_plbuf_push() equivalent with level calculated. */
        int bam_lplbuf_push(const bam1_t *b, bam_lplbuf_t *buf);

        struct __bam_index_t;
        typedef struct __bam_index_t bam_index_t;

        /*!
          @abstract   Build index for a BAM file.
          @discussion Index file "fn.bai" will be created.
          @param  fn  name of the BAM file
          @return     always 0 currently
         */
        int bam_index_build(const char *fn);

        /*!
          @abstract   Load index from file "fn.bai".
          @param  fn  name of the BAM file (NOT the index file)
          @return     pointer to the index structure
         */
        bam_index_t *bam_index_load(const char *fn);

        /*!
          @abstract    Destroy an index structure.
          @param  idx  pointer to the index structure
         */
        void bam_index_destroy(bam_index_t *idx);

        /*! @typedef
          @abstract      Type of function to be called by bam_fetch().
          @param  b     the alignment
          @param  data  user provided data
         */
        typedef int (*bam_fetch_f)(const bam1_t *b, void *data);

        /*!
          @abstract Retrieve the alignments that are overlapped with the
          specified region.

          @discussion A user defined function will be called for each
          retrieved alignment ordered by its start position.

          @param  fp    BAM file handler
          @param  idx   pointer to the alignment index
          @param  tid   chromosome ID as is defined in the header
          @param  beg   start coordinate, 0-based
          @param  end   end coordinate, 0-based
          @param  data  user provided data (will be transferred to func)
          @param  func  user defined function
         */
        int bam_fetch(bamFile fp, const bam_index_t *idx, int tid, int beg, int end, void *data, bam_fetch_f func);

        bam_iterf_t bam_iterf_query(const bam_index_t *idx, int tid, int beg, int end);
        int bam_iterf_read(bamFile fp, bam_iterf_t iter, bam1_t *b);
        void bam_iterf_destroy(bam_iterf_t iter);

        /*!
          @abstract       Parse a region in the format: "chr2:100,000-200,000".
          @discussion     bam_header_t::hash will be initialized if empty.
          @param  header  pointer to the header structure
          @param  str     string to be parsed
          @param  ref_id  the returned chromosome ID
          @param  begin   the returned start coordinate
          @param  end     the returned end coordinate
          @return         0 on success; -1 on failure
         */
        int bam_parse_region(bam_header_t *header, const char *str, int *ref_id, int *begin, int *end);

        /*!
          @abstract       Retrieve data of a tag
          @param  b       pointer to an alignment struct
          @param  tag     two-character tag to be retrieved

          @return  pointer to the type and data. The first character is the
          type that can be 'iIsScCdfAZH'.

          @discussion  Use bam_aux2?() series to convert the returned data to
          the corresponding type.
        */
        uint8_t *bam_aux_get(const bam1_t *b, const char tag[2]);

        int32_t bam_aux2i(const uint8_t *s);
        float bam_aux2f(const uint8_t *s);
        double bam_aux2d(const uint8_t *s);
        char bam_aux2A(const uint8_t *s);
        char *bam_aux2Z(const uint8_t *s);

        int bam_aux_del(bam1_t *b, uint8_t *s);
        void bam_aux_append(bam1_t *b, const char tag[2], char type, int len, uint8_t *data);
        uint8_t *bam_aux_get_core(bam1_t *b, const char tag[2]); // an alias of bam_aux_get()

        /*!  
          @abstract Calculate the rightmost coordinate of an alignment on the
          reference genome.

          @param  c      pointer to the bam1_core_t structure
          @param  cigar  the corresponding CIGAR array (from bam1_t::cigar)
          @return        the rightmost coordinate, 0-based
        */
        uint32_t bam_calend(const bam1_core_t *c, const uint32_t *cigar);

        /*!
          @abstract      Calculate the length of the query sequence from CIGAR.
          @param  c      pointer to the bam1_core_t structure
          @param  cigar  the corresponding CIGAR array (from bam1_t::cigar)
          @return        length of the query sequence
        */
        int32_t bam_cigar2qlen(const bam1_core_t *c, const uint32_t *cigar);

#ifdef __cplusplus
}
#endif

/*!
  @abstract    Calculate the minimum bin that contains a region [beg,end).
  @param  beg  start of the region, 0-based
  @param  end  end of the region, 0-based
  @return      bin
 */
static inline int bam_reg2bin(uint32_t beg, uint32_t end)
{
        --end;
        if (beg>>14 == end>>14) return 4681 + (beg>>14);
        if (beg>>17 == end>>17) return  585 + (beg>>17);
        if (beg>>20 == end>>20) return   73 + (beg>>20);
        if (beg>>23 == end>>23) return    9 + (beg>>23);
        if (beg>>26 == end>>26) return    1 + (beg>>26);
        return 0;
}

/*!
  @abstract     Copy an alignment
  @param  bdst  destination alignment struct
  @param  bsrc  source alignment struct
  @return       pointer to the destination alignment struct
 */
static inline bam1_t *bam_copy1(bam1_t *bdst, const bam1_t *bsrc)
{
        uint8_t *data = bdst->data;
        int m_data = bdst->m_data;   // backup data and m_data
        if (m_data < bsrc->m_data) { // double the capacity
                m_data = bsrc->m_data; kroundup32(m_data);
                data = (uint8_t*)realloc(data, m_data);
        }
        memcpy(data, bsrc->data, bsrc->data_len); // copy var-len data
        *bdst = *bsrc; // copy the rest
        // restore the backup
        bdst->m_data = m_data;
        bdst->data = data;
        return bdst;
}

/*!
  @abstract     Duplicate an alignment
  @param  src   source alignment struct
  @return       pointer to the destination alignment struct
 */
static inline bam1_t *bam_dup1(const bam1_t *src)
{
        bam1_t *b;
        b = bam_init1();
        *b = *src;
        b->m_data = b->data_len;
        b->data = (uint8_t*)calloc(b->data_len, 1);
        memcpy(b->data, src->data, b->data_len);
        return b;
}

#endif