git.sesse.net Git - vlc/blob - include/video_output.h

   1 /*******************************************************************************
   2  * video_output.h : video output thread
   3  * (c)1999 VideoLAN
   4  *******************************************************************************
   5  * This module describes the programming interface for video output threads.
   6  * It includes functions allowing to open a new thread, send pictures to a
   7  * thread, and destroy a previously oppenned video output thread.
   8  *******************************************************************************/
   9
  10 /*******************************************************************************
  11  * vout_yuv_convert_t: YUV convertion function
  12  *******************************************************************************
  13  * This is the prototype common to all convertion functions. The type of p_pic
  14  * will change depending of the screen depth treated.
  15  * Parameters:
  16  *      p_vout                          video output thread
  17  *      p_pic                           picture address
  18  *      p_y, p_u, p_v                   Y,U,V samples addresses
  19  *      i_width, i_height               Y samples extension
  20  *      i_pic_width, i_pic_height       picture extension
  21  *      i_pic_line_width                picture total line width
  22  *      i_matrix_coefficients           matrix coefficients
  23  * Picture width and source dimensions must be multiples of 16.
  24  *******************************************************************************/
  25 typedef void (vout_yuv_convert_t)( p_vout_thread_t p_vout, void *p_pic,
  26                                    yuv_data_t *p_y, yuv_data_t *p_u, yuv_data_t *p_v,
  27                                    int i_width, int i_height,
  28                                    int i_pic_width, int i_pic_height, int i_pic_skip,
  29                                    int i_matrix_coefficients );
  30
  31 /*******************************************************************************
  32  * vout_yuv_t: pre-calculated YUV convertion tables
  33  *******************************************************************************
  34  * These tables are used by convertion and scaling functions.
  35  *******************************************************************************/
  36 typedef struct vout_yuv_s
  37 {
  38     /* Convertion functions */
  39     vout_yuv_convert_t *        p_Convert420;           /* YUV 4:2:0 converter */
  40     vout_yuv_convert_t *        p_Convert422;           /* YUV 4:2:2 converter */
  41     vout_yuv_convert_t *        p_Convert444;           /* YUV 4:4:4 converter */
  42
  43     /* Pre-calculated convertion tables */
  44     void *              p_base;              /* base for all convertion tables */
  45     union
  46     {
  47         u16 *           p_gray16;                        /* gray 16 bits table */
  48         u32 *           p_gray32;                        /* gray 32 bits table */
  49         u16 *           p_rgb16;                          /* RGB 16 bits table */
  50         u32 *           p_rgb32;                          /* RGB 32 bits table */
  51     } yuv;
  52
  53     /* Temporary convertion buffer and offset array */
  54     void *              p_buffer;                         /* convertion buffer */
  55     int *               p_offset;                              /* offset array */
  56 } vout_yuv_t;
  57
  58 /*******************************************************************************
  59  * vout_buffer_t: rendering buffer
  60  *******************************************************************************
  61  * This structure store informations about a buffer. Buffers are not completely
  62  * cleared between displays, and modified areas needs to be stored.
  63  *******************************************************************************/
  64 typedef struct vout_buffer_s
  65 {
  66     /* Picture area */
  67     int         i_pic_x, i_pic_y;                         /* picture position  */
  68     int         i_pic_width, i_pic_height;                /* picture extension */
  69
  70     /* Other areas - only vertical extensions of areas are stored */
  71     int         i_areas;                                    /* number of areas */
  72     int         pi_area_begin[VOUT_MAX_AREAS];            /* beginning of area */
  73     int         pi_area_end[VOUT_MAX_AREAS];                    /* end of area */
  74
  75     /* Picture data */
  76     byte_t *    p_data;                                      /* memory address */
  77 } vout_buffer_t;
  78
  79 /*******************************************************************************
  80  * vout_thread_t: video output thread descriptor
  81  *******************************************************************************
  82  * Any independant video output device, such as an X11 window or a GGI device,
  83  * is represented by a video output thread, and described using following
  84  * structure.
  85  *******************************************************************************/
  86 typedef struct vout_thread_s
  87 {
  88     /* Thread properties and lock */
  89     boolean_t           b_die;                                   /* `die' flag */
  90     boolean_t           b_error;                               /* `error' flag */
  91     boolean_t           b_active;                             /* `active' flag */
  92     vlc_thread_t        thread_id;                 /* id for pthread functions */
  93     vlc_mutex_t         picture_lock;                     /* picture heap lock */
  94     vlc_mutex_t         subpicture_lock;               /* subpicture heap lock */
  95     vlc_mutex_t         change_lock;                     /* thread change lock */
  96     int *               pi_status;                    /* temporary status flag */
  97     p_vout_sys_t        p_sys;                         /* system output method */
  98
  99     /* Current display properties */
 100     u16                 i_changes;               /* changes made to the thread */
 101     int                 i_width;                /* current output method width */
 102     int                 i_height;              /* current output method height */
 103     int                 i_bytes_per_line;/* bytes per line (including virtual) */
 104     int                 i_screen_depth;                      /* bits per pixel */
 105     int                 i_bytes_per_pixel;                /* real screen depth */
 106     float               f_gamma;                                      /* gamma */
 107
 108     /* Pictures and rendering properties */
 109     boolean_t           b_grayscale;             /* color or grayscale display */
 110     boolean_t           b_info;              /* print additionnal informations */
 111     boolean_t           b_interface;                       /* render interface */
 112     boolean_t           b_scale;                      /* allow picture scaling */
 113
 114     /* Idle screens management */
 115     mtime_t             last_display_date;       /* last non idle display date */
 116     mtime_t             last_idle_date;              /* last idle display date */
 117
 118 #ifdef STATS
 119     /* Statistics - these numbers are not supposed to be accurate, but are a
 120      * good indication of the thread status */
 121     mtime_t             render_time;               /* last picture render time */
 122     count_t             c_fps_samples;                       /* picture counts */
 123     mtime_t             p_fps_sample[ VOUT_FPS_SAMPLES ]; /* FPS samples dates */
 124 #endif
 125
 126     /* Rendering buffers */
 127     int                 i_buffer_index;                        /* buffer index */
 128     vout_buffer_t       p_buffer[2];                     /* buffers properties */
 129
 130     /* Videos heap and translation tables */
 131     picture_t           p_picture[VOUT_MAX_PICTURES];              /* pictures */
 132     subpicture_t        p_subpicture[VOUT_MAX_PICTURES];        /* subpictures */
 133     vout_yuv_t          yuv;                             /* translation tables */
 134
 135     /* Bitmap fonts */
 136     p_vout_font_t       p_default_font;                        /* default font */
 137     p_vout_font_t       p_large_font;                            /* large font */
 138 } vout_thread_t;
 139
 140 /* Flags for changes - these flags are set in the i_changes field when another
 141  * thread changed a variable */
 142 #define VOUT_INFO_CHANGE        0x0001                       /* b_info changed */
 143 #define VOUT_GRAYSCALE_CHANGE   0x0002                  /* b_grayscale changed */
 144 #define VOUT_INTF_CHANGE        0x0004                  /* b_interface changed */
 145 #define VOUT_SCALE_CHANGE       0x0008                      /* b_scale changed */
 146 #define VOUT_SIZE_CHANGE        0x0200                         /* size changed */
 147 #define VOUT_DEPTH_CHANGE       0x0400                        /* depth changed */
 148 #define VOUT_GAMMA_CHANGE       0x0010                        /* gamma changed */
 149 #define VOUT_YUV_CHANGE         0x0800                    /* change yuv tables */
 150 #define VOUT_NODISPLAY_CHANGE   0xff00      /* changes which forbidden display */
 151
 152 /*******************************************************************************
 153  * Prototypes
 154  *******************************************************************************/
 155 vout_thread_t * vout_CreateThread       ( char *psz_display, int i_root_window,
 156                                           int i_width, int i_height, int *pi_status );
 157 void            vout_DestroyThread      ( vout_thread_t *p_vout, int *pi_status );
 158 picture_t *     vout_CreatePicture      ( vout_thread_t *p_vout, int i_type,
 159                                           int i_width, int i_height );
 160 void            vout_DestroyPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
 161 void            vout_DisplayPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
 162 void            vout_DatePicture        ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
 163 void            vout_LinkPicture        ( vout_thread_t *p_vout, picture_t *p_pic );
 164 void            vout_UnlinkPicture      ( vout_thread_t *p_vout, picture_t *p_pic );
 165 subpicture_t *  vout_CreateSubPicture   ( vout_thread_t *p_vout, int i_type, int i_size );
 166 void            vout_DestroySubPicture  ( vout_thread_t *p_vout, subpicture_t *p_subpic );
 167 void            vout_DisplaySubPicture  ( vout_thread_t *p_vout, subpicture_t *p_subpic );
 168
 169 void            vout_SetBuffers         ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 );