1 /*****************************************************************************
2 * cdg.c: CDG decoder module
3 *****************************************************************************
4 * Copyright (C) 2007 Laurent Aimar
7 * Authors: Laurent Aimar <fenrir # via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_codec.h>
36 /*****************************************************************************
37 * decoder_sys_t : decoder descriptor
38 *****************************************************************************/
41 #define CDG_SCREEN_WIDTH (300)
42 #define CDG_SCREEN_HEIGHT (216)
44 /* The border of the screen size */
45 #define CDG_SCREEN_BORDER_WIDTH (6)
46 #define CDG_SCREEN_BORDER_HEIGHT (12)
48 /* The display part */
49 #define CDG_DISPLAY_WIDTH (CDG_SCREEN_WIDTH-2*CDG_SCREEN_BORDER_WIDTH)
50 #define CDG_DISPLAY_HEIGHT (CDG_SCREEN_HEIGHT-2*CDG_SCREEN_BORDER_HEIGHT)
52 #define CDG_SCREEN_PITCH (CDG_SCREEN_WIDTH)
59 uint8_t screen[CDG_SCREEN_PITCH*CDG_SCREEN_HEIGHT];
63 #define CDG_PACKET_SIZE (24)
65 #define CDG_COLOR_R_SHIFT ( 0)
66 #define CDG_COLOR_G_SHIFT ( 8)
67 #define CDG_COLOR_B_SHIFT (16)
69 /*****************************************************************************
71 *****************************************************************************/
72 static int Open ( vlc_object_t * );
73 static void Close( vlc_object_t * );
75 static picture_t *Decode( decoder_t *, block_t ** );
77 static int DecodePacket( decoder_sys_t *p_cdg, uint8_t *p_buffer, int i_buffer );
78 static int Render( decoder_sys_t *p_cdg, picture_t *p_picture );
80 /*****************************************************************************
82 *****************************************************************************/
84 set_category( CAT_INPUT );
85 set_subcategory( SUBCAT_INPUT_VCODEC );
86 set_description( N_("CDG video decoder") );
87 set_capability( "decoder", 1000 );
88 set_callbacks( Open, Close );
89 add_shortcut( "cdg" );
92 /*****************************************************************************
93 * Open: probe the decoder and return score
94 *****************************************************************************/
95 static int Open( vlc_object_t *p_this )
97 decoder_t *p_dec = (decoder_t*)p_this;
100 if( p_dec->fmt_in.i_codec != VLC_FOURCC('C','D','G',' ') )
103 /* Allocate the memory needed to store the decoder's structure */
104 p_dec->p_sys = p_sys = malloc(sizeof(decoder_sys_t));
109 memset( p_sys, 0, sizeof(*p_sys) );
110 p_sys->i_offseth = 0;
111 p_sys->i_offsetv = 0;
112 p_sys->p_screen = p_sys->screen;
114 /* Set output properties
115 * TODO maybe it would be better to use RV16 or RV24 ? */
116 p_dec->fmt_out.i_cat = VIDEO_ES;
117 p_dec->fmt_out.i_codec = VLC_FOURCC('R','V','3','2');
118 p_dec->fmt_out.video.i_width = CDG_DISPLAY_WIDTH;
119 p_dec->fmt_out.video.i_height = CDG_DISPLAY_HEIGHT;
120 p_dec->fmt_out.video.i_aspect =
121 VOUT_ASPECT_FACTOR * p_dec->fmt_out.video.i_width / p_dec->fmt_out.video.i_height;
122 p_dec->fmt_out.video.i_rmask = 0xff << CDG_COLOR_R_SHIFT;
123 p_dec->fmt_out.video.i_gmask = 0xff << CDG_COLOR_G_SHIFT;
124 p_dec->fmt_out.video.i_bmask = 0xff << CDG_COLOR_B_SHIFT;
127 p_dec->pf_decode_video = Decode;
132 /****************************************************************************
133 * Decode: the whole thing
134 ****************************************************************************
135 * This function must be fed with a complete compressed frame.
136 ****************************************************************************/
137 static picture_t *Decode( decoder_t *p_dec, block_t **pp_block )
139 decoder_sys_t *p_sys = p_dec->p_sys;
141 picture_t *p_pic = NULL;
143 if( !pp_block || !*pp_block )
148 while( p_block->i_buffer >= CDG_PACKET_SIZE )
150 DecodePacket( p_sys, p_block->p_buffer, CDG_PACKET_SIZE );
151 p_block->i_buffer -= CDG_PACKET_SIZE;
152 p_block->p_buffer += CDG_PACKET_SIZE;
155 /* Get a new picture */
156 p_pic = p_dec->pf_vout_buffer_new( p_dec );
160 Render( p_sys, p_pic );
161 p_pic->date = p_block->i_pts > 0 ? p_block->i_pts : p_block->i_dts;
163 block_Release( p_block ); *pp_block = NULL;
167 block_Release( p_block ); *pp_block = NULL;
171 /*****************************************************************************
172 * Close: decoder destruction
173 *****************************************************************************/
174 static void Close( vlc_object_t *p_this )
176 decoder_t *p_dec = (decoder_t *)p_this;
177 decoder_sys_t *p_sys = p_dec->p_sys;
182 /*****************************************************************************
184 *****************************************************************************/
185 static void ScreenFill( decoder_sys_t *p_cdg, int sx, int sy, int dx, int dy, int c )
188 for( y = sy; y < sy+dy; y++ )
189 for( x = sx; x < sx+dx; x++ )
190 p_cdg->p_screen[y*CDG_SCREEN_PITCH+x] = c;
192 static int DecodeMemoryPreset( decoder_sys_t *p_cdg, const uint8_t *p_data )
194 const int i_color = p_data[0]&0x0f;
196 const int i_repeat= p_data[1]&0x0f;
198 /* if i_repeat > 0 we could ignore it if we have a reliable stream */
199 ScreenFill( p_cdg, 0, 0, CDG_SCREEN_WIDTH, CDG_SCREEN_HEIGHT, i_color );
202 static int DecodeBorderPreset( decoder_sys_t *p_cdg, const uint8_t *p_data )
204 const int i_color = p_data[0]&0x0f;
207 ScreenFill( p_cdg, 0, 0,
208 CDG_SCREEN_WIDTH, CDG_SCREEN_BORDER_HEIGHT, i_color );
209 ScreenFill( p_cdg, 0, CDG_SCREEN_HEIGHT-CDG_SCREEN_BORDER_HEIGHT,
210 CDG_SCREEN_WIDTH, CDG_SCREEN_BORDER_HEIGHT, i_color );
211 ScreenFill( p_cdg, 0, CDG_SCREEN_BORDER_HEIGHT,
212 CDG_SCREEN_BORDER_WIDTH, CDG_SCREEN_HEIGHT-CDG_SCREEN_BORDER_HEIGHT, i_color );
213 ScreenFill( p_cdg, CDG_SCREEN_WIDTH-CDG_SCREEN_BORDER_WIDTH, CDG_SCREEN_BORDER_HEIGHT,
214 CDG_SCREEN_BORDER_WIDTH, CDG_SCREEN_HEIGHT-CDG_SCREEN_BORDER_HEIGHT, i_color );
218 static int DecodeLoadColorTable( decoder_sys_t *p_cdg, const uint8_t *p_data, int i_base )
221 for( n = 0; n < 8; n++ )
223 const int c = ((p_data[2*n+0] << 8) | p_data[2*n+1]);
224 const int r = (c >> 10)&0x0f;
225 const int g = ((c >> 6)&0x0c) | ((c >> 4)&0x03);
226 const int b = c &0x0f;
228 p_cdg->color[i_base+n][0] = r << 4;
229 p_cdg->color[i_base+n][1] = g << 4;
230 p_cdg->color[i_base+n][2] = b << 4;
234 static int DecodeTileBlock( decoder_sys_t *p_cdg, const uint8_t *p_data, int doXor )
240 p_color[0] = p_data[0] & 0x0f;
241 p_color[1] = p_data[1] & 0x0f;
243 sy = (p_data[2] & 0x1f)*12;
244 sx = (p_data[3] & 0x3f)*6;
246 for( y = 0; y < 12; y++ )
248 for( x = 0; x < 6; x++ )
250 const int idx = ( p_data[4+y] >> (5-x) ) & 0x01;
251 uint8_t *p = &p_cdg->p_screen[(sy+y)*CDG_SCREEN_PITCH+(sx+x)];
261 static int DecodeScroll( decoder_sys_t *p_cdg, const uint8_t *p_data, int b_copy )
263 uint8_t copy[CDG_SCREEN_PITCH*CDG_SCREEN_HEIGHT];
265 uint8_t color = p_data[0]&0x0f;
271 p_cdg->i_offseth = p_data[1]&0x7;
272 if( p_cdg->i_offseth >= CDG_SCREEN_BORDER_WIDTH )
273 p_cdg->i_offseth = CDG_SCREEN_BORDER_WIDTH-1;
275 p_cdg->i_offsetv = p_data[2]&0xf;
276 if( p_cdg->i_offsetv >= CDG_SCREEN_BORDER_HEIGHT )
277 p_cdg->i_offsetv = CDG_SCREEN_BORDER_HEIGHT-1;
280 switch( (p_data[1] >> 4)&0x3 )
282 case 0x01: i_shifth = 6; break;
283 case 0x02: i_shifth = -6; break;
288 switch( (p_data[2] >> 4)&0x3 )
290 case 0x01: i_shiftv = 12; break;
291 case 0x02: i_shiftv =-12; break;
297 if( i_shifth == 0 && i_shiftv == 0 )
300 /* Make a copy of the screen */
301 memcpy( copy, p_cdg->screen, sizeof(p_cdg->screen) );
303 /* Fill the uncovered part XXX way too much */
304 ScreenFill( p_cdg, 0, 0, CDG_SCREEN_WIDTH, CDG_SCREEN_HEIGHT, color );
307 for( y = 0; y < CDG_SCREEN_HEIGHT; y++ )
309 int dy = i_shiftv + y;
310 for( x = 0; x < CDG_SCREEN_WIDTH; x++ )
312 int dx = i_shifth + x;
316 dy = ( dy + CDG_SCREEN_HEIGHT ) % CDG_SCREEN_HEIGHT;
317 dy = ( dy + CDG_SCREEN_WIDTH ) % CDG_SCREEN_WIDTH;
321 if( dy < 0 || dy >= CDG_SCREEN_HEIGHT ||
322 dx < 0 || dx >= CDG_SCREEN_WIDTH )
325 p_cdg->screen[dy*CDG_SCREEN_PITCH+dx] = copy[y*CDG_SCREEN_PITCH+x];
329 //CdgDebug( CDG_LOG_WARNING, "DecodeScroll: color=%d ch=%d oh=%d cv=%d ov=%d\n copy=%d\n", color, i_shifth, p_cdg->i_offseth, i_shiftv, p_cdg->i_offsetv, b_copy );
333 static int DecodePacket( decoder_sys_t *p_cdg, uint8_t *p_buffer, int i_buffer )
335 const int i_cmd = p_buffer[0] & 0x3f;
336 const int i_instruction = p_buffer[1] & 0x3f;
337 const uint8_t *p_data = &p_buffer[4];
339 if( i_buffer != CDG_PACKET_SIZE )
342 /* Handle CDG command only */
346 switch( i_instruction )
349 DecodeMemoryPreset( p_cdg, p_data );
352 DecodeBorderPreset( p_cdg, p_data );
355 DecodeTileBlock( p_cdg, p_data, 0 );
358 DecodeScroll( p_cdg, p_data, 0 );
361 DecodeScroll( p_cdg, p_data, 1 );
364 /* FIXME what to do about that one ? */
365 //CdgDebug( CDG_LOG_WARNING, "DecodeDefineTransparentColor not implemented\n" );
366 //DecodeDefineTransparentColor( p_cdg, p_data );
369 DecodeLoadColorTable( p_cdg, p_data, 0 );
372 DecodeLoadColorTable( p_cdg, p_data, 8 );
375 DecodeTileBlock( p_cdg, p_data, 1 );
383 static void RenderPixel( picture_t *p_picture, int x, int y, uint32_t c )
385 const int i_plane = 0;
386 const int i_pitch = p_picture->p[i_plane].i_pitch;
387 uint32_t *s = (uint32_t*)&p_picture->p[i_plane].p_pixels[y*i_pitch + x*sizeof(uint32_t)];
390 static uint32_t RenderRGB( int r, int g, int b )
392 return ( r << CDG_COLOR_R_SHIFT ) | ( g << CDG_COLOR_G_SHIFT ) | ( b << CDG_COLOR_B_SHIFT );
395 static int Render( decoder_sys_t *p_cdg, picture_t *p_picture )
399 for( y = 0; y < CDG_DISPLAY_HEIGHT; y++ )
401 for( x = 0; x < CDG_DISPLAY_WIDTH; x++ )
403 const int sx = x + p_cdg->i_offseth + CDG_SCREEN_BORDER_WIDTH;
404 const int sy = y + p_cdg->i_offsetv + CDG_SCREEN_BORDER_HEIGHT;
405 uint8_t cidx = p_cdg->p_screen[sy*CDG_SCREEN_PITCH +sx];
406 uint8_t r = p_cdg->color[cidx][0];
407 uint8_t g = p_cdg->color[cidx][1];
408 uint8_t b = p_cdg->color[cidx][2];
410 RenderPixel( p_picture, x, y, RenderRGB( r, g, b ) );