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
  60     /* Stuff used for truecolor RGB planes */
  61     uint32_t i_rmask; int i_rrshift, i_lrshift;
  62     uint32_t i_gmask; int i_rgshift, i_lgshift;
  63     uint32_t i_bmask; int i_rbshift, i_lbshift;
  64 };
  65
  66 /*****************************************************************************
  67  * Prototypes
  68  *****************************************************************************/
  69
  70 /**
  71  * \defgroup video_output Video Output
  72  * This module describes the programming interface for video output threads.
  73  * It includes functions allowing to open a new thread, send pictures to a
  74  * thread, and destroy a previously opened video output thread.
  75  * @{
  76  */
  77
  78 /**
  79  * Video ouput thread private structure
  80  */
  81 typedef struct vout_thread_sys_t vout_thread_sys_t;
  82
  83 /**
  84  * Video output thread descriptor
  85  *
  86  * Any independent video output device, such as an X11 window or a GGI device,
  87  * is represented by a video output thread, and described using the following
  88  * structure.
  89  */
  90 struct vout_thread_t
  91 {
  92     VLC_COMMON_MEMBERS
  93
  94     /** \name Thread properties and locks */
  95     /**@{*/
  96     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
  97     vlc_mutex_t         change_lock;                 /**< thread change lock */
  98     /**@}*/
  99
 100     /** \name Current display properties */
 101     /**@{*/
 102     uint16_t            i_changes;          /**< changes made to the thread.
 103                                                       \see \ref vout_changes */
 104     unsigned            b_fullscreen:1;       /**< toogle fullscreen display */
 105     unsigned            b_autoscale:1;      /**< auto scaling picture or not */
 106     unsigned            b_on_top:1; /**< stay always on top of other windows */
 107     int                 i_zoom;               /**< scaling factor if no auto */
 108     unsigned int        i_window_width;              /**< video window width */
 109     unsigned int        i_window_height;            /**< video window height */
 110     unsigned int        i_alignment;          /**< video alignment in window */
 111
 112     /**@}*/
 113
 114     /** \name Video heap and translation tables */
 115     /**@{*/
 116     picture_heap_t      render;                       /**< rendered pictures */
 117     picture_heap_t      output;                          /**< direct buffers */
 118
 119     video_format_t      fmt_render;      /* render format (from the decoder) */
 120     video_format_t      fmt_in;            /* input (modified render) format */
 121     video_format_t      fmt_out;     /* output format (for the video output) */
 122     /**@}*/
 123
 124     /* Picture heap */
 125     picture_t           p_picture[2*VOUT_MAX_PICTURES+1];      /**< pictures */
 126
 127     /* Private vout_thread data */
 128     vout_thread_sys_t *p;
 129 };
 130
 131 #define I_OUTPUTPICTURES p_vout->output.i_pictures
 132 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
 133 #define I_RENDERPICTURES p_vout->render.i_pictures
 134 #define PP_RENDERPICTURE p_vout->render.pp_picture
 135
 136 /** \defgroup vout_changes Flags for changes
 137  * These flags are set in the vout_thread_t::i_changes field when another
 138  * thread changed a variable
 139  * @{
 140  */
 141 /** b_autoscale changed */
 142 #define VOUT_SCALE_CHANGE       0x0008
 143 /** b_on_top changed */
 144 #define VOUT_ON_TOP_CHANGE      0x0010
 145 /** b_fullscreen changed */
 146 #define VOUT_FULLSCREEN_CHANGE  0x0040
 147 /** i_zoom changed */
 148 #define VOUT_ZOOM_CHANGE        0x0080
 149 /** cropping parameters changed */
 150 #define VOUT_CROP_CHANGE        0x1000
 151 /** aspect ratio changed */
 152 #define VOUT_ASPECT_CHANGE      0x2000
 153 /** change/recreate picture buffers */
 154 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
 155 /**@}*/
 156
 157 /* Alignment flags */
 158 #define VOUT_ALIGN_LEFT         0x0001
 159 #define VOUT_ALIGN_RIGHT        0x0002
 160 #define VOUT_ALIGN_HMASK        0x0003
 161 #define VOUT_ALIGN_TOP          0x0004
 162 #define VOUT_ALIGN_BOTTOM       0x0008
 163 #define VOUT_ALIGN_VMASK        0x000C
 164
 165 /* scaling factor (applied to i_zoom in vout_thread_t) */
 166 #define ZOOM_FP_FACTOR          1000
 167
 168 /*****************************************************************************
 169  * Prototypes
 170  *****************************************************************************/
 171
 172 /**
 173  * This function will
 174  *  - returns a suitable vout (if requested by a non NULL p_fmt)
 175  *  - recycles an old vout (if given) by either destroying it or by saving it
 176  *  for latter usage.
 177  *
 178  * The purpose of this function is to avoid unnecessary creation/destruction of
 179  * vout (and to allow optional vout reusing).
 180  *
 181  * You can call vout_Request on a vout created by vout_Create or by a previous
 182  * call to vout_Request.
 183  * You can release the returned value either by vout_Request or vout_Close()
 184  * followed by a vlc_object_release() or shorter vout_CloseAndRelease()
 185  *
 186  * \param p_this a vlc object
 187  * \param p_vout a vout candidate
 188  * \param p_fmt the video format requested or NULL
 189  * \return a vout if p_fmt is non NULL and the request is successfull, NULL
 190  * otherwise
 191  */
 192 VLC_EXPORT( vout_thread_t *, vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) );
 193 #define vout_Request(a,b,c) vout_Request(VLC_OBJECT(a),b,c)
 194
 195 /**
 196  * This function will create a suitable vout for a given p_fmt. It will never
 197  * reuse an already existing unused vout.
 198  *
 199  * You have to call either vout_Close or vout_Request on the returned value
 200  * \param p_this a vlc object to which the returned vout will be attached
 201  * \param p_fmt the video format requested
 202  * \return a vout if the request is successfull, NULL otherwise
 203  */
 204 VLC_EXPORT( vout_thread_t *, vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) );
 205 #define vout_Create(a,b) vout_Create(VLC_OBJECT(a),b)
 206
 207 /**
 208  * This function will close a vout created by vout_Create or vout_Request.
 209  * The associated vout module is closed.
 210  * Note: It is not released yet, you'll have to call vlc_object_release()
 211  * or use the convenient vout_CloseAndRelease().
 212  *
 213  * \param p_vout the vout to close
 214  */
 215 VLC_EXPORT( void,            vout_Close,        ( vout_thread_t *p_vout ) );
 216
 217 /**
 218  * This function will close a vout created by vout_Create
 219  * and then release it.
 220  *
 221  * \param p_vout the vout to close and release
 222  */
 223 static inline void vout_CloseAndRelease( vout_thread_t *p_vout )
 224 {
 225     vout_Close( p_vout );
 226     vlc_object_release( p_vout );
 227 }
 228
 229 /**
 230  * This function will handle a snapshot request.
 231  *
 232  * pp_image, pp_picture and p_fmt can be NULL otherwise they will be
 233  * set with returned value in case of success.
 234  *
 235  * pp_image will hold an encoded picture in psz_format format.
 236  *
 237  * i_timeout specifies the time the function will wait for a snapshot to be
 238  * available.
 239  *
 240  */
 241 VLC_EXPORT( int, vout_GetSnapshot, ( vout_thread_t *p_vout,
 242                                      block_t **pp_image, picture_t **pp_picture,
 243                                      video_format_t *p_fmt,
 244                                      const char *psz_format, mtime_t i_timeout ) );
 245
 246 /* */
 247 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, bool, bool, unsigned int ) );
 248 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
 249 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
 250 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
 251 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
 252
 253 /**
 254  * Return the spu_t object associated to a vout_thread_t.
 255  *
 256  * The return object is valid only as long as the vout is. You must not
 257  * release the spu_t object returned.
 258  * It cannot return NULL so no need to check.
 259  */
 260 VLC_EXPORT( spu_t *, vout_GetSpu, ( vout_thread_t * ) );
 261
 262 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, const char *,bool , bool  ) );
 263
 264 /**@}*/
 265
 266 #endif /* _VLC_VIDEO_H */