* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
-#ifndef _VLC_VOUT_H_
-#define _VLC_VOUT_H_ 1
+#ifndef VLC_VOUT_H_
+#define VLC_VOUT_H_ 1
+
+/**
+ * \file
+ * This file defines common video output structures and functions in vlc
+ */
#include <vlc_es.h>
#include <vlc_filter.h>
int i_status; /**< picture flags */
int i_type; /**< is picture a direct buffer ? */
bool b_slow; /**< is picture in slow memory ? */
- int i_matrix_coefficients; /**< in YUV type, encoding type */
/**@}*/
/** \name Picture management properties
bool b_progressive; /**< is it a progressive frame ? */
unsigned int i_nb_fields; /**< # of displayed fields */
bool b_top_field_first; /**< which field is first */
+ uint8_t *p_q; /**< quantification table */
+ int i_qstride; /**< quantification stride */
+ int i_qtype; /**< quantification style */
/**@}*/
/** The picture heap we are attached to */
struct picture_t *p_next;
};
+/**
+ * This function will create a new picture.
+ * The picture created will implement a default release management compatible
+ * with picture_Hold and picture_Release. This default management will release
+ * picture_sys_t *p_sys field if non NULL.
+ */
+VLC_EXPORT( picture_t *, picture_New, ( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_aspect ) );
+
+/**
+ * This function will force the destruction a picture.
+ * The value of the picture reference count should be 0 before entering this
+ * function.
+ * Unless used for reimplementing pf_release, you should not use this
+ * function but picture_Release.
+ */
+VLC_EXPORT( void, picture_Delete, ( picture_t * ) );
+
+/**
+ * This function will increase the picture reference count.
+ * It will not have any effect on picture obtained from vout
+ */
+static inline void picture_Hold( picture_t *p_picture )
+{
+ if( p_picture->pf_release )
+ p_picture->i_refcount++;
+}
+/**
+ * This function will release a picture.
+ * It will not have any effect on picture obtained from vout
+ */
+static inline void picture_Release( picture_t *p_picture )
+{
+ /* FIXME why do we let pf_release handle the i_refcount ? */
+ if( p_picture->pf_release )
+ p_picture->pf_release( p_picture );
+}
+
+/**
+ * Cleanup quantization matrix data and set to 0
+ */
+static inline void picture_CleanupQuant( picture_t *p_pic )
+{
+ free( p_pic->p_q );
+ p_pic->p_q = NULL;
+ p_pic->i_qstride = 0;
+ p_pic->i_qtype = 0;
+}
+
+/**
+ * This function will copy all picture dynamic properties.
+ */
+static inline void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src )
+{
+ p_dst->date = p_src->date;
+ p_dst->b_force = p_src->b_force;
+
+ p_dst->b_progressive = p_src->b_progressive;
+ p_dst->i_nb_fields = p_src->i_nb_fields;
+ p_dst->b_top_field_first = p_src->b_top_field_first;
+
+ /* FIXME: copy ->p_q and ->p_qstride */
+}
+
+/**
+ * This function will copy the picture pixels.
+ * You can safely copy between pictures that do not have the same size,
+ * only the compatible(smaller) part will be copied.
+ */
+VLC_EXPORT( void, picture_CopyPixels, ( picture_t *p_dst, const picture_t *p_src ) );
+VLC_EXPORT( void, plane_CopyPixels, ( plane_t *p_dst, const plane_t *p_src ) );
+
+/**
+ * This function will copy both picture dynamic properties and pixels.
+ * You have to notice that sometime a simple picture_Hold may do what
+ * you want without the copy overhead.
+ * Provided for convenience.
+ *
+ * \param p_dst pointer to the destination picture.
+ * \param p_src pointer to the source picture.
+ */
+static inline void picture_Copy( picture_t *p_dst, const picture_t *p_src )
+{
+ picture_CopyPixels( p_dst, p_src );
+ picture_CopyProperties( p_dst, p_src );
+}
+
/**
* Video picture heap, either render (to store pictures used
* by the decoder) or output (to store pictures displayed by the vout plugin)
* Flags used to describe the status of a picture
*****************************************************************************/
-/* Picture type */
-#define EMPTY_PICTURE 0 /* empty buffer */
-#define MEMORY_PICTURE 100 /* heap-allocated buffer */
-#define DIRECT_PICTURE 200 /* direct buffer */
+/* Picture type
+ * FIXME are the values meaningfull ? */
+enum
+{
+ EMPTY_PICTURE = 0, /* empty buffer */
+ MEMORY_PICTURE = 100, /* heap-allocated buffer */
+ DIRECT_PICTURE = 200, /* direct buffer */
+};
/* Picture status */
-#define FREE_PICTURE 0 /* free and not allocated */
-#define RESERVED_PICTURE 1 /* allocated and reserved */
-#define RESERVED_DATED_PICTURE 2 /* waiting for DisplayPicture */
-#define RESERVED_DISP_PICTURE 3 /* waiting for a DatePicture */
-#define READY_PICTURE 4 /* ready for display */
-#define DISPLAYED_PICTURE 5 /* been displayed but is linked */
-#define DESTROYED_PICTURE 6 /* allocated but no more used */
+enum
+{
+ FREE_PICTURE, /* free and not allocated */
+ RESERVED_PICTURE, /* allocated and reserved */
+ READY_PICTURE, /* ready for display */
+ DISPLAYED_PICTURE, /* been displayed but is linked */
+ DESTROYED_PICTURE, /* allocated but no more used */
+};
+
+/* Quantification type */
+enum
+{
+ QTYPE_MPEG1,
+ QTYPE_MPEG2,
+ QTYPE_H264,
+};
/*****************************************************************************
* Shortcuts to access image components
*****************************************************************************/
/* Plane indices */
-#define Y_PLANE 0
-#define U_PLANE 1
-#define V_PLANE 2
-#define A_PLANE 3
+enum
+{
+ Y_PLANE = 0,
+ U_PLANE = 1,
+ V_PLANE = 2,
+ A_PLANE = 3,
+};
/* Shortcuts */
#define Y_PIXELS p[Y_PLANE].p_pixels
* @{
*/
+/**
+ * Video subtitle region spu core private
+ */
+typedef struct subpicture_region_private_t subpicture_region_private_t;
+
/**
* Video subtitle region
*
struct subpicture_region_t
{
video_format_t fmt; /**< format of the picture */
- picture_t picture; /**< picture comprising this region */
+ picture_t *p_picture; /**< picture comprising this region */
int i_x; /**< position of region */
int i_y; /**< position of region */
text_style_t *p_style; /**< a description of the text style formatting */
subpicture_region_t *p_next; /**< next region in the list */
- subpicture_region_t *p_cache; /**< modified version of this region */
+ subpicture_region_private_t *p_private; /**< Private data for spu_t *only* */
};
+/* Subpicture region position flags */
+#define SUBPICTURE_ALIGN_LEFT 0x1
+#define SUBPICTURE_ALIGN_RIGHT 0x2
+#define SUBPICTURE_ALIGN_TOP 0x4
+#define SUBPICTURE_ALIGN_BOTTOM 0x8
+#define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
+ SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM )
+
+/**
+ * This function will create a new subpicture region.
+ *
+ * You must use subpicture_region_Delete to destroy it.
+ */
+VLC_EXPORT( subpicture_region_t *, subpicture_region_New, ( const video_format_t *p_fmt ) );
+
+/**
+ * This function will destroy a subpicture region allocated by
+ * subpicture_region_New.
+ *
+ * You may give it NULL.
+ */
+VLC_EXPORT( void, subpicture_region_Delete, ( subpicture_region_t *p_region ) );
+
+/**
+ * This function will destroy a list of subpicture regions allocated by
+ * subpicture_region_New.
+ *
+ * Provided for convenience.
+ */
+VLC_EXPORT( void, subpicture_region_ChainDelete, ( subpicture_region_t *p_head ) );
+
/**
* Video subtitle
*
/** \name Type and flags
Should NOT be modified except by the vout thread */
/**@{*/
- int i_type; /**< type */
- int i_status; /**< flags */
+ int64_t i_order; /** an increasing unique number */
subpicture_t * p_next; /**< next subtitle to be displayed */
/**@}*/
bool b_ephemer; /**< If this flag is set to true the subtitle
will be displayed untill the next one appear */
bool b_fade; /**< enable fading */
- bool b_pausable; /**< subpicture will be paused if
- stream is paused */
/**@}*/
subpicture_region_t *p_region; /**< region list composing this subtitle */
* changed by the video output thread, or simply ignored depending of the
* subtitle type. */
/**@{*/
- int i_x; /**< offset from alignment position */
- int i_y; /**< offset from alignment position */
- int i_width; /**< picture width */
- int i_height; /**< picture height */
- int i_alpha; /**< transparency */
int i_original_picture_width; /**< original width of the movie */
int i_original_picture_height;/**< original height of the movie */
+ bool b_subtitle; /**< the picture is a movie subtitle */
bool b_absolute; /**< position is absolute */
- int i_flags; /**< position flags */
+ int i_alpha; /**< transparency */
/**@}*/
/** Pointer to function that renders this subtitle in a picture */
void ( *pf_destroy ) ( subpicture_t * );
/** Pointer to functions for region management */
- subpicture_region_t * ( *pf_create_region ) ( vlc_object_t *,
- video_format_t * );
- subpicture_region_t * ( *pf_make_region ) ( vlc_object_t *,
- video_format_t *, picture_t * );
- void ( *pf_destroy_region ) ( vlc_object_t *, subpicture_region_t * );
-
- void ( *pf_pre_render ) ( video_format_t *, spu_t *, subpicture_t *, mtime_t );
- subpicture_region_t * ( *pf_update_regions ) ( video_format_t *, spu_t *,
- subpicture_t *, mtime_t );
+ void (*pf_pre_render) ( spu_t *, subpicture_t *, const video_format_t * );
+ void (*pf_update_regions)( spu_t *,
+ subpicture_t *, const video_format_t *, mtime_t );
/** Private data - the subtitle plugin might want to put stuff here to
* keep track of the subpicture */
subpicture_sys_t *p_sys; /* subpicture data */
};
-/* Subpicture type */
-#define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
-#define MEMORY_SUBPICTURE 100 /* subpicture stored in memory */
-
-/* Default subpicture channel ID */
-#define DEFAULT_CHAN 1
-/* Subpicture status */
-#define FREE_SUBPICTURE 0 /* free and not allocated */
-#define RESERVED_SUBPICTURE 1 /* allocated and reserved */
-#define READY_SUBPICTURE 2 /* ready for display */
+/**
+ * This function create a new empty subpicture.
+ *
+ * You must use subpicture_Delete to destroy it.
+ */
+VLC_EXPORT( subpicture_t *, subpicture_New, ( void ) );
-/* Subpicture position flags */
-#define SUBPICTURE_ALIGN_LEFT 0x1
-#define SUBPICTURE_ALIGN_RIGHT 0x2
-#define SUBPICTURE_ALIGN_TOP 0x4
-#define SUBPICTURE_ALIGN_BOTTOM 0x8
-#define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
- SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM )
+/**
+ * This function delete a subpicture created by subpicture_New.
+ * You may give it NULL.
+ */
+VLC_EXPORT( void, subpicture_Delete, ( subpicture_t *p_subpic ) );
-/* Subpicture rendered flag - should only be used by vout_subpictures */
-#define SUBPICTURE_RENDERED 0x10
+/* Default subpicture channel ID */
+#define DEFAULT_CHAN 1
/*****************************************************************************
* Prototypes
*****************************************************************************/
-/**
- * Copy the source picture onto the destination picture.
- * \param p_this a vlc object
- * \param p_dst pointer to the destination picture.
- * \param p_src pointer to the source picture.
- */
-#define vout_CopyPicture(a,b,c) __vout_CopyPicture(VLC_OBJECT(a),b,c)
-VLC_EXPORT( void, __vout_CopyPicture, ( vlc_object_t *p_this, picture_t *p_dst, picture_t *p_src ) );
-
/**
* Initialise different fields of a picture_t (but does not allocate memory).
* \param p_this a vlc object
* @{
*/
+/**
+ * Video ouput thread private structure
+ */
+typedef struct vout_thread_sys_t vout_thread_sys_t;
+
/**
* Video output thread descriptor
*
/** \name Thread properties and locks */
/**@{*/
vlc_mutex_t picture_lock; /**< picture heap lock */
- vlc_mutex_t subpicture_lock; /**< subpicture heap lock */
vlc_mutex_t change_lock; /**< thread change lock */
- vlc_mutex_t vfilter_lock; /**< video filter2 change lock */
vout_sys_t * p_sys; /**< system output method */
/**@}*/
/**@{*/
uint16_t i_changes; /**< changes made to the thread.
\see \ref vout_changes */
- float f_gamma; /**< gamma */
- bool b_grayscale; /**< color or grayscale display */
- bool b_info; /**< print additional information */
- bool b_interface; /**< render interface */
bool b_scale; /**< allow picture scaling */
bool b_fullscreen; /**< toogle fullscreen display */
- uint32_t render_time; /**< last picture render time */
unsigned int i_window_width; /**< video window width */
unsigned int i_window_height; /**< video window height */
unsigned int i_alignment; /**< video alignment in window */
- unsigned int i_par_num; /**< monitor pixel aspect-ratio */
- unsigned int i_par_den; /**< monitor pixel aspect-ratio */
struct vout_window_t *p_window; /**< window for embedded vout (if any) */
/**@}*/
int ( *pf_control ) ( vout_thread_t *, int, va_list );
/**@}*/
- /** \name Statistics
- * These numbers are not supposed to be accurate, but are a
- * good indication of the thread status */
- /**@{*/
- count_t c_fps_samples; /**< picture counts */
- mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /**< FPS samples dates */
- /**@}*/
-
/** \name Video heap and translation tables */
/**@{*/
int i_heap_size; /**< heap size */
picture_heap_t render; /**< rendered pictures */
picture_heap_t output; /**< direct buffers */
- bool b_direct; /**< rendered are like direct ? */
- filter_t *p_chroma; /**< translation tables */
video_format_t fmt_render; /* render format (from the decoder) */
video_format_t fmt_in; /* input (modified render) format */
/* Subpicture unit */
spu_t *p_spu;
- /* Statistics */
- count_t c_loops;
- count_t c_pictures, c_late_pictures;
- mtime_t display_jitter; /**< average deviation from the PTS */
- count_t c_jitter_samples; /**< number of samples used
- for the calculation of the
- jitter */
- /** delay created by internal caching */
- int i_pts_delay;
-
- /* Filter chain */
- char *psz_filter_chain;
- bool b_filter_change;
-
- /* Video filter2 chain */
- filter_chain_t *p_vf2_chain;
- char *psz_vf2;
-
- /* Misc */
- bool b_snapshot; /**< take one snapshot on the next loop */
-
/* Video output configuration */
config_chain_t *p_cfg;
- /* Show media title on videoutput */
- bool b_title_show;
- mtime_t i_title_timeout;
- int i_title_position;
+ /* Private vout_thread data */
+ vout_thread_sys_t *p;
};
#define I_OUTPUTPICTURES p_vout->output.i_pictures
*/
/** b_info changed */
#define VOUT_INFO_CHANGE 0x0001
-/** b_grayscale changed */
-#define VOUT_GRAYSCALE_CHANGE 0x0002
/** b_interface changed */
#define VOUT_INTF_CHANGE 0x0004
/** b_scale changed */
#define VOUT_SCALE_CHANGE 0x0008
-/** gamma changed */
-#define VOUT_GAMMA_CHANGE 0x0010
/** b_cursor changed */
#define VOUT_CURSOR_CHANGE 0x0020
/** b_fullscreen changed */
/*****************************************************************************
* 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.
+ *
+ * The purpose of this function is to avoid unnecessary creation/destruction of
+ * vout (and to allow optional vout reusing).
+ *
+ * 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
+ */
#define vout_Request(a,b,c) __vout_Request(VLC_OBJECT(a),b,c)
-VLC_EXPORT( vout_thread_t *, __vout_Request, ( vlc_object_t *, vout_thread_t *, video_format_t * ) );
+VLC_EXPORT( vout_thread_t *, __vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) );
+
+/**
+ * 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
+ */
#define vout_Create(a,b) __vout_Create(VLC_OBJECT(a),b)
-VLC_EXPORT( vout_thread_t *, __vout_Create, ( vlc_object_t *, video_format_t * ) );
-VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
+VLC_EXPORT( vout_thread_t *, __vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) );
+
+/**
+ * This function will close a vout created by vout_Create or 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().
+ *
+ * \param p_vout the vout to close
+ */
+VLC_EXPORT( void, vout_Close, ( vout_thread_t *p_vout ) );
+
+/**
+ * This function will close a vout created by vout_Create
+ * and then release it.
+ *
+ * \param p_vout the vout to close and release
+ */
+static inline void vout_CloseAndRelease( vout_thread_t *p_vout )
+{
+ vout_Close( p_vout );
+ vlc_object_release( p_vout );
+}
+/* */
VLC_EXPORT( int, vout_ChromaCmp, ( uint32_t, uint32_t ) );
VLC_EXPORT( picture_t *, vout_CreatePicture, ( vout_thread_t *, bool, bool, unsigned int ) );
VLC_EXPORT( void, vout_InitFormat, ( video_frame_format_t *, uint32_t, int, int, 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_DatePicture, ( vout_thread_t *, picture_t *, mtime_t ) );
VLC_EXPORT( void, vout_LinkPicture, ( vout_thread_t *, picture_t * ) );
VLC_EXPORT( void, vout_UnlinkPicture, ( vout_thread_t *, picture_t * ) );
VLC_EXPORT( void, vout_PlacePicture, ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
-picture_t * vout_RenderPicture ( vout_thread_t *, picture_t *,
- subpicture_t * );
VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) );