1 /*****************************************************************************
2 * caca.c: Color ASCII Art video output plugin using libcaca
3 *****************************************************************************
4 * Copyright (C) 2003-2009 the VideoLAN team
7 * Authors: Sam Hocevar <sam@zoy.org>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
35 #include <vlc_interface.h>
36 #include <vlc_playlist.h>
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)
64 /*****************************************************************************
66 *****************************************************************************/
67 static int Create ( vlc_object_t * );
68 static void Destroy ( vlc_object_t * );
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 * );
76 /*****************************************************************************
78 *****************************************************************************/
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 )
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 *****************************************************************************/
98 cucul_dither_t *p_dither;
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 )
108 vout_thread_t *p_vout = (vout_thread_t *)p_this;
110 #if defined( WIN32 ) && !defined( UNDER_CE )
111 CONSOLE_SCREEN_BUFFER_INFO csbiInfo;
116 if( !AllocConsole() )
118 msg_Err( p_vout, "cannot create console" );
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 )
128 msg_Err( p_vout, "cannot create screen buffer" );
133 if( !SetConsoleActiveScreenBuffer( hstdout) )
135 msg_Err( p_vout, "cannot set active screen buffer" );
140 coord = GetLargestConsoleWindowSize( hstdout );
141 msg_Dbg( p_vout, "SetConsoleWindowInfo: %ix%i", coord.X, coord.Y );
143 /* Force size for now */
147 if( !SetConsoleScreenBufferSize( hstdout, coord ) )
148 msg_Warn( p_vout, "SetConsoleScreenBufferSize %i %i",
151 /* Get the current screen buffer size and window position. */
152 if( GetConsoleScreenBufferInfo( hstdout, &csbiInfo ) )
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 );
163 /* Allocate structure */
164 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
165 if( p_vout->p_sys == NULL )
167 #if defined( WIN32 ) && !defined( UNDER_CE )
173 p_vout->p_sys->p_cv = cucul_create_canvas(0, 0);
174 if( !p_vout->p_sys->p_cv )
176 msg_Err( p_vout, "cannot initialize libcucul" );
177 #if defined( WIN32 ) && !defined( UNDER_CE )
180 free( p_vout->p_sys );
184 p_vout->p_sys->p_dp = caca_create_display( p_vout->p_sys->p_cv );
185 if( !p_vout->p_sys->p_dp )
187 msg_Err( p_vout, "cannot initialize libcaca" );
188 cucul_free_canvas( p_vout->p_sys->p_cv );
189 #if defined( WIN32 ) && !defined( UNDER_CE )
192 free( p_vout->p_sys );
196 caca_set_display_title( p_vout->p_sys->p_dp,
197 VOUT_TITLE " - Colour AsCii Art (caca)" );
199 p_vout->pf_init = Init;
200 p_vout->pf_end = End;
201 p_vout->pf_manage = Manage;
202 p_vout->pf_render = Render;
203 p_vout->pf_display = Display;
208 /*****************************************************************************
209 * Init: initialize libcaca video output thread
210 *****************************************************************************/
211 static int Init( vout_thread_t *p_vout )
214 picture_t *p_pic = NULL;
216 I_OUTPUTPICTURES = 0;
218 p_vout->output.i_chroma = VLC_CODEC_RGB32;
219 p_vout->output.i_width = p_vout->render.i_width;
220 p_vout->output.i_height = p_vout->render.i_height;
221 p_vout->output.i_aspect = p_vout->render.i_aspect;
223 p_vout->output.i_rmask = 0x00ff0000;
224 p_vout->output.i_gmask = 0x0000ff00;
225 p_vout->output.i_bmask = 0x000000ff;
227 /* Create the libcaca dither object */
228 p_vout->p_sys->p_dither = cucul_create_dither
229 ( 32, p_vout->output.i_width, p_vout->output.i_height,
230 4 * ((p_vout->output.i_width + 15) & ~15),
231 p_vout->output.i_rmask, p_vout->output.i_gmask,
232 p_vout->output.i_bmask, 0x00000000 );
234 if( !p_vout->p_sys->p_dither )
236 msg_Err( p_vout, "could not create libcaca dither object" );
240 /* Find an empty picture slot */
241 for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
243 if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
245 p_pic = p_vout->p_picture + i_index;
255 /* Allocate the picture */
256 p_pic->p->i_lines = p_vout->output.i_height;
257 p_pic->p->i_visible_lines = p_vout->output.i_height;
258 p_pic->p->i_pitch = 4 * ((p_vout->output.i_width + 15) & ~15);
259 p_pic->p->i_pixel_pitch = 4;
260 p_pic->p->i_visible_pitch = 4 * p_vout->output.i_width;
262 p_pic->p->p_pixels = malloc( p_pic->p->i_pitch * p_pic->p->i_lines );
264 p_pic->i_status = DESTROYED_PICTURE;
265 p_pic->i_type = DIRECT_PICTURE;
267 PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
273 /*****************************************************************************
274 * End: terminate libcaca video output thread
275 *****************************************************************************/
276 static void End( vout_thread_t *p_vout )
278 cucul_free_dither( p_vout->p_sys->p_dither );
281 /*****************************************************************************
282 * Destroy: destroy libcaca video output thread
283 *****************************************************************************
284 * Terminate an output method created by AaCreateOutputMethod
285 *****************************************************************************/
286 static void Destroy( vlc_object_t *p_this )
288 vout_thread_t *p_vout = (vout_thread_t *)p_this;
290 caca_free_display( p_vout->p_sys->p_dp );
291 cucul_free_canvas( p_vout->p_sys->p_cv );
293 #if defined( WIN32 ) && !defined( UNDER_CE )
297 free( p_vout->p_sys );
300 /*****************************************************************************
301 * Manage: handle libcaca events
302 *****************************************************************************
303 * This function should be called regularly by video output thread. It manages
304 * console events. It returns a non null value on error.
305 *****************************************************************************/
306 static int Manage( vout_thread_t *p_vout )
308 #ifdef CACA_API_VERSION_1
309 struct caca_event ev;
314 while( caca_get_event(p_vout->p_sys->p_dp, CACA_EVENT_ANY, &ev, 0) )
316 playlist_t *p_playlist;
319 #ifdef CACA_API_VERSION_1
320 #ifdef CACA_EVENT_OPAQUE
321 switch( caca_get_event_type( &ev ) )
324 #endif /* CACA_EVENT_OPAQUE */
329 case CACA_EVENT_KEY_RELEASE:
330 #ifdef CACA_API_VERSION_1
331 #ifdef CACA_EVENT_OPAQUE
332 switch( caca_get_event_key_ch( &ev ) )
334 switch( ev.data.key.ch )
335 #endif /* CACA_EVENT_OPAQUE */
337 switch( ev & 0x00ffffff )
341 val.i_int = KEY_MODIFIER_CTRL | 'q';
344 val.i_int = KEY_SPACE;
350 var_Set( p_vout->p_libvlc, "key-pressed", val );
352 case CACA_EVENT_RESIZE:
353 /* Acknowledge the resize */
354 caca_refresh_display( p_vout->p_sys->p_dp );
356 #ifdef CACA_API_VERSION_1
357 case CACA_EVENT_MOUSE_MOTION:
359 #ifdef CACA_EVENT_OPAQUE
360 caca_get_event_mouse_x( &ev )
363 #endif /* CACA_EVENT_OPAQUE */
364 * p_vout->render.i_width
365 / cucul_get_canvas_width( p_vout->p_sys->p_cv );
366 var_Set( p_vout, "mouse-x", val );
368 #ifdef CACA_EVENT_OPAQUE
369 caca_get_event_mouse_y( &ev )
372 #endif /* CACA_EVENT_OPAQUE */
373 * p_vout->render.i_height
374 / cucul_get_canvas_height( p_vout->p_sys->p_cv );
375 var_Set( p_vout, "mouse-y", val );
376 var_SetBool( p_vout, "mouse-moved", true );
378 case CACA_EVENT_MOUSE_RELEASE:
379 var_SetBool( p_vout, "mouse-clicked", true );
381 case CACA_EVENT_QUIT:
383 p_playlist = pl_Hold( p_vout );
386 playlist_Stop( p_playlist );
387 pl_Release( p_vout );
389 libvlc_Quit( p_vout->p_libvlc );
401 /*****************************************************************************
402 * Render: render previously calculated output
403 *****************************************************************************/
404 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
406 cucul_set_color_ansi( p_vout->p_sys->p_cv,
407 CUCUL_COLOR_DEFAULT, CUCUL_COLOR_BLACK );
408 cucul_clear_canvas( p_vout->p_sys->p_cv );
409 cucul_dither_bitmap( p_vout->p_sys->p_cv, 0, 0,
410 cucul_get_canvas_width( p_vout->p_sys->p_cv ) - 1,
411 cucul_get_canvas_height( p_vout->p_sys->p_cv ) - 1,
412 p_vout->p_sys->p_dither, p_pic->p->p_pixels );
415 /*****************************************************************************
416 * Display: displays previously rendered output
417 *****************************************************************************/
418 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
421 caca_refresh_display( p_vout->p_sys->p_dp );