NvsAssetPackageManager.h

Go to the documentation of this file.

//================================================================================
//
// (c) Copyright Meishe Co. Ltd, 2017. 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:    Jan 23. 2017
//   Author:        Meishe video team
//================================================================================
#pragma once
 
#import "NvsCommonDef.h"
 
#import <Foundation/Foundation.h>
 
@class NvsTimeline;
@class NvsExpressionParam;
 
typedef enum
{
    NvsAssetPackageType_VideoFx = 0,                    
    NvsAssetPackageType_VideoTransition,                
    NvsAssetPackageType_CaptionStyle,                   
    NvsAssetPackageType_AnimatedSticker,                
    NvsAssetPackageType_Theme,                          
    NvsAssetPackageType_CaptureScene,                   
    NvsAssetPackageType_ARScene,                        
    NvsAssetPackageType_CompoundCaption,                
    NvsAssetPackageType_CaptionContext,                 
    NvsAssetPackageType_CaptionRenderer,                
    NvsAssetPackageType_CaptionAnimation,               
    NvsAssetPackageType_CaptionInAnimation,             
    NvsAssetPackageType_CaptionOutAnimation,            
    NvsAssetPackageType_Template,                       
    NvsAssetPackageType_AvatarModel,                    
    NvsAssetPackageType_AvatarMaterial,                 
    NvsAssetPackageType_AnimatedStickerAnimation,       
    NvsAssetPackageType_AnimatedStickerInAnimation,     
    NvsAssetPackageType_AnimatedStickerOutAnimation,    
    NvsAssetPackageType_Makeup,                         
    NvsAssetPackageType_FaceMesh,                       
    NvsAssetPackageType_Warp,                           
    NvsAssetPackageType_Project                         
} NvsAssetPackageType;
 
typedef enum
{
    NvsAssetPackageStatus_NotInstalled = 0,  
    NvsAssetPackageStatus_Installing,        
    NvsAssetPackageStatus_Ready,             
    NvsAssetPackageStatus_Upgrading          
} NvsAssetPackageStatus;
 
typedef enum
{
    NvsAssetPackageManagerError_NoError = 0,          
    NvsAssetPackageManagerError_Name,                 
    NvsAssetPackageManagerError_AlreadyInstalled,     
    NvsAssetPackageManagerError_WorkingInProgress,    
    NvsAssetPackageManagerError_NotInstalled,         
    NvsAssetPackageManagerError_ImproperStatus,       
    NvsAssetPackageManagerError_Decompression,        
    NvsAssetPackageManagerError_InvalidPackage,       
    NvsAssetPackageManagerError_AssetType,            
    NvsAssetPackageManagerError_Permission,           
    NvsAssetPackageManagerError_MetaContent,          
    NvsAssetPackageManagerError_SdkVersion,           
    NvsAssetPackageManagerError_UpgradeVersion,       
    NvsAssetPackageManagerError_IO,                   
    NvsAssetPackageManagerError_Resource              
} NvsAssetPackageManagerError;
 
typedef enum {
    NvsAssetPackageAspectRatio_16v9 = 1,
    NvsAssetPackageAspectRatio_1v1 = 2,
    NvsAssetPackageAspectRatio_9v16 = 4,
    NvsAssetPackageAspectRatio_4v3 = 8,
    NvsAssetPackageAspectRatio_3v4 = 16,
    NvsAssetPackageAspectRatio_18v9 = 32,
    NvsAssetPackageAspectRatio_9v18 = 64
} NvsAssetPackageAspectRatio;
 
typedef enum {
    NvsTemplateFootageTypeVideoImage = 0,
    NvsTemplateFootageTypeVideo = 1,
    NvsTemplateFootageTypeImage = 2,
    NvsTemplateFootageTypeAudio = 3,
    NvsTemplateFootageTypeFreezeFrame = 4
} NvsTemplateFootageType;
 
typedef struct {
    bool enabled;                       
    float amplitude;                    
    float whitening;                    
    float reddening;                    
    bool sharpenEnabled;                
    bool defaultBeautyEnabled;          
    float defaultBeautyIntensity;       
} NvsARSceneBeautyPreset;
 
typedef struct {
    bool enabled;                       
    float eyeSizeWarp;                  
    float eyeCornerStretch;             
    float faceWidthWarp;                
    float faceLengthWarp;               
    float foreheadWarp;                 
    float hairlineWarp;                 
    float malarWarp;                    
    float jawWarp;                      
    float chinWarp;                     
    float eyebrowWarp;                  
    float eyeDistanceWarp;              
    float noseLengthWarp;               
    float noseWidthWarp;                
    float mouthSizeWarp;                
    float mouthWidthWarp;               
    float mouthCornerLift;              
    float faceSizeWarp;                 
} NvsARSceneShapeBeautificationPreset;
 
typedef struct {
    float fovy;                         
} NvsARSceneCameraPreset;
 
