bgzf.h

   1 /* The MIT License
   2
   3    Copyright (c) 2008 Broad Institute / Massachusetts Institute of Technology
   4                  2011, 2012 Attractive Chaos <attractor@live.co.uk>
   5
   6    Permission is hereby granted, free of charge, to any person obtaining a copy
   7    of this software and associated documentation files (the "Software"), to deal
   8    in the Software without restriction, including without limitation the rights
   9    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10    copies of the Software, and to permit persons to whom the Software is
  11    furnished to do so, subject to the following conditions:
  12
  13    The above copyright notice and this permission notice shall be included in
  14    all copies or substantial portions of the Software.
  15
  16    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22    THE SOFTWARE.
  23 */
  24
  25 /* The BGZF library was originally written by Bob Handsaker from the Broad
  26  * Institute. It was later improved by the SAMtools developers. */
  27
  28 #ifndef __BGZF_H
  29 #define __BGZF_H
  30
  31 #include <stdint.h>
  32 #include <stdio.h>
  33 #include <zlib.h>
  34
  35 #define BGZF_BLOCK_SIZE     0xff00 // make sure compressBound(BGZF_BLOCK_SIZE) < BGZF_MAX_BLOCK_SIZE
  36 #define BGZF_MAX_BLOCK_SIZE 0x10000
  37
  38 #define BGZF_ERR_ZLIB   1
  39 #define BGZF_ERR_HEADER 2
  40 #define BGZF_ERR_IO     4
  41 #define BGZF_ERR_MISUSE 8
  42
  43 typedef struct {
  44         int errcode:16, is_write:2, compress_level:14;
  45         int cache_size;
  46     int block_length, block_offset;
  47     int64_t block_address;
  48     void *uncompressed_block, *compressed_block;
  49         void *cache; // a pointer to a hash table
  50         void *fp; // actual file handler; FILE* on writing; FILE* or knetFile* on reading
  51         void *mt; // only used for multi-threading
  52 } BGZF;
  53
  54 #ifndef KSTRING_T
  55 #define KSTRING_T kstring_t
  56 typedef struct __kstring_t {
  57         size_t l, m;
  58         char *s;
  59 } kstring_t;
  60 #endif
  61
  62 #ifdef __cplusplus
  63 extern "C" {
  64 #endif
  65
  66         /******************
  67          * Basic routines *
  68          ******************/
  69
  70         /**
  71          * Open an existing file descriptor for reading or writing.
  72          *
  73          * @param fd    file descriptor
  74          * @param mode  mode matching /[rwu0-9]+/: 'r' for reading, 'w' for writing and a digit specifies
  75          *              the zlib compression level; if both 'r' and 'w' are present, 'w' is ignored.
  76          * @return      BGZF file handler; 0 on error
  77          */
  78         BGZF* bgzf_dopen(int fd, const char *mode);
  79
  80         #define bgzf_fdopen(fd, mode) bgzf_dopen((fd), (mode)) // for backward compatibility
  81
  82         /**
  83          * Open the specified file for reading or writing.
  84          */
  85         BGZF* bgzf_open(const char* path, const char *mode);
  86
  87         /**
  88          * Close the BGZF and free all associated resources.
  89          *
  90          * @param fp    BGZF file handler
  91          * @return      0 on success and -1 on error
  92          */
  93         int bgzf_close(BGZF *fp);
  94
  95         /**
  96          * Read up to _length_ bytes from the file storing into _data_.
  97          *
  98          * @param fp     BGZF file handler
  99          * @param data   data array to read into
 100          * @param length size of data to read
 101          * @return       number of bytes actually read; 0 on end-of-file and -1 on error
 102          */
 103         ssize_t bgzf_read(BGZF *fp, void *data, ssize_t length);
 104
 105         /**
 106          * Write _length_ bytes from _data_ to the file.
 107          *
 108          * @param fp     BGZF file handler
 109          * @param data   data array to write
 110          * @param length size of data to write
 111          * @return       number of bytes actually written; -1 on error
 112          */
 113         ssize_t bgzf_write(BGZF *fp, const void *data, ssize_t length);
 114
 115         /**
 116          * Write the data in the buffer to the file.
 117          */
 118         int bgzf_flush(BGZF *fp);
 119
 120         /**
 121          * Return a virtual file pointer to the current location in the file.
 122          * No interpetation of the value should be made, other than a subsequent
 123          * call to bgzf_seek can be used to position the file at the same point.
 124          * Return value is non-negative on success.
 125          */
 126         #define bgzf_tell(fp) ((fp->block_address << 16) | (fp->block_offset & 0xFFFF))
 127
 128         /**
 129          * Set the file to read from the location specified by _pos_.
 130          *
 131          * @param fp     BGZF file handler
 132          * @param pos    virtual file offset returned by bgzf_tell()
 133          * @param whence must be SEEK_SET
 134          * @return       0 on success and -1 on error
 135          */
 136         int64_t bgzf_seek(BGZF *fp, int64_t pos, int whence);
 137
 138         /**
 139          * Check if the BGZF end-of-file (EOF) marker is present
 140          *
 141          * @param fp    BGZF file handler opened for reading
 142          * @return      1 if EOF is present; 0 if not or on I/O error
 143          */
 144         int bgzf_check_EOF(BGZF *fp);
 145
 146         /**
 147          * Check if a file is in the BGZF format
 148          *
 149          * @param fn    file name
 150          * @return      1 if _fn_ is BGZF; 0 if not or on I/O error
 151          */
 152          int bgzf_is_bgzf(const char *fn);
 153
 154         /*********************
 155          * Advanced routines *
 156          *********************/
 157
 158         /**
 159          * Set the cache size. Only effective when compiled with -DBGZF_CACHE.
 160          *
 161          * @param fp    BGZF file handler
 162          * @param size  size of cache in bytes; 0 to disable caching (default)
 163          */
 164         void bgzf_set_cache_size(BGZF *fp, int size);
 165
 166         /**
 167          * Flush the file if the remaining buffer size is smaller than _size_
 168          */
 169         int bgzf_flush_try(BGZF *fp, ssize_t size);
 170
 171         /**
 172          * Read one byte from a BGZF file. It is faster than bgzf_read()
 173          * @param fp     BGZF file handler
 174          * @return       byte read; -1 on end-of-file or error
 175          */
 176         int bgzf_getc(BGZF *fp);
 177
 178         /**
 179          * Read one line from a BGZF file. It is faster than bgzf_getc()
 180          *
 181          * @param fp     BGZF file handler
 182          * @param delim  delimitor
 183          * @param str    string to write to; must be initialized
 184          * @return       length of the string; 0 on end-of-file; negative on error
 185          */
 186         int bgzf_getline(BGZF *fp, int delim, kstring_t *str);
 187
 188         /**
 189          * Read the next BGZF block.
 190          */
 191         int bgzf_read_block(BGZF *fp);
 192
 193         /**
 194          * Enable multi-threading (only effective on writing)
 195          *
 196          * @param fp          BGZF file handler; must be opened for writing
 197          * @param n_threads   #threads used for writing
 198          * @param n_sub_blks  #blocks processed by each thread; a value 64-256 is recommended
 199          */
 200         int bgzf_mt(BGZF *fp, int n_threads, int n_sub_blks);
 201
 202 #ifdef __cplusplus
 203 }
 204 #endif
 205
 206 #endif