Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / cachefile.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2016 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Kevin Dietrich.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/blenkernel/intern/cachefile.c
27  *  \ingroup bke
28  */
29
30 #include "DNA_anim_types.h"
31 #include "DNA_cachefile_types.h"
32 #include "DNA_constraint_types.h"
33 #include "DNA_object_types.h"
34 #include "DNA_scene_types.h"
35
36 #include "BLI_fileops.h"
37 #include "BLI_listbase.h"
38 #include "BLI_path_util.h"
39 #include "BLI_string.h"
40 #include "BLI_threads.h"
41 #include "BLI_utildefines.h"
42
43 #include "BKE_animsys.h"
44 #include "BKE_cachefile.h"
45 #include "BKE_global.h"
46 #include "BKE_library.h"
47 #include "BKE_main.h"
48 #include "BKE_modifier.h"
49 #include "BKE_scene.h"
50
51 #ifdef WITH_ALEMBIC
52 #  include "ABC_alembic.h"
53 #endif
54
55 static SpinLock spin;
56
57 void BKE_cachefiles_init(void)
58 {
59         BLI_spin_init(&spin);
60 }
61
62 void BKE_cachefiles_exit(void)
63 {
64         BLI_spin_end(&spin);
65 }
66
67 void *BKE_cachefile_add(Main *bmain, const char *name)
68 {
69         CacheFile *cache_file = BKE_libblock_alloc(bmain, ID_CF, name);
70
71         BKE_cachefile_init(cache_file);
72
73         return cache_file;
74 }
75
76 void BKE_cachefile_init(CacheFile *cache_file)
77 {
78         cache_file->handle = NULL;
79         cache_file->filepath[0] = '\0';
80         cache_file->override_frame = false;
81         cache_file->frame = 0.0f;
82         cache_file->is_sequence = false;
83         cache_file->scale = 1.0f;
84         cache_file->handle_mutex = BLI_mutex_alloc();
85         BLI_listbase_clear(&cache_file->object_paths);
86 }
87
88 /** Free (or release) any data used by this cachefile (does not free the cachefile itself). */
89 void BKE_cachefile_free(CacheFile *cache_file)
90 {
91         BKE_animdata_free((ID *)cache_file, false);
92
93 #ifdef WITH_ALEMBIC
94         ABC_free_handle(cache_file->handle);
95 #endif
96
97         if (cache_file->handle_mutex) {
98                 BLI_mutex_free(cache_file->handle_mutex);
99         }
100         BLI_freelistN(&cache_file->object_paths);
101 }
102
103 CacheFile *BKE_cachefile_copy(Main *bmain, const CacheFile *cache_file)
104 {
105         CacheFile *new_cache_file = BKE_libblock_copy(bmain, &cache_file->id);
106         new_cache_file->handle = NULL;
107
108         BLI_listbase_clear(&new_cache_file->object_paths);
109
110         BKE_id_copy_ensure_local(bmain, &cache_file->id, &new_cache_file->id);
111
112         return new_cache_file;
113 }
114
115 void BKE_cachefile_make_local(Main *bmain, CacheFile *cache_file, const bool lib_local)
116 {
117         BKE_id_make_local_generic(bmain, &cache_file->id, true, lib_local);
118 }
119
120 void BKE_cachefile_reload(const Main *bmain, CacheFile *cache_file)
121 {
122         char filepath[FILE_MAX];
123
124         BLI_strncpy(filepath, cache_file->filepath, sizeof(filepath));
125         BLI_path_abs(filepath, ID_BLEND_PATH(bmain, &cache_file->id));
126
127 #ifdef WITH_ALEMBIC
128         if (cache_file->handle) {
129                 ABC_free_handle(cache_file->handle);
130         }
131
132         cache_file->handle = ABC_create_handle(filepath, &cache_file->object_paths);
133 #endif
134 }
135
136 void BKE_cachefile_ensure_handle(const Main *bmain, CacheFile *cache_file)
137 {
138         BLI_spin_lock(&spin);
139         if (cache_file->handle_mutex == NULL) {
140                 cache_file->handle_mutex = BLI_mutex_alloc();
141         }
142         BLI_spin_unlock(&spin);
143
144         BLI_mutex_lock(cache_file->handle_mutex);
145
146         if (cache_file->handle == NULL) {
147                 BKE_cachefile_reload(bmain, cache_file);
148         }
149
150         BLI_mutex_unlock(cache_file->handle_mutex);
151 }
152
153 void BKE_cachefile_update_frame(Main *bmain, Scene *scene, const float ctime, const float fps)
154 {
155         CacheFile *cache_file;
156         char filename[FILE_MAX];
157
158         for (cache_file = bmain->cachefiles.first; cache_file; cache_file = cache_file->id.next) {
159                 /* Execute drivers only, as animation has already been done. */
160                 BKE_animsys_evaluate_animdata(scene, &cache_file->id, cache_file->adt, ctime, ADT_RECALC_DRIVERS);
161
162                 if (!cache_file->is_sequence) {
163                         continue;
164                 }
165
166                 const float time = BKE_cachefile_time_offset(cache_file, ctime, fps);
167
168                 if (BKE_cachefile_filepath_get(bmain, cache_file, time, filename)) {
169                         BKE_cachefile_clean(bmain, cache_file);
170 #ifdef WITH_ALEMBIC
171                         ABC_free_handle(cache_file->handle);
172                         cache_file->handle = ABC_create_handle(filename, NULL);
173 #endif
174                         break;
175                 }
176         }
177 }
178
179 bool BKE_cachefile_filepath_get(
180         const Main *bmain, const CacheFile *cache_file, float frame,
181         char r_filepath[FILE_MAX])
182 {
183         BLI_strncpy(r_filepath, cache_file->filepath, FILE_MAX);
184         BLI_path_abs(r_filepath, ID_BLEND_PATH(bmain, &cache_file->id));
185
186         int fframe;
187         int frame_len;
188
189         if (cache_file->is_sequence && BLI_path_frame_get(r_filepath, &fframe, &frame_len)) {
190                 char ext[32];
191                 BLI_path_frame_strip(r_filepath, true, ext);
192                 BLI_path_frame(r_filepath, frame, frame_len);
193                 BLI_ensure_extension(r_filepath, FILE_MAX, ext);
194
195                 /* TODO(kevin): store sequence range? */
196                 return BLI_exists(r_filepath);
197         }
198
199         return true;
200 }
201
202 float BKE_cachefile_time_offset(CacheFile *cache_file, const float time, const float fps)
203 {
204         const float frame = (cache_file->override_frame ? cache_file->frame : time);
205         return cache_file->is_sequence ? frame : frame / fps;
206 }
207
208 /* TODO(kevin): replace this with some depsgraph mechanism, or something similar. */
209 void BKE_cachefile_clean(struct Main *bmain, CacheFile *cache_file)
210 {
211         for (Object *ob = bmain->object.first; ob; ob = ob->id.next) {
212                 ModifierData *md = modifiers_findByType(ob, eModifierType_MeshSequenceCache);
213
214                 if (md) {
215                         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *)md;
216
217                         if (cache_file == mcmd->cache_file) {
218 #ifdef WITH_ALEMBIC
219                                 if (mcmd->reader != NULL) {
220                                         CacheReader_free(mcmd->reader);
221                                 }
222 #endif
223                                 mcmd->reader = NULL;
224                         }
225                 }
226
227                 for (bConstraint *con = ob->constraints.first; con; con = con->next) {
228                         if (con->type != CONSTRAINT_TYPE_TRANSFORM_CACHE) {
229                                 continue;
230                         }
231
232                         bTransformCacheConstraint *data = con->data;
233
234                         if (cache_file == data->cache_file) {
235 #ifdef WITH_ALEMBIC
236                                 if (data->reader != NULL) {
237                                         CacheReader_free(data->reader);
238                                 }
239 #endif
240                                 data->reader = NULL;
241                         }
242                 }
243         }
244 }