nvmedia_image_pyramid.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018, NVIDIA CORPORATION.  All rights reserved.  All
 * information contained herein is proprietary and confidential to NVIDIA
 * Corporation.  Any use, reproduction, or disclosure without the written
 * permission of NVIDIA Corporation is prohibited.
 */

#ifndef _NVMEDIA_IMAGE_PYRAMID_H
#define _NVMEDIA_IMAGE_PYRAMID_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_image.h"

#define NVMEDIA_IMAGE_PYRAMID_VERSION_MAJOR   1

#define NVMEDIA_IMAGE_PYRAMID_VERSION_MINOR   0

#define MAX_PYRAMID_LEVELS (10)

typedef struct NvMediaImagePyramid NvMediaImagePyramid;

NvMediaImagePyramid *
NvMediaImagePyramidCreate(
    NvMediaDevice *device,
    NvMediaSurfaceType type,
    NvMediaSurfAllocAttr *attrs,
    uint32_t numLevels,
    float scale,
    uint32_t numAttrs,
    uint32_t flags
);

void
NvMediaImagePyramidDestroy(
    NvMediaImagePyramid *pyramid
);

NvMediaStatus
NvMediaImagePyramidLock(
    NvMediaImagePyramid *pyramid,
    uint32_t lockAccessType,
    NvMediaImageSurfaceMap *surfaceMap
);

void
NvMediaImagePyramidUnlock(
    NvMediaImagePyramid *pyramid
);

NvMediaStatus
NvMediaImagePyramidGetStatus(
    NvMediaImagePyramid *pyramid,
    uint32_t millisecondWait,
    NvMediaTaskStatus *status
);

NvMediaImage *
NvMediaImagePyramidGetImageForLevel(
    NvMediaImagePyramid * pyramid,
    uint32_t level
);

uint32_t
NvMediaImagePyramidGetNumLevels(
    NvMediaImagePyramid * pyramid
);

float
NvMediaImagePyramidGetScale(
    NvMediaImagePyramid * pyramid
);

/*
 * \defgroup history_nvmedia_image_pyramid History
 * Provides change history for the NvMedia ImagePyramid API.
 *
 * \section history_nvmedia_image_pyramid Version History
 *
 * <b> Version 1.0 </b> December 4, 2017
 * - Initial Release.
 *
 */

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

#endif /* _NVMEDIA_IMAGE_PYRAMID_H */