1 /*****************************************************************************
2 * opencv_wrapper.c : OpenCV wrapper video filter
3 *****************************************************************************
4 * Copyright (C) 2006 the VideoLAN team
6 * Authors: Dugal Harris <dugalh@protoclea.co.za>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
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 General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
23 /*****************************************************************************
25 *****************************************************************************/
35 #include <vlc_common.h>
36 #include <vlc_plugin.h>
42 #include <vlc_filter.h>
43 #include "filter_common.h"
44 #include <vlc_charset.h>
45 #include <vlc_image.h>
46 #include <vlc_input.h>
47 #include <vlc_playlist.h>
50 /*****************************************************************************
52 *****************************************************************************/
53 static int Create ( vlc_object_t * );
54 static void Destroy ( vlc_object_t * );
56 static int Init ( vout_thread_t * );
57 static void End ( vout_thread_t * );
58 static void Render ( vout_thread_t *, picture_t * );
60 static void ReleaseImages( vout_thread_t *p_vout );
61 static void VlcPictureToIplImage( vout_thread_t *p_vout, picture_t *p_in );
63 /*****************************************************************************
65 *****************************************************************************/
67 static const char *const chroma_list[] = { "input", "I420", "RGB32"};
68 static const char *const chroma_list_text[] = { N_("Use input chroma unaltered"),
69 N_("I420 - first plane is greyscale"), N_("RGB32")};
71 static const char *const output_list[] = { "none", "input", "processed"};
72 static const char *const output_list_text[] = { N_("Don't display any video"),
73 N_("Display the input video"), N_("Display the processed video")};
75 static const char *const verbosity_list[] = { "error", "warning", "debug"};
76 static const char *const verbosity_list_text[] = { N_("Show only errors"),
77 N_("Show errors and warnings"), N_("Show everything including debug messages")};
80 set_description( N_("OpenCV video filter wrapper") )
81 set_shortname( N_("OpenCV" ))
82 set_category( CAT_VIDEO )
83 set_subcategory( SUBCAT_VIDEO_VFILTER )
84 set_capability( "video filter", 0 )
85 add_shortcut( "opencv_wrapper" )
86 set_callbacks( Create, Destroy )
87 add_float_with_range( "opencv-scale", 1.0, 0.1, 2.0, NULL,
88 N_("Scale factor (0.1-2.0)"),
89 N_("Ammount by which to scale the picture before sending it to the internal OpenCV filter"),
91 add_string( "opencv-chroma", "input", NULL,
92 N_("OpenCV filter chroma"),
93 N_("Chroma to convert picture to before sending it to the internal OpenCV filter"), false);
94 change_string_list( chroma_list, chroma_list_text, 0);
95 add_string( "opencv-output", "input", NULL,
96 N_("Wrapper filter output"),
97 N_("Determines what (if any) video is displayed by the wrapper filter"), false);
98 change_string_list( output_list, output_list_text, 0);
99 add_string( "opencv-verbosity", "error", NULL,
100 N_("Wrapper filter verbosity"),
101 N_("Determines wrapper filter verbosity level"), false);
102 change_string_list( verbosity_list, verbosity_list_text, 0);
103 add_string( "opencv-filter-name", "none", NULL,
104 N_("OpenCV internal filter name"),
105 N_("Name of internal OpenCV plugin filter to use"), false);
109 /*****************************************************************************
110 * wrapper_output_t: what video is output
111 *****************************************************************************/
112 enum wrapper_output_t
114 NONE, //not working yet
119 /*****************************************************************************
120 * internal_chroma_t: what chroma is sent to the internal opencv filter
121 *****************************************************************************/
122 enum internal_chroma_t
129 /*****************************************************************************
131 *****************************************************************************/
139 /*****************************************************************************
140 * vout_sys_t: opencv_wrapper video output method descriptor
141 *****************************************************************************
142 * This structure is part of the video output thread descriptor.
143 * It describes the opencv_wrapper specific properties of an output thread.
144 *****************************************************************************/
147 vout_thread_t *p_vout;
149 image_handler_t *p_image;
153 picture_t *p_proc_image;
154 picture_t *p_to_be_freed;
158 int i_wrapper_output;
159 int i_internal_chroma;
162 IplImage *p_cv_image[VOUT_MAX_PLANES];
165 char* psz_inner_name;
167 picture_t hacked_pic;
170 /*****************************************************************************
171 * Control: control facility for the vout (forwards to child vout)
172 *****************************************************************************/
173 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
175 return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
178 /*****************************************************************************
179 * Create: allocates opencv_wrapper video thread output method
180 *****************************************************************************
181 * This function allocates and initializes a opencv_wrapper vout method.
182 *****************************************************************************/
183 static int Create( vlc_object_t *p_this )
185 vout_thread_t *p_vout = (vout_thread_t *)p_this;
186 char *psz_chroma, *psz_output, *psz_verbosity;
189 /* Allocate structure */
190 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
191 if( p_vout->p_sys == NULL )
195 p_vout->p_sys->p_image = image_HandlerCreate( p_vout );
196 for (i = 0; i < VOUT_MAX_PLANES; i++)
197 p_vout->p_sys->p_cv_image[i] = NULL;
198 p_vout->p_sys->p_proc_image = NULL;
199 p_vout->p_sys->p_to_be_freed = NULL;
200 p_vout->p_sys->i_cv_image_size = 0;
202 p_vout->pf_init = Init;
203 p_vout->pf_end = End;
204 p_vout->pf_manage = NULL;
205 p_vout->pf_render = Render;
206 p_vout->pf_display = NULL;
207 p_vout->pf_control = Control;
209 /* Retrieve and apply config */
210 psz_chroma = var_InheritString( p_vout, "opencv-chroma" );
211 if( psz_chroma == NULL )
213 msg_Err( p_vout, "configuration variable %s empty, using 'grey'",
215 p_vout->p_sys->i_internal_chroma = GREY;
219 if( !strcmp( psz_chroma, "input" ) )
220 p_vout->p_sys->i_internal_chroma = CINPUT;
221 else if( !strcmp( psz_chroma, "I420" ) )
222 p_vout->p_sys->i_internal_chroma = GREY;
223 else if( !strcmp( psz_chroma, "RGB32" ) )
224 p_vout->p_sys->i_internal_chroma = RGB;
227 msg_Err( p_vout, "no valid opencv-chroma provided, using 'grey'" );
228 p_vout->p_sys->i_internal_chroma = GREY;
233 psz_output = var_InheritString( p_vout, "opencv-output" );
234 if( psz_output == NULL )
236 msg_Err( p_vout, "configuration variable %s empty, using 'input'",
238 p_vout->p_sys->i_wrapper_output = VINPUT;
242 if( !strcmp( psz_output, "none" ) )
243 p_vout->p_sys->i_wrapper_output = NONE;
244 else if( !strcmp( psz_output, "input" ) )
245 p_vout->p_sys->i_wrapper_output = VINPUT;
246 else if( !strcmp( psz_output, "processed" ) )
247 p_vout->p_sys->i_wrapper_output = PROCESSED;
250 msg_Err( p_vout, "no valid opencv-output provided, using 'input'" );
251 p_vout->p_sys->i_wrapper_output = VINPUT;
256 psz_verbosity = var_InheritString( p_vout, "opencv-verbosity" );
257 if( psz_verbosity == NULL )
259 msg_Err( p_vout, "configuration variable %s empty, using 'input'",
260 "opencv-verbosity" );
261 p_vout->p_sys->i_verbosity = VERB_ERROR;
265 if( !strcmp( psz_verbosity, "error" ) )
266 p_vout->p_sys->i_verbosity = VERB_ERROR;
267 else if( !strcmp( psz_verbosity, "warning" ) )
268 p_vout->p_sys->i_verbosity = VERB_WARN;
269 else if( !strcmp( psz_verbosity, "debug" ) )
270 p_vout->p_sys->i_verbosity = VERB_DEBUG;
273 msg_Err( p_vout, "no valid opencv-verbosity provided, using 'error'" );
274 p_vout->p_sys->i_verbosity = VERB_ERROR;
277 free( psz_verbosity);
279 p_vout->p_sys->psz_inner_name =
280 var_InheritString( p_vout, "opencv-filter-name" );
281 p_vout->p_sys->f_scale =
282 var_InheritFloat( p_vout, "opencv-scale" );
284 if (p_vout->p_sys->i_verbosity > VERB_WARN)
285 msg_Info(p_vout, "Configuration: opencv-scale: %f, opencv-chroma: %d, "
286 "opencv-output: %d, opencv-verbosity %d, opencv-filter %s",
287 p_vout->p_sys->f_scale,
288 p_vout->p_sys->i_internal_chroma,
289 p_vout->p_sys->i_wrapper_output,
290 p_vout->p_sys->i_verbosity,
291 p_vout->p_sys->psz_inner_name);
296 /*****************************************************************************
297 * Init: initialize opencv_wrapper video thread output method
298 *****************************************************************************/
299 static int Init( vout_thread_t *p_vout )
302 vout_sys_t *p_sys = p_vout->p_sys;
303 I_OUTPUTPICTURES = 0;
305 /* Initialize the output video format */
306 memset( &fmt, 0, sizeof(video_format_t) );
307 p_vout->output.i_chroma = p_vout->render.i_chroma;
308 p_vout->output.i_width = p_vout->render.i_width;
309 p_vout->output.i_height = p_vout->render.i_height;
310 p_vout->output.i_aspect = p_vout->render.i_aspect;
311 p_vout->fmt_out = p_vout->fmt_in; //set to input video format
313 fmt = p_vout->fmt_out;
314 if (p_sys->i_wrapper_output == PROCESSED) //set to processed video format
316 fmt.i_width = fmt.i_width * p_sys->f_scale;
317 fmt.i_height = fmt.i_height * p_sys->f_scale;
318 fmt.i_visible_width = fmt.i_visible_width * p_sys->f_scale;
319 fmt.i_visible_height = fmt.i_visible_height * p_sys->f_scale;
320 fmt.i_x_offset = fmt.i_x_offset * p_sys->f_scale;
321 fmt.i_y_offset = fmt.i_y_offset * p_sys->f_scale;
323 if (p_sys->i_internal_chroma == GREY)
324 fmt.i_chroma = VLC_CODEC_I420;
325 else if (p_sys->i_internal_chroma == RGB)
326 fmt.i_chroma = VLC_CODEC_RGB32;
329 /* Load the internal opencv filter */
330 /* We don't need to set up video formats for this filter as it not actually using a picture_t */
331 p_sys->p_opencv = vlc_object_create( p_vout, sizeof(filter_t) );
332 vlc_object_attach( p_sys->p_opencv, p_vout );
334 if (p_vout->p_sys->psz_inner_name)
335 p_sys->p_opencv->p_module =
336 module_need( p_sys->p_opencv, p_sys->psz_inner_name, NULL, false );
338 if( !p_sys->p_opencv->p_module )
340 msg_Err( p_vout, "can't open internal opencv filter: %s", p_vout->p_sys->psz_inner_name );
341 p_vout->p_sys->psz_inner_name = NULL;
342 vlc_object_detach( p_sys->p_opencv );
343 vlc_object_release( p_sys->p_opencv );
344 p_sys->p_opencv = NULL;
347 /* Try to open the real video output */
348 if (p_sys->i_verbosity > VERB_WARN)
349 msg_Dbg( p_vout, "spawning the real video output" );
351 p_vout->p_sys->p_vout = vout_Create( p_vout, &fmt );
353 /* Everything failed */
354 if( p_vout->p_sys->p_vout == NULL )
356 msg_Err( p_vout, "can't open vout, aborting" );
360 vout_filter_AllocateDirectBuffers( p_vout, VOUT_MAX_PICTURES );
362 vout_filter_AddChild( p_vout, p_vout->p_sys->p_vout, NULL );
367 /*****************************************************************************
368 * End: terminate opencv_wrapper video thread output method
369 *****************************************************************************/
370 static void End( vout_thread_t *p_vout )
372 vout_sys_t *p_sys = p_vout->p_sys;
374 vout_filter_DelChild( p_vout, p_sys->p_vout, NULL );
375 vout_CloseAndRelease( p_sys->p_vout );
377 vout_filter_ReleaseDirectBuffers( p_vout );
379 if( p_sys->p_opencv )
381 //release the internal opencv filter
382 if( p_sys->p_opencv->p_module )
383 module_unneed( p_sys->p_opencv, p_sys->p_opencv->p_module );
384 vlc_object_detach( p_sys->p_opencv );
385 vlc_object_release( p_sys->p_opencv );
386 p_sys->p_opencv = NULL;
390 /*****************************************************************************
391 * Destroy: destroy opencv_wrapper video thread output method
392 *****************************************************************************
393 * Terminate an output method created by opencv_wrapperCreateOutputMethod
394 *****************************************************************************/
395 static void Destroy( vlc_object_t *p_this )
397 vout_thread_t *p_vout = (vout_thread_t *)p_this;
399 ReleaseImages(p_vout);
401 if( p_vout->p_sys->p_image )
402 image_HandlerDelete( p_vout->p_sys->p_image );
404 free( p_vout->p_sys );
407 /*****************************************************************************
408 * ReleaseImages: Release OpenCV images in vout_sys_t.
409 *****************************************************************************/
410 static void ReleaseImages(vout_thread_t *p_vout)
413 if (p_vout->p_sys->p_cv_image)
415 for (i = 0; i < VOUT_MAX_PLANES; i++)
417 if (p_vout->p_sys->p_cv_image[i])
418 cvReleaseImageHeader(&(p_vout->p_sys->p_cv_image[i]));
419 p_vout->p_sys->p_cv_image[i] = NULL;
422 p_vout->p_sys->i_cv_image_size = 0;
424 /* Release temp picture_t if it exists */
425 if (p_vout->p_sys->p_to_be_freed)
427 picture_Release( p_vout->p_sys->p_to_be_freed );
428 p_vout->p_sys->p_to_be_freed = NULL;
430 if (p_vout->p_sys->i_verbosity > VERB_WARN)
431 msg_Dbg( p_vout, "images released" );
434 /*****************************************************************************
435 * VlcPictureToIplImage: Convert picture_t to IplImage
436 *****************************************************************************
437 * Converts given picture_t into IplImage(s) according to module config.
438 * IplImage(s) are stored in vout_sys_t.
439 *****************************************************************************/
440 static void VlcPictureToIplImage( vout_thread_t *p_vout, picture_t *p_in )
442 int planes = p_in->i_planes; //num input video planes
444 CvSize sz = cvSize(abs(p_in->format.i_width), abs(p_in->format.i_height));
445 video_format_t fmt_out;
446 clock_t start, finish; //performance measures
449 vout_sys_t* p_sys = p_vout->p_sys;
451 memset( &fmt_out, 0, sizeof(video_format_t) );
455 //do scale / color conversion according to p_sys config
456 if ((p_sys->f_scale != 1) || (p_sys->i_internal_chroma != CINPUT))
458 fmt_out = p_in->format;
460 //calc the scaled video size
461 fmt_out.i_width = p_in->format.i_width * p_sys->f_scale;
462 fmt_out.i_height = p_in->format.i_height * p_sys->f_scale;
464 if (p_sys->i_internal_chroma == RGB)
466 //rgb2 gives 3 separate planes, this gives 1 interleaved plane
467 //rv24 gives is about 20% faster but gives r&b the wrong way round
468 //and I cant think of an easy way to fix this
469 fmt_out.i_chroma = VLC_CODEC_RGB32;
471 else if (p_sys->i_internal_chroma == GREY)
473 //take the I (gray) plane (video seems to commonly be in this fmt so usually the
474 //conversion does nothing)
475 fmt_out.i_chroma = VLC_CODEC_I420;
478 //convert from the input image
479 p_sys->p_proc_image = image_Convert( p_sys->p_image, p_in,
480 &(p_in->format), &fmt_out );
482 if (!p_sys->p_proc_image)
484 msg_Err(p_vout, "can't convert (unsupported formats?), aborting...");
488 p_sys->p_to_be_freed = p_sys->p_proc_image; //remember this so we can free it later
491 else //((p_sys->f_scale != 1) || (p_sys->i_internal_chroma != CINPUT))
493 //use the input image without conversion
494 p_sys->p_proc_image = p_in;
497 //Convert to the IplImage array that is to be processed.
498 //If there are multiple planes in p_sys->p_proc_image, then 1 IplImage
499 //is created for each plane.
500 planes = p_sys->p_proc_image->i_planes;
501 p_sys->i_cv_image_size = planes;
502 for ( i = 0; i < planes; i++ )
504 sz = cvSize(abs(p_sys->p_proc_image->p[i].i_visible_pitch /
505 p_sys->p_proc_image->p[i].i_pixel_pitch),
506 abs(p_sys->p_proc_image->p[i].i_visible_lines));
508 p_sys->p_cv_image[i] = cvCreateImageHeader(sz, IPL_DEPTH_8U,
509 p_sys->p_proc_image->p[i].i_pixel_pitch);
511 cvSetData( p_sys->p_cv_image[i],
512 (char*)(p_sys->p_proc_image->p[i].p_pixels), p_sys->p_proc_image->p[i].i_pitch );
515 //Hack the above opencv image array into a picture_t so that it can be sent to
516 //another video filter
517 p_sys->hacked_pic.p_data_orig = p_sys->p_cv_image;
518 p_sys->hacked_pic.i_planes = planes;
519 p_sys->hacked_pic.format.i_chroma = fmt_out.i_chroma;
521 //calculate duration of conversion
523 duration = (double)(finish - start) / CLOCKS_PER_SEC;
524 if (p_sys->i_verbosity > VERB_WARN)
525 msg_Dbg( p_vout, "VlcPictureToIplImageRgb took %2.4f seconds", duration );
528 /*****************************************************************************
529 * Render: displays previously rendered output
530 *****************************************************************************
531 * This function send the currently rendered image to the internal opencv
532 * filter for processing.
533 *****************************************************************************/
534 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
536 picture_t *p_outpic = NULL;
537 clock_t start, finish;
540 while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
543 if( !vlc_object_alive (p_vout) || p_vout->b_error )
545 msleep( VOUT_OUTMEM_SLEEP );
548 vout_LinkPicture( p_vout->p_sys->p_vout, p_outpic );
552 if (p_vout->p_sys->i_wrapper_output == VINPUT) //output = input video
554 //This copy is a bit unfortunate but image_Convert can't write into an existing image so it is better to copy the
555 //(say) 16bit YUV image here than a 32bit RGB image somehwere else.
556 //It is also not that expensive in time.
557 picture_Copy( p_outpic, p_pic );
558 VlcPictureToIplImage( p_vout, p_pic);
559 //pass the image to the internal opencv filter for processing
560 if ((p_vout->p_sys->p_opencv) && (p_vout->p_sys->p_opencv->p_module))
561 p_vout->p_sys->p_opencv->pf_video_filter( p_vout->p_sys->p_opencv, &(p_vout->p_sys->hacked_pic));
563 else //output = processed video (NONE option not working yet)
565 VlcPictureToIplImage( p_vout, p_pic);
566 //pass the image to the internal opencv filter for processing
567 if ((p_vout->p_sys->p_opencv) && (p_vout->p_sys->p_opencv->p_module))
568 p_vout->p_sys->p_opencv->pf_video_filter( p_vout->p_sys->p_opencv, &(p_vout->p_sys->hacked_pic));
569 //copy the processed image into the output image
570 if ((p_vout->p_sys->p_proc_image) && (p_vout->p_sys->p_proc_image->p_data))
571 picture_Copy( p_outpic, p_vout->p_sys->p_proc_image );
576 duration = (double)(finish - start) / CLOCKS_PER_SEC;
577 if (p_vout->p_sys->i_verbosity > VERB_WARN)
578 msg_Dbg( p_vout, "Render took %2.4f seconds", duration );
580 ReleaseImages(p_vout);
581 p_outpic->date = p_pic->date;
583 vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
584 vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );