1 /*****************************************************************************
2 * caca.c: Color ASCII Art "vout display" module using libcaca
3 *****************************************************************************
4 * Copyright (C) 2003-2009 VLC authors and VideoLAN
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 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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
33 #include <stdnoreturn.h>
36 #include <vlc_common.h>
37 #include <vlc_block.h>
38 #include <vlc_plugin.h>
39 #include <vlc_vout_display.h>
40 #include <vlc_picture_pool.h>
41 #if !defined(_WIN32) && !defined(__APPLE__)
42 # ifdef X_DISPLAY_MISSING
43 # error Xlib required due to XInitThreads
45 # include <vlc_xlib.h>
51 struct vout_display_sys_t
{
54 cucul_dither_t
*dither
;
60 vlc_tick_t cursor_timeout
;
61 vlc_tick_t cursor_deadline
;
64 noreturn
static void *VoutDisplayEventKeyDispatch(void *data
)
66 vout_display_t
*vd
= data
;
67 vout_display_sys_t
*sys
= vd
->sys
;
68 block_fifo_t
*fifo
= sys
->fifo
;
71 block_t
*event
= block_FifoGet(fifo
);
73 int cancel
= vlc_savecancel();
76 memcpy(&key
, event
->p_buffer
, sizeof (key
));
78 vout_window_ReportKeyPress(vd
->cfg
->window
, key
);
79 vlc_restorecancel(cancel
);
83 static void VoutDisplayEventKey(vout_display_sys_t
*sys
, int key
)
85 block_t
*event
= block_Alloc(sizeof (key
));
86 if (likely(event
!= NULL
)) {
87 memcpy(event
->p_buffer
, &key
, sizeof (key
));
88 block_FifoPut(sys
->fifo
, event
);
93 * Return a pool of direct buffers
95 static picture_pool_t
*Pool(vout_display_t
*vd
, unsigned count
)
97 vout_display_sys_t
*sys
= vd
->sys
;
100 sys
->pool
= picture_pool_NewFromFormat(&vd
->fmt
, count
);
105 * Compute the place in canvas unit.
107 static void Place(vout_display_t
*vd
, vout_display_place_t
*place
)
109 vout_display_sys_t
*sys
= vd
->sys
;
111 vout_display_PlacePicture(place
, &vd
->source
, vd
->cfg
, false);
113 const int canvas_width
= cucul_get_canvas_width(sys
->cv
);
114 const int canvas_height
= cucul_get_canvas_height(sys
->cv
);
115 const int display_width
= caca_get_display_width(sys
->dp
);
116 const int display_height
= caca_get_display_height(sys
->dp
);
118 if (display_width
> 0 && display_height
> 0) {
119 place
->x
= place
->x
* canvas_width
/ display_width
;
120 place
->y
= place
->y
* canvas_height
/ display_height
;
121 place
->width
= (place
->width
* canvas_width
+ display_width
/2) / display_width
;
122 place
->height
= (place
->height
* canvas_height
+ display_height
/2) / display_height
;
126 place
->width
= canvas_width
;
127 place
->height
= display_height
;
131 static void Manage(vout_display_t
*vd
);
134 * Prepare a picture for display */
135 static void Prepare(vout_display_t
*vd
, picture_t
*picture
,
136 subpicture_t
*subpicture
, vlc_tick_t date
)
141 vout_display_sys_t
*sys
= vd
->sys
;
144 /* Create the libcaca dither object */
145 sys
->dither
= cucul_create_dither(32,
146 vd
->source
.i_visible_width
,
147 vd
->source
.i_visible_height
,
148 picture
->p
[0].i_pitch
,
155 msg_Err(vd
, "could not create libcaca dither object");
160 vout_display_place_t place
;
163 cucul_set_color_ansi(sys
->cv
, CUCUL_COLOR_DEFAULT
, CUCUL_COLOR_BLACK
);
164 cucul_clear_canvas(sys
->cv
);
166 const int crop_offset
= vd
->source
.i_y_offset
* picture
->p
->i_pitch
+
167 vd
->source
.i_x_offset
* picture
->p
->i_pixel_pitch
;
168 cucul_dither_bitmap(sys
->cv
, place
.x
, place
.y
,
169 place
.width
, place
.height
,
171 &picture
->p
->p_pixels
[crop_offset
]);
172 VLC_UNUSED(subpicture
);
178 static void PictureDisplay(vout_display_t
*vd
, picture_t
*picture
, subpicture_t
*subpicture
)
180 vout_display_sys_t
*sys
= vd
->sys
;
182 caca_refresh_display(sys
->dp
);
183 picture_Release(picture
);
184 VLC_UNUSED(subpicture
);
188 * Control for vout display
190 static int Control(vout_display_t
*vd
, int query
, va_list args
)
192 vout_display_sys_t
*sys
= vd
->sys
;
197 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE
:
198 case VOUT_DISPLAY_CHANGE_ZOOM
:
199 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED
:
200 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT
:
203 case VOUT_DISPLAY_CHANGE_SOURCE_CROP
:
205 cucul_free_dither(sys
->dither
);
210 msg_Err(vd
, "Unsupported query in vout display caca");
216 static const struct {
221 { CACA_KEY_CTRL_A
, KEY_MODIFIER_CTRL
| 'a' },
222 { CACA_KEY_CTRL_B
, KEY_MODIFIER_CTRL
| 'b' },
223 { CACA_KEY_CTRL_C
, KEY_MODIFIER_CTRL
| 'c' },
224 { CACA_KEY_CTRL_D
, KEY_MODIFIER_CTRL
| 'd' },
225 { CACA_KEY_CTRL_E
, KEY_MODIFIER_CTRL
| 'e' },
226 { CACA_KEY_CTRL_F
, KEY_MODIFIER_CTRL
| 'f' },
227 { CACA_KEY_CTRL_G
, KEY_MODIFIER_CTRL
| 'g' },
228 { CACA_KEY_BACKSPACE
, KEY_BACKSPACE
},
229 { CACA_KEY_TAB
, KEY_TAB
},
230 { CACA_KEY_CTRL_J
, KEY_MODIFIER_CTRL
| 'j' },
231 { CACA_KEY_CTRL_K
, KEY_MODIFIER_CTRL
| 'k' },
232 { CACA_KEY_CTRL_L
, KEY_MODIFIER_CTRL
| 'l' },
233 { CACA_KEY_RETURN
, KEY_ENTER
},
235 { CACA_KEY_CTRL_N
, KEY_MODIFIER_CTRL
| 'n' },
236 { CACA_KEY_CTRL_O
, KEY_MODIFIER_CTRL
| 'o' },
237 { CACA_KEY_CTRL_P
, KEY_MODIFIER_CTRL
| 'p' },
238 { CACA_KEY_CTRL_Q
, KEY_MODIFIER_CTRL
| 'q' },
239 { CACA_KEY_CTRL_R
, KEY_MODIFIER_CTRL
| 'r' },
241 { CACA_KEY_PAUSE
, -1 },
242 { CACA_KEY_CTRL_T
, KEY_MODIFIER_CTRL
| 't' },
243 { CACA_KEY_CTRL_U
, KEY_MODIFIER_CTRL
| 'u' },
244 { CACA_KEY_CTRL_V
, KEY_MODIFIER_CTRL
| 'v' },
245 { CACA_KEY_CTRL_W
, KEY_MODIFIER_CTRL
| 'w' },
246 { CACA_KEY_CTRL_X
, KEY_MODIFIER_CTRL
| 'x' },
247 { CACA_KEY_CTRL_Y
, KEY_MODIFIER_CTRL
| 'y' },
248 { CACA_KEY_CTRL_Z
, KEY_MODIFIER_CTRL
| 'z' },
250 { CACA_KEY_ESCAPE
, KEY_ESC
},
251 { CACA_KEY_DELETE
, KEY_DELETE
},
253 { CACA_KEY_F1
, KEY_F1
},
254 { CACA_KEY_F2
, KEY_F2
},
255 { CACA_KEY_F3
, KEY_F3
},
256 { CACA_KEY_F4
, KEY_F4
},
257 { CACA_KEY_F5
, KEY_F5
},
258 { CACA_KEY_F6
, KEY_F6
},
259 { CACA_KEY_F7
, KEY_F7
},
260 { CACA_KEY_F8
, KEY_F8
},
261 { CACA_KEY_F9
, KEY_F9
},
262 { CACA_KEY_F10
, KEY_F10
},
263 { CACA_KEY_F11
, KEY_F11
},
264 { CACA_KEY_F12
, KEY_F12
},
265 { CACA_KEY_F13
, -1 },
266 { CACA_KEY_F14
, -1 },
267 { CACA_KEY_F15
, -1 },
269 { CACA_KEY_UP
, KEY_UP
},
270 { CACA_KEY_DOWN
, KEY_DOWN
},
271 { CACA_KEY_LEFT
, KEY_LEFT
},
272 { CACA_KEY_RIGHT
, KEY_RIGHT
},
274 { CACA_KEY_INSERT
, KEY_INSERT
},
275 { CACA_KEY_HOME
, KEY_HOME
},
276 { CACA_KEY_END
, KEY_END
},
277 { CACA_KEY_PAGEUP
, KEY_PAGEUP
},
278 { CACA_KEY_PAGEDOWN
,KEY_PAGEDOWN
},
284 static const struct {
288 { 1, MOUSE_BUTTON_LEFT
},
289 { 2, MOUSE_BUTTON_CENTER
},
290 { 3, MOUSE_BUTTON_RIGHT
},
291 { 4, MOUSE_BUTTON_WHEEL_UP
},
292 { 5, MOUSE_BUTTON_WHEEL_DOWN
},
299 * Proccess pending event
301 static void Manage(vout_display_t
*vd
)
303 vout_display_sys_t
*sys
= vd
->sys
;
305 if (sys
->cursor_deadline
!= INT64_MAX
&& sys
->cursor_deadline
< vlc_tick_now()) {
306 caca_set_mouse(sys
->dp
, 0);
307 sys
->cursor_deadline
= INT64_MAX
;
310 struct caca_event ev
;
311 while (caca_get_event(sys
->dp
, CACA_EVENT_ANY
, &ev
, 0) > 0) {
312 switch (caca_get_event_type(&ev
)) {
313 case CACA_EVENT_KEY_PRESS
: {
314 const int caca
= caca_get_event_key_ch(&ev
);
316 for (int i
= 0; keys
[i
].caca
!= -1; i
++) {
317 if (keys
[i
].caca
== caca
) {
318 const int vlc
= keys
[i
].vlc
;
321 VoutDisplayEventKey(sys
, vlc
);
325 if (caca
>= 0x20 && caca
<= 0x7f) {
326 VoutDisplayEventKey(sys
, caca
);
331 case CACA_EVENT_RESIZE
:
333 case CACA_EVENT_MOUSE_MOTION
:
334 caca_set_mouse(sys
->dp
, 1);
335 sys
->cursor_deadline
= vlc_tick_now() + sys
->cursor_timeout
;
336 vout_window_ReportMouseMoved(vd
->cfg
->window
,
337 caca_get_event_mouse_x(&ev
),
338 caca_get_event_mouse_y(&ev
));
340 case CACA_EVENT_MOUSE_PRESS
:
341 case CACA_EVENT_MOUSE_RELEASE
: {
342 caca_set_mouse(sys
->dp
, 1);
343 sys
->cursor_deadline
= vlc_tick_now() + sys
->cursor_timeout
;
345 const int caca
= caca_get_event_mouse_button(&ev
);
346 for (int i
= 0; mouses
[i
].caca
!= -1; i
++) {
347 if (mouses
[i
].caca
== caca
) {
348 if (caca_get_event_type(&ev
) == CACA_EVENT_MOUSE_PRESS
)
349 vout_window_ReportMousePressed(vd
->cfg
->window
,
352 vout_window_ReportMouseReleased(vd
->cfg
->window
,
359 case CACA_EVENT_QUIT
:
360 vout_window_ReportClose(vd
->cfg
->window
);
369 * This function initializes libcaca vout method.
371 static int Open(vlc_object_t
*object
)
373 vout_display_t
*vd
= (vout_display_t
*)object
;
374 vout_display_sys_t
*sys
;
376 if (vout_display_IsWindowed(vd
))
378 #if !defined(__APPLE__) && !defined(_WIN32)
379 # ifndef X_DISPLAY_MISSING
380 if (!vlc_xlib_init(object
))
386 CONSOLE_SCREEN_BUFFER_INFO csbiInfo
;
391 if (!AllocConsole()) {
392 msg_Err(vd
, "cannot create console");
397 CreateConsoleScreenBuffer(GENERIC_READ
| GENERIC_WRITE
,
398 FILE_SHARE_READ
| FILE_SHARE_WRITE
,
399 NULL
, CONSOLE_TEXTMODE_BUFFER
, NULL
);
400 if (!hstdout
|| hstdout
== INVALID_HANDLE_VALUE
) {
401 msg_Err(vd
, "cannot create screen buffer");
406 if (!SetConsoleActiveScreenBuffer(hstdout
)) {
407 msg_Err(vd
, "cannot set active screen buffer");
412 coord
= GetLargestConsoleWindowSize(hstdout
);
413 msg_Dbg(vd
, "SetConsoleWindowInfo: %ix%i", coord
.X
, coord
.Y
);
415 /* Force size for now */
419 if (!SetConsoleScreenBufferSize(hstdout
, coord
))
420 msg_Warn(vd
, "SetConsoleScreenBufferSize %i %i",
423 /* Get the current screen buffer size and window position. */
424 if (GetConsoleScreenBufferInfo(hstdout
, &csbiInfo
)) {
425 rect
.Top
= 0; rect
.Left
= 0;
426 rect
.Right
= csbiInfo
.dwMaximumWindowSize
.X
- 1;
427 rect
.Bottom
= csbiInfo
.dwMaximumWindowSize
.Y
- 1;
428 if (!SetConsoleWindowInfo(hstdout
, TRUE
, &rect
))
429 msg_Dbg(vd
, "SetConsoleWindowInfo failed: %ix%i",
430 rect
.Right
, rect
.Bottom
);
434 /* Allocate structure */
435 vd
->sys
= sys
= calloc(1, sizeof(*sys
));
439 sys
->cv
= cucul_create_canvas(0, 0);
441 msg_Err(vd
, "cannot initialize libcucul");
445 const char *driver
= NULL
;
447 // Make sure we don't try to open a window.
451 sys
->dp
= caca_create_display_with_driver(sys
->cv
, driver
);
453 msg_Err(vd
, "cannot initialize libcaca");
457 char *title
= var_InheritString(vd
, "video-title");
458 caca_set_display_title(sys
->dp
,
459 (title
!= NULL
) ? title
: VOUT_TITLE
"(Colour AsCii Art)");
462 block_fifo_t
*fifo
= block_FifoNew();
463 if (likely(fifo
!= NULL
)) {
466 if (vlc_clone(&sys
->thread
, VoutDisplayEventKeyDispatch
, vd
,
467 VLC_THREAD_PRIORITY_LOW
)) {
468 block_FifoRelease(fifo
);
473 sys
->cursor_timeout
= VLC_TICK_FROM_MS( var_InheritInteger(vd
, "mouse-hide-timeout") );
474 sys
->cursor_deadline
= INT64_MAX
;
477 video_format_t fmt
= vd
->fmt
;
478 if (fmt
.i_chroma
!= VLC_CODEC_RGB32
) {
479 fmt
.i_chroma
= VLC_CODEC_RGB32
;
480 fmt
.i_rmask
= 0x00ff0000;
481 fmt
.i_gmask
= 0x0000ff00;
482 fmt
.i_bmask
= 0x000000ff;
485 /* Setup vout_display now that everything is fine */
489 vd
->prepare
= Prepare
;
490 vd
->display
= PictureDisplay
;
491 vd
->control
= Control
;
493 /* Fix initial state */
494 caca_refresh_display(sys
->dp
);
501 picture_pool_Release(sys
->pool
);
503 cucul_free_dither(sys
->dither
);
505 caca_free_display(sys
->dp
);
507 cucul_free_canvas(sys
->cv
);
518 * Close a libcaca video output
520 static void Close(vlc_object_t
*object
)
522 vout_display_t
*vd
= (vout_display_t
*)object
;
523 vout_display_sys_t
*sys
= vd
->sys
;
525 if (sys
->fifo
!= NULL
) {
526 vlc_cancel(sys
->thread
);
527 vlc_join(sys
->thread
, NULL
);
528 block_FifoRelease(sys
->fifo
);
531 picture_pool_Release(sys
->pool
);
533 cucul_free_dither(sys
->dither
);
534 caca_free_display(sys
->dp
);
535 cucul_free_canvas(sys
->cv
);
544 /*****************************************************************************
546 *****************************************************************************/
548 set_shortname("Caca")
549 set_category(CAT_VIDEO
)
550 set_subcategory(SUBCAT_VIDEO_VOUT
)
551 set_description(N_("Color ASCII art video output"))
552 set_capability("vout display", 15)
553 set_callbacks(Open
, Close
)