git.sesse.net Git - vlc/blob - modules/video_output/caca.c

   1 /*****************************************************************************
   2  * caca.c: Color ASCII Art video output plugin using libcaca
   3  *****************************************************************************
   4  * Copyright (C) 2003, 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Sam Hocevar <sam@zoy.org>
   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 #include <errno.h>                                                 /* ENOMEM */
  28 #include <stdlib.h>                                                /* free() */
  29 #include <string.h>                                            /* strerror() */
  30
  31 #include <caca.h>
  32
  33 #include <vlc/vlc.h>
  34 #include <vlc/vout.h>
  35 #include <vlc/intf.h>
  36 #include <vlc_keys.h>
  37
  38 /*****************************************************************************
  39  * Local prototypes
  40  *****************************************************************************/
  41 static int  Create    ( vlc_object_t * );
  42 static void Destroy   ( vlc_object_t * );
  43
  44 static int  Init      ( vout_thread_t * );
  45 static void End       ( vout_thread_t * );
  46 static int  Manage    ( vout_thread_t * );
  47 static void Render    ( vout_thread_t *, picture_t * );
  48 static void Display   ( vout_thread_t *, picture_t * );
  49
  50 /*****************************************************************************
  51  * Module descriptor
  52  *****************************************************************************/
  53 vlc_module_begin();
  54     set_shortname( "Caca" );
  55     set_category( CAT_VIDEO );
  56     set_subcategory( SUBCAT_VIDEO_VOUT );
  57     set_description( _("Color ASCII art video output") );
  58     set_capability( "video output", 12 );
  59     set_callbacks( Create, Destroy );
  60 vlc_module_end();
  61
  62 /*****************************************************************************
  63  * vout_sys_t: libcaca video output method descriptor
  64  *****************************************************************************
  65  * This structure is part of the video output thread descriptor.
  66  * It describes the libcaca specific properties of an output thread.
  67  *****************************************************************************/
  68 struct vout_sys_t
  69 {
  70 #ifdef CACA_API_VERSION_1
  71     struct cucul_context *p_qq;
  72     struct caca_context *p_kk;
  73     struct cucul_bitmap *p_bitmap;
  74 #else
  75     struct caca_bitmap *p_bitmap;
  76 #endif
  77 };
  78
  79 /*****************************************************************************
  80  * Create: allocates libcaca video output thread
  81  *****************************************************************************
  82  * This function initializes libcaca vout method.
  83  *****************************************************************************/
  84 static int Create( vlc_object_t *p_this )
  85 {
  86     vout_thread_t *p_vout = (vout_thread_t *)p_this;
  87
  88 #if defined( WIN32 ) && !defined( UNDER_CE )
  89     if( AllocConsole() )
  90     {
  91         CONSOLE_SCREEN_BUFFER_INFO csbiInfo;
  92         SMALL_RECT rect;
  93         COORD coord;
  94
  95         HANDLE hstdout =
  96             CreateConsoleScreenBuffer( GENERIC_READ | GENERIC_WRITE,
  97                                        FILE_SHARE_READ | FILE_SHARE_WRITE,
  98                                        NULL, CONSOLE_TEXTMODE_BUFFER, NULL );
  99         if( !hstdout || hstdout == INVALID_HANDLE_VALUE )
 100         {
 101             msg_Err( p_vout, "cannot create screen buffer" );
 102             FreeConsole();
 103             return VLC_EGENERIC;
 104         }
 105
 106         if( !SetConsoleActiveScreenBuffer( hstdout) )
 107         {
 108             msg_Err( p_vout, "cannot set active screen buffer" );
 109             FreeConsole();
 110             return VLC_EGENERIC;
 111         }
 112
 113         coord = GetLargestConsoleWindowSize( hstdout );
 114         msg_Dbg( p_vout, "SetConsoleWindowInfo: %ix%i", coord.X, coord.Y );
 115
 116         /* Force size for now */
 117         coord.X = 100;
 118         coord.Y = 40;
 119
 120         if( !SetConsoleScreenBufferSize( hstdout, coord ) )
 121             msg_Warn( p_vout, "SetConsoleScreenBufferSize %i %i",
 122                       coord.X, coord.Y );
 123
 124         /* Get the current screen buffer size and window position. */
 125         if( GetConsoleScreenBufferInfo( hstdout, &csbiInfo ) )
 126         {
 127             rect.Top = 0; rect.Left = 0;
 128             rect.Right = csbiInfo.dwMaximumWindowSize.X - 1;
 129             rect.Bottom = csbiInfo.dwMaximumWindowSize.Y - 1;
 130             if( !SetConsoleWindowInfo( hstdout, TRUE, &rect ) )
 131                 msg_Dbg( p_vout, "SetConsoleWindowInfo failed: %ix%i",
 132                          rect.Right, rect.Bottom );
 133         }
 134     }
 135     else
 136     {
 137         msg_Err( p_vout, "cannot create console" );
 138         return VLC_EGENERIC;
 139     }
 140
 141 #endif
 142
 143     /* Allocate structure */
 144     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 145     if( p_vout->p_sys == NULL )
 146     {
 147         msg_Err( p_vout, "out of memory" );
 148         return VLC_ENOMEM;
 149     }
 150
 151 #ifdef CACA_API_VERSION_1
 152     p_vout->p_sys->p_qq = cucul_init(0, 0);
 153     if( !p_vout->p_sys->p_qq )
 154     {
 155         msg_Err( p_vout, "cannot initialize libcucul" );
 156         free( p_vout->p_sys );
 157         return VLC_EGENERIC;
 158     }
 159
 160     p_vout->p_sys->p_kk = caca_attach( p_vout->p_sys->p_qq );
 161     if( !p_vout->p_sys->p_kk )
 162     {
 163         msg_Err( p_vout, "cannot initialize libcaca" );
 164         cucul_end( p_vout->p_sys->p_qq );
 165         free( p_vout->p_sys );
 166         return VLC_EGENERIC;
 167     }
 168
 169     caca_set_window_title( p_vout->p_sys->p_kk,
 170                            VOUT_TITLE " - Colour AsCii Art (caca)" );
 171 #else
 172     if( caca_init() )
 173     {
 174         msg_Err( p_vout, "cannot initialize libcaca" );
 175         free( p_vout->p_sys );
 176         return VLC_EGENERIC;
 177     }
 178
 179     caca_set_window_title( VOUT_TITLE " - Colour AsCii Art (caca)" );
 180 #endif
 181
 182     p_vout->pf_init = Init;
 183     p_vout->pf_end = End;
 184     p_vout->pf_manage = Manage;
 185     p_vout->pf_render = Render;
 186     p_vout->pf_display = Display;
 187
 188     return VLC_SUCCESS;
 189 }
 190
 191 /*****************************************************************************
 192  * Init: initialize libcaca video output thread
 193  *****************************************************************************/
 194 static int Init( vout_thread_t *p_vout )
 195 {
 196     int i_index;
 197     picture_t *p_pic = NULL;
 198
 199     I_OUTPUTPICTURES = 0;
 200
 201     p_vout->output.i_chroma = VLC_FOURCC('R','V','3','2');
 202     p_vout->output.i_width = p_vout->render.i_width;
 203     p_vout->output.i_height = p_vout->render.i_height;
 204     p_vout->output.i_aspect = p_vout->render.i_aspect;
 205
 206     p_vout->output.i_rmask = 0x00ff0000;
 207     p_vout->output.i_gmask = 0x0000ff00;
 208     p_vout->output.i_bmask = 0x000000ff;
 209
 210     /* Create the libcaca bitmap */
 211     p_vout->p_sys->p_bitmap =
 212 #ifdef CACA_API_VERSION_1
 213         cucul_create_bitmap
 214 #else
 215         caca_create_bitmap
 216 #endif
 217                        ( 32, p_vout->output.i_width, p_vout->output.i_height,
 218                          4 * ((p_vout->output.i_width + 15) & ~15),
 219                          p_vout->output.i_rmask, p_vout->output.i_gmask,
 220                          p_vout->output.i_bmask, 0x00000000 );
 221
 222     if( !p_vout->p_sys->p_bitmap )
 223     {
 224         msg_Err( p_vout, "could not create libcaca bitmap" );
 225         return VLC_EGENERIC;
 226     }
 227
 228     /* Find an empty picture slot */
 229     for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 230     {
 231         if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 232         {
 233             p_pic = p_vout->p_picture + i_index;
 234             break;
 235         }
 236     }
 237
 238     if( p_pic == NULL )
 239     {
 240         return VLC_EGENERIC;
 241     }
 242
 243     /* Allocate the picture */
 244     p_pic->p->i_lines = p_vout->output.i_height;
 245     p_pic->p->i_visible_lines = p_vout->output.i_height;
 246     p_pic->p->i_pitch = 4 * ((p_vout->output.i_width + 15) & ~15);
 247     p_pic->p->i_pixel_pitch = 4;
 248     p_pic->p->i_visible_pitch = 4 * p_vout->output.i_width;
 249     p_pic->i_planes = 1;
 250     p_pic->p->p_pixels = malloc( p_pic->p->i_pitch * p_pic->p->i_lines );
 251
 252     p_pic->i_status = DESTROYED_PICTURE;
 253     p_pic->i_type   = DIRECT_PICTURE;
 254
 255     PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 256     I_OUTPUTPICTURES++;
 257
 258     return VLC_SUCCESS;
 259 }
 260
 261 /*****************************************************************************
 262  * End: terminate libcaca video output thread
 263  *****************************************************************************/
 264 static void End( vout_thread_t *p_vout )
 265 {
 266 #ifdef CACA_API_VERSION_1
 267     cucul_free_bitmap( p_vout->p_sys->p_bitmap );
 268 #else
 269     caca_free_bitmap( p_vout->p_sys->p_bitmap );
 270 #endif
 271 }
 272
 273 /*****************************************************************************
 274  * Destroy: destroy libcaca video output thread
 275  *****************************************************************************
 276  * Terminate an output method created by AaCreateOutputMethod
 277  *****************************************************************************/
 278 static void Destroy( vlc_object_t *p_this )
 279 {
 280     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 281
 282 #ifdef CACA_API_VERSION_1
 283     caca_detach( p_vout->p_sys->p_kk );
 284     cucul_end( p_vout->p_sys->p_qq );
 285 #else
 286     caca_end();
 287 #endif
 288
 289 #if defined( WIN32 ) && !defined( UNDER_CE )
 290     FreeConsole();
 291 #endif
 292
 293     free( p_vout->p_sys );
 294 }
 295
 296 /*****************************************************************************
 297  * Manage: handle libcaca events
 298  *****************************************************************************
 299  * This function should be called regularly by video output thread. It manages
 300  * console events. It returns a non null value on error.
 301  *****************************************************************************/
 302 static int Manage( vout_thread_t *p_vout )
 303 {
 304     int event;
 305     vlc_value_t val;
 306
 307 #ifdef CACA_API_VERSION_1
 308     while(( event = caca_get_event(p_vout->p_sys->p_kk,
 309                                    CACA_EVENT_KEY_PRESS | CACA_EVENT_RESIZE) ))
 310 #else
 311     while(( event = caca_get_event(CACA_EVENT_KEY_PRESS | CACA_EVENT_RESIZE) ))
 312 #endif
 313     {
 314         if( event == CACA_EVENT_RESIZE )
 315         {
 316             /* Acknowledge the resize */
 317 #ifdef CACA_API_VERSION_1
 318             caca_display( p_vout->p_sys->p_kk );
 319 #else
 320             caca_refresh();
 321 #endif
 322             continue;
 323         }
 324
 325         switch( event & 0x00ffffff )
 326         {
 327         case 'q':
 328             val.i_int = KEY_MODIFIER_CTRL | 'q';
 329             break;
 330         case ' ':
 331             val.i_int = KEY_SPACE;
 332             break;
 333         default:
 334             continue;
 335         }
 336
 337         var_Set( p_vout->p_vlc, "key-pressed", val );
 338     }
 339
 340     return VLC_SUCCESS;
 341 }
 342
 343 /*****************************************************************************
 344  * Render: render previously calculated output
 345  *****************************************************************************/
 346 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
 347 {
 348 #ifdef CACA_API_VERSION_1
 349     cucul_clear( p_vout->p_sys->p_qq );
 350     cucul_draw_bitmap( p_vout->p_sys->p_qq,
 351                        0, 0,
 352                        cucul_get_width( p_vout->p_sys->p_qq ) - 1,
 353                        cucul_get_height( p_vout->p_sys->p_qq ) - 1,
 354                        p_vout->p_sys->p_bitmap, p_pic->p->p_pixels );
 355 #else
 356     caca_clear();
 357     caca_draw_bitmap( 0, 0, caca_get_width() - 1, caca_get_height() - 1,
 358                       p_vout->p_sys->p_bitmap, p_pic->p->p_pixels );
 359 #endif
 360 }
 361
 362 /*****************************************************************************
 363  * Display: displays previously rendered output
 364  *****************************************************************************/
 365 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
 366 {
 367 #ifdef CACA_API_VERSION_1
 368     caca_display( p_vout->p_sys->p_kk );
 369 #else
 370     caca_refresh();
 371 #endif
 372 }
 373