NvsEffectSdkContext.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:    Sep 6. 2018
//   Author:        Meishe video team
//================================================================================
#pragma once
 
#import <Foundation/Foundation.h>
#import "NvsAssetPackageManager.h"
#import "NvsVideoEffect.h"
#import "NvsVideoEffectTransition.h"
#import "NvsVideoEffectAnimatedSticker.h"
#import "NvsVideoEffectCompoundCaption.h"
#import "NvsVideoEffectCaption.h"
#import "NvsEffectRenderCore.h"
#import "NvsEffectCommonDef.h"
 
typedef enum {
    NvsEffectSdkContextFlag_NoFlag = 0
} NvsEffectSdkContextFlag;
 
typedef enum {
    NvsEffectSdkHumanDetectionFeature_FaceLandmark = 1,
    NvsEffectSdkHumanDetectionFeature_FaceAction = 2,
    NvsEffectSdkHumanDetectionFeature_AvatarExpression = 4,
    NvsEffectSdkHumanDetectionFeature_VideoMode = 8,
    NvsEffectSdkHumanDetectionFeature_ImageMode = 16,
    NvsEffectSdkHumanDetectionFeature_SemiImageMode = 32768,
    NvsEffectSdkHumanDetectionFeature_MultiThread = 32,
    NvsEffectSdkHumanDetectionFeature_SingleThread = 64,
    NvsEffectSdkHumanDetectionFeature_Extra = 128,
    NvsEffectSdkHumanDetectionFeature_Background = 256,
    NvsEffectSdkHumanDetectionFeature_HandLandmark = 512,
    NvsEffectSdkHumanDetectionFeature_HandAction = 1024,
    NvsEffectSdkHumanDetectionFeature_HandBone = 2048,
    NvsEffectSdkHumanDetectionFeature_EyeballLandmark = 4096,
    NvsEffectSdkHumanDetectionFeature_MultiDetect = 8192,
    NvsEffectSdkHumanDetectionFeature_SegmentationSky = 16384,
    NvsEffectSdkHumanDetectionFeature_HalfBody = 65536,
    NvsEffectSdkHumanDetectionFeature_FaceAttri = 131072,
    NvsEffectSdkHumanDetectionFeature_FaceAttriShape = 262144
} NvsEffectSdkHumanDetectionFeatureFlag;
 
#define HUMAN_DETECTION_OPTIONS_FACE_DETECT_THREAD_NUM            @"Face Detect Thread Num"       
#define HUMAN_DETECTION_OPTIONS_FACE_LANDMARK_THREAD_NUM          @"Face Landmark Thread Num"     
#define HUMAN_DETECTION_OPTIONS_FACE_TRACK_THREAD_NUM             @"Face Track Thread Num"        
#define HUMAN_DETECTION_OPTIONS_SKY_SEGMENTATION_THREAD_NUM       @"Sky Segmentation Thread Num"  
 
 
typedef enum {
    NvsEffectSdkHumanDetectionDataType_FakeFace = 0,
    NvsEffectSdkHumanDetectionDataType_Makeup,
    NvsEffectSdkHumanDetectionDataType_SkinColor,
    NvsEffectSdkHumanDetectionDataType_PE106,
    NvsEffectSdkHumanDetectionDataType_PE240,
    NvsEffectSdkHumanDetectionDataType_CustomAvatar,
    NvsEffectSdkHumanDetectionDataType_Makeup2,     // deprecated, replaced by NvsHumanDetectionDataType_FaceCommon
    NvsEffectSdkHumanDetectionDataType_FaceCommon,
    NvsEffectSdkHumanDetectionDataType_AdvancedBeauty,
} NvsEffectSdkHumanDetectionDataTypeFlag;
 
@protocol NvsEffectSdkContextDebugLogDelegate <NSObject>
@optional
 
- (void)onDebugLogArrived:(int)level logStr:(NSString*)logStr;
@end
 
NVS_EXPORT @interface NvsEffectSdkContext : NSObject
 
@property (readonly) NvsAssetPackageManager *assetPackageManager; 
 
+ (BOOL)verifySdkLicenseFile:(NSString *)sdkLicenseFilePath;
 
