* This file defines common video output structures and functions in vlc
*/
-#include <vlc_es.h>
+#include <vlc_picture.h>
#include <vlc_filter.h>
-
-/** Description of a planar graphic field */
-typedef struct plane_t
-{
- uint8_t *p_pixels; /**< Start of the plane's data */
-
- /* Variables used for fast memcpy operations */
- int i_lines; /**< Number of lines, including margins */
- int i_pitch; /**< Number of bytes in a line, including margins */
-
- /** Size of a macropixel, defaults to 1 */
- int i_pixel_pitch;
-
- /* Variables used for pictures with margins */
- int i_visible_lines; /**< How many visible lines are there ? */
- int i_visible_pitch; /**< How many visible pixels are there ? */
-
-} plane_t;
-
-/**
- * Video picture
- *
- * Any picture destined to be displayed by a video output thread should be
- * stored in this structure from it's creation to it's effective display.
- * Picture type and flags should only be modified by the output thread. Note
- * that an empty picture MUST have its flags set to 0.
- */
-struct picture_t
-{
- /**
- * The properties of the picture
- */
- video_frame_format_t format;
-
- /** Picture data - data can always be freely modified, but p_data may
- * NEVER be modified. A direct buffer can be handled as the plugin
- * wishes, it can even swap p_pixels buffers. */
- uint8_t *p_data;
- void *p_data_orig; /**< pointer before memalign */
- plane_t p[ VOUT_MAX_PLANES ]; /**< description of the planes */
- int i_planes; /**< number of allocated planes */
-
- /** \name Type and flags
- * Should NOT be modified except by the vout thread
- * @{*/
- 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
- * These properties can be modified using the video output thread API,
- * but should never be written directly */
- /**@{*/
- unsigned i_refcount; /**< link reference counter */
- mtime_t date; /**< display date */
- bool b_force;
- /**@}*/
-
- /** \name Picture dynamic properties
- * Those properties can be changed by the decoder
- * @{
- */
- 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 */
- picture_heap_t* p_heap;
-
- /* Some vouts require the picture to be locked before it can be modified */
- int (* pf_lock) ( vout_thread_t *, picture_t * );
- int (* pf_unlock) ( vout_thread_t *, picture_t * );
-
- /** Private data - the video output plugin might want to put stuff here to
- * keep track of the picture */
- picture_sys_t * p_sys;
-
- /** This way the picture_Release can be overloaded */
- void (*pf_release)( picture_t * );
-
- /** Next picture in a FIFO a pictures */
- struct picture_t *p_next;
-};
-
-/**
- * This function will create a new picture.
- * The picture created will implement a default release management compatible
- * with picture_Yield 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_Yield( 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_Yield may do what
- * you want without the copy overhead.
- * Provided for convenience.
- */
-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 );
-}
+#include <vlc_subpicture.h>
/**
* Video picture heap, either render (to store pictures used
void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
};
-/*****************************************************************************
- * 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 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 */
-
-/* Quantification type */
-#define QTYPE_MPEG1 0
-#define QTYPE_MPEG2 1
-#define QTYPE_H264 2
-
-/*****************************************************************************
- * Shortcuts to access image components
- *****************************************************************************/
-
-/* Plane indices */
-#define Y_PLANE 0
-#define U_PLANE 1
-#define V_PLANE 2
-#define A_PLANE 3
-
-/* Shortcuts */
-#define Y_PIXELS p[Y_PLANE].p_pixels
-#define Y_PITCH p[Y_PLANE].i_pitch
-#define U_PIXELS p[U_PLANE].p_pixels
-#define U_PITCH p[U_PLANE].i_pitch
-#define V_PIXELS p[V_PLANE].p_pixels
-#define V_PITCH p[V_PLANE].i_pitch
-#define A_PIXELS p[A_PLANE].p_pixels
-#define A_PITCH p[A_PLANE].i_pitch
-
-/**
- * \defgroup subpicture Video Subpictures
- * Subpictures are pictures that should be displayed on top of the video, like
- * subtitles and OSD
- * \ingroup video_output
- * @{
- */
-
-/**
- * Video subtitle region
- *
- * A subtitle region is defined by a picture (graphic) and its rendering
- * coordinates.
- * Subtitles contain a list of regions.
- */
-struct subpicture_region_t
-{
- video_format_t fmt; /**< format of the picture */
- picture_t picture; /**< picture comprising this region */
-
- int i_x; /**< position of region */
- int i_y; /**< position of region */
- int i_align; /**< alignment within a region */
- int i_alpha; /**< transparency */
-
- char *psz_text; /**< text string comprising this region */
- char *psz_html; /**< HTML version of subtitle (NULL = use psz_text) */
- 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 */
-};
-
-/**
- * Video subtitle
- *
- * Any subtitle destined to be displayed by a video output thread should
- * be stored in this structure from it's creation to it's effective display.
- * Subtitle type and flags should only be modified by the output thread. Note
- * that an empty subtitle MUST have its flags set to 0.
- */
-struct subpicture_t
-{
- /** \name Channel ID */
- /**@{*/
- int i_channel; /**< subpicture channel ID */
- /**@}*/
-
- /** \name Type and flags
- Should NOT be modified except by the vout thread */
- /**@{*/
- int i_type; /**< type */
- int i_status; /**< flags */
- subpicture_t * p_next; /**< next subtitle to be displayed */
- /**@}*/
-
- /** \name Date properties */
- /**@{*/
- mtime_t i_start; /**< beginning of display date */
- mtime_t i_stop; /**< end of display date */
- 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 */
- /**@}*/
-
- subpicture_region_t *p_region; /**< region list composing this subtitle */
-
- /** \name Display properties
- * These properties are only indicative and may be
- * 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_alpha; /**< transparency */
- int i_original_picture_width; /**< original width of the movie */
- int i_original_picture_height;/**< original height of the movie */
- bool b_absolute; /**< position is absolute */
- int i_flags; /**< position flags */
- bool b_subtitle; /**< the picture is a movie subtitle */
- /**@}*/
-
- /** Pointer to function that renders this subtitle in a picture */
- void ( *pf_render ) ( vout_thread_t *, picture_t *, const subpicture_t * );
- /** Pointer to function that cleans up the private data of this subtitle */
- 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 * );
- void ( *pf_update_regions ) ( video_format_t *, spu_t *,
- subpicture_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 */
-
-/* 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 )
-
-/* Subpicture rendered flag - should only be used by vout_subpictures */
-#define SUBPICTURE_RENDERED 0x10
-
/*****************************************************************************
* 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
- * \param p_pic pointer to the picture structure.
- * \param i_chroma the wanted chroma for the picture.
- * \param i_width the wanted width for the picture.
- * \param i_height the wanted height for the picture.
- * \param i_aspect the wanted aspect ratio for the picture.
- */
-#define vout_InitPicture(a,b,c,d,e,f) \
- __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
-VLC_EXPORT( int, __vout_InitPicture, ( vlc_object_t *p_this, picture_t *p_pic, uint32_t i_chroma, int i_width, int i_height, int i_aspect ) );
-
/**
* Initialise different fields of a picture_t and allocates the picture buffer.
* \param p_this a vlc object
* \param i_height the wanted height for the picture.
* \param i_aspect the wanted aspect ratio for the picture.
*/
-#define vout_AllocatePicture(a,b,c,d,e,f) \
- __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
-VLC_EXPORT( int, __vout_AllocatePicture,( vlc_object_t *p_this, picture_t *p_pic, uint32_t i_chroma, int i_width, int i_height, int i_aspect ) );
+#define vout_AllocatePicture(a,b,c,d,e,f,g) \
+ __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f,g)
+VLC_EXPORT( int, __vout_AllocatePicture,( vlc_object_t *p_this, picture_t *p_pic, uint32_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den ) );
/**
* @{
*/
+/**
+ * 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 b_fullscreen:1; /**< toogle fullscreen display */
+ unsigned b_autoscale:1; /**< auto scaling picture or not */
+ unsigned b_on_top:1; /**< stay always on top of other windows */
+ int i_zoom; /**< scaling factor if no auto */
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) */
/**@}*/
/** \name Plugin used and shortcuts to access its capabilities */
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 */
+/** b_autoscale changed */
#define VOUT_SCALE_CHANGE 0x0008
-/** gamma changed */
-#define VOUT_GAMMA_CHANGE 0x0010
+/** b_on_top changed */
+#define VOUT_ON_TOP_CHANGE 0x0010
/** b_cursor changed */
#define VOUT_CURSOR_CHANGE 0x0020
/** b_fullscreen changed */
#define VOUT_FULLSCREEN_CHANGE 0x0040
+/** i_zoom changed */
+#define VOUT_ZOOM_CHANGE 0x0080
/** size changed */
#define VOUT_SIZE_CHANGE 0x0200
/** depth changed */
#define MAX_JITTER_SAMPLES 20
+/* scaling factor (applied to i_zoom in vout_thread_t) */
+#define ZOOM_FP_FACTOR 1000
+
/*****************************************************************************
* Prototypes
*****************************************************************************/
vlc_object_release( p_vout );
}
+/**
+ * This function will handle a snapshot request.
+ *
+ * pp_image, pp_picture and p_fmt can be NULL otherwise they will be
+ * set with returned value in case of success.
+ *
+ * pp_image will hold an encoded picture in psz_format format.
+ *
+ * i_timeout specifies the time the function will wait for a snapshot to be
+ * available.
+ *
+ */
+VLC_EXPORT( int, vout_GetSnapshot, ( vout_thread_t *p_vout,
+ block_t **pp_image, picture_t **pp_picture,
+ video_format_t *p_fmt,
+ const char *psz_format, mtime_t i_timeout ) );
+
/* */
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 * ) );
+VLC_EXPORT( void, vout_PlacePicture, ( const vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
-/* DO NOT use vout_RenderPicture unless you are in src/video_ouput */
-picture_t * vout_RenderPicture ( vout_thread_t *, picture_t *,
- subpicture_t * );
-
-/* DO NOT use vout_CountPictureAvailable unless your are in src/input/dec.c (no exception) */
-int vout_CountPictureAvailable( vout_thread_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( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
-VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) );
-VLC_EXPORT( void, vout_ReleaseWindow, ( vout_thread_t *, void * ) );
-VLC_EXPORT( int, vout_ControlWindow, ( vout_thread_t *, void *, int, va_list ) );
void vout_IntfInit( vout_thread_t * );
-VLC_EXPORT( int, vout_Snapshot, ( vout_thread_t *p_vout, picture_t *p_pic ) );
-VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,bool , bool ) );
+VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, const char *,bool , bool ) );
static inline int vout_vaControl( vout_thread_t *p_vout, int i_query,
enum output_query_e
{
- VOUT_GET_SIZE, /* arg1= unsigned int*, arg2= unsigned int*, res= */
VOUT_SET_SIZE, /* arg1= unsigned int, arg2= unsigned int, res= */
VOUT_SET_STAY_ON_TOP, /* arg1= bool res= */
- VOUT_REPARENT,
- VOUT_SNAPSHOT,
- VOUT_CLOSE,
- VOUT_SET_FOCUS, /* arg1= bool res= */
VOUT_SET_VIEWPORT, /* arg1= view rect, arg2=clip rect, res= */
VOUT_REDRAW_RECT, /* arg1= area rect, res= */
};
-typedef struct snapshot_t {
- char *p_data; /* Data area */
-
- int i_width; /* In pixels */
- int i_height; /* In pixels */
- int i_datasize; /* In bytes */
- mtime_t date; /* Presentation time */
-} snapshot_t;
-
/**@}*/
#endif /* _VLC_VIDEO_H */
projects / vlc / blobdiff