NVS_EXPORT @interface NvsTemplateFootageCorrespondingClipInfo : NSObject
 
@property (nonatomic, assign) int trackIndex;
@property (nonatomic, assign) int clipIndex;
@property (nonatomic, assign) int64_t inPoint;
@property (nonatomic, assign) int64_t outPoint;
@property (nonatomic, assign) int64_t trimIn; 
@property (nonatomic, assign) int64_t trimOut;
@property (nonatomic, assign) BOOL needReverse;
@property (nonatomic, assign) BOOL canReplace;
 
@end
 
NVS_EXPORT @interface NvsTemplateFootageDesc : NSObject
 
@property (nonatomic, strong) NSString *footageId;
@property (nonatomic, assign) NvsTemplateFootageType type;
@property (nonatomic, assign) BOOL canReplace;
@property (nonatomic, strong) NSString *innerAssetFilePath;
@property (nonatomic, strong) NSArray <NSString *>*tags;
@property (nonatomic, strong) NSArray <NvsTemplateFootageCorrespondingClipInfo *>*correspondingClipInfos;
@property (nonatomic, strong) NSArray<NvsTemplateFootageDesc *>*timelineClipFootages;   
 
@end
NVS_EXPORT @interface NvsTemplateCaptionDesc : NSObject
 
@property (nonatomic, strong) NSString *replaceId;
@property (nonatomic, strong) NSString *text;
@property (nonatomic, assign) int trackIndex;      
@property (nonatomic, assign) int clipIndex;       
@property (nonatomic, strong) NSArray<NvsTemplateCaptionDesc*>* subCaptions;   
 
@end
NVS_EXPORT @interface NvsTemplateCompoundCaptionItemDesc : NSObject
 
@property (nonatomic, assign) int index;        
@property (nonatomic, strong) NSString *text;   
 
@end
 
NVS_EXPORT @interface NvsTemplateCompoundCaptionDesc : NSObject
 
@property (nonatomic, strong) NSString *replaceId;  
@property (nonatomic, strong) NSArray <NvsTemplateCompoundCaptionItemDesc *>*itemList;       
@property (nonatomic, assign)  int trackIndex;      
@property (nonatomic, assign)  int clipIndex;       
@property (nonatomic, strong) NSArray<NvsTemplateCompoundCaptionDesc*> *subCaptions;   
 
@end
 
 
 
@protocol NvsAssetPackageManagerGenerateTemplateDelegate <NSObject>
@optional
 
- (void)onGenerateTemplatePackageFinished:(NSString *)assetPackageFilePath error:(NvsAssetPackageManagerError)error;
 
@end
 
@protocol NvsAssetPackageManagerDelegate <NSObject>
@optional
 
- (void)didFinishAssetPackageInstallation:(NSString *)assetPackageId filePath:(NSString *)assetPackageFilePath type:(NvsAssetPackageType)assetPackageType error:(NvsAssetPackageManagerError)error;
 
- (void)didFinishAssetPackageUpgrading:(NSString *)assetPackageId filePath:(NSString *)assetPackageFilePath type:(NvsAssetPackageType)assetPackageType error:(NvsAssetPackageManagerError)error;
 
@end
 
NVS_EXPORT @interface NvsAssetPackageManager : NSObject
 
@property (nonatomic, weak) id<NvsAssetPackageManagerDelegate> delegate;
@property (nonatomic, weak) id<NvsAssetPackageManagerGenerateTemplateDelegate> generateTemplateDelegate;
 
 
- (NSString *)getAssetPackageIdFromAssetPackageFilePath:(NSString *)assetPackageFilePath;
 
- (int)getAssetPackageVersionFromAssetPackageFilePath:(NSString *)assetPackageFilePath;
 
// 安装asset package
// @assetPackageFilePath: 待安装asset package的文件路径
// @licenseFilePath: 待安装asset package的授权文件
// @type: 待安装asset package的类型
// @synchronous: 是否同步安装
//               YES: 安装过程会阻塞当前线程直到安装成功或者失败
//               NO: 安装过程的结果通过delegate异步通知（但也在当前线程通知）
// @assetPackageId: 返回该asset package的标识符
//
// 返回值为一个错误号
// NvsAssetPackageManagerError_NoError: 表示安装成功（只有同步安装才可能返回这个值）
// NvsAssetPackageManagerError_AlreadyInstalled: 表示当前asset package已经安装
// NvsAssetPackageManagerError_WorkingInProgress: 表示安装正在进行中（只有异步安装才可能返回这个值）
// 任何其它返回值都表示安装错误
//
- (NvsAssetPackageManagerError)installAssetPackage:(NSString *)assetPackageFilePath license:(NSString *)licenseFilePath type:(NvsAssetPackageType)type sync:(BOOL)synchronous assetPackageId:(NSMutableString *)assetPackageId;
 
