]> git.sesse.net Git - vlc/blobdiff - include/video_output.h
* Mandatory step for video output IV and the audio output quality
[vlc] / include / video_output.h
index e7f06f1a6f589cffd5ff137186f62111ad83cb8a..3923a275ee8dc834216daa1753ee66fb902f21ee 100644 (file)
@@ -1,17 +1,34 @@
 /*****************************************************************************
  * video_output.h : video output thread
- * (c)1999 VideoLAN
- *****************************************************************************
  * 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.
+ *****************************************************************************
+ * Copyright (C) 1999, 2000 VideoLAN
+ * $Id: video_output.h,v 1.58 2001/05/01 04:18:17 sam Exp $
+ *
+ * Authors: Vincent Seguin <seguin@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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  *****************************************************************************/
 
 /*****************************************************************************
- * vout_yuv_convert_t: YUV convertion function
+ * vout_yuv_convert_t: YUV conversion function
  *****************************************************************************
- * This is the prototype common to all convertion functions. The type of p_pic
- * will change depending of the screen depth treated.
+ * This is the prototype common to all conversion functions. The type of p_pic
+ * will change depending on the processed screen depth.
  * Parameters:
  *      p_vout                          video output thread
  *      p_pic                           picture address
@@ -29,18 +46,22 @@ typedef void (vout_yuv_convert_t)( p_vout_thread_t p_vout, void *p_pic,
                                    int i_matrix_coefficients );
 
 /*****************************************************************************
- * vout_yuv_t: pre-calculated YUV convertion tables
+ * vout_yuv_t: pre-calculated YUV conversion tables
  *****************************************************************************
- * These tables are used by convertion and scaling functions.
+ * These tables are used by conversion and scaling functions.
  *****************************************************************************/
+typedef int  (yuv_init_t)           ( p_vout_thread_t p_vout );
+typedef int  (yuv_reset_t)          ( p_vout_thread_t p_vout );
+typedef void (yuv_end_t)            ( p_vout_thread_t p_vout );
+
 typedef struct vout_yuv_s
 {
-    /* Convertion 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 */
+    /* conversion functions */
+    vout_yuv_convert_t *pf_yuv420;                    /* YUV 4:2:0 converter */
+    vout_yuv_convert_t *pf_yuv422;                    /* YUV 4:2:2 converter */
+    vout_yuv_convert_t *pf_yuv444;                    /* YUV 4:4:4 converter */
 
-    /* Pre-calculated convertion tables */
+    /* Pre-calculated conversion tables */
     void *              p_base;            /* base for all conversion tables */
     union
     {
@@ -52,22 +73,29 @@ typedef struct vout_yuv_s
         u32 *           p_rgb32;                        /* RGB 32 bits table */
     } yuv;
 
-    /* Temporary convertion buffer and offset array */
-    void *              p_buffer;                       /* convertion buffer */
+    /* Temporary conversion buffer and offset array */
+    void *              p_buffer;                       /* conversion buffer */
     int *               p_offset;                            /* offset array */
+
+    /* Plugin used and shortcuts to access its capabilities */
+    struct module_s *   p_module;
+    yuv_init_t *        pf_init;                    /* initialize YUV tables */
+    yuv_reset_t *       pf_reset;                        /* reset YUV tables */
+    yuv_end_t *         pf_end;                           /* free YUV tables */
+
 } vout_yuv_t;
 
 /*****************************************************************************
  * vout_buffer_t: rendering buffer
  *****************************************************************************
- * This structure store informations about a buffer. Buffers are not completely
+ * This structure stores information about a buffer. Buffers are not completely
  * cleared between displays, and modified areas need to be stored.
  *****************************************************************************/
 typedef struct vout_buffer_s
 {
     /* Picture area */
     int         i_pic_x, i_pic_y;                       /* picture position  */
-    int         i_pic_width, i_pic_height;              /* picture extension */
+    int         i_pic_width, i_pic_height;                   /* picture size */
 
     /* Other areas - only vertical extensions of areas are stored */
     int         i_areas;                                  /* number of areas */
@@ -78,6 +106,28 @@ typedef struct vout_buffer_s
     byte_t *    p_data;                                    /* memory address */
 } vout_buffer_t;
 
