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"
20 #include "old_rfxswf.h"
26 typedef unsigned long U32;
27 typedef signed long S32;
28 typedef unsigned short U16;
29 typedef signed short S16;
30 typedef unsigned char U8;
31 typedef signed char S8;
32 typedef signed long SFIXED;
33 typedef signed long SCOORD;
37 typedef struct _SPOINT
56 typedef struct _MATRIX
57 { SFIXED sx; // factor x
59 SFIXED r0; // rotation
65 typedef struct _CXFORM
72 typedef struct _TAG // NEVER access a Tag-Struct directly !
82 U32 memsize; // to minimize realloc() calls
83 U32 pos; // for Get/Set-Access
84 U8 bitmask; // for Bit-Manipulating Functions [read]
85 U8 bitcount; // [write]
88 typedef struct _ActionTAG
93 struct _ActionTAG * next;
94 struct _ActionTAG * prev;
96 TAG* parent; // may be null
102 U32 FileSize; // valid after load and save
105 U16 FrameCount; // valid after load and save
111 int ReadSWF(int handle,SWF * swf); // Reads SWF to memory (malloc'ed), returns length or <0 if fails
112 int WriteSWF(int handle,SWF * swf); // Writes SWF to file, returns length or <0 if fails
113 int WriteCGI(SWF * swf); // Outputs SWF with valid CGI header to stdout
114 void FreeTags(SWF * swf); // Frees all malloc'ed memory for swf
116 TAG * InsertTag(TAG * after,U16 id); // updates frames, if necessary
117 int DeleteTag(TAG * t);
119 void SetTagPos(TAG * t,U32 pos); // resets Bitcount
120 U32 GetTagPos(TAG * t);
122 TAG * NextTag(TAG * t);
123 TAG * PrevTag(TAG * t);
125 int GetFrameNo(TAG * t); // should be renamed to TagGetFrame
126 U16 GetTagID(TAG * t); // ... TagGetID
127 U32 GetDataSize(TAG * t); // ... TagGetDataSize
128 U8* GetDataSizePtr(TAG * t);
130 U32 GetBits(TAG * t,int nbits);
131 S32 GetSBits(TAG * t,int nbits);
132 int SetBits(TAG * t,U32 v,int nbits);
134 int GetBlock(TAG * t,U8 * b,int l); // resets Bitcount
135 int SetBlock(TAG * t,U8 * b,int l);
137 U8 GetU8(TAG * t); // resets Bitcount
141 int SetU8(TAG * t,U8 v); // resets Bitcount
142 int SetU16(TAG * t,U16 v);
143 int SetU32(TAG * t,U32 v);
145 int GetPoint(TAG * t,SPOINT * p); // resets Bitcount
146 int GetRect(TAG * t,SRECT * r);
147 int GetMatrix(TAG * t,MATRIX * m);
148 int GetCXForm(TAG * t,CXFORM * cx,U8 alpha);
150 int SetPoint(TAG * t,SPOINT * p); // resets Bitcount
151 int SetRect(TAG * t,SRECT * r);
152 int SetMatrix(TAG * t,MATRIX * m);
153 int SetCXForm(TAG * t,CXFORM * cx,U8 alpha);
154 int SetRGB(TAG * t,RGBA * col);
155 int SetRGBA(TAG * t,RGBA * col);
159 #define GetS8(tag) ((S8)GetU8(tag))
160 #define GetS16(tag) ((S16)GetU16(tag))
161 #define GetS32(tag) ((S32)GetU32(tag))
162 #define GetCoord(tag) ((SCOORD)GetU32(tag))
163 #define GetFixed(tag) ((SFIXED)GetU32(tag))
165 #define SetS8(tag,v) SetU8(tag,(U8)v)
166 #define SetS16(tag,v) SetU16(tag,(U16)v)
167 #define SetS32(tag,v) SetU32(tag,(U32)v)
168 #define SetCoord(tag,v) SetU32(tag,(U32)v)
169 #define SetFixed(tag,v) SetU32(tag,(U32)v)
170 #define SetString(t,s) SetBlock(t,s,strlen(s)+1)
172 #define FAILED(b) ((b)<0)
173 #define SUCCEDED(b) ((b)>=0)
175 // Tag IDs (adopted from J. C. Kessels' Form2Flash)
178 #define ST_SHOWFRAME 1
179 #define ST_DEFINESHAPE 2
180 #define ST_FREECHARACTER 3
181 #define ST_PLACEOBJECT 4
182 #define ST_REMOVEOBJECT 5
183 #define ST_DEFINEBITS 6
184 #define ST_DEFINEBUTTON 7
185 #define ST_JPEGTABLES 8
186 #define ST_SETBACKGROUNDCOLOR 9
187 #define ST_DEFINEFONT 10
188 #define ST_DEFINETEXT 11
189 #define ST_DOACTION 12
190 #define ST_DEFINEFONTINFO 13
191 #define ST_DEFINESOUND 14 /* Event sound tags. */
192 #define ST_STARTSOUND 15
193 #define ST_DEFINEBUTTONSOUND 17
194 #define ST_SOUNDSTREAMHEAD 18
195 #define ST_SOUNDSTREAMBLOCK 19
196 #define ST_DEFINEBITSLOSSLESS 20 /* A bitmap using lossless zlib compression. */
197 #define ST_DEFINEBITSJPEG2 21 /* A bitmap using an internal JPEG compression table. */
198 #define ST_DEFINESHAPE2 22
199 #define ST_DEFINEBUTTONCXFORM 23
200 #define ST_PROTECT 24 /* This file should not be importable for editing. */
201 #define ST_PLACEOBJECT2 26 /* The new style place w/ alpha color transform and name. */
202 #define ST_REMOVEOBJECT2 28 /* A more compact remove object that omits the character tag (just depth). */
203 #define ST_DEFINESHAPE3 32 /* A shape V3 includes alpha values. */
204 #define ST_DEFINETEXT2 33 /* A text V2 includes alpha values. */
205 #define ST_DEFINEBUTTON2 34 /* A button V2 includes color transform, alpha and multiple actions */
206 #define ST_DEFINEBITSJPEG3 35 /* A JPEG bitmap with alpha info. */
207 #define ST_DEFINEBITSLOSSLESS2 36 /* A lossless bitmap with alpha info. */
208 #define ST_DEFINEEDITTEXT 37
209 #define ST_DEFINEMOVIE 38
210 #define ST_DEFINESPRITE 39 /* Define a sequence of tags that describe the behavior of a sprite. */
211 #define ST_NAMECHARACTER 40 /* Name a character definition, character id and a string, (used for buttons, bitmaps, sprites and sounds). */
212 #define ST_SERIALNUMBER 41
213 #define ST_GENERATORTEXT 42 /* contains an id */
214 #define ST_FRAMELABEL 43 /* A string label for the current frame. */
215 #define ST_SOUNDSTREAMHEAD2 45 /* For lossless streaming sound, should not have needed this... */
216 #define ST_DEFINEMORPHSHAPE 46 /* A morph shape definition */
217 #define ST_DEFINEFONT2 48
218 #define ST_TEMPLATECOMMAND 49
219 #define ST_GENERATOR3 51
220 #define ST_EXTERNALFONT 52
222 #define ST_REFLEX 777 /* to identify generator software */
228 void DumpHeader(FILE * f,SWF * swf);
229 void DumpMatrix(FILE * f,MATRIX * m);
230 void DumpTag(FILE * f,TAG * t);
231 char* getTagName(TAG*tag);
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 NewShape(SHAPE ** s);
274 void ShapeFree(SHAPE * s);
276 int GetSimpleShape(TAG * t,SHAPE ** s); // without Linestyle/Fillstyle Record
277 int SetSimpleShape(TAG * t,SHAPE * s); // without Linestyle/Fillstyle Record
279 int ShapeAddLineStyle(SHAPE * s,U16 width,RGBA * color);
280 int ShapeAddSolidFillStyle(SHAPE * s,RGBA * color);
281 int ShapeAddBitmapFillStyle(SHAPE * s,MATRIX * m,U16 id_bitmap,int clip);
283 int SetShapeStyles(TAG * t,SHAPE * s);
284 int ShapeCountBits(SHAPE * s,U8 * fbits,U8 * lbits);
285 int SetShapeBits(TAG * t,SHAPE * s);
286 int SetShapeHeader(TAG * t,SHAPE * s); // one call for upper three functions
288 int ShapeSetMove(TAG * t,SHAPE * s,S32 x,S32 y);
289 int ShapeSetStyle(TAG * t,SHAPE * s,U16 line,U16 fill0,U16 fill1);
290 int ShapeSetAll(TAG * t,SHAPE * s,S32 x,S32 y,U16 line,U16 fill0,U16 fill1);
292 int ShapeSetLine(TAG * t,SHAPE * s,S32 x,S32 y);
293 int ShapeSetCurve(TAG * t,SHAPE * s,S32 x,S32 y,S32 ax,S32 ay);
294 int ShapeSetCircle(TAG * t,SHAPE * s,S32 x,S32 y,S32 rx,S32 ry);
295 int ShapeSetEnd(TAG * t);
300 // does not support wide characters !
302 #define MAX_CHAR_PER_FONT 256
304 typedef struct _SWFLAYOUT
308 SRECT bounds[MAX_CHAR_PER_FONT];
311 U8 * data; // size = count*4 bytes
313 } SWFLAYOUT, * LPSWFLAYOUT;
315 typedef struct _SWFFONT
320 U8 flags; // bold/italic/unicode/ansi ...
322 U16 codes[MAX_CHAR_PER_FONT];
326 U16 gid; // Glyph-ID after DefineFont
328 } glyph[MAX_CHAR_PER_FONT];
329 } SWFFONT, * LPSWFFONT;
331 typedef struct _FONTUSAGE
332 { U8 code[MAX_CHAR_PER_FONT];
333 } FONTUSAGE, * LPFONTUSAGE;
335 int FontEnumerate(SWF * swf,void (*FontCallback) (U16,U8*));
336 // -> void fontcallback(U16 id,U8 * name); returns number of defined fonts
338 int FontExtract(SWF * swf,int id,SWFFONT ** f);
339 // Fetches all available information from DefineFont, DefineFontInfo, DefineText, ...
340 // id = FontID, id=0 -> Extract first Font
342 int FontIsItalic(SWFFONT * f);
343 int FontIsBold(SWFFONT * f);
345 int FontSetID(SWFFONT * f,U16 id);
346 int FontReduce(SWFFONT * f,FONTUSAGE * use);
348 int FontInitUsage(FONTUSAGE * use);
349 int FontUse(FONTUSAGE * use,U8 * s);
351 int FontSetDefine(TAG * t,SWFFONT * f);
352 int FontSetInfo(TAG * t,SWFFONT * f);
354 int FontExport(int handle,SWFFONT * f);
355 int FontImport(int handle,SWFFONT * * f);
357 void FontFree(SWFFONT * f);
359 U32 TextGetWidth(SWFFONT * font,U8 * s,int scale);
360 int TextCountBits(SWFFONT * font,U8 * s,int scale,U8 * gbits,U8 * abits);
362 int TextSetInfoRecord(TAG * t,SWFFONT * font,U16 size,RGBA * color,S16 dx,S16 dy);
363 int TextSetCharRecord(TAG * t,SWFFONT * font,U8 * s,int scale,U8 gbits,U8 abits);
365 int TextPrintDefineText(TAG * t,SWFFONT * f);
366 // Prints text defined in tag t with font f to stdout
371 // Always use ST_PLACEOBJECT2 !!!
373 int ObjectPlace(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name);
374 int PlaceObject(TAG * t,U16 id,U16 depth,MATRIX * m,CXFORM * cx,U8 * name, U16 clipaction);
375 int ObjectMove(TAG * t,U16 depth,MATRIX * m,CXFORM * cx);
388 #define BC_OVERDOWN_IDLE 0x0100
389 #define BC_IDLE_OVERDOWN 0x0080
390 #define BC_OUTDOWN_IDLE 0x0040
391 #define BC_OUTDOWN_OVERDOWN 0x0020
392 #define BC_OVERDOWN_OUTDOWN 0x0010
393 #define BC_OVERDOWN_OVERUP 0x0008
394 #define BC_OVERUP_OVERDOWN 0x0004
395 #define BC_OVERUP_IDLE 0x0002
396 #define BC_IDLE_OVERUP 0x0001
398 #define BC_KEY(c) (c<<9)
400 #define BC_CURSORLEFT 0x0200
401 #define BC_CURSORRIGHT 0x0400
402 #define BC_POS1 0x0600
403 #define BC_END 0x0800
404 #define BC_INSERT 0x0a00
405 #define BC_DELETE 0x0c00
406 #define BC_BACKSPACE 0x1000
407 #define BC_ENTER 0x1a00
408 #define BC_CURSORUP 0x1c00
409 #define BC_CURSORDOWN 0x1e00
410 #define BC_PAGEUP 0x2000
411 #define BC_PAGEDOWN 0x2200
412 #define BC_TAB 0x2400
413 #define BC_SPACE 0x4000
417 #define BF_TRACKMENU 0x01
419 int ButtonSetRecord(TAG * t,U8 state,U16 id,U16 layer,MATRIX * m,CXFORM * cx);
420 int ButtonSetCondition(TAG * t,U16 condition); // for DefineButton2
421 int ButtonSetFlags(TAG * t,U8 flags); // necessary for DefineButton2
422 int ButtonPostProcess(TAG * t,int anz_action); // Set all offsets in DefineButton2-Tags (how many conditions to process)
426 typedef int JPEGBITS,* LPJPEGBITS; // cover libjpeg structures
428 JPEGBITS * SetJPEGBitsStart(TAG * t,int width,int height,int quality);
429 int SetJPEGBitsLines(JPEGBITS * jpegbits,U8 ** data,int n);
430 int SetJPEGBitsLine(JPEGBITS * jpegbits,U8 * data);
431 int SetJPEGBitsFinish(JPEGBITS * jpegbits);
433 int SetJPEGBits(TAG * t,char * fname,int quality); // paste jpg file into swf stream
435 #define BYTES_PER_SCANLINE(width) ((width+3)&0xfffffffc)
437 #define BMF_8BIT 3 // Bitmap formats
441 #define BM16_BLUE 0xf800 // Bitmasks for 16 Bit Color
442 #define BM16_RED 0x00f0
443 #define BM16_GREEN 0x000f
445 #define BM32_BLUE 0xff000000 // Bitmasks for 32 Bit Color
446 #define BM32_GREEN 0x00ff0000
447 #define BM32_RED 0x0000ff00
449 int SetLosslessBits(TAG * t,U16 width,U16 height,void * bitmap,U8 bitmap_flags);
450 int SetLosslessBitsIndexed(TAG * t,U16 width,U16 height,U8 * bitmap,RGBA * palette,U16 ncolors);
451 int SetLosslessBitsGrayscale(TAG * t,U16 width,U16 height,U8 * bitmap);
455 char isDefiningTag(TAG * t);
456 char isAllowedSpriteTag(TAG * t);
457 U16 GetDefineID(TAG * t);
458 U16 GetPlaceID(TAG * t); //PLACEOBJECT, PLACEOBJECT2 (sometimes), REMOVEOBJECT
459 U16 GetDepth(TAG * t); //PLACEOBJECT,PLACEOBJECT2,REMOVEOBJECT,REMOVEOBJECT2
460 char* GetName(TAG * t); //PLACEOBJECT2, FRAMELABEL
461 MATRIX * MatrixJoin(MATRIX * d,MATRIX * s1,MATRIX * s2);
462 MATRIX * MatrixMapTriangle(MATRIX * m,int dx,int dy,
463 int x0,int y0,int x1,int y1,int x2,int y2);
468 void uncgi(); // same behaviour as Steven Grimm's uncgi-library
472 ActionTAG* GetActions(TAG*tag);
473 void DumpActions(ActionTAG*atag, char*prefix);