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"
27 typedef unsigned long U32;
28 typedef signed long S32;
29 typedef unsigned short U16;
30 typedef signed short S16;
31 typedef unsigned char U8;
32 typedef signed char S8;
33 typedef signed long SFIXED;
34 typedef signed long SCOORD;
38 typedef struct _SPOINT
57 typedef struct _MATRIX
58 { SFIXED sx; // factor x
60 SFIXED r0; // rotation
66 typedef struct _CXFORM
73 typedef struct _TAG // NEVER access a Tag-Struct directly !
76 U32 memsize; // to minimize realloc() calls
78 U32 len; // for Set-Access
79 U32 pos; // for Get-Access
81 int frame; // not really up-to-date
86 U8 readBit; // for Bit-Manipulating Functions [read]
87 U8 writeBit; // [write]
91 typedef struct _ActionTAG
96 struct _ActionTAG * next;
97 struct _ActionTAG * prev;
99 TAG* parent; // may be null
100 U8 tmp[4]; // store small operands here.
106 U32 fileSize; // valid after load and save
109 U16 frameCount; // valid after load and save
115 int swf_ReadSWF(int handle,SWF * swf); // Reads SWF to memory (malloc'ed), returns length or <0 if fails
116 int swf_WriteSWF(int handle,SWF * swf); // Writes SWF to file, returns length or <0 if fails
117 int swf_WriteCGI(SWF * swf); // Outputs SWF with valid CGI header to stdout
118 void swf_FreeTags(SWF * swf); // Frees all malloc'ed memory for swf
120 TAG * swf_InsertTag(TAG * after,U16 id); // updates frames, if necessary
121 int swf_DeleteTag(TAG * t);
123 void swf_SetTagPos(TAG * t,U32 pos); // resets Bitcount
124 U32 swf_GetTagPos(TAG * t);
126 TAG * swf_NextTag(TAG * t);
127 TAG * swf_PrevTag(TAG * t);
129 int swf_GetFrameNo(TAG * t); // should be renamed to TagGetFrame
130 U16 swf_GetTagID(TAG * t); // ... TagGetID
131 U32 swf_GetDataSize(TAG * t); // ... TagGetDataSize
132 U8* swf_GetDataSizePtr(TAG * t);
134 U32 swf_GetBits(TAG * t,int nbits);
135 S32 swf_GetSBits(TAG * t,int nbits);
136 int swf_SetBits(TAG * t,U32 v,int nbits);
138 int swf_GetBlock(TAG * t,U8 * b,int l); // resets Bitcount
139 int swf_SetBlock(TAG * t,U8 * b,int l);
141 U8 swf_GetU8(TAG * t); // resets Bitcount
142 U16 swf_GetU16(TAG * t);
143 U32 swf_GetU32(TAG * t);
145 int swf_SetU8(TAG * t,U8 v); // resets Bitcount
146 int swf_SetU16(TAG * t,U16 v);
147 int swf_SetU32(TAG * t,U32 v);
149 int swf_GetPoint(TAG * t,SPOINT * p); // resets Bitcount
150 int swf_GetRect(TAG * t,SRECT * r);
151 int swf_GetMatrix(TAG * t,MATRIX * m);
152 int swf_GetCXForm(TAG * t,CXFORM * cx,U8 alpha);
154 int swf_SetPoint(TAG * t,SPOINT * p); // resets Bitcount
155 int swf_SetRect(TAG * t,SRECT * r);
156 int swf_SetMatrix(TAG * t,MATRIX * m);
157 int swf_SetCXForm(TAG * t,CXFORM * cx,U8 alpha);
158 int swf_SetRGB(TAG * t,RGBA * col);
159 int swf_SetRGBA(TAG * t,RGBA * col);
163 #define swf_GetS8(tag) ((S8)swf_GetU8(tag))
164 #define swf_GetS16(tag) ((S16)swf_GetU16(tag))
165 #define swf_GetS32(tag) ((S32)swf_GetU32(tag))
166 #define swf_GetCoord(tag) ((SCOORD)swf_GetU32(tag))
167 #define swf_GetFixed(tag) ((SFIXED)swf_GetU32(tag))
169 #define swf_SetS8(tag,v) swf_SetU8(tag,(U8)v)
170 #define swf_SetS16(tag,v) swf_SetU16(tag,(U16)v)
171 #define swf_SetS32(tag,v) swf_SetU32(tag,(U32)v)
172 #define swf_SetCoord(tag,v) swf_SetU32(tag,(U32)v)
173 #define swf_SetFixed(tag,v) swf_SetU32(tag,(U32)v)
174 #define swf_SetString(t,s) swf_SetBlock(t,s,strlen(s)+1)
176 #define FAILED(b) ((b)<0)
177 #define SUCCEDED(b) ((b)>=0)
179 // Tag IDs (adopted from J. C. Kessels' Form2Flash)
182 #define ST_SHOWFRAME 1
183 #define ST_DEFINESHAPE 2
184 #define ST_FREECHARACTER 3
185 #define ST_PLACEOBJECT 4
186 #define ST_REMOVEOBJECT 5
187 #define ST_DEFINEBITS 6
188 #define ST_DEFINEBUTTON 7
189 #define ST_JPEGTABLES 8
190 #define ST_SETBACKGROUNDCOLOR 9
191 #define ST_DEFINEFONT 10
192 #define ST_DEFINETEXT 11
193 #define ST_DOACTION 12
194 #define ST_DEFINEFONTINFO 13
195 #define ST_DEFINESOUND 14 /* Event sound tags. */
196 #define ST_STARTSOUND 15
197 #define ST_DEFINEBUTTONSOUND 17
198 #define ST_SOUNDSTREAMHEAD 18
199 #define ST_SOUNDSTREAMBLOCK 19
200 #define ST_DEFINEBITSLOSSLESS 20 /* A bitmap using lossless zlib compression. */
201 #define ST_DEFINEBITSJPEG2 21 /* A bitmap using an internal JPEG compression table. */
202 #define ST_DEFINESHAPE2 22
203 #define ST_DEFINEBUTTONCXFORM 23
204 #define ST_PROTECT 24 /* This file should not be importable for editing. */
205 #define ST_PLACEOBJECT2 26 /* The new style place w/ alpha color transform and name. */
206 #define ST_REMOVEOBJECT2 28 /* A more compact remove object that omits the character tag (just depth). */
207 #define ST_DEFINESHAPE3 32 /* A shape V3 includes alpha values. */
208 #define ST_DEFINETEXT2 33 /* A text V2 includes alpha values. */
209 #define ST_DEFINEBUTTON2 34 /* A button V2 includes color transform, alpha and multiple actions */
210 #define ST_DEFINEBITSJPEG3 35 /* A JPEG bitmap with alpha info. */
211 #define ST_DEFINEBITSLOSSLESS2 36 /* A lossless bitmap with alpha info. */
212 #define ST_DEFINEEDITTEXT 37
213 #define ST_DEFINEMOVIE 38
214 #define ST_DEFINESPRITE 39 /* Define a sequence of tags that describe the behavior of a sprite. */
215 #define ST_NAMECHARACTER 40 /* Name a character definition, character id and a string, (used for buttons, bitmaps, sprites and sounds). */
216 #define ST_SERIALNUMBER 41
217 #define ST_GENERATORTEXT 42 /* contains an id */
218 #define ST_FRAMELABEL 43 /* A string label for the current frame. */
219 #define ST_SOUNDSTREAMHEAD2 45 /* For lossless streaming sound, should not have needed this... */
220 #define ST_DEFINEMORPHSHAPE 46 /* A morph shape definition */
221 #define ST_DEFINEFONT2 48
222 #define ST_TEMPLATECOMMAND 49
223 #define ST_GENERATOR3 51
224 #define ST_EXTERNALFONT 52
225 #define ST_EXPORTASSETS 56
226 #define ST_IMPORTASSETS 57
227 #define ST_ENABLEDEBUGGER 58
229 #define ST_REFLEX 777 /* to identify generator software */
235 typedef struct _LINESTYLE
238 } LINESTYLE, * LPLINESTYLE;
240 typedef struct _FILLSTYLE
245 } FILLSTYLE, * LPFILLSTYLE;
247 typedef struct _SHAPE // NEVER access a Shape-Struct directly !
253 // note: changes of shape structure
254 struct // lead to incompatible .efont formats
268 U32 bitlen; // length of data in bits
273 int swf_ShapeNew(SHAPE ** s);
274 void swf_ShapeFree(SHAPE * s);
276 int swf_GetSimpleShape(TAG * t,SHAPE ** s); // without Linestyle/Fillstyle Record
277 int swf_SetSimpleShape(TAG * t,SHAPE * s); // without Linestyle/Fillstyle Record
279 int swf_ShapeAddLineStyle(SHAPE * s,U16 width,RGBA * color);
280 int swf_ShapeAddSolidFillStyle(SHAPE * s,RGBA * color);
281 int swf_ShapeAddBitmapFillStyle(SHAPE * s,MATRIX * m,U16 id_bitmap,int clip);
283 int swf_SetShapeStyles(TAG * t,SHAPE * s);
284 int swf_ShapeCountBits(SHAPE * s,U8 * fbits,U8 * lbits);
285 int swf_SetShapeBits(TAG * t,SHAPE * s);
286 int swf_SetShapeHeader(TAG * t,SHAPE * s); // one call for upper three functions
288 int swf_ShapeSetMove(TAG * t,SHAPE * s,S32 x,S32 y);
289 int swf_ShapeSetStyle(TAG * t,SHAPE * s,U16 line,U16 fill0,U16 fill1);
290 int swf_ShapeSetAll(TAG * t,SHAPE * s,S32 x,S32 y,U16 line,U16 fill0,U16 fill1);
292 int swf_ShapeSetLine(TAG * t,SHAPE * s,S32 x,S32 y);
293 int swf_ShapeSetCurve(TAG * t,SHAPE * s,S32 x,S32 y,S32 ax,S32 ay);
294 int swf_ShapeSetCircle(TAG * t,SHAPE * s,S32 x,S32 y,S32 rx,S32 ry);
295 int swf_ShapeSetEnd(TAG * t);
300 // does not support wide characters !
302 #define MAX_CHAR_PER_FONT 512
304 typedef struct _KERNING
311 typedef struct _SWFLAYOUT
317 SWFKERNING * kerning;
318 } SWFLAYOUT, * LPSWFLAYOUT;
325 typedef struct _SWFFONT
326 { int id; // -1 = not set
327 U8 version; // 0 = not set, 1 = definefont, 2 = definefont2
331 U16 maxascii; // highest mapped ascii value
332 U8 flags; // bold/italic/unicode/ansi ...
336 } SWFFONT, * LPSWFFONT;
338 typedef struct _FONTUSAGE
339 { U8 code[MAX_CHAR_PER_FONT];
340 } FONTUSAGE, * LPFONTUSAGE;
342 int swf_FontEnumerate(SWF * swf,void (*FontCallback) (U16,U8*));
343 // -> void fontcallback(U16 id,U8 * name); returns number of defined fonts
345 int swf_FontExtract(SWF * swf,int id,SWFFONT ** f);
346 // Fetches all available information from DefineFont, DefineFontInfo, DefineText, ...
347 // id = FontID, id=0 -> Extract first Font
349 int swf_FontIsItalic(SWFFONT * f);
350 int swf_FontIsBold(SWFFONT * f);
352 int swf_FontSetID(SWFFONT * f,U16 id);
353 int swf_FontReduce(SWFFONT * f,FONTUSAGE * use);
355 int swf_FontInitUsage(FONTUSAGE * use);
356 int swf_FontUse(FONTUSAGE * use,U8 * s);
358 int swf_FontSetDefine(TAG * t,SWFFONT * f);
359 int swf_FontSetInfo(TAG * t,SWFFONT * f);
361 // the following two functions are obsolete and will be removed soon
362 int swf_FontExport(int handle,SWFFONT * f);
363 int swf_FontImport(int handle,SWFFONT * * f);
365 void swf_WriteFont(SWFFONT* font, char* filename, int useDefineFont2);
366 SWFFONT* swf_ReadFont(char* filename);
368 void swf_FontFree(SWFFONT * f);
370 U32 swf_TextGetWidth(SWFFONT * font,U8 * s,int scale);
371 int swf_TextCountBits(SWFFONT * font,U8 * s,int scale,U8 * gbits,U8 * abits);
373 int swf_TextSetInfoRecord(TAG * t,SWFFONT * font,U16 size,RGBA * color,S16 dx,S16 dy);
374 int swf_TextSetCharRecord(TAG * t,SWFFONT * font,U8 * s,int scale,U8 gbits,U8 abits);
376 int swf_TextPrintDefineText(TAG * t,SWFFONT * f);
377 // Prints text defined in tag t with font f to stdout
381 void swf_DumpHeader(FILE * f,SWF * swf);
382 void swf_DumpMatrix(FILE * f,MATRIX * m);
383 void swf_DumpTag(FILE * f,TAG * t);
384 char* swf_TagGetName(TAG*tag);
385 void swf_DumpFont(SWFFONT * font);
389 // Always use ST_PLACEOBJECT2 !!!
391 int swf_ObjectPlace(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name);
392 int swf_ObjectPlaceClip(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name, U16 clipaction);
393 int swf_ObjectMove(TAG * t,U16 depth,MATRIX * m,CXFORM * cx);
406 #define BC_OVERDOWN_IDLE 0x0100
407 #define BC_IDLE_OVERDOWN 0x0080
408 #define BC_OUTDOWN_IDLE 0x0040
409 #define BC_OUTDOWN_OVERDOWN 0x0020
410 #define BC_OVERDOWN_OUTDOWN 0x0010
411 #define BC_OVERDOWN_OVERUP 0x0008
412 #define BC_OVERUP_OVERDOWN 0x0004
413 #define BC_OVERUP_IDLE 0x0002
414 #define BC_IDLE_OVERUP 0x0001
416 #define BC_KEY(c) (c<<9)
418 #define BC_CURSORLEFT 0x0200
419 #define BC_CURSORRIGHT 0x0400
420 #define BC_POS1 0x0600
421 #define BC_END 0x0800
422 #define BC_INSERT 0x0a00
423 #define BC_DELETE 0x0c00
424 #define BC_BACKSPACE 0x1000
425 #define BC_ENTER 0x1a00
426 #define BC_CURSORUP 0x1c00
427 #define BC_CURSORDOWN 0x1e00
428 #define BC_PAGEUP 0x2000
429 #define BC_PAGEDOWN 0x2200
430 #define BC_TAB 0x2400
431 #define BC_SPACE 0x4000
435 #define BF_TRACKMENU 0x01
437 int swf_ButtonSetRecord(TAG * t,U8 state,U16 id,U16 layer,MATRIX * m,CXFORM * cx);
438 int swf_ButtonSetCondition(TAG * t,U16 condition); // for DefineButton2
439 int swf_ButtonSetFlags(TAG * t,U8 flags); // necessary for DefineButton2
440 int swf_ButtonPostProcess(TAG * t,int anz_action); // Set all offsets in DefineButton2-Tags (how many conditions to process)
444 typedef int JPEGBITS,* LPJPEGBITS; // cover libjpeg structures
446 JPEGBITS * swf_SetJPEGBitsStart(TAG * t,int width,int height,int quality);
447 int swf_SetJPEGBitsLines(JPEGBITS * jpegbits,U8 ** data,int n);
448 int swf_SetJPEGBitsLine(JPEGBITS * jpegbits,U8 * data);
449 int swf_SetJPEGBitsFinish(JPEGBITS * jpegbits);
451 int swf_SetJPEGBits(TAG * t,char * fname,int quality); // paste jpg file into swf stream
453 #define BYTES_PER_SCANLINE(width) ((width+3)&0xfffffffc)
455 #define BMF_8BIT 3 // Bitmap formats
459 #define BM16_BLUE 0xf800 // Bitmasks for 16 Bit Color
460 #define BM16_RED 0x00f0
461 #define BM16_GREEN 0x000f
463 #define BM32_BLUE 0xff000000 // Bitmasks for 32 Bit Color
464 #define BM32_GREEN 0x00ff0000
465 #define BM32_RED 0x0000ff00
467 int swf_SetLosslessBits(TAG * t,U16 width,U16 height,void * bitmap,U8 bitmap_flags);
468 int swf_SetLosslessBitsIndexed(TAG * t,U16 width,U16 height,U8 * bitmap,RGBA * palette,U16 ncolors);
469 int swf_SetLosslessBitsGrayscale(TAG * t,U16 width,U16 height,U8 * bitmap);
473 U8 swf_isDefiningTag(TAG * t);
474 U8 swf_isAllowedSpriteTag(TAG * t);
475 U16 swf_GetDefineID(TAG * t);
476 U16 swf_GetPlaceID(TAG * t); //PLACEOBJECT, PLACEOBJECT2 (sometimes), REMOVEOBJECT
477 U16 swf_GetDepth(TAG * t); //PLACEOBJECT,PLACEOBJECT2,REMOVEOBJECT,REMOVEOBJECT2
478 char* swf_GetName(TAG * t); //PLACEOBJECT2, FRAMELABEL
479 MATRIX * swf_MatrixJoin(MATRIX * d,MATRIX * s1,MATRIX * s2);
480 MATRIX * swf_MatrixMapTriangle(MATRIX * m,int dx,int dy,
481 int x0,int y0,int x1,int y1,int x2,int y2);
486 void swf_uncgi(); // same behaviour as Steven Grimm's uncgi-library
490 ActionTAG* swf_ActionGet(TAG*tag);
491 void swf_ActionFree(ActionTAG*tag);
492 void swf_ActionSet(TAG*tag, ActionTAG*actions);
493 void swf_DumpActions(ActionTAG*atag, char*prefix);
494 void swf_ActionEnumerateURLs(ActionTAG*atag, char*(*callback)(char*));
495 void swf_ActionEnumerateTargets(ActionTAG*atag, char*(*callback)(char*));
496 void swf_ActionEnumerateStrings(ActionTAG*atag, char*(*callback)(char*));
498 ActionTAG* swf_ActionStart();
500 void action_NextFrame();
501 void action_PreviousFrame();
504 void action_ToggleQuality();
505 void action_StopSounds();
507 void action_Subtract();
508 void action_Multiply();
509 void action_Divide();
510 void action_Equals();
515 void action_StringEquals();
516 void action_StringLength();
517 void action_StringExtract();
519 void action_ToInteger();
520 void action_GetVariable();
521 void action_SetVariable();
522 void action_SetTarget2();
523 void action_StringAdd();
524 void action_GetProperty();
525 void action_SetProperty();
526 void action_CloneSprite();
527 void action_RemoveSprite();
529 void action_StartDrag();
530 void action_EndDrag();
531 void action_StringLess();
532 void action_RandomNumber();
533 void action_MBStringLength();
534 void action_CharToAscii();
535 void action_AsciiToChar();
536 void action_GetTime();
537 void action_MBStringExtract();
538 void action_MBCharToAscii();
539 void action_MBAsciiToChar();
540 void action_Delete();
541 void action_Delete2();
542 void action_DefineLocal();
543 void action_CallFunction();
544 void action_Return();
545 void action_Modulo();
546 void action_NewObject();
547 void action_DefineLocal2();
548 void action_InitArray();
549 void action_Makehash();
550 void action_TypeOf();
551 void action_TargetPath();
552 void action_Enumerate();
555 void action_Equals2();
556 void action_ToNumber();
557 void action_ToString();
558 void action_PushDuplicate();
559 void action_StackSwap();
560 void action_GetMember();
561 void action_SetMember();
562 void action_Increment();
563 void action_Decrement();
564 void action_CallMethod();
565 void action_NewMethod();
566 void action_BitAnd();
568 void action_BitXor();
569 void action_BitLShift();
570 void action_BitRShift();
571 void action_BitURShift();
572 void action_GotoFrame(U16 frame);
573 void action_GetUrl(char* url, char* label);
574 void action_StoreRegister(U8 reg);
575 void action_Constantpool(char* constantpool);
576 void action_WaitForFrame(U16 frame, U8 skip);
577 void action_SetTarget(char* target);
578 void action_GotoLabel(char* label);
579 void action_WaitForFrame2(U8 skip);
580 void action_With(char*object);
581 void action_PushString(char*str);
582 void action_PushFloat(float f);
583 void action_PushNULL();
584 void action_PushRegister(U8 reg);
585 void action_PushBoolean(char c);
586 void action_PushDouble(double d);
587 void action_PushInt(int i);
588 void action_PushLookup(U8 index);
589 void action_Jump(U16 branch);
590 void action_GetUrl2(U8 method);
591 void action_DefineFunction(U8*data, int len);
592 void action_If(U16 branch);
594 void action_GotoFrame2(U8 method);
595 void swf_ActionEnd();