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, 0);
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 /**
104  * Only copy internal data of CacheFile ID from source to already allocated/initialized destination.
105  * You probably nerver want to use that directly, use id_copy or BKE_id_copy_ex for typical needs.
106  *
107  * WARNING! This function will not handle ID user count!
108  *
109  * \param flag  Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
110  */
111 void BKE_cachefile_copy_data(
112         Main *UNUSED(bmain), CacheFile *cache_file_dst, const CacheFile *UNUSED(cache_file_src), const int UNUSED(flag))
113 {
114         cache_file_dst->handle = NULL;
115         BLI_listbase_clear(&cache_file_dst->object_paths);
116 }
117
118 CacheFile *BKE_cachefile_copy(Main *bmain, const CacheFile *cache_file)
119 {
120         CacheFile *cache_file_copy;
121         BKE_id_copy_ex(bmain, &cache_file->id, (ID **)&cache_file_copy, 0, false);
122         return cache_file_copy;
123 }
124
125 void BKE_cachefile_make_local(Main *bmain, CacheFile *cache_file, const bool lib_local)
126 {
127         BKE_id_make_local_generic(bmain, &cache_file->id, true, lib_local);
128 }
129
130 void BKE_cachefile_reload(const Main *bmain, CacheFile *cache_file)
131 {
132         char filepath[FILE_MAX];
133
134         BLI_strncpy(filepath, cache_file->filepath, sizeof(filepath));
135         BLI_path_abs(filepath, ID_BLEND_PATH(bmain, &cache_file->id));
136
137 #ifdef WITH_ALEMBIC
138         if (cache_file->handle) {
139                 ABC_free_handle(cache_file->handle);
140         }
141
142         cache_file->handle = ABC_create_handle(filepath, &cache_file->object_paths);
143 #endif
144 }
145
146 void BKE_cachefile_ensure_handle(const Main *bmain, CacheFile *cache_file)
147 {
148         BLI_spin_lock(&spin);
149         if (cache_file->handle_mutex == NULL) {
150                 cache_file->handle_mutex = BLI_mutex_alloc();
151         }
152         BLI_spin_unlock(&spin);
153
154         BLI_mutex_lock(cache_file->handle_mutex);
155
156         if (cache_file->handle == NULL) {
157                 BKE_cachefile_reload(bmain, cache_file);
158         }
159
160         BLI_mutex_unlock(cache_file->handle_mutex);
161 }
162
163 void BKE_cachefile_update_frame(Main *bmain, Scene *scene, const float ctime, const float fps)
164 {
165         CacheFile *cache_file;
166         char filename[FILE_MAX];
167
168         for (cache_file = bmain->cachefiles.first; cache_file; cache_file = cache_file->id.next) {
169                 /* Execute drivers only, as animation has already been done. */
170                 BKE_animsys_evaluate_animdata(scene, &cache_file->id, cache_file->adt, ctime, ADT_RECALC_DRIVERS);
171
172                 if (!cache_file->is_sequence) {
173                         continue;
174                 }
175
176                 const float time = BKE_cachefile_time_offset(cache_file, ctime, fps);
177
178                 if (BKE_cachefile_filepath_get(bmain, cache_file, time, filename)) {
179                         BKE_cachefile_clean(bmain, cache_file);
180 #ifdef WITH_ALEMBIC
181                         ABC_free_handle(cache_file->handle);
182                         cache_file->handle = ABC_create_handle(filename, NULL);
183 #endif
184                 }
185         }
186 }
187
188 bool BKE_cachefile_filepath_get(
189         const Main *bmain, const CacheFile *cache_file, float frame,
190         char r_filepath[FILE_MAX])
191 {
192         BLI_strncpy(r_filepath, cache_file->filepath, FILE_MAX);
193         BLI_path_abs(r_filepath, ID_BLEND_PATH(bmain, &cache_file->id));
194
195         int fframe;
196         int frame_len;
197
198         if (cache_file->is_sequence && BLI_path_frame_get(r_filepath, &fframe, &frame_len)) {
199                 char ext[32];
200                 BLI_path_frame_strip(r_filepath, true, ext);
201                 BLI_path_frame(r_filepath, frame, frame_len);
202                 BLI_ensure_extension(r_filepath, FILE_MAX, ext);
203
204                 /* TODO(kevin): store sequence range? */
205                 return BLI_exists(r_filepath);
206         }
207
208         return true;
209 }
210
211 float BKE_cachefile_time_offset(CacheFile *cache_file, const float time, const float fps)
212 {
213         const float time_offset = cache_file->frame_offset / fps;
214         const float frame = (cache_file->override_frame ? cache_file->frame : time);
215         return cache_file->is_sequence ? frame : frame / fps - time_offset;
216 }
217
218 /* TODO(kevin): replace this with some depsgraph mechanism, or something similar. */
219 void BKE_cachefile_clean(struct Main *bmain, CacheFile *cache_file)
220 {
221         for (Object *ob = bmain->object.first; ob; ob = ob->id.next) {
222                 ModifierData *md = modifiers_findByType(ob, eModifierType_MeshSequenceCache);
223
224                 if (md) {
225                         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *)md;
226
227                         if (cache_file == mcmd->cache_file) {
228 #ifdef WITH_ALEMBIC
229                                 if (mcmd->reader != NULL) {
230                                         CacheReader_free(mcmd->reader);
231                                 }
232 #endif
233                                 mcmd->reader = NULL;
234                         }
235                 }
236
237                 for (bConstraint *con = ob->constraints.first; con; con = con->next) {
238                         if (con->type != CONSTRAINT_TYPE_TRANSFORM_CACHE) {
239                                 continue;
240                         }
241
242                         bTransformCacheConstraint *data = con->data;
243
244                         if (cache_file == data->cache_file) {
245 #ifdef WITH_ALEMBIC
246                                 if (data->reader != NULL) {
247                                         CacheReader_free(data->reader);
248                                 }
249 #endif
250                                 data->reader = NULL;
251                         }
252                 }
253         }
254 }