openshot-audio  0.1.7
inflate.h
Go to the documentation of this file.
1 /* inflate.h -- internal inflate state definition
2  * Copyright (C) 1995-2004 Mark Adler
3  * For conditions of distribution and use, see copyright notice in zlib.h
4  */
5 
6 /* WARNING: this file should *not* be used by applications. It is
7  part of the implementation of the compression library and is
8  subject to change. Applications should only use zlib.h.
9  */
10 
11 #ifndef _INFLATE_H_
12 #define _INFLATE_H_
13 
14 /* define NO_GZIP when compiling if you want to disable gzip header and
15  trailer decoding by inflate(). NO_GZIP would be used to avoid linking in
16  the crc code when it is not needed. For shared libraries, gzip decoding
17  should be left enabled. */
18 #ifndef NO_GZIP
19 # define GUNZIP
20 #endif
21 
22 /* Possible inflate modes between inflate() calls */
23 typedef enum {
24  HEAD, /* i: waiting for magic header */
25  FLAGS, /* i: waiting for method and flags (gzip) */
26  TIME, /* i: waiting for modification time (gzip) */
27  OS, /* i: waiting for extra flags and operating system (gzip) */
28  EXLEN, /* i: waiting for extra length (gzip) */
29  EXTRA, /* i: waiting for extra bytes (gzip) */
30  NAME, /* i: waiting for end of file name (gzip) */
31  COMMENT, /* i: waiting for end of comment (gzip) */
32  HCRC, /* i: waiting for header crc (gzip) */
33  DICTID, /* i: waiting for dictionary check value */
34  DICT, /* waiting for inflateSetDictionary() call */
35  TYPE, /* i: waiting for type bits, including last-flag bit */
36  TYPEDO, /* i: same, but skip check to exit inflate on new block */
37  STORED, /* i: waiting for stored size (length and complement) */
38  COPY, /* i/o: waiting for input or output to copy stored block */
39  TABLE, /* i: waiting for dynamic block table lengths */
40  LENLENS, /* i: waiting for code length code lengths */
41  CODELENS, /* i: waiting for length/lit and distance code lengths */
42  LEN, /* i: waiting for length/lit code */
43  LENEXT, /* i: waiting for length extra bits */
44  DIST, /* i: waiting for distance code */
45  DISTEXT, /* i: waiting for distance extra bits */
46  MATCH, /* o: waiting for output space to copy string */
47  LIT, /* o: waiting for output space to write literal */
48  CHECK, /* i: waiting for 32-bit check value */
49  LENGTH, /* i: waiting for 32-bit length (gzip) */
50  DONE, /* finished check, done -- remain here until reset */
51  BAD, /* got a data error -- remain here until reset */
52  MEM, /* got an inflate() memory error -- remain here until reset */
53  SYNC /* looking for synchronization bytes to restart inflate() */
54 } inflate_mode;
55 
56 /*
57  State transitions between above modes -
58 
59  (most modes can go to the BAD or MEM mode -- not shown for clarity)
60 
61  Process header:
62  HEAD -> (gzip) or (zlib)
63  (gzip) -> FLAGS -> TIME -> OS -> EXLEN -> EXTRA -> NAME
64  NAME -> COMMENT -> HCRC -> TYPE
65  (zlib) -> DICTID or TYPE
66  DICTID -> DICT -> TYPE
67  Read deflate blocks:
68  TYPE -> STORED or TABLE or LEN or CHECK
69  STORED -> COPY -> TYPE
70  TABLE -> LENLENS -> CODELENS -> LEN
71  Read deflate codes:
72  LEN -> LENEXT or LIT or TYPE
73  LENEXT -> DIST -> DISTEXT -> MATCH -> LEN
74  LIT -> LEN
75  Process trailer:
76  CHECK -> LENGTH -> DONE
77  */
78 
79 /* state maintained between inflate() calls. Approximately 7K bytes. */
80 struct inflate_state {
81  inflate_mode mode; /* current inflate mode */
82  int last; /* true if processing last block */
83  int wrap; /* bit 0 true for zlib, bit 1 true for gzip */
84  int havedict; /* true if dictionary provided */
85  int flags; /* gzip header method and flags (0 if zlib) */
86  unsigned dmax; /* zlib header max distance (INFLATE_STRICT) */
87  unsigned long check; /* protected copy of check value */
88  unsigned long total; /* protected copy of output count */
89  gz_headerp head; /* where to save gzip header information */
90  /* sliding window */
91  unsigned wbits; /* log base 2 of requested window size */
92  unsigned wsize; /* window size or zero if not using window */
93  unsigned whave; /* valid bytes in the window */
94  unsigned write; /* window write index */
95  unsigned char FAR *window; /* allocated sliding window, if needed */
96  /* bit accumulator */
97  unsigned long hold; /* input bit accumulator */
98  unsigned bits; /* number of bits in "in" */
99  /* for string and stored block copying */
100  unsigned length; /* literal or length of data to copy */
101  unsigned offset; /* distance back to copy string from */
102  /* for table and code decoding */
103  unsigned extra; /* extra bits needed */
104  /* fixed and dynamic code tables */
105  code const FAR *lencode; /* starting table for length/literal codes */
106  code const FAR *distcode; /* starting table for distance codes */
107  unsigned lenbits; /* index bits for lencode */
108  unsigned distbits; /* index bits for distcode */
109  /* dynamic table building */
110  unsigned ncode; /* number of code length code lengths */
111  unsigned nlen; /* number of length code lengths */
112  unsigned ndist; /* number of distance code lengths */
113  unsigned have; /* number of code lengths in lens[] */
114  code FAR *next; /* next available space in codes[] */
115  unsigned short lens[320]; /* temporary storage for code lengths */
116  unsigned short work[288]; /* work area for code table building */
117  code codes[ENOUGH]; /* space for code tables */
118 };
119 
120 
121 #endif
Definition: inflate.h:31
unsigned nlen
Definition: inflate.h:111
Definition: inflate.h:38
#define ENOUGH
Definition: inflate.h:80
int havedict
Definition: inflate.h:84
Definition: inflate.h:37
Definition: inflate.h:45
unsigned ndist
Definition: inflate.h:112
unsigned long total
Definition: inflate.h:88
gz_headerp head
Definition: inflate.h:89
unsigned wsize
Definition: inflate.h:92
unsigned have
Definition: inflate.h:113
unsigned distbits
Definition: inflate.h:108
unsigned extra
Definition: inflate.h:103
code const FAR * distcode
Definition: inflate.h:106
int last
Definition: inflate.h:82
unsigned long check
Definition: inflate.h:87
Definition: inflate.h:50
Definition: inflate.h:30
Definition: inflate.h:35
Definition: inflate.h:33
gz_header FAR * gz_headerp
Definition: zlib.h:127
Definition: inflate.h:27
#define FAR
unsigned lenbits
Definition: inflate.h:107
unsigned short lens[320]
Definition: inflate.h:115
Definition: inflate.h:42
Definition: inflate.h:40
unsigned ncode
Definition: inflate.h:110
Definition: inflate.h:39
Definition: inflate.h:49
code FAR * next
Definition: inflate.h:114
Definition: inflate.h:53
Definition: inflate.h:29
code codes[ENOUGH]
Definition: inflate.h:117
unsigned long hold
Definition: inflate.h:97
Definition: inflate.h:48
Definition: inflate.h:43
Definition: inflate.h:47
Definition: inflate.h:26
Definition: inflate.h:34
unsigned short work[288]
Definition: inflate.h:116
Definition: inflate.h:32
Definition: inflate.h:24
unsigned write
Definition: inflate.h:94
Definition: inftrees.h:27
unsigned dmax
Definition: inflate.h:86
unsigned bits
Definition: inflate.h:98
Definition: inflate.h:46
Definition: inflate.h:36
inflate_mode
Definition: inflate.h:23
Definition: inflate.h:28
unsigned char FAR * window
Definition: inflate.h:95
inflate_mode mode
Definition: inflate.h:81
Definition: inflate.h:51
Definition: inflate.h:41
unsigned whave
Definition: inflate.h:93
unsigned offset
Definition: inflate.h:101
Definition: inflate.h:44
int flags
Definition: inflate.h:85
code const FAR * lencode
Definition: inflate.h:105
Definition: inflate.h:25
unsigned wbits
Definition: inflate.h:91
int wrap
Definition: inflate.h:83
Definition: inflate.h:52
unsigned length
Definition: inflate.h:100