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 //#define SWAP16(s) ((U16) ((U8*)&s)[0] | ((U16) ((U8*)&s)[1] << 8))
33 //#define SWAP32(s) ((U32) ((U8*)&s)[0] | ((U32) ((U8*)&s)[1] << 8) | ((U32) ((U8*)&s)[2] << 16) | ((U32) ((U8*)&s)[3] << 24))
34 #ifdef WORDS_BIGENDIAN
35 #define SWAP16(s) ((((s)>>8)&0x00ff)|(((s)<<8)&0xff00))
36 #define SWAP32(s) (SWAP16(((s)>>16)&0x0000ffff)|((SWAP16(s)<<16)&0xffff0000))
37 #define REVERSESWAP16(x) (x)
38 #define REVERSESWAP32(x) (x)
42 #define REVERSESWAP16(s) ((((s)>>8)&0x00ff)|(((s)<<8)&0xff00))
43 #define REVERSESWAP32(s) (REVERSESWAP16(((s)>>16)&0x0000ffff)|((REVERSESWAP16(s)<<16)&0xffff0000))
48 typedef unsigned long U32;
49 typedef signed long S32;
50 typedef unsigned short U16;
51 typedef signed short S16;
52 typedef unsigned char U8;
53 typedef signed char S8;
54 typedef signed long SFIXED;
55 typedef signed long SCOORD;
59 typedef struct _SPOINT
78 typedef struct _MATRIX
79 { SFIXED sx; // factor x
81 SFIXED r0; // rotation
87 typedef struct _CXFORM
94 typedef struct _TAG // NEVER access a Tag-Struct directly !
97 U32 memsize; // to minimize realloc() calls
99 U32 len; // for Set-Access
100 U32 pos; // for Get-Access
102 int frame; // not really up-to-date
107 U8 readBit; // for Bit-Manipulating Functions [read]
108 U8 writeBit; // [write]
112 typedef struct _ActionTAG
117 struct _ActionTAG * next;
118 struct _ActionTAG * prev;
120 TAG* parent; // may be null
121 U8 tmp[4]; // store small operands here.
124 typedef struct _ActionMarker
131 U32 fileSize; // valid after load and save
134 U16 frameCount; // valid after load and save
140 int swf_ReadSWF(int handle,SWF * swf); // Reads SWF to memory (malloc'ed), returns length or <0 if fails
141 int swf_WriteSWF(int handle,SWF * swf); // Writes SWF to file, returns length or <0 if fails
142 int swf_WriteCGI(SWF * swf); // Outputs SWF with valid CGI header to stdout
143 void swf_FreeTags(SWF * swf); // Frees all malloc'ed memory for swf
146 int swf_WriteHeader(int handle,SWF * swf); // Writes Header of swf to file
147 int swf_WriteTag(int handle,TAG * tag); // Writes TAG to file
149 TAG * swf_InsertTag(TAG * after,U16 id); // updates frames, if necessary
150 int swf_DeleteTag(TAG * t);
152 void swf_SetTagPos(TAG * t,U32 pos); // resets Bitcount
153 U32 swf_GetTagPos(TAG * t);
155 TAG * swf_NextTag(TAG * t);
156 TAG * swf_PrevTag(TAG * t);
158 int swf_GetFrameNo(TAG * t); // should be renamed to TagGetFrame
159 U16 swf_GetTagID(TAG * t); // ... TagGetID
160 U32 swf_GetTagLen(TAG * t); // ... TagGetTagLen
161 U8* swf_GetTagLenPtr(TAG * t);
163 U32 swf_GetBits(TAG * t,int nbits);
164 S32 swf_GetSBits(TAG * t,int nbits);
165 int swf_SetBits(TAG * t,U32 v,int nbits);
167 int swf_GetBlock(TAG * t,U8 * b,int l); // resets Bitcount
168 int swf_SetBlock(TAG * t,U8 * b,int l);
170 U8 swf_GetU8(TAG * t); // resets Bitcount
171 U16 swf_GetU16(TAG * t);
172 U32 swf_GetU32(TAG * t);
174 int swf_SetU8(TAG * t,U8 v); // resets Bitcount
175 int swf_SetU16(TAG * t,U16 v);
176 int swf_SetU32(TAG * t,U32 v);
178 int swf_GetPoint(TAG * t,SPOINT * p); // resets Bitcount
179 int swf_GetRect(TAG * t,SRECT * r);
180 int swf_GetMatrix(TAG * t,MATRIX * m);
181 int swf_GetCXForm(TAG * t,CXFORM * cx,U8 alpha);
183 int swf_SetPoint(TAG * t,SPOINT * p); // resets Bitcount
184 int swf_SetRect(TAG * t,SRECT * r);
185 int swf_SetMatrix(TAG * t,MATRIX * m);
186 int swf_SetCXForm(TAG * t,CXFORM * cx,U8 alpha);
187 int swf_SetRGB(TAG * t,RGBA * col);
188 int swf_SetRGBA(TAG * t,RGBA * col);
192 #define swf_GetS8(tag) ((S8)swf_GetU8(tag))
193 #define swf_GetS16(tag) ((S16)swf_GetU16(tag))
194 #define swf_GetS32(tag) ((S32)swf_GetU32(tag))
195 #define swf_GetCoord(tag) ((SCOORD)swf_GetU32(tag))
196 #define swf_GetFixed(tag) ((SFIXED)swf_GetU32(tag))
198 #define swf_SetS8(tag,v) swf_SetU8(tag,(U8)v)
199 #define swf_SetS16(tag,v) swf_SetU16(tag,(U16)v)
200 #define swf_SetS32(tag,v) swf_SetU32(tag,(U32)v)
201 #define swf_SetCoord(tag,v) swf_SetU32(tag,(U32)v)
202 #define swf_SetFixed(tag,v) swf_SetU32(tag,(U32)v)
203 #define swf_SetString(t,s) swf_SetBlock(t,s,strlen(s)+1)
205 #define FAILED(b) ((b)<0)
206 #define SUCCEDED(b) ((b)>=0)
208 // Tag IDs (adopted from J. C. Kessels' Form2Flash)
211 #define ST_SHOWFRAME 1
212 #define ST_DEFINESHAPE 2
213 #define ST_FREECHARACTER 3
214 #define ST_PLACEOBJECT 4
215 #define ST_REMOVEOBJECT 5
216 #define ST_DEFINEBITS 6
217 #define ST_DEFINEBUTTON 7
218 #define ST_JPEGTABLES 8
219 #define ST_SETBACKGROUNDCOLOR 9
220 #define ST_DEFINEFONT 10
221 #define ST_DEFINETEXT 11
222 #define ST_DOACTION 12
223 #define ST_DEFINEFONTINFO 13
224 #define ST_DEFINESOUND 14 /* Event sound tags. */
225 #define ST_STARTSOUND 15
226 #define ST_DEFINEBUTTONSOUND 17
227 #define ST_SOUNDSTREAMHEAD 18
228 #define ST_SOUNDSTREAMBLOCK 19
229 #define ST_DEFINEBITSLOSSLESS 20 /* A bitmap using lossless zlib compression. */
230 #define ST_DEFINEBITSJPEG2 21 /* A bitmap using an internal JPEG compression table. */
231 #define ST_DEFINESHAPE2 22
232 #define ST_DEFINEBUTTONCXFORM 23
233 #define ST_PROTECT 24 /* This file should not be importable for editing. */
234 #define ST_PLACEOBJECT2 26 /* The new style place w/ alpha color transform and name. */
235 #define ST_REMOVEOBJECT2 28 /* A more compact remove object that omits the character tag (just depth). */
236 #define ST_DEFINESHAPE3 32 /* A shape V3 includes alpha values. */
237 #define ST_DEFINETEXT2 33 /* A text V2 includes alpha values. */
238 #define ST_DEFINEBUTTON2 34 /* A button V2 includes color transform, alpha and multiple actions */
239 #define ST_DEFINEBITSJPEG3 35 /* A JPEG bitmap with alpha info. */
240 #define ST_DEFINEBITSLOSSLESS2 36 /* A lossless bitmap with alpha info. */
241 #define ST_DEFINEEDITTEXT 37
242 #define ST_DEFINEMOVIE 38
243 #define ST_DEFINESPRITE 39 /* Define a sequence of tags that describe the behavior of a sprite. */
244 #define ST_NAMECHARACTER 40 /* Name a character definition, character id and a string, (used for buttons, bitmaps, sprites and sounds). */
245 #define ST_SERIALNUMBER 41
246 #define ST_GENERATORTEXT 42 /* contains an id */
247 #define ST_FRAMELABEL 43 /* A string label for the current frame. */
248 #define ST_SOUNDSTREAMHEAD2 45 /* For lossless streaming sound, should not have needed this... */
249 #define ST_DEFINEMORPHSHAPE 46 /* A morph shape definition */
250 #define ST_DEFINEFONT2 48
251 #define ST_TEMPLATECOMMAND 49
252 #define ST_GENERATOR3 51
253 #define ST_EXTERNALFONT 52
254 #define ST_EXPORTASSETS 56
255 #define ST_IMPORTASSETS 57
256 #define ST_ENABLEDEBUGGER 58
258 #define ST_REFLEX 777 /* to identify generator software */
264 typedef struct _LINESTYLE
267 } LINESTYLE, * LPLINESTYLE;
269 typedef struct _FILLSTYLE
274 } FILLSTYLE, * LPFILLSTYLE;
276 typedef struct _SHAPE // NEVER access a Shape-Struct directly !
292 // used by Get/SetSimpleShape and glyph handling
294 U32 bitlen; // length of data in bits
299 int swf_ShapeNew(SHAPE ** s);
300 void swf_ShapeFree(SHAPE * s);
302 int swf_GetSimpleShape(TAG * t,SHAPE ** s); // without Linestyle/Fillstyle Record
303 int swf_SetSimpleShape(TAG * t,SHAPE * s); // without Linestyle/Fillstyle Record
305 int swf_ShapeAddLineStyle(SHAPE * s,U16 width,RGBA * color);
306 int swf_ShapeAddSolidFillStyle(SHAPE * s,RGBA * color);
307 int swf_ShapeAddBitmapFillStyle(SHAPE * s,MATRIX * m,U16 id_bitmap,int clip);
309 int swf_SetShapeStyles(TAG * t,SHAPE * s);
310 int swf_ShapeCountBits(SHAPE * s,U8 * fbits,U8 * lbits);
311 int swf_SetShapeBits(TAG * t,SHAPE * s);
312 int swf_SetShapeHeader(TAG * t,SHAPE * s); // one call for upper three functions
314 int swf_ShapeSetMove(TAG * t,SHAPE * s,S32 x,S32 y);
315 int swf_ShapeSetStyle(TAG * t,SHAPE * s,U16 line,U16 fill0,U16 fill1);
316 int swf_ShapeSetAll(TAG * t,SHAPE * s,S32 x,S32 y,U16 line,U16 fill0,U16 fill1);
318 int swf_ShapeSetLine(TAG * t,SHAPE * s,S32 x,S32 y);
319 int swf_ShapeSetCurve(TAG * t,SHAPE * s,S32 x,S32 y,S32 ax,S32 ay);
320 int swf_ShapeSetCircle(TAG * t,SHAPE * s,S32 x,S32 y,S32 rx,S32 ry);
321 int swf_ShapeSetEnd(TAG * t);
326 // does not support wide characters !
328 #define MAX_CHAR_PER_FONT 512
330 typedef struct _KERNING
337 typedef struct _SWFLAYOUT
343 SWFKERNING * kerning;
344 } SWFLAYOUT, * LPSWFLAYOUT;
351 typedef struct _SWFFONT
352 { int id; // -1 = not set
353 U8 version; // 0 = not set, 1 = definefont, 2 = definefont2
357 U16 maxascii; // highest mapped ascii value
358 U8 flags; // bold/italic/unicode/ansi ...
362 } SWFFONT, * LPSWFFONT;
364 typedef struct _FONTUSAGE
365 { U8 code[MAX_CHAR_PER_FONT];
366 } FONTUSAGE, * LPFONTUSAGE;
368 #define ET_HASTEXT 32768
369 #define ET_WORDWRAP 16384
370 #define ET_MULTILINE 8192
371 #define ET_PASSWORD 4096
372 #define ET_READONLY 2048
373 #define ET_HASTEXTCOLOR 1024
374 #define ET_HASMAXLENGTH 512
375 #define ET_HASFONT 256
378 #define ET_HASLAYOUT 32
379 #define ET_NOSELECT 16
383 #define ET_USEOUTLINES 1
385 typedef struct _EditTextLayout
387 U8 align; // 0=left, 1=right, 2=center, 3=justify
394 int swf_FontEnumerate(SWF * swf,void (*FontCallback) (U16,U8*));
395 // -> void fontcallback(U16 id,U8 * name); returns number of defined fonts
397 int swf_FontExtract(SWF * swf,int id,SWFFONT ** f);
398 // Fetches all available information from DefineFont, DefineFontInfo, DefineText, ...
399 // id = FontID, id=0 -> Extract first Font
401 int swf_FontIsItalic(SWFFONT * f);
402 int swf_FontIsBold(SWFFONT * f);
404 int swf_FontSetID(SWFFONT * f,U16 id);
405 int swf_FontReduce(SWFFONT * f,FONTUSAGE * use);
407 int swf_FontInitUsage(FONTUSAGE * use);
408 int swf_FontUse(FONTUSAGE * use,U8 * s);
410 int swf_FontSetDefine(TAG * t,SWFFONT * f);
411 int swf_FontSetInfo(TAG * t,SWFFONT * f);
413 int swf_FontExtract_DefineTextCallback(int id,SWFFONT * f,TAG * t,int jobs,
414 void(*callback)(int*chars, int nr, int id));
416 // the following two functions are obsolete and will be removed soon
417 int swf_FontExport(int handle,SWFFONT * f);
418 int swf_FontImport(int handle,SWFFONT * * f);
420 void swf_WriteFont(SWFFONT* font, char* filename);
421 SWFFONT* swf_ReadFont(char* filename);
423 void swf_FontFree(SWFFONT * f);
425 U32 swf_TextGetWidth(SWFFONT * font,U8 * s,int scale);
426 int swf_TextCountBits(SWFFONT * font,U8 * s,int scale,U8 * gbits,U8 * abits);
428 int swf_TextSetInfoRecord(TAG * t,SWFFONT * font,U16 size,RGBA * color,S16 dx,S16 dy);
429 int swf_TextSetCharRecord(TAG * t,SWFFONT * font,U8 * s,int scale,U8 gbits,U8 abits);
431 int swf_TextPrintDefineText(TAG * t,SWFFONT * f);
432 // Prints text defined in tag t with font f to stdout
434 void swf_SetEditText(TAG*tag, U16 flags, SRECT r, char*text, RGBA*color,
435 int maxlength, U16 font, U16 height, EditTextLayout*layout, char*variable);
439 void swf_DumpHeader(FILE * f,SWF * swf);
440 void swf_DumpMatrix(FILE * f,MATRIX * m);
441 void swf_DumpTag(FILE * f,TAG * t);
442 char* swf_TagGetName(TAG*tag);
443 void swf_DumpFont(SWFFONT * font);
447 // Always use ST_PLACEOBJECT2 !!!
449 int swf_ObjectPlace(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name);
450 int swf_ObjectPlaceClip(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name, U16 clipaction);
451 int swf_ObjectMove(TAG * t,U16 depth,MATRIX * m,CXFORM * cx);
464 #define BC_OVERDOWN_IDLE 0x0100
465 #define BC_IDLE_OVERDOWN 0x0080
466 #define BC_OUTDOWN_IDLE 0x0040
467 #define BC_OUTDOWN_OVERDOWN 0x0020
468 #define BC_OVERDOWN_OUTDOWN 0x0010
469 #define BC_OVERDOWN_OVERUP 0x0008
470 #define BC_OVERUP_OVERDOWN 0x0004
471 #define BC_OVERUP_IDLE 0x0002
472 #define BC_IDLE_OVERUP 0x0001
474 #define BC_KEY(c) (c<<9)
476 #define BC_CURSORLEFT 0x0200
477 #define BC_CURSORRIGHT 0x0400
478 #define BC_POS1 0x0600
479 #define BC_END 0x0800
480 #define BC_INSERT 0x0a00
481 #define BC_DELETE 0x0c00
482 #define BC_CLEAR 0x0e00
483 #define BC_BACKSPACE 0x1000
484 #define BC_ENTER 0x1a00
485 #define BC_CURSORUP 0x1c00
486 #define BC_CURSORDOWN 0x1e00
487 #define BC_PAGEUP 0x2000
488 #define BC_PAGEDOWN 0x2200
489 #define BC_TAB 0x2400
490 #define BC_ESCAPE 0x3600
491 #define BC_SPACE 0x4000
493 /* these are probably only valid with linux:
505 /* everything above 0x4000 is standard ascii:
506 0x4000 ' ' 0x4200 '!' 0x4600 '#' 0x4800 '$' 0x4a00 '%' 0x4c00 '&' ...
507 0x6000 '0' ... 0x7200 '9'
509 0x8200 'A' ... 0xb400 'Z'
516 #define BF_TRACKMENU 0x01
518 int swf_ButtonSetRecord(TAG * t,U8 state,U16 id,U16 layer,MATRIX * m,CXFORM * cx);
519 int swf_ButtonSetCondition(TAG * t,U16 condition); // for DefineButton2
520 int swf_ButtonSetFlags(TAG * t,U8 flags); // necessary for DefineButton2
521 int swf_ButtonPostProcess(TAG * t,int anz_action); // Set all offsets in DefineButton2-Tags (how many conditions to process)
525 typedef int JPEGBITS,* LPJPEGBITS; // cover libjpeg structures
527 JPEGBITS * swf_SetJPEGBitsStart(TAG * t,int width,int height,int quality);
528 int swf_SetJPEGBitsLines(JPEGBITS * jpegbits,U8 ** data,int n);
529 int swf_SetJPEGBitsLine(JPEGBITS * jpegbits,U8 * data);
530 int swf_SetJPEGBitsFinish(JPEGBITS * jpegbits);
532 int swf_SetJPEGBits(TAG * t,char * fname,int quality); // paste jpg file into swf stream
534 #define BYTES_PER_SCANLINE(width) ((width+3)&0xfffffffc)
536 #define BMF_8BIT 3 // Bitmap formats
540 #define BM16_BLUE 0xf800 // Bitmasks for 16 Bit Color
541 #define BM16_RED 0x00f0
542 #define BM16_GREEN 0x000f
544 #define BM32_BLUE 0xff000000 // Bitmasks for 32 Bit Color
545 #define BM32_GREEN 0x00ff0000
546 #define BM32_RED 0x0000ff00
548 int swf_SetLosslessBits(TAG * t,U16 width,U16 height,void * bitmap,U8 bitmap_flags);
549 int swf_SetLosslessBitsIndexed(TAG * t,U16 width,U16 height,U8 * bitmap,RGBA * palette,U16 ncolors);
550 int swf_SetLosslessBitsGrayscale(TAG * t,U16 width,U16 height,U8 * bitmap);
554 U8 swf_isDefiningTag(TAG * t);
555 U8 swf_isPseudoDefiningTag(TAG * t);
556 U8 swf_isAllowedSpriteTag(TAG * t);
557 U16 swf_GetDefineID(TAG * t);
558 U16 swf_GetPlaceID(TAG * t); //PLACEOBJECT, PLACEOBJECT2 (sometimes), REMOVEOBJECT
559 U16 swf_GetDepth(TAG * t); //PLACEOBJECT,PLACEOBJECT2,REMOVEOBJECT,REMOVEOBJECT2
560 char* swf_GetName(TAG * t); //PLACEOBJECT2, FRAMELABEL
561 MATRIX * swf_MatrixJoin(MATRIX * d,MATRIX * s1,MATRIX * s2);
562 MATRIX * swf_MatrixMapTriangle(MATRIX * m,int dx,int dy,
563 int x0,int y0,int x1,int y1,int x2,int y2);
568 void swf_uncgi(); // same behaviour as Steven Grimm's uncgi-library
572 ActionTAG* swf_ActionGet(TAG*tag);
573 void swf_ActionFree(ActionTAG*tag);
574 void swf_ActionSet(TAG*tag, ActionTAG*actions);
575 void swf_DumpActions(ActionTAG*atag, char*prefix);
576 void swf_ActionEnumerateURLs(ActionTAG*atag, char*(*callback)(char*));
577 void swf_ActionEnumerateTargets(ActionTAG*atag, char*(*callback)(char*));
578 void swf_ActionEnumerateStrings(ActionTAG*atag, char*(*callback)(char*));
580 ActionTAG* swf_ActionStart();
582 void action_NextFrame();
583 void action_PreviousFrame();
586 void action_ToggleQuality();
587 void action_StopSounds();
589 void action_Subtract();
590 void action_Multiply();
591 void action_Divide();
592 void action_Equals();
597 void action_StringEquals();
598 void action_StringLength();
599 void action_StringExtract();
601 void action_ToInteger();
602 void action_GetVariable();
603 void action_SetVariable();
604 void action_SetTarget2();
605 void action_StringAdd();
606 void action_GetProperty();
607 void action_SetProperty();
608 void action_CloneSprite();
609 void action_RemoveSprite();
611 void action_StartDrag();
612 void action_EndDrag();
613 void action_StringLess();
614 void action_RandomNumber();
615 void action_MBStringLength();
616 void action_CharToAscii();
617 void action_AsciiToChar();
618 void action_GetTime();
619 void action_MBStringExtract();
620 void action_MBCharToAscii();
621 void action_MBAsciiToChar();
622 void action_Delete();
623 void action_Delete2();
624 void action_DefineLocal();
625 void action_CallFunction();
626 void action_Return();
627 void action_Modulo();
628 void action_NewObject();
629 void action_DefineLocal2();
630 void action_InitArray();
631 void action_Makehash();
632 void action_TypeOf();
633 void action_TargetPath();
634 void action_Enumerate();
637 void action_Equals2();
638 void action_ToNumber();
639 void action_ToString();
640 void action_PushDuplicate();
641 void action_StackSwap();
642 void action_GetMember();
643 void action_SetMember();
644 void action_Increment();
645 void action_Decrement();
646 void action_CallMethod();
647 void action_NewMethod();
648 void action_BitAnd();
650 void action_BitXor();
651 void action_BitLShift();
652 void action_BitRShift();
653 void action_BitURShift();
654 void action_GotoFrame(U16 frame);
655 void action_GetUrl(char* url, char* label);
656 void action_StoreRegister(U8 reg);
657 void action_Constantpool(char* constantpool);
658 void action_WaitForFrame(U16 frame, U8 skip);
659 void action_SetTarget(char* target);
660 void action_GotoLabel(char* label);
661 void action_WaitForFrame2(U8 skip);
662 void action_With(char*object);
663 void action_PushString(char*str);
664 void action_PushFloat(float f);
665 void action_PushNULL();
666 void action_PushRegister(U8 reg);
667 void action_PushBoolean(char c);
668 void action_PushDouble(double d);
669 void action_PushInt(int i);
670 void action_PushLookup(U8 index);
671 void action_Jump(U16 branch);
672 void action_GetUrl2(U8 method);
673 void action_DefineFunction(U8*data, int len);
674 void action_If(U16 branch);
676 void action_GotoFrame2(U8 method);
677 void swf_ActionEnd();
678 ActionMarker action_setMarker();
679 void action_fixjump(ActionMarker m1, ActionMarker m2);