-/**********************************************************************
- * 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.
- * @{
- */
-
-#include <vlc_vout.h>
-
-/**
- * Subpicture unit descriptor
- */
-struct spu_t
-{
- VLC_COMMON_MEMBERS
-
- vlc_mutex_t subpicture_lock; /**< subpicture heap lock */
- subpicture_t p_subpicture[VOUT_MAX_SUBPICTURES]; /**< 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_yuvp; /**< scaling module for YUVP */
- filter_t *p_scale; /**< scaling module (all but YUVP) */
- bool b_force_crop; /**< force cropping of subpicture */
- int i_crop_x, i_crop_y, i_crop_width, i_crop_height; /**< cropping */
-
- int i_margin; /**< force position of a subpicture */
- bool b_force_palette; /**< force palette of subpicture */
- uint8_t palette[4][4]; /**< forced palette */
-
- int ( *pf_control ) ( spu_t *, int, va_list );
-
- /* Supciture filters */
- filter_chain_t *p_chain;
-};
-
-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;
-}
-
-static inline int spu_Control( spu_t *p_spu, int i_query, ... )
-{
- va_list args;
- int i_result;
-
- va_start( args, i_query );
- i_result = spu_vaControl( p_spu, i_query, args );
- va_end( args );
- return i_result;
-}
-
-enum spu_query_e
-{
- SPU_CHANNEL_REGISTER, /* arg1= int * res= */
- SPU_CHANNEL_CLEAR /* arg1= int res= */
-};
-
-#define spu_Create(a) __spu_Create(VLC_OBJECT(a))
-VLC_EXPORT( spu_t *, __spu_Create, ( vlc_object_t * ) );
-VLC_EXPORT( int, spu_Init, ( spu_t * ) );
-VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
-void spu_Attach( spu_t *, vlc_object_t *, bool );
-
-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_MakeRegion(a,b,c) __spu_MakeRegion(VLC_OBJECT(a),b,c)
-VLC_EXPORT( subpicture_region_t *,__spu_MakeRegion, ( vlc_object_t *, video_format_t *, picture_t * ) );
-#define spu_DestroyRegion(a,b) __spu_DestroyRegion(VLC_OBJECT(a),b)
-VLC_EXPORT( void, __spu_DestroyRegion, ( vlc_object_t *, subpicture_region_t * ) );
-VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t display_date, bool b_paused, bool b_subtitle_only ) );
-VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, video_format_t *, picture_t *, subpicture_t *, int, int ) );
-
-/** @}*/
-