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_line_width,
  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 conversion tables */
  45     union
  46     {
  47         u8 *            p_gray8;                        /* gray 8 bits table */
  48         u16 *           p_gray16;                      /* gray 16 bits table */
  49         u32 *           p_gray32;                      /* gray 32 bits table */
  50         u8 *            p_rgb8;                          /* RGB 8 bits table */
  51         u16 *           p_rgb16;                        /* RGB 16 bits table */
  52         u32 *           p_rgb32;                        /* RGB 32 bits table */
  53     } yuv;
  54
  55     /* Temporary convertion buffer and offset array */
  56     void *              p_buffer;                       /* convertion buffer */
  57     int *               p_offset;                            /* offset array */
  58 } vout_yuv_t;
  59
  60 /*****************************************************************************
  61  * vout_buffer_t: rendering buffer
  62  *****************************************************************************
  63  * This structure store informations about a buffer. Buffers are not completely
  64  * cleared between displays, and modified areas need to be stored.
  65  *****************************************************************************/
  66 typedef struct vout_buffer_s
  67 {
  68     /* Picture area */
  69     int         i_pic_x, i_pic_y;                       /* picture position  */
  70     int         i_pic_width, i_pic_height;              /* picture extension */
  71
  72     /* Other areas - only vertical extensions of areas are stored */
  73     int         i_areas;                                  /* number of areas */
  74     int         pi_area_begin[VOUT_MAX_AREAS];          /* beginning of area */
  75     int         pi_area_end[VOUT_MAX_AREAS];                  /* end of area */
  76
  77     /* Picture data */
  78     byte_t *    p_data;                                    /* memory address */
  79 } vout_buffer_t;
  80
  81 /*****************************************************************************
  82  * vout_thread_t: video output thread descriptor
  83  *****************************************************************************
  84  * Any independant video output device, such as an X11 window or a GGI device,
  85  * is represented by a video output thread, and described using the following
  86  * structure.
  87  *****************************************************************************/
  88 typedef int  (vout_sys_create_t)    ( p_vout_thread_t p_vout,
  89                                       char *psz_display, int i_root_window );
  90 typedef int  (vout_sys_init_t)      ( p_vout_thread_t p_vout );
  91 typedef void (vout_sys_end_t)       ( p_vout_thread_t p_vout );
  92 typedef void (vout_sys_destroy_t)   ( p_vout_thread_t p_vout );
  93 typedef int  (vout_sys_manage_t)    ( p_vout_thread_t p_vout );
  94 typedef void (vout_sys_display_t)   ( p_vout_thread_t p_vout );
  95 typedef void (vout_set_palette_t)   ( p_vout_thread_t p_vout, u16 *red,
  96                                       u16 *green, u16 *blue, u16 *transp );
  97
  98 typedef struct vout_thread_s
  99 {
 100     /* Thread properties and lock */
 101     boolean_t           b_die;                                 /* `die' flag */
 102     boolean_t           b_error;                             /* `error' flag */
 103     boolean_t           b_active;                           /* `active' flag */
 104     vlc_thread_t        thread_id;               /* id for pthread functions */
 105     vlc_mutex_t         picture_lock;                   /* picture heap lock */
 106     vlc_mutex_t         subpicture_lock;             /* subpicture heap lock */
 107     vlc_mutex_t         change_lock;                   /* thread change lock */
 108     int *               pi_status;                  /* temporary status flag */
 109     p_vout_sys_t        p_sys;                       /* system output method */
 110
 111     /* Current display properties */
 112     u16                 i_changes;             /* changes made to the thread */
 113     int                 i_width;              /* current output method width */
 114     int                 i_height;            /* current output method height */
 115     int                 i_bytes_per_line;  /* bytes per line (incl. virtual) */
 116     int                 i_screen_depth;  /* significant bpp: 8, 15, 16 or 24 */
 117     int                 i_bytes_per_pixel;/* real screen depth: 1, 2, 3 or 4 */
 118     float               f_gamma;                                    /* gamma */
 119
 120     /* Color masks and shifts in RGB mode - masks are set by system
 121      * initialization, shifts are calculated. A pixel color value can be
 122      * obtained using the formula ((value >> rshift) << lshift) */
 123     u32                 i_red_mask;                              /* red mask */
 124     u32                 i_green_mask;                          /* green mask */
 125     u32                 i_blue_mask;                            /* blue mask */
 126     int                 i_red_lshift, i_red_rshift;            /* red shifts */
 127     int                 i_green_lshift, i_green_rshift;      /* green shifts */
 128     int                 i_blue_lshift, i_blue_rshift;         /* blue shifts */
 129
 130     /* Useful pre-calculated pixel values - these are not supposed to be
 131      * accurate values, but rather values looking nice, given their usage. */
 132     u32                 i_white_pixel;                              /* white */
 133     u32                 i_black_pixel;                              /* black */
 134     u32                 i_gray_pixel;                                /* gray */
 135     u32                 i_blue_pixel;                                /* blue */
 136
 137     /* Plugins */
 138     void *                  p_vout_plugin;            /* video output plugin */
 139     vout_sys_create_t *     p_sys_create;          /* allocate output method */
 140     vout_sys_init_t *       p_sys_init;          /* initialize output method */
 141     vout_sys_end_t *        p_sys_end;            /* terminate output method */
 142     vout_sys_destroy_t *    p_sys_destroy;          /* destroy output method */
 143     vout_sys_manage_t *     p_sys_manage;                   /* handle events */
 144     vout_sys_display_t *    p_sys_display;         /* display rendered image */
 145     vout_set_palette_t *    p_set_palette;              /* sets 8bpp palette */
 146
 147     /* Pictures and rendering properties */
 148     boolean_t           b_grayscale;           /* color or grayscale display */
 149     boolean_t           b_info;            /* print additionnal informations */
 150     boolean_t           b_interface;                     /* render interface */
 151     boolean_t           b_scale;                    /* allow picture scaling */
 152
 153     /* Idle screens management */
 154     mtime_t             last_display_date;     /* last non idle display date */
 155     mtime_t             last_idle_date;            /* last idle display date */
 156
 157 #ifdef STATS
 158     /* Statistics - these numbers are not supposed to be accurate, but are a
 159      * good indication of the thread status */
 160     mtime_t             render_time;             /* last picture render time */
 161     count_t             c_fps_samples;                     /* picture counts */
 162     mtime_t             p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
 163 #endif
 164
 165     /* Rendering buffers */
 166     int                 i_buffer_index;                      /* buffer index */
 167     vout_buffer_t       p_buffer[2];                   /* buffers properties */
 168
 169     /* Videos heap and translation tables */
 170     picture_t           p_picture[VOUT_MAX_PICTURES];            /* pictures */
 171     subpicture_t        p_subpicture[VOUT_MAX_PICTURES];      /* subpictures */
 172     int                 i_pictures;                     /* current heap size */
 173     vout_yuv_t          yuv;                           /* translation tables */
 174
 175     /* Bitmap fonts */
 176     p_vout_font_t       p_default_font;                      /* default font */
 177     p_vout_font_t       p_large_font;                          /* large font */
 178
 179     /* Synchronisation informations - synchro level is updated by the vout
 180      * thread and read by decoder threads */
 181     int                 i_synchro_level;                   /* trashing level */
 182 } vout_thread_t;
 183
 184 /* Flags for changes - these flags are set in the i_changes field when another
 185  * thread changed a variable */
 186 #define VOUT_INFO_CHANGE        0x0001                     /* b_info changed */
 187 #define VOUT_GRAYSCALE_CHANGE   0x0002                /* b_grayscale changed */
 188 #define VOUT_INTF_CHANGE        0x0004                /* b_interface changed */
 189 #define VOUT_SCALE_CHANGE       0x0008                    /* b_scale changed */
 190 #define VOUT_SIZE_CHANGE        0x0200                       /* size changed */
 191 #define VOUT_DEPTH_CHANGE       0x0400                      /* depth changed */
 192 #define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
 193 #define VOUT_YUV_CHANGE         0x0800                  /* change yuv tables */
 194 #define VOUT_NODISPLAY_CHANGE   0xff00    /* changes which forbidden display */
 195
 196 /*****************************************************************************
 197  * Macros
 198  *****************************************************************************/
 199
 200 /* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
 201 #define RGB2PIXEL( p_vout, i_red, i_green, i_blue )                           \
 202     (((((u32)i_red)   >> p_vout->i_red_rshift)   << p_vout->i_red_lshift)   | \
 203      ((((u32)i_green) >> p_vout->i_green_rshift) << p_vout->i_green_lshift) | \
 204      ((((u32)i_blue)  >> p_vout->i_blue_rshift)  << p_vout->i_blue_lshift))
 205
 206
 207 /*****************************************************************************
 208  * Prototypes
 209  *****************************************************************************/
 210 vout_thread_t * vout_CreateThread       ( char *psz_display, int i_root_window,
 211                                           int i_width, int i_height, int *pi_status, int i_method );
 212 void            vout_DestroyThread      ( vout_thread_t *p_vout, int *pi_status );
 213 picture_t *     vout_CreatePicture      ( vout_thread_t *p_vout, int i_type,
 214                                           int i_width, int i_height );
 215 void            vout_DestroyPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
 216 void            vout_DisplayPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
 217 void            vout_DatePicture        ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
 218 void            vout_LinkPicture        ( vout_thread_t *p_vout, picture_t *p_pic );
 219 void            vout_UnlinkPicture      ( vout_thread_t *p_vout, picture_t *p_pic );
 220 subpicture_t *  vout_CreateSubPicture   ( vout_thread_t *p_vout, int i_type, int i_size );
 221 void            vout_DestroySubPicture  ( vout_thread_t *p_vout, subpicture_t *p_subpic );
 222 void            vout_DisplaySubPicture  ( vout_thread_t *p_vout, subpicture_t *p_subpic );
 223
 224 void            vout_SetBuffers         ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 );
 225