movie.cpp

/*
BStone: A Source port of
Blake Stone: Aliens of Gold and Blake Stone: Planet Strike

Copyright (c) 1992-2013 Apogee Entertainment, LLC
Copyright (c) 2013-2015 Boris I. Bendovsky (bibendovsky@hotmail.com)

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 2
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, write to the
Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/


#include "3d_def.h"
#include "an_codes.h"


bool IN_CheckAck();
void VH_UpdateScreen();

void VL_LatchToScreen(
    int source,
    int width,
    int height,
    int x,
    int y);


//
// Various types for various purposes...
//

enum FADES {
    FADE_NONE,
    FADE_SET,
    FADE_IN,
    FADE_OUT,
    FADE_IN_FRAME,
    FADE_OUT_FRAME
}; // FADES


enum MOVIE_FLAGS {
    MV_NONE,
    MV_FILL,
    MV_SKIP,
    MV_READ
}; // MOVIE_FLAGS


// ===========================================================================
//
// VARIABLES
//
// ===========================================================================


// Movie File variables
bstone::FileStream Movie_FHandle;

// Fade Variables
FADES fade_flags, fi_type, fo_type;
uint8_t fi_rate, fo_rate;

// MOVIE_GetFrame & MOVIE_LoadBuffer variables
char* MovieBuffer; // Ptr to Allocated Memory for Buffer
uint32_t BufferLen; // Len of MovieBuffer (Ammount of RAM allocated)
uint32_t PageLen; // Len of data loaded into MovieBuffer
char* BufferPtr; // Ptr to next frame in MovieBuffer
char* NextPtr; // Ptr Ofs to next frame after BufferOfs

bool MorePagesAvail; // More Pages avail on disk?

MOVIE_FLAGS movie_flag;
bool ExitMovie;
bool EverFaded;
int32_t seek_pos;
int8_t movie_reps;
ControlInfo ci;
const void* movie_palette;


//
// MOVIE Definations for external movies
//
// NOTE: This list is ordered according to mv_???? enum list.
//

Movies movies = {
    { "IANIM.", 1, 3, 0, 0, 200, nullptr, }, // mv_intro
    { "EANIM.", 1, 3, 0, 0, 200, nullptr, }, // mv_final
    { "SANIM.", 1, 3, 0, 0, 200, nullptr, }, // mv_final2
    { "GANIM.", 1, 3, 0, 0, 200, nullptr, }, // mv_final3
};


// ===========================================================================
//
// LOCAL PROTO TYPES
//
// ===========================================================================

void JM_MemToScreen();

void JM_ClearVGAScreen(
    uint8_t fill);

void FlipPages();
bool CheckFading();
bool CheckPostFade();


// ===========================================================================
//
// FUNCTIONS
//
// ===========================================================================


// Inits all the internal routines for the Movie Presenter
void SetupMovie(
    MovieStuff_t* MovieStuff)
{
    movie_reps = MovieStuff->rep;
    movie_flag = MV_FILL;
    LastScan = ScanCode::sc_none;
    PageLen = 0;
    MorePagesAvail = true;
    ExitMovie = false;
    EverFaded = false;
    IN_ClearKeysDown();

    movie_palette = MovieStuff->palette;

    ::JM_VGALinearFill(
        0,
        ::vga_ref_width * ::vga_ref_height,
        0);

    VL_FillPalette(0, 0, 0);
    LastScan = ScanCode::sc_none;

    // Find out how much memory we have to work with..

    BufferLen = 65535;
    BufferLen -= 65535; // HACK: Save some room for sounds - This is cludgey

    if (BufferLen < 64256) {
        BufferLen = 64256;
    }

    MovieBuffer = new char[BufferLen];
}

void ShutdownMovie()
{
    delete [] MovieBuffer;
    MovieBuffer = nullptr;

    Movie_FHandle.close();
}

// ---------------------------------------------------------------------------
// void JM_DrawBlock()
//
// dest_offset = Correct offset value for memory location for Paged/Latch mem
//
// byte_offset = Offset for the image to be drawn - This address is NOT
// a calculated Paged/Latch value but a byte offset in
// conventional memory.
//
// source = Source image of graphic to be blasted to latch memory.  This
//                                        pic is NOT 'munged'
//
// length = length of the source image in bytes
// ---------------------------------------------------------------------------
void JM_DrawBlock(
    int dest_offset,
    int byte_offset,
    const char* source,
    int length)
{
    static_cast<void>(dest_offset);

    int x = byte_offset % ::vga_ref_width;
    int y = byte_offset / ::vga_ref_width;

    for (int i = 0; i < length; ++i) {
        VL_Plot(x, y, static_cast<uint8_t>(source[i]));

        ++x;

        if (x == ::vga_ref_width) {
            x = 0;
            ++y;
        }
    }
}

// ---------------------------------------------------------------------------
// MOVIE_ShowFrame() - Shows an animation frame
//
// PARAMETERS: pointer to animpic
// ---------------------------------------------------------------------------
void MOVIE_ShowFrame(
    char* inpic)
{
    anim_chunk* ah;

    if (!inpic) {
        return;
    }

    for ( ; ; ) {
        ah = (anim_chunk*)inpic;

        if (ah->opt == 0) {
            break;
        }

        inpic += sizeof(anim_chunk);
        JM_DrawBlock(bufferofs, ah->offset, (char*)inpic, ah->length);
        inpic += ah->length;
    }
}

// ---------------------------------------------------------------------------
// MOVIE_LoadBuffer() - Loads the RAM Buffer full of graphics...
//
// RETURNS:  true - MORE Pages avail on disk..
//          false   - LAST Pages from disk..
//
// PageLen = Length of data loaded into buffer
//
// ---------------------------------------------------------------------------
bool MOVIE_LoadBuffer()
{
    anim_frame blk;
    long chunkstart;
    char* frame;
    uint32_t free_space;

    NextPtr = BufferPtr = frame = MovieBuffer;
    free_space = BufferLen;

    while (free_space) {
        chunkstart = static_cast<long>(Movie_FHandle.get_position());

        if (Movie_FHandle.read(
                &blk.code,
                sizeof(blk.code)) != sizeof(blk.code))
        {
            ::Quit("Animation file is corrupt or truncated.");
        }

        if (Movie_FHandle.read(
                &blk.block_num,
                sizeof(blk.block_num)) != sizeof(blk.block_num))
        {
            ::Quit("Animation file is corrupt or truncated.");
        }

        if (Movie_FHandle.read(
                &blk.recsize,
                sizeof(blk.recsize)) != sizeof(blk.recsize))
        {
            ::Quit("Animation file is corrupt or truncated.");
        }

        if (blk.code == AN_END_OF_ANIM) {
            return false;
        }

        if (free_space >= (blk.recsize + sizeof(anim_frame))) {
            memcpy(frame, &blk, sizeof(anim_frame));

            free_space -= sizeof(anim_frame);
            frame += sizeof(anim_frame);
            PageLen += sizeof(anim_frame);

            if (Movie_FHandle.read(frame, blk.recsize) != blk.recsize) {
                ::Quit("Animation file is corrupt or truncated.");
            }

            free_space -= blk.recsize;
            frame += blk.recsize;
            PageLen += blk.recsize;
        } else {
            Movie_FHandle.set_position(chunkstart);
            free_space = 0;
        }
    }

    return true;
}

// ---------------------------------------------------------------------------
// MOVIE_GetFrame() - Returns pointer to next Block/Screen of animation
//
// PURPOSE: This function "Buffers" the movie presentation from allocated
//      ram.  It loads and buffers incomming frames of animation..
//
// RETURNS:  0 - Ok
//          1 - End Of File
// ---------------------------------------------------------------------------
int16_t MOVIE_GetFrame()
{
    anim_frame blk;

    if (PageLen == 0) {
        if (MorePagesAvail) {
            MorePagesAvail = MOVIE_LoadBuffer();
        } else {
            return 1;
        }
    }

    BufferPtr = NextPtr;
    memcpy(&blk, BufferPtr, sizeof(anim_frame));
    PageLen -= sizeof(anim_frame);
    PageLen -= blk.recsize;
    NextPtr = BufferPtr + sizeof(anim_frame) + blk.recsize;
    return 0;
}

// ---------------------------------------------------------------------------
// MOVIE_HandlePage() - This handles the current page of data from the
//      ram buffer...
//
// PURPOSE: Process current Page of anim.
//
//
// RETURNS:
//
// ---------------------------------------------------------------------------
void MOVIE_HandlePage(
    MovieStuff_t* MovieStuff)
{
    anim_frame blk;
    char* frame;

    memcpy(&blk, BufferPtr, sizeof(anim_frame));
    BufferPtr += sizeof(anim_frame);
    frame = BufferPtr;

    IN_ReadControl(0, &ci);

    switch (blk.code) {

    case AN_SOUND: // Sound Chunk
    {
        uint16_t sound_chunk;
        sound_chunk = *(uint16_t*)frame;

        ::sd_play_player_sound(
            sound_chunk,
            bstone::AC_ITEM);

        BufferPtr += blk.recsize;
    }
    break;

    case AN_FADE_IN_FRAME: // Fade In Page
        VL_FadeIn(0, 255, (const uint8_t*)movie_palette, 30);
        fade_flags = FADE_NONE;
        EverFaded = true;
        screenfaded = false;
        break;

    case AN_FADE_OUT_FRAME: // Fade Out Page
        VW_FadeOut();
        screenfaded = true;
        fade_flags = FADE_NONE;
        break;

    case AN_PAUSE: // Pause
    {
        uint16_t vbls;
        vbls = *(uint16_t*)frame;
        IN_UserInput(vbls);
        BufferPtr += blk.recsize;

        // BBi
        ::IN_ClearKeysDown();
        ci = {};
        // BBi
    }
    break;



    // -------------------------------------------
    //
    //
    // -------------------------------------------

    case AN_PAGE: // Graphics Chunk
        if (movie_flag == MV_FILL)
        {
            // First page comming in.. Fill screen with fill color...
            //
            movie_flag = MV_NONE; // Set READ flag to skip the first frame on an anim repeat

            ::JM_VGALinearFill(
                0,
                ::vga_ref_width * ::vga_ref_height,
                *frame);

            frame++;
        }
// BBi No need without page flipping
#if 0
        else
        {
            VL_LatchToScreen(
                PAGE1START + ylookup[MovieStuff->start_line],
                ::vga_ref_width / 4,
                MovieStuff->end_line - MovieStuff->start_line,
                0,
                MovieStuff->start_line);
        }
#endif

        MOVIE_ShowFrame(frame);

        FlipPages();

        if (TimeCount < static_cast<uint32_t>(MovieStuff->ticdelay)) {
            const auto min_wait_time = 0;
            const auto max_wait_time = 2 * TickBase; // 2 seconds

            auto wait_time =
                MovieStuff->ticdelay - static_cast<int>(TimeCount);

            if (wait_time < min_wait_time) {
                wait_time = min_wait_time;
            }

            if (wait_time > max_wait_time) {
                wait_time = max_wait_time;
            }

            if (wait_time > 0) {
                wait_time *= 1000;
                wait_time /= TickBase;
                ::sys_sleep_for(wait_time);
            }
        } else {
            ::sys_sleep_for(1000 / TickBase);
        }

        TimeCount = 0;

        if ((!screenfaded) && (ci.button0 || ci.button1 || LastScan != ScanCode::sc_none)) {
            ExitMovie = true;
            if (EverFaded) { // This needs to be a passed flag...
                VW_FadeOut();
                screenfaded = true;
            }
        }
        break;

    case AN_END_OF_ANIM:
        ExitMovie = true;
        break;

    default:
        ::Quit("Unrecognized anim code.");
        break;
    }
}

// ---------------------------------------------------------------------------
// MOVIE_Play() - Playes an Animation
//
// RETURNS: true  - Movie File was found and "played"
//      false - Movie file was NOT found!
// ---------------------------------------------------------------------------
bool MOVIE_Play(
    MovieStuff_t* MovieStuff)
{
    // Init our Movie Stuff...
    //

    SetupMovie(MovieStuff);

    // Start the anim process
    //

    ::ca_open_resource(MovieStuff->file_name, Movie_FHandle);
    if (!Movie_FHandle.is_open()) {
        return false;
    }

    while (movie_reps && (!ExitMovie)) {
        for (; !ExitMovie; ) {
            if (MOVIE_GetFrame()) {
                break;
            }

            MOVIE_HandlePage(MovieStuff);
        }

        movie_reps--;
        movie_flag = MV_SKIP;
    }

    ShutdownMovie();

    return true;
}

void FlipPages()
{
    ::VL_RefreshScreen();
}