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-2009 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
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_vout.h>
  35 #include <vlc_interface.h>
  36 #include <vlc_playlist.h>
  37 #include <vlc_keys.h>
  38
  39 #include <caca.h>
  40
  41 #ifndef CACA_API_VERSION_1
  42     /* Upward compatibility macros */
  43     typedef char cucul_canvas_t;
  44     typedef struct caca_bitmap cucul_dither_t;
  45     typedef char caca_display_t;
  46 #   define CUCUL_COLOR_DEFAULT CACA_COLOR_LIGHTGRAY
  47 #   define CUCUL_COLOR_BLACK CACA_COLOR_BLACK
  48 #   define cucul_clear_canvas(x) caca_clear()
  49 #   define cucul_create_canvas(x,y) "" /* kinda hacky */
  50 #   define cucul_create_dither caca_create_bitmap
  51 #   define cucul_dither_bitmap(x,y,z,t,u,v,w) caca_draw_bitmap(y,z,t,u,v,w)
  52 #   define cucul_free_dither caca_free_bitmap
  53 #   define cucul_free_canvas(x)
  54 #   define cucul_get_canvas_width(x) caca_get_width()
  55 #   define cucul_get_canvas_height(x) caca_get_height()
  56 #   define cucul_set_color(x,y,z) caca_set_color(y,z)
  57 #   define caca_create_display(x) (caca_init() ? NULL : "") /* hacky, too */
  58 #   define caca_free_display(x) caca_end()
  59 #   define caca_get_event(x,y,z,t) *(z) = caca_get_event(y)
  60 #   define caca_refresh_display(x) caca_refresh()
  61 #   define caca_set_display_title(x,y) caca_set_window_title(y)
  62 #endif
  63
  64 /*****************************************************************************
  65  * Local prototypes
  66  *****************************************************************************/
  67 static int  Create    ( vlc_object_t * );
  68 static void Destroy   ( vlc_object_t * );
  69
  70 static int  Init      ( vout_thread_t * );
  71 static void End       ( vout_thread_t * );
  72 static int  Manage    ( vout_thread_t * );
  73 static void Render    ( vout_thread_t *, picture_t * );
  74 static void Display   ( vout_thread_t *, picture_t * );
  75
  76 /*****************************************************************************
  77  * Module descriptor
  78  *****************************************************************************/
  79 vlc_module_begin ()
  80     set_shortname( "Caca" )
  81     set_category( CAT_VIDEO )
  82     set_subcategory( SUBCAT_VIDEO_VOUT )
  83     set_description( N_("Color ASCII art video output") )
  84     set_capability( "video output", 12 )
  85     set_callbacks( Create, Destroy )
  86 vlc_module_end ()
  87
  88 /*****************************************************************************
  89  * vout_sys_t: libcaca video output method descriptor
  90  *****************************************************************************
  91  * This structure is part of the video output thread descriptor.
  92  * It describes the libcaca specific properties of an output thread.
  93  *****************************************************************************/
  94 struct vout_sys_t
  95 {
  96     cucul_canvas_t *p_cv;
  97     caca_display_t *p_dp;
  98     cucul_dither_t *p_dither;
  99 };
 100
 101 /*****************************************************************************
 102  * Create: allocates libcaca video output thread
 103  *****************************************************************************
 104  * This function initializes libcaca vout method.
 105  *****************************************************************************/
 106 static int Create( vlc_object_t *p_this )
 107 {
 108     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 109
 110 #if defined( WIN32 ) && !defined( UNDER_CE )
 111     CONSOLE_SCREEN_BUFFER_INFO csbiInfo;
 112     SMALL_RECT rect;
 113     COORD coord;
 114     HANDLE hstdout;
 115
 116     if( !AllocConsole() )
 117     {
 118         msg_Err( p_vout, "cannot create console" );
 119         return VLC_EGENERIC;
 120     }
 121
 122     hstdout =
 123         CreateConsoleScreenBuffer( GENERIC_READ | GENERIC_WRITE,
 124                                    FILE_SHARE_READ | FILE_SHARE_WRITE,
 125                                    NULL, CONSOLE_TEXTMODE_BUFFER, NULL );
 126     if( !hstdout || hstdout == INVALID_HANDLE_VALUE )
 127     {
 128         msg_Err( p_vout, "cannot create screen buffer" );
 129         FreeConsole();
 130         return VLC_EGENERIC;
 131     }
 132
 133     if( !SetConsoleActiveScreenBuffer( hstdout) )
 134     {
 135         msg_Err( p_vout, "cannot set active screen buffer" );
 136         FreeConsole();
 137         return VLC_EGENERIC;
 138     }
 139
 140     coord = GetLargestConsoleWindowSize( hstdout );
 141     msg_Dbg( p_vout, "SetConsoleWindowInfo: %ix%i", coord.X, coord.Y );
 142
 143     /* Force size for now */
 144     coord.X = 100;
 145     coord.Y = 40;
 146
 147     if( !SetConsoleScreenBufferSize( hstdout, coord ) )
 148         msg_Warn( p_vout, "SetConsoleScreenBufferSize %i %i",
 149                   coord.X, coord.Y );
 150
 151     /* Get the current screen buffer size and window position. */
 152     if( GetConsoleScreenBufferInfo( hstdout, &csbiInfo ) )
 153     {
 154         rect.Top = 0; rect.Left = 0;
 155         rect.Right = csbiInfo.dwMaximumWindowSize.X - 1;
 156         rect.Bottom = csbiInfo.dwMaximumWindowSize.Y - 1;
 157         if( !SetConsoleWindowInfo( hstdout, TRUE, &rect ) )
 158             msg_Dbg( p_vout, "SetConsoleWindowInfo failed: %ix%i",
 159                      rect.Right, rect.Bottom );
 160     }
 161 #endif
 162
 163     /* Allocate structure */
 164     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 165     if( p_vout->p_sys == NULL )
 166     {
 167         FreeConsole();
 168         return VLC_ENOMEM;
 169     }
 170
 171     p_vout->p_sys->p_cv = cucul_create_canvas(0, 0);
 172     if( !p_vout->p_sys->p_cv )
 173     {
 174         msg_Err( p_vout, "cannot initialize libcucul" );
 175         FreeConsole();
 176         free( p_vout->p_sys );
 177         return VLC_EGENERIC;
 178     }
 179
 180     p_vout->p_sys->p_dp = caca_create_display( p_vout->p_sys->p_cv );
 181     if( !p_vout->p_sys->p_dp )
 182     {
 183         msg_Err( p_vout, "cannot initialize libcaca" );
 184         cucul_free_canvas( p_vout->p_sys->p_cv );
 185         free( p_vout->p_sys );
 186         return VLC_EGENERIC;
 187     }
 188
 189     caca_set_display_title( p_vout->p_sys->p_dp,
 190                             VOUT_TITLE " - Colour AsCii Art (caca)" );
 191
 192     p_vout->pf_init = Init;
 193     p_vout->pf_end = End;
 194     p_vout->pf_manage = Manage;
 195     p_vout->pf_render = Render;
 196     p_vout->pf_display = Display;
 197
 198     return VLC_SUCCESS;
 199 }
 200
 201 /*****************************************************************************
 202  * Init: initialize libcaca video output thread
 203  *****************************************************************************/
 204 static int Init( vout_thread_t *p_vout )
 205 {
 206     int i_index;
 207     picture_t *p_pic = NULL;
 208
 209     I_OUTPUTPICTURES = 0;
 210
 211     p_vout->output.i_chroma = VLC_FOURCC('R','V','3','2');
 212     p_vout->output.i_width = p_vout->render.i_width;
 213     p_vout->output.i_height = p_vout->render.i_height;
 214     p_vout->output.i_aspect = p_vout->render.i_aspect;
 215
 216     p_vout->output.i_rmask = 0x00ff0000;
 217     p_vout->output.i_gmask = 0x0000ff00;
 218     p_vout->output.i_bmask = 0x000000ff;
 219
 220     /* Create the libcaca dither object */
 221     p_vout->p_sys->p_dither = cucul_create_dither
 222                        ( 32, p_vout->output.i_width, p_vout->output.i_height,
 223                          4 * ((p_vout->output.i_width + 15) & ~15),
 224                          p_vout->output.i_rmask, p_vout->output.i_gmask,
 225                          p_vout->output.i_bmask, 0x00000000 );
 226
 227     if( !p_vout->p_sys->p_dither )
 228     {
 229         msg_Err( p_vout, "could not create libcaca dither object" );
 230         return VLC_EGENERIC;
 231     }
 232
 233     /* Find an empty picture slot */
 234     for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 235     {
 236         if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 237         {
 238             p_pic = p_vout->p_picture + i_index;
 239             break;
 240         }
 241     }
 242
 243     if( p_pic == NULL )
 244     {
 245         return VLC_EGENERIC;
 246     }
 247
 248     /* Allocate the picture */
 249     p_pic->p->i_lines = p_vout->output.i_height;
 250     p_pic->p->i_visible_lines = p_vout->output.i_height;
 251     p_pic->p->i_pitch = 4 * ((p_vout->output.i_width + 15) & ~15);
 252     p_pic->p->i_pixel_pitch = 4;
 253     p_pic->p->i_visible_pitch = 4 * p_vout->output.i_width;
 254     p_pic->i_planes = 1;
 255     p_pic->p->p_pixels = malloc( p_pic->p->i_pitch * p_pic->p->i_lines );
 256
 257     p_pic->i_status = DESTROYED_PICTURE;
 258     p_pic->i_type   = DIRECT_PICTURE;
 259
 260     PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 261     I_OUTPUTPICTURES++;
 262
 263     return VLC_SUCCESS;
 264 }
 265
 266 /*****************************************************************************
 267  * End: terminate libcaca video output thread
 268  *****************************************************************************/
 269 static void End( vout_thread_t *p_vout )
 270 {
 271     cucul_free_dither( p_vout->p_sys->p_dither );
 272 }
 273
 274 /*****************************************************************************
 275  * Destroy: destroy libcaca video output thread
 276  *****************************************************************************
 277  * Terminate an output method created by AaCreateOutputMethod
 278  *****************************************************************************/
 279 static void Destroy( vlc_object_t *p_this )
 280 {
 281     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 282
 283     caca_free_display( p_vout->p_sys->p_dp );
 284     cucul_free_canvas( p_vout->p_sys->p_cv );
 285
 286 #if defined( WIN32 ) && !defined( UNDER_CE )
 287     FreeConsole();
 288 #endif
 289
 290     free( p_vout->p_sys );
 291 }
 292
 293 /*****************************************************************************
 294  * Manage: handle libcaca events
 295  *****************************************************************************
 296  * This function should be called regularly by video output thread. It manages
 297  * console events. It returns a non null value on error.
 298  *****************************************************************************/
 299 static int Manage( vout_thread_t *p_vout )
 300 {
 301 #ifdef CACA_API_VERSION_1
 302     struct caca_event ev;
 303 #else
 304     int ev;
 305 #endif
 306
 307     while( caca_get_event(p_vout->p_sys->p_dp, CACA_EVENT_ANY, &ev, 0) )
 308     {
 309         playlist_t *p_playlist;
 310         vlc_value_t val;
 311
 312 #ifdef CACA_API_VERSION_1
 313 #ifdef CACA_EVENT_OPAQUE
 314         switch( caca_get_event_type( &ev ) )
 315 #else
 316         switch( ev.type )
 317 #endif /* CACA_EVENT_OPAQUE */
 318 #else
 319         switch( ev )
 320 #endif
 321         {
 322         case CACA_EVENT_KEY_RELEASE:
 323 #ifdef CACA_API_VERSION_1
 324 #ifdef CACA_EVENT_OPAQUE
 325             switch( caca_get_event_key_ch( &ev ) )
 326 #else
 327             switch( ev.data.key.ch )
 328 #endif /* CACA_EVENT_OPAQUE */
 329 #else
 330             switch( ev & 0x00ffffff )
 331 #endif
 332             {
 333             case 'q':
 334                 val.i_int = KEY_MODIFIER_CTRL | 'q';
 335                 break;
 336             case ' ':
 337                 val.i_int = KEY_SPACE;
 338                 break;
 339             default:
 340                 continue;
 341             }
 342
 343             var_Set( p_vout->p_libvlc, "key-pressed", val );
 344             break;
 345         case CACA_EVENT_RESIZE:
 346             /* Acknowledge the resize */
 347             caca_refresh_display( p_vout->p_sys->p_dp );
 348             break;
 349 #ifdef CACA_API_VERSION_1
 350         case  CACA_EVENT_MOUSE_MOTION:
 351             val.i_int =
 352 #ifdef CACA_EVENT_OPAQUE
 353                 caca_get_event_mouse_x( &ev )
 354 #else
 355                 ev.data.mouse.x
 356 #endif /* CACA_EVENT_OPAQUE */
 357                 * p_vout->render.i_width
 358                          / cucul_get_canvas_width( p_vout->p_sys->p_cv );
 359             var_Set( p_vout, "mouse-x", val );
 360             val.i_int =
 361 #ifdef CACA_EVENT_OPAQUE
 362                 caca_get_event_mouse_y( &ev )
 363 #else
 364                 ev.data.mouse.y
 365 #endif /* CACA_EVENT_OPAQUE */
 366                 * p_vout->render.i_height
 367                          / cucul_get_canvas_height( p_vout->p_sys->p_cv );
 368             var_Set( p_vout, "mouse-y", val );
 369             var_SetBool( p_vout, "mouse-moved", true );
 370             break;
 371         case CACA_EVENT_MOUSE_RELEASE:
 372             var_SetBool( p_vout, "mouse-clicked", true );
 373             break;
 374         case CACA_EVENT_QUIT:
 375         {
 376             p_playlist = pl_Hold( p_vout );
 377             if( p_playlist )
 378             {
 379                 playlist_Stop( p_playlist );
 380                 pl_Release( p_vout );
 381             }
 382             libvlc_Quit( p_vout->p_libvlc );
 383             break;
 384         }
 385 #endif
 386         default:
 387             break;
 388         }
 389     }
 390
 391     return VLC_SUCCESS;
 392 }
 393
 394 /*****************************************************************************
 395  * Render: render previously calculated output
 396  *****************************************************************************/
 397 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
 398 {
 399     cucul_set_color_ansi( p_vout->p_sys->p_cv,
 400                      CUCUL_COLOR_DEFAULT, CUCUL_COLOR_BLACK );
 401     cucul_clear_canvas( p_vout->p_sys->p_cv );
 402     cucul_dither_bitmap( p_vout->p_sys->p_cv, 0, 0,
 403                          cucul_get_canvas_width( p_vout->p_sys->p_cv ) - 1,
 404                          cucul_get_canvas_height( p_vout->p_sys->p_cv ) - 1,
 405                          p_vout->p_sys->p_dither, p_pic->p->p_pixels );
 406 }
 407
 408 /*****************************************************************************
 409  * Display: displays previously rendered output
 410  *****************************************************************************/
 411 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
 412 {
 413     VLC_UNUSED(p_pic);
 414     caca_refresh_display( p_vout->p_sys->p_dp );
 415 }
 416