-#include "sci/graphics/coordadjuster.h"

-#include "sci/graphics/screen.h"

-#include "sci/video/robot_decoder.h"

-static int dissolveSequences[2][20] = {

- /* SCI2.1early- */ { 3, 6, 12, 20, 48, 96, 184, 272, 576, 1280, 3232, 6912, 13568, 24576, 46080 },

- /* SCI2.1mid+ */ { 0, 0, 3, 6, 12, 20, 48, 96, 184, 272, 576, 1280, 3232, 6912, 13568, 24576, 46080, 73728, 132096, 466944 }

-};

-static int16 divisionsDefaults[2][16] = {

- /* SCI2.1early- */ { 1, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 40, 40, 101, 101 },

- /* SCI2.1mid+ */ { 1, 20, 20, 20, 20, 10, 10, 10, 10, 20, 20, 6, 10, 101, 101, 2 }

-};

-static int16 unknownCDefaults[2][16] = {

- /* SCI2.1early- */ { 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 0, 0, 0, 0 },

- /* SCI2.1mid+ */ { 0, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 0, 0, 7, 7, 0 }

-};

-

-GfxFrameout::GfxFrameout(SegManager *segMan, ResourceManager *resMan, GfxCoordAdjuster *coordAdjuster, GfxScreen *screen, GfxPalette32 *palette) :

- _isHiRes(false),

- _resMan(resMan),

- _screen(screen),

- _showStyles(nullptr),

- // TODO: Stop using _gfxScreen

- _currentBuffer(screen->getDisplayWidth(), screen->getDisplayHeight(), nullptr),

- _screenRect(screen->getDisplayWidth(), screen->getDisplayHeight()),

- _currentBuffer.setPixels(calloc(1, screen->getDisplayWidth() * screen->getDisplayHeight()));

-

- for (int i = 0; i < 236; i += 2) {

- _styleRanges[i] = 0;

- _styleRanges[i + 1] = -1;

- }

- for (int i = 236; i < ARRAYSIZE(_styleRanges); ++i) {

- _styleRanges[i] = 0;

- }

-

- // TODO: Make hires detection work uniformly across all SCI engine

- // versions (this flag is normally passed by SCI::MakeGraphicsMgr

- // to the GraphicsMgr constructor depending upon video configuration,

- // so should be handled upstream based on game configuration instead

- // of here)

