]> git.sesse.net Git - vlc/blobdiff - include/video_output.h
* ALL: new module API. Makes a few things a lot simpler, and we gain
[vlc] / include / video_output.h
index 0035c6aea9249d399253aac87e6ea88a51172770..7759ce890de4e7bb6c83beed42eb1180461019a6 100644 (file)
@@ -2,11 +2,13 @@
  * video_output.h : video output thread
  * This module describes the programming interface for video output threads.
  * It includes functions allowing to open a new thread, send pictures to a
- * thread, and destroy a previously oppenned video output thread.
+ * thread, and destroy a previously opened video output thread.
  *****************************************************************************
  * Copyright (C) 1999, 2000 VideoLAN
+ * $Id: video_output.h,v 1.82 2002/07/31 20:56:50 sam Exp $
  *
- * Authors:
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
+ *          Samuel Hocevar <sam@via.ecp.fr>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *****************************************************************************/
 
 /*****************************************************************************
- * vout_yuv_convert_t: YUV conversion function
+ * vout_chroma_t: Chroma conversion function
  *****************************************************************************
- * This is the prototype common to all conversion functions. The type of p_pic
- * will change depending on the processed screen depth.
+ * This is the prototype common to all conversion functions.
  * Parameters:
- *      p_vout                          video output thread
- *      p_pic                           picture address
- *      p_y, p_u, p_v                   Y,U,V samples addresses
- *      i_width, i_height               Y samples extension
- *      i_pic_width, i_pic_height       picture extension
- *      i_pic_line_width                picture total line width
- *      i_matrix_coefficients           matrix coefficients
+ *      p_source                        source picture
+ *      p_dest                          destination picture
  * Picture width and source dimensions must be multiples of 16.
  *****************************************************************************/
-typedef void (vout_yuv_convert_t)( p_vout_thread_t p_vout, void *p_pic,
-                                   yuv_data_t *p_y, yuv_data_t *p_u, yuv_data_t *p_v,
-                                   int i_width, int i_height,
-                                   int i_pic_width, int i_pic_height, int i_pic_line_width,
-                                   int i_matrix_coefficients );
+typedef void (vout_chroma_convert_t)( vout_thread_t *,
+                                      picture_t *, picture_t * );
 
-/*****************************************************************************
- * vout_yuv_t: pre-calculated YUV conversion tables
- *****************************************************************************
- * These tables are used by conversion and scaling functions.
- *****************************************************************************/
-typedef struct vout_yuv_s
+typedef struct vout_chroma_t
 {
     /* conversion functions */
-    vout_yuv_convert_t *        p_Convert420;         /* YUV 4:2:0 converter */
-    vout_yuv_convert_t *        p_Convert422;         /* YUV 4:2:2 converter */
-    vout_yuv_convert_t *        p_Convert444;         /* YUV 4:4:4 converter */
-
-    /* Pre-calculated conversion tables */
-    void *              p_base;            /* base for all conversion tables */
-    union
-    {
-        u8 *            p_gray8;                        /* gray 8 bits table */
-        u16 *           p_gray16;                      /* gray 16 bits table */
-        u32 *           p_gray32;                      /* gray 32 bits table */
-        u8 *            p_rgb8;                          /* RGB 8 bits table */
-        u16 *           p_rgb16;                        /* RGB 16 bits table */
-        u32 *           p_rgb32;                        /* RGB 32 bits table */
-    } yuv;
-
-    /* Temporary conversion buffer and offset array */
-    void *              p_buffer;                       /* conversion buffer */
-    int *               p_offset;                            /* offset array */
-} vout_yuv_t;
+    vout_chroma_convert_t *pf_convert;
+
+    /* Private module-dependant data */
+    chroma_sys_t *      p_sys;                               /* private data */
+
+    /* Plugin used and shortcuts to access its capabilities */
+    module_t * p_module;
+
+} vout_chroma_t;
 
 /*****************************************************************************
- * vout_buffer_t: rendering buffer
- *****************************************************************************
- * This structure stores information about a buffer. Buffers are not completely
- * cleared between displays, and modified areas need to be stored.
+ * vout_fifo_t
  *****************************************************************************/
-typedef struct vout_buffer_s
+typedef struct vout_fifo_t
 {
-    /* Picture area */
-    int         i_pic_x, i_pic_y;                       /* picture position  */
-    int         i_pic_width, i_pic_height;                   /* picture size */
+    /* See the fifo types below */
+    int                 i_type;
+    vlc_bool_t          b_die;
+    int                 i_fifo;      /* Just to keep track of the fifo index */
+
+    vlc_mutex_t         data_lock;
+    vlc_cond_t          data_wait;
 
-    /* Other areas - only vertical extensions of areas are stored */
-    int         i_areas;                                  /* number of areas */
-    int         pi_area_begin[VOUT_MAX_AREAS];          /* beginning of area */
-    int         pi_area_end[VOUT_MAX_AREAS];                  /* end of area */
+} vout_fifo_t;
 
