Speedup of filereading: when using large libraries (referenced data from
[blender.git] / source / blender / blenloader / intern / readfile.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  * blenloader readfile private function prototypes
32  */
33 #ifndef READFILE_H
34 #define READFILE_H
35
36 #include "zlib.h"
37
38 struct OldNewMap;
39 struct MemFile;
40 struct bheadsort;
41
42 typedef struct FileData {
43         // linked list of BHeadN's
44         ListBase listbase;
45         int flags;
46         int eof;
47         int buffersize;
48         int seek;
49         int (*read)(struct FileData *filedata, void *buffer, int size);
50
51         // variables needed for reading from memory / stream
52         char *buffer;
53         // variables needed for reading from memfile (undo)
54         struct MemFile *memfile;
55
56         // variables needed for reading from file
57         int filedes;
58         gzFile gzfiledes;
59
60         // now only in use for library appending
61         char filename[FILE_MAXDIR+FILE_MAXFILE];
62         
63         // variables needed for reading from stream
64         char headerdone;
65         int inbuffer;
66         
67         // general reading variables
68         struct SDNA *filesdna;
69         struct SDNA *memsdna;
70         char *compflags;
71         
72         int fileversion;
73         int id_name_offs;               /* used to retrieve ID names from (bhead+1) */
74         
75         struct OldNewMap *datamap;
76         struct OldNewMap *globmap;
77         struct OldNewMap *libmap;
78         struct OldNewMap *imamap;
79         
80         struct bheadsort *bheadmap;
81         int tot_bheadmap;
82         
83         ListBase mainlist;
84         
85                 /* ick ick, used to return
86                  * data through streamglue.
87                  */
88         BlendFileData **bfd_r;
89         BlendReadError *error_r;
90 } FileData;
91
92 typedef struct BHeadN {
93         struct BHeadN *next, *prev;
94         struct BHead bhead;
95 } BHeadN;
96
97
98 #define FD_FLAGS_SWITCH_ENDIAN             (1<<0)
99 #define FD_FLAGS_FILE_POINTSIZE_IS_4       (1<<1)
100 #define FD_FLAGS_POINTSIZE_DIFFERS         (1<<2)
101 #define FD_FLAGS_FILE_OK                   (1<<3)
102 #define FD_FLAGS_NOT_MY_BUFFER                     (1<<4)
103 #define FD_FLAGS_NOT_MY_LIBMAP                     (1<<5)
104
105 #define SIZEOFBLENDERHEADER 12
106
107         /***/
108 struct Main;
109 void blo_join_main(ListBase *mainlist);
110 void blo_split_main(ListBase *mainlist, struct Main *main);
111
112 BlendFileData *blo_read_file_internal( FileData *fd,  BlendReadError *error_r);
113
114 FileData *blo_openblenderfile( char *name, BlendReadError *error_r);
115 FileData *blo_openblendermemory( void *buffer, int buffersize, BlendReadError *error_r);
116 FileData *blo_openblendermemfile(struct MemFile *memfile, BlendReadError *error_r);
117
118 void blo_make_image_pointer_map(FileData *fd);
119 void blo_end_image_pointer_map(FileData *fd);
120 void blo_add_library_pointer_map(ListBase *mainlist, FileData *fd);
121
122 void blo_freefiledata( FileData *fd);
123
124 BHead *blo_firstbhead(FileData *fd);
125 BHead *blo_nextbhead(FileData *fd, BHead *thisblock);
126 BHead *blo_prevbhead(FileData *fd, BHead *thisblock);
127
128 char *bhead_id_name(FileData *fd, BHead *bhead);
129
130 #endif
131