modules/video_filter/chain.c

   1 /*****************************************************************************
   2  * chain.c : chain multiple video filter modules as a last resort solution
   3  *****************************************************************************
   4  * Copyright (C) 2007-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Antoine Cellerier <dionoea at videolan dot 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_filter.h>
  35
  36 /*****************************************************************************
  37  * Module descriptor
  38  *****************************************************************************/
  39 static int       Activate   ( vlc_object_t * );
  40 static void      Destroy    ( vlc_object_t * );
  41
  42 vlc_module_begin ()
  43     set_description( N_("Video filtering using a chain of video filter modules") )
  44     set_capability( "video filter2", 1 )
  45     set_callbacks( Activate, Destroy )
  46 vlc_module_end ()
  47
  48 /*****************************************************************************
  49  * Local prototypes.
  50  *****************************************************************************/
  51 static picture_t *Chain         ( filter_t *, picture_t * );
  52 static int BufferAllocationInit ( filter_t *, void * );
  53
  54 static int BuildChromaResize( filter_t * );
  55 static int BuildChromaChain( filter_t *p_filter );
  56
  57 static int CreateChain( filter_chain_t *p_chain, es_format_t *p_fmt_mid, config_chain_t * );
  58 static void EsFormatMergeSize( es_format_t *p_dst,
  59                                const es_format_t *p_base,
  60                                const es_format_t *p_size );
  61
  62 static const vlc_fourcc_t pi_allowed_chromas[] = {
  63     VLC_CODEC_I420,
  64     VLC_CODEC_I422,
  65     VLC_CODEC_RGB32,
  66     VLC_CODEC_RGB24,
  67     0
  68 };
  69
  70 struct filter_sys_t
  71 {
  72     filter_chain_t *p_chain;
  73 };
  74
  75 #define CHAIN_LEVEL_MAX 1
  76
  77 /*****************************************************************************
  78  * Activate: allocate a chroma function
  79  *****************************************************************************
  80  * This function allocates and initializes a chroma function
  81  *****************************************************************************/
  82 static int Activate( vlc_object_t *p_this )
  83 {
  84     filter_t *p_filter = (filter_t *)p_this;
  85     filter_sys_t *p_sys;
  86     int i_ret;
  87
  88     const bool b_chroma = p_filter->fmt_in.video.i_chroma != p_filter->fmt_out.video.i_chroma;
  89     const bool b_resize = p_filter->fmt_in.video.i_width  != p_filter->fmt_out.video.i_width ||
  90                           p_filter->fmt_in.video.i_height != p_filter->fmt_out.video.i_height;
  91     if( !b_chroma && !b_resize )
  92         return VLC_EGENERIC;
  93
  94     p_sys = p_filter->p_sys = calloc( 1, sizeof( *p_sys ) );
  95     if( !p_sys )
  96         return VLC_ENOMEM;
  97
  98     p_sys->p_chain = filter_chain_New( p_filter, "video filter2", false, BufferAllocationInit, NULL, p_filter );
  99     if( !p_sys->p_chain )
 100     {
 101         free( p_sys );
 102         return VLC_EGENERIC;
 103     }
 104
 105     if( b_chroma && b_resize )
 106         i_ret = BuildChromaResize( p_filter );
 107     else if( b_chroma )
 108         i_ret = BuildChromaChain( p_filter );
 109     else
 110         i_ret = VLC_EGENERIC;
 111
 112     if( i_ret )
 113     {
 114         /* Hum ... looks like this really isn't going to work. Too bad. */
 115         filter_chain_Delete( p_sys->p_chain );
 116         free( p_sys );
 117         return VLC_EGENERIC;
 118     }
 119     /* */
 120     p_filter->pf_video_filter = Chain;
 121     return VLC_SUCCESS;
 122 }
 123
 124 static void Destroy( vlc_object_t *p_this )
 125 {
 126     filter_t *p_filter = (filter_t *)p_this;
 127     filter_chain_Delete( p_filter->p_sys->p_chain );
 128     free( p_filter->p_sys );
 129 }
 130
 131 /*****************************************************************************
 132  * Chain
 133  *****************************************************************************/
 134 static picture_t *Chain( filter_t *p_filter, picture_t *p_pic )
 135 {
 136     return filter_chain_VideoFilter( p_filter->p_sys->p_chain, p_pic );
 137 }
 138
 139 /*****************************************************************************
 140  * Builders
 141  *****************************************************************************/
 142 static int BuildChromaResize( filter_t *p_filter )
 143 {
 144     filter_sys_t *p_sys = p_filter->p_sys;
 145     es_format_t fmt_mid;
 146     int i_ret;
 147
 148     /* Lets try resizing and then doing the chroma conversion */
 149     filter_chain_Reset( p_sys->p_chain, &p_filter->fmt_in, &p_filter->fmt_out );
 150
 151     msg_Dbg( p_filter, "Trying to build resize+chroma" );
 152     EsFormatMergeSize( &fmt_mid, &p_filter->fmt_in, &p_filter->fmt_out );
 153     i_ret = CreateChain( p_sys->p_chain, &fmt_mid, NULL );
 154     es_format_Clean( &fmt_mid );
 155     if( i_ret == VLC_SUCCESS )
 156         return VLC_SUCCESS;
 157
 158     /* Lets try it the other way arround (chroma and then resize) */
 159     filter_chain_Reset( p_sys->p_chain, &p_filter->fmt_in, &p_filter->fmt_out );
 160
 161     msg_Dbg( p_filter, "Trying to build chroma+resize" );
 162     EsFormatMergeSize( &fmt_mid, &p_filter->fmt_out, &p_filter->fmt_in );
 163     i_ret = CreateChain( p_sys->p_chain, &fmt_mid, NULL );
 164     es_format_Clean( &fmt_mid );
 165     if( i_ret == VLC_SUCCESS )
 166         return VLC_SUCCESS;
 167
 168     return VLC_EGENERIC;
 169 }
 170
 171 static int BuildChromaChain( filter_t *p_filter )
 172 {
 173     filter_sys_t *p_sys = p_filter->p_sys;
 174     es_format_t fmt_mid;
 175
 176     /* We have to protect ourself against a too high recursion */
 177     const char *psz_option = MODULE_STRING"-level";
 178     int i_level = 0;
 179     for( const config_chain_t *c = p_filter->p_cfg; c != NULL; c = c->p_next)
 180     {
 181         if( c->psz_name && c->psz_value && !strcmp(c->psz_name, psz_option) )
 182         {
 183             i_level = atoi(c->psz_value);
 184             if( i_level < 0 || i_level > CHAIN_LEVEL_MAX )
 185             {
 186                 msg_Err( p_filter, "Too high level of recursion (%d)", i_level );
 187                 return VLC_EGENERIC;
 188             }
 189             break;
 190         }
 191     }
 192
 193     /* */
 194     int i_ret = VLC_EGENERIC;
 195
 196     /* */
 197     config_chain_t cfg_level;
 198     memset(&cfg_level, 0, sizeof(cfg_level));
 199     cfg_level.psz_name = strdup(psz_option);
 200     if( asprintf( &cfg_level.psz_value, "%d", i_level + 1) < 0 )
 201         cfg_level.psz_value = NULL;
 202     if( !cfg_level.psz_name || !cfg_level.psz_value )
 203         goto exit;
 204
 205     /* Now try chroma format list */
 206     for( int i = 0; pi_allowed_chromas[i]; i++ )
 207     {
 208         const vlc_fourcc_t i_chroma = pi_allowed_chromas[i];
 209         if( i_chroma == p_filter->fmt_in.i_codec ||
 210             i_chroma == p_filter->fmt_out.i_codec )
 211             continue;
 212
 213         msg_Dbg( p_filter, "Trying to use chroma %4.4s as middle man",
 214                  (char*)&i_chroma );
 215
 216         es_format_Copy( &fmt_mid, &p_filter->fmt_in );
 217         fmt_mid.i_codec        =
 218         fmt_mid.video.i_chroma = i_chroma;
 219         fmt_mid.video.i_rmask  = 0;
 220         fmt_mid.video.i_gmask  = 0;
 221         fmt_mid.video.i_bmask  = 0;
 222         video_format_FixRgb(&fmt_mid.video);
 223
 224         filter_chain_Reset( p_sys->p_chain, &p_filter->fmt_in, &p_filter->fmt_out );
 225
 226         i_ret = CreateChain( p_sys->p_chain, &fmt_mid, &cfg_level );
 227         es_format_Clean( &fmt_mid );
 228
 229         if( i_ret == VLC_SUCCESS )
 230             break;
 231     }
 232
 233 exit:
 234     free( cfg_level.psz_name );
 235     free( cfg_level.psz_value );
 236     return i_ret;
 237 }
 238
 239 /*****************************************************************************
 240  * Buffer management
 241  *****************************************************************************/
 242 static picture_t *BufferNew( filter_t *p_filter )
 243 {
 244     filter_t *p_parent = (filter_t*)p_filter->p_owner;
 245
 246     return filter_NewPicture( p_parent );
 247 }
 248 static void BufferDel( filter_t *p_filter, picture_t *p_pic )
 249 {
 250     filter_t *p_parent = (filter_t*)p_filter->p_owner;
 251
 252     return filter_DeletePicture( p_parent, p_pic );
 253 }
 254 static int BufferAllocationInit ( filter_t *p_filter, void *p_data )
 255 {
 256     p_filter->pf_video_buffer_new = BufferNew;
 257     p_filter->pf_video_buffer_del = BufferDel;
 258     p_filter->p_owner = p_data;
 259     return VLC_SUCCESS;
 260 }
 261
 262 /*****************************************************************************
 263  *
 264  *****************************************************************************/
 265 static int CreateChain( filter_chain_t *p_chain, es_format_t *p_fmt_mid, config_chain_t *p_cfg )
 266 {
 267     filter_t *p_filter1;
 268     if( !( p_filter1 =
 269            filter_chain_AppendFilter( p_chain, NULL, p_cfg, NULL, p_fmt_mid )) )
 270         return VLC_EGENERIC;
 271     if( !filter_chain_AppendFilter( p_chain, NULL, p_cfg, p_fmt_mid, NULL ) )
 272     {
 273         filter_chain_DeleteFilter( p_chain, p_filter1 );
 274         return VLC_EGENERIC;
 275     }
 276     return VLC_SUCCESS;
 277 }
 278
 279 static void EsFormatMergeSize( es_format_t *p_dst,
 280                                const es_format_t *p_base,
 281                                const es_format_t *p_size )
 282 {
 283     es_format_Copy( p_dst, p_base );
 284
 285     p_dst->video.i_width  = p_size->video.i_width;
 286     p_dst->video.i_height = p_size->video.i_height;
 287
 288     p_dst->video.i_visible_width  = p_size->video.i_visible_width;
 289     p_dst->video.i_visible_height = p_size->video.i_visible_height;
 290 }
 291