patch [#34103] use boolean in path functions and add comments.
[blender.git] / source / blender / nodes / composite / nodes / node_composite_outputFile.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) 2006 Blender Foundation.
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/nodes/composite/nodes/node_composite_outputFile.c
29  *  \ingroup cmpnodes
30  */
31
32
33 #include <string.h>
34 #include "BLI_utildefines.h"
35 #include "BLI_path_util.h"
36
37 #include "node_composite_util.h"
38
39 #include "IMB_imbuf.h"
40 #include "IMB_imbuf_types.h"
41
42 #include "intern/openexr/openexr_multi.h"
43
44
45 /* **************** OUTPUT FILE ******************** */
46
47 /* find unique path */
48 static bool unique_path_unique_check(void *arg, const char *name)
49 {
50         struct {ListBase *lb; bNodeSocket *sock;} *data= arg;
51         bNodeSocket *sock;
52         for (sock=data->lb->first; sock; sock=sock->next) {
53                 if (sock != data->sock) {
54                         NodeImageMultiFileSocket *sockdata = sock->storage;
55                         if (strcmp(sockdata->path, name)==0)
56                                 return true;
57                 }
58         }
59         return false;
60 }
61 void ntreeCompositOutputFileUniquePath(ListBase *list, bNodeSocket *sock, const char defname[], char delim)
62 {
63         NodeImageMultiFileSocket *sockdata;
64         struct {ListBase *lb; bNodeSocket *sock;} data;
65         data.lb = list;
66         data.sock = sock;
67
68         /* See if we are given an empty string */
69         if (ELEM(NULL, sock, defname))
70                 return;
71
72         sockdata = sock->storage;
73         BLI_uniquename_cb(unique_path_unique_check, &data, defname, delim, sockdata->path, sizeof(sockdata->path));
74 }
75
76 /* find unique EXR layer */
77 static bool unique_layer_unique_check(void *arg, const char *name)
78 {
79         struct {ListBase *lb; bNodeSocket *sock;} *data= arg;
80         bNodeSocket *sock;
81         for (sock=data->lb->first; sock; sock=sock->next) {
82                 if (sock != data->sock) {
83                         NodeImageMultiFileSocket *sockdata = sock->storage;
84                         if (strcmp(sockdata->layer, name)==0)
85                                 return true;
86                 }
87         }
88         return false;
89 }
90 void ntreeCompositOutputFileUniqueLayer(ListBase *list, bNodeSocket *sock, const char defname[], char delim)
91 {
92         NodeImageMultiFileSocket *sockdata;
93         struct {ListBase *lb; bNodeSocket *sock;} data;
94         data.lb = list;
95         data.sock = sock;
96
97         /* See if we are given an empty string */
98         if (ELEM(NULL, sock, defname))
99                 return;
100
101         sockdata = sock->storage;
102         BLI_uniquename_cb(unique_layer_unique_check, &data, defname, delim, sockdata->layer, sizeof(sockdata->layer));
103 }
104
105 bNodeSocket *ntreeCompositOutputFileAddSocket(bNodeTree *ntree, bNode *node, const char *name, ImageFormatData *im_format)
106 {
107         NodeImageMultiFile *nimf = node->storage;
108         bNodeSocket *sock = nodeAddSocket(ntree, node, SOCK_IN, "", SOCK_RGBA);
109         
110         /* create format data for the input socket */
111         NodeImageMultiFileSocket *sockdata = MEM_callocN(sizeof(NodeImageMultiFileSocket), "socket image format");
112         sock->storage = sockdata;
113         
114         BLI_strncpy_utf8(sockdata->path, name, sizeof(sockdata->path));
115         ntreeCompositOutputFileUniquePath(&node->inputs, sock, name, '_');
116         BLI_strncpy_utf8(sockdata->layer, name, sizeof(sockdata->layer));
117         ntreeCompositOutputFileUniqueLayer(&node->inputs, sock, name, '_');
118         
119         if (im_format) {
120                 sockdata->format= *im_format;
121                 if (BKE_imtype_is_movie(sockdata->format.imtype)) {
122                         sockdata->format.imtype= R_IMF_IMTYPE_OPENEXR;
123                 }
124         }
125         else
126                 BKE_imformat_defaults(&sockdata->format);
127         /* use node data format by default */
128         sockdata->use_node_format = TRUE;
129         
130         nimf->active_input = BLI_findindex(&node->inputs, sock);
131         
132         return sock;
133 }
134
135 int ntreeCompositOutputFileRemoveActiveSocket(bNodeTree *ntree, bNode *node)
136 {
137         NodeImageMultiFile *nimf = node->storage;
138         bNodeSocket *sock = BLI_findlink(&node->inputs, nimf->active_input);
139         int totinputs = BLI_countlist(&node->inputs);
140         
141         if (!sock)
142                 return 0;
143         
144         if (nimf->active_input == totinputs-1)
145                 --nimf->active_input;
146         
147         /* free format data */
148         MEM_freeN(sock->storage);
149         
150         nodeRemoveSocket(ntree, node, sock);
151         return 1;
152 }
153
154 void ntreeCompositOutputFileSetPath(bNode *node, bNodeSocket *sock, const char *name)
155 {
156         NodeImageMultiFileSocket *sockdata = sock->storage;
157         BLI_strncpy_utf8(sockdata->path, name, sizeof(sockdata->path));
158         ntreeCompositOutputFileUniquePath(&node->inputs, sock, name, '_');
159 }
160
161 void ntreeCompositOutputFileSetLayer(bNode *node, bNodeSocket *sock, const char *name)
162 {
163         NodeImageMultiFileSocket *sockdata = sock->storage;
164         BLI_strncpy_utf8(sockdata->layer, name, sizeof(sockdata->layer));
165         ntreeCompositOutputFileUniqueLayer(&node->inputs, sock, name, '_');
166 }
167
168 static void init_output_file(bNodeTree *ntree, bNode *node, bNodeTemplate *ntemp)
169 {
170         NodeImageMultiFile *nimf= MEM_callocN(sizeof(NodeImageMultiFile), "node image multi file");
171         ImageFormatData *format = NULL;
172         node->storage= nimf;
173
174         if (ntemp->scene) {
175                 RenderData *rd = &ntemp->scene->r;
176                 BLI_strncpy(nimf->base_path, rd->pic, sizeof(nimf->base_path));
177                 nimf->format = rd->im_format;
178                 if (BKE_imtype_is_movie(nimf->format.imtype)) {
179                         nimf->format.imtype= R_IMF_IMTYPE_OPENEXR;
180                 }
181                 
182                 format = &nimf->format;
183         }
184         else
185                 BKE_imformat_defaults(&nimf->format);
186         
187         /* add one socket by default */
188         ntreeCompositOutputFileAddSocket(ntree, node, "Image", format);
189 }
190
191 static void free_output_file(bNode *node)
192 {
193         bNodeSocket *sock;
194         
195         /* free storage data in sockets */
196         for (sock=node->inputs.first; sock; sock=sock->next) {
197                 MEM_freeN(sock->storage);
198         }
199         
200         MEM_freeN(node->storage);
201 }
202
203 static void copy_output_file(struct bNode *node, struct bNode *target)
204 {
205         bNodeSocket *sock, *newsock;
206         
207         target->storage = MEM_dupallocN(node->storage);
208         
209         /* duplicate storage data in sockets */
210         for (sock=node->inputs.first, newsock=target->inputs.first; sock && newsock; sock=sock->next, newsock=newsock->next) {
211                 newsock->storage = MEM_dupallocN(sock->storage);
212         }
213 }
214
215 static void update_output_file(bNodeTree *UNUSED(ntree), bNode *node)
216 {
217         bNodeSocket *sock;
218         
219         /* automatically update the socket type based on linked input */
220         for (sock=node->inputs.first; sock; sock=sock->next) {
221                 if (sock->link) {
222                         int linktype = sock->link->fromsock->type;
223                         if (linktype != sock->type)
224                                 nodeSocketSetType(sock, linktype);
225                 }
226         }
227 }
228
229 void register_node_type_cmp_output_file(bNodeTreeType *ttype)
230 {
231         static bNodeType ntype;
232
233         node_type_base(ttype, &ntype, CMP_NODE_OUTPUT_FILE, "File Output", NODE_CLASS_OUTPUT, NODE_OPTIONS|NODE_PREVIEW);
234         node_type_socket_templates(&ntype, NULL, NULL);
235         node_type_init(&ntype, init_output_file);
236         node_type_storage(&ntype, "NodeImageMultiFile", free_output_file, copy_output_file);
237         node_type_update(&ntype, update_output_file, NULL);
238
239         nodeRegisterType(ttype, &ntype);
240 }