include/vlc_subpicture.h

   1 /*****************************************************************************
   2  * vlc_subpicture.h: subpicture definitions
   3  *****************************************************************************
   4  * Copyright (C) 1999 - 2009 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   8  *          Samuel Hocevar <sam@via.ecp.fr>
   9  *          Olivier Aubert <oaubert 47 videolan d07 org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU Lesser General Public License as published by
  13  * the Free Software Foundation; either version 2.1 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19  * GNU Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * along with this program; if not, write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 #ifndef VLC_SUBPICTURE_H
  27 #define VLC_SUBPICTURE_H 1
  28
  29 /**
  30  * \file
  31  * This file defines subpicture structures and functions in vlc
  32  */
  33
  34 #include <vlc_picture.h>
  35 #include <vlc_text_style.h>
  36
  37 /**
  38  * \defgroup subpicture Video Subpictures
  39  * Subpictures are pictures that should be displayed on top of the video, like
  40  * subtitles and OSD
  41  * \ingroup video_output
  42  * @{
  43  */
  44
  45 /**
  46  * Video subtitle region spu core private
  47  */
  48 typedef struct subpicture_region_private_t subpicture_region_private_t;
  49
  50 /**
  51  * Video subtitle region
  52  *
  53  * A subtitle region is defined by a picture (graphic) and its rendering
  54  * coordinates.
  55  * Subtitles contain a list of regions.
  56  */
  57 struct subpicture_region_t
  58 {
  59     video_format_t  fmt;                          /**< format of the picture */
  60     picture_t       *p_picture;          /**< picture comprising this region */
  61
  62     int             i_x;                             /**< position of region */
  63     int             i_y;                             /**< position of region */
  64     int             i_align;                  /**< alignment within a region */
  65     int             i_alpha;                               /**< transparency */
  66
  67     char            *psz_text;       /**< text string comprising this region */
  68     char            *psz_html;       /**< HTML version of subtitle (NULL = use psz_text) */
  69     text_style_t    *p_style;        /**< a description of the text style formatting */
  70     bool            b_renderbg;      /**< render black background under text */
  71
  72     subpicture_region_t *p_next;                /**< next region in the list */
  73     subpicture_region_private_t *p_private;  /**< Private data for spu_t *only* */
  74 };
  75
  76 /* Subpicture region position flags */
  77 #define SUBPICTURE_ALIGN_LEFT 0x1
  78 #define SUBPICTURE_ALIGN_RIGHT 0x2
  79 #define SUBPICTURE_ALIGN_TOP 0x4
  80 #define SUBPICTURE_ALIGN_BOTTOM 0x8
  81 #define SUBPICTURE_ALIGN_LEAVETEXT 0x10 /**< Align the subpicture, but not the text inside */
  82 #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
  83                                 SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM| \
  84                                 SUBPICTURE_ALIGN_LEAVETEXT )
  85 /**
  86  * This function will create a new subpicture region.
  87  *
  88  * You must use subpicture_region_Delete to destroy it.
  89  */
  90 VLC_API subpicture_region_t * subpicture_region_New( const video_format_t *p_fmt );
  91
  92 /**
  93  * This function will destroy a subpicture region allocated by
  94  * subpicture_region_New.
  95  *
  96  * You may give it NULL.
  97  */
  98 VLC_API void subpicture_region_Delete( subpicture_region_t *p_region );
  99
 100 /**
 101  * This function will destroy a list of subpicture regions allocated by
 102  * subpicture_region_New.
 103  *
 104  * Provided for convenience.
 105  */
 106 VLC_API void subpicture_region_ChainDelete( subpicture_region_t *p_head );
 107
 108 /**
 109  *
 110  */
 111 typedef struct subpicture_updater_sys_t subpicture_updater_sys_t;
 112 typedef struct
 113 {
 114     int  (*pf_validate)( subpicture_t *,
 115                          bool has_src_changed, const video_format_t *p_fmt_src,
 116                          bool has_dst_changed, const video_format_t *p_fmt_dst,
 117                          mtime_t);
 118     void (*pf_update)  ( subpicture_t *,
 119                          const video_format_t *p_fmt_src,
 120                          const video_format_t *p_fmt_dst,
 121                          mtime_t );
 122     void (*pf_destroy) ( subpicture_t * );
 123     subpicture_updater_sys_t *p_sys;
 124 } subpicture_updater_t;
 125
 126 typedef struct subpicture_private_t subpicture_private_t;
 127
 128 /**
 129  * Video subtitle
 130  *
 131  * Any subtitle destined to be displayed by a video output thread should
 132  * be stored in this structure from it's creation to it's effective display.
 133  * Subtitle type and flags should only be modified by the output thread. Note
 134  * that an empty subtitle MUST have its flags set to 0.
 135  */
 136 struct subpicture_t
 137 {
 138     /** \name Channel ID */
 139     /**@{*/
 140     int             i_channel;                    /**< subpicture channel ID */
 141     /**@}*/
 142
 143     /** \name Type and flags
 144        Should NOT be modified except by the vout thread */
 145     /**@{*/
 146     int64_t         i_order;                 /** an increasing unique number */
 147     subpicture_t *  p_next;               /**< next subtitle to be displayed */
 148     /**@}*/
 149
 150     subpicture_region_t *p_region;  /**< region list composing this subtitle */
 151
 152     /** \name Date properties */
 153     /**@{*/
 154     mtime_t         i_start;                  /**< beginning of display date */
 155     mtime_t         i_stop;                         /**< end of display date */
 156     bool            b_ephemer;    /**< If this flag is set to true the subtitle
 157                                 will be displayed untill the next one appear */
 158     bool            b_fade;                               /**< enable fading */
 159     /**@}*/
 160
 161     /** \name Display properties
 162      * These properties are only indicative and may be
 163      * changed by the video output thread, or simply ignored depending of the
 164      * subtitle type. */
 165     /**@{*/
 166     bool         b_subtitle;            /**< the picture is a movie subtitle */
 167     bool         b_absolute;                       /**< position is absolute */
 168     int          i_original_picture_width;  /**< original width of the movie */
 169     int          i_original_picture_height;/**< original height of the movie */
 170     int          i_alpha;                                  /**< transparency */
 171      /**@}*/
 172
 173     subpicture_updater_t updater;
 174
 175     subpicture_private_t *p_private;    /* Reserved to the core */
 176 };
 177
 178 /**
 179  * This function create a new empty subpicture.
 180  *
 181  * You must use subpicture_Delete to destroy it.
 182  */
 183 VLC_API subpicture_t * subpicture_New( const subpicture_updater_t * );
 184
 185 /**
 186  * This function delete a subpicture created by subpicture_New.
 187  * You may give it NULL.
 188  */
 189 VLC_API void subpicture_Delete( subpicture_t *p_subpic );
 190
 191 /**
 192  * This function will create a subpicture having one region in the requested
 193  * chroma showing the given picture.
 194  *
 195  * The picture_t given is not released nor used inside the
 196  * returned subpicture_t.
 197  */
 198 VLC_API subpicture_t * subpicture_NewFromPicture( vlc_object_t *, picture_t *, vlc_fourcc_t i_chroma );
 199
 200 /**
 201  * This function will update the content of a subpicture created with
 202  * a non NULL subpicture_updater_t.
 203  */
 204 VLC_API void subpicture_Update( subpicture_t *, const video_format_t *src, const video_format_t *, mtime_t );
 205
 206 /**@}*/
 207
 208 #endif /* _VLC_VIDEO_H */