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