cram_io.h

Go to the documentation of this file.

/*
Copyright (c) 2012-2013 Genome Research Ltd.
Author: James Bonfield <jkb@sanger.ac.uk>

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

   1. Redistributions of source code must retain the above copyright notice, 
this list of conditions and the following disclaimer.

   2. Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution.

   3. Neither the names Genome Research Ltd and Wellcome Trust Sanger
Institute nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY GENOME RESEARCH LTD AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL GENOME RESEARCH LTD OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef _CRAM_IO_H_
#define _CRAM_IO_H_

#ifdef __cplusplus
extern "C" {
#endif

#define ITF8_MACROS

#include <stdint.h>
#include <cram/misc.h>

#define CRAM_KEY(a,b) (((a)<<8)|((b)))

int itf8_decode(cram_fd *fd, int32_t *val);

#ifndef ITF8_MACROS

int itf8_get(char *cp, int32_t *val_p);

int itf8_put(char *cp, int32_t val);

#else

/*
 * Macro implementations of the above
 */
#define itf8_get(c,v) (((uc)(c)[0]<0x80)?(*(v)=(uc)(c)[0],1):(((uc)(c)[0]<0xc0)?(*(v)=(((uc)(c)[0]<<8)|(uc)(c)[1])&0x3fff,2):(((uc)(c)[0]<0xe0)?(*(v)=(((uc)(c)[0]<<16)|((uc)(c)[1]<<8)|(uc)(c)[2])&0x1fffff,3):(((uc)(c)[0]<0xf0)?(*(v)=(((uc)(c)[0]<<24)|((uc)(c)[1]<<16)|((uc)(c)[2]<<8)|(uc)(c)[3])&0x0fffffff,4):(*(v)=(((uc)(c)[0]&0x0f)<<28)|((uc)(c)[1]<<20)|((uc)(c)[2]<<12)|((uc)(c)[3]<<4)|((uc)(c)[4]&0x0f),5)))))

#define itf8_put(c,v) ((!((v)&~0x7f))?((c)[0]=(v),1):(!((v)&~0x3fff))?((c)[0]=((v)>>8)|0x80,(c)[1]=(v)&0xff,2):(!((v)&~0x1fffff))?((c)[0]=((v)>>16)|0xc0,(c)[1]=((v)>>8)&0xff,(c)[2]=(v)&0xff,3):(!((v)&~0xfffffff))?((c)[0]=((v)>>24)|0xe0,(c)[1]=((v)>>16)&0xff,(c)[2]=((v)>>8)&0xff,(c)[3]=(v)&0xff,4):((c)[0]=0xf0|(((v)>>28)&0xff),(c)[1]=((v)>>20)&0xff,(c)[2]=((v)>>12)&0xff,(c)[3]=((v)>>4)&0xff,(c)[4]=(v)&0xf,5))

#define itf8_size(v) ((!((v)&~0x7f))?1:(!((v)&~0x3fff))?2:(!((v)&~0x1fffff))?3:(!((v)&~0xfffffff))?4:5)

#endif

int itf8_put_blk(cram_block *blk, int val);

cram_block *cram_new_block(enum cram_content_type content_type,
                           int content_id);

cram_block *cram_read_block(cram_fd *fd);

int cram_write_block(cram_fd *fd, cram_block *b);

void cram_free_block(cram_block *b);

char *zlib_mem_inflate(char *cdata, size_t csize, size_t *size);

int cram_uncompress_block(cram_block *b);

int cram_compress_block(cram_fd *fd, cram_block *b, cram_metrics *metrics,
                        int level,  int strat,
                        int level2, int strat2);

cram_metrics *cram_new_metrics(void);
char *cram_block_method2str(enum cram_block_method m);
char *cram_content_type2str(enum cram_content_type t);

/* --- Accessor macros for manipulating blocks on a byte by byte basis --- */

/* Block size and data pointer. */
#define BLOCK_SIZE(b) ((b)->byte)
#define BLOCK_DATA(b) ((b)->data)

/* Returns the address one past the end of the block */
#define BLOCK_END(b) (&(b)->data[(b)->byte])

