o3de/Code/CryEngine/RenderDll/Common/Textures/PlanningTextureStreamer_Jobs.cpp

/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

#include "RenderDll_precompiled.h"
#include "PlanningTextureStreamer.h"

//#define PLAN_TEXSTRM_DEBUG

static int GetTexReqStreamSizePreClamped(const SPlanningTextureOrderKey& key, int reqMip)
{
    int nTotalSize = 0;

    uint8 nFormatCode = key.nFormatCode;
    if (nFormatCode)
    {
        const SStreamFormatCode& code = CTexture::s_formatCodes[nFormatCode];

        uint32 nCodeMip = reqMip + (SStreamFormatCode::MaxMips - key.nMips);
        uint32 nSlices = key.nSlicesMinus1 + 1;
        uint32 nPoTSlices = key.nSlicesPotMinus1 + 1;

        uint32 n1SliceSize = code.sizes[nCodeMip].size;
        uint32 nFormatSlices = isel(-(int)code.sizes[nCodeMip].alignSlices, nSlices, nPoTSlices);
        nTotalSize = n1SliceSize * nFormatSlices;

#if defined(PLAN_TEXSTRM_DEBUG) && defined(TEXSTRM_STORE_DEVSIZES)
        int nTotalSizeTest = key.pTexture->StreamComputeDevDataSize(reqMip);

        if (nTotalSizeTest != nTotalSize)
        {
            __debugbreak();
        }
#endif
    }
    else
    {
#if defined(TEXSTRM_STORE_DEVSIZES)
        nTotalSize = key.pTexture->StreamComputeDevDataSize(reqMip);
#else
        nTotalSize = CDeviceTexture::TextureDataSize(
            max(1, key.nWidth >> reqMip),
            max(1, key.nHeight >> reqMip),
            1,
            key.nMips - reqMip,
            key.nSlicesMinus1 + 1,
            (ETEX_Format)key.eTF);
#endif
    }

    return nTotalSize - key.nPersistentSize;
}

struct CTextureStreamSize
{
    CTextureStreamSize(int nMinMip, int nBias)
        : m_nMinMip(nMinMip)
        , m_nBias(nBias)
    {
    }

    ptrdiff_t operator () (const SPlanningTextureOrderKey& key) const
    {
        int numMips = key.nMips;
        int numPersMips = key.nMipsPersistent;
        int persMip = numMips - numPersMips;
        int reqMip = min(max(static_cast<int>(key.GetFpMinMipCur() + m_nBias) >> 8, m_nMinMip), persMip);
        return GetTexReqStreamSizePreClamped(key, reqMip);
    }

    int m_nMinMip;
    int m_nBias;
};

struct CTexturePrecachedPred
{
    bool operator () (const SPlanningTextureOrderKey& key) const
    {
        return key.IsPrecached();
    }
};

struct CTextureOnScreenPred
{
    bool operator () (const SPlanningTextureOrderKey& key) const
    {
        return key.IsVisible();
    }
};

struct SPlanningTextureOrder
{
    explicit SPlanningTextureOrder(uint32 nKeyMask)
    {
        m_nKeyMask = nKeyMask;
    }

    bool operator () (const SPlanningTextureOrderKey& a, const SPlanningTextureOrderKey& b) const
    {
        uint32 nMask = m_nKeyMask;
        uint32 nAKeyMasked = a.nKey & nMask;
        uint32 nBKeyMasked = b.nKey & nMask;
        if (nAKeyMasked != nBKeyMasked)
        {
            return nAKeyMasked < nBKeyMasked;
        }

        return a.pTexture < b.pTexture;
    }

    uint32 m_nKeyMask;
};

template <typename T, typename Pred>
static void QuickSelectMedianOf3(T* table, size_t a, size_t b, size_t c, const Pred& p)
{
    using std::swap;

    if (p(table[b], table[a]))
    {
        swap(table[b], table[a]);
    }
    if (p(table[c], table[b]))
    {
        swap(table[c], table[b]);
    }
    if (p(table[b], table[a]))
    {
        swap(table[b], table[a]);
    }
}

