modules/video_output/caca.c

   1 /*****************************************************************************
   2  * caca.c: Color ASCII Art "vout display" module using libcaca
   3  *****************************************************************************
   4  * Copyright (C) 2003-2009 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Sam Hocevar <sam@zoy.org>
   8  *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_vout_display.h>
  36 #include <vlc_picture_pool.h>
  37 #if !defined(_WIN32) && !defined(__APPLE__)
  38 # ifdef X_DISPLAY_MISSING
  39 #  error Xlib required due to XInitThreads
  40 # endif
  41 # include <vlc_xlib.h>
  42 #endif
  43
  44 #include <caca.h>
  45
  46 /*****************************************************************************
  47  * Module descriptor
  48  *****************************************************************************/
  49 static int  Open (vlc_object_t *);
  50 static void Close(vlc_object_t *);
  51
  52 vlc_module_begin()
  53     set_shortname("Caca")
  54     set_category(CAT_VIDEO)
  55     set_subcategory(SUBCAT_VIDEO_VOUT)
  56     set_description(N_("Color ASCII art video output"))
  57     set_capability("vout display", 15)
  58     set_callbacks(Open, Close)
  59 vlc_module_end()
  60
  61 /*****************************************************************************
  62  * Local prototypes
  63  *****************************************************************************/
  64 static picture_pool_t *Pool  (vout_display_t *, unsigned);
  65 static void           Prepare(vout_display_t *, picture_t *, subpicture_t *);
  66 static void    PictureDisplay(vout_display_t *, picture_t *, subpicture_t *);
  67 static int            Control(vout_display_t *, int, va_list);
  68
  69 /* */
  70 static void Manage(vout_display_t *);
  71 static void Refresh(vout_display_t *);
  72 static void Place(vout_display_t *, vout_display_place_t *);
  73
  74 /* */
  75 struct vout_display_sys_t {
  76     cucul_canvas_t *cv;
  77     caca_display_t *dp;
  78     cucul_dither_t *dither;
  79
  80     picture_pool_t *pool;
  81 };
  82
  83 /**
  84  * This function initializes libcaca vout method.
  85  */
  86 static int Open(vlc_object_t *object)
  87 {
  88     vout_display_t *vd = (vout_display_t *)object;
  89     vout_display_sys_t *sys;
  90
  91     if (vout_display_IsWindowed(vd))
  92         return VLC_EGENERIC;
  93 #if !defined(__APPLE__) && !defined(_WIN32)
  94 # ifndef X_DISPLAY_MISSING
  95     if (!vlc_xlib_init(object))
  96         return VLC_EGENERIC;
  97 # endif
  98 #endif
  99
 100 #if defined(_WIN32)
 101     CONSOLE_SCREEN_BUFFER_INFO csbiInfo;
 102     SMALL_RECT rect;
 103     COORD coord;
 104     HANDLE hstdout;
 105
 106     if (!AllocConsole()) {
 107         msg_Err(vd, "cannot create console");
 108         return VLC_EGENERIC;
 109     }
 110
 111     hstdout =
 112         CreateConsoleScreenBuffer(GENERIC_READ | GENERIC_WRITE,
 113                                   FILE_SHARE_READ | FILE_SHARE_WRITE,
 114                                   NULL, CONSOLE_TEXTMODE_BUFFER, NULL);
 115     if (!hstdout || hstdout == INVALID_HANDLE_VALUE) {
 116         msg_Err(vd, "cannot create screen buffer");
 117         FreeConsole();
 118         return VLC_EGENERIC;
 119     }
 120
 121     if (!SetConsoleActiveScreenBuffer(hstdout)) {
 122         msg_Err(vd, "cannot set active screen buffer");
 123         FreeConsole();
 124         return VLC_EGENERIC;
 125     }
 126
 127     coord = GetLargestConsoleWindowSize(hstdout);
 128     msg_Dbg(vd, "SetConsoleWindowInfo: %ix%i", coord.X, coord.Y);
 129
 130     /* Force size for now */
 131     coord.X = 100;
 132     coord.Y = 40;
 133
 134     if (!SetConsoleScreenBufferSize(hstdout, coord))
 135         msg_Warn(vd, "SetConsoleScreenBufferSize %i %i",
 136                   coord.X, coord.Y);
 137
 138     /* Get the current screen buffer size and window position. */
 139     if (GetConsoleScreenBufferInfo(hstdout, &csbiInfo)) {
 140         rect.Top = 0; rect.Left = 0;
 141         rect.Right = csbiInfo.dwMaximumWindowSize.X - 1;
 142         rect.Bottom = csbiInfo.dwMaximumWindowSize.Y - 1;
 143         if (!SetConsoleWindowInfo(hstdout, TRUE, &rect))
 144             msg_Dbg(vd, "SetConsoleWindowInfo failed: %ix%i",
 145                      rect.Right, rect.Bottom);
 146     }
 147 #endif
 148
 149     /* Allocate structure */
 150     vd->sys = sys = calloc(1, sizeof(*sys));
 151     if (!sys)
 152         goto error;
 153
 154     sys->cv = cucul_create_canvas(0, 0);
 155     if (!sys->cv) {
 156         msg_Err(vd, "cannot initialize libcucul");
 157         goto error;
 158     }
 159
 160     const char *driver = NULL;
 161 #ifdef __APPLE__
 162     // Make sure we don't try to open a window.
 163     driver = "ncurses";
 164 #endif
 165
 166     sys->dp = caca_create_display_with_driver(sys->cv, driver);
 167     if (!sys->dp) {
 168         msg_Err(vd, "cannot initialize libcaca");
 169         goto error;
 170     }
 171
 172     if (vd->cfg->display.title)
 173         caca_set_display_title(sys->dp,
 174                                vd->cfg->display.title);
 175     else
 176         caca_set_display_title(sys->dp,
 177                                VOUT_TITLE "(Colour AsCii Art)");
 178
 179     /* Fix format */
 180     video_format_t fmt = vd->fmt;
 181     if (fmt.i_chroma != VLC_CODEC_RGB32) {
 182         fmt.i_chroma = VLC_CODEC_RGB32;
 183         fmt.i_rmask = 0x00ff0000;
 184         fmt.i_gmask = 0x0000ff00;
 185         fmt.i_bmask = 0x000000ff;
 186     }
 187
 188     /* Setup vout_display now that everything is fine */
 189     vd->fmt = fmt;
 190     vd->info.needs_event_thread = true;
 191
 192     vd->pool    = Pool;
 193     vd->prepare = Prepare;
 194     vd->display = PictureDisplay;
 195     vd->control = Control;
 196     vd->manage  = Manage;
 197
 198     /* Fix initial state */
 199     Refresh(vd);
 200
 201     return VLC_SUCCESS;
 202
 203 error:
 204     if (sys) {
 205         if (sys->pool)
 206             picture_pool_Release(sys->pool);
 207         if (sys->dither)
 208             cucul_free_dither(sys->dither);
 209         if (sys->dp)
 210             caca_free_display(sys->dp);
 211         if (sys->cv)
 212             cucul_free_canvas(sys->cv);
 213
 214         free(sys);
 215     }
 216 #if defined(_WIN32)
 217     FreeConsole();
 218 #endif
 219     return VLC_EGENERIC;
 220 }
 221
 222 /**
 223  * Close a libcaca video output
 224  */
 225 static void Close(vlc_object_t *object)
 226 {
 227     vout_display_t *vd = (vout_display_t *)object;
 228     vout_display_sys_t *sys = vd->sys;
 229
 230     if (sys->pool)
 231         picture_pool_Release(sys->pool);
 232     if (sys->dither)
 233         cucul_free_dither(sys->dither);
 234     caca_free_display(sys->dp);
 235     cucul_free_canvas(sys->cv);
 236
 237 #if defined(_WIN32)
 238     FreeConsole();
 239 #endif
 240
 241     free(sys);
 242 }
 243
 244 /**
 245  * Return a pool of direct buffers
 246  */
 247 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
 248 {
 249     vout_display_sys_t *sys = vd->sys;
 250
 251     if (!sys->pool)
 252         sys->pool = picture_pool_NewFromFormat(&vd->fmt, count);
 253     return sys->pool;
 254 }
 255
 256 /**
 257  * Prepare a picture for display */
 258 static void Prepare(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
 259 {
 260     vout_display_sys_t *sys = vd->sys;
 261
 262     if (!sys->dither) {
 263         /* Create the libcaca dither object */
 264         sys->dither = cucul_create_dither(32,
 265                                             vd->source.i_visible_width,
 266                                             vd->source.i_visible_height,
 267                                             picture->p[0].i_pitch,
 268                                             vd->fmt.i_rmask,
 269                                             vd->fmt.i_gmask,
 270                                             vd->fmt.i_bmask,
 271                                             0x00000000);
 272
 273         if (!sys->dither) {
 274             msg_Err(vd, "could not create libcaca dither object");
 275             return;
 276         }
 277     }
 278
 279     vout_display_place_t place;
 280     Place(vd, &place);
 281
 282     cucul_set_color_ansi(sys->cv, CUCUL_COLOR_DEFAULT, CUCUL_COLOR_BLACK);
 283     cucul_clear_canvas(sys->cv);
 284
 285     const int crop_offset = vd->source.i_y_offset * picture->p->i_pitch +
 286                             vd->source.i_x_offset * picture->p->i_pixel_pitch;
 287     cucul_dither_bitmap(sys->cv, place.x, place.y,
 288                         place.width, place.height,
 289                         sys->dither,
 290                         &picture->p->p_pixels[crop_offset]);
 291     VLC_UNUSED(subpicture);
 292 }
 293
 294 /**
 295  * Display a picture
 296  */
 297 static void PictureDisplay(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
 298 {
 299     Refresh(vd);
 300     picture_Release(picture);
 301     VLC_UNUSED(subpicture);
 302 }
 303
 304 /**
 305  * Control for vout display
 306  */
 307 static int Control(vout_display_t *vd, int query, va_list args)
 308 {
 309     vout_display_sys_t *sys = vd->sys;
 310
 311     (void) args;
 312
 313     switch (query) {
 314     case VOUT_DISPLAY_HIDE_MOUSE:
 315         caca_set_mouse(sys->dp, 0);
 316         return VLC_SUCCESS;
 317
 318     case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
 319     case VOUT_DISPLAY_CHANGE_ZOOM:
 320     case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
 321     case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
 322         return VLC_EGENERIC;
 323
 324     case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
 325         if (sys->dither)
 326             cucul_free_dither(sys->dither);
 327         sys->dither = NULL;
 328         return VLC_SUCCESS;
 329
 330     default:
 331         msg_Err(vd, "Unsupported query in vout display caca");
 332         return VLC_EGENERIC;
 333     }
 334 }
 335
 336 /**
 337  * Refresh the display and send resize event
 338  */
 339 static void Refresh(vout_display_t *vd)
 340 {
 341     vout_display_sys_t *sys = vd->sys;
 342
 343     /* */
 344     caca_refresh_display(sys->dp);
 345
 346     /* */
 347     const unsigned width  = caca_get_display_width(sys->dp);
 348     const unsigned height = caca_get_display_height(sys->dp);
 349
 350     if (width  != vd->cfg->display.width ||
 351         height != vd->cfg->display.height)
 352         vout_display_SendEventDisplaySize(vd, width, height);
 353 }
 354
 355 /**
 356  * Compute the place in canvas unit.
 357  */
 358 static void Place(vout_display_t *vd, vout_display_place_t *place)
 359 {
 360     vout_display_sys_t *sys = vd->sys;
 361
 362     vout_display_PlacePicture(place, &vd->source, vd->cfg, false);
 363
 364     const int canvas_width   = cucul_get_canvas_width(sys->cv);
 365     const int canvas_height  = cucul_get_canvas_height(sys->cv);
 366     const int display_width  = caca_get_display_width(sys->dp);
 367     const int display_height = caca_get_display_height(sys->dp);
 368
 369     if (display_width > 0 && display_height > 0) {
 370         place->x      =  place->x      * canvas_width  / display_width;
 371         place->y      =  place->y      * canvas_height / display_height;
 372         place->width  = (place->width  * canvas_width  + display_width/2)  / display_width;
 373         place->height = (place->height * canvas_height + display_height/2) / display_height;
 374     } else {
 375         place->x = 0;
 376         place->y = 0;
 377         place->width  = canvas_width;
 378         place->height = display_height;
 379     }
 380 }
 381
 382 /* */
 383 static const struct {
 384     int caca;
 385     int vlc;
 386 } keys[] = {
 387
 388     { CACA_KEY_CTRL_A,  KEY_MODIFIER_CTRL | 'a' },
 389     { CACA_KEY_CTRL_B,  KEY_MODIFIER_CTRL | 'b' },
 390     { CACA_KEY_CTRL_C,  KEY_MODIFIER_CTRL | 'c' },
 391     { CACA_KEY_CTRL_D,  KEY_MODIFIER_CTRL | 'd' },
 392     { CACA_KEY_CTRL_E,  KEY_MODIFIER_CTRL | 'e' },
 393     { CACA_KEY_CTRL_F,  KEY_MODIFIER_CTRL | 'f' },
 394     { CACA_KEY_CTRL_G,  KEY_MODIFIER_CTRL | 'g' },
 395     { CACA_KEY_BACKSPACE, KEY_BACKSPACE },
 396     { CACA_KEY_TAB,     KEY_TAB },
 397     { CACA_KEY_CTRL_J,  KEY_MODIFIER_CTRL | 'j' },
 398     { CACA_KEY_CTRL_K,  KEY_MODIFIER_CTRL | 'k' },
 399     { CACA_KEY_CTRL_L,  KEY_MODIFIER_CTRL | 'l' },
 400     { CACA_KEY_RETURN,  KEY_ENTER },
 401
 402     { CACA_KEY_CTRL_N,  KEY_MODIFIER_CTRL | 'n' },
 403     { CACA_KEY_CTRL_O,  KEY_MODIFIER_CTRL | 'o' },
 404     { CACA_KEY_CTRL_P,  KEY_MODIFIER_CTRL | 'p' },
 405     { CACA_KEY_CTRL_Q,  KEY_MODIFIER_CTRL | 'q' },
 406     { CACA_KEY_CTRL_R,  KEY_MODIFIER_CTRL | 'r' },
 407
 408     { CACA_KEY_PAUSE,   -1 },
 409     { CACA_KEY_CTRL_T,  KEY_MODIFIER_CTRL | 't' },
 410     { CACA_KEY_CTRL_U,  KEY_MODIFIER_CTRL | 'u' },
 411     { CACA_KEY_CTRL_V,  KEY_MODIFIER_CTRL | 'v' },
 412     { CACA_KEY_CTRL_W,  KEY_MODIFIER_CTRL | 'w' },
 413     { CACA_KEY_CTRL_X,  KEY_MODIFIER_CTRL | 'x' },
 414     { CACA_KEY_CTRL_Y,  KEY_MODIFIER_CTRL | 'y' },
 415     { CACA_KEY_CTRL_Z,  KEY_MODIFIER_CTRL | 'z' },
 416
 417     { CACA_KEY_ESCAPE,  KEY_ESC },
 418     { CACA_KEY_DELETE,  KEY_DELETE },
 419
 420     { CACA_KEY_F1,      KEY_F1 },
 421     { CACA_KEY_F2,      KEY_F2 },
 422     { CACA_KEY_F3,      KEY_F3 },
 423     { CACA_KEY_F4,      KEY_F4 },
 424     { CACA_KEY_F5,      KEY_F5 },
 425     { CACA_KEY_F6,      KEY_F6 },
 426     { CACA_KEY_F7,      KEY_F7 },
 427     { CACA_KEY_F8,      KEY_F8 },
 428     { CACA_KEY_F9,      KEY_F9 },
 429     { CACA_KEY_F10,     KEY_F10 },
 430     { CACA_KEY_F11,     KEY_F11 },
 431     { CACA_KEY_F12,     KEY_F12 },
 432     { CACA_KEY_F13,     -1 },
 433     { CACA_KEY_F14,     -1 },
 434     { CACA_KEY_F15,     -1 },
 435
 436     { CACA_KEY_UP,      KEY_UP },
 437     { CACA_KEY_DOWN,    KEY_DOWN },
 438     { CACA_KEY_LEFT,    KEY_LEFT },
 439     { CACA_KEY_RIGHT,   KEY_RIGHT },
 440
 441     { CACA_KEY_INSERT,  KEY_INSERT },
 442     { CACA_KEY_HOME,    KEY_HOME },
 443     { CACA_KEY_END,     KEY_END },
 444     { CACA_KEY_PAGEUP,  KEY_PAGEUP },
 445     { CACA_KEY_PAGEDOWN,KEY_PAGEDOWN },
 446
 447     /* */
 448     { -1, -1 }
 449 };
 450
 451 static const struct {
 452     int caca;
 453     int vlc;
 454 } mouses[] = {
 455     { 1, MOUSE_BUTTON_LEFT },
 456     { 2, MOUSE_BUTTON_CENTER },
 457     { 3, MOUSE_BUTTON_RIGHT },
 458     { 4, MOUSE_BUTTON_WHEEL_UP },
 459     { 5, MOUSE_BUTTON_WHEEL_DOWN },
 460
 461     /* */
 462     { -1, -1 }
 463 };
 464
 465 /**
 466  * Proccess pending event
 467  */
 468 static void Manage(vout_display_t *vd)
 469 {
 470     vout_display_sys_t *sys = vd->sys;
 471
 472     struct caca_event ev;
 473     while (caca_get_event(sys->dp, CACA_EVENT_ANY, &ev, 0) > 0) {
 474         switch (caca_get_event_type(&ev)) {
 475         case CACA_EVENT_KEY_PRESS: {
 476             const int caca = caca_get_event_key_ch(&ev);
 477
 478             for (int i = 0; keys[i].caca != -1; i++) {
 479                 if (keys[i].caca == caca) {
 480                     const int vlc = keys[i].vlc;
 481
 482                     if (vlc >= 0)
 483                         vout_display_SendEventKey(vd, vlc);
 484                     return;
 485                 }
 486             }
 487             if (caca >= 0x20 && caca <= 0x7f) {
 488                 vout_display_SendEventKey(vd, caca);
 489                 return;
 490             }
 491             break;
 492         }
 493         case CACA_EVENT_RESIZE:
 494             vout_display_SendEventDisplaySize(vd, caca_get_event_resize_width(&ev),
 495                                                   caca_get_event_resize_height(&ev));
 496             break;
 497         case CACA_EVENT_MOUSE_MOTION: {
 498             vout_display_place_t place;
 499             Place(vd, &place);
 500
 501             const unsigned x = vd->source.i_x_offset +
 502                                (int64_t)(caca_get_event_mouse_x(&ev) - place.x) *
 503                                     vd->source.i_visible_width / place.width;
 504             const unsigned y = vd->source.i_y_offset +
 505                                (int64_t)(caca_get_event_mouse_y(&ev) - place.y) *
 506                                     vd->source.i_visible_height / place.height;
 507
 508             caca_set_mouse(sys->dp, 1);
 509             vout_display_SendEventMouseMoved(vd, x, y);
 510             break;
 511         }
 512         case CACA_EVENT_MOUSE_PRESS:
 513         case CACA_EVENT_MOUSE_RELEASE: {
 514             caca_set_mouse(sys->dp, 1);
 515             const int caca = caca_get_event_mouse_button(&ev);
 516             for (int i = 0; mouses[i].caca != -1; i++) {
 517                 if (mouses[i].caca == caca) {
 518                     if (caca_get_event_type(&ev) == CACA_EVENT_MOUSE_PRESS)
 519                         vout_display_SendEventMousePressed(vd, mouses[i].vlc);
 520                     else
 521                         vout_display_SendEventMouseReleased(vd, mouses[i].vlc);
 522                     return;
 523                 }
 524             }
 525             break;
 526         }
 527         case CACA_EVENT_QUIT:
 528             vout_display_SendEventClose(vd);
 529             break;
 530         default:
 531             break;
 532         }
 533     }
 534 }
 535