fbtime.h

Go to the documentation of this file.

#ifndef __FBTIME_H__
#define __FBTIME_H__
/**************************************************************************
 Copyright (c) 1994 - 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 <kaydaradef.h>

#ifndef FBSDK_DLL

  #define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbstring.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

// FBTime

enum FBTimeMode {   
    kFBTimeModeDefault,         
    kFBTimeMode1000Frames,      
    kFBTimeMode120Frames,       
    kFBTimeMode100Frames,       
    kFBTimeMode96Frames,        
    kFBTimeMode72Frames,        
    kFBTimeMode60Frames,        
    kFBTimeMode5994Frames,      
    kFBTimeMode50Frames,        
    kFBTimeMode48Frames,        
    kFBTimeMode30Frames,        
    kFBTimeMode2997Frames_Drop, 
    kFBTimeMode2997Frames,      
    kFBTimeMode25Frames,        
    kFBTimeMode24Frames,        
    kFBTimeMode23976Frames,     
    kFBTimeModeCustom           
};

FB_FORWARD( FBTime );

class FBSDK_DLL FBTime 
{
  private:
    kLongLong   mTime;          
  public:

    enum ETimeFormats
    {
        eSMPTE,         
        eFrame,         
        eDefaultFormat  
    };
 
    /*  Constructor.
    *   \param  pTime   Time to initialize with(default=0).
    */
    FBTime( kLongLong pTime=0);

    FBTime (int pHour,int pMinute,int pSecond=0,int pFrame=0,int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault);

    FBString GetTimeString(FBTimeMode pMode=kFBTimeModeDefault, ETimeFormats pFormat = eDefaultFormat);

    void SetTimeString(const char *pTime);

    bool        GetTime(int &pHour,  int &pMinute, int &pSecond, int &pFrame, int &pField,  int &pMilliSecond, FBTimeMode pTimeMode=kFBTimeModeDefault );
    kLongLong   GetMilliSeconds();

    void        SetMilliSeconds(kLongLong pMilliSeconds);

    kLongLong&  Get();

    const kLongLong& Get() const;

    void        Set( kLongLong pTime );

    double      GetSecondDouble();

    void        SetSecondDouble(double pTime);

    void        SetTime (int pHour,int pMinute=0,int pSecond=0,int pFrame=0,int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault);


    FBTime& operator=   (const FBTime& pTime);
    FBTime& operator+=  (const FBTime& pTime);
    FBTime& operator-=  (const FBTime& pTime);
    FBTime& operator*=  (const FBTime& pTime);
    FBTime& operator/=  (const FBTime& pTime);


    FBTime& operator=   (double pConstant);
    FBTime& operator+=  (double pConstant);
    FBTime& operator-=  (double pConstant);
    FBTime& operator*=  (double pConstant);
    FBTime& operator/=  (double pConstant);


    FBTime  operator- (const FBTime &pTime);
    FBTime  operator+ (const FBTime &pTime);
    FBTime  operator/ (const FBTime &pTime);
    FBTime  operator* (const FBTime &pTime);


    FBTime  operator- (double pConstant);
    FBTime  operator+ (double pConstant);
    FBTime  operator/ (double pConstant);
    FBTime  operator* (double pConstant);


    bool    operator==	(const FBTime& pTime);
    bool    operator!=  (const FBTime& pTime);
    bool    operator>=  (const FBTime& pTime);
    bool    operator<=  (const FBTime& pTime);
    bool    operator>   (const FBTime& pTime);
    bool    operator<   (const FBTime& pTime);

    kLongLong   GetFrame(FBTimeMode pTimeMode=kFBTimeModeDefault);

    void SetFrame(kLongLong pFrames, FBTimeMode pTimeMode=kFBTimeModeDefault);

    static const FBTime Infinity;

    static const FBTime MinusInfinity;

    static const FBTime Zero;

    static const FBTime Epsilon;

    static const FBTime OneSecond;

    static const FBTime OneMinute;

    static const FBTime OneHour;
};

FB_FORWARD( FBTimeCode );

class FBSDK_DLL FBTimeCode 
{
  private:
    double mSecond; 
    double mFrame;  
    double mRate;   
  public:

    FBTimeCode(float pRate=FRAMES_30);

    void SetTimeCode(int pHour,int pMinute=0,int pSecond=0,float pFrame=0);

    FBString GetTimeCodeString(FBTime::ETimeFormats pFormat = FBTime::eDefaultFormat);

    void SetTimeCodeString(const char *pTime, FBTime::ETimeFormats pFormat = FBTime::eDefaultFormat);

    FBTime GetTime() const;

    void SetTime(FBTime pTime);

    double GetFrame() const;

    void SetFrame(double pFrame);

    float GetFrameRate() const;

    double GetRawSecond() const;

    double GetRawFrame() const;

    double GetRawRate() const;

    bool operator==(const FBTimeCode& pTimeCode)const;

    bool operator!=(const FBTimeCode& pTimeCode)const;


    static const float NTSC_DROP;   
    static const float NTSC_FULL;   
    static const float PAL_25;      
    static const float MPAL_30;     
    static const float FILM_24;     
    static const float FILM_23976;  
    static const float FRAMES_30;   
    static const float FRAMES_5994; 
};

// FBTimeSpan

FB_FORWARD( FBTimeSpan );

class FBSDK_DLL FBTimeSpan 
{
  private:
    FBTime       mStart;        
    FBTime       mStop;         
  public:
    FBTimeSpan( FBTime pStart=0,FBTime pStop=0);


    FBTime& GetStart();
    FBTime& GetStop();
    const FBTime& GetStart() const;
    const FBTime& GetStop() const;

    void    Set( FBTime pStart, FBTime pStop );

    FBTime  GetDuration();      

    FBTime  GetSignedDuration(); 

    int     GetDirection();

    bool    operator& (FBTime &pTime);
    
    FBTimeSpan operator& (FBTimeSpan &pTimeSpan);   
};
// Global
#ifdef FBSDKUseNamespace
    }
#endif

#endif