template <typename T, typename Pred>
static void QuickSelectMedian(T* table, size_t a, size_t m, size_t b, const Pred& p)
{
    if ((b - a) >= 40)
    {
        size_t step = (b - a + 1) / 8;
        QuickSelectMedianOf3(table, a, a + step, a + step * 2, p);
        QuickSelectMedianOf3(table, m - step, m, m + step, p);
        QuickSelectMedianOf3(table, b - step * 2, b - step, b, p);
        QuickSelectMedianOf3(table, a + step, m, b - step, p);
    }
    else
    {
        QuickSelectMedianOf3(table, a, m, b, p);
    }
}

template <typename T, typename LessFunc, typename SizeFunc>
static T* QuickSelectSum(T* p, size_t mn, size_t mx, ptrdiff_t targetSum, const LessFunc& less, const SizeFunc& size)
{
    using std::swap;

    size_t rangeMin = mn, rangeMax = mx;

    do
    {
        size_t pivotIdx = rangeMin + (rangeMax - rangeMin) / 2;
        QuickSelectMedian(p, rangeMin, pivotIdx, rangeMax - 1, less);

        ptrdiff_t leftSum = 0;

        // Move pivot out of the way, so it can be placed at the right location at the end
        T pivotVal = p[pivotIdx];
        swap(p[rangeMax - 1], p[pivotIdx]);

        // - 1 to account for the moved pivot
        size_t left = rangeMin, right = rangeMax - 1;
        while (left < right)
        {
            // Advance left edge past all vals <= pivot
            while (left < right && !less(pivotVal, p[left]))
            {
                leftSum += size(p[left]);
                ++left;
            }

            // Advance right edge past all vals >= pivot
            while (right > left && !less(p[right - 1], pivotVal))
            {
                --right;
            }

            if (right > left)
            {
                // Swap the conflicting values
                swap(p[left], p[right - 1]);
            }
        }

        // Put the pivot back
        swap(p[rangeMax - 1], p[left]);

        if (leftSum >= targetSum)
        {
            rangeMax = left;
        }
        else if (leftSum < targetSum)
        {
            rangeMin = right;
            targetSum -= leftSum;
        }

        if (rangeMax - rangeMin <= 1)
        {
            // Handle the case where the leftSum is under budget (such as the pivot being at the far right edge of the range)
            if (leftSum < targetSum)
            {
                ptrdiff_t pivotSize = size(p[left]);
                if (leftSum + pivotSize <= targetSum)
                {
                    ++left;
                }
            }
            return &p[left];
        }
    }
    while (1);
}

void CPlanningTextureStreamer::Job_UpdateEntry()
{
    FUNCTION_PROFILER_RENDERER;

    m_state = S_Updating;

#ifdef TEXSTRM_DEFER_UMR
    uint32 nList = m_nJobList;
    UpdateMipRequestVec& umrv = m_updateMipRequests[nList];

    for (UpdateMipRequestVec::iterator it = umrv.begin(), itEnd = umrv.end(); it != itEnd; ++it)
    {
        Job_UpdateMip(it->pTexture, it->fMipFactor, it->nFlags, it->nUpdateId);
    }
#endif

    Job_Sort();
    Job_ConfigureSchedule();

    m_state = S_QueuedForSync;
}

void CPlanningTextureStreamer::StartUpdateJob()
{
    m_jobExecutor.Reset();
    m_jobExecutor.StartJob(
        [this]()
        {
            this->Job_UpdateEntry();
        }
    );
}

