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_tables_t: pre-calculated convertion tables
  12  *******************************************************************************
  13  * These tables are used by convertion and scaling functions.
  14  *******************************************************************************/
  15 typedef struct vout_tables_s
  16 {
  17     void *              p_base;             /* base for all translation tables */
  18     union
  19     {
  20         struct { u16 *p_red, *p_green, *p_blue; } rgb16;   /* color 15, 16 bpp */
  21         struct { u32 *p_red, *p_green, *p_blue; } rgb32;   /* color 24, 32 bpp */
  22         struct { u16 *p_gray; }                   gray16;   /* gray 15, 16 bpp */
  23         struct { u32 *p_gray; }                   gray32;   /* gray 24, 32 bpp */
  24     } yuv;
  25 } vout_tables_t;
  26
  27 /*******************************************************************************
  28  * vout_convert_t: convertion function
  29  *******************************************************************************
  30  * This is the prototype common to all convertion functions. The type of p_pic
  31  * will change depending of the screen depth treated.
  32  * Parameters:
  33  *      p_vout                  video output thread
  34  *      p_pic                   picture address (start address in picture)
  35  *      p_y, p_u, p_v           Y,U,V samples addresses
  36  *      i_width                 Y samples width
  37  *      i_height                Y samples height
  38  *      i_eol                   number of Y samples to reach the next line
  39  *      i_pic_eol               number or pixels to reach the next line
  40  *      i_scale                 if non 0, vertical scaling is 1 - 1/i_scale
  41  *      i_matrix_coefficients   matrix coefficients
  42  * Conditions:
  43  *      start x + i_width                        <  picture width
  44  *      start y + i_height * (scaling factor)    <  picture height
  45  *      i_width % 16                             == 0
  46  *******************************************************************************/
  47 typedef void (vout_convert_t)( p_vout_thread_t p_vout, void *p_pic,
  48                                yuv_data_t *p_y, yuv_data_t *p_u, yuv_data_t *p_v,
  49                                int i_width, int i_height, int i_eol, int i_pic_eol,
  50                                int i_scale, int i_matrix_coefficients );
  51
  52 /*******************************************************************************
  53  * vout_scale_t: scaling function
  54  *******************************************************************************
  55  * When a picture can't be scaled unsing the fast i_y_scale parameter of a
  56  * transformation, it is rendered in a temporary buffer then scaled using a
  57  * totally accurate (but also very slow) method.
  58  * This is the prototype common to all scaling functions. The types of p_buffer
  59  * and p_pic will change depending of the screen depth treated.
  60  * Parameters:
  61  *      p_vout                  video output thread
  62  *      p_pic                   picture address (start address in picture)
  63  *      p_buffer                source picture
  64  *      i_width                 buffer width
  65  *      i_height                buffer height
  66  *      i_eol                   number of pixels to reach next buffer line
  67  *      i_pic_eol               number of pixels to reach next picture line
  68  *      f_alpha, f_beta         horizontal and vertical scaling factors
  69  *******************************************************************************/
  70 typedef void (vout_scale_t)( p_vout_thread_t p_vout, void *p_pic, void *p_buffer,
  71                              int i_width, int i_height, int i_eol, int i_pic_eol,
  72                              float f_alpha, float f_beta );
  73
  74 /*******************************************************************************
  75  * vout_thread_t: video output thread descriptor
  76  *******************************************************************************
  77  * Any independant video output device, such as an X11 window or a GGI device,
  78  * is represented by a video output thread, and described using following
  79  * structure.
  80  *******************************************************************************/
  81 typedef struct vout_thread_s
  82 {
  83     /* Thread properties and lock */
  84     boolean_t           b_die;                                   /* `die' flag */
  85     boolean_t           b_error;                               /* `error' flag */
  86     boolean_t           b_active;                             /* `active' flag */
  87     vlc_thread_t        thread_id;                 /* id for pthread functions */
  88     vlc_mutex_t         picture_lock;                     /* picture heap lock */
  89     vlc_mutex_t         subtitle_lock;                   /* subtitle heap lock */
  90     int *               pi_status;                    /* temporary status flag */
  91     p_vout_sys_t        p_sys;                         /* system output method */
  92
  93     /* Current display properties */
  94     boolean_t           b_info;              /* print additionnal informations */
  95     boolean_t           b_grayscale;             /* color or grayscale display */
  96     int                 i_width;                /* current output method width */
  97     int                 i_height;              /* current output method height */
  98     int                 i_bytes_per_line;/* bytes per line (including virtual) */
  99     int                 i_screen_depth;                      /* bits per pixel */
 100     int                 i_bytes_per_pixel;                /* real screen depth */
 101     float               f_x_ratio;                 /* horizontal display ratio */
 102     float               f_y_ratio;                   /* vertical display ratio */
 103     float               f_gamma;                                      /* gamma */
 104
 105 #ifdef STATS
 106     /* Statistics - these numbers are not supposed to be accurate, but are a
 107      * good indication of the thread status */
 108     mtime_t             loop_time;                   /* last picture loop time */
 109     count_t             c_fps_samples;               /* picture counts */
 110     mtime_t             fps_sample[ VOUT_FPS_SAMPLES ];   /* FPS samples dates */
 111 #endif
 112
 113     /* Running properties */
 114     u16                 i_changes;               /* changes made to the thread */
 115     mtime_t             last_picture_date;        /* last picture display date */
 116     mtime_t             last_idle_date;        /* last idle screen displaydate */
 117
 118     /* Videos heap and translation tables */
 119     picture_t           p_picture[VOUT_MAX_PICTURES];              /* pictures */
 120     subtitle_t          p_subtitle[VOUT_MAX_PICTURES];            /* subtitles */
 121     vout_tables_t       tables;                          /* translation tables */
 122     vout_convert_t *    p_ConvertYUV420;                /* YUV 4:2:0 converter */
 123     vout_convert_t *    p_ConvertYUV422;                /* YUV 4:2:2 converter */
 124     vout_convert_t *    p_ConvertYUV444;                /* YUV 4:4:4 converter */
 125     vout_scale_t *      p_Scale;                                     /* scaler */
 126 } vout_thread_t;
 127
 128 /* Flags for changes - these flags are set in the i_changes field when another
 129  * thread changed a variable */
 130 #define VOUT_INFO_CHANGE        0x0001                       /* b_info changed */
 131 #define VOUT_GRAYSCALE_CHANGE   0x0002                  /* b_grayscale changed */
 132 #define VOUT_SIZE_CHANGE        0x0004                         /* size changed */
 133 #define VOUT_DEPTH_CHANGE       0x0008                        /* depth changed */
 134 #define VOUT_RATIO_CHANGE       0x0010                /* display ratio changed */
 135 #define VOUT_GAMMA_CHANGE       0x0020                        /* gamma changed */
 136
 137 /*******************************************************************************
 138  * Prototypes
 139  *******************************************************************************/
 140 vout_thread_t * vout_CreateThread       (
 141 #ifdef VIDEO_X11
 142                                           char *psz_display, Window root_window,
 143 #endif
 144                                           int i_width, int i_height, int *pi_status
 145                                         );
 146 void            vout_DestroyThread      ( vout_thread_t *p_vout, int *pi_status );
 147 picture_t *     vout_CreatePicture      ( vout_thread_t *p_vout, int i_type,
 148                                           int i_width, int i_height );
 149 void            vout_DestroyPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
 150 void            vout_DisplayPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
 151 void            vout_LinkPicture        ( vout_thread_t *p_vout, picture_t *p_pic );
 152 void            vout_UnlinkPicture      ( vout_thread_t *p_vout, picture_t *p_pic );
 153 subtitle_t *    vout_CreateSubtitle     ( vout_thread_t *p_vout, int i_type, int i_size );
 154 void            vout_DestroySubtitle    ( vout_thread_t *p_vout, subtitle_t *p_sub );
 155 void            vout_DisplaySubtitle    ( vout_thread_t *p_vout, subtitle_t *p_sub );
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171