+ (void)setDebugLogDelegate:(id<NvsEffectSdkContextDebugLogDelegate>)debugLogDelegate;
+ (NvsEffectSdkContext *)sharedInstance:(NvsEffectSdkContextFlag)flags;
 
+ (void)destroyInstance;
 
+ (int)hasARModule;
 
+ (BOOL)initHumanDetection:(NSString *)modelFilePath
           licenseFilePath:(NSString *)licenseFilePath
                  features:(int)features;
 
+ (BOOL)initHumanDetection:(NSString *)modelFilePath
           licenseFilePath:(NSString *)licenseFilePath
                  features:(int)features
                   options:(NSMutableDictionary *)options;
 
+ (BOOL)initHumanDetectionExt:(NSString *)modelFilePath
              licenseFilePath:(NSString *)licenseFilePath
                     features:(int)features;
 
+ (BOOL)initHumanDetectionExt:(NSString *)modelFilePath
              licenseFilePath:(NSString *)licenseFilePath
                     features:(int)features
                      options:(NSMutableDictionary *)options;
 
+ (BOOL)setupHumanDetectionData:(int)dataType
           dataFilePath:(NSString *)dataFilePath;
 
+ (void)closeHumanDetection;
 
+ (void)getSdkVersion:(int *)majorVersion minorVersion:(int *)minorVersion revisionNumber:(int *)revisionNumber;
 
- (NSArray *)getAllBuiltinVideoFxNames;
 
- (NvsVideoEffect *)createVideoEffect:(NSString *)effectId aspectRatio:(NvsEffectRational)aspectRatio;
 
- (NvsVideoEffect *)createVideoEffect:(NSString *)effectId aspectRatio:(NvsEffectRational)aspectRatio realTime:(BOOL)realTime;
 
- (NvsVideoEffectTransition *)createVideoTransition:(NSString *)transitionId aspectRatio:(NvsEffectRational)aspectRatio;
 
- (NvsVideoEffectAnimatedSticker *)createAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration isPanoramic:(bool)isPanoramic packageId:(NSString *)packageId aspectRatio:(NvsEffectRational)aspectRatio;
 
- (NvsVideoEffectAnimatedSticker *)createCustomAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration isPanoramic:(bool)isPanoramic packageId:(NSString *)packageId customImageFilePath:(NSString *)customImageFilePath aspectRatio:(NvsEffectRational)aspectRatio;
 
- (NvsVideoEffectCompoundCaption *)createCompoundCaption:(int64_t)inPoint duration:(int64_t)duration packageId:(NSString *)packageId aspectRatio:(NvsEffectRational)aspectRatio;
 
- (NvsVideoEffectCompoundCaption *)createPanoramicCompoundCaption:(int64_t)inPoint duration:(int64_t)duration packageId:(NSString *)packageId aspectRatio:(NvsEffectRational)aspectRatio;
 
- (NvsVideoEffectCaption *)createCaption:(NSString *)captionText inPoint:(int64_t)inPoint duration:(int64_t)duration captionStylePackageId:(NSString *)captionStylePackageId aspectRatio:(NvsEffectRational)aspectRatio;
 
- (NvsVideoEffectCaption *)createPanoramicCaption:(NSString *)captionText inPoint:(int64_t)inPoint duration:(int64_t)duration captionStylePackageId:(NSString *)captionStylePackageId aspectRatio:(NvsEffectRational)aspectRatio;
 
- (NvsVideoEffectCaption *)createModularCaption:(NSString *)captionText inPoint:(int64_t)inPoint duration:(int64_t)duration aspectRatio:(NvsEffectRational)aspectRatio;
 
- (NvsVideoEffectCaption *)createPanoramicModularCaption:(NSString *)captionText inPoint:(int64_t)inPoint duration:(int64_t)duration aspectRatio:(NvsEffectRational)aspectRatio;
 
- (NvsEffectRenderCore *)createEffectRenderCore;
 
- (NSString *)registerFontByFilePath:(NSString *)filePath;
 
- (void)UnregisterFontByFilePath:(NSString *)filePath;
 
+ (BOOL)functionalityAuthorised:(NSString *)sdkFunctionName;
@end