doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / nodes / intern / CMP_nodes / CMP_distanceMatte.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL 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. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2006 Blender Foundation.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Bob Holcomb
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #include "../CMP_util.h"
31
32 /* ******************* channel Distance Matte ********************************* */
33 static bNodeSocketType cmp_node_distance_matte_in[]={
34         {SOCK_RGBA,1,"Image", 0.8f, 0.8f, 0.8f, 1.0f, 0.0f, 1.0f},
35         {SOCK_RGBA,1,"Key Color", 0.8f, 0.8f, 0.8f, 1.0f, 0.0f, 1.0f},
36         {-1,0,""}
37 };
38
39 static bNodeSocketType cmp_node_distance_matte_out[]={
40         {SOCK_RGBA,0,"Image", 0.8f, 0.8f, 0.8f, 1.0f, 0.0f, 1.0f},
41         {SOCK_VALUE,0,"Matte",0.0f, 0.0f, 0.0f, 1.0f, 0.0f, 1.0f},
42         {-1,0,""}
43 };
44
45 /* note, keyvals is passed on from caller as stack array */
46 /* might have been nicer as temp struct though... */
47 static void do_distance_matte(bNode *node, float *out, float *in)
48 {
49         NodeChroma *c= (NodeChroma *)node->storage;
50         float tolerence=c->t1;
51    float falloff=c->t2;
52         float distance;
53    float alpha;
54    
55    distance=sqrt((c->key[0]-in[0])*(c->key[0]-in[0]) +
56                                   (c->key[1]-in[1])*(c->key[1]-in[1]) +
57                                   (c->key[2]-in[2])*(c->key[2]-in[2]));
58
59    VECCOPY(out, in);
60
61    /*make 100% transparent */
62    if(distance < tolerence) {
63           out[3]=0.0;
64    }
65    /*in the falloff region, make partially transparent */
66    else if(distance < falloff+tolerence){
67           distance=distance-tolerence;
68           alpha=distance/falloff;
69            /*only change if more transparent than before */
70           if(alpha < in[3]) {
71                  out[3]=alpha;
72           }
73           else { /* leave as before */
74                  out[3]=in[3];
75           }
76    }
77    else {
78           out[3]=in[3];
79    }
80 }
81
82 static void node_composit_exec_distance_matte(void *data, bNode *node, bNodeStack **in, bNodeStack **out)
83 {
84         /*
85         Losely based on the Sequencer chroma key plug-in, but enhanced to work in other color spaces and
86         uses a differnt difference function (suggested in forums of vfxtalk.com).
87         */
88         CompBuf *workbuf;
89         CompBuf *inbuf;
90         NodeChroma *c;
91         
92         /*is anything connected?*/
93         if(out[0]->hasoutput==0 && out[1]->hasoutput==0) return;
94         /*must have an image imput*/
95         if(in[0]->data==NULL) return;
96         
97         inbuf=typecheck_compbuf(in[0]->data, CB_RGBA);
98         
99         c=node->storage;
100         workbuf=dupalloc_compbuf(inbuf);
101         
102         /*use the input color*/
103         c->key[0]= in[1]->vec[0];
104         c->key[1]= in[1]->vec[1];
105         c->key[2]= in[1]->vec[2];
106         
107         /* note, processor gets a keyvals array passed on as buffer constant */
108         composit1_pixel_processor(node, workbuf, workbuf, in[0]->vec, do_distance_matte, CB_RGBA);
109         
110         
111         out[0]->data=workbuf;
112         if(out[1]->hasoutput)
113                 out[1]->data=valbuf_from_rgbabuf(workbuf, CHAN_A);
114         generate_preview(data, node, workbuf);
115
116         if(inbuf!=in[0]->data)
117                 free_compbuf(inbuf);
118 }
119
120 static void node_composit_init_distance_matte(bNode *node)
121 {
122    NodeChroma *c= MEM_callocN(sizeof(NodeChroma), "node chroma");
123    node->storage= c;
124    c->t1= 0.1f;
125    c->t2= 0.1f;
126 }
127
128 void register_node_type_cmp_distance_matte(ListBase *lb)
129 {
130         static bNodeType ntype;
131
132         node_type_base(&ntype, CMP_NODE_DIST_MATTE, "Distance Key", NODE_CLASS_MATTE, NODE_PREVIEW|NODE_OPTIONS,
133                 cmp_node_distance_matte_in, cmp_node_distance_matte_out);
134         node_type_size(&ntype, 200, 80, 250);
135         node_type_init(&ntype, node_composit_init_distance_matte);
136         node_type_storage(&ntype, "NodeChroma", node_free_standard_storage, node_copy_standard_storage);
137         node_type_exec(&ntype, node_composit_exec_distance_matte);
138
139         nodeRegisterType(lb, &ntype);
140 }
141
142
143