git.sesse.net Git - vlc/blob - modules/video_filter/osdmenu.c

   1 /*****************************************************************************
   2  * osdmenu.c: osd filter module
   3  *****************************************************************************
   4  * Copyright (C) 2004-2005 M2X
   5  * $Id: osdmenu.c 11131 2005-05-23 11:04:07Z hartman $
   6  *
   7  * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
   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 implid 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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <vlc/vlc.h>
  30 #include <vlc/input.h>
  31
  32 #include <vlc_filter.h>
  33 #include <vlc_video.h>
  34
  35 #include <osd.h>
  36 #include <vlc_osd.h>
  37
  38 /*****************************************************************************
  39  * Module descriptor
  40  *****************************************************************************/
  41
  42 /* FIXME: Future extension make the definition file in XML format. */
  43 #define OSD_FILE_TEXT N_("OSD menu configuration file")
  44 #define OSD_FILE_LONGTEXT N_( \
  45     "An OSD menu configuration file that menu actions with button images" )
  46
  47 #define OSD_PATH_TEXT N_("Path to OSD menu images")
  48 #define OSD_PATH_LONGTEXT N_( \
  49     "Specify another path to the OSD menu images. This will override the path as defined in the " \
  50     "OSD configuration file." )
  51
  52 #define POSX_TEXT N_("X coordinate of the OSD menu")
  53 #define POSX_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
  54
  55 #define POSY_TEXT N_("Y coordinate of the OSD menu")
  56 #define POSY_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
  57
  58 #define POS_TEXT N_("OSD menu position")
  59 #define POS_LONGTEXT N_( \
  60   "You can enforce the OSD menu position on the video " \
  61   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
  62   "also use combinations of these values).")
  63
  64 #define TIMEOUT_TEXT N_("Timeout of OSD menu")
  65 #define TIMEOUT_LONGTEXT N_( \
  66     "OSD menu pictures get a default timeout of 15 seconds added to their remaining time." \
  67     "This will ensure that they are at least the specified time visible.")
  68
  69 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
  70 static char *ppsz_pos_descriptions[] =
  71 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
  72   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
  73
  74 /* subfilter functions */
  75 static int  CreateFilter ( vlc_object_t * );
  76 static void DestroyFilter( vlc_object_t * );
  77 static subpicture_t *Filter( filter_t *, mtime_t );
  78 static int OSDMenuUpdateEvent( vlc_object_t *, char const *,
  79                     vlc_value_t, vlc_value_t, void * );
  80 static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
  81                     vlc_value_t, vlc_value_t, void * );
  82
  83 #define OSD_CFG "osdmenu-"
  84
  85 vlc_module_begin();
  86     add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
  87     add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
  88     add_integer( OSD_CFG "position", 8, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
  89         change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
  90     add_string( OSD_CFG "file", NULL, NULL, OSD_FILE_TEXT, OSD_FILE_LONGTEXT, VLC_FALSE );
  91     add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT, OSD_PATH_LONGTEXT, VLC_FALSE );
  92     add_integer( OSD_CFG "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT, VLC_FALSE );
  93
  94     set_capability( "sub filter", 100 );
  95     set_description( N_("On Screen Display menu subfilter") );
  96     set_shortname( N_("OSD menu") );
  97     add_shortcut( "osdmenu" );
  98     set_category( CAT_VIDEO );
  99     set_subcategory( SUBCAT_VIDEO_SUBPIC );
 100     set_callbacks( CreateFilter, DestroyFilter );
 101 vlc_module_end();
 102
 103 /*****************************************************************************
 104  * Sub filter code
 105  *****************************************************************************/
 106
 107 /*****************************************************************************
 108  * Local prototypes
 109  *****************************************************************************/
 110 struct filter_sys_t
 111 {
 112     vlc_mutex_t  lock;
 113
 114     int          position;      /* relative positioning of SPU images */
 115     mtime_t      i_last_date;   /* last mdate SPU object has been sent to SPU subsytem */
 116     int          i_timeout;     /* duration SPU object is valid on the video output in seconds */
 117
 118     vlc_bool_t   b_absolute;    /* do we use absolute positioning or relative? */
 119     vlc_bool_t   b_update;      /* Update OSD Menu by sending SPU objects */
 120     vlc_bool_t   b_visible;     /* OSD Menu is visible */
 121
 122     char        *psz_file;      /* OSD Menu configuration file */
 123     osd_menu_t  *p_menu;        /* pointer to OSD Menu object */
 124 };
 125
 126 /*****************************************************************************
 127  * CreateFilter: Create the filter and open the definition file
 128  *****************************************************************************/
 129 static int CreateFilter ( vlc_object_t *p_this )
 130 {
 131     filter_t *p_filter = (filter_t *)p_this;
 132     vlc_value_t val;
 133     int posx, posy;
 134
 135     p_filter->p_sys = (filter_sys_t *) malloc( sizeof( filter_sys_t ) );
 136     if( !p_filter->p_sys )
 137     {
 138         msg_Err( p_filter, "out of memory" );
 139         return VLC_ENOMEM;
 140     }
 141
 142     /* Populating struct */
 143     p_filter->p_sys->p_menu = NULL;
 144     p_filter->p_sys->psz_file = NULL;
 145
 146     vlc_mutex_init( p_filter, &p_filter->p_sys->lock );
 147
 148     p_filter->p_sys->psz_file = config_GetPsz( p_filter, OSD_CFG "file" );
 149     if( p_filter->p_sys->psz_file == NULL || *p_filter->p_sys->psz_file == '\0' )
 150     {
 151         msg_Err( p_filter, "unable to get filename" );
 152         goto error;
 153     }
 154
 155     var_Create( p_this, OSD_CFG "position", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 156     var_Get( p_this, OSD_CFG "position", &val );
 157     p_filter->p_sys->position = val.i_int;
 158     var_Create( p_this, OSD_CFG "x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 159     var_Get( p_this, OSD_CFG "x", &val );
 160     posx = val.i_int;
 161     var_Create( p_this, OSD_CFG "y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 162     var_Get( p_this, OSD_CFG "y", &val );
 163     posy = val.i_int;
 164     var_Create( p_this, OSD_CFG "timeout", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 165     var_Get( p_this, OSD_CFG "timeout", &val );
 166     p_filter->p_sys->i_timeout = val.i_int; /* in seconds */
 167
 168     /* Load the osd menu subsystem */
 169     p_filter->p_sys->p_menu = osd_MenuCreate( p_this, p_filter->p_sys->psz_file );
 170     if( p_filter->p_sys->p_menu == NULL )
 171         goto error;
 172
 173     /* Check if menu position was overridden */
 174     p_filter->p_sys->b_absolute = VLC_TRUE;
 175
 176     if( posx < 0 || posy < 0)
 177     {
 178         p_filter->p_sys->b_absolute = VLC_FALSE;
 179         p_filter->p_sys->p_menu->i_x = 0;
 180         p_filter->p_sys->p_menu->i_y = 0;
 181     }
 182     else if( posx >= 0 || posy >= 0 )
 183     {
 184         p_filter->p_sys->p_menu->i_x = posx;
 185         p_filter->p_sys->p_menu->i_y = posy;
 186     }
 187     else if( p_filter->p_sys->p_menu->i_x < 0 || p_filter->p_sys->p_menu->i_y < 0 )
 188     {
 189         p_filter->p_sys->b_absolute = VLC_FALSE;
 190         p_filter->p_sys->p_menu->i_x = 0;
 191         p_filter->p_sys->p_menu->i_y = 0;
 192     }
 193
 194     /* Set up p_filter */
 195     p_filter->p_sys->i_last_date = mdate();
 196
 197     /* Keep track of OSD Events */
 198     p_filter->p_sys->b_update = VLC_FALSE;
 199     p_filter->p_sys->b_visible = VLC_FALSE;
 200
 201     var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
 202     var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
 203
 204     /* Attach subpicture filter callback */
 205     p_filter->pf_sub_filter = Filter;
 206
 207     es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
 208     p_filter->fmt_out.i_priority = 0;
 209
 210     msg_Dbg( p_filter, "successfully loaded osdmenu filter" );
 211     return VLC_SUCCESS;
 212
 213 error:
 214     msg_Err( p_filter, "osdmenu filter discarded" );
 215     vlc_mutex_destroy( &p_filter->p_sys->lock );
 216     if( p_filter->p_sys->p_menu )
 217     {
 218         osd_MenuDelete( p_this, p_filter->p_sys->p_menu );
 219         p_filter->p_sys->p_menu = NULL;
 220     }
 221     if( p_filter->p_sys->psz_file ) free( p_filter->p_sys->psz_file );
 222     if( p_filter->p_sys ) free( p_filter->p_sys );
 223     return VLC_EGENERIC;
 224 }
 225
 226 /*****************************************************************************
 227  * DestroyFilter: Make a clean exit of this plugin
 228  *****************************************************************************/
 229 static void DestroyFilter( vlc_object_t *p_this )
 230 {
 231     filter_t     *p_filter = (filter_t*)p_this;
 232     filter_sys_t *p_sys = p_filter->p_sys;
 233
 234     var_Destroy( p_this, OSD_CFG "file" );
 235     var_Destroy( p_this, OSD_CFG "x" );
 236     var_Destroy( p_this, OSD_CFG "y" );
 237     var_Destroy( p_this, OSD_CFG "position" );
 238     var_Destroy( p_this, OSD_CFG "timeout" );
 239
 240     var_DelCallback( p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
 241     var_DelCallback( p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
 242
 243     osd_MenuDelete( p_filter, p_sys->p_menu );
 244
 245     vlc_mutex_destroy( &p_filter->p_sys->lock );
 246     if( p_sys->psz_file) free( p_sys->psz_file );
 247     if( p_sys ) free( p_sys );
 248
 249     msg_Dbg( p_filter, "osdmenu filter destroyed" );
 250 }
 251
 252 /*****************************************************************************
 253  * OSDMenuEvent: callback for OSD Menu events
 254  *****************************************************************************/
 255 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
 256                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 257 {
 258     filter_t *p_filter = (filter_t *) p_data;
 259
 260     p_filter->p_sys->b_visible = VLC_TRUE;
 261     return VLC_SUCCESS;
 262 }
 263
 264 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
 265                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 266 {
 267     filter_t *p_filter = (filter_t *) p_data;
 268
 269     p_filter->p_sys->b_update = VLC_TRUE;
 270     return VLC_SUCCESS;
 271 }
 272
 273 #if 0
 274 /*****************************************************************************
 275  * create_text_region : compose a text region SPU
 276  *****************************************************************************/
 277 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
 278     int i_width, int i_height, const char *psz_text )
 279 {
 280     subpicture_region_t *p_region;
 281     video_format_t       fmt;
 282
 283     /* Create new SPU region */
 284     memset( &fmt, 0, sizeof(video_format_t) );
 285     fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
 286     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 287     fmt.i_sar_num = fmt.i_sar_den = 1;
 288     fmt.i_width = fmt.i_visible_width = i_width;
 289     fmt.i_height = fmt.i_visible_height = i_height;
 290     fmt.i_x_offset = fmt.i_y_offset = 0;
 291     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 292     if( !p_region )
 293     {
 294         msg_Err( p_filter, "cannot allocate another SPU region" );
 295         return NULL;
 296     }
 297     p_region->psz_text = strdup( psz_text );
 298     p_region->i_x = 0;
 299     p_region->i_y = 40;
 300 #if 1
 301     msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
 302         p_region->i_x, p_region->i_y,
 303         p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
 304 #endif
 305     return p_region;
 306 }
 307 #endif
 308
 309 /*****************************************************************************
 310  * create_picture_region : compose a text region SPU
 311  *****************************************************************************/
 312 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
 313     int i_width, int i_height, picture_t *p_pic )
 314 {
 315     subpicture_region_t *p_region;
 316     video_format_t       fmt;
 317
 318         /* Create new SPU region */
 319     memset( &fmt, 0, sizeof(video_format_t) );
 320     fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
 321     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 322     fmt.i_sar_num = fmt.i_sar_den = 1;
 323     fmt.i_width = fmt.i_visible_width = i_width;
 324     fmt.i_height = fmt.i_visible_height = i_height;
 325     fmt.i_x_offset = fmt.i_y_offset = 0;
 326     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 327     if( !p_region )
 328     {
 329         msg_Err( p_filter, "cannot allocate SPU region" );
 330         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 331         return NULL;
 332     }
 333     vout_CopyPicture( p_filter, &p_region->picture, p_pic );
 334     p_region->i_x = 0;
 335     p_region->i_y = 0;
 336
 337 #if 0
 338     msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
 339         p_region->i_x, p_region->i_y,
 340         p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
 341 #endif
 342     return p_region;
 343 }
 344
 345 /****************************************************************************
 346  * Filter: the whole thing
 347  ****************************************************************************
 348  * This function outputs subpictures at regular time intervals.
 349  ****************************************************************************/
 350 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
 351 {
 352     filter_sys_t *p_sys = p_filter->p_sys;
 353     subpicture_t *p_spu;
 354     subpicture_region_t *p_region;
 355
 356     if( !p_filter->p_sys->b_update ) return NULL;
 357
 358     p_filter->p_sys->i_last_date = i_date;
 359     p_filter->p_sys->b_update = VLC_FALSE;
 360
 361     /* Allocate the subpicture internal data. */
 362     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 363     if( !p_spu ) return NULL;
 364
 365     p_spu->b_absolute = p_sys->b_absolute;
 366     p_spu->i_start = p_sys->i_last_date = i_date;
 367     /* this never works why ? */
 368     p_spu->i_stop = (p_sys->i_timeout == 0) ? 0 : i_date + (mtime_t)(p_sys->i_timeout * 1000000);
 369     p_spu->b_ephemer = VLC_TRUE;
 370     p_spu->b_fade = VLC_TRUE;
 371     p_spu->i_flags = p_sys->position;
 372     p_filter->p_sys->b_update = VLC_FALSE;
 373
 374     /* Send an empty subpicture to clear the display
 375      * when OSD menu should be hidden and menu picture is not allocated.
 376      */
 377     if( !p_filter->p_sys->p_menu->p_state->p_pic )
 378         return p_spu;
 379     if( p_filter->p_sys->b_visible == VLC_FALSE )
 380         return p_spu;
 381
 382     /* Create new spu regions */
 383     p_region = create_picture_region( p_filter, p_spu,
 384         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
 385         p_filter->p_sys->p_menu->p_state->p_pic );
 386     #if 0
 387     p_region->p_next = create_text_region( p_filter, p_spu,
 388         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
 389         p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
 390     #endif
 391
 392     /* proper positioning of OSD menu image */
 393     p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 394     p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 395
 396     p_spu->p_region = p_region;
 397     return p_spu;
 398 }