Blending - Added blend benchmarking filter
[vlc.git] / modules / video_filter / blendbench.c
1 /*****************************************************************************
2  * blendbench.c : blending benchmark plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2007 the VideoLAN team
5  * $Id$
6  *
7  * Author: Søren Bøg <avacore@videolan.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <errno.h>
28 #include <stdlib.h>                                      /* malloc(), free() */
29 #include <string.h>
30 #include <math.h>
31
32 #include <vlc/vlc.h>
33 #include <vlc_sout.h>
34 #include <vlc_vout.h>
35
36 #include "vlc_filter.h"
37 #include "vlc_image.h"
38
39 /*****************************************************************************
40  * Local prototypes
41  *****************************************************************************/
42 static int Create( vlc_object_t * );
43 static void Destroy( vlc_object_t * );
44
45 static picture_t *Filter( filter_t *, picture_t * );
46
47 /*****************************************************************************
48  * Module descriptor
49  *****************************************************************************/
50
51 #define LOOPS_TEXT N_("Number of time to blend")
52 #define LOOPS_LONGTEXT N_("The number of time the blend will be performed")
53
54 #define ALPHA_TEXT N_("Alpha of the blended image")
55 #define ALPHA_LONGTEXT N_("Alpha with which the blend image is blended")
56
57 #define BASE_IMAGE_TEXT N_("Image to be blended onto")
58 #define BASE_IMAGE_LONGTEXT N_("The image which will be used to blend onto")
59
60 #define BASE_CHROMA_TEXT N_("Chroma for the base image")
61 #define BASE_CHROMA_LONGTEXT N_("Chroma which the base image will be loaded in")
62
63 #define BLEND_IMAGE_TEXT N_("Image which will be blended.")
64 #define BLEND_IMAGE_LONGTEXT N_("The image blended onto the base image")
65
66 #define BLEND_CHROMA_TEXT N_("Chroma for the blend image")
67 #define BLEND_CHROMA_LONGTEXT N_("Chroma which the blend image will be loaded" \
68                                  "in")
69
70 #define CFG_PREFIX "blendbench-"
71
72 vlc_module_begin();
73     set_description( _("Blending benchmark filter") );
74     set_shortname( _("blendbench" ));
75     set_category( CAT_VIDEO );
76     set_subcategory( SUBCAT_VIDEO_VFILTER );
77     set_capability( "video filter2", 0 );
78
79     set_section( N_("Benchmarking"), NULL );
80     add_integer( CFG_PREFIX "loops", 1000, NULL, LOOPS_TEXT,
81               LOOPS_LONGTEXT, VLC_FALSE );
82     add_integer_with_range( CFG_PREFIX "alpha", 128, 0, 255, NULL, ALPHA_TEXT,
83               ALPHA_LONGTEXT, VLC_FALSE );
84
85     set_section( N_("Base image"), NULL );
86     add_file( CFG_PREFIX "base-image", NULL, NULL, BASE_IMAGE_TEXT,
87               BASE_IMAGE_LONGTEXT, VLC_FALSE );
88     add_string( CFG_PREFIX "base-chroma", "I420", NULL, BASE_CHROMA_TEXT,
89               BASE_CHROMA_LONGTEXT, VLC_FALSE );
90
91     set_section( N_("Blend image"), NULL );
92     add_file( CFG_PREFIX "blend-image", NULL, NULL, BLEND_IMAGE_TEXT,
93               BLEND_IMAGE_LONGTEXT, VLC_FALSE );
94     add_string( CFG_PREFIX "blend-chroma", "YUVA", NULL, BLEND_CHROMA_TEXT,
95               BLEND_CHROMA_LONGTEXT, VLC_FALSE );
96
97     set_callbacks( Create, Destroy );
98 vlc_module_end();
99
100 static const char *ppsz_filter_options[] = {
101     "loops", "alpha", "base-image", "base-chroma", "blend-image",
102     "blend-chroma", NULL
103 };
104
105 /*****************************************************************************
106  * filter_sys_t: filter method descriptor
107  *****************************************************************************/
108 struct filter_sys_t
109 {
110     vlc_bool_t b_done;
111     int i_loops, i_alpha;
112
113     picture_t *p_base_image;
114     picture_t *p_blend_image;
115
116     vlc_fourcc_t i_base_chroma;
117     vlc_fourcc_t i_blend_chroma;
118 };
119
120 static int LoadImage( vlc_object_t *p_this, picture_t **pp_pic,
121                        vlc_fourcc_t i_chroma, char *psz_file, const char *psz_name )
122 {
123     image_handler_t *p_image;
124     video_format_t fmt_in, fmt_out;
125
126     memset( &fmt_in, 0, sizeof(video_format_t) );
127     memset( &fmt_out, 0, sizeof(video_format_t) );
128
129     fmt_out.i_chroma = i_chroma;
130     p_image = image_HandlerCreate( p_this );
131     *pp_pic = image_ReadUrl( p_image, psz_file, &fmt_in, &fmt_out );
132     image_HandlerDelete( p_image );
133
134     if( *pp_pic == NULL ) {
135         msg_Err( p_this, "Unable to load %s image", psz_name );
136         return VLC_EGENERIC;
137     }
138
139     msg_Dbg( p_this, "%s image has dim %d x %d (Y plane)", psz_name,
140              (*pp_pic)->p[Y_PLANE].i_visible_pitch,
141              (*pp_pic)->p[Y_PLANE].i_visible_lines );
142 }
143
144 /*****************************************************************************
145  * Create: allocates video thread output method
146  *****************************************************************************/
147 static int Create( vlc_object_t *p_this )
148 {
149     filter_t *p_filter = (filter_t *)p_this;
150     filter_sys_t *p_sys;
151     char *psz_temp;
152
153     /* Allocate structure */
154     p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
155     if( p_filter->p_sys == NULL )
156     {
157         msg_Err( p_filter, "out of memory" );
158         return VLC_ENOMEM;
159     }
160     p_sys = p_filter->p_sys;
161     p_sys->b_done = VLC_FALSE;
162
163     p_filter->pf_video_filter = Filter;
164
165     /* needed to get options passed in transcode using the
166      * adjust{name=value} syntax */
167     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
168                        p_filter->p_cfg );
169
170     p_sys->i_loops = var_CreateGetIntegerCommand( p_filter,
171                                                   CFG_PREFIX "loops" );
172     p_sys->i_alpha = var_CreateGetIntegerCommand( p_filter,
173                                                   CFG_PREFIX "alpha" );
174
175     psz_temp = var_CreateGetStringCommand( p_filter, CFG_PREFIX "base-chroma" );
176     p_sys->i_base_chroma = VLC_FOURCC( psz_temp[0], psz_temp[1],
177                                        psz_temp[2], psz_temp[3] );
178     LoadImage( p_this, &p_sys->p_base_image, p_sys->i_base_chroma,
179                var_CreateGetStringCommand( p_filter, CFG_PREFIX "base-image" ),
180                "Base" );
181
182     psz_temp = var_CreateGetStringCommand( p_filter,
183                                            CFG_PREFIX "blend-chroma" );
184     p_sys->i_blend_chroma = VLC_FOURCC( psz_temp[0], psz_temp[1],
185                                         psz_temp[2], psz_temp[3] );
186     LoadImage( p_this, &p_sys->p_blend_image, p_sys->i_blend_chroma,
187                var_CreateGetStringCommand( p_filter, CFG_PREFIX "blend-image" ),
188                "Blend" );
189
190     return VLC_SUCCESS;
191 }
192
193 /*****************************************************************************
194  * Destroy: destroy video thread output method
195  *****************************************************************************/
196 static void Destroy( vlc_object_t *p_this )
197 {
198     filter_t *p_filter = (filter_t *)p_this;
199     filter_sys_t *p_sys = p_filter->p_sys;
200
201     p_sys->p_base_image->pf_release( p_sys->p_base_image );
202     p_sys->p_blend_image->pf_release( p_sys->p_blend_image );
203 }
204
205 /*****************************************************************************
206  * Render: displays previously rendered output
207  *****************************************************************************/
208 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
209 {
210     filter_sys_t *p_sys = p_filter->p_sys;
211
212     if( p_sys->b_done )
213     {
214         return p_pic;
215     }
216
217     filter_t *p_blend;
218
219     p_blend = vlc_object_create( p_filter, VLC_OBJECT_FILTER );
220     vlc_object_attach( p_blend, p_filter );
221     p_blend->fmt_out.video = p_sys->p_base_image->format;
222     p_blend->fmt_in.video = p_sys->p_blend_image->format;
223     p_blend->p_module = module_Need( p_blend, "video blending", 0, 0 );
224
225     mtime_t time = mdate();
226     for( int i_iter = 0; i_iter < p_sys->i_loops; ++i_iter )
227     {
228         p_blend->pf_video_blend( p_blend, p_sys->p_base_image,
229                                  p_sys->p_base_image, p_sys->p_blend_image, 0,
230                                  0, p_sys->i_alpha );
231     }
232     time = mdate() - time;
233
234     msg_Info( p_filter, "Blended %d images in %f sec.", p_sys->i_loops,
235               time / 1000000.0f );
236     msg_Info( p_filter, "Speed is: %f images/second, %f pixels/second",
237               (float) p_sys->i_loops / time * 1000000,
238               (float) p_sys->i_loops / time * 1000000 *
239                   p_sys->p_blend_image->p[Y_PLANE].i_visible_pitch *
240                   p_sys->p_blend_image->p[Y_PLANE].i_visible_lines );
241
242     module_Unneed( p_blend, p_blend->p_module );
243
244     vlc_object_detach( p_blend );
245     vlc_object_destroy( p_blend );
246
247     p_sys->b_done = VLC_TRUE;
248     return p_pic;
249 }