nvosd.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2017, NVIDIA CORPORATION.  All rights reserved.
 *
 *  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. The names of its contributors may not 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
 *  OWNER 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 __NVOSD_DEFS__
#define __NVOSD_DEFS__

#ifdef __cplusplus
extern "C"
{
#endif

#define NVOSD_MAX_NUM_RECTS 128
#define MAX_BG_CLR 8

typedef struct _NvOSD_ColorParams {
    double red;                 
    double green;               
    double blue;                
    double alpha;               
}NvOSD_ColorParams;


typedef struct _NvOSD_FontParams {
    char * font_name;            
    unsigned int font_size;         
    NvOSD_ColorParams font_color;   
}NvOSD_FontParams;


typedef struct _NvOSD_TextParams {
    char * display_text; 
    unsigned int x_offset; 
    unsigned int y_offset; 
    NvOSD_FontParams font_params; 
    int set_bg_clr; 
    NvOSD_ColorParams text_bg_clr; 
}NvOSD_TextParams;


typedef struct _NvOSD_Class_info {
    int id;
    NvOSD_ColorParams class_clr;
}NvOSD_Class_info;


typedef struct _NvOSD_RectParams {
    unsigned int left;   
    unsigned int top;    
    unsigned int width;  
    unsigned int height; 
    unsigned int border_width; 
    NvOSD_ColorParams border_color; 
    unsigned int has_bg_color;  
    unsigned int reserved; 
    NvOSD_ColorParams bg_color; 
    int has_class_info;
    int class_id;

}NvOSD_RectParams;


typedef struct _NvOSD_ArrowParams {
    unsigned int x1;   
    unsigned int y1;    
    unsigned int x2;  
    unsigned int y2; 
    unsigned int arrow_width; 
    unsigned int start_arrow_head; 
    NvOSD_ColorParams arrow_color; 
    unsigned int reserved; 
}NvOSD_ArrowParams;


typedef struct _NvOSD_CircleParams {
    unsigned int xc;   
    unsigned int yc;    
    unsigned int radius;    
    NvOSD_ColorParams circle_color; 
    unsigned int reserved; 
}NvOSD_CircleParams;

typedef enum{
    MODE_CPU, 
    MODE_GPU, 
    MODE_HW   
} NvOSD_Mode;

void *nvosd_create_context(void);

void nvosd_destroy_context(void *nvosd_ctx);

void nvosd_set_clock_params(void *nvosd_ctx, NvOSD_TextParams *clk_params);


int nvosd_put_text(void *nvosd_ctx, NvOSD_Mode mode, int fd, int num_strings,
        NvOSD_TextParams *text_params_list);


int nvosd_draw_rectangles(void *nvosd_ctx, NvOSD_Mode mode, int fd,
        int num_rects, NvOSD_RectParams *rect_params_list);

int nvosd_init_class_clrs(void *nvosd_ctx, NvOSD_Class_info * class_info,
        int num_classes);


int nvosd_draw_arrows(void *nvosd_ctx, NvOSD_Mode mode, int fd,
        int num_arrows, NvOSD_ArrowParams *arrow_params_list);

int nvosd_draw_circles(void *nvosd_ctx, NvOSD_Mode mode, int fd,
        int num_circles, NvOSD_CircleParams *circle_params_list);

#ifdef __cplusplus
}
#endif

#endif