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., 59 Temple Place - Suite 330, Boston, MA 02111, 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_("Select the number of video windows in which to "\
59 #define VOUTLIST_TEXT N_("List of video output modules")
60 #define VOUTLIST_LONGTEXT N_("Select the specific video output modules that you want to activate.")
63 set_description( _("Clone video filter") );
64 set_capability( "video filter", 0 );
65 set_shortname( N_("Clone" ));
66 set_category( CAT_VIDEO );
67 set_subcategory( SUBCAT_VIDEO_VFILTER );
69 add_integer( "clone-count", 2, NULL, COUNT_TEXT, COUNT_LONGTEXT, VLC_FALSE );
70 add_string ( "clone-vout-list", NULL, NULL, VOUTLIST_TEXT, VOUTLIST_LONGTEXT, VLC_TRUE );
72 add_shortcut( "clone" );
73 set_callbacks( Create, Destroy );
76 /*****************************************************************************
77 * vout_sys_t: Clone video output method descriptor
78 *****************************************************************************
79 * This structure is part of the video output thread descriptor.
80 * It describes the Clone specific properties of an output thread.
81 *****************************************************************************/
86 /* list of vout modules to use. "default" will launch a default
87 * module. If specified, overrides the setting in i_clones (which it
88 * sets to the list length) */
89 char **ppsz_vout_list;
91 vout_thread_t **pp_vout;
94 /*****************************************************************************
95 * Control: control facility for the vout (forwards to child vout)
96 *****************************************************************************/
97 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
100 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
102 vout_vaControl( p_vout->p_sys->pp_vout[ i_vout ], i_query, args );
107 /*****************************************************************************
108 * Create: allocates Clone video thread output method
109 *****************************************************************************
110 * This function allocates and initializes a Clone vout method.
111 *****************************************************************************/
112 static int Create( vlc_object_t *p_this )
114 vout_thread_t *p_vout = (vout_thread_t *)p_this;
117 /* Allocate structure */
118 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
119 if( p_vout->p_sys == NULL )
121 msg_Err( p_vout, "out of memory" );
125 p_vout->pf_init = Init;
126 p_vout->pf_end = End;
127 p_vout->pf_manage = NULL;
128 p_vout->pf_render = Render;
129 p_vout->pf_display = NULL;
130 p_vout->pf_control = Control;
132 psz_clonelist = config_GetPsz( p_vout, "clone-vout-list" );
138 /* Count the number of defined vout */
139 p_vout->p_sys->i_clones = 1;
141 while( psz_clonelist[i_dummy] != 0 )
143 if( psz_clonelist[i_dummy] == VOUTSEPARATOR )
144 p_vout->p_sys->i_clones++;
148 p_vout->p_sys->ppsz_vout_list = malloc( p_vout->p_sys->i_clones
150 if( !p_vout->p_sys->ppsz_vout_list )
152 msg_Err( p_vout, "out of memory" );
153 free( p_vout->p_sys );
157 /* Tokenize the list */
159 psz_token = psz_clonelist;
160 while( psz_token && *psz_token )
163 psz_module = psz_token;
164 psz_token = strchr( psz_module, VOUTSEPARATOR );
170 p_vout->p_sys->ppsz_vout_list[i_dummy] = strdup( psz_module );
174 free( psz_clonelist );
178 /* No list was specified. We will use the default vout, and get
179 * the number of clones from clone-count */
180 p_vout->p_sys->i_clones = config_GetInt( p_vout, "clone-count" );
181 p_vout->p_sys->ppsz_vout_list = NULL;
184 p_vout->p_sys->i_clones = __MAX( 1, __MIN( 99, p_vout->p_sys->i_clones ) );
186 msg_Dbg( p_vout, "spawning %i clone(s)", p_vout->p_sys->i_clones );
188 p_vout->p_sys->pp_vout = malloc( p_vout->p_sys->i_clones *
189 sizeof(vout_thread_t *) );
190 if( p_vout->p_sys->pp_vout == NULL )
192 msg_Err( p_vout, "out of memory" );
193 free( p_vout->p_sys );
200 /*****************************************************************************
201 * Init: initialize Clone video thread output method
202 *****************************************************************************/
203 static int Init( vout_thread_t *p_vout )
207 char *psz_default_vout;
208 video_format_t fmt = {0};
210 I_OUTPUTPICTURES = 0;
212 /* Initialize the output structure */
213 p_vout->output.i_chroma = p_vout->render.i_chroma;
214 p_vout->output.i_width = p_vout->render.i_width;
215 p_vout->output.i_height = p_vout->render.i_height;
216 p_vout->output.i_aspect = p_vout->render.i_aspect;
218 fmt.i_width = fmt.i_visible_width = p_vout->render.i_width;
219 fmt.i_height = fmt.i_visible_height = p_vout->render.i_height;
220 fmt.i_x_offset = fmt.i_y_offset = 0;
221 fmt.i_chroma = p_vout->render.i_chroma;
222 fmt.i_aspect = p_vout->render.i_aspect;
223 fmt.i_sar_num = p_vout->render.i_aspect * fmt.i_height / fmt.i_width;
224 fmt.i_sar_den = VOUT_ASPECT_FACTOR;
226 /* Try to open the real video output */
227 msg_Dbg( p_vout, "spawning the real video outputs" );
229 /* Save the default vout */
230 psz_default_vout = config_GetPsz( p_vout, "vout" );
232 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
234 if( p_vout->p_sys->ppsz_vout_list == NULL
235 || ( !strncmp( p_vout->p_sys->ppsz_vout_list[i_vout],
238 p_vout->p_sys->pp_vout[i_vout] =
239 vout_Create( p_vout, &fmt );
243 /* create the appropriate vout instead of the default one */
244 config_PutPsz( p_vout, "vout",
245 p_vout->p_sys->ppsz_vout_list[i_vout] );
246 p_vout->p_sys->pp_vout[i_vout] =
247 vout_Create( p_vout, &fmt );
249 /* Reset the default value */
250 config_PutPsz( p_vout, "vout", psz_default_vout );
253 if( p_vout->p_sys->pp_vout[ i_vout ] == NULL )
255 msg_Err( p_vout, "failed to clone %i vout threads",
256 p_vout->p_sys->i_clones );
257 p_vout->p_sys->i_clones = i_vout;
258 if( psz_default_vout ) free( psz_default_vout );
259 RemoveAllVout( p_vout );
263 ADD_CALLBACKS( p_vout->p_sys->pp_vout[ i_vout ], SendEvents );
266 if( psz_default_vout ) free( psz_default_vout );
267 ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
269 ADD_PARENT_CALLBACKS( SendEventsToChild );
274 /*****************************************************************************
275 * End: terminate Clone video thread output method
276 *****************************************************************************/
277 static void End( vout_thread_t *p_vout )
281 /* Free the fake output buffers we allocated */
282 for( i_index = I_OUTPUTPICTURES ; i_index ; )
285 free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
289 /*****************************************************************************
290 * Destroy: destroy Clone video thread output method
291 *****************************************************************************
292 * Terminate an output method created by CloneCreateOutputMethod
293 *****************************************************************************/
294 static void Destroy( vlc_object_t *p_this )
296 vout_thread_t *p_vout = (vout_thread_t *)p_this;
298 RemoveAllVout( p_vout );
300 DEL_PARENT_CALLBACKS( SendEventsToChild );
302 free( p_vout->p_sys->pp_vout );
303 free( p_vout->p_sys );
306 /*****************************************************************************
307 * Render: displays previously rendered output
308 *****************************************************************************
309 * This function send the currently rendered image to Clone image, waits
310 * until it is displayed and switch the two rendering buffers, preparing next
312 *****************************************************************************/
313 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
315 picture_t *p_outpic = NULL;
318 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
321 vout_CreatePicture( p_vout->p_sys->pp_vout[ i_vout ], 0, 0, 0 )
324 if( p_vout->b_die || p_vout->b_error )
327 p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
331 msleep( VOUT_OUTMEM_SLEEP );
334 vout_DatePicture( p_vout->p_sys->pp_vout[ i_vout ],
335 p_outpic, p_pic->date );
336 vout_LinkPicture( p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
338 for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
340 uint8_t *p_in, *p_in_end, *p_out;
341 int i_in_pitch = p_pic->p[i_plane].i_pitch;
342 const int i_out_pitch = p_outpic->p[i_plane].i_pitch;
343 const int i_copy_pitch = p_outpic->p[i_plane].i_visible_pitch;
345 p_in = p_pic->p[i_plane].p_pixels;
346 p_out = p_outpic->p[i_plane].p_pixels;
348 if( i_in_pitch == i_copy_pitch
349 && i_out_pitch == i_copy_pitch )
351 p_vout->p_vlc->pf_memcpy( p_out, p_in, i_in_pitch
352 * p_outpic->p[i_plane].i_visible_lines );
356 p_in_end = p_in + i_in_pitch *
357 p_outpic->p[i_plane].i_visible_lines;
359 while( p_in < p_in_end )
361 p_vout->p_vlc->pf_memcpy( p_out, p_in, i_copy_pitch );
363 p_out += i_out_pitch;
368 vout_UnlinkPicture( p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
369 vout_DisplayPicture( p_vout->p_sys->pp_vout[ i_vout ], p_outpic );
373 /*****************************************************************************
374 * RemoveAllVout: destroy all the child video output threads
375 *****************************************************************************/
376 static void RemoveAllVout( vout_thread_t *p_vout )
378 while( p_vout->p_sys->i_clones )
380 --p_vout->p_sys->i_clones;
381 DEL_CALLBACKS( p_vout->p_sys->pp_vout[p_vout->p_sys->i_clones],
383 vlc_object_detach( p_vout->p_sys->pp_vout[p_vout->p_sys->i_clones] );
384 vout_Destroy( p_vout->p_sys->pp_vout[p_vout->p_sys->i_clones] );
388 /*****************************************************************************
389 * SendEvents: forward mouse and keyboard events to the parent p_vout
390 *****************************************************************************/
391 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
392 vlc_value_t oldval, vlc_value_t newval, void *p_data )
394 var_Set( (vlc_object_t *)p_data, psz_var, newval );
399 /*****************************************************************************
400 * SendEventsToChild: forward events to the child/children vout
401 *****************************************************************************/
402 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
403 vlc_value_t oldval, vlc_value_t newval, void *p_data )
405 vout_thread_t *p_vout = (vout_thread_t *)p_this;
408 for( i_vout = 0; i_vout < p_vout->p_sys->i_clones; i_vout++ )
410 var_Set( p_vout->p_sys->pp_vout[ i_vout ], psz_var, newval );
412 if( !strcmp( psz_var, "fullscreen" ) ) break;