1 /* === S Y N F I G ========================================================= */
3 ** \brief BMP Target Module
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2007 Chris Moore
11 ** This package is free software; you can redistribute it and/or
12 ** modify it under the terms of the GNU General Public License as
13 ** published by the Free Software Foundation; either version 2 of
14 ** the License, or (at your option) any later version.
16 ** This package is distributed in the hope that it will be useful,
17 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 ** General Public License for more details.
22 ** === N O T E S ===========================================================
24 ** ========================================================================= */
26 /* === H E A D E R S ======================================================= */
37 #include <ETL/stringf>
42 /* === M A C R O S ========================================================= */
44 using namespace synfig;
48 #define MAX_FRAME_RATE (20.0)
50 /* === G L O B A L S ======================================================= */
52 SYNFIG_TARGET_INIT(gif);
53 SYNFIG_TARGET_SET_NAME(gif,"gif");
54 SYNFIG_TARGET_SET_EXT(gif,"gif");
55 SYNFIG_TARGET_SET_VERSION(gif,"0.1");
56 SYNFIG_TARGET_SET_CVS_ID(gif,"$Id$");
58 /* === M E T H O D S ======================================================= */
60 gif::gif(const char *filename_):
62 file( (filename=="-")?stdout:fopen(filename_,POPEN_BINARY_WRITE_TYPE) ),
78 fputc(';',file.get()); // Image terminator
82 gif::set_rend_desc(RendDesc *given_desc)
84 if(given_desc->get_frame_rate()>MAX_FRAME_RATE)
85 given_desc->set_frame_rate(MAX_FRAME_RATE);
89 if(desc.get_frame_end()-desc.get_frame_start()>0)
93 imagecount=desc.get_frame_end()-desc.get_frame_start();
103 int w=desc.get_w(),h=desc.get_h();
107 synfig::error(strprintf(_("Unable to open \"%s\" for write access!"),filename.c_str()));
111 rootsize=color_bits; // Size of pixel bits
113 curr_frame.set_wh(w,h);
114 prev_frame.set_wh(w,h);
115 curr_surface.set_wh(w,h);
118 curr_surface.clear();
126 fprintf(file.get(),"GIF89a");
127 fputc(w&0x000000ff,file.get());
128 fputc((w&0x0000ff00)>>8,file.get());
129 fputc(h&0x000000ff,file.get());
130 fputc((h&0x0000ff00)>>8,file.get());
132 fputc(0xF0+(rootsize-1),file.get()); // flags
134 fputc((0xF0+(rootsize-1))&~(1<<7),file.get()); // flags
136 fputc(0,file.get()); // background color
137 fputc(0,file.get()); // Pixel Aspect Ratio
141 curr_palette=Palette::grayscale(256/(1<<(8-rootsize))-1);
142 output_curr_palette();
145 if(loop_count && multi_image)
147 fputc(33,file.get()); // 33 (hex 0x21) GIF Extension code
148 fputc(255,file.get()); // 255 (hex 0xFF) Application Extension Label
149 fputc(11,file.get()); // 11 (hex (0x0B) Length of Application Block
150 fprintf(file.get(),"NETSCAPE2.0");
151 fputc(3,file.get()); // 3 (hex 0x03) Length of Data Sub-Block
152 fputc(1,file.get()); // 1 (hex 0x01)
153 fputc(loop_count&0x000000ff,file.get());
154 fputc((loop_count&0x0000ff00)>>8,file.get());
155 fputc(0,file.get()); // 0 (hex 0x00) a Data Sub-block Terminator.
162 gif::output_curr_palette()
164 // Output the color table
165 for(i=0;i<256/(1<<(8-rootsize));i++)
167 if(i<(signed)curr_palette.size())
169 Color color(curr_palette[i].color.clamped());
170 //fputc(i*(1<<(8-rootsize)),file.get());
171 //fputc(i*(1<<(8-rootsize)),file.get());
172 //fputc(i*(1<<(8-rootsize)),file.get());
173 fputc(gamma().r_F32_to_U8(color.get_r()),file.get());
174 fputc(gamma().g_F32_to_U8(color.get_g()),file.get());
175 fputc(gamma().b_F32_to_U8(color.get_b()),file.get());
179 fputc(255,file.get());
181 fputc(255,file.get());
187 gif::start_frame(synfig::ProgressCallback *callback)
195 if(callback)callback->error(string("BUG:")+_("Description not set!"));
199 if(callback)callback->task(filename+strprintf(" %d",imagecount));
209 int w=desc.get_w(),h=desc.get_h(),i;
212 delaytime=round_to_int(100.0/desc.get_frame_rate());
214 bool build_off_previous(multi_image);
216 Palette prev_palette(curr_palette);
218 // Fill in the background color
219 if(!get_remove_alpha())
221 Surface::alpha_pen pen(curr_surface.begin(),1.0,Color::BLEND_BEHIND);
222 pen.set_value(get_canvas()->rend_desc().get_bg_color());
223 for(int y=0;y<curr_surface.get_h();y++,pen.inc_y())
226 for(x=0;x<curr_surface.get_w();x++,pen.inc_x())
228 if(pen.get_value().get_a()>0.1)
231 pen[0][0]=Color::alpha();
239 curr_palette=Palette(curr_surface,256/(1<<(8-rootsize))-build_off_previous-1);
240 synfig::info("curr_palette.size()=%d",curr_palette.size());
243 int transparent_index(curr_palette.find_closest(Color(1,0,1,0))-curr_palette.begin());
244 bool has_transparency(curr_palette[transparent_index].color.get_a()<=0.00001);
247 build_off_previous=false;
249 if(build_off_previous)
252 has_transparency=true;
255 #define DISPOSE_UNDEFINED (0)
256 #define DISPOSE_NONE (1<<2)
257 #define DISPOSE_RESTORE_BGCOLOR (2<<2)
258 #define DISPOSE_RESTORE_PREVIOUS (3<<2)
260 if(build_off_previous)
261 gec_flags|=DISPOSE_NONE;
263 gec_flags|=DISPOSE_RESTORE_PREVIOUS;
267 // output the Graphic Control Extension
268 fputc(0x21,file.get()); // Extension introducer
269 fputc(0xF9,file.get()); // Graphic Control Label
270 fputc(4,file.get()); // Block Size
271 fputc(gec_flags,file.get()); // Flags (Packed Fields)
272 fputc(delaytime&0x000000ff,file.get()); // Delay Time (MSB)
273 fputc((delaytime&0x0000ff00)>>8,file.get()); // Delay Time (LSB)
274 fputc(transparent_index,file.get()); // Transparent Color Index
275 fputc(0,file.get()); // Block Terminator
277 // output the image header
278 fputc(',',file.get());
279 fputc(0,file.get()); // image left
280 fputc(0,file.get()); // image left
281 fputc(0,file.get()); // image top
282 fputc(0,file.get()); // image top
283 fputc(w&0x000000ff,file.get());
284 fputc((w&0x0000ff00)>>8,file.get());
285 fputc(h&0x000000ff,file.get());
286 fputc((h&0x0000ff00)>>8,file.get());
288 fputc(0x80|(rootsize-1),file.get()); // flags
290 fputc(0x00+ rootsize-1,file.get()); // flags
295 Palette out(curr_palette);
297 if(build_off_previous)
298 curr_palette.insert(curr_palette.begin(),Color(1,0,1,0));
299 output_curr_palette();
305 // Prepare ourselves for LZW compression
307 nextcode=(1<<rootsize)+2;
308 table=lzwcode::NewTable((1<<rootsize));
311 // Output the rootsize
312 fputc(rootsize,file.get()); // rootsize;
314 // Push a table reset into the bitstream
315 bs.push_value(1<<rootsize,codesize);
317 for(int cur_scanline=0;cur_scanline<desc.get_h();cur_scanline++)
319 //convert_color_format(curr_frame[cur_scanline], curr_surface[cur_scanline], desc.get_w(), PF_GRAY, gamma());
321 // Now we compress it!
324 Color color(curr_surface[cur_scanline][i].clamped());
325 Palette::iterator iter(curr_palette.find_closest(color));
329 Color error(color-iter->color);
331 if(curr_surface.get_h()>cur_scanline+1)
333 curr_surface[cur_scanline+1][i-1] += error * ((float)3/(float)16);
334 curr_surface[cur_scanline+1][i] += error * ((float)5/(float)16);
335 if(curr_surface.get_w()>i+1)
336 curr_surface[cur_scanline+1][i+1] += error * ((float)1/(float)16);
338 if(curr_surface.get_w()>i+1)
339 curr_surface[cur_scanline][i+1] += error * ((float)7/(float)16);
342 curr_frame[cur_scanline][i]=iter-curr_palette.begin();
344 value=curr_frame[cur_scanline][i];
345 if(build_off_previous)
347 if(value>(unsigned)(1<<rootsize)-1)
348 value=(1<<rootsize)-1;
350 // If the pixel is the same as the one that
351 // is already there, then we should make it
353 if(build_off_previous)
360 abs( ( iter->color-prev_palette[prev_frame[cur_scanline][i]-1].color ).get_y() ) > (1.0/16.0) ||
361 // abs((int)value-(int)prev_frame[cur_scanline][i])>2||
362 // (value<=2 && value!=prev_frame[cur_scanline][i]) ||
363 (imagecount%iframe_density)==0 || imagecount==desc.get_frame_end()-1 ) // lossy version
364 prev_frame[cur_scanline][i]=value;
367 prev_frame[cur_scanline][i]=value;
374 if(value!=prev_frame[cur_scanline][i])
375 prev_frame[cur_scanline][i]=value;
381 prev_frame[cur_scanline][i]=value;
383 next=node->FindCode(value);
388 node->AddNode(nextcode, value);
389 bs.push_value(node->code, codesize);
390 node = table->FindCode(value);
392 // Check to see if we need to increase the codesize
393 if (nextcode == ( 1 << codesize))
398 // check to see if we have filled up the table
399 if (nextcode == 4096)
401 // output the clear code: make sure to use the current
403 bs.push_value((unsigned) 1 << rootsize, codesize);
406 table = lzwcode::NewTable((1<<rootsize));
407 codesize = rootsize + 1;
408 nextcode = (1 << rootsize) + 2;
410 // since we have a new table, need the correct prefix
411 node = table->FindCode(value);
421 // Push the last code onto the bitstream
422 bs.push_value(node->code,codesize);
424 // Push a end-of-stream code onto the bitstream
425 bs.push_value((1<<rootsize)+1,codesize);
427 // Make sure everything is dumped out
432 fputc(0,file.get()); // Block terminator
439 gif::start_scanline(int scanline)
441 cur_scanline=scanline;
442 return curr_surface[scanline];
451 // int w=desc.get_w(),i;
452 // unsigned int value;