NvsEffectRenderCore.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 10. 2019
//   Author:        Meishe video team
//================================================================================
 
#pragma once
 
#import <Foundation/Foundation.h>
#import "NvsEffectCommonDef.h"
#import <CoreVideo/CVPixelBuffer.h>
 
@class NvsEffect;
 
typedef enum {
    NvsEffectCoreError_NoError = 0,
    NvsEffectCoreError_Unknown = -1,
    NvsEffectCoreError_InvalidTexture = -2,
    NvsEffectCoreError_InvalidPixelFormat = -3,
    NvsEffectCoreError_NotInitialized = -4,
} NvsEffectCoreError;
 
typedef enum {
    NvsInitializeFlag_NoFlag = 0,
    NvsInitializeFlag_InSingleGLThread = 1,
    NvsInitializeFlag_CreateGLContextIfNeed = 2,
    NvsInitializeFlag_SUPPORT_4K = 4,
    NvsInitializeFlag_SUPPORT_8K = 8,
    NvsInitializeFlag_SUPPORT_16K = 16
} NvsInitializeFlags;
 
typedef enum {
    NvsRenderFlag_NoFlag = 0,
    NvsRenderFlag_IsUpsideDownTexture = 1,
    NvsRenderFlags_InputTextureIsFlipHorizontally = 2,
    NvsRenderFlags_DownloadAsync = 16
} NvsRenderFlag;
 
typedef struct
{
    int texWidth;
    int texHeight;
    int centerPointX;
    int centerPointY;
    NvsEffectRational imagePar;
    NvsEffectRational proxyScale;
} NvsEffectGPUTextureInfo;
 
static inline NvsEffectGPUTextureInfo NvEffectGPUTextureInfoMake(int w, int h)
{
    NvsEffectGPUTextureInfo info;
    info.texWidth = w;
    info.texHeight = h;
    info.centerPointX = 0;
    info.centerPointY = 0;
    info.imagePar.num = 1;
    info.imagePar.den = 1;
    info.proxyScale.num = 1;
    info.proxyScale.den = 1;
    return info;
}
 
typedef struct
{
    int texId;
    bool isUpSideDown;
    NvsEffectGPUTextureInfo texInfo;
    NvsEffectGpuVideoFrameFormat texFormat;
    NvsEffectVideoFrameColorPrimaries colorPrimaries;
    NvsEffectVideoFrameColorTransfer colorTransfer;
} NvsEffectGPUTexture;
 
static inline NvsEffectGPUTexture NvEffectGPUTextureMake(NvsEffectGPUTextureInfo info, int texId, NvsEffectGpuVideoFrameFormat format)
{
    NvsEffectGPUTexture tex;
    tex.texId = texId;
    tex.texFormat = format;
    tex.texInfo = info;
    tex.isUpSideDown = false;
    tex.colorPrimaries = NvsEffectVideoFrameColorPrimaries_Bt709;
    tex.colorTransfer = NvsEffectVideoFrameColorTransfer_sRGB;
    return tex;
}
 
#define NVS_EFFECT_DISPLAY_ROTATION            @"display_rotation"      
#define NVS_EFFECT_PHYSICAL_ORIENTATION        @"physical_orientation"  
#define NVS_EFFECT_FLIP_HORIZONTALLY           @"flip_horizontally"     
#define NVS_EFFECT_TIMESTAMP                   @"timestamp"             
#define NVS_EFFECT_FLAGS                       @"flags"                 
#define NVS_EFFECT_OUTPUT_FRAME_FORMAT         @"output_frame_format"   
#define NVS_EFFECT_IS_BT601                    @"is_bt.601"             
 
 
NVS_EXPORT @interface NvsEffectRenderCore : NSObject
 
- (BOOL)initialize;
 
- (BOOL)initializeWithFlags:(int)falgs;
 
- (BOOL)initializeWithFlags:(int)falgs maxCacheSize:(int64_t)size;
 
- (void)cleanUp;
 
- (NvsEffectCoreError)renderEffect:(NvsEffect *)effect
                        inputTexId:(int)inputTexId
              inputVideoResolution:(NvsEffectVideoResolution *)inputVideoResolution
                       outputTexId:(int)outputTexId
                         timestamp:(int64_t)timestamp
                             flags:(NvsRenderFlag)flags;
 
- (NvsEffectCoreError)renderEffect:(NvsEffect *)effect
                        inputTexId:(int)inputTexId
                  inputBuddyBuffer:(const NvsEffectVideoFrameInfo*)inputBuddyBuffer
               physicalOrientation:(int)physicalOrientation
              inputVideoResolution:(NvsEffectVideoResolution *)inputVideoResolution
                       outputTexId:(int)outputTexId
                         timestamp:(int64_t)timestamp
                             flags:(NvsRenderFlag)flags;
 
- (NvsEffectCoreError)renderEffects:(NSArray<NvsEffect *>*)effects
                         inputTexId:(int)inputTexId
                   inputBuddyBuffer:(const NvsEffectVideoFrameInfo*)inputBuddyBuffer
                physicalOrientation:(int)physicalOrientation
               inputVideoResolution:(NvsEffectVideoResolution *)inputVideoResolution
                        outputTexId:(int)outputTexId
                          timestamp:(int64_t)timestamp
                              flags:(NvsRenderFlag)flags;
 
- (NvsEffectCoreError)renderEffects:(NSArray<NvsEffect *>*)effects
                         inputImage:(CVPixelBufferRef)inputImage
                    displayRotation:(int)displayRotation
                 isFlipHorizontally:(BOOL)isFlip
                physicalOrientation:(int)physicalOrientation
                        outputTexId:(int)outputTexId
                          timestamp:(int64_t)timestamp
                              flags:(NvsRenderFlag)flags;
 
