FnAssetSuite.h

// Copyright (c) 2012 The Foundry Visionmongers Ltd. All Rights Reserved.

#ifndef FnAssetSuite_H
#define FnAssetSuite_H

#include <FnAttribute/suite/FnAttributeSuite.h>
#include <cstddef>

extern "C" {


typedef struct FnFileSequenceStruct * FnFileSequenceHandle;

typedef struct FnFileSequenceArrayStruct * FnFileSequenceArrayHandle;


#define FnFileSequencePluginSuite_version 1

struct FnFileSequencePluginSuite_v1
{
    FnFileSequenceHandle (*create)(const char *fileseq, FnAttributeHandle *errorMessage);

    void (*destroy)(FnFileSequenceHandle handle, FnAttributeHandle *errorMessage);

    bool (*isFileSequence)(const char *fileseq, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*buildFileSequenceString)(const char *prefix,
                                                 const char *suffix,
                                                 int padding,
                                                 FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getAsString)(FnFileSequenceHandle handle,
                                     FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getDirectory)(FnFileSequenceHandle handle,
                                      FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getPrefix)(FnFileSequenceHandle handle,
                                   FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getSuffix)(FnFileSequenceHandle handle,
                                   FnAttributeHandle *errorMessage);

    unsigned int (*getPadding)(FnFileSequenceHandle handle,
                               FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getResolvedPath)(FnFileSequenceHandle handle, int frame,
                                         FnAttributeHandle *errorMessage);

    bool (*hasFrameSet)(FnFileSequenceHandle handle,
                        FnAttributeHandle *errorMessage);

    bool (*isFrameInFrameSet)(FnFileSequenceHandle handle, int frame,
                              FnAttributeHandle *errorMessage);

    int (*getFirstFrameInFrameSet)(FnFileSequenceHandle handle,
                                   FnAttributeHandle *errorMessage);

    int (*getLastFrameInFrameSet)(FnFileSequenceHandle handle,
                                  FnAttributeHandle *errorMessage);

    void (*getNearestFramesInFrameSet)(FnFileSequenceHandle handle, int frame,
        bool *hasLeft, int *nearestLeft, bool *hasRight, int *nearestRight,
        FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getFrameListFromFrameSet)(FnFileSequenceHandle handle,
                                                  FnAttributeHandle *errorMessage);

    FnFileSequenceArrayHandle (*findSequence)(const char **fileList,
                                              unsigned int fileCount,
                                              FnAttributeHandle *errorMessage);

    void (*destroyFileSequenceArray)(FnFileSequenceArrayHandle handle,
                                     FnAttributeHandle *errorMessage);

    unsigned int (*getFileSequenceCount)(FnFileSequenceArrayHandle handle,
                                         FnAttributeHandle *errorMessage);

    FnFileSequenceHandle (*getFileSequence)(FnFileSequenceArrayHandle handle,
                                            unsigned int index,
                                            FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getFilenames)(FnFileSequenceArrayHandle handle,
                                      FnAttributeHandle *errorMessage);
};

#define kFnAssetFieldName                  "name"
#define kFnAssetFieldVersion               "version"

#define kFnAssetTypeKatanaScene            "katana scene"
#define kFnAssetTypeMacro                  "macro"
#define kFnAssetTypeLiveGroup              "live group"
#define kFnAssetTypeImage                  "image"
#define kFnAssetTypeLookFile               "look file"
#define kFnAssetTypeLookFileMgrSettings    "look file manager settings"
#define kFnAssetTypeAlembic                "alembic"
#define kFnAssetTypeCastingSheet           "casting sheet"
#define kFnAssetTypeAttributeFile          "attribute file"
#define kFnAssetTypeFCurveFile             "fcurve file"
#define kFnAssetTypeGafferThreeRig         "gafferthree rig"
#define kFnAssetTypeScenegraphBookmarks    "scenegraph bookmarks"
#define kFnAssetTypeShader                 "shader"

#define kFnAssetRelationArgsFile           "related args file"

#define kFnAssetContextKatanaScene         "katana scene context"
#define kFnAssetContextMacro               "macro context"
#define kFnAssetContextLiveGroup           "live group context"
#define kFnAssetContextImage               "image context"
#define kFnAssetContextLookFile            "look file context"
#define kFnAssetContextLookFileMgrSettings "look file manager settings context"
#define kFnAssetContextAlembic             "alembic context"
#define kFnAssetContextCastingSheet        "casting sheet context"
#define kFnAssetContextAttributeFile       "attribute file context"
#define kFnAssetContextFCurveFile          "fcurve file context"
#define kFnAssetContextGafferThreeRig      "gafferthree rig context"
#define kFnAssetContextScenegraphBookmarks "scenegraph bookmarks context"
#define kFnAssetContextShader              "shader context"
#define kFnAssetContextCatalog             "catalog context"
#define kFnAssetContextFarm                "farm context"

#define kFnAssetCreationOptionOutputFormat "outputFormat"

#define kFnAssetOutputFormatArchive        "as archive"

#define kFnAssetOutputFormatDirectory      "as directory"

typedef struct FnAssetStruct * FnAssetHandle;

typedef struct FnAssetTransactionStruct * FnAssetTransactionHandle;


#define FnAssetPluginSuite_version 1

struct FnAssetPluginSuite_v1
{
    FnAssetHandle (*create)();

    void (*destroy)(FnAssetHandle handle);

    void (*reset)(FnAssetHandle handle, FnAttributeHandle *errorMessage);

    bool (*isAssetId)(FnAssetHandle handle, const char * str, FnAttributeHandle *errorMessage);

    bool (*containsAssetId)(FnAssetHandle handle, const char * str, FnAttributeHandle *errorMessage);

    bool (*checkPermissions)(FnAssetHandle handle, const char *assetId, FnAttributeHandle context,
                             FnAttributeHandle *errorMessage);

    bool (*runAssetPluginCommand)(FnAssetHandle handle, const char *assetId, const char *command,
                                  FnAttributeHandle commandArgs, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*resolveAsset)(FnAssetHandle handle, const char *assetId, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*resolveAllAssets)(FnAssetHandle handle, const char *str, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*resolvePath)(FnAssetHandle handle, const char *path, int frame, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*resolveAssetVersion)(FnAssetHandle handle, const char *assetId, const char *versionStr,
                                             FnAttributeHandle *errorMessage);


    FnAttributeHandle (*getAssetDisplayName)(FnAssetHandle handle, const char *assetId, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getAssetVersions)(FnAssetHandle handle, const char *assetId, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getUniqueScenegraphLocationFromAssetId)(FnAssetHandle handle, const char *assetId,
                                                                bool includeVersion, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getRelatedAssetId)(FnAssetHandle handle, const char *assetId, const char *relation,
                                           FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getAssetFields)(FnAssetHandle handle, const char *assetId, bool includeDefaults,
                                        FnAttributeHandle *errorMessage);

    FnAttributeHandle (*buildAssetId)(FnAssetHandle handle, FnAttributeHandle fields, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getAssetAttributes)(FnAssetHandle handle, const char *assetId, const char *scope,
                                            FnAttributeHandle *errorMessage);

    void (*setAssetAttributes)(FnAssetHandle handle, const char *assetId, const char *scope,
                               FnAttributeHandle attributes, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*getAssetIdForScope)(FnAssetHandle handle, const char *assetId, const char *scope,
                                            FnAttributeHandle *errorMessage);

    FnAssetTransactionHandle (*createTransaction)(FnAssetHandle handle, FnAttributeHandle *errorMessage);

    void (*cancelTransaction)(FnAssetTransactionHandle handle, FnAttributeHandle *errorMessage);

    bool (*commitTransaction)(FnAssetTransactionHandle handle, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*createAssetAndPath)(FnAssetHandle handle, FnAssetTransactionHandle txn,
            const char *assetType, FnAttributeHandle assetFields, FnAttributeHandle args,
            bool createDirectory, FnAttributeHandle *errorMessage);

    FnAttributeHandle (*postCreateAsset)(FnAssetHandle handle, FnAssetTransactionHandle txn,
            const char *assetType, FnAttributeHandle assetFields, FnAttributeHandle args,
            FnAttributeHandle *errorMessage);
};

#define FnDefaultAssetHostSuite_version 3

struct FnDefaultAssetHostSuite_v3
{
    bool (*isAssetId)(const char* str, FnAttributeHandle* errorMessage);
    bool (*containsAssetId)(const char* str, FnAttributeHandle* errorMessage);
    FnAttributeHandle (*resolveAsset)(const char* assetId,
                                      FnAttributeHandle* errorMessage);
    FnAttributeHandle (*resolvePath)(const char* path,
                                     int frame,
                                     FnAttributeHandle* errorMessage);
    bool (*isFileSequence)(const char* path, FnAttributeHandle* errorMessage);
    FnAttributeHandle (*buildFileSequenceString)(
        const char* prefix,
        const char* suffix,
        int padding,
        FnAttributeHandle* errorMessage);
    FnAttributeHandle (*resolveFileSequence)(const char* path,
                                             int frame,
                                             FnAttributeHandle* errorMessage);
    bool (*isFrameInFileSequence)(const char* path,
                                  int frame,
                                  FnAttributeHandle* errorMessage);
    FnAttributeHandle (*getUniqueScenegraphLocationFromAssetId)(
        const char* assetId,
        bool includeVersion,
        FnAttributeHandle* errorMessage);
    FnAttributeHandle (*getRelatedAssetId)(const char* assetId,
                                           const char* relation,
                                           FnAttributeHandle* errorMessage);
    FnAttributeHandle (*getAssetAttributes)(const char* assetId,
                                            const char* scope,
                                            FnAttributeHandle* errorMessage);
    bool (*checkPermissions)(const char* assetId,
                             const char** context,
                             size_t count,
                             FnAttributeHandle* errorMessage);
    FnAttributeHandle (*resolveAllAssets)(const char* assetId,
                                          FnAttributeHandle* errorMessage);
    FnAttributeHandle (*resolveAssetVersion)(const char* assetId,
                                             const char* versionTag,
                                             FnAttributeHandle* errorMessage);
    FnAttributeHandle (*getAssetDisplayName)(const char* assetId,
                                             FnAttributeHandle* errorMessage);
    FnAttributeHandle (*getAssetVersions)(const char* assetId,
                                          FnAttributeHandle* errorMessage);
    FnAttributeHandle (*getAssetFields)(const char* assetId,
                                        bool includeDefaults,
                                        FnAttributeHandle* errorMessage);
    FnAttributeHandle (*buildAssetId)(const char** fields,
                                      size_t fieldsCount,
                                      FnAttributeHandle* errorMessage);
    FnAttributeHandle (*getAssetIdForScope)(const char* assetId,
                                            const char* scope,
                                            FnAttributeHandle* errorMessage);
};
typedef FnDefaultAssetHostSuite_v3 FnDefaultAssetHostSuite;


}

#endif // FnAssetSuite_H