void CPlanningTextureStreamer::Job_UpdateMip(CTexture* pTexture, const float fMipFactor, const int nFlags, const int nUpdateId)
{
    assert(fMipFactor >= 0.f);

    const int nZoneId = (nFlags & FPR_SINGLE_FRAME_PRIORITY_UPDATE) ? 0 : 1;

    STexStreamingInfo* pStrmInfo = pTexture->m_pFileTexMips;

    if (pStrmInfo && fMipFactor < pStrmInfo->m_fMinMipFactor)
    {
        STexStreamZoneInfo& rZoneInfo = pStrmInfo->m_arrSPInfo[nZoneId];
        STexStreamRoundInfo& rRoundInfo = pTexture->m_streamRounds[nZoneId];

        const int nCurrentRoundUpdateId = m_umrState.arrRoundIds[nZoneId];

        if (rRoundInfo.nRoundUpdateId != nUpdateId)
        {
            STATIC_CHECK(MAX_PREDICTION_ZONES == 2, THIS_CODE_IS_OPTIMISED_ASSUMING_THIS_EQUALS_2);

            // reset mip factor and save the accumulated value into history and compute final mip factor
            float fFinalMipFactor = fMipFactor;
            int nRoundUpdateId = (int)rRoundInfo.nRoundUpdateId;
            if (nRoundUpdateId >= 0 && (nRoundUpdateId > nCurrentRoundUpdateId - 2))
            {
                fFinalMipFactor = min(fFinalMipFactor, rZoneInfo.fMinMipFactor);
            }

            // if the min mip factor is at its default value, initialise the entire history with the new mip factor
            rZoneInfo.fLastMinMipFactor = (float)fsel(rZoneInfo.fMinMipFactor - 1000000.0f, fMipFactor, rZoneInfo.fMinMipFactor);
            rZoneInfo.fMinMipFactor = fMipFactor;

            // reset the high prio flags
            rRoundInfo.bLastHighPriority = rRoundInfo.bHighPriority;
            rRoundInfo.bHighPriority = false;

            // update round id
            rRoundInfo.nRoundUpdateId = max(nUpdateId, nCurrentRoundUpdateId);

            // consider the alternate zone mip factor as well
            const int nOtherZoneId = nZoneId ^ 1;
            const STexStreamZoneInfo& rOtherZoneInfo = pStrmInfo->m_arrSPInfo[nOtherZoneId];
            const STexStreamRoundInfo& rOtherRoundInfo = pTexture->m_streamRounds[nOtherZoneId];
            int nOtherRoundUpdateId = (int)rOtherRoundInfo.nRoundUpdateId;
            if (nOtherRoundUpdateId >= 0 && (nOtherRoundUpdateId > m_umrState.arrRoundIds[nOtherZoneId] - 2))
            {
                fFinalMipFactor = min(fFinalMipFactor, rOtherZoneInfo.fLastMinMipFactor);
            }

            Job_CheckEnqueueForStreaming(pTexture, fFinalMipFactor, rRoundInfo.bLastHighPriority);
        }

        rZoneInfo.fMinMipFactor = min(rZoneInfo.fMinMipFactor, fMipFactor);
        rRoundInfo.bHighPriority = (rRoundInfo.bHighPriority || nFlags & FPR_HIGHPRIORITY);

#if !defined (_RELEASE)
        CTexture::s_TextureUpdates += 1;
#endif
    }

    // And source textures for composition
    if (pTexture->CTexture::GetFlags() & FT_COMPOSITE)
    {
        DynArray<STexComposition>& composition = pTexture->m_composition;

        for (int i = 0, c = composition.size(); i != c; ++i)
        {
            CTexture* pTexFrame = (CTexture*)&*composition[i].pTexture;

            if (pTexFrame->IsStreamed())
            {
                Job_UpdateMip(pTexFrame, fMipFactor, nFlags, nUpdateId);
            }
        }
    }
}

