NvsVideoClip.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 "NvsCommonDef.h"
#import "NvsClip.h"
#import "NvsCustomAudioFx.h"
#import "NvsCustomVideoFx.h"
#import "NvsClipCaption.h"
#import "NvsClipCompoundCaption.h"
#import "NvsClipAnimatedSticker.h"
#import <CoreGraphics/CGGeometry.h>
 
typedef enum NvsVideoClipType {
    NvsVideoClipType_AV = 0,   
    NvsVideoClipType_Image,    
} NvsVideoClipType;
 
typedef enum {
    NvsStreamingEngineImageClipMotionMode_LetterBoxZoomIn = 0,  
    NvsStreamingEngineImageClipMotionMode_LetterBoxZoomOut,     
    NvsStreamingEngineImageClipMotionMode_ROI,                  
    NvsStreamingEngineImageClipMotionMode_Crop                  
} NvsStreamingEngineImageClipMotionMode;
 
typedef enum NvsSourceBackgroundMode {
    NvsSourceBackgroundModeColorSolid = 0,  
    NvsSourceBackgroundModeBlur,            
} NvsSourceBackgroundMode;
 
typedef enum NvsVariantImageFillMode {
    NvsVariantImageFillModeAspectFit = 0,  
    NvsVariantImageFillModeAspectFill,     
    NvsVariantImageFillModeFill,           
} NvsVariantImageFillMode;
 
typedef enum NvsClipWrapMode {
    NvsClipWrapMode_Repeat_LastFrame = 0,
    NvsClipWrapMode_Repeat_FirstFrame = 1,
    NvsClipWrapMode_Repeat = 2
} NvsClipWrapMode;
 
typedef enum NvsExtraVideoRotation {
    NvsExtraVideoRotation_0 = 0,
    NvsExtraVideoRotation_90 = 1,
    NvsExtraVideoRotation_180 = 2,
    NvsExtraVideoRotation_270 = 3
} NvsExtraVideoRotation;
 
typedef enum NvsClipBlendingMode {
    NvsClipBlendingMode_Normal = 0,        
    NvsClipBlendingMode_Multiplay,         
    NvsClipBlendingMode_Subtract,          
    NvsClipBlendingMode_Screen,            
    NvsClipBlendingMode_Add,               
    NvsClipBlendingMode_Exclusion,         
    NvsClipBlendingMode_Darken,         
    NvsClipBlendingMode_Burn,         
    NvsClipBlendingMode_LinearBurn,         
    NvsClipBlendingMode_Lighten,         
    NvsClipBlendingMode_Dodge,         
    NvsClipBlendingMode_Overlay,         
    NvsClipBlendingMode_SoftLight,         
    NvsClipBlendingMode_HardLight,         
    NvsClipBlendingMode_VividLight,         
    NvsClipBlendingMode_PinLight,         
    NvsClipBlendingMode_LinearLight,         
    NvsClipBlendingMode_HardMix,         
    NvsClipBlendingMode_Difference,         
} NvsClipBlendingMode;
 
typedef NS_ENUM(NSInteger, NvsClipRawFilterProcessesMode) {
    NvsClipRawFilterProcessesModeNone = 0, 
    NvsClipRawFilterProcessesModeVarSize, 
    NvsClipRawFilterProcessesModeVarSizeWithFillModeUsed 
};
 
@class NvsVideoFx;
 
NVS_EXPORT @interface NvsVideoClip : NvsClip
 
 
@property (readonly) NvsVideoClipType videoType;                              
 
 
@property (readonly) NvsRoleInTheme roleInTheme;                              
 
@property (nonatomic) NvsStreamingEngineImageClipMotionMode imageMotionMode;  
 
@property (nonatomic) BOOL imageMotionAnimationEnabled;                       
 
@property (readonly) NvsRect startROI;                                        
 
@property (readonly) NvsRect endROI;                                          
 
@property (readonly) unsigned int audioFxCount;                               
 
@property (nonatomic, assign) NvsClipRawFilterProcessesMode rawFilterProcessesMode; 
 
- (void)setPlayInReverse:(BOOL)playInReverse;
 
- (BOOL)getPlayInReverse;
 
- (void)setExtraVideoRotation:(NvsExtraVideoRotation)rotation;
 
- (void)setExtraVideoRotation:(NvsExtraVideoRotation)rotation rotateROI:(bool)rotateROI;
 
- (NvsExtraVideoRotation)getExtraVideoRotation;
 
- (void)setPan:(float)pan andScan:(float)scan;
 
- (void)getPan:(float *)pan andScan:(float *)scan;
 
- (void)enableVideoClipROI:(BOOL) enable;
 
- (BOOL)isVideoClipROIEnabled;
 
- (void)setSourceBackgroundMode:(NvsSourceBackgroundMode) sourceBackgroundMode;
 
- (NvsSourceBackgroundMode)getSourceBackgroundMode;
 
- (void)setSourceBackgroundColor:(NvsColor *)color;
 
