New: rendering in background mode (blender -b) now prints a percentage to
[blender.git] / source / blender / render / intern / source / RE_callbacks.c
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  * Callbacks to make the renderer interact with calling modules.
32  */
33
34 #include <stdlib.h> /* for NULL??? */
35 #include <stdio.h>
36 #include "render.h"
37 #include "render_intern.h"
38 #include "RE_callbacks.h"
39
40 #ifdef HAVE_CONFIG_H
41 #include <config.h>
42 #endif
43
44 /*
45  * The callbacks are done in three parts:
46  *
47  * - a local static pointer to the eventual function. NULL if not
48  * defined, or if the behaviour is not required.
49  *
50  * - a hook that can be called locally
51  *
52  * - a hook that can be called externally, to set an external function
53  * to provide said functionality.
54  *
55  * These might be generated from a spec such as:
56  * 
57  * callback {
58  *    local    = <local name>
59  *    external = <external name>
60  *    type     = <ret_type> (<args>,...)
61  * }
62  *
63  * Should generate:
64  * - a static var
65  * - an internal loop, plus decl.
66  * - an external setter, plus decl.
67  * 
68  */
69
70 /* Part 1: ------------------------------------------------------------- */
71
72 static int (*RE_local_test_break_function)(void) = NULL;
73
74 static void (*RE_local_timecursor_function)(int) = NULL;
75
76 static void (*RE_local_renderdisplay_function)(int i, 
77                                                                                            int j, 
78                                                                                            int k, 
79                                                                                            int l, 
80                                                                                            unsigned int *m) 
81          = NULL;
82
83 static void (*RE_local_initrenderdisplay_function)(void) = NULL;
84 static void (*RE_local_clearrenderdisplay_function)(short) = NULL;
85
86 static void (*RE_local_printrenderinfo_function)(double,int) = NULL;
87
88 static void (*RE_local_getrenderdata_function)(void) = NULL;
89 static void (*RE_local_freerenderdata_function)(void) = NULL;
90
91 /* Part 2: ------------------------------------------------------------- */
92
93 int RE_local_test_break(void) {
94         if (RE_local_test_break_function) {
95                 return RE_local_test_break_function();
96         } else {
97                 /* transparant behaviour: proceed */
98                 return 0;
99         }
100 }
101
102 void RE_local_timecursor(int i) {
103         if (RE_local_timecursor_function) RE_local_timecursor_function(i);
104 }
105
106 void RE_local_render_display(int i, int j, int k, int l, unsigned int* m) {
107         if (RE_local_renderdisplay_function) RE_local_renderdisplay_function(i, j, k, l, m);
108         else {
109                 if(j-i >= l-1) printf("\n");// full picture
110                 else printf("\rRender %d%% ", (100*i)/l); 
111                 fflush(stdout);
112         }
113 }
114 void RE_local_init_render_display(void) {
115         if (RE_local_initrenderdisplay_function) RE_local_initrenderdisplay_function();
116 }
117 void RE_local_clear_render_display(short i) {
118         if (RE_local_clearrenderdisplay_function) RE_local_clearrenderdisplay_function(i);
119 }
120
121 void RE_local_printrenderinfo(double time, int i) {
122         if (RE_local_printrenderinfo_function) RE_local_printrenderinfo_function(time, i);
123 }
124
125 void RE_local_get_renderdata(void) {
126         if (RE_local_getrenderdata_function) RE_local_getrenderdata_function();
127 }
128 void RE_local_free_renderdata(void) {
129         if (RE_local_freerenderdata_function) RE_local_freerenderdata_function();
130 }
131
132 /* Part 3: ------------------------------------------------------------- */
133
134 void RE_set_test_break_callback(int (*f)(void)) {
135         RE_local_test_break_function = f;
136 }
137
138 void RE_set_timecursor_callback(void (*f)(int)) {
139         RE_local_timecursor_function = f;
140 }
141
142 void RE_set_renderdisplay_callback(void (*f)(int i, 
143                                                                                          int j, 
144                                                                                          int k, 
145                                                                                          int l, 
146                                                                                          unsigned int *)) 
147 {
148         RE_local_renderdisplay_function = f;
149 }
150
151 void RE_set_initrenderdisplay_callback(void (*f)(void)) {
152         RE_local_initrenderdisplay_function = f;
153 }
154
155 void RE_set_clearrenderdisplay_callback(void (*f)(short)) {
156         RE_local_clearrenderdisplay_function = f;
157 }
158
159 void RE_set_printrenderinfo_callback(void (*f)(double,int)) {
160         RE_local_printrenderinfo_function = f;
161 }
162
163 void RE_set_getrenderdata_callback(void (*f)(void)) {
164         RE_local_getrenderdata_function = f;
165 }
166
167 void RE_set_freerenderdata_callback(void (*f)(void)) {
168         RE_local_freerenderdata_function = f;
169 }