/*****************************************************************************
- * vlc_spu.h : subpicture unit
+ * vlc_spu.h: spu_t definition and functions.
*****************************************************************************
- * Copyright (C) 1999, 2000 VideoLAN
+ * Copyright (C) 1999-2010 the VideoLAN team
+ * Copyright (C) 2010 Laurent Aimar
* $Id$
*
* Authors: Gildas Bazin <gbazin@videolan.org>
+ * Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
+#ifndef VLC_SPU_H
+#define VLC_SPU_H 1
+
+#include <vlc_subpicture.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**********************************************************************
+ * Base SPU structures
+ **********************************************************************/
/**
* \defgroup spu Subpicture Unit
* This module describes the programming interface for the subpicture unit.
- * It includes functions allowing to create/destroy an spu, create/destroy
- * subpictures and render them.
+ * It includes functions allowing to create/destroy an spu, and render
+ * subpictures.
* @{
*/
+typedef struct spu_private_t spu_private_t;
+
+/* Default subpicture channel ID */
+#define SPU_DEFAULT_CHANNEL (1)
+
/**
* Subpicture unit descriptor
*/
{
VLC_COMMON_MEMBERS
- vlc_mutex_t subpicture_lock; /**< subpicture heap lock */
- subpicture_t p_subpicture[VOUT_MAX_PICTURES]; /**< subpictures */
- int i_channel; /**< number of subpicture channels registered */
-
- filter_t *p_blend; /**< alpha blending module */
- filter_t *p_text; /**< text renderer module */
- filter_t *p_scale; /**< scaling module */
-
- vlc_bool_t b_force_crop; /**< force cropping of subpicture */
- int i_crop_x, i_crop_y, i_crop_width, i_crop_height; /**< cropping */
+ spu_private_t *p;
+};
- int i_margin; /**< force position of a subpicture */
- vlc_bool_t b_force_alpha; /**< force alpha palette of subpicture */
- uint8_t pi_alpha[4]; /**< forced alpha palette */
+VLC_EXPORT( spu_t *, spu_Create, ( vlc_object_t * ) );
+#define spu_Create(a) spu_Create(VLC_OBJECT(a))
+VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
- int ( *pf_control ) ( spu_t *, int, va_list );
-};
+/**
+ * This function sends a subpicture to the spu_t core.
+ *
+ * You cannot use the provided subpicture anymore. The spu_t core
+ * will destroy it at its convenience.
+ */
+VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
-static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
-{
- if( p_spu->pf_control )
- return p_spu->pf_control( p_spu, i_query, args );
- else
- return VLC_EGENERIC;
-}
+/**
+ * This function asks the spu_t core a list of subpictures to display.
+ *
+ * The returned list can only be used by spu_RenderSubpictures.
+ */
+VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t render_subtitle_date, bool b_subtitle_only ) );
-static inline int spu_Control( spu_t *p_spu, int i_query, ... )
-{
- va_list args;
- int i_result;
+/**
+ * This function renders a list of subpicture_t on the provided picture.
+ *
+ * \param p_fmt_dst is the format of the destination picture.
+ * \param p_fmt_src is the format of the original(source) video.
+ */
+VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, picture_t *, const video_format_t *p_fmt_dst, subpicture_t *p_list, const video_format_t *p_fmt_src, mtime_t render_subtitle_date ) );
- va_start( args, i_query );
- i_result = spu_vaControl( p_spu, i_query, args );
- va_end( args );
- return i_result;
-}
+/**
+ * It registers a new SPU channel.
+ */
+VLC_EXPORT( int, spu_RegisterChannel, ( spu_t * ) );
-enum spu_query_e
-{
- SPU_CHANNEL_REGISTER, /* arg1= int * res= */
- SPU_CHANNEL_CLEAR /* arg1= int res= */
-};
+/**
+ * It clears all subpictures associated to a SPU channel.
+ */
+VLC_EXPORT( void, spu_ClearChannel, ( spu_t *, int ) );
/**
- * \addtogroup subpicture
- * @{
+ * It changes the sub filters list
*/
-#define spu_Init(a) __spu_Init(VLC_OBJECT(a))
-VLC_EXPORT( spu_t *, __spu_Init, ( vlc_object_t * ) );
-VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
-void spu_Attach( spu_t *, vlc_object_t *, vlc_bool_t );
+VLC_EXPORT( void, spu_ChangeFilters, ( spu_t *, const char * ) );
-VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) );
-VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) );
-VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
+/** @}*/
-#define spu_CreateRegion(a,b) __spu_CreateRegion(VLC_OBJECT(a),b)
-VLC_EXPORT( subpicture_region_t *,__spu_CreateRegion, ( vlc_object_t *, video_format_t * ) );
-#define spu_DestroyRegion(a,b) __spu_DestroyRegion(VLC_OBJECT(a),b)
-VLC_EXPORT( void, __spu_DestroyRegion, ( vlc_object_t *, subpicture_region_t * ) );
+#ifdef __cplusplus
+}
+#endif
-VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t ) );
-VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, video_format_t *, picture_t *, picture_t *, subpicture_t *, int, int ) );
+#endif /* VLC_SPU_H */
-/** @}*/
-/**
- * @}
- */
projects / vlc / blobdiff