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       pass
 130
 131   ctypedef struct bam_plbuf_t:
 132       pass
 133
 134   ctypedef struct pair64_t:
 135       uint64_t u, v
 136
 137   ctypedef struct bam_iter_t:
 138       int from_first
 139       int tid, beg, end, n_off, i, finished
 140       uint64_t curr_off
 141       pair64_t *off
 142
 143   # ctypedef __bam_iter_t * bam_iter_t
 144
 145   bam1_t * bam_init1()
 146   void bam_destroy1(bam1_t *)
 147
 148   bamFile razf_dopen(int data_fd, char *mode)
 149
 150   int64_t bam_seek( bamFile fp, uint64_t voffset, int where)
 151   int64_t bam_tell( bamFile fp )
 152
 153   # void bam_init_header_hash(bam_header_t *header)
 154
 155   ###############################################
 156   # stand-ins for samtools macros
 157   uint32_t * bam1_cigar( bam1_t * b)
 158   char * bam1_qname( bam1_t * b)
 159   uint8_t * bam1_seq( bam1_t * b)
 160   uint8_t * bam1_qual( bam1_t * b)
 161   uint8_t * bam1_aux( bam1_t * b)
 162
 163   ###############################################
 164   # bam iterator interface
 165   bam_iter_t bam_iter_query( bam_index_t *idx, int tid, int beg, int end)
 166
 167   int bam_iter_read(bamFile fp, bam_iter_t iter, bam1_t *b)
 168
 169   void bam_iter_destroy(bam_iter_t iter)
 170
 171   ###############################################
 172
 173   bam1_t * bam_dup1( bam1_t *src )
 174
 175   bam1_t * bam_copy1(bam1_t *bdst, bam1_t *bsrc)
 176   bam_index_t *bam_index_load(char *f )
 177
 178   void bam_index_destroy(bam_index_t *idx)
 179
 180   int bam_parse_region(bam_header_t *header, char *str, int *ref_id, int *begin, int *end)
 181
 182   ###############################################
 183   bam_plbuf_t *bam_plbuf_init(bam_pileup_f func, void *data)
 184
 185   int bam_fetch(bamFile fp, bam_index_t *idx, int tid, int beg, int end, void *data, bam_fetch_f func)
 186
 187   int bam_plbuf_push(bam1_t *b, bam_plbuf_t *buf)
 188
 189   void bam_plbuf_destroy(bam_plbuf_t *buf)
 190   ########################################
 191   # pileup iterator interface
 192   ctypedef struct bam_plp_t:
 193       pass
 194
 195   ctypedef bam_pileup1_t * const_bam_pileup1_t_ptr "const bam_pileup1_t *"
 196
 197   ctypedef int (*bam_plp_auto_f)(void *data, bam1_t *b)
 198
 199   bam_plp_t bam_plp_init( bam_plp_auto_f func, void *data)
 200   int bam_plp_push( bam_plp_t iter,  bam1_t *b)
 201   bam_pileup1_t * bam_plp_next( bam_plp_t iter, int *_tid, int *_pos, int *_n_plp)
 202   bam_pileup1_t * bam_plp_auto( bam_plp_t iter, int *_tid, int *_pos, int *_n_plp)
 203   void bam_plp_set_mask(bam_plp_t iter, int mask)
 204   void bam_plp_reset(bam_plp_t iter)
 205   void bam_plp_destroy(bam_plp_t iter)
 206
 207   ##################################################
 208
 209   int bam_read1( bamFile fp, bam1_t *b)
 210   int bam_validate1( bam_header_t *header, bam1_t *b)
 211   int bam_write1( bamFile fp, bam1_t *b)
 212
 213   bam_header_t *bam_header_init()
 214
 215   int bam_header_write( bamFile fp, bam_header_t *header)
 216
 217   bam_header_t *bam_header_read( bamFile fp )
 218
 219   void bam_header_destroy(bam_header_t *header)
 220
 221   bam1_t * bam_dup1( bam1_t *src )
 222
 223   bam1_t * bam_copy1(bam1_t *bdst, bam1_t *bsrc)
 224
 225   uint8_t *bam_aux_get(bam1_t *b,  char tag[2])
 226
 227   int32_t bam_aux2i(uint8_t *s)
 228   float bam_aux2f(uint8_t *s)
 229   double bam_aux2d(uint8_t *s)
 230   char bam_aux2A( uint8_t *s)
 231   char *bam_aux2Z( uint8_t *s)
 232
 233   int bam_reg2bin(uint32_t beg, uint32_t end)
 234
 235   uint32_t bam_calend(bam1_core_t *c, uint32_t *cigar)
 236
 237 cdef extern from *:
 238     ctypedef char* const_char_ptr "const char*"
 239
 240 cdef extern from "sam.h":
 241
 242   ctypedef struct samfile_t_un:
 243     tamFile tamr
 244     bamFile bam
 245     FILE *tamw
 246
 247   ctypedef struct samfile_t:
 248      int type
 249      samfile_t_un x
 250      bam_header_t *header
 251
 252   samfile_t *samopen( const_char_ptr fn, char * mode, void *aux)
 253
 254   int sampileup( samfile_t *fp, int mask, bam_pileup_f func, void *data)
 255
 256   void samclose(samfile_t *fp)
 257
 258   int samread(samfile_t *fp, bam1_t *b)
 259
 260   int samwrite(samfile_t *fp, bam1_t *b)
 261
 262   int bam_prob_realn(bam1_t *b, char *ref)
 263   int bam_cap_mapQ(bam1_t *b, char *ref, int thres)
 264
 265
 266 cdef extern from "glf.h":
 267    ctypedef struct glf1_t:
 268       pass
 269
 270 cdef extern from "bam_maqcns.h":
 271
 272   ctypedef struct bam_maqcns_t:
 273      float het_rate, theta
 274      int n_hap, cap_mapQ, errmod, min_baseQ
 275      float eta, q_r
 276      double *fk, *coef
 277      double *lhet
 278      void *aux
 279
 280   glf1_t *bam_maqcns_glfgen(int n,
 281                             bam_pileup1_t *pl,
 282                             uint8_t ref_base,
 283                             bam_maqcns_t *bm)
 284
 285   ctypedef struct bam_maqindel_opt_t:
 286       int q_indel
 287       float r_indel
 288       float r_snp
 289       int mm_penalty, indel_err, ambi_thres
 290
 291   uint32_t bam_maqcns_call(int n, bam_pileup1_t *pl, bam_maqcns_t *bm)
 292   bam_maqcns_t * bam_maqcns_init()
 293   void bam_maqcns_destroy(bam_maqcns_t *bm)
 294   void bam_maqcns_prepare(bam_maqcns_t *bm)
 295
 296   uint32_t glf2cns(glf1_t *g, int q_r)
 297
 298   int BAM_ERRMOD_MAQ2
 299   int BAM_ERRMOD_MAQ
 300   int BAM_ERRMOD_SOAP
 301
 302   ctypedef struct bam_maqindel_ret_t:
 303     int indel1
 304     int indel2
 305     int cnt1
 306     int cnt2
 307     int cnt_anti
 308     int cnt_ref
 309     int cnt_ambi
 310     char *s[2]
 311     int gt
 312     int gl[2]
 313     int q_cns
 314     int q_ref
 315
 316   void bam_maqindel_ret_destroy( bam_maqindel_ret_t * )
 317
 318   bam_maqindel_opt_t *bam_maqindel_opt_init()
 319
 320   bam_maqindel_ret_t * bam_maqindel(int n,
 321                      int pos,
 322                      bam_maqindel_opt_t * mi,
 323                      bam_pileup1_t * pl,
 324                      char *ref,
 325                      int _n_types,
 326                      int * _types )
 327
 328
 329 cdef extern from "faidx.h":
 330
 331    ctypedef struct faidx_t:
 332       pass
 333
 334    int fai_build(char *fn)
 335
 336    void fai_destroy(faidx_t *fai)
 337
 338    faidx_t *fai_load(char *fn)
 339
 340    char *fai_fetch(faidx_t *fai, char *reg, int *len)
 341
 342    int faidx_fetch_nseq(faidx_t *fai)
 343
 344    char *faidx_fetch_seq(faidx_t *fai, char *c_name,
 345                          int p_beg_i, int p_end_i, int *len)
 346
 347
 348 cdef extern from "pysam_util.h":
 349
 350     int pysam_pileup_next(bam1_t *b,
 351                           bam_plbuf_t *buf,
 352                           bam_pileup1_t ** plp,
 353                           int * tid,
 354                           int * pos,
 355                           int * n_plp )
 356
 357
 358     int pysam_dispatch(int argc, char *argv[] )
 359
 360     # stand-in functions for samtools macros
 361     void pysam_bam_destroy1( bam1_t * b)
 362
 363     # add *nbytes* into the variable length data of *src* at *pos*
 364     bam1_t * pysam_bam_update( bam1_t * b,
 365                                size_t nbytes_old,
 366                                size_t nbytes_new,
 367                                uint8_t * pos )
 368
 369     # translate char to unsigned char
 370     unsigned char pysam_translate_sequence( char s )
 371
 372     unsigned char * bam_nt16_table
 373
 374     int pysam_reference2tid( bam_header_t *header, char * s )
 375
 376     void pysam_set_stderr( FILE * file )
 377
 378     uint32_t pysam_glf_depth( glf1_t * g )
 379
 380     void pysam_dump_glf( glf1_t * g, bam_maqcns_t * c )
 381
 382 # need to declare all C fields and methods here
 383 cdef class AlignedRead:
 384
 385     # object that this AlignedRead represents
 386     cdef bam1_t * _delegate
 387
 388 cdef class Samfile:
 389     cdef char * _filename
 390     # pointer to samfile
 391     cdef samfile_t * samfile
 392     # pointer to index
 393     cdef bam_index_t *index
 394     # true if file is a bam file
 395     cdef int isbam
 396     # true if file is not on the local filesystem
 397     cdef int isremote
 398     # current read within iteration
 399     cdef bam1_t * b
 400     # file opening mode
 401     cdef char * mode
 402
 403     cdef bam_header_t * _buildHeader( self, new_header )
 404     cdef bam1_t * getCurrent( self )
 405     cdef int cnext(self)
 406
 407     # write an aligned read
 408     cpdef int write( self, AlignedRead read )
 409
 410     cdef char * _getrname( self, int tid )
 411