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