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 int SendEvents( vlc_object_t *, char const *,
61 vlc_value_t, vlc_value_t, void * );
62 static void ReleaseImages( vout_thread_t *p_vout );
63 static void VlcPictureToIplImage( vout_thread_t *p_vout, picture_t *p_in );
65 /*****************************************************************************
67 *****************************************************************************/
69 static const char *const chroma_list[] = { "input", "I420", "RGB32"};
70 static const char *const chroma_list_text[] = { N_("Use input chroma unaltered"),
71 N_("I420 - first plane is greyscale"), N_("RGB32")};
73 static const char *const output_list[] = { "none", "input", "processed"};
74 static const char *const output_list_text[] = { N_("Don't display any video"),
75 N_("Display the input video"), N_("Display the processed video")};
77 static const char *const verbosity_list[] = { "error", "warning", "debug"};
78 static const char *const verbosity_list_text[] = { N_("Show only errors"),
79 N_("Show errors and warnings"), N_("Show everything including debug messages")};
82 set_description( N_("OpenCV video filter wrapper") );
83 set_shortname( N_("OpenCV" ));
84 set_category( CAT_VIDEO );
85 set_subcategory( SUBCAT_VIDEO_VFILTER );
86 set_capability( "video filter", 0 );
87 add_shortcut( "opencv_wrapper" );
88 set_callbacks( Create, Destroy );
89 add_float_with_range( "opencv-scale", 1.0, 0.1, 2.0, NULL,
90 N_("Scale factor (0.1-2.0)"),
91 N_("Ammount by which to scale the picture before sending it to the internal OpenCV filter"),
93 add_string( "opencv-chroma", "input", NULL,
94 N_("OpenCV filter chroma"),
95 N_("Chroma to convert picture to before sending it to the internal OpenCV filter"), false);
96 change_string_list( chroma_list, chroma_list_text, 0);
97 add_string( "opencv-output", "input", NULL,
98 N_("Wrapper filter output"),
99 N_("Determines what (if any) video is displayed by the wrapper filter"), false);
100 change_string_list( output_list, output_list_text, 0);
101 add_string( "opencv-verbosity", "error", NULL,
102 N_("Wrapper filter verbosity"),
103 N_("Determines wrapper filter verbosity level"), false);
104 change_string_list( verbosity_list, verbosity_list_text, 0);
105 add_string( "opencv-filter-name", "none", NULL,
106 N_("OpenCV internal filter name"),
107 N_("Name of internal OpenCV plugin filter to use"), false);
111 /*****************************************************************************
112 * wrapper_output_t: what video is output
113 *****************************************************************************/
114 enum wrapper_output_t
116 NONE, //not working yet
121 /*****************************************************************************
122 * internal_chroma_t: what chroma is sent to the internal opencv filter
123 *****************************************************************************/
124 enum internal_chroma_t
131 /*****************************************************************************
133 *****************************************************************************/
141 /*****************************************************************************
142 * vout_sys_t: opencv_wrapper video output method descriptor
143 *****************************************************************************
144 * This structure is part of the video output thread descriptor.
145 * It describes the opencv_wrapper specific properties of an output thread.
146 *****************************************************************************/
149 vout_thread_t *p_vout;
151 image_handler_t *p_image;
155 picture_t *p_proc_image;
156 picture_t *p_to_be_freed;
160 int i_wrapper_output;
161 int i_internal_chroma;
164 IplImage *p_cv_image[VOUT_MAX_PLANES];
167 char* psz_inner_name;
169 picture_t hacked_pic;
172 /*****************************************************************************
173 * Control: control facility for the vout (forwards to child vout)
174 *****************************************************************************/
175 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
177 return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
180 /*****************************************************************************
181 * Create: allocates opencv_wrapper video thread output method
182 *****************************************************************************
183 * This function allocates and initializes a opencv_wrapper vout method.
184 *****************************************************************************/
185 static int Create( vlc_object_t *p_this )
187 vout_thread_t *p_vout = (vout_thread_t *)p_this;
188 char *psz_chroma, *psz_output, *psz_verbosity;
191 /* Allocate structure */
192 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
193 if( p_vout->p_sys == NULL )
197 p_vout->p_sys->p_image = image_HandlerCreate( p_vout );
198 for (i = 0; i < VOUT_MAX_PLANES; i++)
199 p_vout->p_sys->p_cv_image[i] = NULL;
200 p_vout->p_sys->p_proc_image = NULL;
201 p_vout->p_sys->p_to_be_freed = NULL;
202 p_vout->p_sys->i_cv_image_size = 0;
204 p_vout->pf_init = Init;
205 p_vout->pf_end = End;
206 p_vout->pf_manage = NULL;
207 p_vout->pf_render = Render;
208 p_vout->pf_display = NULL;
209 p_vout->pf_control = Control;
211 /* Retrieve and apply config */
212 if( !(psz_chroma = config_GetPsz( p_vout, "opencv-chroma" )) )
214 msg_Err( p_vout, "configuration variable %s empty, using 'grey'",
216 p_vout->p_sys->i_internal_chroma = GREY;
220 if( !strcmp( psz_chroma, "input" ) )
221 p_vout->p_sys->i_internal_chroma = CINPUT;
222 else if( !strcmp( psz_chroma, "I420" ) )
223 p_vout->p_sys->i_internal_chroma = GREY;
224 else if( !strcmp( psz_chroma, "RGB32" ) )
225 p_vout->p_sys->i_internal_chroma = RGB;
228 msg_Err( p_vout, "no valid opencv-chroma provided, using 'grey'" );
229 p_vout->p_sys->i_internal_chroma = GREY;
234 if( !(psz_output = config_GetPsz( p_vout, "opencv-output" )) )
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 if( !(psz_verbosity = config_GetPsz( p_vout, "opencv-verbosity" )) )
258 msg_Err( p_vout, "configuration variable %s empty, using 'input'",
259 "opencv-verbosity" );
260 p_vout->p_sys->i_verbosity = VERB_ERROR;
264 if( !strcmp( psz_verbosity, "error" ) )
265 p_vout->p_sys->i_verbosity = VERB_ERROR;
266 else if( !strcmp( psz_verbosity, "warning" ) )
267 p_vout->p_sys->i_verbosity = VERB_WARN;
268 else if( !strcmp( psz_verbosity, "debug" ) )
269 p_vout->p_sys->i_verbosity = VERB_DEBUG;
272 msg_Err( p_vout, "no valid opencv-verbosity provided, using 'error'" );
273 p_vout->p_sys->i_verbosity = VERB_ERROR;
276 free( psz_verbosity);
278 p_vout->p_sys->psz_inner_name = config_GetPsz( p_vout, "opencv-filter-name" );
280 p_vout->p_sys->f_scale =
281 config_GetFloat( p_vout, "opencv-scale" );
283 if (p_vout->p_sys->i_verbosity > VERB_WARN)
284 msg_Info(p_vout, "Configuration: opencv-scale: %f, opencv-chroma: %d, "
285 "opencv-output: %d, opencv-verbosity %d, opencv-filter %s",
286 p_vout->p_sys->f_scale,
287 p_vout->p_sys->i_internal_chroma,
288 p_vout->p_sys->i_wrapper_output,
289 p_vout->p_sys->i_verbosity,
290 p_vout->p_sys->psz_inner_name);
295 /*****************************************************************************
296 * Init: initialize opencv_wrapper video thread output method
297 *****************************************************************************/
298 static int Init( vout_thread_t *p_vout )
303 vout_sys_t *p_sys = p_vout->p_sys;
304 I_OUTPUTPICTURES = 0;
306 /* Initialize the output video format */
307 memset( &fmt, 0, sizeof(video_format_t) );
308 p_vout->output.i_chroma = p_vout->render.i_chroma;
309 p_vout->output.i_width = p_vout->render.i_width;
310 p_vout->output.i_height = p_vout->render.i_height;
311 p_vout->output.i_aspect = p_vout->render.i_aspect;
312 p_vout->fmt_out = p_vout->fmt_in; //set to input video format
314 fmt = p_vout->fmt_out;
315 if (p_sys->i_wrapper_output == PROCESSED) //set to processed video format
317 fmt.i_width = fmt.i_width * p_sys->f_scale;
318 fmt.i_height = fmt.i_height * p_sys->f_scale;
319 fmt.i_visible_width = fmt.i_visible_width * p_sys->f_scale;
320 fmt.i_visible_height = fmt.i_visible_height * p_sys->f_scale;
321 fmt.i_x_offset = fmt.i_x_offset * p_sys->f_scale;
322 fmt.i_y_offset = fmt.i_y_offset * p_sys->f_scale;
324 if (p_sys->i_internal_chroma == GREY)
325 fmt.i_chroma = VLC_FOURCC('I','4','2','0');
326 else if (p_sys->i_internal_chroma == RGB)
327 fmt.i_chroma = VLC_FOURCC('R','V','3','2');
330 /* Load the internal opencv filter */
331 /* We don't need to set up video formats for this filter as it not actually using a picture_t */
332 p_sys->p_opencv = vlc_object_create( p_vout, sizeof(filter_t) );
333 vlc_object_attach( p_sys->p_opencv, p_vout );
335 if (p_vout->p_sys->psz_inner_name)
336 p_sys->p_opencv->p_module =
337 module_Need( p_sys->p_opencv, p_sys->psz_inner_name, 0, 0 );
339 if( !p_sys->p_opencv->p_module )
341 msg_Err( p_vout, "can't open internal opencv filter: %s", p_vout->p_sys->psz_inner_name );
342 p_vout->p_sys->psz_inner_name = NULL;
343 vlc_object_detach( p_sys->p_opencv );
344 vlc_object_release( p_sys->p_opencv );
345 p_sys->p_opencv = NULL;
348 /* Try to open the real video output */
349 if (p_sys->i_verbosity > VERB_WARN)
350 msg_Dbg( p_vout, "spawning the real video output" );
352 p_vout->p_sys->p_vout = vout_Create( p_vout, &fmt );
354 /* Everything failed */
355 if( p_vout->p_sys->p_vout == NULL )
357 msg_Err( p_vout, "can't open vout, aborting" );
361 ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
363 ADD_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
365 ADD_PARENT_CALLBACKS( SendEventsToChild );
370 /*****************************************************************************
371 * End: terminate opencv_wrapper video thread output method
372 *****************************************************************************/
373 static void End( vout_thread_t *p_vout )
377 DEL_PARENT_CALLBACKS( SendEventsToChild );
379 DEL_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
381 /* Free the fake output buffers we allocated */
382 for( i_index = I_OUTPUTPICTURES ; i_index ; )
385 free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
388 if ( p_vout->p_sys->p_opencv )
390 //release the internal opencv filter
391 if( p_vout->p_sys->p_opencv->p_module )
392 module_Unneed( p_vout->p_sys->p_opencv, p_vout->p_sys->p_opencv->p_module );
393 vlc_object_detach( p_vout->p_sys->p_opencv );
394 vlc_object_release( p_vout->p_sys->p_opencv );
395 p_vout->p_sys->p_opencv = NULL;
398 vout_CloseAndRelease( p_vout->p_sys->p_vout )
401 /*****************************************************************************
402 * Destroy: destroy opencv_wrapper video thread output method
403 *****************************************************************************
404 * Terminate an output method created by opencv_wrapperCreateOutputMethod
405 *****************************************************************************/
406 static void Destroy( vlc_object_t *p_this )
408 vout_thread_t *p_vout = (vout_thread_t *)p_this;
410 ReleaseImages(p_vout);
412 if( p_vout->p_sys->p_image )
413 image_HandlerDelete( p_vout->p_sys->p_image );
415 free( p_vout->p_sys );
418 /*****************************************************************************
419 * ReleaseImages: Release OpenCV images in vout_sys_t.
420 *****************************************************************************/
421 static void ReleaseImages(vout_thread_t *p_vout)
424 if (p_vout->p_sys->p_cv_image)
426 for (i = 0; i < VOUT_MAX_PLANES; i++)
428 if (p_vout->p_sys->p_cv_image[i])
429 cvReleaseImageHeader(&(p_vout->p_sys->p_cv_image[i]));
430 p_vout->p_sys->p_cv_image[i] = NULL;
433 p_vout->p_sys->i_cv_image_size = 0;
435 /* Release temp picture_t if it exists */
436 if (p_vout->p_sys->p_to_be_freed)
438 picture_Release( p_vout->p_sys->p_to_be_freed );
439 p_vout->p_sys->p_to_be_freed = NULL;
441 if (p_vout->p_sys->i_verbosity > VERB_WARN)
442 msg_Dbg( p_vout, "images released" );
445 /*****************************************************************************
446 * VlcPictureToIplImage: Convert picture_t to IplImage
447 *****************************************************************************
448 * Converts given picture_t into IplImage(s) according to module config.
449 * IplImage(s) are stored in vout_sys_t.
450 *****************************************************************************/
451 static void VlcPictureToIplImage( vout_thread_t *p_vout, picture_t *p_in )
453 int planes = p_in->i_planes; //num input video planes
455 CvSize sz = cvSize(abs(p_in->format.i_width), abs(p_in->format.i_height));
456 video_format_t fmt_out;
457 clock_t start, finish; //performance measures
460 vout_sys_t* p_sys = p_vout->p_sys;
462 memset( &fmt_out, 0, sizeof(video_format_t) );
466 //do scale / color conversion according to p_sys config
467 if ((p_sys->f_scale != 1) || (p_sys->i_internal_chroma != CINPUT))
469 fmt_out = p_in->format;
471 //calc the scaled video size
472 fmt_out.i_width = p_in->format.i_width * p_sys->f_scale;
473 fmt_out.i_height = p_in->format.i_height * p_sys->f_scale;
475 if (p_sys->i_internal_chroma == RGB)
477 //rgb2 gives 3 separate planes, this gives 1 interleaved plane
478 //rv24 gives is about 20% faster but gives r&b the wrong way round
479 //and I cant think of an easy way to fix this
480 fmt_out.i_chroma = VLC_FOURCC('R','V','3','2');
482 else if (p_sys->i_internal_chroma == GREY)
484 //take the I (gray) plane (video seems to commonly be in this fmt so usually the
485 //conversion does nothing)
486 fmt_out.i_chroma = VLC_FOURCC('I','4','2','0');
489 //convert from the input image
490 p_sys->p_proc_image = image_Convert( p_sys->p_image, p_in,
491 &(p_in->format), &fmt_out );
493 if (!p_sys->p_proc_image)
495 msg_Err(p_vout, "can't convert (unsupported formats?), aborting...");
499 p_sys->p_to_be_freed = p_sys->p_proc_image; //remember this so we can free it later
502 else //((p_sys->f_scale != 1) || (p_sys->i_internal_chroma != CINPUT))
504 //use the input image without conversion
505 p_sys->p_proc_image = p_in;
508 //Convert to the IplImage array that is to be processed.
509 //If there are multiple planes in p_sys->p_proc_image, then 1 IplImage
510 //is created for each plane.
511 planes = p_sys->p_proc_image->i_planes;
512 p_sys->i_cv_image_size = planes;
513 for ( i = 0; i < planes; i++ )
515 sz = cvSize(abs(p_sys->p_proc_image->p[i].i_visible_pitch /
516 p_sys->p_proc_image->p[i].i_pixel_pitch),
517 abs(p_sys->p_proc_image->p[i].i_visible_lines));
519 p_sys->p_cv_image[i] = cvCreateImageHeader(sz, IPL_DEPTH_8U,
520 p_sys->p_proc_image->p[i].i_pixel_pitch);
522 cvSetData( p_sys->p_cv_image[i],
523 (char*)(p_sys->p_proc_image->p[i].p_pixels), p_sys->p_proc_image->p[i].i_pitch );
526 //Hack the above opencv image array into a picture_t so that it can be sent to
527 //another video filter
528 p_sys->hacked_pic.p_data_orig = p_sys->p_cv_image;
529 p_sys->hacked_pic.i_planes = planes;
530 p_sys->hacked_pic.format.i_chroma = fmt_out.i_chroma;
532 //calculate duration of conversion
534 duration = (double)(finish - start) / CLOCKS_PER_SEC;
535 if (p_sys->i_verbosity > VERB_WARN)
536 msg_Dbg( p_vout, "VlcPictureToIplImageRgb took %2.4f seconds\n", duration );
539 /*****************************************************************************
540 * Render: displays previously rendered output
541 *****************************************************************************
542 * This function send the currently rendered image to the internal opencv
543 * filter for processing.
544 *****************************************************************************/
545 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
547 picture_t *p_outpic = NULL;
548 clock_t start, finish;
551 while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
554 if( !vlc_object_alive (p_vout) || p_vout->b_error )
556 msleep( VOUT_OUTMEM_SLEEP );
559 vout_LinkPicture( p_vout->p_sys->p_vout, p_outpic );
563 if (p_vout->p_sys->i_wrapper_output == VINPUT) //output = input video
565 //This copy is a bit unfortunate but image_Convert can't write into an existing image so it is better to copy the
566 //(say) 16bit YUV image here than a 32bit RGB image somehwere else.
567 //It is also not that expensive in time.
568 vout_CopyPicture( p_vout, p_outpic, p_pic );
569 VlcPictureToIplImage( p_vout, p_pic);
570 //pass the image to the internal opencv filter for processing
571 if ((p_vout->p_sys->p_opencv) && (p_vout->p_sys->p_opencv->p_module))
572 p_vout->p_sys->p_opencv->pf_video_filter( p_vout->p_sys->p_opencv, &(p_vout->p_sys->hacked_pic));
574 else //output = processed video (NONE option not working yet)
576 VlcPictureToIplImage( p_vout, p_pic);
577 //pass the image to the internal opencv filter for processing
578 if ((p_vout->p_sys->p_opencv) && (p_vout->p_sys->p_opencv->p_module))
579 p_vout->p_sys->p_opencv->pf_video_filter( p_vout->p_sys->p_opencv, &(p_vout->p_sys->hacked_pic));
580 //copy the processed image into the output image
581 if ((p_vout->p_sys->p_proc_image) && (p_vout->p_sys->p_proc_image->p_data))
582 vout_CopyPicture( p_vout, p_outpic, p_vout->p_sys->p_proc_image );
587 duration = (double)(finish - start) / CLOCKS_PER_SEC;
588 if (p_vout->p_sys->i_verbosity > VERB_WARN)
589 msg_Dbg( p_vout, "Render took %2.4f seconds\n", duration );
591 ReleaseImages(p_vout);
592 vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
594 vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
595 vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
598 /*****************************************************************************
599 * SendEvents: forward mouse and keyboard events to the parent p_vout
600 *****************************************************************************/
601 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
602 vlc_value_t oldval, vlc_value_t newval, void *p_data )
604 var_Set( (vlc_object_t *)p_data, psz_var, newval );
609 /*****************************************************************************
610 * SendEventsToChild: forward events to the child/children vout
611 *****************************************************************************/
612 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
613 vlc_value_t oldval, vlc_value_t newval, void *p_data )
615 vout_thread_t *p_vout = (vout_thread_t *)p_this;
616 var_Set( p_vout->p_sys->p_vout, psz_var, newval );