1 /*****************************************************************************
2 * caca.c: Color ASCII Art video output plugin using libcaca
3 *****************************************************************************
4 * Copyright (C) 2003, 2004 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 *****************************************************************************/
27 #include <errno.h> /* ENOMEM */
28 #include <stdlib.h> /* free() */
29 #include <string.h> /* strerror() */
38 /*****************************************************************************
40 *****************************************************************************/
41 static int Create ( vlc_object_t * );
42 static void Destroy ( vlc_object_t * );
44 static int Init ( vout_thread_t * );
45 static void End ( vout_thread_t * );
46 static int Manage ( vout_thread_t * );
47 static void Render ( vout_thread_t *, picture_t * );
48 static void Display ( vout_thread_t *, picture_t * );
50 /*****************************************************************************
52 *****************************************************************************/
54 set_shortname( "Caca" );
55 set_category( CAT_VIDEO );
56 set_subcategory( SUBCAT_VIDEO_VOUT );
57 set_description( _("Color ASCII art video output") );
58 set_capability( "video output", 12 );
59 set_callbacks( Create, Destroy );
62 /*****************************************************************************
63 * vout_sys_t: libcaca video output method descriptor
64 *****************************************************************************
65 * This structure is part of the video output thread descriptor.
66 * It describes the libcaca specific properties of an output thread.
67 *****************************************************************************/
70 #ifdef CACA_API_VERSION_1
73 cucul_dither_t *p_dither;
75 struct caca_bitmap *p_bitmap;
79 /*****************************************************************************
80 * Create: allocates libcaca video output thread
81 *****************************************************************************
82 * This function initializes libcaca vout method.
83 *****************************************************************************/
84 static int Create( vlc_object_t *p_this )
86 vout_thread_t *p_vout = (vout_thread_t *)p_this;
88 #if defined( WIN32 ) && !defined( UNDER_CE )
91 CONSOLE_SCREEN_BUFFER_INFO csbiInfo;
96 CreateConsoleScreenBuffer( GENERIC_READ | GENERIC_WRITE,
97 FILE_SHARE_READ | FILE_SHARE_WRITE,
98 NULL, CONSOLE_TEXTMODE_BUFFER, NULL );
99 if( !hstdout || hstdout == INVALID_HANDLE_VALUE )
101 msg_Err( p_vout, "cannot create screen buffer" );
106 if( !SetConsoleActiveScreenBuffer( hstdout) )
108 msg_Err( p_vout, "cannot set active screen buffer" );
113 coord = GetLargestConsoleWindowSize( hstdout );
114 msg_Dbg( p_vout, "SetConsoleWindowInfo: %ix%i", coord.X, coord.Y );
116 /* Force size for now */
120 if( !SetConsoleScreenBufferSize( hstdout, coord ) )
121 msg_Warn( p_vout, "SetConsoleScreenBufferSize %i %i",
124 /* Get the current screen buffer size and window position. */
125 if( GetConsoleScreenBufferInfo( hstdout, &csbiInfo ) )
127 rect.Top = 0; rect.Left = 0;
128 rect.Right = csbiInfo.dwMaximumWindowSize.X - 1;
129 rect.Bottom = csbiInfo.dwMaximumWindowSize.Y - 1;
130 if( !SetConsoleWindowInfo( hstdout, TRUE, &rect ) )
131 msg_Dbg( p_vout, "SetConsoleWindowInfo failed: %ix%i",
132 rect.Right, rect.Bottom );
137 msg_Err( p_vout, "cannot create console" );
143 /* Allocate structure */
144 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
145 if( p_vout->p_sys == NULL )
147 msg_Err( p_vout, "out of memory" );
151 #ifdef CACA_API_VERSION_1
152 p_vout->p_sys->p_cv = cucul_create_canvas(0, 0);
153 if( !p_vout->p_sys->p_cv )
155 msg_Err( p_vout, "cannot initialize libcucul" );
156 free( p_vout->p_sys );
160 p_vout->p_sys->p_dp = caca_create_display( p_vout->p_sys->p_cv );
161 if( !p_vout->p_sys->p_dp )
163 msg_Err( p_vout, "cannot initialize libcaca" );
164 cucul_free_canvas( p_vout->p_sys->p_cv );
165 free( p_vout->p_sys );
169 caca_set_display_title( p_vout->p_sys->p_dp,
170 VOUT_TITLE " - Colour AsCii Art (caca)" );
174 msg_Err( p_vout, "cannot initialize libcaca" );
175 free( p_vout->p_sys );
179 caca_set_window_title( VOUT_TITLE " - Colour AsCii Art (caca)" );
182 p_vout->pf_init = Init;
183 p_vout->pf_end = End;
184 p_vout->pf_manage = Manage;
185 p_vout->pf_render = Render;
186 p_vout->pf_display = Display;
191 /*****************************************************************************
192 * Init: initialize libcaca video output thread
193 *****************************************************************************/
194 static int Init( vout_thread_t *p_vout )
197 picture_t *p_pic = NULL;
199 I_OUTPUTPICTURES = 0;
201 p_vout->output.i_chroma = VLC_FOURCC('R','V','3','2');
202 p_vout->output.i_width = p_vout->render.i_width;
203 p_vout->output.i_height = p_vout->render.i_height;
204 p_vout->output.i_aspect = p_vout->render.i_aspect;
206 p_vout->output.i_rmask = 0x00ff0000;
207 p_vout->output.i_gmask = 0x0000ff00;
208 p_vout->output.i_bmask = 0x000000ff;
210 /* Create the libcaca bitmap */
211 #ifdef CACA_API_VERSION_1
212 p_vout->p_sys->p_dither =
215 p_vout->p_sys->p_bitmap =
218 ( 32, p_vout->output.i_width, p_vout->output.i_height,
219 4 * ((p_vout->output.i_width + 15) & ~15),
220 p_vout->output.i_rmask, p_vout->output.i_gmask,
221 p_vout->output.i_bmask, 0x00000000 );
223 #ifdef CACA_API_VERSION_1
224 if( !p_vout->p_sys->p_dither )
226 if( !p_vout->p_sys->p_bitmap )
229 msg_Err( p_vout, "could not create libcaca bitmap" );
233 /* Find an empty picture slot */
234 for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
236 if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
238 p_pic = p_vout->p_picture + i_index;
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;
255 p_pic->p->p_pixels = malloc( p_pic->p->i_pitch * p_pic->p->i_lines );
257 p_pic->i_status = DESTROYED_PICTURE;
258 p_pic->i_type = DIRECT_PICTURE;
260 PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
266 /*****************************************************************************
267 * End: terminate libcaca video output thread
268 *****************************************************************************/
269 static void End( vout_thread_t *p_vout )
271 #ifdef CACA_API_VERSION_1
272 cucul_free_dither( p_vout->p_sys->p_dither );
274 caca_free_bitmap( p_vout->p_sys->p_bitmap );
278 /*****************************************************************************
279 * Destroy: destroy libcaca video output thread
280 *****************************************************************************
281 * Terminate an output method created by AaCreateOutputMethod
282 *****************************************************************************/
283 static void Destroy( vlc_object_t *p_this )
285 vout_thread_t *p_vout = (vout_thread_t *)p_this;
287 #ifdef CACA_API_VERSION_1
288 caca_free_display( p_vout->p_sys->p_dp );
289 cucul_free_canvas( p_vout->p_sys->p_cv );
294 #if defined( WIN32 ) && !defined( UNDER_CE )
298 free( p_vout->p_sys );
301 /*****************************************************************************
302 * Manage: handle libcaca events
303 *****************************************************************************
304 * This function should be called regularly by video output thread. It manages
305 * console events. It returns a non null value on error.
306 *****************************************************************************/
307 static int Manage( vout_thread_t *p_vout )
309 #ifdef CACA_API_VERSION_1
310 struct caca_event ev;
316 #ifdef CACA_API_VERSION_1
317 while(( caca_get_event(p_vout->p_sys->p_dp,
318 CACA_EVENT_KEY_PRESS | CACA_EVENT_RESIZE, &ev, 0) ))
320 while(( event = caca_get_event(CACA_EVENT_KEY_PRESS | CACA_EVENT_RESIZE) ))
323 /* Acknowledge the resize */
324 #ifdef CACA_API_VERSION_1
325 if( ev.type == CACA_EVENT_RESIZE )
327 caca_refresh_display( p_vout->p_sys->p_dp );
331 if( event == CACA_EVENT_RESIZE )
338 #ifdef CACA_API_VERSION_1
339 switch( ev.data.key.ch )
341 switch( event & 0x00ffffff )
345 val.i_int = KEY_MODIFIER_CTRL | 'q';
348 val.i_int = KEY_SPACE;
354 var_Set( p_vout->p_vlc, "key-pressed", val );
360 /*****************************************************************************
361 * Render: render previously calculated output
362 *****************************************************************************/
363 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
365 #ifdef CACA_API_VERSION_1
366 cucul_set_color( p_vout->p_sys->p_cv,
367 CUCUL_COLOR_DEFAULT, CUCUL_COLOR_BLACK );
368 cucul_clear_canvas( p_vout->p_sys->p_cv );
369 cucul_dither_bitmap( p_vout->p_sys->p_cv, 0, 0,
370 cucul_get_canvas_width( p_vout->p_sys->p_cv ) - 1,
371 cucul_get_canvas_height( p_vout->p_sys->p_cv ) - 1,
372 p_vout->p_sys->p_dither, p_pic->p->p_pixels );
375 caca_draw_bitmap( 0, 0, caca_get_width() - 1, caca_get_height() - 1,
376 p_vout->p_sys->p_bitmap, p_pic->p->p_pixels );
380 /*****************************************************************************
381 * Display: displays previously rendered output
382 *****************************************************************************/
383 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
385 #ifdef CACA_API_VERSION_1
386 caca_refresh_display( p_vout->p_sys->p_dp );