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
76 U32 len; // for Set-Access
77 U32 pos; // for Get-Access
79 int frame; // not really up-to-date
84 U8 readBit; // for Bit-Manipulating Functions [read]
85 U8 writeBit; // [write]
89 typedef struct _ActionTAG
94 struct _ActionTAG * next;
95 struct _ActionTAG * prev;
97 TAG* parent; // may be null
98 U8 tmp[4]; // store small operands here.
104 U32 fileSize; // valid after load and save
107 U16 frameCount; // valid after load and save
113 int swf_ReadSWF(int handle,SWF * swf); // Reads SWF to memory (malloc'ed), returns length or <0 if fails
114 int swf_WriteSWF(int handle,SWF * swf); // Writes SWF to file, returns length or <0 if fails
115 int swf_WriteCGI(SWF * swf); // Outputs SWF with valid CGI header to stdout
116 void swf_FreeTags(SWF * swf); // Frees all malloc'ed memory for swf
118 TAG * swf_InsertTag(TAG * after,U16 id); // updates frames, if necessary
119 int swf_DeleteTag(TAG * t);
121 void swf_SetTagPos(TAG * t,U32 pos); // resets Bitcount
122 U32 swf_GetTagPos(TAG * t);
124 TAG * swf_NextTag(TAG * t);
125 TAG * swf_PrevTag(TAG * t);
127 int swf_GetFrameNo(TAG * t); // should be renamed to TagGetFrame
128 U16 swf_GetTagID(TAG * t); // ... TagGetID
129 U32 swf_GetDataSize(TAG * t); // ... TagGetDataSize
130 U8* swf_GetDataSizePtr(TAG * t);
132 U32 swf_GetBits(TAG * t,int nbits);
133 S32 swf_GetSBits(TAG * t,int nbits);
134 int swf_SetBits(TAG * t,U32 v,int nbits);
136 int swf_GetBlock(TAG * t,U8 * b,int l); // resets Bitcount
137 int swf_SetBlock(TAG * t,U8 * b,int l);
139 U8 swf_GetU8(TAG * t); // resets Bitcount
140 U16 swf_GetU16(TAG * t);
141 U32 swf_GetU32(TAG * t);
143 int swf_SetU8(TAG * t,U8 v); // resets Bitcount
144 int swf_SetU16(TAG * t,U16 v);
145 int swf_SetU32(TAG * t,U32 v);
147 int swf_GetPoint(TAG * t,SPOINT * p); // resets Bitcount
148 int swf_GetRect(TAG * t,SRECT * r);
149 int swf_GetMatrix(TAG * t,MATRIX * m);
150 int swf_GetCXForm(TAG * t,CXFORM * cx,U8 alpha);
152 int swf_SetPoint(TAG * t,SPOINT * p); // resets Bitcount
153 int swf_SetRect(TAG * t,SRECT * r);
154 int swf_SetMatrix(TAG * t,MATRIX * m);
155 int swf_SetCXForm(TAG * t,CXFORM * cx,U8 alpha);
156 int swf_SetRGB(TAG * t,RGBA * col);
157 int swf_SetRGBA(TAG * t,RGBA * col);
161 #define swf_GetS8(tag) ((S8)swf_GetU8(tag))
162 #define swf_GetS16(tag) ((S16)swf_GetU16(tag))
163 #define swf_GetS32(tag) ((S32)swf_GetU32(tag))
164 #define swf_GetCoord(tag) ((SCOORD)swf_GetU32(tag))
165 #define swf_GetFixed(tag) ((SFIXED)swf_GetU32(tag))
167 #define swf_SetS8(tag,v) swf_SetU8(tag,(U8)v)
168 #define swf_SetS16(tag,v) swf_SetU16(tag,(U16)v)
169 #define swf_SetS32(tag,v) swf_SetU32(tag,(U32)v)
170 #define swf_SetCoord(tag,v) swf_SetU32(tag,(U32)v)
171 #define swf_SetFixed(tag,v) swf_SetU32(tag,(U32)v)
172 #define swf_SetString(t,s) swf_SetBlock(t,s,strlen(s)+1)
174 #define FAILED(b) ((b)<0)
175 #define SUCCEDED(b) ((b)>=0)
177 // Tag IDs (adopted from J. C. Kessels' Form2Flash)
180 #define ST_SHOWFRAME 1
181 #define ST_DEFINESHAPE 2
182 #define ST_FREECHARACTER 3
183 #define ST_PLACEOBJECT 4
184 #define ST_REMOVEOBJECT 5
185 #define ST_DEFINEBITS 6
186 #define ST_DEFINEBUTTON 7
187 #define ST_JPEGTABLES 8
188 #define ST_SETBACKGROUNDCOLOR 9
189 #define ST_DEFINEFONT 10
190 #define ST_DEFINETEXT 11
191 #define ST_DOACTION 12
192 #define ST_DEFINEFONTINFO 13
193 #define ST_DEFINESOUND 14 /* Event sound tags. */
194 #define ST_STARTSOUND 15
195 #define ST_DEFINEBUTTONSOUND 17
196 #define ST_SOUNDSTREAMHEAD 18
197 #define ST_SOUNDSTREAMBLOCK 19
198 #define ST_DEFINEBITSLOSSLESS 20 /* A bitmap using lossless zlib compression. */
199 #define ST_DEFINEBITSJPEG2 21 /* A bitmap using an internal JPEG compression table. */
200 #define ST_DEFINESHAPE2 22
201 #define ST_DEFINEBUTTONCXFORM 23
202 #define ST_PROTECT 24 /* This file should not be importable for editing. */
203 #define ST_PLACEOBJECT2 26 /* The new style place w/ alpha color transform and name. */
204 #define ST_REMOVEOBJECT2 28 /* A more compact remove object that omits the character tag (just depth). */
205 #define ST_DEFINESHAPE3 32 /* A shape V3 includes alpha values. */
206 #define ST_DEFINETEXT2 33 /* A text V2 includes alpha values. */
207 #define ST_DEFINEBUTTON2 34 /* A button V2 includes color transform, alpha and multiple actions */
208 #define ST_DEFINEBITSJPEG3 35 /* A JPEG bitmap with alpha info. */
209 #define ST_DEFINEBITSLOSSLESS2 36 /* A lossless bitmap with alpha info. */
210 #define ST_DEFINEEDITTEXT 37
211 #define ST_DEFINEMOVIE 38
212 #define ST_DEFINESPRITE 39 /* Define a sequence of tags that describe the behavior of a sprite. */
213 #define ST_NAMECHARACTER 40 /* Name a character definition, character id and a string, (used for buttons, bitmaps, sprites and sounds). */
214 #define ST_SERIALNUMBER 41
215 #define ST_GENERATORTEXT 42 /* contains an id */
216 #define ST_FRAMELABEL 43 /* A string label for the current frame. */
217 #define ST_SOUNDSTREAMHEAD2 45 /* For lossless streaming sound, should not have needed this... */
218 #define ST_DEFINEMORPHSHAPE 46 /* A morph shape definition */
219 #define ST_DEFINEFONT2 48
220 #define ST_TEMPLATECOMMAND 49
221 #define ST_GENERATOR3 51
222 #define ST_EXTERNALFONT 52
224 #define ST_REFLEX 777 /* to identify generator software */
230 void swf_DumpHeader(FILE * f,SWF * swf);
231 void swf_DumpMatrix(FILE * f,MATRIX * m);
232 void swf_DumpTag(FILE * f,TAG * t);
233 char* swf_TagGetName(TAG*tag);
237 typedef struct _LINESTYLE
240 } LINESTYLE, * LPLINESTYLE;
242 typedef struct _FILLSTYLE
247 } FILLSTYLE, * LPFILLSTYLE;
249 typedef struct _SHAPE // NEVER access a Shape-Struct directly !
255 // note: changes of shape structure
256 struct // lead to incompatible .efont formats
270 U32 bitlen; // length of data in bits
275 int swf_ShapeNew(SHAPE ** s);
276 void swf_ShapeFree(SHAPE * s);
278 int swf_GetSimpleShape(TAG * t,SHAPE ** s); // without Linestyle/Fillstyle Record
279 int swf_SetSimpleShape(TAG * t,SHAPE * s); // without Linestyle/Fillstyle Record
281 int swf_ShapeAddLineStyle(SHAPE * s,U16 width,RGBA * color);
282 int swf_ShapeAddSolidFillStyle(SHAPE * s,RGBA * color);
283 int swf_ShapeAddBitmapFillStyle(SHAPE * s,MATRIX * m,U16 id_bitmap,int clip);
285 int swf_SetShapeStyles(TAG * t,SHAPE * s);
286 int swf_ShapeCountBits(SHAPE * s,U8 * fbits,U8 * lbits);
287 int swf_SetShapeBits(TAG * t,SHAPE * s);
288 int swf_SetShapeHeader(TAG * t,SHAPE * s); // one call for upper three functions
290 int swf_ShapeSetMove(TAG * t,SHAPE * s,S32 x,S32 y);
291 int swf_ShapeSetStyle(TAG * t,SHAPE * s,U16 line,U16 fill0,U16 fill1);
292 int swf_ShapeSetAll(TAG * t,SHAPE * s,S32 x,S32 y,U16 line,U16 fill0,U16 fill1);
294 int swf_ShapeSetLine(TAG * t,SHAPE * s,S32 x,S32 y);
295 int swf_ShapeSetCurve(TAG * t,SHAPE * s,S32 x,S32 y,S32 ax,S32 ay);
296 int swf_ShapeSetCircle(TAG * t,SHAPE * s,S32 x,S32 y,S32 rx,S32 ry);
297 int swf_ShapeSetEnd(TAG * t);
302 // does not support wide characters !
304 #define MAX_CHAR_PER_FONT 256
306 typedef struct _SWFLAYOUT
310 SRECT bounds[MAX_CHAR_PER_FONT];
313 U8 * data; // size = count*4 bytes
315 } SWFLAYOUT, * LPSWFLAYOUT;
317 typedef struct _SWFFONT
322 U8 flags; // bold/italic/unicode/ansi ...
324 U16 codes[MAX_CHAR_PER_FONT];
328 U16 gid; // Glyph-ID after DefineFont
330 } glyph[MAX_CHAR_PER_FONT];
331 } SWFFONT, * LPSWFFONT;
333 typedef struct _FONTUSAGE
334 { U8 code[MAX_CHAR_PER_FONT];
335 } FONTUSAGE, * LPFONTUSAGE;
337 int swf_FontEnumerate(SWF * swf,void (*FontCallback) (U16,U8*));
338 // -> void fontcallback(U16 id,U8 * name); returns number of defined fonts
340 int swf_FontExtract(SWF * swf,int id,SWFFONT ** f);
341 // Fetches all available information from DefineFont, DefineFontInfo, DefineText, ...
342 // id = FontID, id=0 -> Extract first Font
344 int swf_FontIsItalic(SWFFONT * f);
345 int swf_FontIsBold(SWFFONT * f);
347 int swf_FontSetID(SWFFONT * f,U16 id);
348 int swf_FontReduce(SWFFONT * f,FONTUSAGE * use);
350 int swf_FontInitUsage(FONTUSAGE * use);
351 int swf_FontUse(FONTUSAGE * use,U8 * s);
353 int swf_FontSetDefine(TAG * t,SWFFONT * f);
354 int swf_FontSetInfo(TAG * t,SWFFONT * f);
356 int swf_FontExport(int handle,SWFFONT * f);
357 int swf_FontImport(int handle,SWFFONT * * f);
359 void swf_FontFree(SWFFONT * f);
361 U32 swf_TextGetWidth(SWFFONT * font,U8 * s,int scale);
362 int swf_TextCountBits(SWFFONT * font,U8 * s,int scale,U8 * gbits,U8 * abits);
364 int swf_TextSetInfoRecord(TAG * t,SWFFONT * font,U16 size,RGBA * color,S16 dx,S16 dy);
365 int swf_TextSetCharRecord(TAG * t,SWFFONT * font,U8 * s,int scale,U8 gbits,U8 abits);
367 int swf_TextPrintDefineText(TAG * t,SWFFONT * f);
368 // Prints text defined in tag t with font f to stdout
373 // Always use ST_PLACEOBJECT2 !!!
375 int swf_ObjectPlace(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name);
376 int swf_ObjectPlaceClip(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name, U16 clipaction);
377 int swf_ObjectMove(TAG * t,U16 depth,MATRIX * m,CXFORM * cx);
390 #define BC_OVERDOWN_IDLE 0x0100
391 #define BC_IDLE_OVERDOWN 0x0080
392 #define BC_OUTDOWN_IDLE 0x0040
393 #define BC_OUTDOWN_OVERDOWN 0x0020
394 #define BC_OVERDOWN_OUTDOWN 0x0010
395 #define BC_OVERDOWN_OVERUP 0x0008
396 #define BC_OVERUP_OVERDOWN 0x0004
397 #define BC_OVERUP_IDLE 0x0002
398 #define BC_IDLE_OVERUP 0x0001
400 #define BC_KEY(c) (c<<9)
402 #define BC_CURSORLEFT 0x0200
403 #define BC_CURSORRIGHT 0x0400
404 #define BC_POS1 0x0600
405 #define BC_END 0x0800
406 #define BC_INSERT 0x0a00
407 #define BC_DELETE 0x0c00
408 #define BC_BACKSPACE 0x1000
409 #define BC_ENTER 0x1a00
410 #define BC_CURSORUP 0x1c00
411 #define BC_CURSORDOWN 0x1e00
412 #define BC_PAGEUP 0x2000
413 #define BC_PAGEDOWN 0x2200
414 #define BC_TAB 0x2400
415 #define BC_SPACE 0x4000
419 #define BF_TRACKMENU 0x01
421 int swf_ButtonSetRecord(TAG * t,U8 state,U16 id,U16 layer,MATRIX * m,CXFORM * cx);
422 int swf_ButtonSetCondition(TAG * t,U16 condition); // for DefineButton2
423 int swf_ButtonSetFlags(TAG * t,U8 flags); // necessary for DefineButton2
424 int swf_ButtonPostProcess(TAG * t,int anz_action); // Set all offsets in DefineButton2-Tags (how many conditions to process)
428 typedef int JPEGBITS,* LPJPEGBITS; // cover libjpeg structures
430 JPEGBITS * swf_SetJPEGBitsStart(TAG * t,int width,int height,int quality);
431 int swf_SetJPEGBitsLines(JPEGBITS * jpegbits,U8 ** data,int n);
432 int swf_SetJPEGBitsLine(JPEGBITS * jpegbits,U8 * data);
433 int swf_SetJPEGBitsFinish(JPEGBITS * jpegbits);
435 int swf_SetJPEGBits(TAG * t,char * fname,int quality); // paste jpg file into swf stream
437 #define BYTES_PER_SCANLINE(width) ((width+3)&0xfffffffc)
439 #define BMF_8BIT 3 // Bitmap formats
443 #define BM16_BLUE 0xf800 // Bitmasks for 16 Bit Color
444 #define BM16_RED 0x00f0
445 #define BM16_GREEN 0x000f
447 #define BM32_BLUE 0xff000000 // Bitmasks for 32 Bit Color
448 #define BM32_GREEN 0x00ff0000
449 #define BM32_RED 0x0000ff00
451 int swf_SetLosslessBits(TAG * t,U16 width,U16 height,void * bitmap,U8 bitmap_flags);
452 int swf_SetLosslessBitsIndexed(TAG * t,U16 width,U16 height,U8 * bitmap,RGBA * palette,U16 ncolors);
453 int swf_SetLosslessBitsGrayscale(TAG * t,U16 width,U16 height,U8 * bitmap);
457 U8 swf_isDefiningTag(TAG * t);
458 U8 swf_isAllowedSpriteTag(TAG * t);
459 U16 swf_GetDefineID(TAG * t);
460 U16 swf_GetPlaceID(TAG * t); //PLACEOBJECT, PLACEOBJECT2 (sometimes), REMOVEOBJECT
461 U16 swf_GetDepth(TAG * t); //PLACEOBJECT,PLACEOBJECT2,REMOVEOBJECT,REMOVEOBJECT2
462 char* swf_GetName(TAG * t); //PLACEOBJECT2, FRAMELABEL
463 MATRIX * swf_MatrixJoin(MATRIX * d,MATRIX * s1,MATRIX * s2);
464 MATRIX * swf_MatrixMapTriangle(MATRIX * m,int dx,int dy,
465 int x0,int y0,int x1,int y1,int x2,int y2);
470 void swf_uncgi(); // same behaviour as Steven Grimm's uncgi-library
474 ActionTAG* swf_GetActions(TAG*tag);
475 void swf_SetActions(TAG*tag, ActionTAG*actions);
476 void swf_DumpActions(ActionTAG*atag, char*prefix);
477 void swf_ActionEnumerateURLs(ActionTAG*atag, char*(*callback)(char*));
478 void swf_ActionEnumerateTargets(ActionTAG*atag, char*(*callback)(char*));
479 void swf_ActionEnumerateStrings(ActionTAG*atag, char*(*callback)(char*));
481 ActionTAG* swf_ActionStart();
483 void action_NextFrame();
484 void action_PreviousFrame();
487 void action_ToggleQuality();
488 void action_StopSounds();
490 void action_Subtract();
491 void action_Multiply();
492 void action_Divide();
493 void action_Equals();
498 void action_StringEquals();
499 void action_StringLength();
500 void action_StringExtract();
502 void action_ToInteger();
503 void action_GetVariable();
504 void action_SetVariable();
505 void action_SetTarget2();
506 void action_StringAdd();
507 void action_GetProperty();
508 void action_SetProperty();
509 void action_CloneSprite();
510 void action_RemoveSprite();
512 void action_StartDrag();
513 void action_EndDrag();
514 void action_StringLess();
515 void action_RandomNumber();
516 void action_MBStringLength();
517 void action_CharToAscii();
518 void action_AsciiToChar();
519 void action_GetTime();
520 void action_MBStringExtract();
521 void action_MBCharToAscii();
522 void action_MBAsciiToChar();
523 void action_Delete();
524 void action_Delete2();
525 void action_DefineLocal();
526 void action_CallFunction();
527 void action_Return();
528 void action_Modulo();
529 void action_NewObject();
530 void action_DefineLocal2();
531 void action_InitArray();
532 void action_Makehash();
533 void action_TypeOf();
534 void action_TargetPath();
535 void action_Enumerate();
538 void action_Equals2();
539 void action_ToNumber();
540 void action_ToString();
541 void action_PushDuplicate();
542 void action_StackSwap();
543 void action_GetMember();
544 void action_SetMember();
545 void action_Increment();
546 void action_Decrement();
547 void action_CallMethod();
548 void action_NewMethod();
549 void action_BitAnd();
551 void action_BitXor();
552 void action_BitLShift();
553 void action_BitRShift();
554 void action_BitURShift();
555 void action_GotoFrame(U16 frame);
556 void action_GetUrl(char* url, char* label);
557 void action_StoreRegister(U8 reg);
558 void action_Constantpool(char* constantpool);
559 void action_WaitForFrame(U16 frame, U8 skip);
560 void action_SetTarget(char* target);
561 void action_GotoLabel(char* label);
562 void action_WaitForFrame2(U8 skip);
563 void action_With(char*object);
564 void action_PushString(char*str);
565 void action_PushFloat(float f);
566 void action_PushNULL();
567 void action_PushRegister(U8 reg);
568 void action_PushBoolean(char c);
569 void action_PushDouble(double d);
570 void action_PushInt(int i);
571 void action_PushLookup(U8 index);
572 void action_Jump(U16 branch);
573 void action_GetUrl2(U8 method);
574 void action_DefineFunction(U8*data, int len);
575 void action_If(U16 branch);
577 void action_GotoFrame2(U8 method);
578 void swf_ActionEnd();