NvBuffer.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2016-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __NV_BUFFER_H__
#define __NV_BUFFER_H__
 
#include <linux/videodev2.h>
#include <pthread.h>
#include <stdint.h>
 
#include "v4l2_nv_extensions.h"
#include "nvbufsurface.h"
 
#define MAX_PLANES 3
 
class NvBuffer
{
public:
    typedef struct
    {
        uint32_t width;             
        uint32_t height;            
        uint32_t bytesperpixel;     
        uint32_t stride;            
        uint32_t sizeimage;         
    } NvBufferPlaneFormat;
 
    typedef struct
    {
        NvBufferPlaneFormat fmt;    
        unsigned char *data;        
        uint32_t bytesused;         
        int fd;                     
        uint32_t mem_offset;        
        uint32_t length;            
    } NvBufferPlane;
 
    NvBuffer(enum v4l2_buf_type buf_type, enum v4l2_memory memory_type,
           uint32_t n_planes, NvBufferPlaneFormat *fmt, uint32_t index);
 
    NvBuffer(uint32_t pixfmt, uint32_t width, uint32_t height, uint32_t index);
 
    NvBuffer(uint32_t size, uint32_t index);
 
    ~NvBuffer();
 
    int map();
    void unmap();
 
    int allocateMemory();
    void deallocateMemory();
 
    int ref();
    int unref();
 
    const enum v4l2_buf_type buf_type;  
    const enum v4l2_memory memory_type; 
    const uint32_t index;               
    uint32_t n_planes;            
    NvBufferPlane planes[MAX_PLANES];     
    static int fill_buffer_plane_format(uint32_t *num_planes,
            NvBuffer::NvBufferPlaneFormat *planefmts,
            uint32_t width, uint32_t height, uint32_t raw_pixfmt);
private:
    uint32_t ref_count;             
    pthread_mutex_t ref_lock;       
    bool mapped;                    
    bool allocated;                 
    NvBuffer *shared_buffer; 
    NvBuffer(const NvBuffer& that);
    void operator=(NvBuffer const&);
 
    friend class NvV4l2ElementPlane;
};
#endif