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  * Prototypes
  40  *****************************************************************************/
  41
  42 /**
  43  * \defgroup video_output Video Output
  44  * This module describes the programming interface for video output threads.
  45  * It includes functions allowing to open a new thread, send pictures to a
  46  * thread, and destroy a previously opened video output thread.
  47  * @{
  48  */
  49
  50 /**
  51  * Video ouput thread private structure
  52  */
  53 typedef struct vout_thread_sys_t vout_thread_sys_t;
  54
  55 /**
  56  * Video output thread descriptor
  57  *
  58  * Any independent video output device, such as an X11 window or a GGI device,
  59  * is represented by a video output thread, and described using the following
  60  * structure.
  61  */
  62 struct vout_thread_t
  63 {
  64     VLC_COMMON_MEMBERS
  65
  66     video_format_t      fmt_render;      /* render format (from the decoder) */
  67     video_format_t      fmt_in;            /* input (modified render) format */
  68     video_format_t      fmt_out;     /* output format (for the video output) */
  69
  70     /* Private vout_thread data */
  71     vout_thread_sys_t *p;
  72 };
  73
  74 /* Alignment flags */
  75 #define VOUT_ALIGN_LEFT         0x0001
  76 #define VOUT_ALIGN_RIGHT        0x0002
  77 #define VOUT_ALIGN_HMASK        0x0003
  78 #define VOUT_ALIGN_TOP          0x0004
  79 #define VOUT_ALIGN_BOTTOM       0x0008
  80 #define VOUT_ALIGN_VMASK        0x000C
  81
  82 /* scaling factor (applied to i_zoom in vout_thread_t) */
  83 #define ZOOM_FP_FACTOR          1000
  84
  85 /*****************************************************************************
  86  * Prototypes
  87  *****************************************************************************/
  88
  89 /**
  90  * This function will
  91  *  - returns a suitable vout (if requested by a non NULL p_fmt)
  92  *  - recycles an old vout (if given) by either destroying it or by saving it
  93  *  for latter usage.
  94  *
  95  * The purpose of this function is to avoid unnecessary creation/destruction of
  96  * vout (and to allow optional vout reusing).
  97  *
  98  * You can call vout_Request on a vout created by vout_Create or by a previous
  99  * call to vout_Request.
 100  * You can release the returned value either by vout_Request or vout_Close()
 101  * followed by a vlc_object_release() or shorter vout_CloseAndRelease()
 102  *
 103  * \param p_this a vlc object
 104  * \param p_vout a vout candidate
 105  * \param p_fmt the video format requested or NULL
 106  * \return a vout if p_fmt is non NULL and the request is successfull, NULL
 107  * otherwise
 108  */
 109 VLC_EXPORT( vout_thread_t *, vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) );
 110 #define vout_Request(a,b,c) vout_Request(VLC_OBJECT(a),b,c)
 111
 112 /**
 113  * This function will create a suitable vout for a given p_fmt. It will never
 114  * reuse an already existing unused vout.
 115  *
 116  * You have to call either vout_Close or vout_Request on the returned value
 117  * \param p_this a vlc object to which the returned vout will be attached
 118  * \param p_fmt the video format requested
 119  * \return a vout if the request is successfull, NULL otherwise
 120  */
 121 VLC_EXPORT( vout_thread_t *, vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) );
 122 #define vout_Create(a,b) vout_Create(VLC_OBJECT(a),b)
 123
 124 /**
 125  * This function will close a vout created by vout_Create or vout_Request.
 126  * The associated vout module is closed.
 127  * Note: It is not released yet, you'll have to call vlc_object_release()
 128  * or use the convenient vout_CloseAndRelease().
 129  *
 130  * \param p_vout the vout to close
 131  */
 132 VLC_EXPORT( void,            vout_Close,        ( vout_thread_t *p_vout ) );
 133
 134 /**
 135  * This function will close a vout created by vout_Create
 136  * and then release it.
 137  *
 138  * \param p_vout the vout to close and release
 139  */
 140 static inline void vout_CloseAndRelease( vout_thread_t *p_vout )
 141 {
 142     vout_Close( p_vout );
 143     vlc_object_release( p_vout );
 144 }
 145
 146 /**
 147  * This function will handle a snapshot request.
 148  *
 149  * pp_image, pp_picture and p_fmt can be NULL otherwise they will be
 150  * set with returned value in case of success.
 151  *
 152  * pp_image will hold an encoded picture in psz_format format.
 153  *
 154  * i_timeout specifies the time the function will wait for a snapshot to be
 155  * available.
 156  *
 157  */
 158 VLC_EXPORT( int, vout_GetSnapshot, ( vout_thread_t *p_vout,
 159                                      block_t **pp_image, picture_t **pp_picture,
 160                                      video_format_t *p_fmt,
 161                                      const char *psz_format, mtime_t i_timeout ) );
 162
 163 /* */
 164 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, bool, bool, unsigned int ) );
 165 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
 166 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
 167 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
 168 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
 169
 170 /**
 171  * Return the spu_t object associated to a vout_thread_t.
 172  *
 173  * The return object is valid only as long as the vout is. You must not
 174  * release the spu_t object returned.
 175  * It cannot return NULL so no need to check.
 176  */
 177 VLC_EXPORT( spu_t *, vout_GetSpu, ( vout_thread_t * ) );
 178
 179 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, const char *,bool , bool  ) );
 180
 181 /**@}*/
 182
 183 #endif /* _VLC_VIDEO_H */