HUSD_EditClips.h

Go to the documentation of this file.

/*
 * Copyright 2019 Side Effects Software Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef __HUSD_EditClips_h__
#define __HUSD_EditClips_h__

#include "HUSD_API.h"
#include "HUSD_DataHandle.h"
#include <UT/UT_StringHolder.h>

class HUSD_ClipSegment
{
public:
                         HUSD_ClipSegment(int clipindex,
                                fpreal duration)
                             : myClipIndex(clipindex),
                               myForcedClipStartTime(0.0),
                               myDuration(duration),
                               myFirstAndLastFramesMatch(false),
                               myUseForcedClipStartTime(false),
                               myResetClipTime(false)
                         { }

    int                  clipIndex() const
                         { return myClipIndex; }

    void                 setDuration(fpreal duration)
                         { myDuration = duration; }
    fpreal               duration() const
                         {
                             if (SYSisLessOrEqual(myDuration, 1.0) ||
                                 !myFirstAndLastFramesMatch)
                                return myDuration;

                             return myDuration - 1.0;
                         }

    void                 setFirstAndLastFramesMatch(bool match)
                         { myFirstAndLastFramesMatch = match; }
    bool                 firstAndLastFramesMatch() const
                         { return myFirstAndLastFramesMatch; }

    void                 setForcedClipStartTime(fpreal clip_start_time)
                         {
                             myForcedClipStartTime = clip_start_time;
                             myUseForcedClipStartTime = true;
                         }
    bool                 useForcedClipStartTime() const
                         { return myUseForcedClipStartTime; }
    fpreal               forcedClipStartTime() const
                         { return myForcedClipStartTime; }

    void                 setResetClipTime(bool reset)
                         { myResetClipTime = reset; }
    bool                 resetClipTime() const
                         { return myResetClipTime; }

private:
    int                  myClipIndex;
    fpreal               myForcedClipStartTime;
    fpreal               myDuration;
    bool                 myFirstAndLastFramesMatch;
    bool                 myUseForcedClipStartTime;
    bool                 myResetClipTime;
};

typedef UT_Array<HUSD_ClipSegment> HUSD_ClipSegmentArray;

class HUSD_API HUSD_EditClips
{
public:
                         HUSD_EditClips(HUSD_AutoWriteLock &lock);
                        ~HUSD_EditClips();

    bool                 setClipPrimPath(const UT_StringRef &primpath,
                                const UT_StringRef &clipsetname,
                                const UT_StringRef &clipprimpath) const;
    bool                 setClipManifestFile(const UT_StringRef &primpath,
                                const UT_StringRef &clipsetname,
                                const UT_StringRef &manifestfile) const;
    bool                 setClipFiles(const UT_StringRef &primpath,
                                const UT_StringRef &clipsetname,
                                const UT_StringArray &clipfiles) const;
    bool                 setClipSegments(const UT_StringRef &primpath,
                                const UT_StringRef &clipsetname,
                                fpreal starttime,
                                fpreal clipstarttime,
                                fpreal cliptimescale,
                                const HUSD_ClipSegmentArray &segments,
                                bool set_fake_manifest = false) const;

    bool                 flattenClipFiles(const UT_StringRef &primpath,
                                const UT_StringRef &clipsetname,
                                const UT_StringArray &clipfilesavepaths) const;
    bool                 createClipTopologyFile(const UT_StringRef &primpath,
                                const UT_StringRef &clipsetname,
                                const UT_StringRef &topologyfile,
                                bool use_single_file = false) const;
    bool                 getMissingClipManifests(const UT_StringRef &primpath,
                                UT_Map<UT_StringHolder, UT_StringHolder> &clipSets);
    bool                 createClipManifestFile(const UT_StringRef &primpath,
                                const UT_StringRef &clipsetname,
                                const UT_StringRef &manifestfile,
                                bool use_single_file = false) const;
    bool                 compactFlattenedClipFiles(const UT_StringRef &primpath,
                                const UT_StringRef &clipsetname) const;
    bool                 authorExistenceTrackingVisibility(
                                const UT_StringRef &primpath,
                                const UT_StringRef &clipsetname) const;

private:
    HUSD_AutoWriteLock  &myWriteLock;
};

#endif