- (NvsColor)getSourceBackgroundColor;
 
- (void)disableAmbiguousCrop:(BOOL) disable;
 
- (BOOL)isAmbiguousCropDisabled;
 
- (void)setImageMotionROI:(NvsRect *)startROI endROI:(NvsRect *)endROI;
 
- (void)setClipWrapMode:(NvsClipWrapMode)wrapMode;
 
- (NvsClipWrapMode)getClipWrapMode;
 
- (void)setAudioFadeInDuration:(int64_t)fadeInDuration;
 
- (int64_t)getAudioFadeInDuration;
 
- (void)setAudioFadeOutDuration:(int64_t)fadeOutDuration;
 
- (int64_t)getAudioFadeOutDuration;
 
- (void)changeVariableSpeed:(double)startSpeed endSpeed:(double)endSpped keepAudioPitch:(BOOL)keepAudioPitch;
 
-(double)getStartSpeed;
 
- (double)getEndSpeed;
 
- (void)setBlendingMode:(NvsClipBlendingMode)blendMode;
 
- (NvsClipBlendingMode)getBlendingMode;
 
- (void)setOpacity:(float)opacity;
 
- (float)getOpacity;
 
- (void)setEnableOriginalRender:(BOOL)enable;
 
- (BOOL)isOriginalRender;
 
- (void)enableClipFreezeFrame:(BOOL)enable;
 
- (BOOL)isClipFreezeFrameEnabled;
 
- (void)setClipFreezeFrameTrimPosition:(long)trimPos;
 
- (long)getClipFreezeFrameTrimPosition;
 
- (void)enableRawSourceMode:(BOOL) enable;
 
- (BOOL)isRawSourceModeEnabled;
 
- (NvsAudioFx *)appendAudioFx:(NSString *)fxName;
 
- (NvsAudioFx *)insertAudioFx:(NSString *)fxName fxIndex:(unsigned int)fxIndex;
 
- (NvsAudioFx *)appendCustomAudioFx:(id<NvsCustomAudioFxRenderer>)customAudioFxRender;
 
- (NvsAudioFx *)insertCustomAudioFx:(id<NvsCustomAudioFxRenderer>)customAudioFxRender fxIndex:(unsigned int)fxIndex;
 
- (BOOL)removeAudioFx:(unsigned int)fxIndex;
 
- (NvsAudioFx *)getAudioFxWithIndex:(unsigned int)fxIndex;
 
- (NvsVideoFx *)appendBuiltinFx:(NSString *)fxName;
 
- (NvsVideoFx *)insertBuiltinFx:(NSString *)fxName fxIndex:(unsigned int)fxIndex;
 
- (NvsVideoFx *)appendPackagedFx:(NSString *)fxPackageId;
 
- (NvsVideoFx *)insertPackagedFx:(NSString *)fxPackageId fxIndex:(unsigned int)fxIndex;
 
- (NvsVideoFx *)appendCustomFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender;
 
- (NvsVideoFx *)insertCustomFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender fxIndex:(unsigned int)fxIndex;
 
- (NvsVideoFx *)appendRawBuiltinFx:(NSString *)fxName;
 
- (NvsVideoFx *)insertRawBuiltinFx:(NSString *)fxName fxIndex:(unsigned int)fxIndex;
 
- (NvsVideoFx *)appendRawPackagedFx:(NSString *)fxPackageId;
 
- (NvsVideoFx *)insertRawPackagedFx:(NSString *)fxPackageId fxIndex:(unsigned int)fxIndex;
 
- (NvsVideoFx *)appendRawCustomFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender;
 
- (NvsVideoFx *)insertRawCustomFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender fxIndex:(unsigned int)fxIndex;
 
- (NvsVideoFx *)appendBeautyFx;
 
- (NvsVideoFx *)insertBeautyFx:(unsigned int)fxIndex;
 
- (NvsVideoFx *)appendBuiltinFx:(NSString *)fxName inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)insertBuiltinFx:(NSString *)fxName fxIndex:(unsigned int)fxIndex inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)appendPackagedFx:(NSString *)fxPackageId inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)insertPackagedFx:(NSString *)fxPackageId fxIndex:(unsigned int)fxIndex inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)appendCustomFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)insertCustomFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender fxIndex:(unsigned int)fxIndex inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)appendRawBuiltinFx:(NSString *)fxName inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)insertRawBuiltinFx:(NSString *)fxName fxIndex:(unsigned int)fxIndex inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)appendRawPackagedFx:(NSString *)fxPackageId inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)insertRawPackagedFx:(NSString *)fxPackageId fxIndex:(unsigned int)fxIndex inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)appendRawCustomFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)insertRawCustomFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender fxIndex:(unsigned int)fxIndex inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)appendBeautyFx:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsVideoFx *)insertBeautyFx:(unsigned int)fxIndex inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
 
- (BOOL)removeFx:(unsigned int)fxIndex;
 
