nvscrncapt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 NVIDIA Corporation.  All Rights Reserved.
 *
 * NVIDIA Corporation and its licensors retain all intellectual property and
 * proprietary rights in and to this software and related documentation.  Any
 * use, reproduction, disclosure or distribution of this software and related
 * documentation without an express license agreement from NVIDIA Corporation
 * is strictly prohibited.
 */

#ifndef _NVSCRNCAPT_H
#define _NVSCRNCAPT_H

#ifdef __cplusplus
extern "C" {
#endif

#define NVSCRNCAPT_VERSION_MAJOR     1

#define NVSCRNCAPT_VERSION_MINOR     0

#define NVSCRNCAPT_TRUE  (0 == 0)

#define NVSCRNCAPT_FALSE (0 == 1)

#define NVSCRNCAPT_MAX_HEADS         4

#define NVSCRNCAPT_MAX_WINS          6

typedef int NvScrncaptBool;

typedef enum {
    NVSCRNCAPT_STATUS_OK = 0,
    NVSCRNCAPT_STATUS_BAD_PARAMETER,
    NVSCRNCAPT_STATUS_BUSY,
    NVSCRNCAPT_STATUS_TIMED_OUT,
    NVSCRNCAPT_STATUS_OUT_OF_MEMORY,
    NVSCRNCAPT_STATUS_NOT_INITIALIZED,
    NVSCRNCAPT_STATUS_NOT_SUPPORTED,
    NVSCRNCAPT_STATUS_ERROR,
    NVSCRNCAPT_STATUS_INVALID_SIZE,
    NVSCRNCAPT_STATUS_INCOMPATIBLE_VERSION,
} NvScrncaptStatus;

typedef enum {
  NvScrncaptSurfaceLayout_Tiled = 0,
  NvScrncaptSurfaceLayout_PitchLinear,
  NvScrncaptSurfaceLayout_BlockLinear,
} NvScrncaptSurfaceLayout;

typedef enum {
    NvScrncaptColorFormat_RGB_AUTO        = ~0,
    /* NOTE: these enums need to be kept in sync with the kernel defines */
    NvScrncaptColorFormat_P8              = 3,
    NvScrncaptColorFormat_B4G4R4A4        = 4,
    NvScrncaptColorFormat_B5G5R5A         = 5,
    NvScrncaptColorFormat_B5G6R5          = 6,
    NvScrncaptColorFormat_AB5G5R5         = 7,
    NvScrncaptColorFormat_B8G8R8A8        = 12,
    NvScrncaptColorFormat_R8G8B8A8        = 13,
    NvScrncaptColorFormat_B6x2G6x2R6x2A8  = 14,
    NvScrncaptColorFormat_R6x2G6x2B6x2A8  = 15,
    NvScrncaptColorFormat_YCbCr422        = 16,
    NvScrncaptColorFormat_YUV422          = 17,
    NvScrncaptColorFormat_YCbCr420P       = 18,
    NvScrncaptColorFormat_YUV420P         = 19,
    NvScrncaptColorFormat_YCbCr422P       = 20,
    NvScrncaptColorFormat_YUV422P         = 21,
    NvScrncaptColorFormat_YCbCr422R       = 22,
    NvScrncaptColorFormat_YUV422R         = 23,
    NvScrncaptColorFormat_YCbCr422RA      = 24,
    NvScrncaptColorFormat_YUV422RA        = 25,
    NvScrncaptColorFormat_R4G4B4A4        = 27,
    NvScrncaptColorFormat_R5G5B5A         = 28,
    NvScrncaptColorFormat_AR5G5B5         = 29,
    NvScrncaptColorFormat_B5G5R5X         = 30,
    NvScrncaptColorFormat_XB5G5R5         = 31,
    NvScrncaptColorFormat_R5G5B5X         = 32,
    NvScrncaptColorFormat_XR5G5B5         = 33,
    NvScrncaptColorFormat_R5G6B5          = 34,
    NvScrncaptColorFormat_A8B8G8R8        = 36,
    NvScrncaptColorFormat_B8G8R8X8        = 37,
    NvScrncaptColorFormat_R8G8B8X8        = 38,
    NvScrncaptColorFormat_YCbCr444P       = 41,
    NvScrncaptColorFormat_YCrCb420SP      = 42,
    NvScrncaptColorFormat_YCbCr420SP      = 43,
    NvScrncaptColorFormat_YCrCb422SP      = 44,
    NvScrncaptColorFormat_YCbCr422SP      = 45,
    NvScrncaptColorFormat_YCrCb422SPR     = 46,
    NvScrncaptColorFormat_YCbCr422SPR     = 47,
    NvScrncaptColorFormat_YCrCb444SP      = 48,
    NvScrncaptColorFormat_YCbCr444SP      = 49,
    NvScrncaptColorFormat_YUV444P         = 52,
    NvScrncaptColorFormat_YVU420SP        = 53,
    NvScrncaptColorFormat_YUV420SP        = 54,
    NvScrncaptColorFormat_YVU422SP        = 55,
    NvScrncaptColorFormat_YUV422SP        = 56,
    NvScrncaptColorFormat_YVU422SPR       = 57,
    NvScrncaptColorFormat_YUV422SPR       = 58,
    NvScrncaptColorFormat_YVU444SP        = 59,
    NvScrncaptColorFormat_YUV444SP        = 60,
} NvScrncaptColorFormat;

typedef enum {
    NvScrncaptBlend_None,
    NvScrncaptBlend_Premult,
    NvScrncaptBlend_Coverage,
    NvScrncaptBlend_Colorkey,
} NvScrncaptBlend;

typedef struct {
    union {
        unsigned char r;
        unsigned char y;
    };
    union {
        unsigned char g;
        unsigned char u;
    };
    union {
        unsigned char b;
        unsigned char v;
    };
    unsigned char alpha;
} NvScrncaptPixel;

typedef struct {
    NvScrncaptSurfaceLayout surfaceLayout;
    NvScrncaptColorFormat pixelFormat;
    union {
        unsigned char *pRGB;
        unsigned char *pY;
    };
    union {
        unsigned int lengthRGB;
        unsigned int lengthY;
    };
    union {
        unsigned int strideRGB;
        unsigned int strideY;
    };
    unsigned char *pU;
    unsigned int lengthU;
    unsigned int strideUV;
    unsigned char *pV;
    unsigned int lengthV;
    unsigned char blockHeight;
} NvScrncaptSurfaceMap;


typedef struct {
    int startX;
    int startY;
    int width;
    int height;
} NvScrncaptAperture;

typedef struct {
    NvScrncaptBool enabled;
    unsigned int windowIdx;
    NvScrncaptSurfaceMap surfaceMap;
    NvScrncaptBlend blendMode;
    unsigned int winDepth;
    unsigned int alpha;
    NvScrncaptBool invertH;
    NvScrncaptBool invertV;
    NvScrncaptAperture fbAperture;
    NvScrncaptAperture outputAperture;
} NvScrncaptWindowState;

typedef struct {
    unsigned int headIdx;
    NvScrncaptBool enabled;
    unsigned int resolutionH;
    unsigned int resolutionV;
    int numWins;
    NvScrncaptWindowState wins[NVSCRNCAPT_MAX_WINS];
} NvScrncaptHeadState;

typedef struct {
    unsigned int memSize;
    unsigned int captureTimeUsec;
} NvScrncaptStatistics;

typedef struct {
    int numHeads;
    NvScrncaptHeadState heads[NVSCRNCAPT_MAX_HEADS];
    unsigned char *userAddress;
    unsigned int userDataSize;
    NvScrncaptStatistics stats;
    void *reserved;
} NvScrncaptResult;

NvScrncaptStatus NvScrncaptInit(NvScrncaptResult **pResult);

NvScrncaptStatus NvScrncaptCapture(NvScrncaptResult *result, unsigned int headMask);

NvScrncaptStatus NvScrncaptCleanup(NvScrncaptResult *result);

unsigned int NvScrncaptGetBlocklinearOffset(unsigned int x,
        unsigned int y, unsigned int stride, unsigned int blockHeight);

#ifdef __cplusplus
};      /* extern "C" */
#endif

#endif  /* _NVSCRNCAPT_H */