// 升级asset package
// @assetPackageFilePath: 待升级asset package的文件路径
// @licenseFilePath: 待升级asset package的授权文件
// @type: 待升级asset package的类型
// @synchronous: 是否同步升级
//               YES: 升级过程会阻塞当前线程直到升级成功或者失败
//               NO: 升级过程的结果通过delegate异步通知（但也在当前线程通知）
// @assetPackageId: 返回该asset package的标识符
//
// 返回值为一个错误号
// NvsAssetPackageManagerError_NoError: 表示升级成功（只有同步升级才可能返回这个值）
// NvsAssetPackageManagerError_NotInstalled: 表示当前asset package尚未安装
// NvsAssetPackageManagerError_WorkingInProgress: 表示升级正在进行中（只有异步升级才可能返回这个值）
// 任何其它返回值都表示升级错误
//
- (NvsAssetPackageManagerError)upgradeAssetPackage:(NSString *)assetPackageFilePath license:(NSString *)licenseFilePath type:(NvsAssetPackageType)type sync:(BOOL)synchronous assetPackageId:(NSMutableString *)assetPackageId;
 
- (NvsAssetPackageManagerError)uninstallAssetPackage:(NSString *)assetPackageId type:(NvsAssetPackageType)type;
 
- (NvsAssetPackageStatus)getAssetPackageStatus:(NSString *)assetPackageId type:(NvsAssetPackageType)type;
 
- (int)getAssetPackageVersion:(NSString *)assetPackageId type:(NvsAssetPackageType)type;
 
- (NSString*)getAssetPackageMinSdkVersion:(NSString *)assetPackageId type:(NvsAssetPackageType)type;
 
- (NSString*)getAssetPackageContentType:(NSString *)assetPackageId type:(NvsAssetPackageType)type;
 
- (NSArray <NvsExpressionParam *>*)getExpValueList:(NSString *)assetPackageId type:(NvsAssetPackageType)type;
 
- (NSDictionary<NSString*, NSString*>*)getTranslationMap:(NSString *)assetPackageId type:(NvsAssetPackageType)type;
 
- (int)getAssetPackageSupportedAspectRatio:(NSString *)assetPackageId type:(NvsAssetPackageType)type;
 
// 获取某个类型的asset package的列表
// @type: asset package的类型
// 返回值为一个NSString类型的NSArray，每一个NSString都是一个资源包的标识符
- (NSArray *)getAssetPackageListOfType:(NvsAssetPackageType)type;
 
- (BOOL)isCustomAnimatedSticker:(NSString *)uuidString;
 
- (BOOL)isParticleFx:(NSString *)uuidString;
 
- (BOOL)isThemeContainMusic:(NSString *)uuidString;
 
- (NSString *)GetVideoFxAssetPackageDescription:(NSString *)uuidString;
 
- (NSArray <NvsTemplateFootageDesc *>*)getTemplateFootages:(NSString *)uuidString;
 
- (NSArray <NvsTemplateCaptionDesc *>*)getTemplateCaptions:(NSString *)uuidString;
 
- (int)getTemplateCurrentAspectRatio:(NSString *)uuidString;
 
- (NSArray <NvsTemplateCompoundCaptionDesc *>*)getTemplateCampoundCaptions:(NSString *)uuidString;
 
- (BOOL)changeTemplateAspectRatio:(NSString *)uuidString aspectRatio:(int)aspectRatio;
 
- (NSString *)getARSceneAssetPackagePrompt:(NSString *)uuidString;
 
-(BOOL)isARSceneAssetPackageContainMakeup:(NSString *)uuidString;
 
-(BOOL)isARSceneAssetPackageContainFaceMesh:(NSString *)uuidString;
 
-(BOOL)isARSceneAssetPackageContainWarp:(NSString *)uuidString;
 
- (BOOL)getARSceneAssetPackage:(NSString *)uuidString
                  beautyPreset:(NvsARSceneBeautyPreset *)beautyPreset;
 
- (BOOL)getARSceneAssetPackage:(NSString *)uuidString
     shapeBeautificationPreset:(NvsARSceneShapeBeautificationPreset *)shapeBeautificationPreset;
 
 
 
- (BOOL)getARSceneAssetPackage:(NSString *)uuidString
     cameraPreset:(NvsARSceneCameraPreset *)cameraPreset;
 
- (BOOL)hasAudioInAssetPackage:(NSString *)uuidString type:(NvsAssetPackageType)assetPackageType;
 
- (BOOL)hasDetectionInAssetPackage:(NSString *)uuidString type:(NvsAssetPackageType)assetPackageType;
 
 
- (NSString *)decodeFile:(NSString *)fileFile
                 licPath:(NSString *)licPath
                  isJson:(BOOL)isJson;
- (void)createZipFileAtPath:(NSString *)path withContentsOfDirectory:(NSString *)directoryPath;
@end