int CPlanningTextureStreamer::Job_Bias(SPlanningSortState& sortState, SPlanningTextureOrderKey* pKeys, size_t nNumPrecachedTexs, size_t nStreamLimit)
{
    FUNCTION_PROFILER_RENDERER;

    int fpSortStateBias = sortState.nBias;
    const int fpSortStateMinBias = sortState.fpMinBias;
    const int fpSortStateMaxBias = sortState.fpMaxBias;
    const int fpSortStateMinMip = sortState.fpMinMip;

    fpSortStateBias = clamp_tpl(fpSortStateBias, fpSortStateMinBias, fpSortStateMaxBias);

    int fpMipBiasLow = fpSortStateMinBias;
    int fpMipBiasHigh = max(fpSortStateMinBias, fpSortStateMaxBias);

    const int nMaxBiasSteps = 8;

    for (int nBiasStep = 0; nBiasStep < nMaxBiasSteps && (fpMipBiasHigh - fpMipBiasLow) > 1; ++nBiasStep)
    {
        int nMipBiasTest = (fpMipBiasLow + fpMipBiasHigh) / 2;

        size_t nBiasedListStreamSize = 0;
        for (size_t texIdx = 0, texCount = nNumPrecachedTexs; texIdx != texCount && nBiasedListStreamSize < nStreamLimit; ++texIdx)
        {
            const SPlanningTextureOrderKey& key = pKeys[texIdx];

            int nMips = key.nMips;
            int fpReqMip = max(fpSortStateMinMip, key.GetFpMinMipCur() + nMipBiasTest);
            int nReqMip = min(fpReqMip >> 8, nMips - 1);

            nBiasedListStreamSize += GetTexReqStreamSizePreClamped(key, nReqMip);
        }

        if (nBiasedListStreamSize < nStreamLimit)
        {
            fpMipBiasHigh = nMipBiasTest;
        }
        else
        {
            fpMipBiasLow = nMipBiasTest;
        }
    }

    int nProspBias = (fpMipBiasLow + fpMipBiasHigh) / 2;
    if (abs(fpSortStateBias - nProspBias) > 8)
    {
        fpSortStateBias = nProspBias;
    }

    return fpSortStateBias;
}

size_t CPlanningTextureStreamer::Job_Plan(SPlanningSortState& sortState, const SPlanningTextureOrderKey* pKeys, size_t nTextures, size_t nNumPrecachedTexs, size_t nBalancePoint, int nMinMip, int fpSortStateBias)
{
    FUNCTION_PROFILER_RENDERER;

    COMPILE_TIME_ASSERT(MAX_PREDICTION_ZONES == 2);

    size_t nListSize = 0;

    enum
    {
        MaxRequests = 16384
    };
    SPlanningRequestIdent requests[MaxRequests];
    size_t nRequests = 0;

    for (size_t texIdx = 0, texCount = nBalancePoint; texIdx != texCount; ++texIdx)
    {
        const SPlanningTextureOrderKey& key = pKeys[texIdx];

        int nMips = key.nMips;
        int cachedMip = key.nCurMip;
        int persMip = nMips - key.nMipsPersistent;
        int cacheMip;

        if (texIdx < nNumPrecachedTexs)
        {
            int16 fpMinMipCur = key.GetFpMinMipCur();

            cacheMip = max((int)(fpMinMipCur + fpSortStateBias) >> 8, nMinMip);
            cacheMip = min(cacheMip, persMip);
        }
        else
        {
            cacheMip = persMip;
        }

        int cacheMipSize = GetTexReqStreamSizePreClamped(key, cacheMip);

        nListSize += cacheMipSize;

        if (!key.bIsStreaming)
        {
            if (cacheMip > cachedMip)
            {
                sortState.pTrimmableList->push_back(key.pTexture);
            }
            else if (cachedMip > cacheMip)
            {
                if (nRequests < MaxRequests)
                {
                    bool bOnlyNeedsTopMip = cacheMip == 0 && cachedMip == 1;

                    uint32 nSortKey =
                        (!key.nIsComposite << 31)
                        | ((int)(cachedMip < (max(0, key.GetFpMinMipCur()) >> 8)) << 30)
                        | ((int)!key.IsHighPriority() << 29)
                        | ((int)bOnlyNeedsTopMip << 28)
                        | ((int)!key.IsVisible() << 27)
                        | ((int)(7 - key.nStreamPrio) << 19)
                        | ((int)!key.IsInZone(0) << 18)
                        | ((int)!key.IsInZone(1) << 17)
                        | (key.GetFpMinMipCurBiased() << 1)
                    ;

                    requests[nRequests++] = SPlanningRequestIdent(nSortKey, (int)texIdx, cacheMip);
                }
            }
        }
        else
        {
            uint32 nStreamSlot = key.pTexture->m_nStreamSlot;
            if (!(nStreamSlot & (CTexture::StreamOutMask | CTexture::StreamPrepMask)))
            {
                STexStreamInState* pStreamInState = CTexture::s_StreamInTasks.GetPtrFromIdx(nStreamSlot & CTexture::StreamIdxMask);
                if (cacheMip > pStreamInState->m_nLowerUploadedMip)
                {
                    sortState.pActionList->push_back(SPlanningAction(SPlanningAction::Abort, texIdx));
                }
            }
        }
    }

    for (size_t texIdx = nBalancePoint, texCount = nTextures; texIdx != texCount; ++texIdx)
    {
        assert(nBalancePoint < nTextures);
        PREFAST_ASSUME(nBalancePoint < nTextures);
        const SPlanningTextureOrderKey& key = pKeys[texIdx];

        int cachedMip = key.nCurMip;
        int nMips = key.nMips;
        int persMip = nMips - key.nMipsPersistent;
        int16 fpMinMipCur = key.GetFpMinMipCur();
        int cacheMip = texIdx < nNumPrecachedTexs
            ? max((int)(fpMinMipCur + fpSortStateBias) >> 8, nMinMip)
            : persMip;

        cacheMip = min(cacheMip, persMip);

        int cacheMipSize = GetTexReqStreamSizePreClamped(key, cacheMip);

        nListSize += cacheMipSize;

        if (!key.bIsStreaming && !key.bUnloaded)
        {
            if (cacheMip > cachedMip)
            {
                sortState.pTrimmableList->push_back(key.pTexture);
            }
            else if (cachedMip > persMip)
            {
                if (nRequests < MaxRequests)    // Persistent mips should always be present - needed in case stream unload occurred
                {
                    uint32 nSortKey =
                        (!key.nIsComposite << 31)
                        | ((int)(cachedMip < (max(0, key.GetFpMinMipCur()) >> 8)) << 30)
                        | ((int)!key.IsHighPriority() << 29)
                        | ((int)!key.IsVisible() << 27)
                        | ((int)(7 - key.nStreamPrio) << 19)
                        | ((int)!key.IsInZone(0) << 18)
                        | ((int)!key.IsInZone(1) << 17)
                        | (key.GetFpMinMipCurBiased() << 1)
                    ;

                    requests[nRequests++] = SPlanningRequestIdent(nSortKey, (int)texIdx, persMip);
                }
            }
            else if (!key.IsPrecached() && cachedMip == persMip)
            {
                sortState.pUnlinkList->push_back(key.pTexture);
            }
        }
    }

    if (nRequests > 0)
    {
        // TODO - only sort the part of the list that can actually be submitted this update
        SPlanningTextureRequestOrder sort_op;
        std::sort(&requests[0], &requests[nRequests], sort_op);

        for (size_t iRequest = 0; iRequest < nRequests; ++iRequest)
        {
            int nRequestMip = requests[iRequest].nMip;
            sortState.pRequestList->push_back(std::make_pair(pKeys[requests[iRequest].nKey].pTexture, nRequestMip));
        }
    }

    return nListSize;
}

