git.sesse.net Git - vlc/blob - modules/codec/cdg.c

   1 /*****************************************************************************
   2  * cdg.c: CDG decoder module
   3  *****************************************************************************
   4  * Copyright (C) 2007 Laurent Aimar
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir # via.ecp.fr>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc/vlc.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_codec.h>
  34 #include <vlc_vout.h>
  35
  36 /*****************************************************************************
  37  * decoder_sys_t : decoder descriptor
  38  *****************************************************************************/
  39
  40 /* The screen size */
  41 #define CDG_SCREEN_WIDTH (300)
  42 #define CDG_SCREEN_HEIGHT (216)
  43
  44 /* The border of the screen size */
  45 #define CDG_SCREEN_BORDER_WIDTH (6)
  46 #define CDG_SCREEN_BORDER_HEIGHT (12)
  47
  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)
  51
  52 #define CDG_SCREEN_PITCH (CDG_SCREEN_WIDTH)
  53
  54 struct decoder_sys_t
  55 {
  56     uint8_t color[16][3];
  57     int     i_offseth;
  58     int     i_offsetv;
  59     uint8_t screen[CDG_SCREEN_PITCH*CDG_SCREEN_HEIGHT];
  60     uint8_t *p_screen;
  61 };
  62
  63 #define CDG_PACKET_SIZE (24)
  64
  65 #define CDG_COLOR_R_SHIFT ( 0)
  66 #define CDG_COLOR_G_SHIFT ( 8)
  67 #define CDG_COLOR_B_SHIFT (16)
  68
  69 /*****************************************************************************
  70  * Local prototypes
  71  *****************************************************************************/
  72 static int  Open ( vlc_object_t * );
  73 static void Close( vlc_object_t * );
  74
  75 static picture_t *Decode( decoder_t *, block_t ** );
  76
  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 );
  79
  80 /*****************************************************************************
  81  * Module descriptor
  82  *****************************************************************************/
  83 vlc_module_begin();
  84     set_category( CAT_INPUT );
  85     set_subcategory( SUBCAT_INPUT_VCODEC );
  86     set_description( _("CDG video decoder") );
  87     set_capability( "decoder", 1000 );
  88     set_callbacks( Open, Close );
  89     add_shortcut( "cdg" );
  90 vlc_module_end();
  91
  92 /*****************************************************************************
  93  * Open: probe the decoder and return score
  94  *****************************************************************************/
  95 static int Open( vlc_object_t *p_this )
  96 {
  97     decoder_t *p_dec = (decoder_t*)p_this;
  98     decoder_sys_t *p_sys;
  99
 100     if( p_dec->fmt_in.i_codec != VLC_FOURCC('C','D','G',' ') )
 101         return VLC_EGENERIC;
 102
 103     /* Allocate the memory needed to store the decoder's structure */
 104     p_dec->p_sys = p_sys = malloc(sizeof(decoder_sys_t));
 105     if( !p_sys )
 106         return VLC_ENOMEM;
 107
 108     /* Init */
 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;
 113
 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;
 125
 126     /* Set callbacks */
 127     p_dec->pf_decode_video = Decode;
 128
 129     return VLC_SUCCESS;
 130 }
 131
 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 )
 138 {
 139     decoder_sys_t *p_sys = p_dec->p_sys;
 140     block_t *p_block;
 141     picture_t *p_pic = NULL;
 142
 143     if( !pp_block || !*pp_block )
 144         return NULL;
 145     p_block = *pp_block;
 146
 147     /* Decode packet */
 148     while( p_block->i_buffer >= CDG_PACKET_SIZE )
 149     {
 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;
 153     }
 154
 155     /* Get a new picture */
 156     p_pic = p_dec->pf_vout_buffer_new( p_dec );
 157     if( !p_pic )
 158         goto error;
 159
 160     Render( p_sys, p_pic );
 161     p_pic->date = p_block->i_pts > 0 ? p_block->i_pts : p_block->i_dts;
 162
 163     block_Release( p_block ); *pp_block = NULL;
 164     return p_pic;
 165
 166 error:
 167     block_Release( p_block ); *pp_block = NULL;
 168     return NULL;
 169 }
 170
 171 /*****************************************************************************
 172  * Close: decoder destruction
 173  *****************************************************************************/
 174 static void Close( vlc_object_t *p_this )
 175 {
 176     decoder_t *p_dec = (decoder_t *)p_this;
 177     decoder_sys_t *p_sys = p_dec->p_sys;
 178
 179     free( p_sys );
 180 }
 181
 182 /*****************************************************************************
 183  * Decoder
 184  *****************************************************************************/
 185 static void ScreenFill( decoder_sys_t *p_cdg, int sx, int sy, int dx, int dy, int c )
 186 {
 187     int x, y;
 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;
 191 }
 192 static int DecodeMemoryPreset( decoder_sys_t *p_cdg, const uint8_t *p_data )
 193 {
 194     const int i_color = p_data[0]&0x0f;
 195 #if 0
 196     const int i_repeat= p_data[1]&0x0f;
 197 #endif
 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 );
 200     return 0;
 201 }
 202 static int DecodeBorderPreset( decoder_sys_t *p_cdg, const uint8_t *p_data )
 203 {
 204     const int i_color = p_data[0]&0x0f;
 205
 206     /* */
 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 );
 215     return 0;
 216 }
 217
 218 static int DecodeLoadColorTable( decoder_sys_t *p_cdg, const uint8_t *p_data, int i_base )
 219 {
 220     int n;
 221     for( n = 0; n < 8; n++ )
 222     {
 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;
 227
 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;
 231     }
 232     return 0;
 233 }
 234 static int DecodeTileBlock( decoder_sys_t *p_cdg, const uint8_t *p_data, int doXor )
 235 {
 236     int p_color[2];
 237     int sx, sy;
 238     int x, y;
 239
 240     p_color[0] = p_data[0] & 0x0f;
 241     p_color[1] = p_data[1] & 0x0f;
 242
 243     sy = (p_data[2] & 0x1f)*12;
 244     sx = (p_data[3] & 0x3f)*6;
 245
 246     for( y = 0; y < 12; y++ )
 247     {
 248         for( x = 0; x < 6; x++ )
 249         {
 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)];
 252             if( doXor )
 253                 *p ^= p_color[idx];
 254             else
 255                 *p = p_color[idx];
 256         }
 257     }
 258     return 0;
 259 }
 260
 261 static int DecodeScroll( decoder_sys_t *p_cdg, const uint8_t *p_data, int b_copy )
 262 {
 263     uint8_t copy[CDG_SCREEN_PITCH*CDG_SCREEN_HEIGHT];
 264
 265     uint8_t color = p_data[0]&0x0f;
 266     int i_shifth;
 267     int i_shiftv;
 268     int x, y;
 269
 270     /* */
 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;
 274
 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;
 278
 279     /* */
 280     switch( (p_data[1] >> 4)&0x3 )
 281     {
 282     case 0x01: i_shifth =  6; break;
 283     case 0x02: i_shifth = -6; break;
 284     default:
 285         i_shifth = 0;
 286         break;
 287     }
 288     switch( (p_data[2] >> 4)&0x3 )
 289     {
 290     case 0x01: i_shiftv = 12; break;
 291     case 0x02: i_shiftv =-12; break;
 292     default:
 293         i_shiftv = 0;
 294         break;
 295     }
 296
 297     if( i_shifth == 0 && i_shiftv == 0 )
 298         return 0;
 299
 300     /* Make a copy of the screen */
 301     memcpy( copy, p_cdg->screen, sizeof(p_cdg->screen) );
 302
 303     /* Fill the uncovered part XXX way too much */
 304     ScreenFill( p_cdg, 0, 0, CDG_SCREEN_WIDTH, CDG_SCREEN_HEIGHT, color );
 305
 306     /* Copy back */
 307     for( y = 0; y < CDG_SCREEN_HEIGHT; y++ )
 308     {
 309         int dy = i_shiftv + y;
 310         for( x = 0; x < CDG_SCREEN_WIDTH; x++ )
 311         {
 312             int dx = i_shifth + x;
 313
 314             if( b_copy )
 315             {
 316                 dy = ( dy + CDG_SCREEN_HEIGHT ) % CDG_SCREEN_HEIGHT;
 317                 dy = ( dy + CDG_SCREEN_WIDTH  ) % CDG_SCREEN_WIDTH;
 318             }
 319             else
 320             {
 321                 if( dy < 0 || dy >= CDG_SCREEN_HEIGHT ||
 322                     dx < 0 || dx >= CDG_SCREEN_WIDTH )
 323                     continue;
 324             }
 325             p_cdg->screen[dy*CDG_SCREEN_PITCH+dx] = copy[y*CDG_SCREEN_PITCH+x];
 326         }
 327     }
 328     /* */
 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 );
 330     return 0;
 331 }
 332
 333 static int DecodePacket( decoder_sys_t *p_cdg, uint8_t *p_buffer, int i_buffer )
 334 {
 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];
 338
 339     if( i_buffer != CDG_PACKET_SIZE )
 340         return -1;
 341
 342     /* Handle CDG command only */
 343     if( i_cmd != 0x09 )
 344         return 0;
 345
 346     switch( i_instruction )
 347     {
 348         case 1:
 349             DecodeMemoryPreset( p_cdg, p_data );
 350             break;
 351         case 2:
 352             DecodeBorderPreset( p_cdg, p_data );
 353             break;
 354         case 6:
 355             DecodeTileBlock( p_cdg, p_data, 0 );
 356             break;
 357         case 20:
 358             DecodeScroll( p_cdg, p_data, 0 );
 359             break;
 360         case 24:
 361             DecodeScroll( p_cdg, p_data, 1 );
 362             break;
 363         case 28:
 364             /* FIXME what to do about that one ? */
 365             //CdgDebug( CDG_LOG_WARNING, "DecodeDefineTransparentColor not implemented\n" );
 366             //DecodeDefineTransparentColor( p_cdg, p_data );
 367             break;
 368         case 30:
 369             DecodeLoadColorTable( p_cdg, p_data, 0 );
 370             break;
 371         case 31:
 372             DecodeLoadColorTable( p_cdg, p_data, 8 );
 373             break;
 374         case 38:
 375             DecodeTileBlock( p_cdg, p_data, 1 );
 376             break;
 377         default:
 378             break;
 379     }
 380     return 0;
 381 }
 382
 383 static void RenderPixel( picture_t *p_picture, int x, int y, uint32_t c )
 384 {
 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)];
 388     *s = c;
 389 }
 390 static uint32_t RenderRGB( int r, int g, int b )
 391 {
 392     return ( r << CDG_COLOR_R_SHIFT ) | ( g << CDG_COLOR_G_SHIFT ) | ( b << CDG_COLOR_B_SHIFT );
 393 }
 394
 395 static int Render( decoder_sys_t *p_cdg, picture_t *p_picture )
 396 {
 397     int x, y;
 398
 399     for( y = 0; y < CDG_DISPLAY_HEIGHT; y++ )
 400     {
 401         for( x = 0; x < CDG_DISPLAY_WIDTH; x++ )
 402         {
 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];
 409
 410             RenderPixel( p_picture, x, y, RenderRGB( r, g, b ) );
 411         }
 412     }
 413     return 0;
 414 }
 415