lib/rfxswf.h

   1 /* rfxswf.h
   2
   3    Headers for rfxswf.c and modules
   4
   5    Part of the swftools package.
   6
   7    Copyright (c) 2000, 2001 Rainer Böhme <rfxswf@reflex-studio.de>
   8
   9    This file is distributed under the GPL, see file COPYING for details
  10
  11 */
  12
  13 #ifndef __RFX_SWF_INCLUDED__
  14 #define __RFX_SWF_INCLUDED__
  15
  16 #include <stdio.h>
  17 #include <stdlib.h>
  18 #include <string.h>
  19 #include "../config.h"
  20
  21 #define DEBUG_RFXSWF
  22
  23 // SWF Types
  24
  25 typedef         unsigned long   U32;
  26 typedef         signed long     S32;
  27 typedef         unsigned short  U16;
  28 typedef         signed short    S16;
  29 typedef         unsigned char   U8;
  30 typedef         signed char     S8;
  31 typedef         signed long     SFIXED;
  32 typedef         signed long     SCOORD;
  33
  34 // Basic Structures
  35
  36 typedef struct _SPOINT
  37 { SCOORD        x;
  38   SCOORD        y;
  39 } SPOINT, * LPSPOINT;
  40
  41 typedef struct _RGBA
  42 { U8    a;
  43   U8    r;
  44   U8    g;
  45   U8    b;
  46 } RGBA, * LPRGBA;
  47
  48 typedef struct _SRECT
  49 { SCOORD        xmin;
  50   SCOORD        ymin;
  51   SCOORD        xmax;
  52   SCOORD        ymax;
  53 } SRECT, * LPSRECT;
  54
  55 typedef struct _MATRIX
  56 { SFIXED        sx;     // factor x
  57   SFIXED        sy;
  58   SFIXED        r0;     // rotation
  59   SFIXED        r1;
  60   SCOORD        tx;     // delta x
  61   SCOORD        ty;
  62 } MATRIX, * LPMATRIX;
  63
  64 typedef struct _CXFORM
  65 { S16           a0, a1;
  66   S16           r0, r1;
  67   S16           g0, g1;
  68   S16           b0, b1;
  69 } CXFORM, * LPCXFORM;
  70
  71 typedef struct _TAG             // NEVER access a Tag-Struct directly !
  72 { U16           id;
  73   U32           len;
  74   U8 *          data;
  75
  76   int           frame;
  77
  78   struct _TAG * next;
  79   struct _TAG * prev;
  80
  81   U32           memsize;        // to minimize realloc() calls
  82   U32           pos;            // for Get/Set-Access
  83   U8            bitmask;        // for Bit-Manipulating Functions [read]
  84   U8            bitcount;       // [write]
  85 } TAG, * LPTAG;
  86
  87 typedef struct _ActionTAG
  88 { U8            op;
  89   U16           len;
  90   U8 *          data;
  91
  92   struct _ActionTAG * next;
  93   struct _ActionTAG * prev;
  94
  95   TAG* parent; // may be null
  96 } ActionTAG;
  97
  98
  99 typedef struct _SWF
 100 { U8            fileVersion;
 101   U32           fileSize;       // valid after load and save
 102   SRECT         movieSize;
 103   U16           frameRate;
 104   U16           frameCount;     // valid after load and save
 105   TAG *         firstTag;
 106 } SWF, * LPSWF;
 107
 108 // Basic Functions
 109
 110 int  swf_ReadSWF(int handle,SWF * swf);     // Reads SWF to memory (malloc'ed), returns length or <0 if fails
 111 int  swf_WriteSWF(int handle,SWF * swf);    // Writes SWF to file, returns length or <0 if fails
 112 int  swf_WriteCGI(SWF * swf);               // Outputs SWF with valid CGI header to stdout
 113 void swf_FreeTags(SWF * swf);               // Frees all malloc'ed memory for swf
 114
 115 TAG * swf_InsertTag(TAG * after,U16 id);    // updates frames, if necessary
 116 int   swf_DeleteTag(TAG * t);
 117
 118 void  swf_SetTagPos(TAG * t,U32 pos);       // resets Bitcount
 119 U32   swf_GetTagPos(TAG * t);
 120
 121 TAG * swf_NextTag(TAG * t);
 122 TAG * swf_PrevTag(TAG * t);
 123
 124 int   swf_GetFrameNo(TAG * t);              // should be renamed to TagGetFrame
 125 U16   swf_GetTagID(TAG * t);                // ... TagGetID
 126 U32   swf_GetDataSize(TAG * t);             // ... TagGetDataSize
 127 U8*   swf_GetDataSizePtr(TAG * t);
 128
 129 U32   swf_GetBits(TAG * t,int nbits);
 130 S32   swf_GetSBits(TAG * t,int nbits);
 131 int   swf_SetBits(TAG * t,U32 v,int nbits);
 132
 133 int   swf_GetBlock(TAG * t,U8 * b,int l);   // resets Bitcount
 134 int   swf_SetBlock(TAG * t,U8 * b,int l);
 135
 136 U8    swf_GetU8(TAG * t);                   // resets Bitcount
 137 U16   swf_GetU16(TAG * t);
 138 U32   swf_GetU32(TAG * t);
 139
 140 int   swf_SetU8(TAG * t,U8 v);              // resets Bitcount
 141 int   swf_SetU16(TAG * t,U16 v);
 142 int   swf_SetU32(TAG * t,U32 v);
 143
 144 int   swf_GetPoint(TAG * t,SPOINT * p);     // resets Bitcount
 145 int   swf_GetRect(TAG * t,SRECT * r);
 146 int   swf_GetMatrix(TAG * t,MATRIX * m);
 147 int   swf_GetCXForm(TAG * t,CXFORM * cx,U8 alpha);
 148
 149 int   swf_SetPoint(TAG * t,SPOINT * p);     // resets Bitcount
 150 int   swf_SetRect(TAG * t,SRECT * r);
 151 int   swf_SetMatrix(TAG * t,MATRIX * m);
 152 int   swf_SetCXForm(TAG * t,CXFORM * cx,U8 alpha);
 153 int   swf_SetRGB(TAG * t,RGBA * col);
 154 int   swf_SetRGBA(TAG * t,RGBA * col);
 155
 156 // Function Macros
 157
 158 #define swf_GetS8(tag)      ((S8)swf_GetU8(tag))
 159 #define swf_GetS16(tag)     ((S16)swf_GetU16(tag))
 160 #define swf_GetS32(tag)     ((S32)swf_GetU32(tag))
 161 #define swf_GetCoord(tag)   ((SCOORD)swf_GetU32(tag))
 162 #define swf_GetFixed(tag)   ((SFIXED)swf_GetU32(tag))
 163
 164 #define swf_SetS8(tag,v)    swf_SetU8(tag,(U8)v)
 165 #define swf_SetS16(tag,v)   swf_SetU16(tag,(U16)v)
 166 #define swf_SetS32(tag,v)   swf_SetU32(tag,(U32)v)
 167 #define swf_SetCoord(tag,v) swf_SetU32(tag,(U32)v)
 168 #define swf_SetFixed(tag,v) swf_SetU32(tag,(U32)v)
 169 #define swf_SetString(t,s)  swf_SetBlock(t,s,strlen(s)+1)
 170
 171 #define FAILED(b)       ((b)<0)
 172 #define SUCCEDED(b)     ((b)>=0)
 173
 174 // Tag IDs (adopted from J. C. Kessels' Form2Flash)
 175
 176 #define ST_END                  0
 177 #define ST_SHOWFRAME            1
 178 #define ST_DEFINESHAPE          2
 179 #define ST_FREECHARACTER        3
 180 #define ST_PLACEOBJECT          4
 181 #define ST_REMOVEOBJECT         5
 182 #define ST_DEFINEBITS           6
 183 #define ST_DEFINEBUTTON         7
 184 #define ST_JPEGTABLES           8
 185 #define ST_SETBACKGROUNDCOLOR   9
 186 #define ST_DEFINEFONT           10
 187 #define ST_DEFINETEXT           11
 188 #define ST_DOACTION             12
 189 #define ST_DEFINEFONTINFO       13
 190 #define ST_DEFINESOUND          14 /* Event sound tags. */
 191 #define ST_STARTSOUND           15
 192 #define ST_DEFINEBUTTONSOUND    17
 193 #define ST_SOUNDSTREAMHEAD      18
 194 #define ST_SOUNDSTREAMBLOCK     19
 195 #define ST_DEFINEBITSLOSSLESS   20 /* A bitmap using lossless zlib compression. */
 196 #define ST_DEFINEBITSJPEG2      21 /* A bitmap using an internal JPEG compression table. */
 197 #define ST_DEFINESHAPE2         22
 198 #define ST_DEFINEBUTTONCXFORM   23
 199 #define ST_PROTECT              24 /* This file should not be importable for editing. */
 200 #define ST_PLACEOBJECT2         26 /* The new style place w/ alpha color transform and name. */
 201 #define ST_REMOVEOBJECT2        28 /* A more compact remove object that omits the character tag (just depth). */
 202 #define ST_DEFINESHAPE3         32 /* A shape V3 includes alpha values. */
 203 #define ST_DEFINETEXT2          33 /* A text V2 includes alpha values. */
 204 #define ST_DEFINEBUTTON2        34 /* A button V2 includes color transform, alpha and multiple actions */
 205 #define ST_DEFINEBITSJPEG3      35 /* A JPEG bitmap with alpha info. */
 206 #define ST_DEFINEBITSLOSSLESS2  36 /* A lossless bitmap with alpha info. */
 207 #define ST_DEFINEEDITTEXT       37
 208 #define ST_DEFINEMOVIE          38
 209 #define ST_DEFINESPRITE         39 /* Define a sequence of tags that describe the behavior of a sprite. */
 210 #define ST_NAMECHARACTER        40 /* Name a character definition, character id and a string, (used for buttons, bitmaps, sprites and sounds). */
 211 #define ST_SERIALNUMBER         41
 212 #define ST_GENERATORTEXT        42 /* contains an id */
 213 #define ST_FRAMELABEL           43 /* A string label for the current frame. */
 214 #define ST_SOUNDSTREAMHEAD2     45 /* For lossless streaming sound, should not have needed this... */
 215 #define ST_DEFINEMORPHSHAPE     46 /* A morph shape definition */
 216 #define ST_DEFINEFONT2          48
 217 #define ST_TEMPLATECOMMAND      49
 218 #define ST_GENERATOR3           51
 219 #define ST_EXTERNALFONT         52
 220
 221 #define ST_REFLEX              777 /* to identify generator software */
 222
 223 // Advanced Funtions
 224
 225 // swfdump.c
 226
 227 void swf_DumpHeader(FILE * f,SWF * swf);
 228 void swf_DumpMatrix(FILE * f,MATRIX * m);
 229 void swf_DumpTag(FILE * f,TAG * t);
 230 char* swf_TagGetName(TAG*tag);
 231
 232 // swfshape.c
 233
 234 typedef struct _LINESTYLE
 235 { U16           width;
 236   RGBA          color;
 237 } LINESTYLE, * LPLINESTYLE;
 238
 239 typedef struct _FILLSTYLE
 240 { U8     type;
 241   RGBA   color;
 242   MATRIX         m;
 243   U16    id_bitmap;
 244 } FILLSTYLE, * LPFILLSTYLE;
 245
 246 typedef struct _SHAPE           // NEVER access a Shape-Struct directly !
 247 {
 248   struct
 249   { LINESTYLE * data;
 250     U16         n;
 251   } linestyle;
 252                   // note: changes of shape structure
 253   struct                  // lead to incompatible .efont formats
 254   { FILLSTYLE * data;
 255     U16         n;
 256   } fillstyle;
 257
 258   S32           px;
 259   S32           py;
 260
 261   struct
 262   { U16         fill;
 263     U16         line;
 264   } bits;
 265
 266   U8 *          data;
 267   U32           bitlen;         // length of data in bits
 268 } SHAPE, * LPSHAPE;
 269
 270 // Shapes
 271
 272 int   swf_ShapeNew(SHAPE ** s);
 273 void  swf_ShapeFree(SHAPE * s);
 274
 275 int   swf_GetSimpleShape(TAG * t,SHAPE ** s); // without Linestyle/Fillstyle Record
 276 int   swf_SetSimpleShape(TAG * t,SHAPE * s);   // without Linestyle/Fillstyle Record
 277
 278 int   swf_ShapeAddLineStyle(SHAPE * s,U16 width,RGBA * color);
 279 int   swf_ShapeAddSolidFillStyle(SHAPE * s,RGBA * color);
 280 int   swf_ShapeAddBitmapFillStyle(SHAPE * s,MATRIX * m,U16 id_bitmap,int clip);
 281
 282 int   swf_SetShapeStyles(TAG * t,SHAPE * s);
 283 int   swf_ShapeCountBits(SHAPE * s,U8 * fbits,U8 * lbits);
 284 int   swf_SetShapeBits(TAG * t,SHAPE * s);
 285 int   swf_SetShapeHeader(TAG * t,SHAPE * s); // one call for upper three functions
 286
 287 int   swf_ShapeSetMove(TAG * t,SHAPE * s,S32 x,S32 y);
 288 int   swf_ShapeSetStyle(TAG * t,SHAPE * s,U16 line,U16 fill0,U16 fill1);
 289 int   swf_ShapeSetAll(TAG * t,SHAPE * s,S32 x,S32 y,U16 line,U16 fill0,U16 fill1);
 290
 291 int   swf_ShapeSetLine(TAG * t,SHAPE * s,S32 x,S32 y);
 292 int   swf_ShapeSetCurve(TAG * t,SHAPE * s,S32 x,S32 y,S32 ax,S32 ay);
 293 int   swf_ShapeSetCircle(TAG * t,SHAPE * s,S32 x,S32 y,S32 rx,S32 ry);
 294 int   swf_ShapeSetEnd(TAG * t);
 295
 296
 297 // swffont.c
 298
 299 // does not support wide characters !
 300
 301 #define MAX_CHAR_PER_FONT 256
 302
 303 typedef struct _SWFLAYOUT
 304 { S16         ascent;
 305   S16         descent;
 306   S16         leading;
 307   SRECT       bounds[MAX_CHAR_PER_FONT];
 308   struct
 309   { U16       count;
 310     U8 *      data;  // size = count*4 bytes
 311   } kerning;
 312 } SWFLAYOUT, * LPSWFLAYOUT;
 313
 314 typedef struct _SWFFONT
 315 { U16           id;
 316   U8 *          name;
 317   SWFLAYOUT *   layout;
 318
 319   U8            flags; // bold/italic/unicode/ansi ...
 320
 321   U16           codes[MAX_CHAR_PER_FONT];
 322
 323   struct
 324   { U16         advance;
 325     U16         gid;            // Glyph-ID after DefineFont
 326     SHAPE *     shape;
 327   }             glyph[MAX_CHAR_PER_FONT];
 328 } SWFFONT, * LPSWFFONT;
 329
 330 typedef struct _FONTUSAGE
 331 { U8 code[MAX_CHAR_PER_FONT];
 332 } FONTUSAGE, * LPFONTUSAGE;
 333
 334 int swf_FontEnumerate(SWF * swf,void (*FontCallback) (U16,U8*));
 335 // -> void fontcallback(U16 id,U8 * name); returns number of defined fonts
 336
 337 int swf_FontExtract(SWF * swf,int id,SWFFONT ** f);
 338 // Fetches all available information from DefineFont, DefineFontInfo, DefineText, ...
 339 // id = FontID, id=0 -> Extract first Font
 340
 341 int swf_FontIsItalic(SWFFONT * f);
 342 int swf_FontIsBold(SWFFONT * f);
 343
 344 int swf_FontSetID(SWFFONT * f,U16 id);
 345 int swf_FontReduce(SWFFONT * f,FONTUSAGE * use);
 346
 347 int swf_FontInitUsage(FONTUSAGE * use);
 348 int swf_FontUse(FONTUSAGE * use,U8 * s);
 349
 350 int swf_FontSetDefine(TAG * t,SWFFONT * f);
 351 int swf_FontSetInfo(TAG * t,SWFFONT * f);
 352
 353 int swf_FontExport(int handle,SWFFONT * f);
 354 int swf_FontImport(int handle,SWFFONT * * f);
 355
 356 void swf_FontFree(SWFFONT * f);
 357
 358 U32 swf_TextGetWidth(SWFFONT * font,U8 * s,int scale);
 359 int swf_TextCountBits(SWFFONT * font,U8 * s,int scale,U8 * gbits,U8 * abits);
 360
 361 int swf_TextSetInfoRecord(TAG * t,SWFFONT * font,U16 size,RGBA * color,S16 dx,S16 dy);
 362 int swf_TextSetCharRecord(TAG * t,SWFFONT * font,U8 * s,int scale,U8 gbits,U8 abits);
 363
 364 int swf_TextPrintDefineText(TAG * t,SWFFONT * f);
 365 // Prints text defined in tag t with font f to stdout
 366
 367
 368 // swfobject.c
 369
 370 // Always use ST_PLACEOBJECT2 !!!
 371
 372 int swf_ObjectPlace(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name);
 373 int swf_ObjectPlaceClip(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name, U16 clipaction);
 374 int swf_ObjectMove(TAG * t,U16 depth,MATRIX * m,CXFORM * cx);
 375
 376 // swfbutton.c
 377
 378 // Button States
 379
 380 #define BS_HIT          0x08
 381 #define BS_DOWN         0x04
 382 #define BS_OVER         0x02
 383 #define BS_UP           0x01
 384
 385 // Button Conditions
 386
 387 #define BC_OVERDOWN_IDLE        0x0100
 388 #define BC_IDLE_OVERDOWN        0x0080
 389 #define BC_OUTDOWN_IDLE         0x0040
 390 #define BC_OUTDOWN_OVERDOWN     0x0020
 391 #define BC_OVERDOWN_OUTDOWN     0x0010
 392 #define BC_OVERDOWN_OVERUP      0x0008
 393 #define BC_OVERUP_OVERDOWN      0x0004
 394 #define BC_OVERUP_IDLE          0x0002
 395 #define BC_IDLE_OVERUP          0x0001
 396
 397 #define BC_KEY(c) (c<<9)
 398
 399 #define BC_CURSORLEFT           0x0200
 400 #define BC_CURSORRIGHT          0x0400
 401 #define BC_POS1                 0x0600
 402 #define BC_END                  0x0800
 403 #define BC_INSERT               0x0a00
 404 #define BC_DELETE               0x0c00
 405 #define BC_BACKSPACE            0x1000
 406 #define BC_ENTER                0x1a00
 407 #define BC_CURSORUP             0x1c00
 408 #define BC_CURSORDOWN           0x1e00
 409 #define BC_PAGEUP               0x2000
 410 #define BC_PAGEDOWN             0x2200
 411 #define BC_TAB                  0x2400
 412 #define BC_SPACE                0x4000
 413
 414 // Button Flag
 415
 416 #define BF_TRACKMENU            0x01
 417
 418 int swf_ButtonSetRecord(TAG * t,U8 state,U16 id,U16 layer,MATRIX * m,CXFORM * cx);
 419 int swf_ButtonSetCondition(TAG * t,U16 condition); // for DefineButton2
 420 int swf_ButtonSetFlags(TAG * t,U8 flags);  // necessary for DefineButton2
 421 int swf_ButtonPostProcess(TAG * t,int anz_action); // Set all offsets in DefineButton2-Tags (how many conditions to process)
 422
 423 // swfbits.c
 424
 425 typedef int JPEGBITS,* LPJPEGBITS; // cover libjpeg structures
 426
 427 JPEGBITS * swf_SetJPEGBitsStart(TAG * t,int width,int height,int quality);
 428 int swf_SetJPEGBitsLines(JPEGBITS * jpegbits,U8 ** data,int n);
 429 int swf_SetJPEGBitsLine(JPEGBITS * jpegbits,U8 * data);
 430 int swf_SetJPEGBitsFinish(JPEGBITS * jpegbits);
 431
 432 int swf_SetJPEGBits(TAG * t,char * fname,int quality); // paste jpg file into swf stream
 433
 434 #define BYTES_PER_SCANLINE(width) ((width+3)&0xfffffffc)
 435
 436 #define BMF_8BIT        3               // Bitmap formats
 437 #define BMF_16BIT       4
 438 #define BMF_32BIT       5
 439
 440 #define BM16_BLUE       0xf800          // Bitmasks for 16 Bit Color
 441 #define BM16_RED        0x00f0
 442 #define BM16_GREEN      0x000f
 443
 444 #define BM32_BLUE       0xff000000      // Bitmasks for 32 Bit Color
 445 #define BM32_GREEN      0x00ff0000
 446 #define BM32_RED        0x0000ff00
 447
 448 int swf_SetLosslessBits(TAG * t,U16 width,U16 height,void * bitmap,U8 bitmap_flags);
 449 int swf_SetLosslessBitsIndexed(TAG * t,U16 width,U16 height,U8 * bitmap,RGBA * palette,U16 ncolors);
 450 int swf_SetLosslessBitsGrayscale(TAG * t,U16 width,U16 height,U8 * bitmap);
 451
 452 // swftools.c
 453
 454 U8 swf_isDefiningTag(TAG * t);
 455 U8 swf_isAllowedSpriteTag(TAG * t);
 456 U16 swf_GetDefineID(TAG * t);
 457 U16 swf_GetPlaceID(TAG * t); //PLACEOBJECT, PLACEOBJECT2 (sometimes), REMOVEOBJECT
 458 U16 swf_GetDepth(TAG * t); //PLACEOBJECT,PLACEOBJECT2,REMOVEOBJECT,REMOVEOBJECT2
 459 char* swf_GetTagName(TAG * t); //PLACEOBJECT2, FRAMELABEL
 460 MATRIX * swf_MatrixJoin(MATRIX * d,MATRIX * s1,MATRIX * s2);
 461 MATRIX * swf_MatrixMapTriangle(MATRIX * m,int dx,int dy,
 462                     int x0,int y0,int x1,int y1,int x2,int y2);
 463
 464
 465 // swfcgi.c
 466
 467 void swf_uncgi();  // same behaviour as Steven Grimm's uncgi-library
 468
 469 // swfaction.c
 470
 471 ActionTAG* swf_GetActions(TAG*tag);
 472 void swf_DumpActions(ActionTAG*atag, char*prefix);
 473
 474 #endif