FnRenderOutputUtils.h

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

#ifndef FNRENDEROUTPUTUTILS_RENDEROUTPUTUTILS_H
#define FNRENDEROUTPUTUTILS_RENDEROUTPUTUTILS_H
#include <set>
#include <string>
#include <vector>

#include "FnAttribute/FnAttribute.h"
#include "FnPluginSystem/FnPluginSystem.h"
#include "FnScenegraphIterator/FnScenegraphIterator.h"

#include "FnRenderOutputUtils/CameraInfo.h"
#include "FnRenderOutputUtils/FnRenderOutputUtilsAPI.h"
#include "FnRenderOutputUtils/ShadingNodeConnectionDescription.h"
#include "FnRenderOutputUtils/ShadingNodeDescription.h"
#include "FnRenderOutputUtils/ShadingNodeDescriptionMap.h"
#include "FnRenderOutputUtils/XFormMatrix.h"
#include "FnRenderOutputUtils/ns.h"

FNRENDEROUTPUTUTILS_NAMESPACE_ENTER
{
namespace RenderOutputUtils
{
    enum ProceduralArgsType
    {
        kProceduralArgsType_Classic,
        kProceduralArgsType_ScenegraphAttr
    };

    struct FNRENDEROUTPUTUTILS_API ProceduralOutputContextInfo
    {
        int   _frameNumber;
        float _shutterOpen;
        float _shutterClose;
        float _cropWindowXMin;
        float _cropWindowXMax;
        float _cropWindowYMin;
        float _cropWindowYMax;
        int   _xres;
        int   _yres;

        ProceduralOutputContextInfo()
        : _frameNumber(1)
        , _shutterOpen(0)
        , _shutterClose(0)
        , _cropWindowXMin(0)
        , _cropWindowXMax(1)
        , _cropWindowYMin(0)
        , _cropWindowYMax(1)
        , _xres(0)
        , _yres(0)
        {}
    };

    FNRENDEROUTPUTUTILS_API std::string buildProceduralArgsString(FnScenegraphIterator sgIterator,
                                                               ProceduralArgsType type,
                                                               const std::string& argsAttrName,
                                                               const ProceduralOutputContextInfo& contextInfo);

    FNRENDEROUTPUTUTILS_API void flushProceduralDsoCaches(const std::string& apiName="");

    FNRENDEROUTPUTUTILS_API int getPixelAreaThroughCamera(FnScenegraphIterator sgIterator,
                                                       const std::string& cameraName,
                                                       const std::string& resolution);

    FNRENDEROUTPUTUTILS_API void findSampleTimesRelevantToShutterRange(std::vector<float>& sampleTimes,
                                                                    const std::set<float>& inputSamples,
                                                                    float shutterOpen,
                                                                    float shutterClose);

    FNRENDEROUTPUTUTILS_API std::string getRenderResolution(FnScenegraphIterator rootIterator,
                                                         int *width,
                                                         int *height);

    FNRENDEROUTPUTUTILS_API std::string getCameraPath(FnScenegraphIterator rootIterator);

    typedef std::vector<float>                    TransformData;
    typedef std::pair<std::string, TransformData> TransformPair;
    typedef std::vector<TransformPair>            TransformList;

    struct Transform
    {
        TransformList transformList;    
        std::vector<float> sampleTimes; 
    };

    FNRENDEROUTPUTUTILS_API void fillXFormListForLocation(std::vector<Transform>& xFormList,
                                                       FnScenegraphIterator sgIterator,
                                                       float shutterClose = 0.0f);

    FNRENDEROUTPUTUTILS_API bool fillXFormListFromAttributes(std::vector<Transform>& xFormList,
                                                          const FnAttribute::GroupAttribute& xformAttr,
                                                          float shutterClose = 0.0f,
                                                          bool invertMatrix = true);

    FNRENDEROUTPUTUTILS_API FnAttribute::GroupAttribute convertTexturesToArbitraryAttr(const FnAttribute::GroupAttribute& texturesAttr);


    FNRENDEROUTPUTUTILS_API std::string getArchString();
    FNRENDEROUTPUTUTILS_API std::string expandArchPath(const std::string& path);

    FNRENDEROUTPUTUTILS_API FnAttribute::GroupAttribute getFlattenedMaterialAttr(FnScenegraphIterator sgIterator,
                                                                              const FnAttribute::StringAttribute& terminalNamesAttr);

    FNRENDEROUTPUTUTILS_API void emptyFlattenedMaterialCache();

    FNRENDEROUTPUTUTILS_API CameraInfo getCameraInfo(FnScenegraphIterator sgIterator,
                                                  const std::string& cameraInfoPath);

    FNRENDEROUTPUTUTILS_API FnPlugStatus setHost(FnPluginHost* host);
    FNRENDEROUTPUTUTILS_API FnPluginHost *getHost();

    FNRENDEROUTPUTUTILS_API bool processLocation(FnScenegraphIterator sgIterator,
                                              const std::string& rendererName,
                                              const std::string& locationName,
                                              void* optionalInput,
                                              void** optionalOutput);

    FNRENDEROUTPUTUTILS_API void fillDelegateHandledLocationTypesList(std::vector<std::string>& delegateHandledLocationTypesList,
                                                                   const std::string& renderer = std::string());

    FNRENDEROUTPUTUTILS_API std::string buildTempRenderLocation(FnScenegraphIterator sgIterator,
                                                             const std::string& outputName,
                                                             const std::string& prefix,
                                                             const std::string& fileExtension,
                                                             const float frameTime);

    FNRENDEROUTPUTUTILS_API std::string buildTileLocation(FnScenegraphIterator sgIterator,
                                                       const std::string& outputPath);

    extern RenderOutputUtilsSuite_v3* _suite ;

    }  // namespace RenderOutputUtils
}
FNRENDEROUTPUTUTILS_NAMESPACE_EXIT

#endif