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

   1 /*****************************************************************************
   2  * vlc_video.h: common video definitions
   3  *****************************************************************************
   4  * Copyright (C) 1999 - 2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   8  *          Samuel Hocevar <sam@via.ecp.fr>
   9  *          Olivier Aubert <oaubert 47 videolan d07 org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 #ifndef VLC_VOUT_H_
  27 #define VLC_VOUT_H_ 1
  28
  29 /**
  30  * \file
  31  * This file defines common video output structures and functions in vlc
  32  */
  33
  34 #include <vlc_picture.h>
  35 #include <vlc_filter.h>
  36 #include <vlc_subpicture.h>
  37
  38 /**
  39  * Video picture heap, either render (to store pictures used
  40  * by the decoder) or output (to store pictures displayed by the vout plugin)
  41  */
  42 struct picture_heap_t
  43 {
  44     int i_pictures;                                   /**< current heap size */
  45
  46     /* \name Picture static properties
  47      * Those properties are fixed at initialization and should NOT be modified
  48      * @{
  49      */
  50     unsigned int i_width;                                 /**< picture width */
  51     unsigned int i_height;                               /**< picture height */
  52     vlc_fourcc_t i_chroma;                               /**< picture chroma */
  53     unsigned int i_aspect;                                 /**< aspect ratio */
  54     /**@}*/
  55
  56     /* Real pictures */
  57     picture_t*      pp_picture[VOUT_MAX_PICTURES];             /**< pictures */
  58     int             i_last_used_pic;              /**< last used pic in heap */
  59     bool            b_allow_modify_pics;
  60
  61     /* Stuff used for truecolor RGB planes */
  62     uint32_t i_rmask; int i_rrshift, i_lrshift;
  63     uint32_t i_gmask; int i_rgshift, i_lgshift;
  64     uint32_t i_bmask; int i_rbshift, i_lbshift;
  65 };
  66
  67 /*****************************************************************************
  68  * Prototypes
  69  *****************************************************************************/
  70
  71 /**
  72  * Initialise different fields of a picture_t and allocates the picture buffer.
  73  * \param p_this a vlc object
  74  * \param p_pic pointer to the picture structure.
  75  * \param i_chroma the wanted chroma for the picture.
  76  * \param i_width the wanted width for the picture.
  77  * \param i_height the wanted height for the picture.
  78  * \param i_aspect the wanted aspect ratio for the picture.
  79  */
  80 VLC_EXPORT( int, vout_AllocatePicture,( vlc_object_t *p_this, picture_t *p_pic, uint32_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den ) );
  81 #define vout_AllocatePicture(a,b,c,d,e,f,g) \
  82         vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f,g)
  83
  84 /**
  85  * \defgroup video_output Video Output
  86  * This module describes the programming interface for video output threads.
  87  * It includes functions allowing to open a new thread, send pictures to a
  88  * thread, and destroy a previously opened video output thread.
  89  * @{
  90  */
  91
  92 /**
  93  * Video ouput thread private structure
  94  */
  95 typedef struct vout_thread_sys_t vout_thread_sys_t;
  96
  97 /**
  98  * Video output thread descriptor
  99  *
 100  * Any independent video output device, such as an X11 window or a GGI device,
 101  * is represented by a video output thread, and described using the following
 102  * structure.
 103  */
 104 struct vout_thread_t
 105 {
 106     VLC_COMMON_MEMBERS
 107     bool                b_error;
 108
 109     /** \name Thread properties and locks */
 110     /**@{*/
 111     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
 112     vlc_mutex_t         change_lock;                 /**< thread change lock */
 113     vout_sys_t *        p_sys;                     /**< system output method */
 114     /**@}*/
 115
 116     /** \name Current display properties */
 117     /**@{*/
 118     uint16_t            i_changes;          /**< changes made to the thread.
 119                                                       \see \ref vout_changes */
 120     unsigned            b_fullscreen:1;       /**< toogle fullscreen display */
 121     unsigned            b_autoscale:1;      /**< auto scaling picture or not */
 122     unsigned            b_on_top:1; /**< stay always on top of other windows */
 123     int                 i_zoom;               /**< scaling factor if no auto */
 124     unsigned int        i_window_width;              /**< video window width */
 125     unsigned int        i_window_height;            /**< video window height */
 126     unsigned int        i_alignment;          /**< video alignment in window */
 127
 128     /**@}*/
 129
 130     /** \name Video heap and translation tables */
 131     /**@{*/
 132     int                 i_heap_size;                          /**< heap size */
 133     picture_heap_t      render;                       /**< rendered pictures */
 134     picture_heap_t      output;                          /**< direct buffers */
 135
 136     video_format_t      fmt_render;      /* render format (from the decoder) */
 137     video_format_t      fmt_in;            /* input (modified render) format */
 138     video_format_t      fmt_out;     /* output format (for the video output) */
 139     /**@}*/
 140
 141     /* Picture heap */
 142     picture_t           p_picture[2*VOUT_MAX_PICTURES+1];      /**< pictures */
 143
 144     /* Subpicture unit */
 145     spu_t          *p_spu;
 146
 147     /* Video output configuration */
 148     config_chain_t *p_cfg;
 149
 150     /* Private vout_thread data */
 151     vout_thread_sys_t *p;
 152 };
 153
 154 #define I_OUTPUTPICTURES p_vout->output.i_pictures
 155 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
 156 #define I_RENDERPICTURES p_vout->render.i_pictures
 157 #define PP_RENDERPICTURE p_vout->render.pp_picture
 158
 159 /** \defgroup vout_changes Flags for changes
 160  * These flags are set in the vout_thread_t::i_changes field when another
 161  * thread changed a variable
 162  * @{
 163  */
 164 /** b_autoscale changed */
 165 #define VOUT_SCALE_CHANGE       0x0008
 166 /** b_on_top changed */
 167 #define VOUT_ON_TOP_CHANGE      0x0010
 168 /** b_fullscreen changed */
 169 #define VOUT_FULLSCREEN_CHANGE  0x0040
 170 /** i_zoom changed */
 171 #define VOUT_ZOOM_CHANGE        0x0080
 172 /** cropping parameters changed */
 173 #define VOUT_CROP_CHANGE        0x1000
 174 /** aspect ratio changed */
 175 #define VOUT_ASPECT_CHANGE      0x2000
 176 /** change/recreate picture buffers */
 177 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
 178 /**@}*/
 179
 180 /* Alignment flags */
 181 #define VOUT_ALIGN_LEFT         0x0001
 182 #define VOUT_ALIGN_RIGHT        0x0002
 183 #define VOUT_ALIGN_HMASK        0x0003
 184 #define VOUT_ALIGN_TOP          0x0004
 185 #define VOUT_ALIGN_BOTTOM       0x0008
 186 #define VOUT_ALIGN_VMASK        0x000C
 187
 188 /* scaling factor (applied to i_zoom in vout_thread_t) */
 189 #define ZOOM_FP_FACTOR          1000
 190
 191 /*****************************************************************************
 192  * Prototypes
 193  *****************************************************************************/
 194
 195 /**
 196  * This function will
 197  *  - returns a suitable vout (if requested by a non NULL p_fmt)
 198  *  - recycles an old vout (if given) by either destroying it or by saving it
 199  *  for latter usage.
 200  *
 201  * The purpose of this function is to avoid unnecessary creation/destruction of
 202  * vout (and to allow optional vout reusing).
 203  *
 204  * You can call vout_Request on a vout created by vout_Create or by a previous
 205  * call to vout_Request.
 206  * You can release the returned value either by vout_Request or vout_Close()
 207  * followed by a vlc_object_release() or shorter vout_CloseAndRelease()
 208  *
 209  * \param p_this a vlc object
 210  * \param p_vout a vout candidate
 211  * \param p_fmt the video format requested or NULL
 212  * \return a vout if p_fmt is non NULL and the request is successfull, NULL
 213  * otherwise
 214  */
 215 VLC_EXPORT( vout_thread_t *, vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) );
 216 #define vout_Request(a,b,c) vout_Request(VLC_OBJECT(a),b,c)
 217
 218 /**
 219  * This function will create a suitable vout for a given p_fmt. It will never
 220  * reuse an already existing unused vout.
 221  *
 222  * You have to call either vout_Close or vout_Request on the returned value
 223  * \param p_this a vlc object to which the returned vout will be attached
 224  * \param p_fmt the video format requested
 225  * \return a vout if the request is successfull, NULL otherwise
 226  */
 227 VLC_EXPORT( vout_thread_t *, vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) );
 228 #define vout_Create(a,b) vout_Create(VLC_OBJECT(a),b)
 229
 230 /**
 231  * This function will close a vout created by vout_Create or vout_Request.
 232  * The associated vout module is closed.
 233  * Note: It is not released yet, you'll have to call vlc_object_release()
 234  * or use the convenient vout_CloseAndRelease().
 235  *
 236  * \param p_vout the vout to close
 237  */
 238 VLC_EXPORT( void,            vout_Close,        ( vout_thread_t *p_vout ) );
 239
 240 /**
 241  * This function will close a vout created by vout_Create
 242  * and then release it.
 243  *
 244  * \param p_vout the vout to close and release
 245  */
 246 static inline void vout_CloseAndRelease( vout_thread_t *p_vout )
 247 {
 248     vout_Close( p_vout );
 249     vlc_object_release( p_vout );
 250 }
 251
 252 /**
 253  * This function will handle a snapshot request.
 254  *
 255  * pp_image, pp_picture and p_fmt can be NULL otherwise they will be
 256  * set with returned value in case of success.
 257  *
 258  * pp_image will hold an encoded picture in psz_format format.
 259  *
 260  * i_timeout specifies the time the function will wait for a snapshot to be
 261  * available.
 262  *
 263  */
 264 VLC_EXPORT( int, vout_GetSnapshot, ( vout_thread_t *p_vout,
 265                                      block_t **pp_image, picture_t **pp_picture,
 266                                      video_format_t *p_fmt,
 267                                      const char *psz_format, mtime_t i_timeout ) );
 268
 269 /* */
 270 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, bool, bool, unsigned int ) );
 271 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
 272 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
 273 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
 274 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
 275
 276 /**
 277  * Return the spu_t object associated to a vout_thread_t.
 278  *
 279  * The return object is valid only as long as the vout is. You must not
 280  * release the spu_t object returned.
 281  * It cannot return NULL so no need to check.
 282  */
 283 VLC_EXPORT( spu_t *, vout_GetSpu, ( vout_thread_t * ) );
 284
 285 void vout_IntfInit( vout_thread_t * );
 286 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, const char *,bool , bool  ) );
 287
 288 /**@}*/
 289
 290 #endif /* _VLC_VIDEO_H */