Towards Philips OGT (SVCD subtitle) handling.
[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.1 2003/12/07 22:14:26 rocky Exp $
6  *
7  * Authors: Rocky Bernstein 
8  *   based on code from: 
9  *       Julio Sanchez Fernandez (http://subhandler.sourceforge.net)
10  *       Samuel 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_INFO        8 
31
32 #define DECODE_DEBUG 1
33 #if DECODE_DEBUG
34 #define dbg_print(mask, s, args...) \
35    if (p_sys && p_sys->i_debug & mask) \
36      msg_Dbg(p_dec, "%s: "s, __func__ , ##args)
37 #else
38 #define dbg_print(mask, s, args...) 
39 #endif
40
41 #define LOG_ERR(args...)  msg_Err( p_input, args )
42 #define LOG_WARN(args...) msg_Warn( p_input, args )
43
44 #define GETINT16(p) ( (p[0] <<  8) +  p[1] ); p +=2;
45    
46 #define GETINT32(p) ( (p[0] << 24) +  (p[1] << 16) +    \
47                       (p[2] <<  8) +  (p[3]) ) ; p += 4;
48
49 typedef enum  {
50   SUBTITLE_BLOCK_EMPTY,
51   SUBTITLE_BLOCK_PARTIAL,
52   SUBTITLE_BLOCK_COMPLETE
53 } packet_state_t;
54
55 /* Color and transparency of a pixel or a palette (CLUT) entry */
56 typedef struct ogt_yuvt_val_s {
57   u_int8_t y;
58   u_int8_t u;
59   u_int8_t v;
60   u_int8_t t;
61 } ogt_yuvt_val_t;
62
63 struct decoder_sys_t
64 {
65 #ifndef FIXED
66   int i_rle_size; /*REMOVE WHEN WE'VE GONE OVER ALL CODE*/
67 #endif
68   int i_debug;            /* debugging mask */
69
70   int b_packetizer;
71   
72   mtime_t i_pts;          /* Start PTS of subtitle block */
73   int i_spu_size;         /* size of the allocated subtitle_data */
74   int i_spu;
75   packet_state_t state;   /* data-gathering state for this subtitle */
76   u_int16_t i_image;      /* image number in the subtitle stream; 0 is the 
77                              first one. */
78   u_int8_t  i_packet;     /* packet number for above image number; 0 is the 
79                              first one. */
80   
81   block_t *p_block;       /* Bytes of the packet. */
82   
83   uint8_t buffer[65536 + 20 ]; /* we will never overflow more than 11 bytes if I'm right */
84
85   vout_thread_t *p_vout;
86
87   /* Move into subpicture_sys_t? */
88   u_int16_t comp_image_offset;  /* offset from subtitle_data to compressed
89                                    image data */
90   int comp_image_length;        /* size of the compressed image data */
91   int first_field_offset;
92   int second_field_offset;
93
94   int metadata_offset;          /* offset to data describing the image */
95   int metadata_length;          /* length of metadata */
96
97   int subtitle_data_pos;        /* where to write next chunk */
98   int subtitle_data_length;     /* goal for subtitle_data_pos while gathering,
99                                    length of used subtitle_data later */
100
101   u_int32_t duration;           /* how long to display the image, 0 stands
102                                    for "until next sub" */
103
104   u_int16_t i_x_start, i_y_start; /* position of top leftmost pixel of
105                                      image when displayed */
106   u_int16_t i_width, i_height;  /* dimensions in pixels of image */
107
108   ogt_yuvt_val_t pi_palette[4];
109   ogt_yuvt_val_t pi_palette_highlight[4];
110
111   u_int8_t i_options;
112   u_int8_t i_options2;
113   u_int8_t i_cmd;
114   u_int32_t i_cmd_arg;
115 };
116
117 struct subpicture_sys_t
118 {
119     mtime_t i_pts;                                 /* presentation timestamp */
120
121     int   pi_offset[2];                              /* byte offsets to data */
122     void *p_data;
123
124     /* Color information */
125     vlc_bool_t b_palette;
126     uint8_t    pi_alpha[4];
127     uint8_t    pi_yuv[4][3];
128
129     /* Link to our input */
130     vlc_object_t * p_input;
131
132     /* Cropping properties */
133     vlc_mutex_t  lock;
134     vlc_bool_t   b_crop;
135     unsigned int i_x_start, i_y_start, i_x_end, i_y_end;
136 };
137
138 /*****************************************************************************
139  * Prototypes
140  *****************************************************************************/
141 void E_(ParsePacket)( decoder_t * );
142
143 void E_(RenderSPU)  ( vout_thread_t *, picture_t *, const subpicture_t * );
144