vlc_spu.h
上传用户:riyaled888
上传日期:2009-03-27
资源大小:7338k
文件大小:4k
源码类别:

多媒体

开发平台:

MultiPlatform

  1. /*****************************************************************************
  2.  * vlc_spu.h : subpicture unit
  3.  *****************************************************************************
  4.  * Copyright (C) 1999, 2000 VideoLAN
  5.  * $Id: vlc_spu.h 8717 2004-09-17 09:11:50Z gbazin $
  6.  *
  7.  * Authors: Gildas Bazin <gbazin@videolan.org>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify
  10.  * it under the terms of the GNU General Public License as published by
  11.  * the Free Software Foundation; either version 2 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17.  * GNU General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU General Public License
  20.  * along with this program; if not, write to the Free Software
  21.  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22.  *****************************************************************************/
  23. /**
  24.  * defgroup spu Subpicture Unit
  25.  * This module describes the programming interface for the subpicture unit.
  26.  * It includes functions allowing to create/destroy an spu, create/destroy
  27.  * subpictures and render them.
  28.  * @{
  29.  */
  30. /**
  31.  * Subpicture unit descriptor
  32.  */
  33. struct spu_t
  34. {
  35.     VLC_COMMON_MEMBERS
  36.     vlc_mutex_t  subpicture_lock;                  /**< subpicture heap lock */
  37.     subpicture_t p_subpicture[VOUT_MAX_PICTURES];           /**< subpictures */
  38.     int i_channel;             /**< number of subpicture channels registered */
  39.     filter_t *p_blend;                            /**< alpha blending module */
  40.     filter_t *p_text;                              /**< text renderer module */
  41.     filter_t *p_scale;                                   /**< scaling module */
  42.     vlc_bool_t b_force_crop;               /**< force cropping of subpicture */
  43.     int i_crop_x, i_crop_y, i_crop_width, i_crop_height;       /**< cropping */
  44.     int i_margin;                        /**< force position of a subpicture */
  45.     vlc_bool_t b_force_alpha;         /**< force alpha palette of subpicture */
  46.     uint8_t pi_alpha[4];                           /**< forced alpha palette */
  47.     int ( *pf_control ) ( spu_t *, int, va_list );
  48.     /* Supciture filters */
  49.     filter_t *pp_filter[10];
  50.     int      i_filter;
  51. };
  52. static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
  53. {
  54.     if( p_spu->pf_control )
  55.         return p_spu->pf_control( p_spu, i_query, args );
  56.     else
  57.         return VLC_EGENERIC;
  58. }
  59. static inline int spu_Control( spu_t *p_spu, int i_query, ... )
  60. {
  61.     va_list args;
  62.     int i_result;
  63.     va_start( args, i_query );
  64.     i_result = spu_vaControl( p_spu, i_query, args );
  65.     va_end( args );
  66.     return i_result;
  67. }
  68. enum spu_query_e
  69. {
  70.     SPU_CHANNEL_REGISTER,         /* arg1= int *   res=    */
  71.     SPU_CHANNEL_CLEAR             /* arg1= int     res=    */
  72. };
  73. /**
  74.  * addtogroup subpicture
  75.  * @{
  76.  */
  77. #define spu_Create(a) __spu_Create(VLC_OBJECT(a))
  78. VLC_EXPORT( spu_t *, __spu_Create, ( vlc_object_t * ) );
  79. VLC_EXPORT( int, spu_Init, ( spu_t * ) );
  80. VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
  81. void spu_Attach( spu_t *, vlc_object_t *, vlc_bool_t );
  82. VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) );
  83. VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) );
  84. VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
  85. #define spu_CreateRegion(a,b) __spu_CreateRegion(VLC_OBJECT(a),b)
  86. VLC_EXPORT( subpicture_region_t *,__spu_CreateRegion, ( vlc_object_t *, video_format_t * ) );
  87. #define spu_DestroyRegion(a,b) __spu_DestroyRegion(VLC_OBJECT(a),b)
  88. VLC_EXPORT( void, __spu_DestroyRegion, ( vlc_object_t *, subpicture_region_t * ) );
  89. VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t ) );
  90. VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *,  video_format_t *, picture_t *, picture_t *, subpicture_t *, int, int ) );
  91. /** @}*/
  92. /**
  93.  * @}
  94.  */