MeiCam SDK For iOS  3.14.0
NvsCustomVideoFx.h
Go to the documentation of this file.
1 //================================================================================
2 //
3 // (c) Copyright Meishe Co. Ltd, 2017. All rights reserved.
4 //
5 // This code and information is provided "as is" without warranty of any kind,
6 // either expressed or implied, including but not limited to the implied
7 // warranties of merchantability and/or fitness for a particular purpose.
8 //
9 //--------------------------------------------------------------------------------
10 // Birth Date: Jul 20. 2017
11 // Author: Meishe video team
12 //================================================================================
13 #pragma once
14 
15 #import <Foundation/Foundation.h>
16 #import "NvsCommonDef.h"
17 
19  int texId;
20  int width;
21  int height;
24 
26 };
27 
36  int64_t effectTime;
37  int64_t effectStartTime;
38  int64_t effectEndTime;
39  int64_t mediaStreamTime;
40 };
41 
43 
52 @protocol NvsCustomVideoFxRenderer <NSObject>
53 
66 - (void)didInit;
67 
80 - (void)didCleanup;
81 
96 - (void)didPreloadResources;
97 
126 - (void)didRender:(struct NvsCustomVideoFxRenderContext *)renderContext
127  renderHelper:(NvsCustomVideoFxRenderHelper *)renderHelper;
128 
129 @optional
130 
143 - (void)didClearCacheResources;
144 
159 - (bool)needInputBuddyFrame;
160 
161 @end
162 
170 
185 - (int)allocateRGBATexture:(NvsSize)texSize;
186 
203 - (int)allocateRGBATexture:(NvsSize)texSize format:(NvsGpuVideoFrameFormat)fmt;
204 
213 - (void)reclaimTexture:(int)texId;
214 
225 - (BOOL)uploadHostBufferToOpenGLTexture:(NvsVideoFrameInfo*)hostBuffer textureId:(int)tId;
226 
237 - (BOOL)uploadHostBufferToOpenGLTexture:(NvsVideoFrameInfoExt*)hostBuffer gpuVideoFrame:(struct NvsCustomVideoFxVideoFrame*)tex;
238 
239 @end
240 
NvsCustomVideoFxRenderContext::inputVideoFrame
struct NvsCustomVideoFxVideoFrame inputVideoFrame
Inputs video frame.
Definition: NvsCustomVideoFx.h:29
NvsVideoFrameColorPrimaries
NvsVideoFrameColorPrimaries
Definition: NvsCommonDef.h:254
NvsCustomVideoFxVideoFrame::texId
int texId
The texture ID of the video frame.
Definition: NvsCustomVideoFx.h:19
NvsVideoFrameColorTransfer
NvsVideoFrameColorTransfer
Definition: NvsCommonDef.h:235
NvsCustomVideoFxVideoFrame::proxyScale
NvsRational proxyScale
Definition: NvsCustomVideoFx.h:23
NvsCustomVideoFxVideoFrame::isUpsideDownTexture
BOOL isUpsideDownTexture
YES means that the texture in this video frame is upside down. The user needs to deal with the textur...
Definition: NvsCustomVideoFx.h:22
NvsVideoFrameInfo
Video frame information.
Definition: NvsCommonDef.h:446
NvsCustomVideoFxRenderContext::effectEndTime
int64_t effectEndTime
Effect ending time (in microseconds).
Definition: NvsCustomVideoFx.h:38
-[NvsCustomVideoFxRenderer-p didCleanup]
void didCleanup()
Meishe SDK calls this method on custom video special effects to let users clean up resources.
-[NvsCustomVideoFxRenderer-p didClearCacheResources]
void didClearCacheResources()
Meishe SDK calls this method on custom video effects to allow some resource preprocessing.
NvsRational
Rational value.
Definition: NvsCommonDef.h:339
NvsCustomVideoFxRenderContext
Definition: NvsCustomVideoFx.h:28
NvsCustomVideoFxRenderContext::hasBuddyVideoFrame
bool hasBuddyVideoFrame
Indicates that whether the buddy video frame exists or not.Buddy video frames will only exist which s...
Definition: NvsCustomVideoFx.h:30
NvsCustomVideoFxVideoFrame::width
int width
The width of the video frame.
Definition: NvsCustomVideoFx.h:20
NvsCustomVideoFxRenderContext::mediaStreamTime
int64_t mediaStreamTime
Effect ending time (in microseconds).
Definition: NvsCustomVideoFx.h:39
NvsCustomVideoFxRenderContext::effectStartTime
int64_t effectStartTime
Effect starting time (in microseconds).
Definition: NvsCustomVideoFx.h:37
NvsCustomVideoFxRenderContext::inputBuddyVideoFrame
NvsVideoFrameInfo inputBuddyVideoFrame
Data and information of the input video frame in Host Memory.
Definition: NvsCustomVideoFx.h:31
NvsCustomVideoFxRenderer-p
Custom video effects renderer interface.
Definition: NvsCustomVideoFx.h:52
-[NvsCustomVideoFxRenderer-p needInputBuddyFrame]
bool needInputBuddyFrame()
Meishe SDK calls this method on custom video effects to allow input buddy frame.
NvsCustomVideoFxRenderContext::inputBuddyVideoFrameColorMatrix
NvsVideoFrameYUVColorMatrix inputBuddyVideoFrameColorMatrix
Definition: NvsCustomVideoFx.h:32
NvsCustomVideoFxRenderContext::outputVideoFrame
struct NvsCustomVideoFxVideoFrame outputVideoFrame
Output video frame.
Definition: NvsCustomVideoFx.h:35
NvsCustomVideoFxVideoFrame::height
int height
The height of the video frame.
Definition: NvsCustomVideoFx.h:21
NvsCustomVideoFxRenderHelper
Auxiliary method interface for custom video effects.
Definition: NvsCustomVideoFx.h:170
NvsVideoFrameYUVColorMatrix
NvsVideoFrameYUVColorMatrix
Definition: NvsCommonDef.h:217
NVS_EXPORT
#define NVS_EXPORT
Definition: NvsCommonDef.h:20
-[NvsCustomVideoFxRenderer-p didPreloadResources]
void didPreloadResources()
Meishe SDK calls this method on custom video effects to allow some resource preprocessing.
NvsCustomVideoFxVideoFrame::texFormat
NvsGpuVideoFrameFormat texFormat
Definition: NvsCustomVideoFx.h:25
-[NvsCustomVideoFxRenderer-p didInit]
void didInit()
Meishe SDK calls this method on custom video effects to let the user initialize resources.
NvsCommonDef.h
NvsGpuVideoFrameFormat
NvsGpuVideoFrameFormat
Video frame pixel format.
Definition: NvsCommonDef.h:202
NvsCustomVideoFxRenderContext::inputBuddyVideoFrameColorPrimaries
NvsVideoFrameColorPrimaries inputBuddyVideoFrameColorPrimaries
Definition: NvsCustomVideoFx.h:34
NvsCustomVideoFxVideoFrame
Definition: NvsCustomVideoFx.h:18
NvsCustomVideoFxRenderContext::effectTime
int64_t effectTime
Special effect duration (in microseconds).
Definition: NvsCustomVideoFx.h:36
NvsCustomVideoFxRenderContext::inputBuddyVideoFrameColorTransfer
NvsVideoFrameColorTransfer inputBuddyVideoFrameColorTransfer
Definition: NvsCustomVideoFx.h:33
NvsSize
Size.
Definition: NvsCommonDef.h:350
NvsVideoFrameInfoExt
Video frame extra information.
Definition: NvsCommonDef.h:466