* This header is required by all modules which have to handle pictures. It
* includes all common video types and constants.
*****************************************************************************
- * Copyright (C) 1999, 2000 VideoLAN
- * $Id: vlc_video.h,v 1.3 2003/10/04 15:51:22 sigmunau Exp $
+ * Copyright (C) 1999 - 2005 VideoLAN
+ * $Id$
*
* Authors: Vincent Seguin <seguin@via.ecp.fr>
*
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
- *
+ *
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
*****************************************************************************/
+#ifndef _VLC_VIDEO_H
+#define _VLC_VIDEO_H 1
+
+#include "vlc_es.h"
/**
* Description of a planar graphic field
uint8_t *p_pixels; /**< Start of the plane's data */
/* Variables used for fast memcpy operations */
- int i_lines; /**< Number of lines */
+ 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;
*/
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. */
* @{*/
int i_status; /**< picture flags */
int i_type; /**< is picture a direct buffer ? */
+ vlc_bool_t b_slow; /**< is picture in slow memory ? */
int i_matrix_coefficients; /**< in YUV type, encoding type */
/**@}*/
unsigned int i_nb_fields; /**< # of displayed fields */
vlc_bool_t b_top_field_first; /**< which field is first */
/**@}*/
-
+
/** The picture heap we are attached to */
picture_heap_t* p_heap;
/** 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;
};
/**
#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 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
* @{
*/
+/**
+ * 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 */
+
+ char *psz_text; /**< text string comprising this region */
+ int i_text_color; /**< text color (RGB native endianess) */
+ int i_text_alpha; /**< text transparency */
+ int i_text_size; /**< text size */
+ int i_text_align; /**< horizontal alignment hint for */
+
+ subpicture_region_t *p_next; /**< next region in the list */
+ subpicture_region_t *p_cache; /**< modified version of this region */
+};
+
/**
* Video subtitle
*
*/
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 */
/**@{*/
/**@{*/
mtime_t i_start; /**< beginning of display date */
mtime_t i_stop; /**< end of display date */
- vlc_bool_t b_ephemer; /**< If this flag is set to true
- the subtitle will be displayed
- untill the next one appear */
+ vlc_bool_t b_ephemer; /**< If this flag is set to true the subtitle
+ will be displayed untill the next one appear */
+ vlc_bool_t 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_width; /**< picture width */
- int i_height; /**< picture height */
- /**@}*/
-#if 0
- /* Additionnal properties depending of the subpicture type */
- union
- {
- /* Text subpictures properties - text is stored in data area, in ASCIIZ
- * format */
- struct
- {
- vout_font_t * p_font; /* font, NULL for default */
- int i_style; /* text style */
- uint32_t i_char_color; /* character color */
- uint32_t i_border_color; /* border color */
- uint32_t i_bg_color; /* background color */
- } text;
- } type;
-#endif
+ 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 */
+ int b_absolute; /**< position is absolute */
+ int i_flags; /**< position flags */
+ /**@}*/
/** 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 * );
+
/** Private data - the subtitle plugin might want to put stuff here to
* keep track of the subpicture */
subpicture_sys_t *p_sys; /* subpicture data */
#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
+
+/*****************************************************************************
+ * Prototypes
+ *****************************************************************************/
+/**
+ * vout_CopyPicture
+ *
+ * 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 ) );
+
+/**
+ * vout_InitPicture
+ *
+ * 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 ) );
+
+/**
+ * vout_AllocatePicture
+ *
+ * Initialise different fields of a picture_t and allocates the picture buffer.
+ * \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_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 ) );
+
/**@}*/
+
+#endif /* _VLC_VIDEO_H */
projects / vlc / blobdiff