- (NvsEffectCoreError)renderEffect:(NvsEffect *)effect
                        inputImage:(CVPixelBufferRef)inputImage
                   displayRotation:(int)rotation
                isFlipHorizontally:(BOOL)isFlip
                         timestamp:(int64_t)timestamp
                             flags:(NvsRenderFlag)flags
                 outputFrameFormat:(NvsEffectVideoFramePixelFormat)format
                outputFrameIsBT601:(BOOL)is601
                       outputImage:(CVPixelBufferRef*)ouputImage;
 
- (NvsEffectCoreError)renderEffects:(NSArray<NvsEffect *>*)effects
                         inputImage:(CVPixelBufferRef)inputImage
                    displayRotation:(int)rotation
                 isFlipHorizontally:(BOOL)isFlip
                          timestamp:(int64_t)timestamp
                              flags:(NvsRenderFlag)flags
                  outputFrameFormat:(NvsEffectVideoFramePixelFormat)ouputFrameformat
                 outputFrameIsBT601:(BOOL)is601
                        outputImage:(CVPixelBufferRef*)ouputImage;
 
- (NvsEffectCoreError)renderEffects:(NSArray<NvsEffect *>*)effects
                         inputImage:(CVPixelBufferRef)inputImage
                        outputImage:(CVPixelBufferRef*)ouputImage
                            options:(NSDictionary *)options;
 
- (NvsEffectCoreError)renderEffectsWithPixelBuffer:(NSArray<NvsEffect *>*)effects
                                         inputImage:(CVPixelBufferRef)inputImage
                                    displayRotation:(int)rotation
                                physicalOrientation:(int)physicalOrientation
                                 isFlipHorizontally:(BOOL)isFlip
                                          timestamp:(int64_t)timestamp
                                              flags:(NvsRenderFlag)flags
                                        outputImage:(CVPixelBufferRef)ouputImage;
 
- (NvsEffectCoreError)renderEffects:(NSArray<NvsEffect *>*)effects
                         inputImage:(CVPixelBufferRef)inputImage
                            options:(NSDictionary *)options;
 
- (NvsEffectCoreError)renderEffect:(NvsEffect *)effect
                       inputTexIds:(NSArray*)inputTextures
              inputVideoResolution:(NvsEffectVideoResolution *)inputVideoResolution
                       outputTexId:(int)outputTexId
                         timestamp:(int64_t)timestamp
                             flags:(NvsRenderFlag)flags;
 
- (NvsEffectCoreError)calcEffectOutputSize:(NvsEffect *)effect
                                    inputTexs:(NvsEffectGPUTexture*)inputTextureArray
                                intputTexCount:(int)texArrayCount
                      expectVideoResolution:(NvsEffectVideoResolution *)videoResolution
                                    outputTex:(NvsEffectGPUTextureInfo*)outputTexInfo
                                    timestamp:(int64_t)timestamp
                                        flags:(NvsRenderFlag)flags;
 
- (NvsEffectCoreError)renderVariantSizeEffect:(NvsEffect *)effect
                                    inputTexs:(NvsEffectGPUTexture*)inputTextureArray
                                intputTexSize:(int)texArrayCount
                                    outputTex:(NvsEffectGPUTexture*)outputTex
                                    timestamp:(int64_t)timestamp
                                        flags:(NvsRenderFlag)flags;
 
- (NvsEffectCoreError)renderEffects:(NSArray<NvsEffect *>*)effects
                         inputTex:(NvsEffectGPUTexture *)inputTex
                   inputBuddyBuffer:(const NvsEffectVideoFrameInfoExt*)inputBuddyBuffer
                physicalOrientation:(int)physicalOrientation
                        outputTex:(NvsEffectGPUTexture *)outputTex
                          timestamp:(int64_t)timestamp
                              flags:(NvsRenderFlag)flags;
 
- (void)clearEffectResources:(NvsEffect *)effect;
 
- (void)clearCacheResources;
 
-(NvsEffectCoreError)uploadPixelBufferToTexture:(CVPixelBufferRef)frameBuffer displayRotation:(int)rotation horizontalFlip:(BOOL)flip outputTexId:(int)outputTexId;
 
-(NvsEffectCoreError)uploadPixelBufferToTexture:(CVPixelBufferRef)frameBuffer horizontalFlip:(BOOL)flip outputTexId:(int)outputTexId;
 
-(NvsEffectCoreError)uploadPixelBufferToTexture:(CVPixelBufferRef)frameBuffer displayRotation:(int)rotation horizontalFlip:(BOOL)flip outputTex:(NvsEffectGPUTexture *)outputTex;
 
-(NvsEffectCoreError)downloadPixelBufferFromTexture:(int)inputTexId
                          inputVideoResolution:(NvsEffectVideoResolution *)inputVideoResolution
                             outputFrameFormat:(NvsEffectVideoFramePixelFormat)format
                                       isBT601:(BOOL)is601
                                   outputFrame:(CVPixelBufferRef*)frameBuffer;
 
-(NvsEffectCoreError)downloadPixelBufferFromTexture:(NvsEffectGPUTexture *)inputTexture
                                    outputFrameFormat:(NvsEffectVideoFramePixelFormat)format
                                     outputYUVMatrix:(NvsEffectVideoFrameYUVColorMatrix)colorMatrix
                                 outputColorTransfer:(NvsEffectVideoFrameColorTransfer)colorTransfer
                                outputColorPrimaries:(NvsEffectVideoFrameColorPrimaries)colorPrimaries
                                         outputFrame:(CVPixelBufferRef*)frameBuffer;
 
@end