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