L4T Multimedia API Reference

31.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nvbuf_utils.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2018, NVIDIA CORPORATION. All rights reserved.
3  *
4  * NVIDIA Corporation and its licensors retain all intellectual property
5  * and proprietary rights in and to this software, related documentation
6  * and any modifications thereto. Any use, reproduction, disclosure or
7  * distribution of this software and related documentation without an express
8  * license agreement from NVIDIA Corporation is strictly prohibited.
9  */
10 
25 #ifndef _NVBUF_UTILS_H_
26 #define _NVBUF_UTILS_H_
27 
28 #ifdef __cplusplus
29 extern "C"
30 {
31 #endif
32 
33 #include <EGL/egl.h>
34 #include <EGL/eglext.h>
35 #include <errno.h>
36 
40 #define MAX_NUM_PLANES 3
41 
45 #define MAX_COMPOSITE_FRAME 16
46 
50 typedef enum
51 {
57 
61 typedef enum
62 {
68 
72 typedef enum
73 {
81 
85 typedef enum
86 {
92  NvBufferTag_JPEG = 0x1500,
99 } NvBufferTag;
100 
104 typedef enum
105 {
151 
155 typedef enum
156 {
174 
178 typedef enum
179 {
193 
197 typedef enum {
207 
211 typedef enum {
215  NVBUFFER_BLEND = 1 << 1,
217 
221 typedef struct
222 {
224  float r;
226  float g;
228  float b;
230 
234 typedef struct
235 {
237  uint32_t top;
239  uint32_t left;
241  uint32_t width;
243  uint32_t height;
244 }NvBufferRect;
245 
252 typedef struct _NvBufferSession * NvBufferSession;
253 
257 typedef struct _NvBufferCreateParams
258 {
260  int32_t width;
262  int32_t height;
266  int32_t memsize;
274 
278 typedef struct _NvBufferParams
279 {
281  uint32_t dmabuf_fd;
283  void *nv_buffer;
287  int32_t memsize;
289  uint32_t nv_buffer_size;
291  uint32_t pixel_format;
293  uint32_t num_planes;
307 
312 {
314  uint32_t composite_flag;
316  uint32_t input_buf_count;
327  NvBufferSession session;
329 
334 {
336  uint32_t transform_flag;
347  NvBufferSession session;
349 
350 
356 int NvBufferGetSize (void);
357 
367 EGLImageKHR NvEGLImageFromFd (EGLDisplay display, int dmabuf_fd);
368 
378 int NvDestroyEGLImage (EGLDisplay display, EGLImageKHR eglImage);
379 
391 int NvBufferCreate (int *dmabuf_fd, int width, int height,
392  NvBufferLayout layout, NvBufferColorFormat colorFormat);
393 
401 int NvBufferCreateEx (int *dmabuf_fd, NvBufferCreateParams *input_params);
402 
410 int NvBufferGetParams (int dmabuf_fd, NvBufferParams *params);
411 
418 int NvBufferDestroy (int dmabuf_fd);
419 
427 int ExtractFdFromNvBuffer (void *nvbuf, int *dmabuf_fd);
428 
436 int NvReleaseFd (int dmabuf_fd);
437 
450 int NvBufferMemSyncForCpu (int dmabuf_fd, unsigned int plane, void **pVirtAddr);
451 
463 int NvBufferMemSyncForDevice (int dmabuf_fd, unsigned int plane, void **pVirtAddr);
464 
486 int NvBufferMemMap (int dmabuf_fd, unsigned int plane, NvBufferMemFlags memflag, void **pVirtAddr);
487 
502 int NvBufferMemUnMap (int dmabuf_fd, unsigned int plane, void **pVirtAddr);
503 
514 int NvBuffer2Raw (int dmabuf_fd, unsigned int plane, unsigned int out_width, unsigned int out_height, unsigned char *ptr);
515 
526 int Raw2NvBuffer (unsigned char *ptr, unsigned int plane, unsigned int in_width, unsigned int in_height, int dmabuf_fd);
527 
534 NvBufferSession NvBufferSessionCreate(void);
535 
540 void NvBufferSessionDestroy(NvBufferSession session);
541 
551 int NvBufferTransform (int src_dmabuf_fd, int dst_dmabuf_fd, NvBufferTransformParams *transform_params);
552 
562 int NvBufferComposite (int *src_dmabuf_fds, int dst_dmabuf_fd, NvBufferCompositeParams *composite_params);
563 
564 #ifdef __cplusplus
565 }
566 #endif
567 
570 #endif
uint32_t layout[MAX_NUM_PLANES]
layout type of each planes of hardware buffer.
Definition: nvbuf_utils.h:305
uint32_t num_planes
number of planes of hardware buffer.
Definition: nvbuf_utils.h:293
NvBufferSession session
NvBufferSession to be used for transform.
Definition: nvbuf_utils.h:347
int ExtractFdFromNvBuffer(void *nvbuf, int *dmabuf_fd)
Extracts the dmabuf_fd from the hardware buffer.
Y/CbCr 4:2:0 multi-planar.
Definition: nvbuf_utils.h:119
uint32_t left
rectangle left.
Definition: nvbuf_utils.h:239
NvBufferRect src_comp_rect[MAX_COMPOSITE_FRAME]
source rectangle coordinates of input buffers for composition.
Definition: nvbuf_utils.h:320
uint32_t transform_flag
flag to indicate which of the transform parameters are valid.
Definition: nvbuf_utils.h:336
YUV 4:2:2 planar.
Definition: nvbuf_utils.h:131
tag for H264/H265/VP9 Video Decoder.
Definition: nvbuf_utils.h:96
transform flag to set flip method.
Definition: nvbuf_utils.h:205
float g
background color value for g.
Definition: nvbuf_utils.h:226
uint32_t psize[MAX_NUM_PLANES]
size of each vodeo planes of hardware buffer.
Definition: nvbuf_utils.h:303
transform flag to set filter type.
Definition: nvbuf_utils.h:203
int NvReleaseFd(int dmabuf_fd)
Releases the dmabuf_fd buffer.
Memory read.
Definition: nvbuf_utils.h:75
flag to set for composition.
Definition: nvbuf_utils.h:213
Memory write.
Definition: nvbuf_utils.h:77
transform flag to crop source rectangle.
Definition: nvbuf_utils.h:199
Video flip rotate 270 degree clockwise.
Definition: nvbuf_utils.h:164
Video flip with respect to Y-axis.
Definition: nvbuf_utils.h:168
BGRA-8-8-8-8 planar.
Definition: nvbuf_utils.h:139
uint32_t input_buf_count
number of the input buffers to be composited.
Definition: nvbuf_utils.h:316
tag for Video Transform/Composite.
Definition: nvbuf_utils.h:98
NvBufferTransform_Filter transform_filter
transform filter.
Definition: nvbuf_utils.h:340
int32_t memsize
size of the memory.
Definition: nvbuf_utils.h:266
Video flip inverse transpode.
Definition: nvbuf_utils.h:172
NvBufferRect dst_comp_rect[MAX_COMPOSITE_FRAME]
destination rectangle coordinates of input buffers for composition.
Definition: nvbuf_utils.h:322
int32_t width
width of the buffer.
Definition: nvbuf_utils.h:260
Video flip rotate 180 degree clockwise.
Definition: nvbuf_utils.h:162
Holds composition background r,g,b colors.
Definition: nvbuf_utils.h:221
int NvBufferMemUnMap(int dmabuf_fd, unsigned int plane, void **pVirtAddr)
Unmaps the mapped virtual address of the plane.
YUV ER 4:2:2 planar.
Definition: nvbuf_utils.h:133
Y/CbCr 4:2:0 multi-planar.
Definition: nvbuf_utils.h:115
Pitch Layout.
Definition: nvbuf_utils.h:64
struct _NvBufferCreateParams NvBufferCreateParams
Holds the input parameters for hardware buffer creation.
transform filter bilinear.
Definition: nvbuf_utils.h:183
XRGB-8-8-8-8 planar.
Definition: nvbuf_utils.h:141
ARGB-8-8-8-8 planar.
Definition: nvbuf_utils.h:143
buffer payload with HW memory handle for specific memory size.
Definition: nvbuf_utils.h:55
transform filter 10 tap.
Definition: nvbuf_utils.h:187
Holds parameters for a hardware buffer.
Definition: nvbuf_utils.h:278
uint32_t nv_buffer_size
size of hardware buffer.
Definition: nvbuf_utils.h:289
int NvBuffer2Raw(int dmabuf_fd, unsigned int plane, unsigned int out_width, unsigned int out_height, unsigned char *ptr)
Copies the NvBuffer plane contents to a raw buffer plane.
Memory read & write.
Definition: nvbuf_utils.h:79
transform filter nearest.
Definition: nvbuf_utils.h:181
uint32_t composite_flag
flag to indicate which of the composition/blending parameters are valid.
Definition: nvbuf_utils.h:314
uint32_t height
rectangle height.
Definition: nvbuf_utils.h:243
transform filter smart.
Definition: nvbuf_utils.h:189
int Raw2NvBuffer(unsigned char *ptr, unsigned int plane, unsigned int in_width, unsigned int in_height, int dmabuf_fd)
Copies raw buffer plane contents to an NvBuffer plane.
NvBufferTransform_Flag
Defines flags to indicate for valid transform.
Definition: nvbuf_utils.h:197
uint32_t pixel_format
video format type of hardware buffer.
Definition: nvbuf_utils.h:291
transform filter 5 tap.
Definition: nvbuf_utils.h:185
int NvBufferMemSyncForCpu(int dmabuf_fd, unsigned int plane, void **pVirtAddr)
Syncs the HW memory cache for the CPU.
NvBufferComposite_Flag
Defines flags that specify valid composition/blending operations.
Definition: nvbuf_utils.h:211
int NvBufferMemMap(int dmabuf_fd, unsigned int plane, NvBufferMemFlags memflag, void **pVirtAddr)
Gets the memory-mapped virtual address of the plane.
YUV 4:2:2 planar.
Definition: nvbuf_utils.h:135
uint32_t width
rectangle width.
Definition: nvbuf_utils.h:241
YUV ER 4:2:2 planar.
Definition: nvbuf_utils.h:129
NvBufferTag
Defines tags to associate, while allocation of NvBuffer.
Definition: nvbuf_utils.h:85
NvBufferSession NvBufferSessionCreate(void)
Creates a new NvBufferSession for parallel scheduling of buffer transformations and compositions...
float b
background color value for b.
Definition: nvbuf_utils.h:228
#define MAX_NUM_PLANES
Defines the maximum number of planes for video frame.
Definition: nvbuf_utils.h:40
YVU420 ER multi-planar.
Definition: nvbuf_utils.h:113
tag for Camera.
Definition: nvbuf_utils.h:90
NvBufferColorFormat colorFormat
colorformat of the buffer.
Definition: nvbuf_utils.h:270
YUV420 multi-planar.
Definition: nvbuf_utils.h:107
struct _NvBufferCompositeParams NvBufferCompositeParams
Holds parameters related to compositing/blending.
NvBufferCompositeBackground composite_bgcolor
background color values for composition.
Definition: nvbuf_utils.h:324
float dst_comp_rect_alpha[MAX_COMPOSITE_FRAME]
alpha values of input buffers for the blending.
Definition: nvbuf_utils.h:318
NvBufferPayloadType payloadType
payload type of the buffer.
Definition: nvbuf_utils.h:264
NvBufferTransform_Flip transform_flip
flip method.
Definition: nvbuf_utils.h:338
uint32_t height[MAX_NUM_PLANES]
height of each planes of hardware buffer.
Definition: nvbuf_utils.h:297
tag for Jpeg Encoder/Decoder.
Definition: nvbuf_utils.h:92
struct _NvBufferParams NvBufferParams
Holds parameters for a hardware buffer.
int NvBufferMemSyncForDevice(int dmabuf_fd, unsigned int plane, void **pVirtAddr)
Syncs the HW memory cache sync for the device.
uint32_t width[MAX_NUM_PLANES]
width of each planes of hardware buffer.
Definition: nvbuf_utils.h:295
uint32_t pitch[MAX_NUM_PLANES]
pitch of each planes of hardware buffer.
Definition: nvbuf_utils.h:299
int NvBufferCreate(int *dmabuf_fd, int width, int height, NvBufferLayout layout, NvBufferColorFormat colorFormat)
Allocates a HW buffer (deprecated).
EGLImageKHR NvEGLImageFromFd(EGLDisplay display, int dmabuf_fd)
Creates an EGLImage instance from dmabuf-fd.
YUV420 ER multi-planar.
Definition: nvbuf_utils.h:111
uint32_t dmabuf_fd
dmabuf_fd of hardware buffer.
Definition: nvbuf_utils.h:281
YUV ER 4:2:2 planar.
Definition: nvbuf_utils.h:125
uint32_t offset[MAX_NUM_PLANES]
memory offset values of each video planes of hardware buffer.
Definition: nvbuf_utils.h:301
buffer payload with HW memory handle for set of planes.
Definition: nvbuf_utils.h:53
BlockLinear Layout.
Definition: nvbuf_utils.h:66
YUV420 multi-planar.
Definition: nvbuf_utils.h:109
uint32_t top
rectangle top.
Definition: nvbuf_utils.h:237
int32_t memsize
size of the memory.
Definition: nvbuf_utils.h:287
int NvBufferTransform(int src_dmabuf_fd, int dst_dmabuf_fd, NvBufferTransformParams *transform_params)
Transforms one DMA buffer to another DMA buffer.
int NvBufferGetSize(void)
This method can be used to get HW Buffer struct size.
Video flip with respect to X-axis.
Definition: nvbuf_utils.h:166
Invalid color format.
Definition: nvbuf_utils.h:149
void * nv_buffer
pointer to hardware buffer memory.
Definition: nvbuf_utils.h:283
void NvBufferSessionDestroy(NvBufferSession session)
Destroys an exisiting NvBufferSession.
Holds the input parameters for hardware buffer creation.
Definition: nvbuf_utils.h:257
int NvBufferGetParams(int dmabuf_fd, NvBufferParams *params)
Gets buffer parameters.
NvBufferPayloadType
Defines Payload types for NvBuffer.
Definition: nvbuf_utils.h:50
int NvBufferComposite(int *src_dmabuf_fds, int dst_dmabuf_fd, NvBufferCompositeParams *composite_params)
Composites multiple input DMA buffers to one output DMA buffer.
int32_t height
height of the buffer.
Definition: nvbuf_utils.h:262
Y/CbCr ER 4:2:0 multi-planar.
Definition: nvbuf_utils.h:121
NvBufferTransform_Filter
Defines transform video filter types.
Definition: nvbuf_utils.h:178
Y/CbCr ER 4:2:0 multi-planar.
Definition: nvbuf_utils.h:117
Y/CbCr 4:2:0 10-bit multi-planar.
Definition: nvbuf_utils.h:145
Y/CbCr 4:2:0 12-bit multi-planar.
Definition: nvbuf_utils.h:147
Holds parameters for buffer transform functions.
Definition: nvbuf_utils.h:333
NvBufferLayout layout
layout of the buffer.
Definition: nvbuf_utils.h:268
NvBufferTag nvbuf_tag
tag to associate with the buffer.
Definition: nvbuf_utils.h:272
float r
background color value for r.
Definition: nvbuf_utils.h:224
tag None.
Definition: nvbuf_utils.h:88
Video flip none.
Definition: nvbuf_utils.h:158
YUV 4:2:2 planar.
Definition: nvbuf_utils.h:127
struct _NvBufferTransformParams NvBufferTransformParams
Holds parameters for buffer transform functions.
transform flag to crop destination rectangle.
Definition: nvbuf_utils.h:201
Video flip transpose.
Definition: nvbuf_utils.h:170
NvBufferPayloadType payloadType
payload type of the buffer.
Definition: nvbuf_utils.h:285
NvBufferTransform_Flip
Defines video flip methods.
Definition: nvbuf_utils.h:155
YUV 4:2:2 planar.
Definition: nvbuf_utils.h:123
NvBufferRect dst_rect
destination rectangle coordinates for crop opeartion.
Definition: nvbuf_utils.h:344
NvBufferLayout
Defines Layout formats for NvBuffer video planes.
Definition: nvbuf_utils.h:61
tag for H264/H265 Video Encoder.
Definition: nvbuf_utils.h:94
int NvBufferDestroy(int dmabuf_fd)
Destroys a HW buffer.
int NvBufferCreateEx(int *dmabuf_fd, NvBufferCreateParams *input_params)
Allocates a HW buffer.
Holds coordinates for a rectangle.
Definition: nvbuf_utils.h:234
NvBufferColorFormat
Defines color formats for NvBuffer.
Definition: nvbuf_utils.h:104
Holds parameters related to compositing/blending.
Definition: nvbuf_utils.h:311
Video flip rotate 90 degree clockwise.
Definition: nvbuf_utils.h:160
struct _NvBufferSession * NvBufferSession
Holds an opaque NvBuffer session type required for parallel buffer tranformations and compositions...
Definition: nvbuf_utils.h:252
transform filter nicest.
Definition: nvbuf_utils.h:191
NvBufferRect src_rect
source rectangle coordinates for crop opeartion.
Definition: nvbuf_utils.h:342
YUV ER 4:2:2 planar.
Definition: nvbuf_utils.h:137
int NvDestroyEGLImage(EGLDisplay display, EGLImageKHR eglImage)
Destroys an EGLImage object.
NvBufferSession session
NvBufferSession to be used for composition.
Definition: nvbuf_utils.h:327
flag to set for blending.
Definition: nvbuf_utils.h:215
NvBufferMemFlags
Defines memory access flags for NvBuffer.
Definition: nvbuf_utils.h:72
#define MAX_COMPOSITE_FRAME
Defines the maximum number of input video frames that can be used for composition.
Definition: nvbuf_utils.h:45