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 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
33 #include "filter_common.h"
35 #define VOUTSEPARATOR ','
37 /*****************************************************************************
39 *****************************************************************************/
40 static int Create ( vlc_object_t * );
41 static void Destroy ( vlc_object_t * );
43 static int Init ( vout_thread_t * );
44 static void End ( vout_thread_t * );
45 static void Render ( vout_thread_t *, picture_t * );
47 static void RemoveAllVout ( vout_thread_t *p_vout );
49 static int SendEvents( vlc_object_t *, char const *,
50 vlc_value_t, vlc_value_t, void * );
52 /*****************************************************************************
54 *****************************************************************************/
55 #define COUNT_TEXT N_("Number of clones")
56 #define COUNT_LONGTEXT N_("Number of video windows in which to "\
59 #define VOUTLIST_TEXT N_("Video output modules")
60 #define VOUTLIST_LONGTEXT N_("You can use specific video output modules " \
61 "for the clones. Use a comma-separated list of modules." )
64 set_description( _("Clone video filter") );
65 set_capability( "video filter", 0 );
66 set_shortname( _("Clone" ));
67 set_category( CAT_VIDEO );
68 set_subcategory( SUBCAT_VIDEO_VFILTER );
70 add_integer( "clone-count", 2, NULL, COUNT_TEXT, COUNT_LONGTEXT, VLC_FALSE );
71 add_string ( "clone-vout-list", NULL, NULL, VOUTLIST_TEXT, VOUTLIST_LONGTEXT, VLC_TRUE );
73 add_shortcut( "clone" );
74 set_callbacks( Create, Destroy );
77 /*****************************************************************************
78 * vout_sys_t: Clone video output method descriptor
79 *****************************************************************************
80 * This structure is part of the video output thread descriptor.
81 * It describes the Clone specific properties of an output thread.
82 *****************************************************************************/
87 /* list of vout modules to use. "default" will launch a default
88 * module. If specified, overrides the setting in i_clones (which it
89 * sets to the list length) */
90 char **ppsz_vout_list;
92 vout_thread_t **pp_vout;
95 /*****************************************************************************
96 * Control: control facility for the vout (forwards to child vout)
97 *****************************************************************************/
98 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
101 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
103 vout_vaControl( p_vout->p_sys->pp_vout[ i_vout ], i_query, args );
108 /*****************************************************************************
109 * Create: allocates Clone video thread output method
110 *****************************************************************************
111 * This function allocates and initializes a Clone vout method.
112 *****************************************************************************/
113 static int Create( vlc_object_t *p_this )
115 vout_thread_t *p_vout = (vout_thread_t *)p_this;
118 /* Allocate structure */
119 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
120 if( p_vout->p_sys == NULL )
122 msg_Err( p_vout, "out of memory" );
126 p_vout->pf_init = Init;
127 p_vout->pf_end = End;
128 p_vout->pf_manage = NULL;
129 p_vout->pf_render = Render;
130 p_vout->pf_display = NULL;
131 p_vout->pf_control = Control;
133 psz_clonelist = config_GetPsz( p_vout, "clone-vout-list" );
139 /* Count the number of defined vout */
140 p_vout->p_sys->i_clones = 1;
142 while( psz_clonelist[i_dummy] != 0 )
144 if( psz_clonelist[i_dummy] == VOUTSEPARATOR )
145 p_vout->p_sys->i_clones++;
149 p_vout->p_sys->ppsz_vout_list = malloc( p_vout->p_sys->i_clones
151 if( !p_vout->p_sys->ppsz_vout_list )
153 msg_Err( p_vout, "out of memory" );
154 free( p_vout->p_sys );
158 /* Tokenize the list */
160 psz_token = psz_clonelist;
161 while( psz_token && *psz_token )
164 psz_module = psz_token;
165 psz_token = strchr( psz_module, VOUTSEPARATOR );
171 p_vout->p_sys->ppsz_vout_list[i_dummy] = strdup( psz_module );
175 free( psz_clonelist );
179 /* No list was specified. We will use the default vout, and get
180 * the number of clones from clone-count */
181 p_vout->p_sys->i_clones = config_GetInt( p_vout, "clone-count" );
182 p_vout->p_sys->ppsz_vout_list = NULL;
185 p_vout->p_sys->i_clones = __MAX( 1, __MIN( 99, p_vout->p_sys->i_clones ) );
187 msg_Dbg( p_vout, "spawning %i clone(s)", p_vout->p_sys->i_clones );
189 p_vout->p_sys->pp_vout = malloc( p_vout->p_sys->i_clones *
190 sizeof(vout_thread_t *) );
191 if( p_vout->p_sys->pp_vout == NULL )
193 msg_Err( p_vout, "out of memory" );
194 free( p_vout->p_sys );
201 /*****************************************************************************
202 * Init: initialize Clone video thread output method
203 *****************************************************************************/
204 static int Init( vout_thread_t *p_vout )
208 char *psz_default_vout;
209 video_format_t fmt = {0};
211 I_OUTPUTPICTURES = 0;
213 /* Initialize the output structure */
214 p_vout->output.i_chroma = p_vout->render.i_chroma;
215 p_vout->output.i_width = p_vout->render.i_width;
216 p_vout->output.i_height = p_vout->render.i_height;
217 p_vout->output.i_aspect = p_vout->render.i_aspect;
218 p_vout->fmt_out = p_vout->fmt_in;
219 fmt = p_vout->fmt_out;
221 /* Try to open the real video output */
222 msg_Dbg( p_vout, "spawning the real video outputs" );
224 /* Save the default vout */
225 psz_default_vout = config_GetPsz( p_vout, "vout" );
227 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
229 if( p_vout->p_sys->ppsz_vout_list == NULL
230 || ( !strncmp( p_vout->p_sys->ppsz_vout_list[i_vout],
233 p_vout->p_sys->pp_vout[i_vout] =
234 vout_Create( p_vout, &fmt );
238 /* create the appropriate vout instead of the default one */
239 config_PutPsz( p_vout, "vout",
240 p_vout->p_sys->ppsz_vout_list[i_vout] );
241 p_vout->p_sys->pp_vout[i_vout] =
242 vout_Create( p_vout, &fmt );
244 /* Reset the default value */
245 config_PutPsz( p_vout, "vout", psz_default_vout );
248 if( p_vout->p_sys->pp_vout[ i_vout ] == NULL )
250 msg_Err( p_vout, "failed to clone %i vout threads",
251 p_vout->p_sys->i_clones );
252 p_vout->p_sys->i_clones = i_vout;
253 if( psz_default_vout ) free( psz_default_vout );
254 RemoveAllVout( p_vout );
258 ADD_CALLBACKS( p_vout->p_sys->pp_vout[ i_vout ], SendEvents );
261 if( psz_default_vout ) free( psz_default_vout );
262 ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
264 ADD_PARENT_CALLBACKS( SendEventsToChild );
269 /*****************************************************************************
270 * End: terminate Clone video thread output method
271 *****************************************************************************/
272 static void End( vout_thread_t *p_vout )
276 /* Free the fake output buffers we allocated */
277 for( i_index = I_OUTPUTPICTURES ; i_index ; )
280 free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
284 /*****************************************************************************
285 * Destroy: destroy Clone video thread output method
286 *****************************************************************************
287 * Terminate an output method created by CloneCreateOutputMethod
288 *****************************************************************************/
289 static void Destroy( vlc_object_t *p_this )
291 vout_thread_t *p_vout = (vout_thread_t *)p_this;
293 RemoveAllVout( p_vout );
295 DEL_PARENT_CALLBACKS( SendEventsToChild );
297 free( p_vout->p_sys->pp_vout );
298 free( p_vout->p_sys );
301 /*****************************************************************************
302 * Render: displays previously rendered output
303 *****************************************************************************
304 * This function send the currently rendered image to Clone image, waits
305 * until it is displayed and switch the two rendering buffers, preparing next
307 *****************************************************************************/
308 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
310 picture_t *p_outpic = NULL;
313 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
316 vout_CreatePicture( p_vout->p_sys->pp_vout[ i_vout ], 0, 0, 0 )
319 if( p_vout->b_die || p_vout->b_error )
322 p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
326 msleep( VOUT_OUTMEM_SLEEP );
329 vout_DatePicture( p_vout->p_sys->pp_vout[ i_vout ],
330 p_outpic, p_pic->date );
331 vout_LinkPicture( p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
333 for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
335 uint8_t *p_in, *p_in_end, *p_out;
336 int i_in_pitch = p_pic->p[i_plane].i_pitch;
337 const int i_out_pitch = p_outpic->p[i_plane].i_pitch;
338 const int i_copy_pitch = p_outpic->p[i_plane].i_visible_pitch;
340 p_in = p_pic->p[i_plane].p_pixels;
341 p_out = p_outpic->p[i_plane].p_pixels;
343 if( i_in_pitch == i_copy_pitch
344 && i_out_pitch == i_copy_pitch )
346 p_vout->p_libvlc->pf_memcpy( p_out, p_in, i_in_pitch
347 * p_outpic->p[i_plane].i_visible_lines );
351 p_in_end = p_in + i_in_pitch *
352 p_outpic->p[i_plane].i_visible_lines;
354 while( p_in < p_in_end )
356 p_vout->p_libvlc->pf_memcpy( p_out, p_in, i_copy_pitch );
358 p_out += i_out_pitch;
363 vout_UnlinkPicture( p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
364 vout_DisplayPicture( p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
368 /*****************************************************************************
369 * RemoveAllVout: destroy all the child video output threads
370 *****************************************************************************/
371 static void RemoveAllVout( vout_thread_t *p_vout )
373 while( p_vout->p_sys->i_clones )
375 --p_vout->p_sys->i_clones;
376 DEL_CALLBACKS( p_vout->p_sys->pp_vout[p_vout->p_sys->i_clones],
378 vlc_object_detach( p_vout->p_sys->pp_vout[p_vout->p_sys->i_clones] );
379 vout_Destroy( p_vout->p_sys->pp_vout[p_vout->p_sys->i_clones] );
383 /*****************************************************************************
384 * SendEvents: forward mouse and keyboard events to the parent p_vout
385 *****************************************************************************/
386 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
387 vlc_value_t oldval, vlc_value_t newval, void *p_data )
389 var_Set( (vlc_object_t *)p_data, psz_var, newval );
394 /*****************************************************************************
395 * SendEventsToChild: forward events to the child/children vout
396 *****************************************************************************/
397 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
398 vlc_value_t oldval, vlc_value_t newval, void *p_data )
400 vout_thread_t *p_vout = (vout_thread_t *)p_this;
403 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
405 var_Set( p_vout->p_sys->pp_vout[ i_vout ], psz_var, newval );
407 if( !strcmp( psz_var, "fullscreen" ) ) break;