Camera tracking integration
[blender.git] / source / blender / blenloader / intern / readfile.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL 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.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * blenloader readfile private function prototypes
29  */
30
31 /** \file blender/blenloader/intern/readfile.h
32  *  \ingroup blenloader
33  */
34
35 #ifndef READFILE_H
36 #define READFILE_H
37
38 #include "zlib.h"
39
40 struct OldNewMap;
41 struct MemFile;
42 struct bheadsort;
43 struct ReportList;
44
45 typedef struct FileData {
46         // linked list of BHeadN's
47         ListBase listbase;
48         int flags;
49         int eof;
50         int buffersize;
51         int seek;
52         int (*read)(struct FileData *filedata, void *buffer, unsigned int size);
53
54         // variables needed for reading from memory / stream
55         char *buffer;
56         // variables needed for reading from memfile (undo)
57         struct MemFile *memfile;
58
59         // variables needed for reading from file
60         int filedes;
61         gzFile gzfiledes;
62
63         // now only in use for library appending
64         char relabase[FILE_MAXDIR+FILE_MAXFILE];
65         
66         // variables needed for reading from stream
67         char headerdone;
68         int inbuffer;
69         
70         // general reading variables
71         struct SDNA *filesdna;
72         struct SDNA *memsdna;
73         char *compflags;
74         
75         int fileversion;
76         int id_name_offs;               /* used to retrieve ID names from (bhead+1) */
77         int globalf, fileflags; /* for do_versions patching */
78         
79         struct OldNewMap *datamap;
80         struct OldNewMap *globmap;
81         struct OldNewMap *libmap;
82         struct OldNewMap *imamap;
83         struct OldNewMap *movieclipmap;
84         
85         struct bheadsort *bheadmap;
86         int tot_bheadmap;
87         
88         ListBase mainlist;
89         
90                 /* ick ick, used to return
91                  * data through streamglue.
92                  */
93         BlendFileData **bfd_r;
94         struct ReportList *reports;
95 } FileData;
96
97 typedef struct BHeadN {
98         struct BHeadN *next, *prev;
99         struct BHead bhead;
100 } BHeadN;
101
102
103 #define FD_FLAGS_SWITCH_ENDIAN             (1<<0)
104 #define FD_FLAGS_FILE_POINTSIZE_IS_4       (1<<1)
105 #define FD_FLAGS_POINTSIZE_DIFFERS         (1<<2)
106 #define FD_FLAGS_FILE_OK                   (1<<3)
107 #define FD_FLAGS_NOT_MY_BUFFER                     (1<<4)
108 #define FD_FLAGS_NOT_MY_LIBMAP                     (1<<5)
109
110 #define SIZEOFBLENDERHEADER 12
111
112         /***/
113 struct Main;
114 void blo_join_main(ListBase *mainlist);
115 void blo_split_main(ListBase *mainlist, struct Main *main);
116
117 BlendFileData *blo_read_file_internal(FileData *fd, const char *filepath);
118
119 FileData *blo_openblenderfile(const char *filepath, struct ReportList *reports);
120 FileData *blo_openblendermemory(void *buffer, int buffersize, struct ReportList *reports);
121 FileData *blo_openblendermemfile(struct MemFile *memfile, struct ReportList *reports);
122
123 void blo_clear_proxy_pointers_from_lib(Main *oldmain);
124 void blo_make_image_pointer_map(FileData *fd, Main *oldmain);
125 void blo_end_image_pointer_map(FileData *fd, Main *oldmain);
126 void blo_make_movieclip_pointer_map(FileData *fd, Main *oldmain);
127 void blo_end_movieclip_pointer_map(FileData *fd, Main *oldmain);
128 void blo_add_library_pointer_map(ListBase *mainlist, FileData *fd);
129
130 void blo_freefiledata( FileData *fd);
131
132 BHead *blo_firstbhead(FileData *fd);
133 BHead *blo_nextbhead(FileData *fd, BHead *thisblock);
134 BHead *blo_prevbhead(FileData *fd, BHead *thisblock);
135
136 char *bhead_id_name(FileData *fd, BHead *bhead);
137
138 #endif
139