https://github.com/scummvm/scummvm
Tip revision: 3001e893d911994ba0110cbef94b44d62d4b35d0 authored by Lothar Serra Mari on 16 July 2022, 19:46:15 UTC
DISTS: WIN32: Specify release date for 2.6.0
DISTS: WIN32: Specify release date for 2.6.0
Tip revision: 3001e89
animation.h
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
// Background animation management module private header
#ifndef SAGA_ANIMATION_H
#define SAGA_ANIMATION_H
namespace Saga {
#define MAX_ANIMATIONS 10
#define DEFAULT_FRAME_TIME 140
#define SAGA_FRAME_START 0xF
#define SAGA_FRAME_END 0x3F
#define SAGA_FRAME_NOOP 0x1F
#define SAGA_FRAME_REPOSITION 0x30
#define SAGA_FRAME_ROW_END 0x2F
#define SAGA_FRAME_LONG_COMPRESSED_RUN 0x20
#define SAGA_FRAME_LONG_UNCOMPRESSED_RUN 0x10
#define SAGA_FRAME_COMPRESSED_RUN 0x80
#define SAGA_FRAME_UNCOMPRESSED_RUN 0x40
#define SAGA_FRAME_EMPTY_RUN 0xC0
enum AnimationState {
ANIM_PLAYING = 0x01,
ANIM_PAUSE = 0x02,
ANIM_STOPPING = 0x03
};
enum AnimationFlags {
ANIM_FLAG_NONE = 0x00,
ANIM_FLAG_ENDSCENE = 0x01 // When animation ends, dispatch scene end event
};
// Cutaway info array member. Cutaways are basically animations with a really
// bad attitude.
struct Cutaway {
uint16 backgroundResourceId;
uint16 animResourceId;
int16 cycles;
int16 frameRate;
};
// Animation info array member
struct AnimationData {
ByteArray resourceData;
uint16 magic;
uint16 screenWidth;
uint16 screenHeight;
byte unknown06;
byte unknown07;
int16 maxFrame;
int16 loopFrame;
int16 currentFrame;
Common::Array<size_t> frameOffsets;
uint16 completed;
uint16 cycles;
int frameTime;
AnimationState state;
int16 linkId;
uint16 flags;
};
class Anim {
public:
Anim(SagaEngine *vm);
~Anim();
void loadCutawayList(const ByteArray &resourceData);
void clearCutawayList();
int playCutaway(int cut, bool fade);
void endCutaway();
void returnFromCutaway();
void clearCutaway();
void showCutawayBg(int bg);
void startVideo(int vid, bool fade);
void endVideo();
void returnFromVideo();
void load(uint16 animId, const ByteArray &resourceData);
void freeId(uint16 animId);
void play(uint16 animId, int vectorTime, bool playing = true);
void link(int16 animId1, int16 animId2);
void setFlag(uint16 animId, uint16 flag);
void clearFlag(uint16 animId, uint16 flag);
void setFrameTime(uint16 animId, int time);
void reset();
void animInfo();
void cutawayInfo();
void setCycles(uint16 animId, int cycles);
void stop(uint16 animId);
void finish(uint16 animId);
void resume(uint16 animId, int cycles);
void resumeAll();
int16 getCurrentFrame(uint16 animId);
int getFrameTime(uint16 animId);
int getCycles(uint16 animId);
bool isPlaying(uint16 animId);
bool hasAnimation(uint16 animId) {
if (animId >= MAX_ANIMATIONS) {
if (animId < MAX_ANIMATIONS + ARRAYSIZE(_cutawayAnimations))
return (_cutawayAnimations[animId - MAX_ANIMATIONS] != NULL);
return false;
}
return (_animations[animId] != NULL);
}
bool hasCutaway() { return _cutawayActive; }
void setCutAwayMode(int mode) { _cutAwayMode = mode; }
// int cutawayListLength() { return _cutawayListLength; }
// int cutawayBgResourceID(int cutaway) { return _cutawayList[cutaway].backgroundResourceId; }
// int cutawayAnimResourceID(int cutaway) { return _cutawayList[cutaway].animResourceId; }
private:
void decodeFrame(AnimationData *anim, size_t frameOffset, byte *buf, size_t bufLength);
int fillFrameOffsets(AnimationData *anim, bool reallyFill = true);
void validateAnimationId(uint16 animId) {
if (animId >= MAX_ANIMATIONS) {
// Cutaway
if (animId >= MAX_ANIMATIONS + ARRAYSIZE(_cutawayAnimations))
error("validateAnimationId: animId out of range");
if (_cutawayAnimations[animId - MAX_ANIMATIONS] == NULL) {
error("validateAnimationId: animId=%i unassigned", animId);
}
} else {
// Animation
if (_animations[animId] == NULL) {
error("validateAnimationId: animId=%i unassigned.", animId);
}
}
}
bool isLongData() const {
if ((_vm->getGameId() == GID_ITE) && (_vm->getPlatform() != Common::kPlatformMacintosh)) {
return false;
}
return true;
}
AnimationData* getAnimation(uint16 animId) {
validateAnimationId(animId);
if (animId >= MAX_ANIMATIONS)
return _cutawayAnimations[animId - MAX_ANIMATIONS];
return _animations[animId];
}
uint16 getAnimationCount() const {
uint16 i = 0;
for (; i < MAX_ANIMATIONS; i++) {
if (_animations[i] == NULL) {
break;
}
}
return i;
}
SagaEngine *_vm;
AnimationData *_animations[MAX_ANIMATIONS];
AnimationData *_cutawayAnimations[2];
Common::Array<Cutaway> _cutawayList;
PalEntry saved_pal[PAL_ENTRIES];
bool _cutawayActive;
int _cutAwayMode;
bool _cutAwayFade;
};
} // End of namespace Saga
#endif // ANIMATION_H_