1 /*****************************************************************************
2 * subtitle.h : Common SVCD and CVD subtitles header
3 *****************************************************************************
4 * Copyright (C) 2003,2004 VideoLAN
5 * $Id: subtitle.h,v 1.10 2004/01/21 04:45:47 rocky Exp $
7 * Author: Rocky Bernstein
9 * Julio Sanchez Fernandez (http://subhandler.sourceforge.net)
10 * Sam Hocevar <sam@zoy.org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
25 *****************************************************************************/
29 #define DECODE_DBG_EXT 1 /* Calls from external routines */
30 #define DECODE_DBG_CALL 2 /* all calls */
31 #define DECODE_DBG_PACKET 4 /* packet assembly info */
32 #define DECODE_DBG_IMAGE 8 /* image bitmaps */
33 #define DECODE_DBG_TRANSFORM 16 /* bitmap transformations */
34 #define DECODE_DBG_RENDER 32 /* rendering information */
35 #define DECODE_DBG_PNG 64 /* Extract subtitles to PNG files. */
36 #define DECODE_DBG_INFO 128
38 #define DEBUG_LONGTEXT N_( \
39 "This integer when viewed in binary is a debugging mask\n" \
42 "packet assembly info 4\n" \
44 "image transformations 16\n" \
45 "rendering information 32\n" \
46 "extract subtitles 64\n" \
49 #define SUB_ASPECT_RATIO_TEXT N_("Subtitle aspect-ratio correction")
50 #define SUB_ASPECT_RATIO_LONGTEXT N_( \
51 "Use this to force the subtitle aspect ratio. If you give a null string " \
52 "the right value will be determined automatically. Usually this is what " \
53 "you want. For OGT and CVD subtitles this undoes the effect " \
54 "of the underlying video scaling. And using a value of 1 will cause " \
55 "no correction; subtitles will be scaled with the same aspect " \
56 "ratio as as the underlying video (which not correct for OGT or " \
57 "CVD subtitles). You can also force another ratio by giving a pair of " \
58 "integers x:y where y should between x and twice x. For example 4:3, or " \
59 "16:9. Alternatively, you can give a float value expressing pixel " \
60 "squareness. For example 1.25 or 1.3333 which mean the same thing as " \
61 "4:3 and 16:9 respectively." \
64 #define DURATION_SCALE_TEXT N_("factor to increase subtitle display interval")
65 #define DURATION_SCALE_LONGTEXT N_( \
66 "If you find you need extra time for reading subtitles, " \
67 "you can set this higher and it will multiply the display " \
68 "time by that amount. Use 0 to mean until the next " \
71 #define HORIZONTAL_CORRECT \
72 N_("Add this to starting horizontal position of subtitle.")
73 #define HORIZONTAL_CORRECT_LONGTEXT N_( \
74 "If you need to adjust the subtitle starting position horizontally, " \
75 "set this. Negative values shift left and postive values right. 0 would " \
76 "be no deviation from where the position specified in the subtitle." \
79 #define VERTICAL_CORRECT \
80 N_("Add this to starting vertical position of subtitle.")
81 #define VERTICAL_CORRECT_LONGTEXT N_( \
82 "If you need to adjust the subtitle starting position vertically, " \
83 "set this. Negative values shift up, positive values down. 0 would " \
84 "be no deviation from where the position specified in the subtitle." \
87 #define DECODE_DEBUG 1
89 #define dbg_print(mask, s, args...) \
90 if (p_sys && p_sys->i_debug & mask) \
91 msg_Dbg(p_dec, "%s: "s, __func__ , ##args)
93 #define dbg_print(mask, s, args...)
96 #define LOG_ERR(args...) msg_Err( p_input, args )
97 #define LOG_WARN(args...) msg_Warn( p_input, args )
99 #define GETINT16(p) ( (p[0] << 8) + p[1] ) ; p +=2;
101 #define GETINT32(p) ( (p[0] << 24) + (p[1] << 16) + \
102 (p[2] << 8) + (p[3]) ) ; p += 4;
105 /* The number of color palette entries allowed in a subtitle. */
106 #define NUM_SUBTITLE_COLORS 4
109 SUBTITLE_BLOCK_EMPTY,
110 SUBTITLE_BLOCK_PARTIAL,
111 SUBTITLE_BLOCK_COMPLETE
114 /* The storage used by one pixel */
117 /* Size in bytes of YUV portion above. */
120 /* Transparency plane. NOTE: see vlc_video.h for V_PLANE */
121 #define T_PLANE V_PLANE+1
125 int i_debug; /* debugging mask */
126 mtime_t i_pts; /* Start PTS of subtitle block */
128 packet_state_t state; /* data-gathering state for this subtitle */
130 uint16_t i_image; /* image number in the subtitle stream; 0 is the
132 uint8_t i_packet;/* packet number for above image number; 0 is the
134 block_t *p_block;/* Bytes of the packet. */
136 uint8_t buffer[65536 + 20 ]; /* we will never overflow more than 11
137 bytes if I'm right */
139 int i_spu_size; /* goal for subtitle_data_pos while gathering,
140 size of used subtitle_data later */
141 vout_thread_t *p_vout;
143 /* FIXME: Remove this? */
144 uint8_t *subtitle_data; /* buffer used to accumulate data from
145 successive packets in the same subtitle */
146 int subtitle_data_size; /* size of the allocated subtitle_data */
148 /* Move into subpicture_sys_t? */
149 uint16_t i_image_offset; /* offset from subtitle_data to compressed
151 int i_image_length; /* size of the compressed image data */
152 int first_field_offset; /* offset of even raster lines. Used
155 int second_field_offset; /* offset of odd raster lines */
156 int metadata_offset; /* offset to data describing the image */
157 int metadata_length; /* length of metadata */
159 int subtitle_data_pos; /* where to write next chunk */
161 mtime_t i_duration; /* how long to display the image, 0 stands
162 for "until next subtitle" */
164 uint16_t i_x_start, i_y_start; /* position of top leftmost pixel of
165 image when displayed */
166 uint16_t i_width, i_height; /* dimensions in pixels of image */
168 ogt_yuvt_t p_palette[NUM_SUBTITLE_COLORS]; /* Palette of colors used
172 ogt_yuvt_t p_palette_highlight[NUM_SUBTITLE_COLORS]; /* Only used
181 struct subpicture_sys_t
183 int i_debug; /* debugging mask */
184 mtime_t i_pts; /* presentation timestamp */
186 uint8_t *p_data; /* Image data one byte T, Y, U, V */
188 /* Link to our input */
189 vlc_object_t * p_input;
191 /* Cropping properties */
194 unsigned int i_x_start, i_y_start, i_x_end, i_y_end;