doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / nodes / intern / CMP_nodes / CMP_chromaMatte.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): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #include "../CMP_util.h"
31
32 /* ******************* Chroma Key ********************************************************** */
33 static bNodeSocketType cmp_node_chroma_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_chroma_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 static void do_rgba_to_ycca_normalized(bNode *UNUSED(node), float *out, float *in)
46 {
47    rgb_to_ycc(in[0],in[1],in[2], &out[0], &out[1], &out[2], BLI_YCC_ITU_BT601);
48
49    //normalize to 0..1.0
50    out[0]=out[0]/255.0;
51    out[1]=out[1]/255.0;
52    out[2]=out[2]/255.0;
53
54    //rescale to -1.0..1.0
55    out[0]=(out[0]*2.0)-1.0;
56    out[1]=(out[1]*2.0)-1.0;
57    out[2]=(out[2]*2.0)-1.0;
58
59 //      out[0]=((out[0])-16)/255.0;
60 //      out[1]=((out[1])-128)/255.0;
61 //      out[2]=((out[2])-128)/255.0;
62         out[3]=in[3];
63 }
64
65 static void do_ycca_to_rgba_normalized(bNode *UNUSED(node), float *out, float *in)
66 {
67    /*un-normalize the normalize from above */
68    in[0]=(in[0]+1.0)/2.0;
69    in[1]=(in[1]+1.0)/2.0;
70    in[2]=(in[2]+1.0)/2.0;
71
72    in[0]=(in[0]*255.0);
73    in[1]=(in[1]*255.0);
74    in[2]=(in[2]*255.0);
75
76 //      in[0]=(in[0]*255.0)+16;
77 //      in[1]=(in[1]*255.0)+128;
78 //      in[2]=(in[2]*255.0)+128;
79         ycc_to_rgb(in[0],in[1],in[2], &out[0], &out[1], &out[2], BLI_YCC_ITU_BT601);
80         out[3]=in[3];
81 }
82
83 static void do_chroma_key(bNode *node, float *out, float *in)
84 {
85         NodeChroma *c;
86    float x, z, alpha;
87    float theta, beta, angle, angle2;
88    float kfg;
89
90         c=node->storage;
91
92    /* Algorithm from book "Video Demistified," does not include the spill reduction part */
93
94         /* find theta, the angle that the color space should be rotated based on key*/
95    theta=atan2(c->key[2], c->key[1]);
96
97         /*rotate the cb and cr into x/z space */
98    x=in[1]*cos(theta)+in[2]*sin(theta);
99    z=in[2]*cos(theta)-in[1]*sin(theta);
100
101    /*if within the acceptance angle */
102    angle=c->t1*M_PI/180.0; /* convert to radians */
103         
104    /* if kfg is <0 then the pixel is outside of the key color */
105    kfg=x-(fabs(z)/tan(angle/2.0));
106
107    out[0]=in[0];
108    out[1]=in[1];
109    out[2]=in[2];
110
111    if(kfg>0.0) {  /* found a pixel that is within key color */
112       alpha=(1.0-kfg)*(c->fstrength);
113
114       beta=atan2(z,x);
115       angle2=c->t2*M_PI/180.0;
116
117       /* if beta is within the cutoff angle */
118       if(fabs(beta)<(angle2/2.0)) {
119          alpha=0.0;
120       }
121
122                 /* don't make something that was more transparent less transparent */
123                 if (alpha<in[3]) {
124                         out[3]=alpha;
125                 }
126                 else {
127                         out[3]=in[3];
128                 }
129         }
130         else { /*pixel is outside key color */
131                 out[0]=in[0];
132                 out[1]=in[1];
133                 out[2]=in[2];
134                 out[3]=in[3]; /* make pixel just as transparent as it was before */
135         }
136 }
137
138 static void node_composit_exec_chroma_matte(void *data, bNode *node, bNodeStack **in, bNodeStack **out)
139 {
140         CompBuf *cbuf;
141         CompBuf *chromabuf;
142         NodeChroma *c;
143         
144         if(in[0]->hasinput==0) return;
145         if(in[0]->data==NULL) return;
146         if(out[0]->hasoutput==0 && out[1]->hasoutput==0) return;
147         
148         cbuf= typecheck_compbuf(in[0]->data, CB_RGBA);
149         
150         chromabuf= dupalloc_compbuf(cbuf);
151         
152         c=node->storage;
153         
154         /*convert rgbbuf to normalized chroma space*/
155         composit1_pixel_processor(node, chromabuf, cbuf, in[0]->vec, do_rgba_to_ycca_normalized, CB_RGBA);
156         /*convert key to normalized chroma color space */
157         do_rgba_to_ycca_normalized(node, c->key, in[1]->vec);
158         
159         /*per pixel chroma key*/
160         composit1_pixel_processor(node, chromabuf, chromabuf, in[0]->vec, do_chroma_key, CB_RGBA);
161         
162         /*convert back*/
163         composit1_pixel_processor(node, chromabuf, chromabuf, in[0]->vec, do_ycca_to_rgba_normalized, CB_RGBA);
164         
165         out[0]->data= chromabuf;
166         if(out[1]->hasoutput)
167                 out[1]->data= valbuf_from_rgbabuf(chromabuf, CHAN_A);
168         
169         generate_preview(data, node, chromabuf);
170
171         if(cbuf!=in[0]->data)
172                 free_compbuf(cbuf);
173 };
174
175
176 static void node_composit_init_chroma_matte(bNode *node)
177 {
178    NodeChroma *c= MEM_callocN(sizeof(NodeChroma), "node chroma");
179    node->storage= c;
180    c->t1= 30.0f;
181    c->t2= 10.0f;
182    c->t3= 0.0f;
183    c->fsize= 0.0f;
184    c->fstrength= 1.0f;
185 };
186
187 void register_node_type_cmp_chroma_matte(ListBase *lb)
188 {
189         static bNodeType ntype;
190
191         node_type_base(&ntype, CMP_NODE_CHROMA_MATTE, "Chroma Key", NODE_CLASS_MATTE, NODE_PREVIEW|NODE_OPTIONS,
192                 cmp_node_chroma_in, cmp_node_chroma_out);
193         node_type_size(&ntype, 200, 80, 300);
194         node_type_init(&ntype, node_composit_init_chroma_matte);
195         node_type_storage(&ntype, "NodeChroma", node_free_standard_storage, node_copy_standard_storage);
196         node_type_exec(&ntype, node_composit_exec_chroma_matte);
197
198         nodeRegisterType(lb, &ntype);
199 }
200
201
202