pysam/csamtools.pxd

   1 cdef extern from "string.h":
   2   ctypedef int size_t
   3   void *memcpy(void *dst,void *src,size_t len)
   4   void *memmove(void *dst,void *src,size_t len)
   5   void *memset(void *b,int c,size_t len)
   6
   7 cdef extern from "stdlib.h":
   8   void free(void *)
   9   void *malloc(size_t)
  10   void *calloc(size_t,size_t)
  11   void *realloc(void *,size_t)
  12   int c_abs "abs" (int)
  13   void qsort(void *base, size_t nmemb, size_t size,
  14              int (*compar)(void *,void *))
  15
  16 cdef extern from "math.h":
  17    double sqrt(double x)
  18
  19 cdef extern from "stdio.h":
  20   ctypedef struct FILE:
  21     pass
  22   FILE *fopen(char *,char *)
  23   FILE *freopen(char *path, char *mode, FILE *stream)
  24   int fileno(FILE *stream)
  25   int dup2(int oldfd, int newfd)
  26   int fflush(FILE *stream)
  27
  28   FILE * stderr
  29   FILE * stdout
  30   int fclose(FILE *)
  31   int sscanf(char *str,char *fmt,...)
  32   int printf(char *fmt,...)
  33   int sprintf(char *str,char *fmt,...)
  34   int fprintf(FILE *ifile,char *fmt,...)
  35   char *fgets(char *str,int size,FILE *ifile)
  36
  37 cdef extern from "ctype.h":
  38   int toupper(int c)
  39   int tolower(int c)
  40
  41 cdef extern from "unistd.h":
  42   char *ttyname(int fd)
  43   int isatty(int fd)
  44
  45 cdef extern from "string.h":
  46   int strcmp(char *s1, char *s2)
  47   int strncmp(char *s1,char *s2,size_t len)
  48   char *strcpy(char *dest,char *src)
  49   char *strncpy(char *dest,char *src, size_t len)
  50   char *strdup(char *)
  51   char *strcat(char *,char *)
  52   size_t strlen(char *s)
  53   int memcmp( void * s1, void *s2, size_t len )
  54
  55 cdef extern from "Python.h":
  56    long _Py_HashPointer(void*)
  57    FILE* PyFile_AsFile(object)
  58
  59 cdef extern from "fileobject.h":
  60    ctypedef class __builtin__.file [object PyFileObject]:
  61         pass
  62
  63 cdef extern from "razf.h":
  64   pass
  65
  66 cdef extern from "stdint.h":
  67   ctypedef int int64_t
  68   ctypedef int int32_t
  69   ctypedef int uint32_t
  70   ctypedef int uint8_t
  71   ctypedef int uint64_t
  72
  73 cdef extern from "bam.h":
  74
  75   # constants
  76   int BAM_DEF_MASK
  77   # IF _IOLIB=2, bamFile = BGZF, see bgzf.h
  78   # samtools uses KNETFILE, check how this works
  79
  80   ctypedef struct tamFile:
  81       pass
  82
  83   ctypedef struct bamFile:
  84       pass
  85
  86   ctypedef struct bam1_core_t:
  87       int32_t tid
  88       int32_t pos
  89       uint32_t bin
  90       uint32_t qual
  91       uint32_t l_qname
  92       uint32_t flag
  93       uint32_t n_cigar
  94       int32_t l_qseq
  95       int32_t mtid
  96       int32_t mpos
  97       int32_t isize
  98
  99   ctypedef struct bam1_t:
 100     bam1_core_t core
 101     int l_aux
 102     int data_len
 103     int m_data
 104     uint8_t *data
 105
 106   ctypedef struct bam_pileup1_t:
 107       bam1_t *b
 108       int32_t qpos
 109       int indel
 110       int level
 111       uint32_t is_del
 112       uint32_t is_head
 113       uint32_t is_tail
 114
 115   ctypedef int (*bam_pileup_f)(uint32_t tid, uint32_t pos, int n, bam_pileup1_t *pl, void *data)
 116
 117   ctypedef int (*bam_fetch_f)(bam1_t *b, void *data)
 118
 119   ctypedef struct bam_header_t:
 120      int32_t n_targets
 121      char **target_name
 122      uint32_t *target_len
 123      void *hash
 124      void *rg2lib
 125      int l_text
 126      char *text
 127
 128   ctypedef struct bam_index_t:
 129       int32_t n
 130       uint64_t n_no_coor
 131
 132   ctypedef struct bam_plbuf_t:
 133       pass
 134
 135   ctypedef struct pair64_t:
 136       uint64_t u, v
 137
 138   ctypedef struct bam_iter_t:
 139       int from_first
 140       int tid, beg, end, n_off, i, finished
 141       uint64_t curr_off
 142       pair64_t *off
 143
 144   # ctypedef __bam_iter_t * bam_iter_t
 145
 146   bam1_t * bam_init1()
 147   void bam_destroy1(bam1_t *)
 148
 149   bamFile razf_dopen(int data_fd, char *mode)
 150
 151   int64_t bam_seek( bamFile fp, uint64_t voffset, int where)
 152   int64_t bam_tell( bamFile fp )
 153
 154   # void bam_init_header_hash(bam_header_t *header)
 155
 156   ###############################################
 157   # stand-ins for samtools macros
 158   uint32_t * bam1_cigar( bam1_t * b)
 159   char * bam1_qname( bam1_t * b)
 160   uint8_t * bam1_seq( bam1_t * b)
 161   uint8_t * bam1_qual( bam1_t * b)
 162   uint8_t * bam1_aux( bam1_t * b)
 163
 164   ###############################################
 165   # bam iterator interface
 166   bam_iter_t bam_iter_query( bam_index_t *idx, int tid, int beg, int end)
 167
 168   int bam_iter_read(bamFile fp, bam_iter_t iter, bam1_t *b)
 169
 170   void bam_iter_destroy(bam_iter_t iter)
 171
 172   ###############################################
 173
 174   bam1_t * bam_dup1( bam1_t *src )
 175
 176   bam1_t * bam_copy1(bam1_t *bdst, bam1_t *bsrc)
 177   bam_index_t *bam_index_load(char *f )
 178
 179   void bam_index_destroy(bam_index_t *idx)
 180
 181   int bam_parse_region(bam_header_t *header, char *str, int *ref_id, int *begin, int *end)
 182
 183   ###############################################
 184   bam_plbuf_t *bam_plbuf_init(bam_pileup_f func, void *data)
 185
 186   int bam_fetch(bamFile fp, bam_index_t *idx, int tid, int beg, int end, void *data, bam_fetch_f func)
 187
 188   int bam_plbuf_push(bam1_t *b, bam_plbuf_t *buf)
 189
 190   void bam_plbuf_destroy(bam_plbuf_t *buf)
 191   ########################################
 192   # pileup iterator interface
 193   ctypedef struct bam_plp_t:
 194       pass
 195
 196   ctypedef bam_pileup1_t * const_bam_pileup1_t_ptr "const bam_pileup1_t *"
 197
 198   ctypedef int (*bam_plp_auto_f)(void *data, bam1_t *b)
 199
 200   bam_plp_t bam_plp_init( bam_plp_auto_f func, void *data)
 201   int bam_plp_push( bam_plp_t iter,  bam1_t *b)
 202   bam_pileup1_t * bam_plp_next( bam_plp_t iter, int *_tid, int *_pos, int *_n_plp)
 203   bam_pileup1_t * bam_plp_auto( bam_plp_t iter, int *_tid, int *_pos, int *_n_plp)
 204   void bam_plp_set_mask(bam_plp_t iter, int mask)
 205   void bam_plp_reset(bam_plp_t iter)
 206   void bam_plp_destroy(bam_plp_t iter)
 207   void bam_plp_set_maxcnt(bam_plp_t iter, int maxcnt)
 208
 209   ##################################################
 210
 211   int bam_read1( bamFile fp, bam1_t *b)
 212   int bam_validate1( bam_header_t *header, bam1_t *b)
 213   int bam_write1( bamFile fp, bam1_t *b)
 214
 215   bam_header_t *bam_header_init()
 216
 217   int bam_header_write( bamFile fp, bam_header_t *header)
 218
 219   bam_header_t *bam_header_read( bamFile fp )
 220
 221   void bam_header_destroy(bam_header_t *header)
 222
 223   bam1_t * bam_dup1( bam1_t *src )
 224
 225   bam1_t * bam_copy1(bam1_t *bdst, bam1_t *bsrc)
 226
 227   uint8_t *bam_aux_get(bam1_t *b,  char tag[2])
 228
 229   int32_t bam_aux2i(uint8_t *s)
 230   float bam_aux2f(uint8_t *s)
 231   double bam_aux2d(uint8_t *s)
 232   char bam_aux2A( uint8_t *s)
 233   char *bam_aux2Z( uint8_t *s)
 234
 235   int bam_reg2bin(uint32_t beg, uint32_t end)
 236
 237   uint32_t bam_calend(bam1_core_t *c, uint32_t *cigar)
 238
 239 cdef extern from *:
 240     ctypedef char* const_char_ptr "const char*"
 241
 242 cdef extern from "sam.h":
 243
 244   ctypedef struct samfile_t_un:
 245     tamFile tamr
 246     bamFile bam
 247     FILE *tamw
 248
 249   ctypedef struct samfile_t:
 250      int type
 251      samfile_t_un x
 252      bam_header_t *header
 253
 254   samfile_t *samopen( const_char_ptr fn, char * mode, void *aux)
 255
 256   int sampileup( samfile_t *fp, int mask, bam_pileup_f func, void *data)
 257
 258   void samclose(samfile_t *fp)
 259
 260   int samread(samfile_t *fp, bam1_t *b)
 261
 262   int samwrite(samfile_t *fp, bam1_t *b)
 263
 264   int bam_prob_realn(bam1_t *b, char *ref)
 265   int bam_cap_mapQ(bam1_t *b, char *ref, int thres)
 266
 267
 268 #cdef extern from "glf.h":
 269 #   ctypedef struct glf1_t:
 270 #      pass
 271
 272 #cdef extern from "bam_maqcns.h":
 273 #
 274 #  ctypedef struct bam_maqcns_t:
 275 #     float het_rate, theta
 276 #     int n_hap, cap_mapQ, errmod, min_baseQ
 277 #     float eta, q_r
 278 #     double *fk, *coef
 279 #     double *lhet
 280 #     void *aux
 281
 282 #  glf1_t *bam_maqcns_glfgen(int n,
 283 #                            bam_pileup1_t *pl,
 284 #                            uint8_t ref_base,
 285 #                            bam_maqcns_t *bm)
 286
 287 #  ctypedef struct bam_maqindel_opt_t:
 288 #      int q_indel
 289 #      float r_indel
 290 #      float r_snp
 291 #      int mm_penalty, indel_err, ambi_thres
 292
 293 #  uint32_t bam_maqcns_call(int n, bam_pileup1_t *pl, bam_maqcns_t *bm)
 294 #  bam_maqcns_t * bam_maqcns_init()
 295 #  void bam_maqcns_destroy(bam_maqcns_t *bm)
 296 #  void bam_maqcns_prepare(bam_maqcns_t *bm)
 297
 298 #  uint32_t glf2cns(glf1_t *g, int q_r)
 299
 300 #  int BAM_ERRMOD_MAQ2
 301 #  int BAM_ERRMOD_MAQ
 302 #  int BAM_ERRMOD_SOAP
 303
 304 #  ctypedef struct bam_maqindel_ret_t:
 305 #    int indel1
 306 #    int indel2
 307 #    int cnt1
 308 #    int cnt2
 309 #    int cnt_anti
 310 #    int cnt_ref
 311 #    int cnt_ambi
 312 #    char *s[2]
 313 #    int gt
 314 #    int gl[2]
 315 #    int q_cns
 316 #    int q_ref
 317
 318 #  void bam_maqindel_ret_destroy( bam_maqindel_ret_t * )
 319
 320 #  bam_maqindel_opt_t *bam_maqindel_opt_init()
 321
 322 #  bam_maqindel_ret_t * bam_maqindel(int n,
 323 #                    int pos,
 324 #                    bam_maqindel_opt_t * mi,
 325 #                    bam_pileup1_t * pl,
 326 #                    char *ref,
 327 #                    int _n_types,
 328 #                    int * _types )
 329
 330
 331 cdef extern from "faidx.h":
 332
 333    ctypedef struct faidx_t:
 334       pass
 335
 336    int fai_build(char *fn)
 337
 338    void fai_destroy(faidx_t *fai)
 339
 340    faidx_t *fai_load(char *fn)
 341
 342    char *fai_fetch(faidx_t *fai, char *reg, int *len)
 343
 344    int faidx_fetch_nseq(faidx_t *fai)
 345
 346    char *faidx_fetch_seq(faidx_t *fai, char *c_name,
 347                          int p_beg_i, int p_end_i, int *len)
 348
 349
 350 cdef extern from "pysam_util.h":
 351
 352     int pysam_pileup_next(bam1_t *b,
 353                           bam_plbuf_t *buf,
 354                           bam_pileup1_t ** plp,
 355                           int * tid,
 356                           int * pos,
 357                           int * n_plp )
 358
 359
 360     int pysam_dispatch(int argc, char *argv[] )
 361
 362     # stand-in functions for samtools macros
 363     void pysam_bam_destroy1( bam1_t * b)
 364
 365     # add *nbytes* into the variable length data of *src* at *pos*
 366     bam1_t * pysam_bam_update( bam1_t * b,
 367                                size_t nbytes_old,
 368                                size_t nbytes_new,
 369                                uint8_t * pos )
 370
 371     # translate char to unsigned char
 372     unsigned char pysam_translate_sequence( char s )
 373
 374     unsigned char * bam_nt16_table
 375
 376     int pysam_reference2tid( bam_header_t *header, char * s )
 377
 378     void pysam_set_stderr( FILE * file )
 379
 380     # return mapped/unmapped reads on tid
 381     uint32_t pysam_get_mapped( bam_index_t *idx, int tid )
 382     uint32_t pysam_get_unmapped( bam_index_t *idx, int tid )
 383
 384 #    uint32_t pysam_glf_depth( glf1_t * g )
 385
 386 #    void pysam_dump_glf( glf1_t * g, bam_maqcns_t * c )
 387
 388 # need to declare all C fields and methods here
 389 cdef class AlignedRead:
 390
 391     # object that this AlignedRead represents
 392     cdef bam1_t * _delegate
 393
 394 cdef class Samfile:
 395     cdef char * _filename
 396     # pointer to samfile
 397     cdef samfile_t * samfile
 398     # pointer to index
 399     cdef bam_index_t *index
 400     # true if file is a bam file
 401     cdef int isbam
 402     # true if not a file but a stream
 403     cdef int isstream
 404     # true if file is not on the local filesystem
 405     cdef int isremote
 406     # current read within iteration
 407     cdef bam1_t * b
 408     # file opening mode
 409     cdef char * mode
 410
 411     # beginning of read section
 412     cdef int64_t start_offset
 413
 414     cdef bam_header_t * _buildHeader( self, new_header )
 415     cdef bam1_t * getCurrent( self )
 416     cdef int cnext(self)
 417
 418     # write an aligned read
 419     cpdef int write( self, AlignedRead read )
 420
 421     cdef char * _getrname( self, int tid )
 422
 423 cdef class IteratorRow:
 424     pass
 425
 426 cdef class IteratorRowAll(IteratorRow):
 427     cdef bam1_t * b
 428     cdef samfile_t * fp
 429     # true if samfile belongs to this object
 430     cdef int owns_samfile
 431
 432     cdef bam1_t * getCurrent( self )
 433
 434     cdef int cnext(self)
 435
 436