-    /* Picture data */
-    byte_t *    p_data;                                    /* memory address */
-} vout_buffer_t;
+#define VOUT_EMPTY_FIFO         0
+#define VOUT_YUV_FIFO           1
+#define VOUT_SPU_FIFO           2
 
 /*****************************************************************************
  * vout_thread_t: video output thread descriptor
@@ -101,111 +76,74 @@ typedef struct vout_buffer_s
  * is represented by a video output thread, and described using the following
  * structure.
  *****************************************************************************/
-typedef int  (vout_sys_create_t)    ( p_vout_thread_t p_vout,
-                                      char *psz_display,
-                                      int i_root_window, void *p_data );
-typedef int  (vout_sys_init_t)      ( p_vout_thread_t p_vout );
-typedef void (vout_sys_end_t)       ( p_vout_thread_t p_vout );
-typedef void (vout_sys_destroy_t)   ( p_vout_thread_t p_vout );
-typedef int  (vout_sys_manage_t)    ( p_vout_thread_t p_vout );
-typedef void (vout_sys_display_t)   ( p_vout_thread_t p_vout );
-
-typedef void (vout_set_palette_t)   ( p_vout_thread_t p_vout, u16 *red,
-                                      u16 *green, u16 *blue, u16 *transp );
-
-typedef int  (yuv_sys_init_t)       ( p_vout_thread_t p_vout );
-typedef int  (yuv_sys_reset_t)      ( p_vout_thread_t p_vout );
-typedef void (yuv_sys_end_t)        ( p_vout_thread_t p_vout );
-
-typedef struct vout_thread_s
+struct vout_thread_t
 {
+    VLC_COMMON_MEMBERS
+
     /* Thread properties and lock */
-    boolean_t           b_die;                                 /* `die' flag */
-    boolean_t           b_error;                             /* `error' flag */
-    boolean_t           b_active;                           /* `active' flag */
-    vlc_thread_t        thread_id;               /* id for pthread functions */
     vlc_mutex_t         picture_lock;                   /* picture heap lock */
     vlc_mutex_t         subpicture_lock;             /* subpicture heap lock */
     vlc_mutex_t         change_lock;                   /* thread change lock */
-    int *               pi_status;                  /* temporary status flag */
-    p_vout_sys_t        p_sys;                       /* system output method */
+    vout_sys_t *        p_sys;                       /* system output method */
 
     /* Current display properties */
     u16                 i_changes;             /* changes made to the thread */
-    int                 i_width;              /* current output method width */
-    int                 i_height;            /* current output method height */
-    int                 i_bytes_per_line;  /* bytes per line (incl. virtual) */
-    int                 i_screen_depth;  /* significant bpp: 8, 15, 16 or 24 */
-    int                 i_bytes_per_pixel;/* real screen depth: 1, 2, 3 or 4 */
     float               f_gamma;                                    /* gamma */
+    vlc_bool_t          b_grayscale;           /* color or grayscale display */
+    vlc_bool_t          b_info;              /* print additional information */
+    vlc_bool_t          b_interface;                     /* render interface */
+    vlc_bool_t          b_scale;                    /* allow picture scaling */
+    vlc_bool_t          b_fullscreen;           /* toogle fullscreen display */
+    mtime_t             render_time;             /* last picture render time */
+    int                 i_window_width;                /* video window width */
+    int                 i_window_height;              /* video window height */
+
+    /* Plugin used and shortcuts to access its capabilities */
+    module_t *   p_module;
+    int       ( *pf_init )       ( vout_thread_t * );
+    void      ( *pf_end )        ( vout_thread_t * );
+    int       ( *pf_manage )     ( vout_thread_t * );
+    void      ( *pf_render )     ( vout_thread_t *, picture_t * );
+    void      ( *pf_display )    ( vout_thread_t *, picture_t * );
 
-    /* Color masks and shifts in RGB mode - masks are set by system
-     * initialization, shifts are calculated. A pixel color value can be
-     * obtained using the formula ((value >> rshift) << lshift) */
-    u32                 i_red_mask;                              /* red mask */
-    u32                 i_green_mask;                          /* green mask */
-    u32                 i_blue_mask;                            /* blue mask */
-    int                 i_red_lshift, i_red_rshift;            /* red shifts */
-    int                 i_green_lshift, i_green_rshift;      /* green shifts */
-    int                 i_blue_lshift, i_blue_rshift;         /* blue shifts */
-
-    /* Useful pre-calculated pixel values - these are not supposed to be
-     * accurate values, but rather values looking nice, given their usage. */
-    u32                 i_white_pixel;                              /* white */
-    u32                 i_black_pixel;                              /* black */
-    u32                 i_gray_pixel;                                /* gray */
-    u32                 i_blue_pixel;                                /* blue */
-
-    /* Plugins */
-    vout_sys_create_t *     p_sys_create;          /* allocate output method */
-    vout_sys_init_t *       p_sys_init;          /* initialize output method */
-    vout_sys_end_t *        p_sys_end;            /* terminate output method */
-    vout_sys_destroy_t *    p_sys_destroy;          /* destroy output method */
-    vout_sys_manage_t *     p_sys_manage;                   /* handle events */
-    vout_sys_display_t *    p_sys_display;         /* display rendered image */
-
-    vout_set_palette_t *    p_set_palette;               /* set 8bpp palette */
-
-    yuv_sys_init_t *        p_yuv_init;             /* initialize YUV tables */
-    yuv_sys_reset_t *       p_yuv_reset;                 /* reset YUV tables */
-    yuv_sys_end_t *         p_yuv_end;                    /* free YUV tables */
-
-    /* Pictures and rendering properties */
-    boolean_t           b_grayscale;           /* color or grayscale display */
-    boolean_t           b_info;              /* print additional information */
-    boolean_t           b_interface;                     /* render interface */
-    boolean_t           b_scale;                    /* allow picture scaling */
-
-    /* Idle screens management */
-    mtime_t             last_display_date;     /* last non idle display date */
-    mtime_t             last_idle_date;            /* last idle display date */
-
-#ifdef STATS
     /* Statistics - these numbers are not supposed to be accurate, but are a
      * good indication of the thread status */
-    mtime_t             render_time;             /* last picture render time */
     count_t             c_fps_samples;                     /* picture counts */
     mtime_t             p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
-#endif
-
-    /* Rendering buffers */
-    int                 i_buffer_index;                      /* buffer index */
-    vout_buffer_t       p_buffer[2];                   /* buffers properties */
 
     /* Video heap and translation tables */
-    picture_t           p_picture[VOUT_MAX_PICTURES];            /* pictures */
+    int                 i_heap_size;                            /* heap size */
+    picture_heap_t      render;                         /* rendered pictures */
+    picture_heap_t      output;                            /* direct buffers */
+    vlc_bool_t          b_direct;              /* rendered are like direct ? */
+    vout_chroma_t       chroma;                        /* translation tables */
+
+    /* Picture and subpicture heaps */
+    picture_t           p_picture[2*VOUT_MAX_PICTURES];          /* pictures */
     subpicture_t        p_subpicture[VOUT_MAX_PICTURES];      /* subpictures */
-    int                 i_pictures;                     /* current heap size */
-    vout_yuv_t          yuv;                           /* translation tables */
 
     /* Bitmap fonts */
-    p_vout_font_t       p_default_font;                      /* default font */
-    p_vout_font_t       p_large_font;                          /* large font */
+    vout_font_t *       p_default_font;                      /* default font */
+    vout_font_t *       p_large_font;                          /* large font */
+
+    /* Statistics */
+    count_t             c_loops;
+    count_t             c_pictures, c_late_pictures;
+    mtime_t             display_jitter;    /* average deviation from the PTS */
+    count_t             c_jitter_samples;  /* number of samples used for the *
+                                            * calculation of the jitter      */
 
-    /* Synchronization informations - synchro level is updated by the vout
-     * thread and read by decoder threads */
-    int                 i_synchro_level;                   /* trashing level */
-} vout_thread_t;
+    /* Mouse */
+    int                 i_mouse_x, i_mouse_y, i_mouse_button;
+
+    /* Filter chain */
+    char *psz_filter_chain;
+};
+
+#define I_OUTPUTPICTURES p_vout->output.i_pictures
+#define PP_OUTPUTPICTURE p_vout->output.pp_picture
+#define I_RENDERPICTURES p_vout->render.i_pictures
+#define PP_RENDERPICTURE p_vout->render.pp_picture
 
 /* Flags for changes - these flags are set in the i_changes field when another
  * thread changed a variable */
