kfbxvideo.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXVIDEO_H
#define FBXFILESDK_KFBXPLUGINS_KFBXVIDEO_H

/**************************************************************************************

 Copyright (C) 2001 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.

 The coded instructions, statements, computer programs, and/or related material 
 (collectively the "Data") in these files contain unpublished information 
 proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
 Canada and United States of America federal copyright law and by international 
 treaties. 
 
 The Data may not be disclosed or distributed to third parties, in whole or in
 part, without the prior written consent of Autodesk, Inc. ("Autodesk").

 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
 BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
 NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
 WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
 OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
 OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
 SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
 OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
 HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
 FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
 ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
 WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
 OR DAMAGE. 

**************************************************************************************/
#include <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/components/kbaselib/klib/kerror.h>

#include <fbxfilesdk/kfbxmath/kfbxvector2.h>
#include <fbxfilesdk/kfbxplugins/kfbxgroupname.h>
#include <fbxfilesdk/kfbxplugins/kfbxobject.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFBX_DLL KFbxVideo : public KFbxObject
{
    KFBXOBJECT_DECLARE(KFbxVideo,KFbxObject);
  public:

    void Reset();


    void ImageTextureSetMipMap(bool pUseMipMap);

    bool ImageTextureGetMipMap() const;

    bool SetFileName(char const* pName);

    KString GetFileName () const;

    bool SetRelativeFileName(char const* pName);

    const char* GetRelativeFileName() const;

    double GetFrameRate() const;

    int GetLastFrame() const;

    int GetWidth() const;

    int GetHeight() const;

    void SetStartFrame(int pStartFrame);

    int GetStartFrame() const;

    void SetStopFrame(int pStopFrame);

    int GetStopFrame() const;

    void SetPlaySpeed(double pPlaySpeed);

    double GetPlaySpeed() const;

    void SetOffset(KTime pTime);

    /* Retrieve the time offset.
     * \return     The current time shift.
     */
    KTime GetOffset() const;

    void SetFreeRunning(bool pState);

    bool GetFreeRunning() const;


    void SetLoop(bool pLoop);

    bool GetLoop() const;


    typedef enum
    {
        None,       // Progressive frame (full frame)
        Fields,     // Alternate even/odd fields
        HalfEven,   // Half of a frame, even fields only
        HalfOdd,    // Half of a frame, odd fields only
        FullEven,   // Extract and use the even field of a full frame
        FullOdd,    // Extract and use the odd field of a full frame
        FullEvenOdd, // Extract Fields and make full frame with each one beginning with Even (60fps)
        FullOddEven
    } EInterlaceMode;

    void SetInterlaceMode(EInterlaceMode pInterlaceMode);

    EInterlaceMode GetInterlaceMode() const;


    typedef enum
    {
        Disk,
        Memory,
        DiskAsync
    } EAccessMode;

    void SetAccessMode(EAccessMode pAccessMode);

    EAccessMode GetAccessMode() const;
    


    KError& GetError();

    typedef enum
    {
        eTAKE_NODE_ERROR,
        eERROR_COUNT
    } EError;

    EError GetLastErrorID() const;

    const char* GetLastErrorString() const;


#ifndef DOXYGEN_SHOULD_SKIP_THIS

    // Clone
    virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;

protected:
    KFbxVideo(KFbxSdkManager& pManager, char const* pName);

    virtual void Construct(const KFbxVideo* pFrom);
    virtual bool ConstructProperties(bool pForceSet);
    virtual bool ConnecNotify(KFbxConnectEvent const &pEvent);

public:
    virtual KString     GetTypeName() const;
    virtual KStringList GetTypeFlags() const;

    void SetOriginalFormat(bool pState);
    bool GetOriginalFormat() const;
    void SetOriginalFilename(const char* pOriginalFilename);
    const char* GetOriginalFilename() const;

protected:
    void Init();

    static KError smError;

    KFbxTypedProperty<fbxDouble1> FrameRate;
    KFbxTypedProperty<fbxInteger1> LastFrame;
    KFbxTypedProperty<fbxInteger1> Width;
    KFbxTypedProperty<fbxInteger1> Height;
    KFbxTypedProperty<fbxString> Path;
    KFbxTypedProperty<fbxInteger1> StartFrame;
    KFbxTypedProperty<fbxInteger1> StopFrame;
    KFbxTypedProperty<fbxDouble1> PlaySpeed;
    KFbxTypedProperty<fbxTime> Offset;
    KFbxTypedProperty<EInterlaceMode> InterlaceMode;
    KFbxTypedProperty<fbxBool1> FreeRunning;
    KFbxTypedProperty<fbxBool1> Loop;
    KFbxTypedProperty<EAccessMode> AccessMode;

    bool                   mUseMipMap;
    bool                   mOriginalFormat;
    KString                mOriginalFilename;

    // Temporary values
    KString                mRelativeFilename;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

typedef KFbxVideo* HKFbxVideo;

inline EFbxType FbxTypeOf( KFbxVideo::EInterlaceMode const &pItem ) { return eENUM; }
inline EFbxType FbxTypeOf( KFbxVideo::EAccessMode const &pItem ) { return eENUM; }

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXVIDEO_H