workbench/classes/datatypes/animation/animationclass.h

   1 /*
   2     Copyright © 2015-2016, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #include <graphics/gfx.h>
   7 #include <datatypes/pictureclass.h>
   8 #include <datatypes/animationclass.h>
   9 #include <datatypes/animationclassext.h>
  10
  11 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
  12 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
  13
  14 /*
  15     api flags
  16  */
  17 #define ANIMDF_CONTROLPANEL     (1 << 0)
  18 #define ANIMDF_IMMEDIATE        (1 << 1)
  19 #define ANIMDF_REPEAT           (1 << 2)
  20 #define ANIMDF_REMAP            (1 << 3)
  21 #define ANIMDF_ADJUSTPALETTE    (1 << 4)
  22 #define ANIMDF_ADAPTFPS         (1 << 5)
  23 #define ANIMDF_FRAMESKIP        (1 << 6)
  24 #define ANIMDF_SMARTSKIP        (1 << 7)
  25
  26 /*
  27     special flags used by rendering/layout code
  28  */
  29 #define ANIMDF_LAYOUT           (1 << 29)
  30 #define ANIMDF_REMAPPEDPENS     (1 << 30)
  31 #define ANIMDF_SHOWPANEL        (1 << 31)
  32
  33 #define ANIMPLAYER_TICKFREQ     ((struct RealTimeBase *)RealTimeBase)->rtb_Reserved1
  34
  35 struct ProcessPrivate;
  36 struct Animation_Data;
  37 struct AnimFrame;
  38 BOOL ProcEnabled(struct ProcessPrivate *, volatile ULONG *, ULONG);
  39 void cacheFrame(struct Animation_Data *, struct AnimFrame *);
  40 void freeFrame(struct Animation_Data *, struct AnimFrame *);
  41
  42 struct AnimColor_Data
  43 {
  44     struct SignalSemaphore      acd_PenLock;
  45     struct ColorMap             *acd_ColorMap;
  46     struct ColorRegister        *acd_ColorRegs;
  47     ULONG                       *acd_CRegs;
  48     ULONG                       *acd_GRegs;
  49
  50     UWORD                       acd_NumColors;
  51     UWORD                       acd_NumAlloc;
  52
  53     UBYTE                       *acd_ColorTable[2];
  54     UBYTE                       *acd_Allocated;          /* pens we have actually allocated      */
  55     ULONG                       acd_PenPrecison;         /* precision to use allocating pens     */
  56 };
  57
  58 struct AnimFrame_Data
  59 {
  60     struct SignalSemaphore      afd_AnimFramesLock;
  61     struct List                 afd_AnimFrames;
  62
  63     UWORD                       afd_Frames;              /* # of frames                          */
  64     UWORD                       afd_FrameCurrent;        /* # of current frame                   */
  65     UWORD                       afd_FramesStep;          /* how much to skip back/fwd            */
  66 };
  67
  68 struct AnimTimer_Data
  69 {
  70     UWORD                       atd_FramesPerSec;        /* Playback rate                        */
  71     UWORD                       atd_TicksPerFrame;       /* realtime.libraries tick frequency /
  72                                                            ad_FramesPerSec */
  73     UWORD                       atd_Tick;
  74 };
  75
  76 /* our nodes used to play the anim! */
  77 struct AnimFrame
  78 {
  79     struct Node                 af_Node;
  80 #define af_CacheBM af_Node.ln_Name
  81     struct adtNewFormatFrame    af_Frame;
  82 };
  83
  84 /* for sanity, we embed the frame number in the ln_type/ln_pri fields */
  85 #define NODEID(node)  *((UWORD *)(&((struct AnimFrame *)node)->af_Node.ln_Type))
  86
  87
  88 struct Animation_Data
  89 {
  90     ULONG                       ad_Flags;               /* object control flags                 */
  91     char                        *ad_BaseName;
  92
  93     struct Window               *ad_Window;
  94
  95     struct AnimFrame_Data       ad_FrameData;
  96     struct AnimTimer_Data       ad_TimerData;
  97
  98     struct BitMap               *ad_FrameBM;        /* currently displayed frame            */
  99     struct BitMap               *ad_CacheBM;        /* .. */
 100     struct AnimFrame            *ad_KeyFrame;       /* animations key (first) frame         */
 101
 102     UWORD                       ad_VertTop;             /* Y offset of visible rectangle        */
 103     UWORD                       ad_VertTotal;
 104     UWORD                       ad_VertVis;
 105     UWORD                       ad_HorizTop;            /* X offset of visible rectangle        */
 106     UWORD                       ad_HorizTotal;
 107     UWORD                       ad_HorizVis;
 108
 109     UWORD                       ad_RenderLeft;
 110     UWORD                       ad_RenderTop;
 111     UWORD                       ad_RenderWidth;
 112     UWORD                       ad_RenderHeight;
 113
 114     IPTR                        ad_ModeID;
 115     struct BitMapHeader         ad_BitMapHeader;        /* objects embedded bitmap header       */
 116
 117     struct AnimColor_Data       ad_ColorData;
 118
 119     IPTR                        ad_ProcStack;
 120     struct ProcessPrivate       *ad_ProcessData;
 121     struct Process              *ad_BufferProc;         /* buffering process */
 122     struct Process              *ad_PlayerProc;         /* playback process */
 123     struct Player               *ad_Player;
 124     struct Hook                 ad_PlayerHook;
 125
 126     struct Gadget               *ad_Tapedeck;
 127     ULONG                       ad_BufferTime;         /* (prefs) how many seconds to buffer  */
 128     ULONG                       ad_BufferStep;         /* (prefs) no of frames to try to load in one go */
 129     UBYTE                       ad_PlayerSourceLastState;
 130 };
 131
 132 struct ProcessPrivate
 133 {
 134     Object                      *pp_Object;
 135     struct Animation_Data       *pp_Data;
 136     char                        *pp_PlayBackName;
 137     char                        *pp_BufferingName;
 138     volatile ULONG              pp_PlayerFlags;
 139     volatile ULONG              pp_BufferFlags;
 140     ULONG                       pp_BufferFrames;       /* no of frames to buffer in total       */
 141     ULONG                       pp_BufferLevel;        /* no of frames buffered                 */
 142     IPTR                        pp_BufferSpecific;     /* specific frame to load                */
 143     struct AnimFrame            *pp_BufferFirst;       /* starting point to load from           */
 144     struct AnimFrame            *pp_PlaybackFrame;
 145
 146     ULONG                       pp_BufferSigMask;
 147     UBYTE                       pp_BufferEnable;
 148     UBYTE                       pp_BufferDisable;
 149     UBYTE                       pp_BufferFill;
 150     UBYTE                       pp_BufferPurge;
 151
 152     ULONG                       pp_PlaybackSigMask;
 153     UBYTE                       pp_PlaybackEnable;
 154     UBYTE                       pp_PlaybackDisable;
 155     UBYTE                       pp_PlaybackTick;          /* signal frames needs to change      */
 156     UBYTE                       pp_PlaybackSync;          /* signal position changed            */
 157 };
 158
 159 #define PRIVPROCF_ENABLED       (1 << 0)
 160 #define PRIVPROCF_RUNNING       (1 << 1)
 161 #define PRIVPROCF_ACTIVE        (1 << 2)
 162 #define PRIVPROCF_BUSY          (1 << 3)
 163
 164 #define TAG_PRIVATE                     (ADTA_Dummy + 100)
 165 #define PRIVATE_INITPLAYER              (TAG_PRIVATE - 1)
 166 #define PRIVATE_ALLOCCOLORTABLES        (TAG_PRIVATE - 2)
 167 #define PRIVATE_MAPFRAMEPENS            (TAG_PRIVATE - 3)
 168 #define PRIVATE_FREECOLORTABLES         (TAG_PRIVATE - 4)
 169 #define PRIVATE_FREEPENS                (TAG_PRIVATE - 5)
 170 #define PRIVATE_ALLOCBUFFER             (TAG_PRIVATE - 6)
 171 #define PRIVATE_RENDERFRAME             (TAG_PRIVATE - 7)
 172 #define PRIVATE_REMAPFRAME              (TAG_PRIVATE - 8)
 173
 174 struct privAllocColorTables
 175 {
 176     STACKED ULONG MethodID;
 177     STACKED ULONG NumColors;
 178 };
 179
 180 struct privMapFramePens
 181 {
 182     STACKED ULONG MethodID;
 183     STACKED struct AnimFrame *Frame;
 184 };
 185
 186 struct privAllocBuffer
 187 {
 188     STACKED ULONG MethodID;
 189     STACKED struct BitMap *Friend;
 190     STACKED UBYTE Depth;
 191 };
 192
 193 struct privRenderFrame
 194 {
 195     STACKED ULONG MethodID;
 196     STACKED struct AnimFrame *Frame;
 197     STACKED struct BitMap *Target;
 198 };
 199
 200 #if DEBUG > 0
 201 #define DFRAMES(...) bug(__VA_ARGS__);
 202 #else
 203 #define DFRAMES(...)
 204 #endif