Keep in synch with rest of source. Should also have no effect on upcoming release
[vlc.git] / modules / codec / ogt / ogt.h
1 /*****************************************************************************
2  * ogt.h : Overlay Graphics Text (SVCD subtitles) decoder thread interface
3  *****************************************************************************
4  * Copyright (C) 2003 VideoLAN
5  * $Id: ogt.h,v 1.4 2003/12/26 02:47:59 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_INFO       16
32
33 #define DECODE_DEBUG 1
34 #if DECODE_DEBUG
35 #define dbg_print(mask, s, args...) \
36    if (p_sys && p_sys->i_debug & mask) \
37      msg_Dbg(p_dec, "%s: "s, __func__ , ##args)
38 #else
39 #define dbg_print(mask, s, args...)
40 #endif
41
42 #define LOG_ERR(args...)  msg_Err( p_input, args )
43 #define LOG_WARN(args...) msg_Warn( p_input, args )
44
45 #define GETINT16(p) ( (p[0] <<  8) +  p[1] ); p +=2;
46
47 #define GETINT32(p) ( (p[0] << 24) +  (p[1] << 16) +    \
48                       (p[2] <<  8) +  (p[3]) ) ; p += 4;
49
50
51 /* The number of color palette entries allowed in a subtitle. */
52 #define NUM_SUBTITLE_COLORS 4 
53
54 typedef enum  {
55   SUBTITLE_BLOCK_EMPTY,
56   SUBTITLE_BLOCK_PARTIAL,
57   SUBTITLE_BLOCK_COMPLETE
58 } packet_state_t;
59
60 /* FIXME: REMOVE THE BELOW. */
61 /* Color and transparency of a pixel or a palette (CLUT) entry */
62 typedef struct ogt_yuvt_val_s {
63   uint8_t y;
64   uint8_t u;
65   uint8_t v;
66   uint8_t t;
67 } ogt_yuvt_t;
68
69 /* The storage used by one pixel */
70 #define PIXEL_SIZE 4
71
72 /* Size in bytes of YUV portion above. */ 
73 #define YUV_SIZE 3
74
75 /* Transparency plane. NOTE: see vlc_video.h for V_PLANE */
76 #define T_PLANE  V_PLANE+1
77
78 struct decoder_sys_t
79 {
80   int            i_debug; /* debugging mask */
81   mtime_t        i_pts;   /* Start PTS of subtitle block */
82   int            i_spu;
83   packet_state_t state;   /* data-gathering state for this subtitle */
84
85   uint16_t       i_image; /* image number in the subtitle stream; 0 is the 
86                              first one. */
87   uint8_t        i_packet;/* packet number for above image number; 0 is the 
88                              first one. */
89   block_t        *p_block;/* Bytes of the packet. */
90   
91   uint8_t buffer[65536 + 20 ]; /* we will never overflow more than 11
92                                   bytes if I'm right */
93   int     b_packetizer;
94   int     i_spu_size;     /* goal for subtitle_data_pos while gathering,
95                              size of used subtitle_data later */
96   vout_thread_t *p_vout;
97
98   /* FIXME: Remove this? */
99   uint8_t *subtitle_data;       /* buffer used to accumulate data from
100                                    successive packets in the same subtitle */
101   int subtitle_data_size;       /* size of the allocated subtitle_data */
102
103   /* Move into subpicture_sys_t? */
104   uint16_t comp_image_offset;   /* offset from subtitle_data to compressed
105                                    image data */
106   int comp_image_length;        /* size of the compressed image data */
107   int second_field_offset;      /* offset of odd raster lines */
108   int metadata_offset;          /* offset to data describing the image */
109   int metadata_length;          /* length of metadata */
110
111   int subtitle_data_pos;        /* where to write next chunk */
112
113   uint32_t i_duration;          /* how long to display the image, 0 stands
114                                    for "until next subtitle" */
115
116   uint16_t i_x_start, i_y_start; /* position of top leftmost pixel of
117                                      image when displayed */
118   uint16_t i_width, i_height;   /* dimensions in pixels of image */
119
120   ogt_yuvt_t pi_palette[NUM_SUBTITLE_COLORS];
121
122   uint8_t i_options;
123   uint8_t i_options2;
124   uint8_t i_cmd;
125   uint32_t i_cmd_arg;
126 };
127
128 struct subpicture_sys_t
129 {
130   mtime_t i_pts;                /* presentation timestamp */
131
132   u_int8_t *p_data;             /* Image data one byte T, Y, U, V */
133
134   /* Color information */
135   vlc_bool_t b_palette;
136   
137   /* Link to our input */
138   vlc_object_t * p_input;
139   
140   /* Cropping properties */
141   vlc_mutex_t  lock;
142   vlc_bool_t   b_crop;
143   unsigned int i_x_start, i_y_start, i_x_end, i_y_end;
144 };
145
146 /*****************************************************************************
147  * Prototypes
148  *****************************************************************************/
149 void E_(ParseHeader)( decoder_t *, uint8_t *, block_t *  );
150 void E_(ParsePacket)( decoder_t * );
151 void E_(RenderSPU)  ( vout_thread_t *, picture_t *, const subpicture_t * );
152