AnimEncoding_VariableKeyLerp.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    AnimEncoding_VariableKeyLerp.h: Variable key compression.
=============================================================================*/ 
 
#pragma once
 
#include "CoreMinimal.h"
#include "AnimEncoding.h"
#include "AnimationCompression.h"
#include "AnimEncoding_ConstantKeyLerp.h"
 
class FMemoryWriter;
 
class AEFVariableKeyLerpShared : public AEFConstantKeyLerpShared
{
public:
    virtual void ByteSwapRotationIn(
        FUECompressedAnimData& CompressedData,
        FMemoryReader& MemoryReader,
        uint8*& RotTrackData,
        int32 NumKeysRot) override;
 
    virtual void ByteSwapTranslationIn(
        FUECompressedAnimData& CompressedData,
        FMemoryReader& MemoryReader,
        uint8*& TransTrackData,
        int32 NumKeysTransn) override;
 
    virtual void ByteSwapScaleIn(
        FUECompressedAnimData& CompressedData,
        FMemoryReader& MemoryReader,
        uint8*& ScaleTrackData,
        int32 NumKeysScale) override;
 
    virtual void ByteSwapRotationOut(
        FUECompressedAnimData& CompressedData,
        FMemoryWriter& MemoryWriter,
        uint8*& RotTrackData,
        int32 NumKeysRot) override;
 
    virtual void ByteSwapTranslationOut(
        FUECompressedAnimData& CompressedData,
        FMemoryWriter& MemoryWriter,
        uint8*& TransTrackData,
        int32 NumKeysTrans) override;
 
    virtual void ByteSwapScaleOut(
        FUECompressedAnimData& CompressedData,
        FMemoryWriter& MemoryWriter,
        uint8*& ScaleTrackData,
        int32 NumKeysScale) override;
};
 
template<int32 FORMAT>
class AEFVariableKeyLerp : public AEFVariableKeyLerpShared
{
public:
    virtual void GetBoneAtomRotation(FTransform& OutAtom, const FAnimSequenceDecompressionContext& DecompContext, int32 TrackIndex) override;
 
    virtual void GetBoneAtomTranslation(FTransform& OutAtom, const FAnimSequenceDecompressionContext& DecompContext, int32 TrackIndex) override;
 
    virtual void GetBoneAtomScale(FTransform& OutAtom, const FAnimSequenceDecompressionContext& DecompContext, int32 TrackIndex) override;
 
#if USE_ANIMATION_CODEC_BATCH_SOLVER
 
    virtual void GetPoseRotations(
        TArrayView<FTransform>& Atoms,
        const BoneTrackArray& DesiredPairs,
        FAnimSequenceDecompressionContext& DecompContext) override;
 
    virtual void GetPoseTranslations(
        TArrayView<FTransform>& Atoms,
        const BoneTrackArray& DesiredPairs,
        FAnimSequenceDecompressionContext& DecompContext) override;
 
    virtual void GetPoseScales(
        TArrayView<FTransform>& Atoms,
        const BoneTrackArray& DesiredPairs,
        FAnimSequenceDecompressionContext& DecompContext) override;
#endif
 
};
 
 
template<int32 FORMAT>
inline void AEFVariableKeyLerp<FORMAT>::GetBoneAtomRotation(FTransform& OutAtom, const FAnimSequenceDecompressionContext& DecompContext, int32 TrackIndex)
{
    const FUECompressedAnimData& AnimData = static_cast<const FUECompressedAnimData&>(DecompContext.CompressedAnimData);
 
    const int32* RESTRICT TrackData = AnimData.CompressedTrackOffsets.GetData() + (TrackIndex * 4);
    int32 RotKeysOffset = TrackData[2];
    int32 NumRotKeys = TrackData[3];
    const uint8* RESTRICT RotStream = AnimData.CompressedByteStream.GetData() + RotKeysOffset;
 
    if (NumRotKeys == 1)
    {
        // For a rotation track of n=1 keys, the single key is packed as an FQuatFloat96NoW.
        FQuat4f R0;
        DecompressRotation<ACF_Float96NoW>( R0 , RotStream, RotStream );
        OutAtom.SetRotation(FQuat(R0));
    }
    else
    {
        const int32 RotationStreamOffset = (FORMAT == ACF_IntervalFixed32NoW) ? (sizeof(float)*6) : 0; // offset past Min and Range data
        const uint8* RESTRICT FrameTable= RotStream + RotationStreamOffset +(NumRotKeys*CompressedRotationStrides[FORMAT]*CompressedRotationNum[FORMAT]);
        FrameTable = Align(FrameTable, 4);
 
        int32 Index0;
        int32 Index1;
        float Alpha = TimeToIndex(DecompContext.Interpolation, AnimData.CompressedNumberOfKeys, FrameTable, DecompContext.GetRelativePosition(), NumRotKeys, Index0, Index1);
 
 
        if (Index0 != Index1)
        {
            // unpack and lerp between the two nearest keys
            const uint8* RESTRICT KeyData0= RotStream + RotationStreamOffset +(Index0*CompressedRotationStrides[FORMAT]*CompressedRotationNum[FORMAT]);
            const uint8* RESTRICT KeyData1= RotStream + RotationStreamOffset +(Index1*CompressedRotationStrides[FORMAT]*CompressedRotationNum[FORMAT]);
            FQuat4f R0;
            FQuat4f R1;
            DecompressRotation<FORMAT>( R0, RotStream, KeyData0 );
            DecompressRotation<FORMAT>( R1, RotStream, KeyData1 );
 
            // Fast linear quaternion interpolation.
            FQuat4f RLerped = FQuat4f::FastLerp(R0, R1, Alpha);
            RLerped.Normalize();
            OutAtom.SetRotation(FQuat(RLerped));
        }
        else // (Index0 == Index1)
        {
            // unpack a single key
            const uint8* RESTRICT KeyData= RotStream + RotationStreamOffset +(Index0*CompressedRotationStrides[FORMAT]*CompressedRotationNum[FORMAT]);
 
            FQuat4f R0;
            DecompressRotation<FORMAT>( R0, RotStream, KeyData );
 
            OutAtom.SetRotation(FQuat(R0));
        }
    }
 
}
 