/* Request block to be at least 'l' bytes long */
#define BLOCK_RESIZE(b,l)                                       \
    do {                                                        \
        while((b)->alloc <= (l)) {                              \
            (b)->alloc = (b)->alloc ? (b)->alloc*1.5 : 1024;    \
            (b)->data = realloc((b)->data, (b)->alloc);         \
        }                                                       \
     } while(0)

/* Ensure the block can hold at least another 'l' bytes */
#define BLOCK_GROW(b,l) BLOCK_RESIZE((b), BLOCK_SIZE((b)) + (l))

/* Append string 's' of length 'l' */
#define BLOCK_APPEND(b,s,l)               \
    do {                                  \
        BLOCK_GROW((b),(l));              \
        memcpy(BLOCK_END((b)), (s), (l)); \
        BLOCK_SIZE((b)) += (l);           \
    } while (0)

/* Append as single character 'c' */
#define BLOCK_APPEND_CHAR(b,c)            \
    do {                                  \
        BLOCK_GROW((b),1);                \
        (b)->data[(b)->byte++] = (c);     \
    } while (0)

/* Append via sprintf with 1 arg */
#define BLOCK_APPENDF_1(b,buf,fmt, a1)                  \
    do {                                                \
        int l = sprintf((buf), (fmt), (a1));            \
        BLOCK_APPEND((b), (buf), l);                    \
    } while (0)

/* Append via sprintf with 2 args */
#define BLOCK_APPENDF_2(b,buf,fmt, a1,a2)               \
    do {                                                \
        int l = sprintf((buf), (fmt), (a1), (a2));      \
        BLOCK_APPEND((b), (buf), l);                    \
    } while (0)

#define BLOCK_UPLEN(b) \
    (b)->comp_size = (b)->uncomp_size = BLOCK_SIZE((b))

int cram_load_reference(cram_fd *fd, char *fn);

int refs2id(refs_t *r, SAM_hdr *bfd);

void refs_free(refs_t *r);

char *cram_get_ref(cram_fd *fd, int id, int start, int end);
void cram_ref_incr(refs_t *r, int id);
void cram_ref_decr(refs_t *r, int id);
cram_container *cram_new_container(int nrec, int nslice);
void cram_free_container(cram_container *c);

cram_container *cram_read_container(cram_fd *fd);

int cram_write_container(cram_fd *fd, cram_container *h);

int cram_flush_container(cram_fd *fd, cram_container *c);
int cram_flush_container_mt(cram_fd *fd, cram_container *c);


cram_block_compression_hdr *cram_new_compression_header(void);

void cram_free_compression_header(cram_block_compression_hdr *hdr);


void cram_free_slice_header(cram_block_slice_hdr *hdr);

void cram_free_slice(cram_slice *s);

cram_slice *cram_new_slice(enum cram_content_type type, int nrecs);

cram_slice *cram_read_slice(cram_fd *fd);



cram_file_def *cram_read_file_def(cram_fd *fd);

int cram_write_file_def(cram_fd *fd, cram_file_def *def);

void cram_free_file_def(cram_file_def *def);


SAM_hdr *cram_read_SAM_hdr(cram_fd *fd);

int cram_write_SAM_hdr(cram_fd *fd, SAM_hdr *hdr);


cram_fd *cram_open(const char *filename, const char *mode);

cram_fd *cram_dopen(cram_FILE *fp, const char *filename, const char *mode);

int cram_close(cram_fd *fd);

/*
 * Seek within a CRAM file.
 *
 * Returns 0 on success
 *        -1 on failure
 */
int cram_seek(cram_fd *fd, off_t offset, int whence);

/*
 * Flushes a CRAM file.
 * Useful for when writing to stdout without wishing to close the stream.
 *
 * Returns 0 on success
 *        -1 on failure
 */
int cram_flush(cram_fd *fd);

int cram_eof(cram_fd *fd);

int cram_set_option(cram_fd *fd, enum cram_option opt, ...);

int cram_set_voption(cram_fd *fd, enum cram_option opt, va_list args);

int cram_set_header(cram_fd *fd, SAM_hdr *hdr);


#ifdef __cplusplus
}
#endif

#endif /* _CRAM_IO_H_ */