]> git.sesse.net Git - vlc/blobdiff - include/vlc_vout.h
Merge branch 'master' into lpcm_encoder
[vlc] / include / vlc_vout.h
index 05bc7011c2e6f1d9bec610f42df92ce4560bcdca..ad08f3975f9d39d0e8356727b7544cefc8b71da7 100644 (file)
 #include <vlc_filter.h>
 #include <vlc_subpicture.h>
 
-/**
- * Video picture heap, either render (to store pictures used
- * by the decoder) or output (to store pictures displayed by the vout plugin)
- */
-struct picture_heap_t
-{
-    int i_pictures;                                   /**< current heap size */
-
-    /* \name Picture static properties
-     * Those properties are fixed at initialization and should NOT be modified
-     * @{
-     */
-    unsigned int i_width;                                 /**< picture width */
-    unsigned int i_height;                               /**< picture height */
-    vlc_fourcc_t i_chroma;                               /**< picture chroma */
-    unsigned int i_aspect;                                 /**< aspect ratio */
-    /**@}*/
-
-    /* Real pictures */
-    picture_t*      pp_picture[VOUT_MAX_PICTURES];             /**< pictures */
-    int             i_last_used_pic;              /**< last used pic in heap */
-
-    /* Stuff used for truecolor RGB planes */
-    uint32_t i_rmask; int i_rrshift, i_lrshift;
-    uint32_t i_gmask; int i_rgshift, i_lgshift;
-    uint32_t i_bmask; int i_rbshift, i_lbshift;
-};
-
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
@@ -75,6 +47,17 @@ struct picture_heap_t
  * @{
  */
 
+/**
+ * Vout configuration
+ */
+typedef struct {
+    vout_thread_t        *vout;
+    vlc_object_t         *input;
+    bool                 change_fmt;
+    const video_format_t *fmt;
+    unsigned             dpb_size;
+} vout_configuration_t;
+
 /**
  * Video ouput thread private structure
  */
@@ -87,69 +70,13 @@ typedef struct vout_thread_sys_t vout_thread_sys_t;
  * is represented by a video output thread, and described using the following
  * structure.
  */
-struct vout_thread_t
-{
+struct vout_thread_t {
     VLC_COMMON_MEMBERS
 
-    /** \name Thread properties and locks */
-    /**@{*/
-    vlc_mutex_t         picture_lock;                 /**< picture heap lock */
-    vlc_mutex_t         change_lock;                 /**< thread change lock */
-    /**@}*/
-
-    /** \name Current display properties */
-    /**@{*/
-    uint16_t            i_changes;          /**< changes made to the thread.
-                                                      \see \ref vout_changes */
-    unsigned            b_fullscreen:1;       /**< toogle fullscreen display */
-    unsigned            b_on_top:1; /**< stay always on top of other windows */
-    int                 i_zoom;               /**< scaling factor if no auto */
-
-    /**@}*/
-
-    /** \name Video heap and translation tables */
-    /**@{*/
-    picture_heap_t      render;                       /**< rendered pictures */
-    picture_heap_t      output;                          /**< direct buffers */
-
-    video_format_t      fmt_render;      /* render format (from the decoder) */
-    video_format_t      fmt_in;            /* input (modified render) format */
-    video_format_t      fmt_out;     /* output format (for the video output) */
-    /**@}*/
-
-    /* Picture heap */
-    picture_t           p_picture[2*VOUT_MAX_PICTURES+1];      /**< pictures */
-
     /* Private vout_thread data */
     vout_thread_sys_t *p;
 };
 
-#define I_OUTPUTPICTURES p_vout->output.i_pictures
-#define PP_OUTPUTPICTURE p_vout->output.pp_picture
-#define I_RENDERPICTURES p_vout->render.i_pictures
-#define PP_RENDERPICTURE p_vout->render.pp_picture
-
-/** \defgroup vout_changes Flags for changes
- * These flags are set in the vout_thread_t::i_changes field when another
- * thread changed a variable
- * @{
- */
-/** b_autoscale changed */
-#define VOUT_SCALE_CHANGE       0x0008
-/** b_on_top changed */
-#define VOUT_ON_TOP_CHANGE     0x0010
-/** b_fullscreen changed */
-#define VOUT_FULLSCREEN_CHANGE  0x0040
-/** i_zoom changed */
-#define VOUT_ZOOM_CHANGE        0x0080
-/** cropping parameters changed */
-#define VOUT_CROP_CHANGE        0x1000
-/** aspect ratio changed */
-#define VOUT_ASPECT_CHANGE      0x2000
-/** change/recreate picture buffers */
-#define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
-/**@}*/
-
 /* Alignment flags */
 #define VOUT_ALIGN_LEFT         0x0001
 #define VOUT_ALIGN_RIGHT        0x0002
@@ -158,50 +85,29 @@ struct vout_thread_t
 #define VOUT_ALIGN_BOTTOM       0x0008
 #define VOUT_ALIGN_VMASK        0x000C
 
-/* scaling factor (applied to i_zoom in vout_thread_t) */
-#define ZOOM_FP_FACTOR          1000
-
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
 
 /**
- * This function will
- *  - returns a suitable vout (if requested by a non NULL p_fmt)
- *  - recycles an old vout (if given) by either destroying it or by saving it
- *  for latter usage.
+ * Returns a suitable vout or release the given one.
  *
- * The purpose of this function is to avoid unnecessary creation/destruction of
- * vout (and to allow optional vout reusing).
+ * If cfg->fmt is non NULL and valid, a vout will be returned, reusing cfg->vout
+ * is possible, otherwise it returns NULL.
+ * If cfg->vout is not used, it will be closed and released.
  *
- * You can call vout_Request on a vout created by vout_Create or by a previous
- * call to vout_Request.
  * You can release the returned value either by vout_Request or vout_Close()
  * followed by a vlc_object_release() or shorter vout_CloseAndRelease()
  *
- * \param p_this a vlc object
- * \param p_vout a vout candidate
- * \param p_fmt the video format requested or NULL
- * \return a vout if p_fmt is non NULL and the request is successfull, NULL
- * otherwise
- */
-VLC_EXPORT( vout_thread_t *, vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) );
-#define vout_Request(a,b,c) vout_Request(VLC_OBJECT(a),b,c)
-
-/**
- * This function will create a suitable vout for a given p_fmt. It will never
- * reuse an already existing unused vout.
- *
- * You have to call either vout_Close or vout_Request on the returned value
- * \param p_this a vlc object to which the returned vout will be attached
- * \param p_fmt the video format requested
- * \return a vout if the request is successfull, NULL otherwise
+ * \param object a vlc object
+ * \param cfg the video configuration requested.
+ * \return a vout
  */
-VLC_EXPORT( vout_thread_t *, vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) );
-#define vout_Create(a,b) vout_Create(VLC_OBJECT(a),b)
+VLC_EXPORT( vout_thread_t *, vout_Request, ( vlc_object_t *object, const vout_configuration_t *cfg ) );
+#define vout_Request(a,b) vout_Request(VLC_OBJECT(a),b)
 
 /**
- * This function will close a vout created by vout_Create or vout_Request.
+ * This function will close a vout created by vout_Request.
  * The associated vout module is closed.
  * Note: It is not released yet, you'll have to call vlc_object_release()
  * or use the convenient vout_CloseAndRelease().
@@ -240,20 +146,16 @@ VLC_EXPORT( int, vout_GetSnapshot, ( vout_thread_t *p_vout,
                                      const char *psz_format, mtime_t i_timeout ) );
 
 /* */
-VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, bool, bool, unsigned int ) );
-VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
-VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
-VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
-VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
+VLC_EXPORT( picture_t *,     vout_GetPicture,     ( vout_thread_t * ) );
+VLC_EXPORT( void,            vout_PutPicture,     ( vout_thread_t *, picture_t * ) );
 
-/**
- * Return the spu_t object associated to a vout_thread_t.
- *
- * The return object is valid only as long as the vout is. You must not
- * release the spu_t object returned.
- * It cannot return NULL so no need to check.
- */
-VLC_EXPORT( spu_t *, vout_GetSpu, ( vout_thread_t * ) );
+VLC_EXPORT( void,            vout_HoldPicture,    ( vout_thread_t *, picture_t * ) );
+VLC_EXPORT( void,            vout_ReleasePicture, ( vout_thread_t *, picture_t * ) );
+
+/* */
+VLC_EXPORT( void, vout_PutSubpicture,             ( vout_thread_t *, subpicture_t * ) );
+VLC_EXPORT( int,  vout_RegisterSubpictureChannel, ( vout_thread_t * ) );
+VLC_EXPORT( void, vout_FlushSubpictureChannel,    ( vout_thread_t *, int ) );
 
 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, const char *,bool , bool  ) );