New compression/decompression API
[wimlib] / include / wimlib / wim.h
1 #ifndef _WIMLIB_WIM_H
2 #define _WIMLIB_WIM_H
3
4 #include "wimlib/header.h"
5 #include "wimlib/types.h"
6 #include "wimlib/file_io.h"
7 #include "wimlib/list.h"
8
9 struct wim_info;
10 struct wim_lookup_table;
11 struct wim_image_metadata;
12
13 /* The opaque structure exposed to the wimlib API. */
14 struct WIMStruct {
15
16         /* File descriptor for the WIM file, opened for reading.  in_fd.fd is -1
17          * if the WIM file has not been opened or there is no associated file
18          * backing it yet. */
19         struct filedes in_fd;
20
21         /* File descriptor, opened either for writing only or for
22          * reading+writing, for the WIM file (if any) currently being written.
23          * */
24         struct filedes out_fd;
25
26         /* The name of the WIM file (if any) that has been opened. */
27         tchar *filename;
28
29         /* The lookup table for the WIM file. */
30         struct wim_lookup_table *lookup_table;
31
32         /* Information retrieved from the XML data, arranged in an orderly
33          * manner. */
34         struct wim_info *wim_info;
35
36         /* Array of the image metadata, one for each image in the WIM. */
37         struct wim_image_metadata **image_metadata;
38
39         /* The header of the WIM file. */
40         struct wim_header hdr;
41
42         /* Temporary field */
43         void *private;
44
45         struct wimlib_decompressor *decompressor;
46         enum wimlib_compression_type decompressor_ctype;
47         u32 decompressor_max_block_size;
48
49         struct list_head subwims;
50
51         struct list_head subwim_node;
52
53         /* The currently selected image, indexed starting at 1.  If not 0,
54          * subtract 1 from this to get the index of the current image in the
55          * image_metadata array. */
56         int current_image;
57
58         /* Have any images been deleted? */
59         u8 deletion_occurred : 1;
60
61         /* Do we know that all the stream reference counts in the WIM are
62          * correct?  If so, this is set to 1 and deletions are safe; otherwise
63          * this is set to 0 and deletions are not safe until reference counts
64          * are recalculated.  (This is due to a bug in M$'s software that
65          * generates WIMs with invalid reference counts.)  */
66         u8 refcnts_ok : 1;
67
68         u8 wim_locked : 1;
69
70         u8 guid_set_explicitly : 1;
71
72         /* One of WIMLIB_COMPRESSION_TYPE_*, cached from the header flags. */
73         u8 compression_type : 2;
74
75         /* Overwritten compression type for wimlib_overwrite() or
76          * wimlib_write().  Can be changed by
77          * wimlib_set_output_compression_type(); otherwise is the same as
78          * compression_type.  */
79         u8 out_compression_type : 2;
80
81         /* Uncompressed size of compressed chunks in this WIM (cached from
82          * header).  */
83         u32 chunk_size;
84
85         /* Overridden chunk size for wimlib_overwrite() or wimlib_write().  Can
86          * be changed by wimlib_set_output_chunk_size(); otherwise is the same
87          * as chunk_size.  */
88         u32 out_chunk_size;
89 };
90
91 static inline bool wim_is_pipable(const WIMStruct *wim)
92 {
93         return (wim->hdr.magic == PWM_MAGIC);
94 }
95
96 static inline bool wim_has_integrity_table(const WIMStruct *wim)
97 {
98         return (wim->hdr.integrity_table_reshdr.offset_in_wim != 0);
99 }
100
101 static inline bool wim_has_metadata(const WIMStruct *wim)
102 {
103         return (wim->image_metadata != NULL || wim->hdr.image_count == 0);
104 }
105
106 extern int
107 wim_recalculate_refcnts(WIMStruct *wim);
108
109 extern int
110 set_wim_hdr_cflags(int ctype, struct wim_header *hdr);
111
112 extern int
113 init_wim_header(struct wim_header *hdr, int ctype, u32 chunk_size);
114
115 extern int
116 read_wim_header(WIMStruct *wim, struct wim_header *hdr);
117
118 extern int
119 write_wim_header(const struct wim_header *hdr, struct filedes *out_fd);
120
121 extern int
122 write_wim_header_at_offset(const struct wim_header *hdr, struct filedes *out_fd,
123                            off_t offset);
124
125 extern int
126 write_wim_header_flags(u32 hdr_flags, struct filedes *out_fd);
127
128 extern int
129 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to);
130
131 extern int
132 select_wim_image(WIMStruct *wim, int image);
133
134 extern int
135 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *));
136
137 extern int
138 wim_checksum_unhashed_streams(WIMStruct *wim);
139
140 extern int
141 reopen_wim(WIMStruct *wim);
142
143 /* Internal open flags (pass to open_wim_as_WIMStruct(), not wimlib_open_wim())
144  */
145 #define WIMLIB_OPEN_FLAG_FROM_PIPE      0x80000000
146 #define WIMLIB_OPEN_MASK_PUBLIC         0x7fffffff
147
148 extern int
149 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
150                       WIMStruct **wim_ret,
151                       wimlib_progress_func_t progress_func);
152
153 extern int
154 close_wim(WIMStruct *wim);
155
156 extern int
157 can_modify_wim(WIMStruct *wim);
158
159 extern int
160 can_delete_from_wim(WIMStruct *wim);
161
162 #endif /* _WIMLIB_WIM_H */