NvsARSceneManipulate.h

Go to the documentation of this file.

//================================================================================
//
// (c) Copyright Meishe Co. Ltd, 2016. All rights reserved.
//
// This code and information is provided "as is" without warranty of any kind,
// either expressed or implied, including but not limited to the implied
// warranties of merchantability and/or fitness for a particular purpose.
//
//--------------------------------------------------------------------------------
//   Birth Date:    Dec 29. 2016
//   Author:        Meishe video team
//================================================================================
#pragma once
 
#import <Foundation/Foundation.h>
#import "NvsCommonDef.h"
 
typedef enum {
    NvsARSceneDetectionMode_Video = 0x01,           
    NvsARSceneDetectionMode_Image = 0x02,           
    NvsARSceneDetectionMode_SemiImage = 0x10,       
    NvsARSceneDetectionMode_SingleThread = 0x04,    
    NvsARSceneDetectionMode_MultiThread = 0x08,     
} NvsARSceneDetectionMode;
 
 
typedef NS_ENUM(NSInteger,NvsFaceActionType){
    NvsFaceActionTypeInvalid = -1,
    NvsFaceActionTypeEyeBlink,
    NvsFaceActionTypeLipsPart,
    NvsFaceActionTypeHeadYaw,
    NvsFaceActionTypeHeadPitch,
    NvsFaceActionTypeBrowJump,
    NvsFaceActionTypeLipsUpward,
    NvsFaceActionTypeLipsPouted
};
 
typedef NS_ENUM(NSInteger,NvsAvatarActionType){
    NvsAvatarActionTypeInvalid = -1,
    NvsAvatarActionTypeEyeRightClose,                
    NvsAvatarActionTypeEyeRightDown,                 
    NvsAvatarActionTypeEyeRightInward,               
    NvsAvatarActionTypeEyeRightOutward,              
    NvsAvatarActionTypeEyeRightUp,                   
    NvsAvatarActionTypeEyeRightNarrow,               
    NvsAvatarActionTypeEyeRightWide,                 
    NvsAvatarActionTypeEyeLeftClose,                 
    NvsAvatarActionTypeEyeLeftDown,                  
    NvsAvatarActionTypeEyeLeftInward,                
    NvsAvatarActionTypeEyeLeftOutward,               
    NvsAvatarActionTypeEyeLeftUp,                    
    NvsAvatarActionTypeEyeLeftNarrow,                
    NvsAvatarActionTypeEyeLeftWide,                  
    NvsAvatarActionTypeJawForward,                   
    NvsAvatarActionTypeJawRight,                     
    NvsAvatarActionTypeJawLeft,                      
    NvsAvatarActionTypeJawOpen,                      
    NvsAvatarActionTypeJawDown,                      
    NvsAvatarActionTypeMouthClose,                   
    NvsAvatarActionTypeMouthRound,                   
    NvsAvatarActionTypeMouthPucker,                  
    NvsAvatarActionTypeMouthBulge,                   
    NvsAvatarActionTypeMouthBothLipRight,            
    NvsAvatarActionTypeMouthBothLipLeft,             
    NvsAvatarActionTypeMouthRightCornerUp,           
    NvsAvatarActionTypeMouthLeftCornerUp,            
    NvsAvatarActionTypeMouthRightCornerDown,         
    NvsAvatarActionTypeMouthLeftCornerDown,          
    NvsAvatarActionTypeMouthRightCornerBackward,     
    NvsAvatarActionTypeMouthLeftCornerBackward,      
    NvsAvatarActionTypeMouthRightCornerOutward,      
    NvsAvatarActionTypeMouthLeftCornerOutward,       
    NvsAvatarActionTypeMouthCornerShrink,            
    NvsAvatarActionTypeMouthLowerLipInward,          
    NvsAvatarActionTypeMouthUpperLipInward,          
    NvsAvatarActionTypeMouthLowerLipOutward,         
    NvsAvatarActionTypeMouthUpperLipOutward,         
    NvsAvatarActionTypeMouthLowerLipRightUp,         
    NvsAvatarActionTypeMouthLowerLipLeftUp,          
    NvsAvatarActionTypeMouthLowerLipRightDown,       
    NvsAvatarActionTypeMouthLowerLipLeftDown,        
    NvsAvatarActionTypeMouthUpperLipRightUp,         
    NvsAvatarActionTypeMouthUpperLipLeftUp,          
    NvsAvatarActionTypeMouthLipPart,                 
    NvsAvatarActionTypeEyebrowRightOuterDown,        
    NvsAvatarActionTypeEyebrowLeftOuterDown,         
    NvsAvatarActionTypeEyebrowBothInnerUp,           
    NvsAvatarActionTypeEyebrowBothInnerDown,         
    NvsAvatarActionTypeEyebrowRightOuterUp,          
    NvsAvatarActionTypeEyebrowLeftOuterUp,           
    NvsAvatarActionTypeCheekBothOutward,             
    NvsAvatarActionTypeCheekRightUp,                 
    NvsAvatarActionTypeCheekLeftUp,                  
    NvsAvatarActionTypeNoseRightUp,                  
    NvsAvatarActionTypeNoseLeftUp,                   
    NvsAvatarActionTypeNoseBothWide,                 
    NvsAvatarActionTypeTongueOutward                 
};
 
