Patch #34204: [Render Animation] Fails with "Error: Specified sample_fmt is not suppo...
[blender.git] / source / blender / blenkernel / intern / screen.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/screen.c
29  *  \ingroup bke
30  */
31
32 #ifdef WIN32
33 #  include "BLI_winstuff.h"
34 #endif
35
36 #include <string.h>
37 #include <stdio.h>
38 #include <math.h>
39
40 #include "MEM_guardedalloc.h"
41
42 #include "DNA_scene_types.h"
43 #include "DNA_screen_types.h"
44 #include "DNA_space_types.h"
45 #include "DNA_view3d_types.h"
46
47 #include "BLI_listbase.h"
48 #include "BLI_utildefines.h"
49
50 #include "BKE_screen.h"
51
52 /* ************ Spacetype/regiontype handling ************** */
53
54 /* keep global; this has to be accessible outside of windowmanager */
55 static ListBase spacetypes = {NULL, NULL};
56
57 /* not SpaceType itself */
58 static void spacetype_free(SpaceType *st)
59 {
60         ARegionType *art;
61         PanelType *pt;
62         HeaderType *ht;
63         
64         for (art = st->regiontypes.first; art; art = art->next) {
65                 BLI_freelistN(&art->drawcalls);
66
67                 for (pt = art->paneltypes.first; pt; pt = pt->next)
68                         if (pt->ext.free)
69                                 pt->ext.free(pt->ext.data);
70
71                 for (ht = art->headertypes.first; ht; ht = ht->next)
72                         if (ht->ext.free)
73                                 ht->ext.free(ht->ext.data);
74
75                 BLI_freelistN(&art->paneltypes);
76                 BLI_freelistN(&art->headertypes);
77         }
78         
79         BLI_freelistN(&st->regiontypes);
80         BLI_freelistN(&st->toolshelf);
81
82 }
83
84 void BKE_spacetypes_free(void)
85 {
86         SpaceType *st;
87         
88         for (st = spacetypes.first; st; st = st->next) {
89                 spacetype_free(st);
90         }
91         
92         BLI_freelistN(&spacetypes);
93 }
94
95 SpaceType *BKE_spacetype_from_id(int spaceid)
96 {
97         SpaceType *st;
98         
99         for (st = spacetypes.first; st; st = st->next) {
100                 if (st->spaceid == spaceid)
101                         return st;
102         }
103         return NULL;
104 }
105
106 ARegionType *BKE_regiontype_from_id(SpaceType *st, int regionid)
107 {
108         ARegionType *art;
109         
110         for (art = st->regiontypes.first; art; art = art->next)
111                 if (art->regionid == regionid)
112                         return art;
113         
114         printf("Error, region type missing in - name:\"%s\", id:%d\n", st->name, st->spaceid);
115         return st->regiontypes.first;
116 }
117
118
119 const ListBase *BKE_spacetypes_list(void)
120 {
121         return &spacetypes;
122 }
123
124 void BKE_spacetype_register(SpaceType *st)
125 {
126         SpaceType *stype;
127         
128         /* sanity check */
129         stype = BKE_spacetype_from_id(st->spaceid);
130         if (stype) {
131                 printf("error: redefinition of spacetype %s\n", stype->name);
132                 spacetype_free(stype);
133                 MEM_freeN(stype);
134         }
135         
136         BLI_addtail(&spacetypes, st);
137 }
138
139 /* ***************** Space handling ********************** */
140
141 void BKE_spacedata_freelist(ListBase *lb)
142 {
143         SpaceLink *sl;
144         ARegion *ar;
145         
146         for (sl = lb->first; sl; sl = sl->next) {
147                 SpaceType *st = BKE_spacetype_from_id(sl->spacetype);
148                 
149                 /* free regions for pushed spaces */
150                 for (ar = sl->regionbase.first; ar; ar = ar->next)
151                         BKE_area_region_free(st, ar);
152
153                 BLI_freelistN(&sl->regionbase);
154                 
155                 if (st && st->free) 
156                         st->free(sl);
157         }
158         
159         BLI_freelistN(lb);
160 }
161
162 ARegion *BKE_area_region_copy(SpaceType *st, ARegion *ar)
163 {
164         ARegion *newar = MEM_dupallocN(ar);
165         Panel *pa, *newpa, *patab;
166         
167         newar->prev = newar->next = NULL;
168         newar->handlers.first = newar->handlers.last = NULL;
169         newar->uiblocks.first = newar->uiblocks.last = NULL;
170         newar->ui_lists.first = newar->ui_lists.last = NULL;
171         newar->swinid = 0;
172         
173         /* use optional regiondata callback */
174         if (ar->regiondata) {
175                 ARegionType *art = BKE_regiontype_from_id(st, ar->regiontype);
176
177                 if (art && art->duplicate)
178                         newar->regiondata = art->duplicate(ar->regiondata);
179                 else
180                         newar->regiondata = MEM_dupallocN(ar->regiondata);
181         }
182
183         if (ar->v2d.tab_offset)
184                 newar->v2d.tab_offset = MEM_dupallocN(ar->v2d.tab_offset);
185         
186         newar->panels.first = newar->panels.last = NULL;
187         BLI_duplicatelist(&newar->panels, &ar->panels);
188         
189         /* copy panel pointers */
190         for (newpa = newar->panels.first; newpa; newpa = newpa->next) {
191                 patab = newar->panels.first;
192                 pa = ar->panels.first;
193                 while (patab) {
194                         if (newpa->paneltab == pa) {
195                                 newpa->paneltab = patab;
196                                 break;
197                         }
198                         patab = patab->next;
199                         pa = pa->next;
200                 }
201         }
202         
203         return newar;
204 }
205
206
207 /* from lb2 to lb1, lb1 is supposed to be freed */
208 static void region_copylist(SpaceType *st, ListBase *lb1, ListBase *lb2)
209 {
210         ARegion *ar;
211         
212         /* to be sure */
213         lb1->first = lb1->last = NULL;
214         
215         for (ar = lb2->first; ar; ar = ar->next) {
216                 ARegion *arnew = BKE_area_region_copy(st, ar);
217                 BLI_addtail(lb1, arnew);
218         }
219 }
220
221
222 /* lb1 should be empty */
223 void BKE_spacedata_copylist(ListBase *lb1, ListBase *lb2)
224 {
225         SpaceLink *sl;
226         
227         lb1->first = lb1->last = NULL;    /* to be sure */
228         
229         for (sl = lb2->first; sl; sl = sl->next) {
230                 SpaceType *st = BKE_spacetype_from_id(sl->spacetype);
231                 
232                 if (st && st->duplicate) {
233                         SpaceLink *slnew = st->duplicate(sl);
234                         
235                         BLI_addtail(lb1, slnew);
236                         
237                         region_copylist(st, &slnew->regionbase, &sl->regionbase);
238                 }
239         }
240 }
241
242 /* facility to set locks for drawing to survive (render) threads accessing drawing data */
243 /* lock can become bitflag too */
244 /* should be replaced in future by better local data handling for threads */
245 void BKE_spacedata_draw_locks(int set)
246 {
247         SpaceType *st;
248         
249         for (st = spacetypes.first; st; st = st->next) {
250                 ARegionType *art;
251         
252                 for (art = st->regiontypes.first; art; art = art->next) {
253                         if (set) 
254                                 art->do_lock = art->lock;
255                         else 
256                                 art->do_lock = FALSE;
257                 }
258         }
259 }
260
261
262 /* not region itself */
263 void BKE_area_region_free(SpaceType *st, ARegion *ar)
264 {
265         if (st) {
266                 ARegionType *art = BKE_regiontype_from_id(st, ar->regiontype);
267                 
268                 if (art && art->free)
269                         art->free(ar);
270                 
271                 if (ar->regiondata)
272                         printf("regiondata free error\n");
273         }
274         else if (ar->type && ar->type->free)
275                 ar->type->free(ar);
276         
277         if (ar->v2d.tab_offset) {
278                 MEM_freeN(ar->v2d.tab_offset);
279                 ar->v2d.tab_offset = NULL;
280         }
281
282         BLI_freelistN(&ar->panels);
283         BLI_freelistN(&ar->ui_lists);
284 }
285
286 /* not area itself */
287 void BKE_screen_area_free(ScrArea *sa)
288 {
289         SpaceType *st = BKE_spacetype_from_id(sa->spacetype);
290         ARegion *ar;
291         
292         for (ar = sa->regionbase.first; ar; ar = ar->next)
293                 BKE_area_region_free(st, ar);
294
295         BLI_freelistN(&sa->regionbase);
296         
297         BKE_spacedata_freelist(&sa->spacedata);
298         
299         BLI_freelistN(&sa->actionzones);
300 }
301
302 /* don't free screen itself */
303 void BKE_screen_free(bScreen *sc)
304 {
305         ScrArea *sa, *san;
306         ARegion *ar;
307         
308         for (ar = sc->regionbase.first; ar; ar = ar->next)
309                 BKE_area_region_free(NULL, ar);
310
311         BLI_freelistN(&sc->regionbase);
312         
313         for (sa = sc->areabase.first; sa; sa = san) {
314                 san = sa->next;
315                 BKE_screen_area_free(sa);
316         }
317         
318         BLI_freelistN(&sc->vertbase);
319         BLI_freelistN(&sc->edgebase);
320         BLI_freelistN(&sc->areabase);
321 }
322
323 /* for depsgraph */
324 unsigned int BKE_screen_visible_layers(bScreen *screen, Scene *scene)
325 {
326         ScrArea *sa;
327         unsigned int layer = 0;
328
329         if (screen) {
330                 /* get all used view3d layers */
331                 for (sa = screen->areabase.first; sa; sa = sa->next)
332                         if (sa->spacetype == SPACE_VIEW3D)
333                                 layer |= ((View3D *)sa->spacedata.first)->lay;
334         }
335
336         if (!layer)
337                 return scene->lay;
338
339         return layer;
340 }
341
342 /* ***************** Utilities ********************** */
343
344 /* Find a region of the specified type from the given area */
345 ARegion *BKE_area_find_region_type(ScrArea *sa, int type)
346 {
347         if (sa) {
348                 ARegion *ar;
349                 
350                 for (ar = sa->regionbase.first; ar; ar = ar->next) {
351                         if (ar->regiontype == type)
352                                 return ar;
353                 }
354         }
355         return NULL;
356 }
357
358 ARegion *BKE_area_find_region_active_win(ScrArea *sa)
359 {
360         if (sa) {
361                 ARegion *ar = BLI_findlink(&sa->regionbase, sa->region_active_win);
362                 if (ar && (ar->regiontype == RGN_TYPE_WINDOW)) {
363                         return ar;
364                 }
365
366                 /* fallback to any */
367                 return BKE_area_find_region_type(sa, RGN_TYPE_WINDOW);
368         }
369         return NULL;
370 }
371
372 /* note, using this function is generally a last resort, you really want to be
373  * using the context when you can - campbell
374  * -1 for any type */
375 ScrArea *BKE_screen_find_big_area(bScreen *sc, const int spacetype, const short min)
376 {
377         ScrArea *sa, *big = NULL;
378         int size, maxsize = 0;
379
380         for (sa = sc->areabase.first; sa; sa = sa->next) {
381                 if ((spacetype == -1) || sa->spacetype == spacetype) {
382                         if (min <= sa->winx && min <= sa->winy) {
383                                 size = sa->winx * sa->winy;
384                                 if (size > maxsize) {
385                                         maxsize = size;
386                                         big = sa;
387                                 }
388                         }
389                 }
390         }
391
392         return big;
393 }
394
395 void BKE_screen_view3d_sync(struct View3D *v3d, struct Scene *scene)
396 {
397         int bit;
398
399         if (v3d->scenelock && v3d->localvd == NULL) {
400                 v3d->lay = scene->lay;
401                 v3d->camera = scene->camera;
402
403                 if (v3d->camera == NULL) {
404                         ARegion *ar;
405
406                         for (ar = v3d->regionbase.first; ar; ar = ar->next) {
407                                 if (ar->regiontype == RGN_TYPE_WINDOW) {
408                                         RegionView3D *rv3d = ar->regiondata;
409                                         if (rv3d->persp == RV3D_CAMOB)
410                                                 rv3d->persp = RV3D_PERSP;
411                                 }
412                         }
413                 }
414
415                 if ((v3d->lay & v3d->layact) == 0) {
416                         for (bit = 0; bit < 32; bit++) {
417                                 if (v3d->lay & (1 << bit)) {
418                                         v3d->layact = 1 << bit;
419                                         break;
420                                 }
421                         }
422                 }
423         }
424 }
425
426 void BKE_screen_view3d_scene_sync(bScreen *sc)
427 {
428         /* are there cameras in the views that are not in the scene? */
429         ScrArea *sa;
430         for (sa = sc->areabase.first; sa; sa = sa->next) {
431                 SpaceLink *sl;
432                 for (sl = sa->spacedata.first; sl; sl = sl->next) {
433                         if (sl->spacetype == SPACE_VIEW3D) {
434                                 View3D *v3d = (View3D *) sl;
435                                 BKE_screen_view3d_sync(v3d, sc->scene);
436                         }
437                 }
438         }
439 }
440
441 void BKE_screen_view3d_main_sync(ListBase *screen_lb, Scene *scene)
442 {
443         bScreen *sc;
444         ScrArea *sa;
445         SpaceLink *sl;
446
447         /* from scene copy to the other views */
448         for (sc = screen_lb->first; sc; sc = sc->id.next) {
449                 if (sc->scene != scene)
450                         continue;
451
452                 for (sa = sc->areabase.first; sa; sa = sa->next)
453                         for (sl = sa->spacedata.first; sl; sl = sl->next)
454                                 if (sl->spacetype == SPACE_VIEW3D)
455                                         BKE_screen_view3d_sync((View3D *)sl, scene);
456         }
457 }
458
459 /* magic zoom calculation, no idea what
460  * it signifies, if you find out, tell me! -zr
461  */
462
463 /* simple, its magic dude!
464  * well, to be honest, this gives a natural feeling zooming
465  * with multiple keypad presses (ton)
466  */
467 float BKE_screen_view3d_zoom_to_fac(float camzoom)
468 {
469         return powf(((float)M_SQRT2 + camzoom / 50.0f), 2.0f) / 4.0f;
470 }
471
472 float BKE_screen_view3d_zoom_from_fac(float zoomfac)
473 {
474         return ((sqrtf(4.0f * zoomfac) - (float)M_SQRT2) * 50.0f);
475 }