1 /*****************************************************************************
2 * caca.c: Color ASCII Art "vout display" module using libcaca
3 *****************************************************************************
4 * Copyright (C) 2003-2009 the VideoLAN team
7 * Authors: Sam Hocevar <sam@zoy.org>
8 * Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
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 General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_vout_display.h>
36 #include <vlc_picture_pool.h>
40 /*****************************************************************************
42 *****************************************************************************/
43 static int Open (vlc_object_t *);
44 static void Close(vlc_object_t *);
48 set_category(CAT_VIDEO)
49 set_subcategory(SUBCAT_VIDEO_VOUT)
50 set_description(N_("Color ASCII art video output"))
51 set_capability("vout display", 12)
52 set_callbacks(Open, Close)
55 /*****************************************************************************
57 *****************************************************************************/
58 static picture_pool_t *Pool (vout_display_t *, unsigned);
59 static void Prepare(vout_display_t *, picture_t *);
60 static void Display(vout_display_t *, picture_t *);
61 static int Control(vout_display_t *, int, va_list);
64 static void Manage(vout_display_t *);
65 static void Refresh(vout_display_t *);
66 static void Place(vout_display_t *, vout_display_place_t *);
69 struct vout_display_sys_t {
72 cucul_dither_t *dither;
78 * This function initializes libcaca vout method.
80 static int Open(vlc_object_t *object)
82 vout_display_t *vd = (vout_display_t *)object;
83 vout_display_sys_t *sys;
85 #if defined(WIN32) && !defined(UNDER_CE)
86 CONSOLE_SCREEN_BUFFER_INFO csbiInfo;
91 if (!AllocConsole()) {
92 msg_Err(vd, "cannot create console");
97 CreateConsoleScreenBuffer(GENERIC_READ | GENERIC_WRITE,
98 FILE_SHARE_READ | FILE_SHARE_WRITE,
99 NULL, CONSOLE_TEXTMODE_BUFFER, NULL);
100 if (!hstdout || hstdout == INVALID_HANDLE_VALUE) {
101 msg_Err(vd, "cannot create screen buffer");
106 if (!SetConsoleActiveScreenBuffer(hstdout)) {
107 msg_Err(vd, "cannot set active screen buffer");
112 coord = GetLargestConsoleWindowSize(hstdout);
113 msg_Dbg(vd, "SetConsoleWindowInfo: %ix%i", coord.X, coord.Y);
115 /* Force size for now */
119 if (!SetConsoleScreenBufferSize(hstdout, coord))
120 msg_Warn(vd, "SetConsoleScreenBufferSize %i %i",
123 /* Get the current screen buffer size and window position. */
124 if (GetConsoleScreenBufferInfo(hstdout, &csbiInfo)) {
125 rect.Top = 0; rect.Left = 0;
126 rect.Right = csbiInfo.dwMaximumWindowSize.X - 1;
127 rect.Bottom = csbiInfo.dwMaximumWindowSize.Y - 1;
128 if (!SetConsoleWindowInfo(hstdout, TRUE, &rect))
129 msg_Dbg(vd, "SetConsoleWindowInfo failed: %ix%i",
130 rect.Right, rect.Bottom);
134 /* Allocate structure */
135 vd->sys = sys = calloc(1, sizeof(*sys));
139 sys->cv = cucul_create_canvas(0, 0);
141 msg_Err(vd, "cannot initialize libcucul");
145 sys->dp = caca_create_display(sys->cv);
147 msg_Err(vd, "cannot initialize libcaca");
151 if (vd->cfg->display.title)
152 caca_set_display_title(sys->dp,
153 vd->cfg->display.title);
155 caca_set_display_title(sys->dp,
156 VOUT_TITLE "(Colour AsCii Art)");
159 video_format_t fmt = vd->fmt;
160 if (fmt.i_chroma != VLC_CODEC_RGB32) {
161 fmt.i_chroma = VLC_CODEC_RGB32;
162 fmt.i_rmask = 0x00ff0000;
163 fmt.i_gmask = 0x0000ff00;
164 fmt.i_bmask = 0x000000ff;
168 vout_display_info_t info = vd->info;
170 /* Setup vout_display now that everything is fine */
175 vd->prepare = Prepare;
176 vd->display = Display;
177 vd->control = Control;
180 /* Fix initial state */
181 vout_display_SendEventFullscreen(vd, false);
189 picture_pool_Delete(sys->pool);
191 cucul_free_dither(sys->dither);
193 caca_free_display(sys->dp);
195 cucul_free_canvas(sys->cv);
199 #if defined(WIN32) && !defined(UNDER_CE)
206 * Close a libcaca video output
208 static void Close(vlc_object_t *object)
210 vout_display_t *vd = (vout_display_t *)object;
211 vout_display_sys_t *sys = vd->sys;
214 picture_pool_Delete(sys->pool);
216 cucul_free_dither(sys->dither);
217 caca_free_display(sys->dp);
218 cucul_free_canvas(sys->cv);
220 #if defined(WIN32) && !defined(UNDER_CE)
228 * Return a pool of direct buffers
230 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
232 vout_display_sys_t *sys = vd->sys;
235 sys->pool = picture_pool_NewFromFormat(&vd->fmt, count);
240 * Prepare a picture for display */
241 static void Prepare(vout_display_t *vd, picture_t *picture)
243 vout_display_sys_t *sys = vd->sys;
246 /* Create the libcaca dither object */
247 sys->dither = cucul_create_dither(32,
248 vd->source.i_visible_width,
249 vd->source.i_visible_height,
250 picture->p[0].i_pitch,
257 msg_Err(vd, "could not create libcaca dither object");
262 vout_display_place_t place;
265 cucul_set_color_ansi(sys->cv, CUCUL_COLOR_DEFAULT, CUCUL_COLOR_BLACK);
266 cucul_clear_canvas(sys->cv);
268 const int crop_offset = vd->source.i_y_offset * picture->p->i_pitch +
269 vd->source.i_x_offset * picture->p->i_pixel_pitch;
270 cucul_dither_bitmap(sys->cv, place.x, place.y,
271 place.width, place.height,
273 &picture->p->p_pixels[crop_offset]);
279 static void Display(vout_display_t *vd, picture_t *picture)
282 picture_Release(picture);
286 * Control for vout display
288 static int Control(vout_display_t *vd, int query, va_list args)
290 vout_display_sys_t *sys = vd->sys;
293 case VOUT_DISPLAY_HIDE_MOUSE:
294 caca_set_mouse(sys->dp, 0);
297 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE: {
298 const vout_display_cfg_t *cfg = va_arg(args, const vout_display_cfg_t *);
300 caca_refresh_display(sys->dp);
302 /* Not quite good but not sure how to resize it */
303 if (cfg->display.width != caca_get_display_width(sys->dp) ||
304 cfg->display.height != caca_get_display_height(sys->dp))
309 case VOUT_DISPLAY_CHANGE_ZOOM:
310 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
311 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
314 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
316 cucul_free_dither(sys->dither);
321 msg_Err(vd, "Unsupported query in vout display caca");
327 * Refresh the display and send resize event
329 static void Refresh(vout_display_t *vd)
331 vout_display_sys_t *sys = vd->sys;
334 caca_refresh_display(sys->dp);
337 const unsigned width = caca_get_display_width(sys->dp);
338 const unsigned height = caca_get_display_height(sys->dp);
340 if (width != vd->cfg->display.width ||
341 height != vd->cfg->display.height)
342 vout_display_SendEventDisplaySize(vd, width, height, false);
346 * Compute the place in canvas unit.
348 static void Place(vout_display_t *vd, vout_display_place_t *place)
350 vout_display_sys_t *sys = vd->sys;
352 vout_display_PlacePicture(place, &vd->source, vd->cfg, false);
354 const int canvas_width = cucul_get_canvas_width(sys->cv);
355 const int canvas_height = cucul_get_canvas_height(sys->cv);
356 const int display_width = caca_get_display_width(sys->dp);
357 const int display_height = caca_get_display_height(sys->dp);
359 if (display_width > 0 && display_height > 0) {
360 place->x = place->x * canvas_width / display_width;
361 place->y = place->y * canvas_height / display_height;
362 place->width = (place->width * canvas_width + display_width/2) / display_width;
363 place->height = (place->height * canvas_height + display_height/2) / display_height;
367 place->width = canvas_width;
368 place->height = display_height;
373 static const struct {
378 { CACA_KEY_CTRL_A, KEY_MODIFIER_CTRL | 'a' },
379 { CACA_KEY_CTRL_B, KEY_MODIFIER_CTRL | 'b' },
380 { CACA_KEY_CTRL_C, KEY_MODIFIER_CTRL | 'c' },
381 { CACA_KEY_CTRL_D, KEY_MODIFIER_CTRL | 'd' },
382 { CACA_KEY_CTRL_E, KEY_MODIFIER_CTRL | 'e' },
383 { CACA_KEY_CTRL_F, KEY_MODIFIER_CTRL | 'f' },
384 { CACA_KEY_CTRL_G, KEY_MODIFIER_CTRL | 'g' },
385 { CACA_KEY_BACKSPACE, KEY_BACKSPACE },
386 { CACA_KEY_TAB, KEY_TAB },
387 { CACA_KEY_CTRL_J, KEY_MODIFIER_CTRL | 'j' },
388 { CACA_KEY_CTRL_K, KEY_MODIFIER_CTRL | 'k' },
389 { CACA_KEY_CTRL_L, KEY_MODIFIER_CTRL | 'l' },
390 { CACA_KEY_RETURN, KEY_ENTER },
392 { CACA_KEY_CTRL_N, KEY_MODIFIER_CTRL | 'n' },
393 { CACA_KEY_CTRL_O, KEY_MODIFIER_CTRL | 'o' },
394 { CACA_KEY_CTRL_P, KEY_MODIFIER_CTRL | 'p' },
395 { CACA_KEY_CTRL_Q, KEY_MODIFIER_CTRL | 'q' },
396 { CACA_KEY_CTRL_R, KEY_MODIFIER_CTRL | 'r' },
398 { CACA_KEY_PAUSE, -1 },
399 { CACA_KEY_CTRL_T, KEY_MODIFIER_CTRL | 't' },
400 { CACA_KEY_CTRL_U, KEY_MODIFIER_CTRL | 'u' },
401 { CACA_KEY_CTRL_V, KEY_MODIFIER_CTRL | 'v' },
402 { CACA_KEY_CTRL_W, KEY_MODIFIER_CTRL | 'w' },
403 { CACA_KEY_CTRL_X, KEY_MODIFIER_CTRL | 'x' },
404 { CACA_KEY_CTRL_Y, KEY_MODIFIER_CTRL | 'y' },
405 { CACA_KEY_CTRL_Z, KEY_MODIFIER_CTRL | 'z' },
407 { CACA_KEY_ESCAPE, KEY_ESC },
408 { CACA_KEY_DELETE, KEY_DELETE },
410 { CACA_KEY_F1, KEY_F1 },
411 { CACA_KEY_F2, KEY_F2 },
412 { CACA_KEY_F3, KEY_F3 },
413 { CACA_KEY_F4, KEY_F4 },
414 { CACA_KEY_F5, KEY_F5 },
415 { CACA_KEY_F6, KEY_F6 },
416 { CACA_KEY_F7, KEY_F7 },
417 { CACA_KEY_F8, KEY_F8 },
418 { CACA_KEY_F9, KEY_F9 },
419 { CACA_KEY_F10, KEY_F10 },
420 { CACA_KEY_F11, KEY_F11 },
421 { CACA_KEY_F12, KEY_F12 },
422 { CACA_KEY_F13, -1 },
423 { CACA_KEY_F14, -1 },
424 { CACA_KEY_F15, -1 },
426 { CACA_KEY_UP, KEY_UP },
427 { CACA_KEY_DOWN, KEY_DOWN },
428 { CACA_KEY_LEFT, KEY_LEFT },
429 { CACA_KEY_RIGHT, KEY_RIGHT },
431 { CACA_KEY_INSERT, KEY_INSERT },
432 { CACA_KEY_HOME, KEY_HOME },
433 { CACA_KEY_END, KEY_END },
434 { CACA_KEY_PAGEUP, KEY_PAGEUP },
435 { CACA_KEY_PAGEDOWN,KEY_PAGEDOWN },
441 static const struct {
445 { 1, MOUSE_BUTTON_LEFT },
446 { 2, MOUSE_BUTTON_CENTER },
447 { 3, MOUSE_BUTTON_RIGHT },
448 { 4, MOUSE_BUTTON_WHEEL_UP },
449 { 5, MOUSE_BUTTON_WHEEL_DOWN },
456 * Proccess pending event
458 static void Manage(vout_display_t *vd)
460 vout_display_sys_t *sys = vd->sys;
462 struct caca_event ev;
463 while (caca_get_event(sys->dp, CACA_EVENT_ANY, &ev, 0) > 0) {
464 switch (caca_get_event_type(&ev)) {
465 case CACA_EVENT_KEY_PRESS: {
466 const int caca = caca_get_event_key_ch(&ev);
468 for (int i = 0; keys[i].caca != -1; i++) {
469 if (keys[i].caca == caca) {
470 const int vlc = keys[i].vlc;
473 vout_display_SendEventKey(vd, vlc);
477 if (caca >= 0x20 && caca <= 0x7f) {
478 vout_display_SendEventKey(vd, caca);
483 case CACA_EVENT_RESIZE:
484 vout_display_SendEventDisplaySize(vd, caca_get_event_resize_width(&ev),
485 caca_get_event_resize_height(&ev), false);
487 case CACA_EVENT_MOUSE_MOTION: {
488 vout_display_place_t place;
491 const unsigned x = vd->source.i_x_offset +
492 (int64_t)(caca_get_event_mouse_x(&ev) - place.x) *
493 vd->source.i_visible_width / place.width;
494 const unsigned y = vd->source.i_y_offset +
495 (int64_t)(caca_get_event_mouse_y(&ev) - place.y) *
496 vd->source.i_visible_height / place.height;
498 caca_set_mouse(sys->dp, 1);
499 vout_display_SendEventMouseMoved(vd, x, y);
502 case CACA_EVENT_MOUSE_PRESS:
503 case CACA_EVENT_MOUSE_RELEASE: {
504 caca_set_mouse(sys->dp, 1);
505 const int caca = caca_get_event_mouse_button(&ev);
506 for (int i = 0; mouses[i].caca != -1; i++) {
507 if (mouses[i].caca == caca) {
508 if (caca_get_event_type(&ev) == CACA_EVENT_MOUSE_PRESS)
509 vout_display_SendEventMousePressed(vd, mouses[i].vlc);
511 vout_display_SendEventMouseReleased(vd, mouses[i].vlc);
517 case CACA_EVENT_QUIT:
518 vout_display_SendEventClose(vd);