NvDrmRenderer.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2016-2026 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_DRM_RENDERER_H__
#define __NV_DRM_RENDERER_H__
 
#include "NvElement.h"
#include <stdint.h>
#include <pthread.h>
#include <queue>
#include <unordered_map>
 
typedef struct _NvDrmBO {
    uint32_t bo_handle;  
    int width;           
    int height;          
    int pitch;           
    uint8_t* data;       
} NvDrmBO;
 
typedef struct _NvDrmFB {
    uint32_t fb_id;  
    int width;       
    int height;      
    int format;      
    NvDrmBO bo[4];   
    int num_buffers; 
} NvDrmFB;
 
 
class NvDrmRenderer:public NvElement
{
public:
    static NvDrmRenderer *createDrmRenderer(int adrm_fd, const char *name, uint32_t width,
                                          uint32_t height, uint32_t w_x, uint32_t w_y,
                                          uint32_t connector, uint32_t crtc);
     ~NvDrmRenderer();
 
    int enqueBuffer(int fd);
 
    int dequeBuffer();
 
    int setFPS(float fps);
 
    bool enableUniversalPlanes(int enable);
 
    uint32_t createDumbFB(uint32_t width, uint32_t height, uint32_t drm_format, NvDrmFB *fb);
 
    int removeFB(uint32_t fb_id);
 
 
    int drmUtilCloseGemBo(int fd, uint32_t bo_handle);
 
    int setPlane(uint32_t pl_index,
                 uint32_t fb_id,
                 uint32_t crtc_x,
                 uint32_t crtc_y,
                 uint32_t crtc_w,
                 uint32_t crtc_h,
                 uint32_t src_x,
                 uint32_t src_y,
                 uint32_t src_w,
                 uint32_t src_h);
 
    int getPlaneCount();
 
    int getPlaneIndex(uint32_t crtc_index,
                      int32_t* plane_index);
 
    int getCrtcCount();
 
    int getEncoderCount();
 
private:
 
    struct timespec last_render_time;   
    int drm_fd;              
    int conn, crtc;
    uint32_t width, height;
    uint32_t offset_x, offset_y;
    uint32_t drm_conn_id;    
    uint32_t drm_enc_id;     
    uint32_t drm_crtc_id;    
    uint32_t last_fb;
    int activeFd;
    int flippedFd;
    bool flipPending;
    bool renderingStarted;
    bool is_nvidia_drm;
    uint32_t plane_idx;
 
    uint32_t hdrBlobId;
    bool hdrBlobCreated;
 
    std::queue<int> freeBuffers;
    std::queue<int> pendingBuffers;
    std::unordered_map <int, int> map_list;
 
    bool stop_thread;   
    pthread_t render_thread;         
    pthread_mutex_t render_lock;     
    pthread_cond_t render_cond;      
    pthread_mutex_t enqueue_lock;    
    pthread_cond_t enqueue_cond;     
    pthread_mutex_t dequeue_lock;    
    pthread_cond_t dequeue_cond;     
    float fps;                      
    uint64_t render_time_sec;       
    uint64_t render_time_nsec;      
    NvDrmRenderer(int adrm_fd, const char *name, uint32_t width, uint32_t height,
                  uint32_t w_x, uint32_t w_y, uint32_t connector, uint32_t crtc);
 
    static void * renderThread(void *arg);
    static void * renderThreadOrin(void *arg);
 
    static void page_flip_handler(int fd, unsigned int frame,
                                  unsigned int sec, unsigned int usec, void *data);
 
    int renderInternal(int fd);
 
    /*
     *  Returns a DRM buffer_object handle.
     *
     * \param[in] w     Width of the window in pixels.
     * \param[in] h     Height of the window in pixels.
     * \param[in] bpp   Bits per pixel in the window.
     * \param[in] bo    A pointer to a buffer object handle.
     * \return  An allocated DRM buffer_object handle of size (w,h)
     */
    int createDumbBO(int w, int h, int bpp, NvDrmBO *bo);
 
    static const NvElementProfiler::ProfilerField valid_fields =
            NvElementProfiler::PROFILER_FIELD_TOTAL_UNITS |
            NvElementProfiler::PROFILER_FIELD_FPS |
            NvElementProfiler::PROFILER_FIELD_LATE_UNITS;
};
 
#endif