+/*****************************************************************************
+ * vout_fifo_t
+ *****************************************************************************/
+typedef struct vout_fifo_s
+{
+    /* See the fifo types below */
+    int                 i_type;
+    boolean_t           b_die;
+    int                 i_fifo;      /* Just to keep track of the fifo index */
+
+    int                 i_width;
+    int                 i_height;
+
+    vlc_mutex_t         data_lock;
+    vlc_cond_t          data_wait;
+
+} vout_fifo_t;
+
+#define VOUT_EMPTY_FIFO         0
+#define VOUT_YUV_FIFO           1
+#define VOUT_SPU_FIFO           2
+
 /*****************************************************************************
  * vout_thread_t: video output thread descriptor
  *****************************************************************************
@@ -85,16 +135,6 @@ 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 );
-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 struct vout_thread_s
 {
     /* Thread properties and lock */
@@ -107,7 +147,7 @@ typedef struct vout_thread_s
     vlc_mutex_t         change_lock;                   /* thread change lock */
     int *               pi_status;                  /* temporary status flag */
     p_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 */
@@ -116,6 +156,8 @@ typedef struct vout_thread_s
     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 */
+    boolean_t           b_need_render;  /* does the output method need a YUV 
+                                         * conversion ?                      */
 
     /* Color masks and shifts in RGB mode - masks are set by system
      * initialization, shifts are calculated. A pixel color value can be
@@ -134,51 +176,54 @@ typedef struct vout_thread_s
     u32                 i_gray_pixel;                                /* gray */
     u32                 i_blue_pixel;                                /* blue */
 
-    /* Plugins */
-    void *                  p_vout_plugin;            /* video output plugin */
-    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;              /* sets 8bpp palette */
+    /* Plugin used and shortcuts to access its capabilities */
+    struct module_s *   p_module;
+    int              ( *pf_create )     ( struct vout_thread_s * );
+    int              ( *pf_init )       ( struct vout_thread_s * );
+    void             ( *pf_end )        ( struct vout_thread_s * );
+    void             ( *pf_destroy )    ( struct vout_thread_s * );
+    int              ( *pf_manage )     ( struct vout_thread_s * );
+    void             ( *pf_display )    ( struct vout_thread_s * );
+    void             ( *pf_setpalette ) ( struct vout_thread_s *, u16 *red,
+                                          u16 *green, u16 *blue, u16 *transp );
 
     /* Pictures and rendering properties */
     boolean_t           b_grayscale;           /* color or grayscale display */
-    boolean_t           b_info;            /* print additionnal informations */
+    boolean_t           b_YCbr;            /* use YUV to YCbr instead of RGB */
+    boolean_t           b_info;              /* print additional information */
     boolean_t           b_interface;                     /* render interface */
     boolean_t           b_scale;                    /* allow picture scaling */
+    mtime_t             render_time;             /* last picture render time */
+
 
     /* Idle screens management */
     mtime_t             last_display_date;     /* last non idle display date */
     mtime_t             last_idle_date;            /* last idle display date */
+    mtime_t             init_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 */
 
-    /* Videos heap and translation tables */
+    /* Video heap and translation tables */
     picture_t           p_picture[VOUT_MAX_PICTURES];            /* pictures */
     subpicture_t        p_subpicture[VOUT_MAX_PICTURES];      /* subpictures */
     int                 i_pictures;                     /* current heap size */
     vout_yuv_t          yuv;                           /* translation tables */
+    picture_t *         p_rendered_pic;  /* picture currently being rendered */
 
     /* Bitmap fonts */
     p_vout_font_t       p_default_font;                      /* default font */
     p_vout_font_t       p_large_font;                          /* large font */
 
-    /* Synchronisation informations - synchro level is updated by the vout
-     * thread and read by decoder threads */
-    int                 i_synchro_level;                   /* trashing level */
+#ifdef STATS
+    count_t             c_loops;
+#endif
 } vout_thread_t;
 
 /* Flags for changes - these flags are set in the i_changes field when another
@@ -187,11 +232,15 @@ 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 */
+
+/* Disabled for thread deadlocks issues --Meuuh */
+//#define VOUT_NODISPLAY_CHANGE   0xff00    /* changes which forbidden display */
 
 /*****************************************************************************
  * Macros
@@ -207,16 +256,21 @@ typedef struct vout_thread_s
 /*****************************************************************************
  * 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            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 );
+vout_thread_t * vout_CreateThread   ( int *pi_status );
+void            vout_DestroyThread  ( vout_thread_t *p_vout, int *pi_status );
+
+vout_fifo_t *   vout_CreateFifo         ( void );
+void            vout_DestroyFifo        ( vout_fifo_t *p_fifo );
+void            vout_FreeFifo           ( vout_fifo_t *p_fifo );
+
+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 );