1 /*****************************************************************************
2 * clone.c : Clone video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2002, 2003 the VideoLAN team
7 * Authors: Samuel 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>
36 #include "filter_common.h"
38 #define VOUTSEPARATOR ','
40 /*****************************************************************************
42 *****************************************************************************/
43 static int Create ( vlc_object_t * );
44 static void Destroy ( vlc_object_t * );
46 static int Init ( vout_thread_t * );
47 static void End ( vout_thread_t * );
48 static void Render ( vout_thread_t *, picture_t * );
50 static void RemoveAllVout ( vout_thread_t *p_vout );
52 static int SendEvents( vlc_object_t *, char const *,
53 vlc_value_t, vlc_value_t, void * );
55 /*****************************************************************************
57 *****************************************************************************/
58 #define COUNT_TEXT N_("Number of clones")
59 #define COUNT_LONGTEXT N_("Number of video windows in which to "\
62 #define VOUTLIST_TEXT N_("Video output modules")
63 #define VOUTLIST_LONGTEXT N_("You can use specific video output modules " \
64 "for the clones. Use a comma-separated list of modules." )
66 #define CFG_PREFIX "clone-"
69 set_description( N_("Clone video filter") )
70 set_capability( "video filter", 0 )
71 set_shortname( N_("Clone" ))
72 set_category( CAT_VIDEO )
73 set_subcategory( SUBCAT_VIDEO_VFILTER )
75 add_integer( CFG_PREFIX "count", 2, NULL, COUNT_TEXT, COUNT_LONGTEXT, false )
76 add_string ( CFG_PREFIX "vout-list", NULL, NULL, VOUTLIST_TEXT, VOUTLIST_LONGTEXT, true )
78 add_shortcut( "clone" )
79 set_callbacks( Create, Destroy )
82 static const char *const ppsz_filter_options[] = {
83 "count", "vout-list", NULL
86 /*****************************************************************************
87 * vout_sys_t: Clone video output method descriptor
88 *****************************************************************************
89 * This structure is part of the video output thread descriptor.
90 * It describes the Clone specific properties of an output thread.
91 *****************************************************************************/
96 /* list of vout modules to use. "default" will launch a default
97 * module. If specified, overrides the setting in i_clones (which it
98 * sets to the list length) */
99 char **ppsz_vout_list;
101 vout_thread_t **pp_vout;
104 /*****************************************************************************
105 * Control: control facility for the vout (forwards to child vout)
106 *****************************************************************************/
107 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
110 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
112 vout_vaControl( p_vout->p_sys->pp_vout[ i_vout ], i_query, args );
117 /*****************************************************************************
118 * Create: allocates Clone video thread output method
119 *****************************************************************************
120 * This function allocates and initializes a Clone vout method.
121 *****************************************************************************/
122 static int Create( vlc_object_t *p_this )
124 vout_thread_t *p_vout = (vout_thread_t *)p_this;
127 /* Allocate structure */
128 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
129 if( p_vout->p_sys == NULL )
132 p_vout->pf_init = Init;
133 p_vout->pf_end = End;
134 p_vout->pf_manage = NULL;
135 p_vout->pf_render = Render;
136 p_vout->pf_display = NULL;
137 p_vout->pf_control = Control;
139 config_ChainParse( p_vout, CFG_PREFIX, ppsz_filter_options,
142 psz_clonelist = var_CreateGetNonEmptyString( p_vout,
143 CFG_PREFIX "vout-list" );
149 /* Count the number of defined vout */
150 p_vout->p_sys->i_clones = 1;
152 while( psz_clonelist[i_dummy] != 0 )
154 if( psz_clonelist[i_dummy] == VOUTSEPARATOR )
155 p_vout->p_sys->i_clones++;
159 p_vout->p_sys->ppsz_vout_list = malloc( p_vout->p_sys->i_clones
161 if( !p_vout->p_sys->ppsz_vout_list )
163 free( psz_clonelist );
164 free( p_vout->p_sys );
168 /* Tokenize the list */
170 psz_token = psz_clonelist;
171 while( psz_token && *psz_token )
174 psz_module = psz_token;
175 psz_token = strchr( psz_module, VOUTSEPARATOR );
181 p_vout->p_sys->ppsz_vout_list[i_dummy] = strdup( psz_module );
185 free( psz_clonelist );
189 /* No list was specified. We will use the default vout, and get
190 * the number of clones from clone-count */
191 p_vout->p_sys->i_clones =
192 var_CreateGetInteger( p_vout, CFG_PREFIX "count" );
193 p_vout->p_sys->ppsz_vout_list = NULL;
196 p_vout->p_sys->i_clones = __MAX( 1, __MIN( 99, p_vout->p_sys->i_clones ) );
198 msg_Dbg( p_vout, "spawning %i clone(s)", p_vout->p_sys->i_clones );
200 p_vout->p_sys->pp_vout = malloc( p_vout->p_sys->i_clones *
201 sizeof(vout_thread_t *) );
202 if( p_vout->p_sys->pp_vout == NULL )
204 free( p_vout->p_sys );
211 /*****************************************************************************
212 * Init: initialize Clone video thread output method
213 *****************************************************************************/
214 static int Init( vout_thread_t *p_vout )
218 char *psz_default_vout;
221 I_OUTPUTPICTURES = 0;
222 memset( &fmt, 0, sizeof(video_format_t) );
224 /* Initialize the output structure */
225 p_vout->output.i_chroma = p_vout->render.i_chroma;
226 p_vout->output.i_width = p_vout->render.i_width;
227 p_vout->output.i_height = p_vout->render.i_height;
228 p_vout->output.i_aspect = p_vout->render.i_aspect;
229 p_vout->fmt_out = p_vout->fmt_in;
230 fmt = p_vout->fmt_out;
232 /* Try to open the real video output */
233 msg_Dbg( p_vout, "spawning the real video outputs" );
235 /* Save the default vout */
236 psz_default_vout = config_GetPsz( p_vout, "vout" );
238 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
240 if( p_vout->p_sys->ppsz_vout_list == NULL
241 || ( !strncmp( p_vout->p_sys->ppsz_vout_list[i_vout],
244 p_vout->p_sys->pp_vout[i_vout] =
245 vout_Create( p_vout, &fmt );
249 /* create the appropriate vout instead of the default one */
250 config_PutPsz( p_vout, "vout",
251 p_vout->p_sys->ppsz_vout_list[i_vout] );
252 p_vout->p_sys->pp_vout[i_vout] =
253 vout_Create( p_vout, &fmt );
255 /* Reset the default value */
256 config_PutPsz( p_vout, "vout", psz_default_vout );
259 if( p_vout->p_sys->pp_vout[ i_vout ] == NULL )
261 msg_Err( p_vout, "failed to clone %i vout threads",
262 p_vout->p_sys->i_clones );
263 p_vout->p_sys->i_clones = i_vout;
264 free( psz_default_vout );
265 RemoveAllVout( p_vout );
269 ADD_CALLBACKS( p_vout->p_sys->pp_vout[ i_vout ], SendEvents );
272 free( psz_default_vout );
273 ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
275 ADD_PARENT_CALLBACKS( SendEventsToChild );
280 /*****************************************************************************
281 * End: terminate Clone video thread output method
282 *****************************************************************************/
283 static void End( vout_thread_t *p_vout )
287 DEL_PARENT_CALLBACKS( SendEventsToChild );
289 /* Free the fake output buffers we allocated */
290 for( i_index = I_OUTPUTPICTURES ; i_index ; )
293 free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
296 RemoveAllVout( p_vout );
299 /*****************************************************************************
300 * Destroy: destroy Clone video thread output method
301 *****************************************************************************
302 * Terminate an output method created by CloneCreateOutputMethod
303 *****************************************************************************/
304 static void Destroy( vlc_object_t *p_this )
306 vout_thread_t *p_vout = (vout_thread_t *)p_this;
308 free( p_vout->p_sys->pp_vout );
309 free( p_vout->p_sys );
312 /*****************************************************************************
313 * Render: displays previously rendered output
314 *****************************************************************************
315 * This function send the currently rendered image to Clone image, waits
316 * until it is displayed and switch the two rendering buffers, preparing next
318 *****************************************************************************/
319 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
321 picture_t *p_outpic = NULL;
324 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
327 vout_CreatePicture( p_vout->p_sys->pp_vout[ i_vout ], 0, 0, 0 )
330 if( !vlc_object_alive (p_vout) || p_vout->b_error )
333 p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
337 msleep( VOUT_OUTMEM_SLEEP );
340 p_outpic->date = p_pic->date;
341 vout_LinkPicture( p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
343 for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
345 uint8_t *p_in, *p_in_end, *p_out;
346 int i_in_pitch = p_pic->p[i_plane].i_pitch;
347 const int i_out_pitch = p_outpic->p[i_plane].i_pitch;
348 const int i_copy_pitch = p_outpic->p[i_plane].i_visible_pitch;
350 p_in = p_pic->p[i_plane].p_pixels;
351 p_out = p_outpic->p[i_plane].p_pixels;
353 if( i_in_pitch == i_copy_pitch
354 && i_out_pitch == i_copy_pitch )
356 vlc_memcpy( p_out, p_in, i_in_pitch
357 * p_outpic->p[i_plane].i_visible_lines );
361 p_in_end = p_in + i_in_pitch *
362 p_outpic->p[i_plane].i_visible_lines;
364 while( p_in < p_in_end )
366 vlc_memcpy( p_out, p_in, i_copy_pitch );
368 p_out += i_out_pitch;
373 vout_UnlinkPicture( p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
374 vout_DisplayPicture( p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
378 /*****************************************************************************
379 * RemoveAllVout: destroy all the child video output threads
380 *****************************************************************************/
381 static void RemoveAllVout( vout_thread_t *p_vout )
383 while( p_vout->p_sys->i_clones )
385 --p_vout->p_sys->i_clones;
386 DEL_CALLBACKS( p_vout->p_sys->pp_vout[p_vout->p_sys->i_clones],
388 vout_CloseAndRelease( p_vout->p_sys->pp_vout[p_vout->p_sys->i_clones] );
392 /*****************************************************************************
393 * SendEvents: forward mouse and keyboard events to the parent p_vout
394 *****************************************************************************/
395 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
396 vlc_value_t oldval, vlc_value_t newval, void *p_data )
398 VLC_UNUSED(p_this); VLC_UNUSED(oldval);
399 var_Set( (vlc_object_t *)p_data, psz_var, newval );
404 /*****************************************************************************
405 * SendEventsToChild: forward events to the child/children vout
406 *****************************************************************************/
407 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
408 vlc_value_t oldval, vlc_value_t newval, void *p_data )
410 VLC_UNUSED(p_data); VLC_UNUSED(oldval);
411 vout_thread_t *p_vout = (vout_thread_t *)p_this;
414 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
416 var_Set( p_vout->p_sys->pp_vout[ i_vout ], psz_var, newval );
418 if( !strcmp( psz_var, "fullscreen" ) ) break;