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__
21 #include "../config.h"
32 #ifdef WORDS_BIGENDIAN
33 #define SWAP16(s) ((U16) ((U8*)&s)[0] | ((U16) ((U8*)&s)[1] << 8))
34 #define SWAP32(s) ((U32) ((U8*)&s)[0] | ((U32) ((U8*)&s)[1] << 8) | ((U32) ((U8*)&s)[2] << 16) | ((U32) ((U8*)&s)[3] << 24))
42 typedef unsigned long U32;
43 typedef signed long S32;
44 typedef unsigned short U16;
45 typedef signed short S16;
46 typedef unsigned char U8;
47 typedef signed char S8;
48 typedef signed long SFIXED;
49 typedef signed long SCOORD;
53 typedef struct _SPOINT
72 typedef struct _MATRIX
73 { SFIXED sx; // factor x
75 SFIXED r0; // rotation
81 typedef struct _CXFORM
88 typedef struct _TAG // NEVER access a Tag-Struct directly !
91 U32 memsize; // to minimize realloc() calls
93 U32 len; // for Set-Access
94 U32 pos; // for Get-Access
96 int frame; // not really up-to-date
101 U8 readBit; // for Bit-Manipulating Functions [read]
102 U8 writeBit; // [write]
106 typedef struct _ActionTAG
111 struct _ActionTAG * next;
112 struct _ActionTAG * prev;
114 TAG* parent; // may be null
115 U8 tmp[4]; // store small operands here.
118 typedef struct _ActionMarker
125 U32 fileSize; // valid after load and save
128 U16 frameCount; // valid after load and save
134 int swf_ReadSWF(int handle,SWF * swf); // Reads SWF to memory (malloc'ed), returns length or <0 if fails
135 int swf_WriteSWF(int handle,SWF * swf); // Writes SWF to file, returns length or <0 if fails
136 int swf_WriteCGI(SWF * swf); // Outputs SWF with valid CGI header to stdout
137 void swf_FreeTags(SWF * swf); // Frees all malloc'ed memory for swf
139 TAG * swf_InsertTag(TAG * after,U16 id); // updates frames, if necessary
140 int swf_DeleteTag(TAG * t);
142 void swf_SetTagPos(TAG * t,U32 pos); // resets Bitcount
143 U32 swf_GetTagPos(TAG * t);
145 TAG * swf_NextTag(TAG * t);
146 TAG * swf_PrevTag(TAG * t);
148 int swf_GetFrameNo(TAG * t); // should be renamed to TagGetFrame
149 U16 swf_GetTagID(TAG * t); // ... TagGetID
150 U32 swf_GetTagLen(TAG * t); // ... TagGetTagLen
151 U8* swf_GetTagLenPtr(TAG * t);
153 U32 swf_GetBits(TAG * t,int nbits);
154 S32 swf_GetSBits(TAG * t,int nbits);
155 int swf_SetBits(TAG * t,U32 v,int nbits);
157 int swf_GetBlock(TAG * t,U8 * b,int l); // resets Bitcount
158 int swf_SetBlock(TAG * t,U8 * b,int l);
160 U8 swf_GetU8(TAG * t); // resets Bitcount
161 U16 swf_GetU16(TAG * t);
162 U32 swf_GetU32(TAG * t);
164 int swf_SetU8(TAG * t,U8 v); // resets Bitcount
165 int swf_SetU16(TAG * t,U16 v);
166 int swf_SetU32(TAG * t,U32 v);
168 int swf_GetPoint(TAG * t,SPOINT * p); // resets Bitcount
169 int swf_GetRect(TAG * t,SRECT * r);
170 int swf_GetMatrix(TAG * t,MATRIX * m);
171 int swf_GetCXForm(TAG * t,CXFORM * cx,U8 alpha);
173 int swf_SetPoint(TAG * t,SPOINT * p); // resets Bitcount
174 int swf_SetRect(TAG * t,SRECT * r);
175 int swf_SetMatrix(TAG * t,MATRIX * m);
176 int swf_SetCXForm(TAG * t,CXFORM * cx,U8 alpha);
177 int swf_SetRGB(TAG * t,RGBA * col);
178 int swf_SetRGBA(TAG * t,RGBA * col);
182 #define swf_GetS8(tag) ((S8)swf_GetU8(tag))
183 #define swf_GetS16(tag) ((S16)swf_GetU16(tag))
184 #define swf_GetS32(tag) ((S32)swf_GetU32(tag))
185 #define swf_GetCoord(tag) ((SCOORD)swf_GetU32(tag))
186 #define swf_GetFixed(tag) ((SFIXED)swf_GetU32(tag))
188 #define swf_SetS8(tag,v) swf_SetU8(tag,(U8)v)
189 #define swf_SetS16(tag,v) swf_SetU16(tag,(U16)v)
190 #define swf_SetS32(tag,v) swf_SetU32(tag,(U32)v)
191 #define swf_SetCoord(tag,v) swf_SetU32(tag,(U32)v)
192 #define swf_SetFixed(tag,v) swf_SetU32(tag,(U32)v)
193 #define swf_SetString(t,s) swf_SetBlock(t,s,strlen(s)+1)
195 #define FAILED(b) ((b)<0)
196 #define SUCCEDED(b) ((b)>=0)
198 // Tag IDs (adopted from J. C. Kessels' Form2Flash)
201 #define ST_SHOWFRAME 1
202 #define ST_DEFINESHAPE 2
203 #define ST_FREECHARACTER 3
204 #define ST_PLACEOBJECT 4
205 #define ST_REMOVEOBJECT 5
206 #define ST_DEFINEBITS 6
207 #define ST_DEFINEBUTTON 7
208 #define ST_JPEGTABLES 8
209 #define ST_SETBACKGROUNDCOLOR 9
210 #define ST_DEFINEFONT 10
211 #define ST_DEFINETEXT 11
212 #define ST_DOACTION 12
213 #define ST_DEFINEFONTINFO 13
214 #define ST_DEFINESOUND 14 /* Event sound tags. */
215 #define ST_STARTSOUND 15
216 #define ST_DEFINEBUTTONSOUND 17
217 #define ST_SOUNDSTREAMHEAD 18
218 #define ST_SOUNDSTREAMBLOCK 19
219 #define ST_DEFINEBITSLOSSLESS 20 /* A bitmap using lossless zlib compression. */
220 #define ST_DEFINEBITSJPEG2 21 /* A bitmap using an internal JPEG compression table. */
221 #define ST_DEFINESHAPE2 22
222 #define ST_DEFINEBUTTONCXFORM 23
223 #define ST_PROTECT 24 /* This file should not be importable for editing. */
224 #define ST_PLACEOBJECT2 26 /* The new style place w/ alpha color transform and name. */
225 #define ST_REMOVEOBJECT2 28 /* A more compact remove object that omits the character tag (just depth). */
226 #define ST_DEFINESHAPE3 32 /* A shape V3 includes alpha values. */
227 #define ST_DEFINETEXT2 33 /* A text V2 includes alpha values. */
228 #define ST_DEFINEBUTTON2 34 /* A button V2 includes color transform, alpha and multiple actions */
229 #define ST_DEFINEBITSJPEG3 35 /* A JPEG bitmap with alpha info. */
230 #define ST_DEFINEBITSLOSSLESS2 36 /* A lossless bitmap with alpha info. */
231 #define ST_DEFINEEDITTEXT 37
232 #define ST_DEFINEMOVIE 38
233 #define ST_DEFINESPRITE 39 /* Define a sequence of tags that describe the behavior of a sprite. */
234 #define ST_NAMECHARACTER 40 /* Name a character definition, character id and a string, (used for buttons, bitmaps, sprites and sounds). */
235 #define ST_SERIALNUMBER 41
236 #define ST_GENERATORTEXT 42 /* contains an id */
237 #define ST_FRAMELABEL 43 /* A string label for the current frame. */
238 #define ST_SOUNDSTREAMHEAD2 45 /* For lossless streaming sound, should not have needed this... */
239 #define ST_DEFINEMORPHSHAPE 46 /* A morph shape definition */
240 #define ST_DEFINEFONT2 48
241 #define ST_TEMPLATECOMMAND 49
242 #define ST_GENERATOR3 51
243 #define ST_EXTERNALFONT 52
244 #define ST_EXPORTASSETS 56
245 #define ST_IMPORTASSETS 57
246 #define ST_ENABLEDEBUGGER 58
248 #define ST_REFLEX 777 /* to identify generator software */
254 typedef struct _LINESTYLE
257 } LINESTYLE, * LPLINESTYLE;
259 typedef struct _FILLSTYLE
264 } FILLSTYLE, * LPFILLSTYLE;
266 typedef struct _SHAPE // NEVER access a Shape-Struct directly !
282 // used by Get/SetSimpleShape and glyph handling
284 U32 bitlen; // length of data in bits
289 int swf_ShapeNew(SHAPE ** s);
290 void swf_ShapeFree(SHAPE * s);
292 int swf_GetSimpleShape(TAG * t,SHAPE ** s); // without Linestyle/Fillstyle Record
293 int swf_SetSimpleShape(TAG * t,SHAPE * s); // without Linestyle/Fillstyle Record
295 int swf_ShapeAddLineStyle(SHAPE * s,U16 width,RGBA * color);
296 int swf_ShapeAddSolidFillStyle(SHAPE * s,RGBA * color);
297 int swf_ShapeAddBitmapFillStyle(SHAPE * s,MATRIX * m,U16 id_bitmap,int clip);
299 int swf_SetShapeStyles(TAG * t,SHAPE * s);
300 int swf_ShapeCountBits(SHAPE * s,U8 * fbits,U8 * lbits);
301 int swf_SetShapeBits(TAG * t,SHAPE * s);
302 int swf_SetShapeHeader(TAG * t,SHAPE * s); // one call for upper three functions
304 int swf_ShapeSetMove(TAG * t,SHAPE * s,S32 x,S32 y);
305 int swf_ShapeSetStyle(TAG * t,SHAPE * s,U16 line,U16 fill0,U16 fill1);
306 int swf_ShapeSetAll(TAG * t,SHAPE * s,S32 x,S32 y,U16 line,U16 fill0,U16 fill1);
308 int swf_ShapeSetLine(TAG * t,SHAPE * s,S32 x,S32 y);
309 int swf_ShapeSetCurve(TAG * t,SHAPE * s,S32 x,S32 y,S32 ax,S32 ay);
310 int swf_ShapeSetCircle(TAG * t,SHAPE * s,S32 x,S32 y,S32 rx,S32 ry);
311 int swf_ShapeSetEnd(TAG * t);
316 // does not support wide characters !
318 #define MAX_CHAR_PER_FONT 512
320 typedef struct _KERNING
327 typedef struct _SWFLAYOUT
333 SWFKERNING * kerning;
334 } SWFLAYOUT, * LPSWFLAYOUT;
341 typedef struct _SWFFONT
342 { int id; // -1 = not set
343 U8 version; // 0 = not set, 1 = definefont, 2 = definefont2
347 U16 maxascii; // highest mapped ascii value
348 U8 flags; // bold/italic/unicode/ansi ...
352 } SWFFONT, * LPSWFFONT;
354 typedef struct _FONTUSAGE
355 { U8 code[MAX_CHAR_PER_FONT];
356 } FONTUSAGE, * LPFONTUSAGE;
358 int swf_FontEnumerate(SWF * swf,void (*FontCallback) (U16,U8*));
359 // -> void fontcallback(U16 id,U8 * name); returns number of defined fonts
361 int swf_FontExtract(SWF * swf,int id,SWFFONT ** f);
362 // Fetches all available information from DefineFont, DefineFontInfo, DefineText, ...
363 // id = FontID, id=0 -> Extract first Font
365 int swf_FontIsItalic(SWFFONT * f);
366 int swf_FontIsBold(SWFFONT * f);
368 int swf_FontSetID(SWFFONT * f,U16 id);
369 int swf_FontReduce(SWFFONT * f,FONTUSAGE * use);
371 int swf_FontInitUsage(FONTUSAGE * use);
372 int swf_FontUse(FONTUSAGE * use,U8 * s);
374 int swf_FontSetDefine(TAG * t,SWFFONT * f);
375 int swf_FontSetInfo(TAG * t,SWFFONT * f);
377 int swf_FontExtract_DefineTextCallback(int id,SWFFONT * f,TAG * t,int jobs,
378 void(*callback)(int*chars, int nr, int id));
380 // the following two functions are obsolete and will be removed soon
381 int swf_FontExport(int handle,SWFFONT * f);
382 int swf_FontImport(int handle,SWFFONT * * f);
384 void swf_WriteFont(SWFFONT* font, char* filename);
385 SWFFONT* swf_ReadFont(char* filename);
387 void swf_FontFree(SWFFONT * f);
389 U32 swf_TextGetWidth(SWFFONT * font,U8 * s,int scale);
390 int swf_TextCountBits(SWFFONT * font,U8 * s,int scale,U8 * gbits,U8 * abits);
392 int swf_TextSetInfoRecord(TAG * t,SWFFONT * font,U16 size,RGBA * color,S16 dx,S16 dy);
393 int swf_TextSetCharRecord(TAG * t,SWFFONT * font,U8 * s,int scale,U8 gbits,U8 abits);
395 int swf_TextPrintDefineText(TAG * t,SWFFONT * f);
396 // Prints text defined in tag t with font f to stdout
400 void swf_DumpHeader(FILE * f,SWF * swf);
401 void swf_DumpMatrix(FILE * f,MATRIX * m);
402 void swf_DumpTag(FILE * f,TAG * t);
403 char* swf_TagGetName(TAG*tag);
404 void swf_DumpFont(SWFFONT * font);
408 // Always use ST_PLACEOBJECT2 !!!
410 int swf_ObjectPlace(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name);
411 int swf_ObjectPlaceClip(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name, U16 clipaction);
412 int swf_ObjectMove(TAG * t,U16 depth,MATRIX * m,CXFORM * cx);
425 #define BC_OVERDOWN_IDLE 0x0100
426 #define BC_IDLE_OVERDOWN 0x0080
427 #define BC_OUTDOWN_IDLE 0x0040
428 #define BC_OUTDOWN_OVERDOWN 0x0020
429 #define BC_OVERDOWN_OUTDOWN 0x0010
430 #define BC_OVERDOWN_OVERUP 0x0008
431 #define BC_OVERUP_OVERDOWN 0x0004
432 #define BC_OVERUP_IDLE 0x0002
433 #define BC_IDLE_OVERUP 0x0001
435 #define BC_KEY(c) (c<<9)
437 #define BC_CURSORLEFT 0x0200
438 #define BC_CURSORRIGHT 0x0400
439 #define BC_POS1 0x0600
440 #define BC_END 0x0800
441 #define BC_INSERT 0x0a00
442 #define BC_DELETE 0x0c00
443 #define BC_CLEAR 0x0e00
444 #define BC_BACKSPACE 0x1000
445 #define BC_ENTER 0x1a00
446 #define BC_CURSORUP 0x1c00
447 #define BC_CURSORDOWN 0x1e00
448 #define BC_PAGEUP 0x2000
449 #define BC_PAGEDOWN 0x2200
450 #define BC_TAB 0x2400
451 #define BC_ESCAPE 0x3600
452 #define BC_SPACE 0x4000
454 /* these are probably only valid with linux:
466 /* everything above 0x4000 is standard ascii:
467 0x4000 ' ' 0x4200 '!' 0x4600 '#' 0x4800 '$' 0x4a00 '%' 0x4c00 '&' ...
468 0x6000 '0' ... 0x7200 '9'
470 0x8200 'A' ... 0xb400 'Z'
477 #define BF_TRACKMENU 0x01
479 int swf_ButtonSetRecord(TAG * t,U8 state,U16 id,U16 layer,MATRIX * m,CXFORM * cx);
480 int swf_ButtonSetCondition(TAG * t,U16 condition); // for DefineButton2
481 int swf_ButtonSetFlags(TAG * t,U8 flags); // necessary for DefineButton2
482 int swf_ButtonPostProcess(TAG * t,int anz_action); // Set all offsets in DefineButton2-Tags (how many conditions to process)
486 typedef int JPEGBITS,* LPJPEGBITS; // cover libjpeg structures
488 JPEGBITS * swf_SetJPEGBitsStart(TAG * t,int width,int height,int quality);
489 int swf_SetJPEGBitsLines(JPEGBITS * jpegbits,U8 ** data,int n);
490 int swf_SetJPEGBitsLine(JPEGBITS * jpegbits,U8 * data);
491 int swf_SetJPEGBitsFinish(JPEGBITS * jpegbits);
493 int swf_SetJPEGBits(TAG * t,char * fname,int quality); // paste jpg file into swf stream
495 #define BYTES_PER_SCANLINE(width) ((width+3)&0xfffffffc)
497 #define BMF_8BIT 3 // Bitmap formats
501 #define BM16_BLUE 0xf800 // Bitmasks for 16 Bit Color
502 #define BM16_RED 0x00f0
503 #define BM16_GREEN 0x000f
505 #define BM32_BLUE 0xff000000 // Bitmasks for 32 Bit Color
506 #define BM32_GREEN 0x00ff0000
507 #define BM32_RED 0x0000ff00
509 int swf_SetLosslessBits(TAG * t,U16 width,U16 height,void * bitmap,U8 bitmap_flags);
510 int swf_SetLosslessBitsIndexed(TAG * t,U16 width,U16 height,U8 * bitmap,RGBA * palette,U16 ncolors);
511 int swf_SetLosslessBitsGrayscale(TAG * t,U16 width,U16 height,U8 * bitmap);
515 U8 swf_isDefiningTag(TAG * t);
516 U8 swf_isPseudoDefiningTag(TAG * t);
517 U8 swf_isAllowedSpriteTag(TAG * t);
518 U16 swf_GetDefineID(TAG * t);
519 U16 swf_GetPlaceID(TAG * t); //PLACEOBJECT, PLACEOBJECT2 (sometimes), REMOVEOBJECT
520 U16 swf_GetDepth(TAG * t); //PLACEOBJECT,PLACEOBJECT2,REMOVEOBJECT,REMOVEOBJECT2
521 char* swf_GetName(TAG * t); //PLACEOBJECT2, FRAMELABEL
522 MATRIX * swf_MatrixJoin(MATRIX * d,MATRIX * s1,MATRIX * s2);
523 MATRIX * swf_MatrixMapTriangle(MATRIX * m,int dx,int dy,
524 int x0,int y0,int x1,int y1,int x2,int y2);
529 void swf_uncgi(); // same behaviour as Steven Grimm's uncgi-library
533 ActionTAG* swf_ActionGet(TAG*tag);
534 void swf_ActionFree(ActionTAG*tag);
535 void swf_ActionSet(TAG*tag, ActionTAG*actions);
536 void swf_DumpActions(ActionTAG*atag, char*prefix);
537 void swf_ActionEnumerateURLs(ActionTAG*atag, char*(*callback)(char*));
538 void swf_ActionEnumerateTargets(ActionTAG*atag, char*(*callback)(char*));
539 void swf_ActionEnumerateStrings(ActionTAG*atag, char*(*callback)(char*));
541 ActionTAG* swf_ActionStart();
543 void action_NextFrame();
544 void action_PreviousFrame();
547 void action_ToggleQuality();
548 void action_StopSounds();
550 void action_Subtract();
551 void action_Multiply();
552 void action_Divide();
553 void action_Equals();
558 void action_StringEquals();
559 void action_StringLength();
560 void action_StringExtract();
562 void action_ToInteger();
563 void action_GetVariable();
564 void action_SetVariable();
565 void action_SetTarget2();
566 void action_StringAdd();
567 void action_GetProperty();
568 void action_SetProperty();
569 void action_CloneSprite();
570 void action_RemoveSprite();
572 void action_StartDrag();
573 void action_EndDrag();
574 void action_StringLess();
575 void action_RandomNumber();
576 void action_MBStringLength();
577 void action_CharToAscii();
578 void action_AsciiToChar();
579 void action_GetTime();
580 void action_MBStringExtract();
581 void action_MBCharToAscii();
582 void action_MBAsciiToChar();
583 void action_Delete();
584 void action_Delete2();
585 void action_DefineLocal();
586 void action_CallFunction();
587 void action_Return();
588 void action_Modulo();
589 void action_NewObject();
590 void action_DefineLocal2();
591 void action_InitArray();
592 void action_Makehash();
593 void action_TypeOf();
594 void action_TargetPath();
595 void action_Enumerate();
598 void action_Equals2();
599 void action_ToNumber();
600 void action_ToString();
601 void action_PushDuplicate();
602 void action_StackSwap();
603 void action_GetMember();
604 void action_SetMember();
605 void action_Increment();
606 void action_Decrement();
607 void action_CallMethod();
608 void action_NewMethod();
609 void action_BitAnd();
611 void action_BitXor();
612 void action_BitLShift();
613 void action_BitRShift();
614 void action_BitURShift();
615 void action_GotoFrame(U16 frame);
616 void action_GetUrl(char* url, char* label);
617 void action_StoreRegister(U8 reg);
618 void action_Constantpool(char* constantpool);
619 void action_WaitForFrame(U16 frame, U8 skip);
620 void action_SetTarget(char* target);
621 void action_GotoLabel(char* label);
622 void action_WaitForFrame2(U8 skip);
623 void action_With(char*object);
624 void action_PushString(char*str);
625 void action_PushFloat(float f);
626 void action_PushNULL();
627 void action_PushRegister(U8 reg);
628 void action_PushBoolean(char c);
629 void action_PushDouble(double d);
630 void action_PushInt(int i);
631 void action_PushLookup(U8 index);
632 void action_Jump(U16 branch);
633 void action_GetUrl2(U8 method);
634 void action_DefineFunction(U8*data, int len);
635 void action_If(U16 branch);
637 void action_GotoFrame2(U8 method);
638 void swf_ActionEnd();
639 ActionMarker action_setMarker();
640 void action_fixjump(ActionMarker m1, ActionMarker m2);