void CPlanningTextureStreamer::Job_Sort()
{
    FUNCTION_PROFILER_RENDERER;

    SPlanningSortState& sortState = m_sortState;

    CTexture** pTextures = &(*sortState.pTextures)[0];
    size_t nTextures = sortState.nTextures;

    int nMinMip = sortState.fpMinMip >> 8;

    size_t const nStreamLimit = sortState.nStreamLimit;

    m_keys.resize(nTextures);
    SPlanningTextureOrderKey* pKeys = &m_keys[0];

    int const nFrameId = sortState.nFrameId;
    int const nZoneIds[] = { sortState.arrRoundIds[0], sortState.arrRoundIds[1] };
    Job_InitKeys(pKeys, pTextures, nTextures, nFrameId - 8, nZoneIds);

    SPlanningTextureOrderKey* pLastPrecachedKey = std::partition(pKeys, pKeys + nTextures, CTexturePrecachedPred());
    size_t nNumPrecachedTexs = std::distance(pKeys, pLastPrecachedKey);

    int fpSortStateBias = Job_Bias(sortState, pKeys, nNumPrecachedTexs, nStreamLimit);


    SPlanningTextureOrderKey* pBalanceKey = pKeys + nNumPrecachedTexs;
    if (fpSortStateBias >= 0 && nNumPrecachedTexs > 0)
    {
        SPlanningTextureOrder order(SPlanningTextureOrderKey::OverBudgetMask);
        pBalanceKey = QuickSelectSum(pKeys, 0, nNumPrecachedTexs, nStreamLimit, order, CTextureStreamSize(nMinMip, fpSortStateBias));
    }

    size_t nBalancePoint = std::distance(pKeys, pBalanceKey);



    SPlanningTextureOrderKey* pFirstOffScreenKey = std::partition(pKeys, pKeys + nBalancePoint, CTextureOnScreenPred());
    size_t nOnScreenPoint = std::distance(pKeys, pFirstOffScreenKey);


    size_t nListSize = Job_Plan(sortState, pKeys, nTextures, nNumPrecachedTexs, nBalancePoint, nMinMip, fpSortStateBias);


    Job_CommitKeys(pTextures, pKeys, nTextures);

    sortState.nListSize = nListSize;
    sortState.nBalancePoint = nBalancePoint;
    sortState.nOnScreenPoint = nOnScreenPoint;
    sortState.nPrecachedTexs = nNumPrecachedTexs;
    sortState.nBias = fpSortStateBias;
}

