binary.h

//
// Copyright 2024 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_BASE_TS_BINARY_H
#define PXR_BASE_TS_BINARY_H
 
#include "pxr/pxr.h"
#include "pxr/base/ts/api.h"
#include "pxr/base/ts/spline.h"
#include "pxr/base/ts/types.h"
#include "pxr/base/vt/dictionary.h"
 
#include <vector>
#include <unordered_map>
#include <cstdint>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
// For writing splines to, and reading them from, binary files.
//
struct Ts_BinaryDataAccess
{
public:
    // Get spline data version that is needed to write the given spline.
    // 1: initial version.
    // 2: added tangent algorithms None and AutoEase
    // 3: added loopBoundaryTime to delimit spline extrapolation loop regions,
    //    and repurposed the time-valued header bit to denote a GfTimeCode
    //    value type
    // 4: added GfDuration valued splines.
    TS_API
    static uint8_t GetBinaryFormatVersion(const TsSpline& spline);
 
    // Write a spline to binary data.  There are two outputs: a blob, and a
    // customData map-of-dictionaries that consists of standard types.
    TS_API
    static void GetBinaryData(
        const TsSpline &spline,
        std::vector<uint8_t> *buf,
        const std::unordered_map<TsTime, VtDictionary> **customDataOut);
 
    // Read a spline out of binary data.
    TS_API
    static TsSpline CreateSplineFromBinaryData(
        const std::vector<uint8_t> &buf,
        std::unordered_map<TsTime, VtDictionary> &&customData);
 
private:
    static TsSpline _ParseV1_4(
        uint8_t version,
        const std::vector<uint8_t> &buf,
        std::unordered_map<TsTime, VtDictionary> &&customData);
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif