synfig-core/trunk/src/modules/mod_gif/trgt_gif.cpp

   1 /*! ========================================================================
   2 ** Synfig
   3 ** BMP Target Module
   4 ** $Id: trgt_gif.cpp,v 1.1.1.1 2005/01/04 01:23:10 darco Exp $
   5 **
   6 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   7 **
   8 **      This package is free software; you can redistribute it and/or
   9 **      modify it under the terms of the GNU General Public License as
  10 **      published by the Free Software Foundation; either version 2 of
  11 **      the License, or (at your option) any later version.
  12 **
  13 **      This package is distributed in the hope that it will be useful,
  14 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16 **      General Public License for more details.
  17 **
  18 ** === N O T E S ===========================================================
  19 **
  20 ** ========================================================================= */
  21
  22 /* === H E A D E R S ======================================================= */
  23
  24 #define SYNFIG_TARGET
  25
  26 #ifdef USING_PCH
  27 #       include "pch.h"
  28 #else
  29 #ifdef HAVE_CONFIG_H
  30 #       include <config.h>
  31 #endif
  32
  33 #include <ETL/stringf>
  34 #include "trgt_gif.h"
  35 #include <stdio.h>
  36 #endif
  37
  38 /* === M A C R O S ========================================================= */
  39
  40 using namespace synfig;
  41 using namespace std;
  42 using namespace etl;
  43
  44 #define MAX_FRAME_RATE  (20.0)
  45
  46 /* === G L O B A L S ======================================================= */
  47
  48 SYNFIG_TARGET_INIT(gif);
  49 SYNFIG_TARGET_SET_NAME(gif,"gif");
  50 SYNFIG_TARGET_SET_EXT(gif,"gif");
  51 SYNFIG_TARGET_SET_VERSION(gif,"0.1");
  52 SYNFIG_TARGET_SET_CVS_ID(gif,"$Id: trgt_gif.cpp,v 1.1.1.1 2005/01/04 01:23:10 darco Exp $");
  53
  54 /* === M E T H O D S ======================================================= */
  55
  56 gif::gif(const char *filename_):
  57         filename(filename_),
  58         file( (filename=="-")?stdout:fopen(filename_,"wb") ),
  59         imagecount(0),
  60
  61         lossy(true),
  62         multi_image(false),
  63         dithering(true),
  64         color_bits(8),
  65         iframe_density(30),
  66         loop_count(0x7fff),
  67         local_palette(true)
  68 {
  69 }
  70
  71 gif::~gif()
  72 {
  73         if(file)
  74                 fputc(';',file.get());  // Image terminator
  75 }
  76
  77 bool
  78 gif::set_rend_desc(RendDesc *given_desc)
  79 {
  80         if(given_desc->get_frame_rate()>MAX_FRAME_RATE)
  81                 given_desc->set_frame_rate(MAX_FRAME_RATE);
  82
  83         desc=*given_desc;
  84
  85         if(desc.get_frame_end()-desc.get_frame_start()>0)
  86         {
  87                 multi_image=true;
  88                 //set_remove_alpha();
  89                 imagecount=desc.get_frame_end()-desc.get_frame_start();
  90         }
  91         else
  92                 multi_image=false;
  93         return true;
  94 }
  95
  96 bool
  97 gif::init()
  98 {
  99         int w=desc.get_w(),h=desc.get_h();
 100
 101         if(!file)
 102         {
 103                 synfig::error(strprintf(_("Unable to open \"%s\" for write access!"),filename.c_str()));
 104                 return false;
 105         }
 106
 107         rootsize=color_bits;    // Size of pixel bits
 108
 109         curr_frame.set_wh(w,h);
 110         prev_frame.set_wh(w,h);
 111         curr_surface.set_wh(w,h);
 112         curr_frame.clear();
 113         prev_frame.clear();
 114         curr_surface.clear();
 115
 116         if(get_quality()>5)
 117                 lossy=true;
 118         else
 119                 lossy=false;
 120
 121         // Output the header
 122         fprintf(file.get(),"GIF89a");
 123         fputc(w&0x000000ff,file.get());
 124         fputc((w&0x0000ff00)>>8,file.get());
 125         fputc(h&0x000000ff,file.get());
 126         fputc((h&0x0000ff00)>>8,file.get());
 127         if(!local_palette)
 128                 fputc(0xF0+(rootsize-1),file.get());    // flags
 129         else
 130                 fputc((0xF0+(rootsize-1))&~(1<<7),file.get());  // flags
 131
 132         fputc(0,file.get());            // backgound color
 133         fputc(0,file.get());            // Pixel Aspect Ratio
 134
 135         DEBUGPOINT();
 136
 137         if(!local_palette)
 138         {
 139         DEBUGPOINT();
 140                 curr_palette=Palette::grayscale(256/(1<<(8-rootsize))-1);
 141                 output_curr_palette();
 142         }
 143
 144         if(loop_count && multi_image)
 145         {
 146         DEBUGPOINT();
 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.
 156         }
 157         DEBUGPOINT();
 158
 159         return true;
 160 }
 161
 162 void
 163 gif::output_curr_palette()
 164 {
 165         // Output the color table
 166         for(i=0;i<256/(1<<(8-rootsize));i++)
 167         {
 168                 if(i<(signed)curr_palette.size())
 169                 {
 170                         Color color(curr_palette[i].color.clamped());
 171                         //fputc(i*(1<<(8-rootsize)),file.get());
 172                         //fputc(i*(1<<(8-rootsize)),file.get());
 173                         //fputc(i*(1<<(8-rootsize)),file.get());
 174                         fputc(gamma().r_F32_to_U8(color.get_r()),file.get());
 175                         fputc(gamma().g_F32_to_U8(color.get_g()),file.get());
 176                         fputc(gamma().b_F32_to_U8(color.get_b()),file.get());
 177                 }
 178                 else
 179                 {
 180                         fputc(255,file.get());
 181                         fputc(0,file.get());
 182                         fputc(255,file.get());
 183                 }
 184         }
 185 }
 186
 187 bool
 188 gif::start_frame(synfig::ProgressCallback *callback)
 189 {
 190 //      int
 191 //              w=desc.get_w(),
 192 //              h=desc.get_h();
 193
 194         if(!file)
 195         {
 196                 if(callback)callback->error(string("BUG:")+_("Description not set!"));
 197                 return false;
 198         }
 199
 200         if(callback)callback->task(filename+strprintf(" %d",imagecount));
 201
 202
 203
 204         return true;
 205 }
 206
 207 void
 208 gif::end_frame()
 209 {
 210         int w=desc.get_w(),h=desc.get_h(),i;
 211         unsigned int value;
 212         int
 213                 delaytime=round_to_int(100.0/desc.get_frame_rate());
 214
 215         bool build_off_previous(multi_image);
 216
 217         Palette prev_palette(curr_palette);
 218
 219         // Fill in the background color
 220         if(!get_remove_alpha())
 221         {
 222                 Surface::alpha_pen pen(curr_surface.begin(),1.0,Color::BLEND_BEHIND);
 223                 pen.set_value(get_canvas()->rend_desc().get_bg_color());
 224                 for(int y=0;y<curr_surface.get_h();y++,pen.inc_y())
 225                 {
 226                         int x;
 227                         for(x=0;x<curr_surface.get_w();x++,pen.inc_x())
 228                         {
 229                                 if(pen.get_value().get_a()>0.1)
 230                                         pen.put_value();
 231                                 else
 232                                         pen[0][0]=Color::alpha();
 233                         }
 234                         pen.dec_x(x);
 235                 }
 236         }
 237
 238         if(local_palette)
 239         {
 240                 curr_palette=Palette(curr_surface,256/(1<<(8-rootsize))-build_off_previous-1);
 241                 synfig::info("curr_palette.size()=%d",curr_palette.size());
 242         }
 243
 244         int transparent_index(curr_palette.find_closest(Color(1,0,1,0))-curr_palette.begin());
 245         bool has_transparency(curr_palette[transparent_index].color.get_a()<=0.00001);
 246
 247         if(has_transparency)
 248                 build_off_previous=false;
 249
 250         if(build_off_previous)
 251         {
 252                 transparent_index=0;
 253                 has_transparency=true;
 254         }
 255
 256 #define DISPOSE_UNDEFINED                       (0)
 257 #define DISPOSE_NONE                            (1<<2)
 258 #define DISPOSE_RESTORE_BGCOLOR         (2<<2)
 259 #define DISPOSE_RESTORE_PREVIOUS        (3<<2)
 260         int gec_flags(0);
 261         if(build_off_previous)
 262                 gec_flags|=DISPOSE_NONE;
 263         else
 264                 gec_flags|=DISPOSE_RESTORE_PREVIOUS;
 265         if(has_transparency)
 266                 gec_flags|=1;
 267
 268         // output the Graphic Control Extension
 269         fputc(0x21,file.get()); // Extension introducer
 270         fputc(0xF9,file.get()); // Graphic Control Label
 271         fputc(4,file.get()); // Block Size
 272         fputc(gec_flags,file.get()); // Flags (Packed Fields)
 273         fputc(delaytime&0x000000ff,file.get()); // Delay Time (MSB)
 274         fputc((delaytime&0x0000ff00)>>8,file.get()); // Delay Time (LSB)
 275         fputc(transparent_index,file.get()); // Transparent Color Index
 276         fputc(0,file.get()); // Block Terminator
 277
 278         // output the image header
 279         fputc(',',file.get());
 280         fputc(0,file.get());    // image left
 281         fputc(0,file.get());    // image left
 282         fputc(0,file.get());    // image top
 283         fputc(0,file.get());    // image top
 284         fputc(w&0x000000ff,file.get());
 285         fputc((w&0x0000ff00)>>8,file.get());
 286         fputc(h&0x000000ff,file.get());
 287         fputc((h&0x0000ff00)>>8,file.get());
 288         if(local_palette)
 289                 fputc(0x80|(rootsize-1),file.get());    // flags
 290         else
 291                 fputc(0x00+ rootsize-1,file.get());     // flags
 292
 293
 294         if(local_palette)
 295         {
 296                 Palette out(curr_palette);
 297
 298                 if(build_off_previous)
 299                         curr_palette.insert(curr_palette.begin(),Color(1,0,1,0));
 300                 output_curr_palette();
 301                 curr_palette=out;
 302         }
 303
 304         bs=bitstream(file);
 305
 306         // Prepare ourselves for LZW compression
 307         codesize=rootsize+1;
 308         nextcode=(1<<rootsize)+2;
 309         table=lzwcode::NewTable((1<<rootsize));
 310         node=table;
 311
 312         // Output the rootsize
 313         fputc(rootsize,file.get());     // rootsize;
 314
 315         // Push a table reset into the bitstream
 316         bs.push_value(1<<rootsize,codesize);
 317
 318         for(int cur_scanline=0;cur_scanline<desc.get_h();cur_scanline++)
 319         {
 320                 //convert_color_format(curr_frame[cur_scanline], curr_surface[cur_scanline], desc.get_w(), PF_GRAY, gamma());
 321
 322                 // Now we compress it!
 323                 for(i=0;i<w;i++)
 324                 {
 325                         Color color(curr_surface[cur_scanline][i].clamped());
 326                         Palette::iterator iter(curr_palette.find_closest(color));
 327
 328                         if(dithering)
 329                         {
 330                                 Color error(color-iter->color);
 331                                 //error*=0.25;
 332                                 if(curr_surface.get_h()>cur_scanline+1)
 333                                 {
 334                                         curr_surface[cur_scanline+1][i-1]  += error * ((float)3/(float)16);
 335                                         curr_surface[cur_scanline+1][i]    += error * ((float)5/(float)16);
 336                                         if(curr_surface.get_w()>i+1)
 337                                                 curr_surface[cur_scanline+1][i+1]  += error * ((float)1/(float)16);
 338                                 }
 339                                 if(curr_surface.get_w()>i+1)
 340                                         curr_surface[cur_scanline][i+1]    += error * ((float)7/(float)16);
 341                         }
 342
 343                         curr_frame[cur_scanline][i]=iter-curr_palette.begin();
 344
 345                         value=curr_frame[cur_scanline][i];
 346                         if(build_off_previous)
 347                                 value++;
 348                         if(value>(unsigned)(1<<rootsize)-1)
 349                                 value=(1<<rootsize)-1;
 350
 351                         // If the pixel is the same as the one that
 352                         // is already there, then we should make it
 353                         // transparent
 354                         if(build_off_previous)
 355                         {
 356                                 if(lossy)
 357                                 {
 358
 359                                         // Lossy
 360                                         if(
 361                                                 abs( ( iter->color-prev_palette[prev_frame[cur_scanline][i]-1].color ).get_y() ) > (1.0/16.0) ||
 362 //                                              abs((int)value-(int)prev_frame[cur_scanline][i])>2||
 363 //                                              (value<=2 && value!=prev_frame[cur_scanline][i]) ||
 364                                                 (imagecount%iframe_density)==0 || imagecount==desc.get_frame_end()-1 ) // lossy version
 365                                                 prev_frame[cur_scanline][i]=value;
 366                                         else
 367                                         {
 368                                                 prev_frame[cur_scanline][i]=value;
 369                                                 value=0;
 370                                         }
 371                                 }
 372                                 else
 373                                 {
 374                                         // lossless version
 375                                         if(value!=prev_frame[cur_scanline][i])
 376                                                 prev_frame[cur_scanline][i]=value;
 377                                         else
 378                                                 value=0;
 379                                 }
 380                         }
 381                         else
 382                         prev_frame[cur_scanline][i]=value;
 383
 384                         next=node->FindCode(value);
 385                         if(next)
 386                                 node=next;
 387                         else
 388                         {
 389                                 node->AddNode(nextcode, value);
 390                                 bs.push_value(node->code, codesize);
 391                                 node = table->FindCode(value);
 392
 393                                 // Check to see if we need to increase the codesize
 394                                 if (nextcode == ( 1 << codesize))
 395                                         codesize += 1;
 396
 397                                 nextcode += 1;
 398
 399                                 // check to see if we have filled up the table
 400                                 if (nextcode == 4096)
 401                                 {
 402                                         // output the clear code: make sure to use the current
 403                                         // codesize
 404                                         bs.push_value((unsigned) 1 << rootsize, codesize);
 405
 406                                         delete table;
 407                                         table = lzwcode::NewTable((1<<rootsize));
 408                                         codesize = rootsize + 1;
 409                                         nextcode = (1 << rootsize) + 2;
 410
 411                                         // since we have a new table, need the correct prefix
 412                                         node = table->FindCode(value);
 413                                 }
 414                         }
 415                 }
 416         }
 417
 418
 419
 420
 421
 422         // Push the last code onto the bitstream
 423         bs.push_value(node->code,codesize);
 424
 425         // Push a end-of-stream code onto the bitstream
 426         bs.push_value((1<<rootsize)+1,codesize);
 427
 428         // Make sure everything is dumped out
 429         bs.dump();
 430
 431         delete table;
 432
 433         fputc(0,file.get());            // Block terminator
 434
 435         fflush(file.get());
 436         imagecount++;
 437 }
 438
 439 synfig::Color*
 440 gif::start_scanline(int scanline)
 441 {
 442         cur_scanline=scanline;
 443         return curr_surface[scanline];
 444 }
 445
 446 bool
 447 gif::end_scanline()
 448 {
 449         if(!file)
 450                 return false;
 451
 452 //      int w=desc.get_w(),i;
 453 //      unsigned int value;
 454
 455
 456         return true;
 457 }