Work towards handling all planes in subtites, generalizing for CVD, and
[vlc.git] / modules / codec / ogt / subtitle.h
1 /*****************************************************************************
2  * subtitle.h : Common SVCD and CVD subtitles header
3  *****************************************************************************
4  * Copyright (C) 2003 VideoLAN
5  * $Id: subtitle.h,v 1.1 2003/12/28 02:01:11 rocky Exp $
6  *
7  * Author: Rocky Bernstein
8  *   based on code from:
9  *       Julio Sanchez Fernandez (http://subhandler.sourceforge.net)
10  *       Sam Hocevar <sam@zoy.org>
11  *
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.
16  *
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.
21  *
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  *****************************************************************************/
26
27 #define DECODE_DBG_EXT         1 /* Calls from external routines */
28 #define DECODE_DBG_CALL        2 /* all calls */
29 #define DECODE_DBG_PACKET      4 /* packet assembly info */
30 #define DECODE_DBG_IMAGE       8 /* image bitmaps */
31 #define DECODE_DBG_TRANSFORM  16 /* bitmap transformations */
32 #define DECODE_DBG_RENDER     32 /* rendering information */
33 #define DECODE_DBG_INFO       64
34
35 #define DECODE_DEBUG 1
36 #if DECODE_DEBUG
37 #define dbg_print(mask, s, args...) \
38    if (p_sys && p_sys->i_debug & mask) \
39      msg_Dbg(p_dec, "%s: "s, __func__ , ##args)
40 #else
41 #define dbg_print(mask, s, args...)
42 #endif
43
44 #define LOG_ERR(args...)  msg_Err( p_input, args )
45 #define LOG_WARN(args...) msg_Warn( p_input, args )
46
47 #define GETINT16(p) ( (p[0] <<  8) +  p[1] ); p +=2;
48
49 #define GETINT32(p) ( (p[0] << 24) +  (p[1] << 16) +    \
50                       (p[2] <<  8) +  (p[3]) ) ; p += 4;
51
52
53 /* The number of color palette entries allowed in a subtitle. */
54 #define NUM_SUBTITLE_COLORS 4 
55
56 typedef enum  {
57   SUBTITLE_BLOCK_EMPTY,
58   SUBTITLE_BLOCK_PARTIAL,
59   SUBTITLE_BLOCK_COMPLETE
60 } packet_state_t;
61
62 /* Color and transparency of a pixel or a palette (CLUT) entry */
63 typedef union {
64   uint8_t plane[4];
65   struct {
66     uint8_t y;
67     uint8_t u;
68     uint8_t v;
69     uint8_t t;
70   } s;
71 } ogt_yuvt_t;
72
73 /* The storage used by one pixel */
74 #define PIXEL_SIZE 4
75
76 /* Size in bytes of YUV portion above. */ 
77 #define YUV_SIZE 3
78
79 /* Transparency plane. NOTE: see vlc_video.h for V_PLANE */
80 #define T_PLANE  V_PLANE+1
81
82 struct decoder_sys_t
83 {
84   int            i_debug; /* debugging mask */
85   mtime_t        i_pts;   /* Start PTS of subtitle block */
86   int            i_spu;
87   packet_state_t state;   /* data-gathering state for this subtitle */
88
89   uint16_t       i_image; /* image number in the subtitle stream; 0 is the 
90                              first one. */
91   uint8_t        i_packet;/* packet number for above image number; 0 is the 
92                              first one. */
93   block_t        *p_block;/* Bytes of the packet. */
94   
95   uint8_t buffer[65536 + 20 ]; /* we will never overflow more than 11
96                                   bytes if I'm right */
97   int     b_packetizer;
98   int     i_spu_size;     /* goal for subtitle_data_pos while gathering,
99                              size of used subtitle_data later */
100   vout_thread_t *p_vout;
101
102   /* FIXME: Remove this? */
103   uint8_t *subtitle_data;       /* buffer used to accumulate data from
104                                    successive packets in the same subtitle */
105   int subtitle_data_size;       /* size of the allocated subtitle_data */
106
107   /* Move into subpicture_sys_t? */
108   uint16_t comp_image_offset;   /* offset from subtitle_data to compressed
109                                    image data */
110   int comp_image_length;        /* size of the compressed image data */
111   int second_field_offset;      /* offset of odd raster lines */
112   int metadata_offset;          /* offset to data describing the image */
113   int metadata_length;          /* length of metadata */
114
115   int subtitle_data_pos;        /* where to write next chunk */
116
117   uint32_t i_duration;          /* how long to display the image, 0 stands
118                                    for "until next subtitle" */
119
120   uint16_t i_x_start, i_y_start; /* position of top leftmost pixel of
121                                      image when displayed */
122   uint16_t i_width, i_height;   /* dimensions in pixels of image */
123
124   ogt_yuvt_t pi_palette[NUM_SUBTITLE_COLORS];
125
126   uint8_t i_options;
127   uint8_t i_options2;
128   uint8_t i_cmd;
129   uint32_t i_cmd_arg;
130 };
131
132 struct subpicture_sys_t
133 {
134   int     i_debug;              /* debugging mask */
135   mtime_t i_pts;                /* presentation timestamp */
136
137   u_int8_t *p_data;             /* Image data one byte T, Y, U, V */
138
139   /* Link to our input */
140   vlc_object_t * p_input;
141   
142   /* Cropping properties */
143   vlc_mutex_t  lock;
144   vlc_bool_t   b_crop;
145   unsigned int i_x_start, i_y_start, i_x_end, i_y_end;
146 };