typedef NS_ENUM(NSInteger,NvsToBeCheckedFunctionType) {
    NvsToBeCheckedFunctionType_Invalid = -1,
    NvsToBeCheckedFunctionType_Matte,           
    NvsToBeCheckedFunctionType_Count
};
 
@interface NvsFaceFeatureInfo : NSObject
 
@property (nonatomic, assign) int faceId;
@property (nonatomic, assign) NvsRect boundingBox;
@property (nonatomic, strong) NSMutableArray<NSValue *> *landmarks;
@property (nonatomic, strong) NSMutableArray<NSNumber *> *visibilities;
@property (nonatomic, strong) NSMutableArray<NSValue *> *extraPoints;
@property (nonatomic, strong) NSMutableArray<NSNumber *> *extraVisibilities;
@property (nonatomic, assign) float yaw;
@property (nonatomic, assign) float pitch;
@property (nonatomic, assign) float roll;
@property (nonatomic, strong) NSMutableArray<NSValue *> *vertices;  //Values is NvsPosition3D
@property (nonatomic, assign) NvsPosition3D rotation;
@property (nonatomic, assign) NvsPosition3D translation;
 
@property (nonatomic, strong) NSMutableArray<NSValue *> *extraVertices;
 
@property (nonatomic, strong) NSMutableArray<NSNumber *> *faceActions;
@property (nonatomic, strong) NSMutableArray<NSNumber *> *avatarExpressions;
 
@end
 
typedef NS_ENUM(NSInteger, NvsHandActionType) {
    NvsHandActionInvalid = -1,
    NvsHandActionOK = 0,        
    NvsHandActionScissor,       
    NvsHandActionGood,          
    NvsHandActionPalm,          
    NvsHandActionPistol,        
    NvsHandActionLove,          
    NvsHandActionHoldup,        
    NvsHandActionCongratulate,  
    NvsHandActionFingerHeart,   
    NvsHandActionFingerIndex,   
    NvsHandActionFist,          
    NvsHandAction666,           
    NvsHandActionBless,         
    NvsHandActionILoveYou,      
    NvsHandActionSSH,           
    NvsHandActionThree,         
    NvsHandActionFour           
};
 
@interface NvsHandFeatureInfo : NSObject
 
@property (nonatomic, assign) int handId;
@property (nonatomic, assign) NvsRect boundingBox;
@property (nonatomic, assign) NvsHandActionType actionType;
 
@end
 
@protocol NvsARSceneManipulateDelegate <NSObject>
@optional
 
- (void)notifyFaceBoundingRectWithId:(int*)faceIds boundingRect:(NvsRect*)boundingRects faceCount:(int)count;
 
- (void)notifyFaceFeatureInfos:(NSMutableArray<NvsFaceFeatureInfo *> *)faceFeatureInfos;
 
- (void)notifyHandFeatureInfos:(NSArray<NvsHandFeatureInfo *> *)handFeatureInfos;
 
- (void)notifyCustomAvatarRealtimeResourcesPreloaded:(BOOL)isPreloaded;
 
- (void)notifyDetectionTimeCost:(float)time;
 
 
- (void)notifyTotalTimeCost:(float)time;
 
@end
 
@interface NvsARSceneManipulate : NSObject
 
@property (nonatomic, weak) id<NvsARSceneManipulateDelegate> delegate;
 
- (void)setDetectionMode:(NvsARSceneDetectionMode)mode;
 
- (void)resetTracking;
 
- (void)resetSkinColor;
 
- (void)setDetectionAutoProbe:(bool)autoProbe;
 
- (void)setInternalObject:(void *)internalObject;
 
- (void)setDisableDetectionSmooth:(BOOL)disable;
 
- (void)setSoundVolumeGain:(float)volume;
 
- (float)getSoundVolumeGain;
 
- (void)setMusicVolumeGain:(float)volume;
 
- (float)getMusicVolumeGain;
 
- (BOOL)isFunctionAvailable:(NvsToBeCheckedFunctionType)functionType;
 
- (void)setFaceLandmarkConfidenceThresh:(float)thresh;
 
- (void)setFaceConfidenceThresh:(float)thresh;
 
- (void)setDetectionForceInterval:(int)interval;
 
- (void)setDetectionInterval:(int)interval;
@end