annotate ezBAMQC/src/htslib/cram/cram_encode.h @ 0:dfa3745e5fd8

Uploaded
author youngkim
date Thu, 24 Mar 2016 17:12:52 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
1 /*
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
2 Copyright (c) 2012-2013 Genome Research Ltd.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
3 Author: James Bonfield <jkb@sanger.ac.uk>
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
4
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
5 Redistribution and use in source and binary forms, with or without
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
6 modification, are permitted provided that the following conditions are met:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
7
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
8 1. Redistributions of source code must retain the above copyright notice,
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
9 this list of conditions and the following disclaimer.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
10
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
11 2. Redistributions in binary form must reproduce the above copyright notice,
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
12 this list of conditions and the following disclaimer in the documentation
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
13 and/or other materials provided with the distribution.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
14
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
15 3. Neither the names Genome Research Ltd and Wellcome Trust Sanger
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
16 Institute nor the names of its contributors may be used to endorse or promote
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
17 products derived from this software without specific prior written permission.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
18
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
19 THIS SOFTWARE IS PROVIDED BY GENOME RESEARCH LTD AND CONTRIBUTORS "AS IS" AND
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
20 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
21 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
22 DISCLAIMED. IN NO EVENT SHALL GENOME RESEARCH LTD OR CONTRIBUTORS BE LIABLE
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
23 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
24 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
25 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
26 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
27 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
29 */
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
30
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
31 /*! \file
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
32 * Include cram.h instead.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
33 *
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
34 * This is an internal part of the CRAM system and is automatically included
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
35 * when you #include cram.h.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
36 *
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
37 * Implements the encoding portion of CRAM I/O. Also see
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
38 * cram_codecs.[ch] for the actual encoding functions themselves.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
39 */
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
40
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
41 #ifndef _CRAM_WRITE_H_
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
42 #define _CRAM_WRITE_H_
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
43
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
44 #ifdef __cplusplus
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
45 extern "C" {
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
46 #endif
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
47
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
48 /* ----------------------------------------------------------------------
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
49 * CRAM sequence iterators.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
50 */
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
51
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
52 /*! Write iterator: put BAM format sequences into a CRAM file.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
53 *
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
54 * We buffer up a containers worth of data at a time.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
55 *
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
56 * FIXME: break this into smaller pieces.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
57 *
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
58 * @return
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
59 * Returns 0 on success;
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
60 * -1 on failure
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
61 */
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
62 int cram_put_bam_seq(cram_fd *fd, bam_seq_t *b);
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
63
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
64
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
65 /* ----------------------------------------------------------------------
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
66 * Internal functions
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
67 */
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
68
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
69 /*! INTERNAL:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
70 * Encodes a compression header block into a generic cram_block structure.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
71 *
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
72 * @return
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
73 * Returns cram_block ptr on success;
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
74 * NULL on failure
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
75 */
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
76 cram_block *cram_encode_compression_header(cram_fd *fd, cram_container *c,
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
77 cram_block_compression_hdr *h);
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
78
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
79 /*! INTERNAL:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
80 * Encodes a slice compression header.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
81 *
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
82 * @return
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
83 * Returns cram_block on success;
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
84 * NULL on failure
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
85 */
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
86 cram_block *cram_encode_slice_header(cram_fd *fd, cram_slice *s);
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
87
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
88 /*! INTERNAL:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
89 * Encodes all slices in a container into blocks.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
90 *
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
91 * @return
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
92 * Returns 0 on success;
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
93 * -1 on failure
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
94 *
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
95 * FIXME: separate into encode_container and write_container. Ideally
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
96 * we should be able to do read_container / write_container or
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
97 * decode_container / encode_container.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
98 */
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
99 int cram_encode_container(cram_fd *fd, cram_container *c);
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
100
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
101 #ifdef __cplusplus
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
102 }
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
103 #endif
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
104
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
105 #endif