- if (getSciVersion() >= SCI_VERSION_2_1_EARLY && _resMan->detectHires()) {

- _isHiRes = true;

- if (getSciVersion() < SCI_VERSION_2_1_MIDDLE) {

- _dissolveSequenceSeeds = dissolveSequences[0];

- _defaultDivisions = divisionsDefaults[0];

- _defaultUnknownC = unknownCDefaults[0];

- _dissolveSequenceSeeds = dissolveSequences[1];

- _defaultDivisions = divisionsDefaults[1];

- _defaultUnknownC = unknownCDefaults[1];

-

- // TODO: Nothing in the renderer really uses this. Currently,

- // the cursor renderer does, and kLocalToGlobal/kGlobalToLocal

- // do, but in the real engine (1) the cursor is handled in

- // frameOut, and (2) functions do a very simple lookup of the

- // plane and arithmetic with the plane's gameRect. In

- // principle, CoordAdjuster could be reused for

- // convertGameRectToPlaneRect, but it is not super clear yet

- // what the benefit would be to do that.

- _coordAdjuster = (GfxCoordAdjuster32 *)coordAdjuster;

-

- // TODO: Script resolution is hard-coded per game;

- // also this must be set or else the engine will crash

- _coordAdjuster->setScriptsResolution(_currentBuffer.scriptWidth, _currentBuffer.scriptHeight);

-void GfxFrameout::kernelAddPicAt(const reg_t planeObject, const GuiResourceId pictureId, const int16 x, const int16 y, const bool mirrorX) {

- plane->addPic(pictureId, Common::Point(x, y), mirrorX);

-// TODO: Robot

-// if (_robot != nullptr) {

-// _robot.doRobot();

-// }

-// TODO: Robot

-// if (_robot != nullptr) {

-// _robot->frameAlmostVisible();

-// }

-// TODO: Robot

-// if (_robot != nullptr) {

-// robot->frameNowVisible();

-// }

-void GfxFrameout::palMorphFrameOut(const int8 *styleRanges, const ShowStyleEntry *showStyle) {

- Palette sourcePalette(_palette->getNextPalette());

- alterVmap(sourcePalette, sourcePalette, -1, styleRanges);

-

- int16 prevRoom = g_sci->getEngineState()->variables[VAR_GLOBAL][12].toSint16();

-

- Common::Rect rect(_screen->getDisplayWidth(), _screen->getDisplayHeight());

- _showList.add(rect);

- showBits();

-

- // NOTE: The original engine allocated these as static arrays of 100

- // pointers to ScreenItemList / RectList

- ScreenItemListList screenItemLists;

- EraseListList eraseLists;

-

- screenItemLists.resize(_planes.size());

- eraseLists.resize(_planes.size());

-

- if (g_sci->_gfxRemap32->getRemapCount() > 0 && _remapOccurred) {

- remapMarkRedraw();

- }

-

- calcLists(screenItemLists, eraseLists);

- for (ScreenItemListList::iterator list = screenItemLists.begin(); list != screenItemLists.end(); ++list) {

- list->sort();

- }

-

- for (ScreenItemListList::iterator list = screenItemLists.begin(); list != screenItemLists.end(); ++list) {

- for (DrawList::iterator drawItem = list->begin(); drawItem != list->end(); ++drawItem) {

- (*drawItem)->screenItem->getCelObj().submitPalette();

- }

- }

-

- _remapOccurred = _palette->updateForFrame();

- _frameNowVisible = false;

-

- for (PlaneList::size_type i = 0; i < _planes.size(); ++i) {

- drawEraseList(eraseLists[i], *_planes[i]);

- drawScreenItemList(screenItemLists[i]);

- }

-

- Palette nextPalette(_palette->getNextPalette());

-

- if (prevRoom < 1000) {

- for (int i = 0; i < ARRAYSIZE(sourcePalette.colors); ++i) {

- if (styleRanges[i] == -1 || styleRanges[i] == 0) {

- sourcePalette.colors[i] = nextPalette.colors[i];

- sourcePalette.colors[i].used = true;

- }

- }

- } else {

- for (int i = 0; i < ARRAYSIZE(sourcePalette.colors); ++i) {

- // TODO: Limiting range 72 to 103 is NOT present in every game

- if (styleRanges[i] == -1 || (styleRanges[i] == 0 && i > 71 && i < 104)) {

- sourcePalette.colors[i] = nextPalette.colors[i];

- sourcePalette.colors[i].used = true;

- }

- }

- }

-

- _palette->submit(sourcePalette);

- _palette->updateFFrame();

- _palette->updateHardware();

- alterVmap(nextPalette, sourcePalette, 1, _styleRanges);

-

- if (showStyle && showStyle->type != kShowStyleUnknown) {

-// TODO: SCI2.1mid transition effects

-// processEffects();

- warning("Transition %d not implemented!", showStyle->type);

- } else {

- showBits();

- }

-

- _frameNowVisible = true;

-

- for (PlaneList::iterator plane = _planes.begin(); plane != _planes.end(); ++plane) {

- (*plane)->_redrawAllCount = getScreenCount();

- }

-

- if (g_sci->_gfxRemap32->getRemapCount() > 0 && _remapOccurred) {

- remapMarkRedraw();

- }

-

- calcLists(screenItemLists, eraseLists);

- for (ScreenItemListList::iterator list = screenItemLists.begin(); list != screenItemLists.end(); ++list) {

- list->sort();

- }

-

- for (ScreenItemListList::iterator list = screenItemLists.begin(); list != screenItemLists.end(); ++list) {

- for (DrawList::iterator drawItem = list->begin(); drawItem != list->end(); ++drawItem) {

- (*drawItem)->screenItem->getCelObj().submitPalette();

- }

- }

-

- _remapOccurred = _palette->updateForFrame();

- // NOTE: During this second loop, `_frameNowVisible = false` is

- // inside the next loop in SCI2.1mid

- _frameNowVisible = false;

-

- for (PlaneList::size_type i = 0; i < _planes.size(); ++i) {

- drawEraseList(eraseLists[i], *_planes[i]);

- drawScreenItemList(screenItemLists[i]);

- _palette->submit(nextPalette);

- _palette->updateFFrame();

- _palette->updateHardware(false);

- showBits();

-

- _frameNowVisible = true;

-}

-

-void GfxFrameout::showBits() {

-

- // TODO:

- // _cursor->GonnaPaint(rounded);

- // TODO:

- // _cursor->PaintStarting();

- // TODO:

- // _cursor->DonePainting();

- // NOTE: This is currBuffer->ptr in SCI engine

-void GfxFrameout::kernelSetPalStyleRange(const uint8 fromColor, const uint8 toColor) {

- if (toColor > fromColor) {

- return;

- }

-

- for (int i = fromColor; i < toColor; ++i) {

- _styleRanges[i] = 0;

- }

-}

-

-inline ShowStyleEntry * GfxFrameout::findShowStyleForPlane(const reg_t planeObj) const {

- ShowStyleEntry *entry = _showStyles;

- while (entry != nullptr) {

- if (entry->plane == planeObj) {

- break;

- }

- entry = entry->next;

- }

-

- return entry;

-}

-

-inline ShowStyleEntry *GfxFrameout::deleteShowStyleInternal(ShowStyleEntry *const showStyle) {

- ShowStyleEntry *lastEntry = nullptr;

-

- for (ShowStyleEntry *testEntry = _showStyles; testEntry != nullptr; testEntry = testEntry->next) {

- if (testEntry == showStyle) {

- break;

- }

- lastEntry = testEntry;

- }

-

- if (lastEntry == nullptr) {

- _showStyles = showStyle->next;

- lastEntry = _showStyles;

- } else {

- lastEntry->next = showStyle->next;

- }

-

- delete[] showStyle->fadeColorRanges;

- delete showStyle;

-

- // TODO: Verify that this is the correct entry to return

- // for the loop in processShowStyles to work correctly

- return lastEntry;

-}

-

-// TODO: 10-argument version is only in SCI3; argc checks are currently wrong for this version

-// and need to be fixed in future

-// TODO: SQ6 does not use 'priority' (exists since SCI2) or 'blackScreen' (exists since SCI3);

-// check to see if other versions use or if they are just always ignored

-void GfxFrameout::kernelSetShowStyle(const uint16 argc, const reg_t planeObj, const ShowStyleType type, const int16 seconds, const int16 back, const int16 priority, const int16 animate, const int16 frameOutNow, reg_t pFadeArray, int16 divisions, const int16 blackScreen) {

-

- bool hasDivisions = false;

- bool hasFadeArray = false;

-

- // KQ7 2.0b uses a mismatched version of the Styler script (SCI2.1early script

- // for SCI2.1mid engine), so the calls it makes to kSetShowStyle are wrong and

- // put `divisions` where `pFadeArray` is supposed to be

- if (getSciVersion() == SCI_VERSION_2_1_MIDDLE && g_sci->getGameId() == GID_KQ7) {

- hasDivisions = argc > 7;

- hasFadeArray = false;

- divisions = argc > 7 ? pFadeArray.toSint16() : -1;

- pFadeArray = NULL_REG;

- } else if (getSciVersion() < SCI_VERSION_2_1_MIDDLE) {

- hasDivisions = argc > 7;

- hasFadeArray = false;

- } else if (getSciVersion() < SCI_VERSION_3) {

- hasDivisions = argc > 8;

- hasFadeArray = argc > 7;

- } else {

- hasDivisions = argc > 9;

- hasFadeArray = argc > 8;

- }

-

- bool isFadeUp;

- int16 color;

- if (back != -1) {

- isFadeUp = false;

- color = back;

- } else {

- isFadeUp = true;

- color = 0;

- }

-

- if ((getSciVersion() < SCI_VERSION_2_1_MIDDLE && type == 15) || type > 15) {

- error("Illegal show style %d for plane %04x:%04x", type, PRINT_REG(planeObj));

- }

-

- Plane *plane = _planes.findByObject(planeObj);

- if (plane == nullptr) {

- error("Plane %04x:%04x is not present in active planes list", PRINT_REG(planeObj));

- }

-

- bool createNewEntry = true;

- ShowStyleEntry *entry = findShowStyleForPlane(planeObj);

- if (entry != nullptr) {

- // TODO: SCI2.1early has different criteria for show style reuse

- bool useExisting = true;

-

- if (useExisting) {

- useExisting = entry->divisions == (hasDivisions ? divisions : _defaultDivisions[type]) && entry->unknownC == _defaultUnknownC[type];

- }

-

- if (useExisting) {

- createNewEntry = false;

- isFadeUp = true;

- entry->currentStep = 0;

- } else {

- isFadeUp = true;

- color = entry->color;

- deleteShowStyleInternal(entry/*, true*/);

- entry = nullptr;

- }

- }

-

- if (type > 0) {

- if (createNewEntry) {

- entry = new ShowStyleEntry;

- // NOTE: SCI2.1 engine tests if allocation returned a null pointer

- // but then only avoids setting currentStep if this is so. Since

- // this is a nonsensical approach, we do not do that here

- entry->currentStep = 0;

- entry->unknownC = _defaultUnknownC[type];

- entry->processed = false;

- entry->divisions = hasDivisions ? divisions : _defaultDivisions[type];

- entry->plane = planeObj;

-

- entry->fadeColorRanges = nullptr;

- if (hasFadeArray) {

- // NOTE: SCI2.1mid engine does no check to verify that an array is

- // successfully retrieved, and SegMan will cause a fatal error

- // if we try to use a memory segment that is not an array

- SciArray<reg_t> *table = _segMan->lookupArray(pFadeArray);

-

- uint32 rangeCount = table->getSize();

- entry->fadeColorRangesCount = rangeCount;

-

- // NOTE: SCI engine code always allocates memory even if the range

- // table has no entries, but this does not really make sense, so

- // we avoid the allocation call in this case

- if (rangeCount > 0) {

- entry->fadeColorRanges = new uint16[rangeCount];

- for (size_t i = 0; i < rangeCount; ++i) {

- entry->fadeColorRanges[i] = table->getValue(i).toUint16();

- }

- }

- } else {

- entry->fadeColorRangesCount = 0;

- }

- }

-

- // NOTE: The original engine had no nullptr check and would just crash

- // if it got to here

- if (entry == nullptr) {

- error("Cannot edit non-existing ShowStyle entry");

- }

-

- entry->fadeUp = isFadeUp;

- entry->color = color;

- entry->nextTick = g_sci->getTickCount();

- entry->type = type;

- entry->animate = animate;

- entry->delay = (seconds * 60 + entry->divisions - 1) / entry->divisions;

-

- if (entry->delay == 0) {

- if (entry->fadeColorRanges != nullptr) {

- delete[] entry->fadeColorRanges;

- }

- delete entry;

- error("ShowStyle has no duration");

- }

-

- if (frameOutNow) {

- Common::Rect frameOutRect(0, 0);

- frameOut(false, frameOutRect);

- }

-

- if (createNewEntry) {

- // TODO: Implement SCI2.1early and SCI3

- entry->next = _showStyles;

- _showStyles = entry;

- }

- }

-}

-

-// NOTE: Different version of SCI engine support different show styles

-// SCI2 implements 0, 1/3/5/7/9, 2/4/6/8/10, 11, 12, 13, 14

-// SCI2.1 implements 0, 1/2/3/4/5/6/7/8/9/10/11/12/15, 13, 14

-// SCI3 implements 0, 1/3/5/7/9, 2/4/6/8/10, 11, 12/15, 13, 14

-// TODO: Sierra code needs to be replaced with code that uses the

-// computed entry->delay property instead of just counting divisors,

-// as the latter is machine-speed-dependent and leads to wrong

-// transition speeds

-void GfxFrameout::processShowStyles() {

- uint32 now = g_sci->getTickCount();

-

- bool continueProcessing;

-

- // TODO: Change to bool? Engine uses inc to set the value to true,

- // but there does not seem to be any reason to actually count how

- // many times it was set

- int doFrameOut;

- do {

- continueProcessing = false;

- doFrameOut = 0;

- ShowStyleEntry *showStyle = _showStyles;

- while (showStyle != nullptr) {

- bool retval = false;

-

- if (!showStyle->animate) {

- ++doFrameOut;

- }

-

- if (showStyle->nextTick < now || !showStyle->animate) {

- // TODO: Different versions of SCI use different processors!

- // This is the SQ6/KQ7/SCI2.1mid table.

- switch (showStyle->type) {

- case kShowStyleNone: {

- retval = processShowStyleNone(showStyle);

- break;

- }

- case kShowStyleHShutterOut:

- case kShowStyleVShutterOut:

- case kShowStyleWipeLeft:

- case kShowStyleWipeUp:

- case kShowStyleIrisOut:

- case kShowStyleHShutterIn:

- case kShowStyleVShutterIn:

- case kShowStyleWipeRight:

- case kShowStyleWipeDown:

- case kShowStyleIrisIn:

- case kShowStyle11:

- case kShowStyle12:

- case kShowStyleUnknown: {

- retval = processShowStyleMorph(showStyle);

- break;

- }

- case kShowStyleFadeOut: {

- retval = processShowStyleFade(-1, showStyle);

- break;

- }

- case kShowStyleFadeIn: {

- retval = processShowStyleFade(1, showStyle);

- break;

- }

- }

- }

-

- if (!retval) {

- continueProcessing = true;

- }

-

- if (retval && showStyle->processed) {

- showStyle = deleteShowStyleInternal(showStyle);

- } else {

- showStyle = showStyle->next;

- }

- }

-

- if (g_engine->shouldQuit()) {

- return;

- }

-

- if (doFrameOut) {

- frameOut(true);

-

- // TODO: Transitions without the “animate” flag are too

- // fast, but the throttle value is arbitrary. Someone on

- // real hardware probably needs to test what the actual

- // speed of these transitions should be

- throttle();

- }

- } while(continueProcessing && doFrameOut);

-}

-

-bool GfxFrameout::processShowStyleNone(ShowStyleEntry *const showStyle) {

- if (showStyle->fadeUp) {

- _palette->setFade(100, 0, 255);

- } else {

- _palette->setFade(0, 0, 255);

- }

-

- showStyle->processed = true;

- return true;

-}

-

-bool GfxFrameout::processShowStyleMorph(ShowStyleEntry *const showStyle) {

- palMorphFrameOut(_styleRanges, showStyle);

- showStyle->processed = true;

- return true;

-}

-

-// TODO: Normalise use of 'entry' vs 'showStyle'

-bool GfxFrameout::processShowStyleFade(const int direction, ShowStyleEntry *const showStyle) {

- bool unchanged = true;

- if (showStyle->currentStep < showStyle->divisions) {

- int percent;

- if (direction <= 0) {

- percent = showStyle->divisions - showStyle->currentStep - 1;

- } else {

- percent = showStyle->currentStep;

- }

-

- percent *= 100;

- percent /= showStyle->divisions - 1;

-

- if (showStyle->fadeColorRangesCount > 0) {

- for (int i = 0, len = showStyle->fadeColorRangesCount; i < len; i += 2) {

- _palette->setFade(percent, showStyle->fadeColorRanges[i], showStyle->fadeColorRanges[i + 1]);

- }

- } else {

- _palette->setFade(percent, 0, 255);

- }

-

- ++showStyle->currentStep;

- showStyle->nextTick += showStyle->delay;

- unchanged = false;

- }

-

- if (showStyle->currentStep >= showStyle->divisions && unchanged) {

- if (direction > 0) {

- showStyle->processed = true;

- }

-

- return true;

- }

-

- return false;

-}

-

- if (_showStyles != nullptr) {

- processShowStyles();

- palMorphFrameOut(_styleRanges, nullptr);

-// TODO: Window scroll

-// if (g_PlaneScroll) {

-// processScrolls();

-// }

- throttleTime = 17;

- throttleTime = 16;

-void GfxFrameout::kernelSetNowSeen(const reg_t screenItemObject) const {

- error("kSetNowSeen: Screen item %04x:%04x not found in plane %04x:%04x", PRINT_REG(screenItemObject), PRINT_REG(planeObject));