6219a4032080851e03ac27f4745e8d66c8bf41d6
[vlc.git] / modules / video_splitter / clone.c
1 /*****************************************************************************
2  * clone.c : Clone video plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2002-2009 VLC authors and VideoLAN
5  *
6  * Authors: Samuel Hocevar <sam@zoy.org>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_video_splitter.h>
34
35 /*****************************************************************************
36  * Module descriptor
37  *****************************************************************************/
38 #define COUNT_TEXT N_("Number of clones")
39 #define COUNT_LONGTEXT N_("Number of video windows in which to "\
40     "clone the video.")
41
42 #define VOUTLIST_TEXT N_("Video output modules")
43 #define VOUTLIST_LONGTEXT N_("You can use specific video output modules " \
44         "for the clones. Use a comma-separated list of modules." )
45
46 #define CLONE_HELP N_("Duplicate your video to multiple windows " \
47         "and/or video output modules")
48 #define CFG_PREFIX "clone-"
49
50 static int  Open ( vlc_object_t * );
51 static void Close( vlc_object_t * );
52
53 vlc_module_begin ()
54     set_description( N_("Clone video filter") )
55     set_capability( "video splitter", 0 )
56     set_shortname( N_("Clone" ))
57     set_help(CLONE_HELP)
58     set_category( CAT_VIDEO )
59     set_subcategory( SUBCAT_VIDEO_SPLITTER )
60
61     add_integer( CFG_PREFIX "count", 2, COUNT_TEXT, COUNT_LONGTEXT, false )
62     add_module_list(CFG_PREFIX "vout-list", "vout display", NULL,
63                     VOUTLIST_TEXT, VOUTLIST_LONGTEXT)
64
65     add_shortcut( "clone" )
66     set_callbacks( Open, Close )
67 vlc_module_end ()
68
69 /*****************************************************************************
70  * Local prototypes
71  *****************************************************************************/
72 static const char *const ppsz_filter_options[] = {
73     "count", "vout-list", NULL
74 };
75
76 #define VOUTSEPARATOR ':'
77
78 static int Filter( video_splitter_t *, picture_t *pp_dst[], picture_t * );
79
80 /**
81  * This function allocates and initializes a Clone splitter module
82  */
83 static int Open( vlc_object_t *p_this )
84 {
85     video_splitter_t *p_splitter = (video_splitter_t*)p_this;
86
87     config_ChainParse( p_splitter, CFG_PREFIX, ppsz_filter_options,
88                        p_splitter->p_cfg );
89
90     char *psz_clonelist = var_CreateGetNonEmptyString( p_splitter,
91                                                        CFG_PREFIX "vout-list" );
92     if( psz_clonelist )
93     {
94         /* Count the number of defined vout */
95         p_splitter->i_output = 1;
96         for( int i = 0; psz_clonelist[i]; i++ )
97         {
98             if( psz_clonelist[i] == VOUTSEPARATOR )
99                 p_splitter->i_output++;
100         }
101
102         /* */
103         p_splitter->p_output = calloc( p_splitter->i_output,
104                                        sizeof(*p_splitter->p_output) );
105         if( !p_splitter->p_output )
106         {
107             free( psz_clonelist );
108             return VLC_EGENERIC;
109         }
110
111         /* Tokenize the list */
112         char *psz_tmp = psz_clonelist;
113         for( int i = 0; psz_tmp && *psz_tmp; i++ )
114         {
115             char *psz_new = strchr( psz_tmp, VOUTSEPARATOR );
116             if( psz_new )
117                 *psz_new++ = '\0';
118
119             p_splitter->p_output[i].psz_module = strdup( psz_tmp );
120
121             psz_tmp = psz_new;
122         }
123
124         free( psz_clonelist );
125     }
126     else
127     {
128         /* No list was specified. We will use the default vout, and get
129          * the number of clones from clone-count */
130         p_splitter->i_output = var_CreateGetInteger( p_splitter, CFG_PREFIX "count" );
131         if( p_splitter->i_output <= 0 )
132             p_splitter->i_output = 1;
133
134         p_splitter->p_output = calloc( p_splitter->i_output,
135                                        sizeof(*p_splitter->p_output) );
136
137         if( !p_splitter->p_output )
138             return VLC_EGENERIC;
139
140         for( int i = 0; i < p_splitter->i_output; i++ )
141             p_splitter->p_output[i].psz_module = NULL;
142     }
143
144     /* */
145     for( int i = 0; i < p_splitter->i_output; i++ )
146     {
147         video_splitter_output_t *p_cfg = &p_splitter->p_output[i];
148         video_format_Copy( &p_cfg->fmt, &p_splitter->fmt );
149     }
150
151     /* */
152     p_splitter->pf_filter = Filter;
153     p_splitter->mouse = NULL;
154
155     msg_Dbg( p_splitter, "spawning %i clone(s)", p_splitter->i_output );
156
157     return VLC_SUCCESS;
158 }
159
160 /**
161  * This function closes a clone video splitter module
162  */
163 static void Close( vlc_object_t *p_this )
164 {
165     video_splitter_t *p_splitter = (video_splitter_t*)p_this;
166
167     for( int i = 0; i < p_splitter->i_output; i++ )
168     {
169         video_splitter_output_t *p_cfg = &p_splitter->p_output[i];
170
171         free( p_cfg->psz_module );
172         video_format_Clean( &p_cfg->fmt );
173     }
174     free( p_splitter->p_output );
175 }
176
177 /**
178  * This function filter a picture
179  */
180 static int Filter( video_splitter_t *p_splitter,
181                    picture_t *pp_dst[], picture_t *p_src )
182 {
183     if( video_splitter_NewPicture( p_splitter, pp_dst ) )
184     {
185         picture_Release( p_src );
186         return VLC_EGENERIC;
187     }
188
189     for( int i = 0; i < p_splitter->i_output; i++ )
190         picture_Copy( pp_dst[i], p_src );
191
192     picture_Release( p_src );
193     return VLC_SUCCESS;
194 }
195