3 Headers for rfxswf.c and modules
5 Part of the swftools package.
7 Copyright (c) 2000, 2001 Rainer Böhme <rfxswf@reflex-studio.de>
9 This file is distributed under the GPL, see file COPYING for details
13 #ifndef __RFX_SWF_INCLUDED__
14 #define __RFX_SWF_INCLUDED__
19 #include "../config.h"
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;
36 typedef struct _SPOINT
55 typedef struct _MATRIX
56 { SFIXED sx; // factor x
58 SFIXED r0; // rotation
64 typedef struct _CXFORM
71 typedef struct _TAG // NEVER access a Tag-Struct directly !
74 U32 memsize; // to minimize realloc() calls
77 { U32 len; // for Set-Access
82 { U32 pos; // for Get-Access
86 int frame; // not really up-to-date
91 U8 readBit; // for Bit-Manipulating Functions [read]
92 U8 writeBit; // [write]
96 typedef struct _ActionTAG
101 struct _ActionTAG * next;
102 struct _ActionTAG * prev;
104 TAG* parent; // may be null
105 U8 tmp[4]; // store small operands here.
111 U32 fileSize; // valid after load and save
114 U16 frameCount; // valid after load and save
120 int swf_ReadSWF(int handle,SWF * swf); // Reads SWF to memory (malloc'ed), returns length or <0 if fails
121 int swf_WriteSWF(int handle,SWF * swf); // Writes SWF to file, returns length or <0 if fails
122 int swf_WriteCGI(SWF * swf); // Outputs SWF with valid CGI header to stdout
123 void swf_FreeTags(SWF * swf); // Frees all malloc'ed memory for swf
125 TAG * swf_InsertTag(TAG * after,U16 id); // updates frames, if necessary
126 int swf_DeleteTag(TAG * t);
128 void swf_SetTagPos(TAG * t,U32 pos); // resets Bitcount
129 U32 swf_GetTagPos(TAG * t);
131 TAG * swf_NextTag(TAG * t);
132 TAG * swf_PrevTag(TAG * t);
134 int swf_GetFrameNo(TAG * t); // should be renamed to TagGetFrame
135 U16 swf_GetTagID(TAG * t); // ... TagGetID
136 U32 swf_GetDataSize(TAG * t); // ... TagGetDataSize
137 U8* swf_GetDataSizePtr(TAG * t);
139 U32 swf_GetBits(TAG * t,int nbits);
140 S32 swf_GetSBits(TAG * t,int nbits);
141 int swf_SetBits(TAG * t,U32 v,int nbits);
143 int swf_GetBlock(TAG * t,U8 * b,int l); // resets Bitcount
144 int swf_SetBlock(TAG * t,U8 * b,int l);
146 U8 swf_GetU8(TAG * t); // resets Bitcount
147 U16 swf_GetU16(TAG * t);
148 U32 swf_GetU32(TAG * t);
150 int swf_SetU8(TAG * t,U8 v); // resets Bitcount
151 int swf_SetU16(TAG * t,U16 v);
152 int swf_SetU32(TAG * t,U32 v);
154 int swf_GetPoint(TAG * t,SPOINT * p); // resets Bitcount
155 int swf_GetRect(TAG * t,SRECT * r);
156 int swf_GetMatrix(TAG * t,MATRIX * m);
157 int swf_GetCXForm(TAG * t,CXFORM * cx,U8 alpha);
159 int swf_SetPoint(TAG * t,SPOINT * p); // resets Bitcount
160 int swf_SetRect(TAG * t,SRECT * r);
161 int swf_SetMatrix(TAG * t,MATRIX * m);
162 int swf_SetCXForm(TAG * t,CXFORM * cx,U8 alpha);
163 int swf_SetRGB(TAG * t,RGBA * col);
164 int swf_SetRGBA(TAG * t,RGBA * col);
168 #define swf_GetS8(tag) ((S8)swf_GetU8(tag))
169 #define swf_GetS16(tag) ((S16)swf_GetU16(tag))
170 #define swf_GetS32(tag) ((S32)swf_GetU32(tag))
171 #define swf_GetCoord(tag) ((SCOORD)swf_GetU32(tag))
172 #define swf_GetFixed(tag) ((SFIXED)swf_GetU32(tag))
174 #define swf_SetS8(tag,v) swf_SetU8(tag,(U8)v)
175 #define swf_SetS16(tag,v) swf_SetU16(tag,(U16)v)
176 #define swf_SetS32(tag,v) swf_SetU32(tag,(U32)v)
177 #define swf_SetCoord(tag,v) swf_SetU32(tag,(U32)v)
178 #define swf_SetFixed(tag,v) swf_SetU32(tag,(U32)v)
179 #define swf_SetString(t,s) swf_SetBlock(t,s,strlen(s)+1)
181 #define FAILED(b) ((b)<0)
182 #define SUCCEDED(b) ((b)>=0)
184 // Tag IDs (adopted from J. C. Kessels' Form2Flash)
187 #define ST_SHOWFRAME 1
188 #define ST_DEFINESHAPE 2
189 #define ST_FREECHARACTER 3
190 #define ST_PLACEOBJECT 4
191 #define ST_REMOVEOBJECT 5
192 #define ST_DEFINEBITS 6
193 #define ST_DEFINEBUTTON 7
194 #define ST_JPEGTABLES 8
195 #define ST_SETBACKGROUNDCOLOR 9
196 #define ST_DEFINEFONT 10
197 #define ST_DEFINETEXT 11
198 #define ST_DOACTION 12
199 #define ST_DEFINEFONTINFO 13
200 #define ST_DEFINESOUND 14 /* Event sound tags. */
201 #define ST_STARTSOUND 15
202 #define ST_DEFINEBUTTONSOUND 17
203 #define ST_SOUNDSTREAMHEAD 18
204 #define ST_SOUNDSTREAMBLOCK 19
205 #define ST_DEFINEBITSLOSSLESS 20 /* A bitmap using lossless zlib compression. */
206 #define ST_DEFINEBITSJPEG2 21 /* A bitmap using an internal JPEG compression table. */
207 #define ST_DEFINESHAPE2 22
208 #define ST_DEFINEBUTTONCXFORM 23
209 #define ST_PROTECT 24 /* This file should not be importable for editing. */
210 #define ST_PLACEOBJECT2 26 /* The new style place w/ alpha color transform and name. */
211 #define ST_REMOVEOBJECT2 28 /* A more compact remove object that omits the character tag (just depth). */
212 #define ST_DEFINESHAPE3 32 /* A shape V3 includes alpha values. */
213 #define ST_DEFINETEXT2 33 /* A text V2 includes alpha values. */
214 #define ST_DEFINEBUTTON2 34 /* A button V2 includes color transform, alpha and multiple actions */
215 #define ST_DEFINEBITSJPEG3 35 /* A JPEG bitmap with alpha info. */
216 #define ST_DEFINEBITSLOSSLESS2 36 /* A lossless bitmap with alpha info. */
217 #define ST_DEFINEEDITTEXT 37
218 #define ST_DEFINEMOVIE 38
219 #define ST_DEFINESPRITE 39 /* Define a sequence of tags that describe the behavior of a sprite. */
220 #define ST_NAMECHARACTER 40 /* Name a character definition, character id and a string, (used for buttons, bitmaps, sprites and sounds). */
221 #define ST_SERIALNUMBER 41
222 #define ST_GENERATORTEXT 42 /* contains an id */
223 #define ST_FRAMELABEL 43 /* A string label for the current frame. */
224 #define ST_SOUNDSTREAMHEAD2 45 /* For lossless streaming sound, should not have needed this... */
225 #define ST_DEFINEMORPHSHAPE 46 /* A morph shape definition */
226 #define ST_DEFINEFONT2 48
227 #define ST_TEMPLATECOMMAND 49
228 #define ST_GENERATOR3 51
229 #define ST_EXTERNALFONT 52
231 #define ST_REFLEX 777 /* to identify generator software */
237 void swf_DumpHeader(FILE * f,SWF * swf);
238 void swf_DumpMatrix(FILE * f,MATRIX * m);
239 void swf_DumpTag(FILE * f,TAG * t);
240 char* swf_TagGetName(TAG*tag);
244 typedef struct _LINESTYLE
247 } LINESTYLE, * LPLINESTYLE;
249 typedef struct _FILLSTYLE
254 } FILLSTYLE, * LPFILLSTYLE;
256 typedef struct _SHAPE // NEVER access a Shape-Struct directly !
262 // note: changes of shape structure
263 struct // lead to incompatible .efont formats
277 U32 bitlen; // length of data in bits
282 int swf_ShapeNew(SHAPE ** s);
283 void swf_ShapeFree(SHAPE * s);
285 int swf_GetSimpleShape(TAG * t,SHAPE ** s); // without Linestyle/Fillstyle Record
286 int swf_SetSimpleShape(TAG * t,SHAPE * s); // without Linestyle/Fillstyle Record
288 int swf_ShapeAddLineStyle(SHAPE * s,U16 width,RGBA * color);
289 int swf_ShapeAddSolidFillStyle(SHAPE * s,RGBA * color);
290 int swf_ShapeAddBitmapFillStyle(SHAPE * s,MATRIX * m,U16 id_bitmap,int clip);
292 int swf_SetShapeStyles(TAG * t,SHAPE * s);
293 int swf_ShapeCountBits(SHAPE * s,U8 * fbits,U8 * lbits);
294 int swf_SetShapeBits(TAG * t,SHAPE * s);
295 int swf_SetShapeHeader(TAG * t,SHAPE * s); // one call for upper three functions
297 int swf_ShapeSetMove(TAG * t,SHAPE * s,S32 x,S32 y);
298 int swf_ShapeSetStyle(TAG * t,SHAPE * s,U16 line,U16 fill0,U16 fill1);
299 int swf_ShapeSetAll(TAG * t,SHAPE * s,S32 x,S32 y,U16 line,U16 fill0,U16 fill1);
301 int swf_ShapeSetLine(TAG * t,SHAPE * s,S32 x,S32 y);
302 int swf_ShapeSetCurve(TAG * t,SHAPE * s,S32 x,S32 y,S32 ax,S32 ay);
303 int swf_ShapeSetCircle(TAG * t,SHAPE * s,S32 x,S32 y,S32 rx,S32 ry);
304 int swf_ShapeSetEnd(TAG * t);
309 // does not support wide characters !
311 #define MAX_CHAR_PER_FONT 256
313 typedef struct _SWFLAYOUT
317 SRECT bounds[MAX_CHAR_PER_FONT];
320 U8 * data; // size = count*4 bytes
322 } SWFLAYOUT, * LPSWFLAYOUT;
324 typedef struct _SWFFONT
329 U8 flags; // bold/italic/unicode/ansi ...
331 U16 codes[MAX_CHAR_PER_FONT];
335 U16 gid; // Glyph-ID after DefineFont
337 } glyph[MAX_CHAR_PER_FONT];
338 } SWFFONT, * LPSWFFONT;
340 typedef struct _FONTUSAGE
341 { U8 code[MAX_CHAR_PER_FONT];
342 } FONTUSAGE, * LPFONTUSAGE;
344 int swf_FontEnumerate(SWF * swf,void (*FontCallback) (U16,U8*));
345 // -> void fontcallback(U16 id,U8 * name); returns number of defined fonts
347 int swf_FontExtract(SWF * swf,int id,SWFFONT ** f);
348 // Fetches all available information from DefineFont, DefineFontInfo, DefineText, ...
349 // id = FontID, id=0 -> Extract first Font
351 int swf_FontIsItalic(SWFFONT * f);
352 int swf_FontIsBold(SWFFONT * f);
354 int swf_FontSetID(SWFFONT * f,U16 id);
355 int swf_FontReduce(SWFFONT * f,FONTUSAGE * use);
357 int swf_FontInitUsage(FONTUSAGE * use);
358 int swf_FontUse(FONTUSAGE * use,U8 * s);
360 int swf_FontSetDefine(TAG * t,SWFFONT * f);
361 int swf_FontSetInfo(TAG * t,SWFFONT * f);
363 int swf_FontExport(int handle,SWFFONT * f);
364 int swf_FontImport(int handle,SWFFONT * * f);
366 void swf_FontFree(SWFFONT * f);
368 U32 swf_TextGetWidth(SWFFONT * font,U8 * s,int scale);
369 int swf_TextCountBits(SWFFONT * font,U8 * s,int scale,U8 * gbits,U8 * abits);
371 int swf_TextSetInfoRecord(TAG * t,SWFFONT * font,U16 size,RGBA * color,S16 dx,S16 dy);
372 int swf_TextSetCharRecord(TAG * t,SWFFONT * font,U8 * s,int scale,U8 gbits,U8 abits);
374 int swf_TextPrintDefineText(TAG * t,SWFFONT * f);
375 // Prints text defined in tag t with font f to stdout
380 // Always use ST_PLACEOBJECT2 !!!
382 int swf_ObjectPlace(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name);
383 int swf_ObjectPlaceClip(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name, U16 clipaction);
384 int swf_ObjectMove(TAG * t,U16 depth,MATRIX * m,CXFORM * cx);
397 #define BC_OVERDOWN_IDLE 0x0100
398 #define BC_IDLE_OVERDOWN 0x0080
399 #define BC_OUTDOWN_IDLE 0x0040
400 #define BC_OUTDOWN_OVERDOWN 0x0020
401 #define BC_OVERDOWN_OUTDOWN 0x0010
402 #define BC_OVERDOWN_OVERUP 0x0008
403 #define BC_OVERUP_OVERDOWN 0x0004
404 #define BC_OVERUP_IDLE 0x0002
405 #define BC_IDLE_OVERUP 0x0001
407 #define BC_KEY(c) (c<<9)
409 #define BC_CURSORLEFT 0x0200
410 #define BC_CURSORRIGHT 0x0400
411 #define BC_POS1 0x0600
412 #define BC_END 0x0800
413 #define BC_INSERT 0x0a00
414 #define BC_DELETE 0x0c00
415 #define BC_BACKSPACE 0x1000
416 #define BC_ENTER 0x1a00
417 #define BC_CURSORUP 0x1c00
418 #define BC_CURSORDOWN 0x1e00
419 #define BC_PAGEUP 0x2000
420 #define BC_PAGEDOWN 0x2200
421 #define BC_TAB 0x2400
422 #define BC_SPACE 0x4000
426 #define BF_TRACKMENU 0x01
428 int swf_ButtonSetRecord(TAG * t,U8 state,U16 id,U16 layer,MATRIX * m,CXFORM * cx);
429 int swf_ButtonSetCondition(TAG * t,U16 condition); // for DefineButton2
430 int swf_ButtonSetFlags(TAG * t,U8 flags); // necessary for DefineButton2
431 int swf_ButtonPostProcess(TAG * t,int anz_action); // Set all offsets in DefineButton2-Tags (how many conditions to process)
435 typedef int JPEGBITS,* LPJPEGBITS; // cover libjpeg structures
437 JPEGBITS * swf_SetJPEGBitsStart(TAG * t,int width,int height,int quality);
438 int swf_SetJPEGBitsLines(JPEGBITS * jpegbits,U8 ** data,int n);
439 int swf_SetJPEGBitsLine(JPEGBITS * jpegbits,U8 * data);
440 int swf_SetJPEGBitsFinish(JPEGBITS * jpegbits);
442 int swf_SetJPEGBits(TAG * t,char * fname,int quality); // paste jpg file into swf stream
444 #define BYTES_PER_SCANLINE(width) ((width+3)&0xfffffffc)
446 #define BMF_8BIT 3 // Bitmap formats
450 #define BM16_BLUE 0xf800 // Bitmasks for 16 Bit Color
451 #define BM16_RED 0x00f0
452 #define BM16_GREEN 0x000f
454 #define BM32_BLUE 0xff000000 // Bitmasks for 32 Bit Color
455 #define BM32_GREEN 0x00ff0000
456 #define BM32_RED 0x0000ff00
458 int swf_SetLosslessBits(TAG * t,U16 width,U16 height,void * bitmap,U8 bitmap_flags);
459 int swf_SetLosslessBitsIndexed(TAG * t,U16 width,U16 height,U8 * bitmap,RGBA * palette,U16 ncolors);
460 int swf_SetLosslessBitsGrayscale(TAG * t,U16 width,U16 height,U8 * bitmap);
464 U8 swf_isDefiningTag(TAG * t);
465 U8 swf_isAllowedSpriteTag(TAG * t);
466 U16 swf_GetDefineID(TAG * t);
467 U16 swf_GetPlaceID(TAG * t); //PLACEOBJECT, PLACEOBJECT2 (sometimes), REMOVEOBJECT
468 U16 swf_GetDepth(TAG * t); //PLACEOBJECT,PLACEOBJECT2,REMOVEOBJECT,REMOVEOBJECT2
469 char* swf_GetName(TAG * t); //PLACEOBJECT2, FRAMELABEL
470 MATRIX * swf_MatrixJoin(MATRIX * d,MATRIX * s1,MATRIX * s2);
471 MATRIX * swf_MatrixMapTriangle(MATRIX * m,int dx,int dy,
472 int x0,int y0,int x1,int y1,int x2,int y2);
477 void swf_uncgi(); // same behaviour as Steven Grimm's uncgi-library
481 ActionTAG* swf_GetActions(TAG*tag);
482 void swf_SetActions(TAG*tag, ActionTAG*actions);
483 void swf_DumpActions(ActionTAG*atag, char*prefix);
484 void swf_ActionEnumerateURLs(ActionTAG*atag, char*(*callback)(char*));
485 void swf_ActionEnumerateTargets(ActionTAG*atag, char*(*callback)(char*));
486 void swf_ActionEnumerateStrings(ActionTAG*atag, char*(*callback)(char*));
488 ActionTAG* swf_ActionStart();
490 void action_NextFrame();
491 void action_PreviousFrame();
494 void action_ToggleQuality();
495 void action_StopSounds();
497 void action_Subtract();
498 void action_Multiply();
499 void action_Divide();
500 void action_Equals();
505 void action_StringEquals();
506 void action_StringLength();
507 void action_StringExtract();
509 void action_ToInteger();
510 void action_GetVariable();
511 void action_SetVariable();
512 void action_SetTarget2();
513 void action_StringAdd();
514 void action_GetProperty();
515 void action_SetProperty();
516 void action_CloneSprite();
517 void action_RemoveSprite();
519 void action_StartDrag();
520 void action_EndDrag();
521 void action_StringLess();
522 void action_RandomNumber();
523 void action_MBStringLength();
524 void action_CharToAscii();
525 void action_AsciiToChar();
526 void action_GetTime();
527 void action_MBStringExtract();
528 void action_MBCharToAscii();
529 void action_MBAsciiToChar();
530 void action_Delete();
531 void action_Delete2();
532 void action_DefineLocal();
533 void action_CallFunction();
534 void action_Return();
535 void action_Modulo();
536 void action_NewObject();
537 void action_DefineLocal2();
538 void action_InitArray();
539 void action_Makehash();
540 void action_TypeOf();
541 void action_TargetPath();
542 void action_Enumerate();
545 void action_Equals2();
546 void action_ToNumber();
547 void action_ToString();
548 void action_PushDuplicate();
549 void action_StackSwap();
550 void action_GetMember();
551 void action_SetMember();
552 void action_Increment();
553 void action_Decrement();
554 void action_CallMethod();
555 void action_NewMethod();
556 void action_BitAnd();
558 void action_BitXor();
559 void action_BitLShift();
560 void action_BitRShift();
561 void action_BitURShift();
562 void action_GotoFrame(U16 frame);
563 void action_GetUrl(char* url, char* label);
564 void action_StoreRegister(U8 reg);
565 void action_Constantpool(char* constantpool);
566 void action_WaitForFrame(U16 frame, U8 skip);
567 void action_SetTarget(char* target);
568 void action_GotoLabel(char* label);
569 void action_WaitForFrame2(U8 skip);
570 void action_With(char*object);
571 void action_PushString(char*str);
572 void action_PushFloat(float f);
573 void action_PushNULL();
574 void action_PushRegister(U8 reg);
575 void action_PushBoolean(char c);
576 void action_PushDouble(double d);
577 void action_PushInt(int i);
578 void action_PushLookup(U8 index);
579 void action_Jump(U16 branch);
580 void action_GetUrl2(U8 method);
581 void action_DefineFunction(U8*data, int len);
582 void action_If(U16 branch);
584 void action_GotoFrame2(U8 method);
585 void swf_ActionEnd();