template<int32 FORMAT>
inline void AEFVariableKeyLerp<FORMAT>::GetBoneAtomTranslation(FTransform& OutAtom, const FAnimSequenceDecompressionContext& DecompContext, int32 TrackIndex)
{
    const FUECompressedAnimData& AnimData = static_cast<const FUECompressedAnimData&>(DecompContext.CompressedAnimData);
 
    const int32* RESTRICT TrackData = AnimData.CompressedTrackOffsets.GetData() + (TrackIndex * 4);
    int32 TransKeysOffset = TrackData[0];
    int32 NumTransKeys = TrackData[1];
    const uint8* RESTRICT TransStream = AnimData.CompressedByteStream.GetData() + TransKeysOffset;
 
    const int32 TransStreamOffset = ((FORMAT == ACF_IntervalFixed32NoW) && NumTransKeys > 1) ? (sizeof(float) * 6) : 0; // offset past Min and Range data
    const uint8* RESTRICT FrameTable = TransStream + TransStreamOffset + (NumTransKeys * CompressedTranslationStrides[FORMAT] * CompressedTranslationNum[FORMAT]);
    FrameTable= Align(FrameTable, 4);
 
    int32 Index0;
    int32 Index1;
    float Alpha = TimeToIndex(DecompContext.Interpolation, AnimData.CompressedNumberOfKeys, FrameTable, DecompContext.GetRelativePosition(), NumTransKeys, Index0, Index1);
 
    if (Index0 != Index1)
    {
        FVector3f P0;
        FVector3f P1;
        const uint8* RESTRICT KeyData0 = TransStream + TransStreamOffset + Index0*CompressedTranslationStrides[FORMAT]*CompressedTranslationNum[FORMAT];
        const uint8* RESTRICT KeyData1 = TransStream + TransStreamOffset + Index1*CompressedTranslationStrides[FORMAT]*CompressedTranslationNum[FORMAT];
        DecompressTranslation<FORMAT>( P0, TransStream, KeyData0 );
        DecompressTranslation<FORMAT>( P1, TransStream, KeyData1 );
        OutAtom.SetTranslation( (FVector)FMath::Lerp( P0, P1, Alpha ) );
    }
    else // (Index0 == Index1)
    {
        // unpack a single key
        FVector3f P0;
        const uint8* RESTRICT KeyData = TransStream + TransStreamOffset + Index0*CompressedTranslationStrides[FORMAT]*CompressedTranslationNum[FORMAT];
        DecompressTranslation<FORMAT>( P0, TransStream, KeyData);
        OutAtom.SetTranslation( (FVector)P0 );
    }
}
 
template<int32 FORMAT>
inline void AEFVariableKeyLerp<FORMAT>::GetBoneAtomScale(FTransform& OutAtom, const FAnimSequenceDecompressionContext& DecompContext, int32 TrackIndex)
{
    const FUECompressedAnimData& AnimData = static_cast<const FUECompressedAnimData&>(DecompContext.CompressedAnimData);
 
    const int32 ScaleKeysOffset = AnimData.CompressedScaleOffsets.GetOffsetData(TrackIndex, 0);
    const int32 NumScaleKeys = AnimData.CompressedScaleOffsets.GetOffsetData(TrackIndex, 1);
    const uint8* RESTRICT ScaleStream = AnimData.CompressedByteStream.GetData() + ScaleKeysOffset;
 
    const int32 ScaleStreamOffset = ((FORMAT == ACF_IntervalFixed32NoW) && NumScaleKeys > 1) ? (sizeof(float) * 6) : 0; // offset past Min and Range data
    const uint8* RESTRICT FrameTable = ScaleStream + ScaleStreamOffset + (NumScaleKeys * CompressedScaleStrides[FORMAT] * CompressedScaleNum[FORMAT]);
    FrameTable= Align(FrameTable, 4);
 
    int32 Index0;
    int32 Index1;
    float Alpha = TimeToIndex(DecompContext.Interpolation, AnimData.CompressedNumberOfKeys, FrameTable, DecompContext.GetRelativePosition(), NumScaleKeys, Index0, Index1);
 
    if (Index0 != Index1)
    {
        FVector3f P0;
        FVector3f P1;
        const uint8* RESTRICT KeyData0 = ScaleStream + ScaleStreamOffset + Index0*CompressedScaleStrides[FORMAT]*CompressedScaleNum[FORMAT];
        const uint8* RESTRICT KeyData1 = ScaleStream + ScaleStreamOffset + Index1*CompressedScaleStrides[FORMAT]*CompressedScaleNum[FORMAT];
        DecompressScale<FORMAT>( P0, ScaleStream, KeyData0 );
        DecompressScale<FORMAT>( P1, ScaleStream, KeyData1 );
        OutAtom.SetScale3D( (FVector)FMath::Lerp( P0, P1, Alpha ) );
    }
    else // (Index0 == Index1)
    {
        // unpack a single key
        FVector3f P0;
        const uint8* RESTRICT KeyData = ScaleStream + ScaleStreamOffset + Index0*CompressedScaleStrides[FORMAT]*CompressedScaleNum[FORMAT];
        DecompressScale<FORMAT>( P0, ScaleStream, KeyData);
        OutAtom.SetScale3D( (FVector)P0 );
    }
}