fbaudio.h

Go to the documentation of this file.

#ifndef __FBAUDIO_H__
#define __FBAUDIO_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/fbcomponent.h>
#include <fbsdk/fbaudiofmt.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

__FB_FORWARD( FBAudioIn );
__FB_FORWARD( FBAudioOut );
__FB_FORWARD( FBAudioClip );
FB_DEFINE_COMPONENT( FBSDK_DLL, AudioIn );
FB_DEFINE_COMPONENT( FBSDK_DLL, AudioOut );
FB_DEFINE_COMPONENT( FBSDK_DLL, AudioClip );

enum FBAccessMode {
    kFBAccessModeDisk,  
    kFBAccessModeMemory 
};

enum FBUseChnMode {
    kFBUseChannelLeftOnly,  
    kFBUseChannelRightOnly, 
    kFBUseChannelBoth       
};

enum FBTriggerStyle {
    kFBTriggerStyleContinue,    
    kFBTriggerStyleCut,         
    kFBTriggerStyleToggle       
};

enum FBExistingClipAction {
    kFBExistingClipAskUser,         
    kFBExistingClipRemove,          
    kFBExistingClipAbortOperation   
};

enum FBExistingFileAction {
    kFBExistingFileAskUser,         
    kFBExistingFileOverwrite,       
    kFBExistingFileAppend,          
    kFBExistingFileAbortOperation,  
};

FB_DEFINE_ENUM(FBSDK_DLL, AccessMode);
FB_DEFINE_ENUM(FBSDK_DLL, UseChnMode);
FB_DEFINE_ENUM(FBSDK_DLL, TriggerStyle);
FB_DEFINE_ENUM(FBSDK_DLL, ExistingClipAction);
FB_DEFINE_ENUM(FBSDK_DLL, ExistingFileAction);

// FBAudioIn

class FBSDK_DLL FBAudioIn : public FBComponent
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBAudioIn, FBComponent);
public:

    FBAudioIn(HIObject pObject=NULL);


    bool SetOnline( bool pOnline );

    bool IsOnline() const;


    bool PrepareToRecord(   const char*             pRecordingPath, 
                            FBExistingClipAction    pExistingClipAction = kFBExistingClipAskUser,
                            FBExistingFileAction    pExistingFileAction = kFBExistingFileAskUser );

    bool TurnOffRecording();

    bool IsReadyToRecord() const;


    FBAudioFmt GetSupportedFormats() const;

    bool SetRecordingFormat( FBAudioFmt pAudioFormat );

    FBAudioFmt GetRecordingFormat() const;


    bool SetDelay( FBTime& pDelay );

    FBTime GetDelay() const;


    bool SetDestination( FBAudioOut* pAudioOut );

    FBAudioOut* GetDestination() const;
};

// FBAudioOut

class FBSDK_DLL FBAudioOut : public FBComponent
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBAudioOut, FBComponent);
public:

    FBAudioOut(HIObject pObject=NULL);
};

FBSDK_DLL FBAudioOut* FBAudioOutGetDefault();

// FBAudioClip

class FBSDK_DLL FBAudioClip : public FBComponent
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBAudioClip, FBComponent);
public:

    FBAudioClip(const char* pFileName, bool pSetToDefaultDest=true, HIObject pObject=NULL);

    virtual void FBDelete();

    bool Play(FBTriggerStyle pStyle=kFBTriggerStyleContinue, FBAudioOut* pDestination=NULL);

    void Stop(FBAudioOut* pDestination=NULL);

    bool IsMediaReady();

    bool FileOpen(char const * pPath);


    FBPropertyString        Path;           
    FBPropertyString        Filename;       
    FBPropertyString        RelativePath;   

    FBPropertyInt           Format;         
    FBPropertyInt           Channels;       
    FBPropertyInt           Rate;           
    FBPropertyInt           Bits;           
    FBPropertyAccessMode    AccessMode;     
    FBPropertyUseChnMode    UseChannel;     
    FBPropertyUseChnMode    UseChannelMode; 
    FBPropertyDouble        ClipSpeed;      

    FBPropertyTime          SrcIn;          
    FBPropertyTime          SrcDuration;    
    FBPropertyTime          SrcEnd;         
    
    FBPropertyTime          InPoint;        
    FBPropertyTime          DstIn;          
    FBPropertyTime          Duration;       
    FBPropertyTime          DstDuration;    
    FBPropertyTime          EndPoint;       
    FBPropertyTime          DstEnd;         
    
    FBPropertyBool          TakeSetsInPoint;    
    FBPropertyBool          ConstrainDstToTake; 
    FBPropertyBool          Scrubbing;          
    FBPropertyBool          LockClipSpeed;      

    FBPropertyTake          CurrentTake;    
    FBPropertyAudioOut      Destination;    

    FBPropertyDouble        Pitch;              
    FBPropertyBool          LockPitchToSpeed;   
};

class FBSDK_DLL FBPropertyListAudioIn : public FBPropertyListComponent
{
public:
    FBPropertyListAudioIn();
    FBAudioIn* operator[](int pIndex);
};

class FBSDK_DLL FBPropertyListAudioOut : public FBPropertyListComponent
{
public:
    FBPropertyListAudioOut();
    FBAudioOut* operator[](int pIndex);
};

class FBSDK_DLL FBPropertyListAudioClip : public FBPropertyListComponent
{
public:
    FBPropertyListAudioClip();
    FBAudioClip* operator[](int pIndex);
};

#ifdef FBSDKUseNamespace
    }
#endif
#endif /* this must be the last line of this file */