void CPlanningTextureStreamer::Job_InitKeys(SPlanningTextureOrderKey* pKeys, CTexture** pTexs, size_t nTextures, int nFrameId, const int nZoneIds[])
{
    FUNCTION_PROFILER_RENDERER;

    for (size_t i = 0; i < nTextures; ++i)
    {
#if PLANNINGTEXTURESTREAMER_JOBS_CPP_TRAIT_JOB_INITKEYS_PREFETCH
        if ((i + 32) < nTextures)
        {
            _mm_prefetch((char*)(pTexs[i + 32]) + 0x40, 0);
        }
#endif
        new (&pKeys[i])SPlanningTextureOrderKey(pTexs[i], nFrameId, nZoneIds);
    }
}

void CPlanningTextureStreamer::Job_CommitKeys(CTexture** pTextures, SPlanningTextureOrderKey* pKeys, size_t nTextures)
{
    for (size_t i = 0; i < nTextures; ++i)
    {
        pTextures[i] = pKeys[i].pTexture;
    }
}

void CPlanningTextureStreamer::Job_CheckEnqueueForStreaming(CTexture* pTexture, const float fMipFactor, bool bHighPriority)
{

    // calculate the new lod value
    int fpMipIdSigned = pTexture->StreamCalculateMipsSignedFP(fMipFactor);
    const int fpNewMip = max(0, fpMipIdSigned);
    const int nNewMip = fpNewMip >> 8;
    const int nMipIdSigned = fpMipIdSigned >> 8;

    if IsCVarConstAccess(constexpr) (CRenderer::CV_r_TexturesStreamingDebug == 2)
    {
        iLog->Log("Updating mips: %s - Current: %i, Desired: %i", pTexture->m_SrcName.c_str(), pTexture->GetRequiredMipNonVirtual(), nNewMip);
    }

#if defined(ENABLE_TEXTURE_STREAM_LISTENER)
    if (pTexture->GetRequiredMipNonVirtual() != nNewMip)
    {
        ITextureStreamListener* pListener = CTexture::s_pStreamListener;
        if (pListener)
        {
            pListener->OnTextureWantsMip(pTexture, min(nNewMip, (int)pTexture->m_nMips));
        }
    }
#endif

    // update required mip for streaming
    pTexture->m_fpMinMipCur = fpMipIdSigned;

    // update high priority flag
    pTexture->m_bStreamHighPriority |= bHighPriority ? 1 : 0;

#if defined(TEXSTRM_DEFER_UMR)
    __debugbreak();
#else
    pTexture->Relink();
#endif
}

void CPlanningTextureStreamer::Job_ConfigureSchedule()
{
    SPlanningScheduleState& schedule = m_schedule;
    SPlanningSortState& sortState = m_sortState;

    schedule.nFrameId = sortState.nFrameId;
    schedule.nBias = sortState.nBias;
    schedule.memState = sortState.memState;
    schedule.nBalancePoint = sortState.nBalancePoint;
    schedule.nOnScreenPoint = sortState.nOnScreenPoint;
}