- (BOOL)removeRawFx:(unsigned int)fxIndex;
 
- (BOOL)removeAllAudioFx;
 
- (BOOL)removeAllVideoFx;
 
- (BOOL)removeAllFx;
 
- (NvsVideoFx *)getFxWithIndex:(unsigned int)fxIndex;
 
- (unsigned int)getRawFxCount;
 
- (NvsVideoFx *)getRawFxByIndex:(unsigned int)fxIndex;
 
- (NvsVariantImageFillMode)getRefImageFillMode;
 
- (void)setRefImageFillMode:(NvsVariantImageFillMode)variantImageBackgroundMode;
 
- (NvsSize)getRefImageSize;
 
- (void)setRefImageSize:(NvsSize)refImageSize;
 
- (NvsSourceBackgroundMode)getRefImageBackgroundMode;
 
- (void)setRefImageBackgroundMode:(NvsSourceBackgroundMode)variantImageBackgroundMode;
 
- (NvsColor)getRefImageBackgroundColor;
 
- (void)setRefImageBackgroundColor:(NvsColor *)color;
 
- (float)getRefImageBackgroundBlurRadius;
 
- (void)setRefImageBackgroundBlurRadius:(float)radius;
 
 
- (BOOL)getRefImageBackgroundBlurNewModeEnable;
 
- (void)setRefImageBackgroundBlurNewModeEnable:(BOOL)newModeEnable;
 
- (void)updateAudioForClipVideoFx;
 
- (NvsVideoFx *)getPropertyVideoFx;
 
- (NvsVideoFx *)setCustomPropertyVideoFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender;
 
- (void)enablePropertyVideoFx:(BOOL)enable;
 
- (NvsClipCaption *)getFirstCaption;
 
- (NvsClipCaption *)getLastCaption;
 
- (NvsClipCaption *)getPrevCaption:(NvsClipCaption *)caption;
 
- (NvsClipCaption *)getNextCaption:(NvsClipCaption *)caption;
 
- (NSArray *)getCaptionsByClipTimePosition:(int64_t)cliptimePos;
 
- (NvsClipCaption *)addCaption:(NSString *)captionText inPoint:(int64_t)inPoint duration:(int64_t)duration captionStylePackageId:(NSString *)captionStylePackageId;
 
- (NvsClipCaption *)addPanoramicCaption:(NSString *)captionText inPoint:(int64_t)inPoint duration:(int64_t)duration captionStylePackageId:(NSString *)captionStylePackageId;
 
- (NvsClipCaption *)addModularCaption:(NSString *)captionText inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsClipCaption *)removeCaption:(NvsClipCaption *)caption;
 
- (NvsClipCompoundCaption *)getFirstCompoundCaption;
 
- (NvsClipCompoundCaption *)getLastCompoundCaption;
 
- (NvsClipCompoundCaption *)getPrevCompoundCaption:(NvsClipCompoundCaption *)caption;
 
- (NvsClipCompoundCaption *)getNextCompoundCaption:(NvsClipCompoundCaption *)caption;
 
- (NSArray<NvsClipCompoundCaption*> *)getCompoundCaptionsByClipTimePosition:(int64_t)cliptimePos;
 
- (NvsClipCompoundCaption *)addCompoundCaption:(int64_t)inPoint
                                          duration:(int64_t)duration
                          compoundCaptionPackageId:(NSString *)compoundCaptionPackageId;
 
- (NvsClipCompoundCaption *)removeCompoundCaption:(NvsClipCompoundCaption *)caption;
 
- (NvsClipAnimatedSticker *)getFirstAnimatedSticker;
 
- (NvsClipAnimatedSticker *)getLastAnimatedSticker;
 
- (NvsClipAnimatedSticker *)getPrevAnimatedSticker:(NvsClipAnimatedSticker *)animatedSticker;
 
- (NvsClipAnimatedSticker *)getNextAnimatedSticker:(NvsClipAnimatedSticker *)animatedSticker;
 
- (NSArray *)getAnimatedStickersByClipTimePosition:(int64_t)cliptimePos;
 
- (NvsClipAnimatedSticker *)addAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration animatedStickerPackageId:(NSString*)animatedStickerPackageId;
 
- (NvsClipAnimatedSticker *)addPanoramicAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration animatedStickerPackageId:(NSString*)animatedStickerPackageId;
 
- (NvsClipAnimatedSticker *)addCustomAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration animatedStickerPackageId:(NSString*)animatedStickerPackageId customImagePath:(NSString*)customImagePath;
 
- (NvsClipAnimatedSticker *)addCustomPanoramicAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration animatedStickerPackageId:(NSString*)animatedStickerPackageId customImagePath:(NSString*)customImagePath;
 
- (NvsClipAnimatedSticker *)removeAnimatedSticker:(NvsClipAnimatedSticker *)animatedSticker;
 
- (BOOL)isPropertyVideoFxEnabled;
 
 
@end