@@ -213,40 +151,46 @@ typedef struct vout_thread_s
 #define VOUT_GRAYSCALE_CHANGE   0x0002                /* b_grayscale changed */
 #define VOUT_INTF_CHANGE        0x0004                /* b_interface changed */
 #define VOUT_SCALE_CHANGE       0x0008                    /* b_scale changed */
+#define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
+#define VOUT_CURSOR_CHANGE      0x0020                   /* b_cursor changed */
+#define VOUT_FULLSCREEN_CHANGE  0x0040               /* b_fullscreen changed */
 #define VOUT_SIZE_CHANGE        0x0200                       /* size changed */
 #define VOUT_DEPTH_CHANGE       0x0400                      /* depth changed */
-#define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
-#define VOUT_YUV_CHANGE         0x0800                  /* change yuv tables */
-#define VOUT_NODISPLAY_CHANGE   0xff00    /* changes which forbidden display */
+#define VOUT_CHROMA_CHANGE      0x0800               /* change chroma tables */
 
-/*****************************************************************************
- * Macros
- *****************************************************************************/
-
-/* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
-#define RGB2PIXEL( p_vout, i_red, i_green, i_blue )                           \
-    (((((u32)i_red)   >> p_vout->i_red_rshift)   << p_vout->i_red_lshift)   | \
-     ((((u32)i_green) >> p_vout->i_green_rshift) << p_vout->i_green_lshift) | \
-     ((((u32)i_blue)  >> p_vout->i_blue_rshift)  << p_vout->i_blue_lshift))
+/* Disabled for thread deadlocks issues --Meuuh */
+//#define VOUT_NODISPLAY_CHANGE   0xff00    /* changes which forbidden display */
 
+#define MAX_JITTER_SAMPLES      20
 
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
-vout_thread_t * vout_CreateThread       ( char *psz_display, int i_root_window,
-                                          int i_width, int i_height, int *pi_status,
-                                          int i_method, void *p_data );
-void            vout_DestroyThread      ( vout_thread_t *p_vout, int *pi_status );
-picture_t *     vout_CreatePicture      ( vout_thread_t *p_vout, int i_type,
-                                          int i_width, int i_height );
-void            vout_DestroyPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
-void            vout_DisplayPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
-void            vout_DatePicture        ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
-void            vout_LinkPicture        ( vout_thread_t *p_vout, picture_t *p_pic );
-void            vout_UnlinkPicture      ( vout_thread_t *p_vout, picture_t *p_pic );
-subpicture_t *  vout_CreateSubPicture   ( vout_thread_t *p_vout, int i_type, int i_size );
-void            vout_DestroySubPicture  ( vout_thread_t *p_vout, subpicture_t *p_subpic );
-void            vout_DisplaySubPicture  ( vout_thread_t *p_vout, subpicture_t *p_subpic );
-
-void            vout_SetBuffers         ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 );
-
+#define vout_CreateThread(a,b,c,d,e) __vout_CreateThread(VLC_OBJECT(a),b,c,d,e)
+VLC_EXPORT( vout_thread_t *, __vout_CreateThread,   ( vlc_object_t *, int, int, u32, int ) );
+VLC_EXPORT( void,              vout_DestroyThread,  ( vout_thread_t * ) );
+
+vout_fifo_t *   vout_CreateFifo     ( void );
+void            vout_DestroyFifo    ( vout_fifo_t * );
+void            vout_FreeFifo       ( vout_fifo_t * );
+
+VLC_EXPORT( int,             vout_ChromaCmp,      ( u32, u32 ) );
+
+VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, vlc_bool_t, vlc_bool_t, vlc_bool_t ) );
+VLC_EXPORT( void,            vout_AllocatePicture,( vout_thread_t *, picture_t *, int, int, u32 ) );
+VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
+VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
+VLC_EXPORT( void,            vout_DatePicture,    ( vout_thread_t *, picture_t *, mtime_t ) );
+VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
+VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
+VLC_EXPORT( void,            vout_PlacePicture,   ( vout_thread_t *, int, int, int *, int *, int *, int * ) );
+picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
+                                                       subpicture_t * );
+
+VLC_EXPORT( subpicture_t *,  vout_CreateSubPicture,   ( vout_thread_t *, int, int ) );
+VLC_EXPORT( void,            vout_DestroySubPicture,  ( vout_thread_t *, subpicture_t * ) );
+VLC_EXPORT( void,            vout_DisplaySubPicture,  ( vout_thread_t *, subpicture_t * ) );
+
+subpicture_t *  vout_SortSubPictures    ( vout_thread_t *, mtime_t );
+void            vout_RenderSubPictures  ( vout_thread_t *, picture_t *,
+                                                           subpicture_t * );