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 #define OSD_UPDATE_TEXT N_("Update speed of OSD menu")
  70 #define OSD_UPDATE_LONGTEXT N_( \
  71     "Update the OSD menu picture every 200ms (default). Shorten the update time for " \
  72     "environments that experience transmissions errors. Be carefull with this option " \
  73     "because encoding OSD menu pictures is very computing intensive. The range is 0 - 1000 ms." )
  74
  75 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
  76 static char *ppsz_pos_descriptions[] =
  77 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
  78   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
  79
  80 /* subfilter functions */
  81 static int  CreateFilter ( vlc_object_t * );
  82 static void DestroyFilter( vlc_object_t * );
  83 static subpicture_t *Filter( filter_t *, mtime_t );
  84 static int OSDMenuUpdateEvent( vlc_object_t *, char const *,
  85                     vlc_value_t, vlc_value_t, void * );
  86 static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
  87                     vlc_value_t, vlc_value_t, void * );
  88
  89 #define OSD_CFG "osdmenu-"
  90
  91 #if defined( WIN32 ) || defined( UNDER_CE )
  92 #define OSD_DEFAULT_CFG "osdmenu/default.cfg"
  93 #else
  94 #define OSD_DEFAULT_CFG "share/osdmenu/default.cfg"
  95 #endif
  96
  97 #define OSD_UPDATE_MIN     0
  98 #define OSD_UPDATE_DEFAULT 0
  99 #define OSD_UPDATE_MAX     1000
 100
 101 vlc_module_begin();
 102     add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
 103     add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
 104     add_integer( OSD_CFG "position", 8, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
 105         change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
 106     add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT,
 107         OSD_FILE_LONGTEXT, VLC_FALSE );
 108     add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT,
 109         OSD_PATH_LONGTEXT, VLC_FALSE );
 110     add_integer( OSD_CFG "timeout", 15, NULL, TIMEOUT_TEXT,
 111         TIMEOUT_LONGTEXT, VLC_FALSE );
 112     add_integer_with_range( OSD_CFG "update", OSD_UPDATE_DEFAULT,
 113         OSD_UPDATE_MIN, OSD_UPDATE_MAX, NULL, OSD_UPDATE_TEXT,
 114         OSD_UPDATE_LONGTEXT, VLC_TRUE );
 115
 116     set_capability( "sub filter", 100 );
 117     set_description( N_("On Screen Display menu subfilter") );
 118     set_shortname( N_("OSD menu") );
 119     add_shortcut( "osdmenu" );
 120     set_category( CAT_VIDEO );
 121     set_subcategory( SUBCAT_VIDEO_SUBPIC );
 122     set_callbacks( CreateFilter, DestroyFilter );
 123 vlc_module_end();
 124
 125 /*****************************************************************************
 126  * Sub filter code
 127  *****************************************************************************/
 128
 129 /*****************************************************************************
 130  * Local prototypes
 131  *****************************************************************************/
 132 struct filter_sys_t
 133 {
 134     vlc_mutex_t  lock;
 135
 136     int          position;      /* relative positioning of SPU images */
 137     mtime_t      i_last_date;   /* last mdate SPU object has been sent to SPU subsytem */
 138     mtime_t      i_timeout;     /* duration SPU object is valid on the video output in seconds */
 139
 140     vlc_bool_t   b_absolute;    /* do we use absolute positioning or relative? */
 141     vlc_bool_t   b_update;      /* Update OSD Menu by sending SPU objects */
 142     vlc_bool_t   b_visible;     /* OSD Menu is visible */
 143     mtime_t      i_update;      /* Update the OSD menu every n ms */
 144     mtime_t      i_end_date;    /* End data of display OSD menu */
 145
 146     char        *psz_file;      /* OSD Menu configuration file */
 147     osd_menu_t  *p_menu;        /* pointer to OSD Menu object */
 148 };
 149
 150 /*****************************************************************************
 151  * CreateFilter: Create the filter and open the definition file
 152  *****************************************************************************/
 153 static int CreateFilter ( vlc_object_t *p_this )
 154 {
 155     filter_t *p_filter = (filter_t *)p_this;
 156     vlc_value_t val;
 157     int i_posx, i_posy;
 158
 159     p_filter->p_sys = (filter_sys_t *) malloc( sizeof( filter_sys_t ) );
 160     if( !p_filter->p_sys )
 161     {
 162         msg_Err( p_filter, "out of memory" );
 163         return VLC_ENOMEM;
 164     }
 165
 166     /* Populating struct */
 167     p_filter->p_sys->p_menu = NULL;
 168     p_filter->p_sys->psz_file = NULL;
 169
 170     vlc_mutex_init( p_filter, &p_filter->p_sys->lock );
 171
 172     p_filter->p_sys->psz_file = config_GetPsz( p_filter, OSD_CFG "file" );
 173     if( p_filter->p_sys->psz_file == NULL || *p_filter->p_sys->psz_file == '\0' )
 174     {
 175         msg_Err( p_filter, "unable to get filename" );
 176         goto error;
 177     }
 178
 179     var_Create( p_this, OSD_CFG "position", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 180     var_Get( p_this, OSD_CFG "position", &val );
 181     p_filter->p_sys->position = val.i_int;
 182     var_Create( p_this, OSD_CFG "x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 183     var_Get( p_this, OSD_CFG "x", &val );
 184     i_posx = val.i_int;
 185     var_Create( p_this, OSD_CFG "y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 186     var_Get( p_this, OSD_CFG "y", &val );
 187     i_posy = val.i_int;
 188
 189     /* in micro seconds - divide by 2 to match user expectations */
 190     var_Create( p_this, OSD_CFG "timeout", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 191     var_Get( p_this, OSD_CFG "timeout", &val );
 192     p_filter->p_sys->i_timeout = (mtime_t)(val.i_int * 1000000) >> 2;
 193     var_Create( p_this, OSD_CFG "update", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 194     var_Get( p_this, OSD_CFG "update", &val );
 195     p_filter->p_sys->i_update = (mtime_t)(val.i_int * 1000); /* in micro seconds */
 196
 197     /* Load the osd menu subsystem */
 198     p_filter->p_sys->p_menu = osd_MenuCreate( p_this, p_filter->p_sys->psz_file );
 199     if( p_filter->p_sys->p_menu == NULL )
 200         goto error;
 201
 202     /* Check if menu position was overridden */
 203     p_filter->p_sys->b_absolute = VLC_TRUE;
 204     if( i_posx < 0 || i_posy < 0)
 205     {
 206         p_filter->p_sys->b_absolute = VLC_FALSE;
 207         p_filter->p_sys->p_menu->i_x = 0;
 208         p_filter->p_sys->p_menu->i_y = 0;
 209     }
 210     else if( i_posx >= 0 || i_posy >= 0 )
 211     {
 212         p_filter->p_sys->p_menu->i_x = i_posx;
 213         p_filter->p_sys->p_menu->i_y = i_posy;
 214     }
 215     else if( p_filter->p_sys->p_menu->i_x < 0 || p_filter->p_sys->p_menu->i_y < 0 )
 216     {
 217         p_filter->p_sys->b_absolute = VLC_FALSE;
 218         p_filter->p_sys->p_menu->i_x = 0;
 219         p_filter->p_sys->p_menu->i_y = 0;
 220     }
 221
 222     /* Set up p_filter */
 223     p_filter->p_sys->i_last_date = mdate();
 224
 225     /* Keep track of OSD Events */
 226     p_filter->p_sys->b_update  = VLC_FALSE;
 227     p_filter->p_sys->b_visible = VLC_FALSE;
 228
 229     var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
 230     var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
 231
 232     /* Attach subpicture filter callback */
 233     p_filter->pf_sub_filter = Filter;
 234
 235     es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
 236     p_filter->fmt_out.i_priority = 0;
 237
 238     msg_Dbg( p_filter, "successfully loaded osdmenu filter" );
 239     return VLC_SUCCESS;
 240
 241 error:
 242     msg_Err( p_filter, "osdmenu filter discarded" );
 243     vlc_mutex_destroy( &p_filter->p_sys->lock );
 244     if( p_filter->p_sys->p_menu )
 245     {
 246         osd_MenuDelete( p_this, p_filter->p_sys->p_menu );
 247         p_filter->p_sys->p_menu = NULL;
 248     }
 249     if( p_filter->p_sys->psz_file ) free( p_filter->p_sys->psz_file );
 250     if( p_filter->p_sys ) free( p_filter->p_sys );
 251     return VLC_EGENERIC;
 252 }
 253
 254 /*****************************************************************************
 255  * DestroyFilter: Make a clean exit of this plugin
 256  *****************************************************************************/
 257 static void DestroyFilter( vlc_object_t *p_this )
 258 {
 259     filter_t     *p_filter = (filter_t*)p_this;
 260     filter_sys_t *p_sys = p_filter->p_sys;
 261
 262     var_Destroy( p_this, OSD_CFG "file" );
 263     var_Destroy( p_this, OSD_CFG "x" );
 264     var_Destroy( p_this, OSD_CFG "y" );
 265     var_Destroy( p_this, OSD_CFG "position" );
 266     var_Destroy( p_this, OSD_CFG "timeout" );
 267     var_Destroy( p_this, OSD_CFG "update" );
 268
 269     var_DelCallback( p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
 270     var_DelCallback( p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
 271
 272     osd_MenuDelete( p_filter, p_sys->p_menu );
 273
 274     vlc_mutex_destroy( &p_filter->p_sys->lock );
 275     if( p_sys->psz_file) free( p_sys->psz_file );
 276     if( p_sys ) free( p_sys );
 277
 278     msg_Dbg( p_filter, "osdmenu filter destroyed" );
 279 }
 280
 281 /*****************************************************************************
 282  * OSDMenuEvent: callback for OSD Menu events
 283  *****************************************************************************/
 284 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
 285                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 286 {
 287     filter_t *p_filter = (filter_t *) p_data;
 288
 289     p_filter->p_sys->b_visible = VLC_TRUE;
 290     return VLC_SUCCESS;
 291 }
 292
 293 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
 294                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 295 {
 296     filter_t *p_filter = (filter_t *) p_data;
 297
 298     p_filter->p_sys->b_update = VLC_TRUE;
 299     p_filter->p_sys->i_end_date = (mtime_t) 0;
 300     return VLC_SUCCESS;
 301 }
 302
 303 #if 0
 304 /*****************************************************************************
 305  * create_text_region : compose a text region SPU
 306  *****************************************************************************/
 307 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
 308     int i_width, int i_height, const char *psz_text )
 309 {
 310     subpicture_region_t *p_region;
 311     video_format_t       fmt;
 312
 313     /* Create new SPU region */
 314     memset( &fmt, 0, sizeof(video_format_t) );
 315     fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
 316     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 317     fmt.i_sar_num = fmt.i_sar_den = 1;
 318     fmt.i_width = fmt.i_visible_width = i_width;
 319     fmt.i_height = fmt.i_visible_height = i_height;
 320     fmt.i_x_offset = fmt.i_y_offset = 0;
 321     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 322     if( !p_region )
 323     {
 324         msg_Err( p_filter, "cannot allocate another SPU region" );
 325         return NULL;
 326     }
 327     p_region->psz_text = strdup( psz_text );
 328     p_region->i_x = 0;
 329     p_region->i_y = 40;
 330 #if 1
 331     msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
 332         p_region->i_x, p_region->i_y,
 333         p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
 334 #endif
 335     return p_region;
 336 }
 337 #endif
 338
 339 /*****************************************************************************
 340  * create_picture_region : compose a picture region SPU
 341  *****************************************************************************/
 342 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
 343     int i_width, int i_height, picture_t *p_pic )
 344 {
 345     subpicture_region_t *p_region;
 346     video_format_t       fmt;
 347
 348     if( !p_spu ) return NULL;
 349
 350     /* Create new SPU region */
 351     memset( &fmt, 0, sizeof(video_format_t) );
 352     fmt.i_chroma = (p_pic == NULL) ? VLC_FOURCC('Y','U','V','P') : VLC_FOURCC('Y','U','V','A');
 353     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 354     fmt.i_sar_num = fmt.i_sar_den = 1;
 355     fmt.i_width = fmt.i_visible_width = i_width;
 356     fmt.i_height = fmt.i_visible_height = i_height;
 357     fmt.i_x_offset = fmt.i_y_offset = 0;
 358     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 359     if( !p_region )
 360     {
 361         msg_Err( p_filter, "cannot allocate SPU region" );
 362         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 363         return NULL;
 364     }
 365     if( !p_pic && ( fmt.i_chroma == VLC_FOURCC('Y','U','V','P') ) )
 366     {
 367         p_region->fmt.p_palette->i_entries = 0;
 368         p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
 369         p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
 370     }
 371     if( p_pic != NULL )
 372         vout_CopyPicture( p_filter, &p_region->picture, p_pic );
 373
 374     p_region->i_x = 0;
 375     p_region->i_y = 0;
 376 #if 0
 377     msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
 378         p_region->i_x, p_region->i_y,
 379         p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
 380 #endif
 381     return p_region;
 382 }
 383
 384 /****************************************************************************
 385  * Filter: the whole thing
 386  ****************************************************************************
 387  * This function outputs subpictures at regular time intervals.
 388  ****************************************************************************/
 389 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
 390 {
 391     filter_sys_t *p_sys = p_filter->p_sys;
 392     subpicture_t *p_spu;
 393     subpicture_region_t *p_region;
 394
 395     if( !p_sys->b_update )
 396             return NULL;
 397
 398     /* Am I too early? */
 399     if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
 400         ( p_sys->i_end_date > 0 ) )
 401         return NULL; /* we are too early, so wait */
 402
 403     /* Allocate the subpicture internal data. */
 404     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 405     if( !p_spu ) return NULL;
 406     p_spu->b_ephemer = VLC_TRUE;
 407     p_spu->b_fade = VLC_TRUE;
 408     p_spu->b_absolute = p_sys->b_absolute;
 409     p_spu->i_flags = p_sys->position;
 410
 411     /* Determine the duration of the subpicture */
 412     if( p_sys->i_end_date > 0 )
 413     {
 414         /* Display the subpicture again. */
 415         p_spu->i_stop = p_sys->i_end_date - i_date;
 416         if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
 417             p_sys->b_update = VLC_FALSE;
 418     }
 419     else
 420     {
 421         /* There is a new OSD picture to display */
 422         p_spu->i_stop = i_date + p_sys->i_timeout;
 423         p_sys->i_end_date = p_spu->i_stop;
 424     }
 425
 426     p_sys->i_last_date = i_date;
 427     p_spu->i_start = p_sys->i_last_date = i_date;
 428
 429     /* Send an empty subpicture to clear the display
 430      * when OSD menu should be hidden and menu picture is not allocated.
 431      */
 432     if( !p_filter->p_sys->p_menu->p_state->p_pic ||
 433         ( p_filter->p_sys->b_visible == VLC_FALSE ) )
 434     {
 435         /* Create new spu regions and allocate an empty picture in it. */
 436         p_region = create_picture_region( p_filter, p_spu,
 437             p_filter->p_sys->p_menu->p_state->i_width,
 438             p_filter->p_sys->p_menu->p_state->i_height,
 439             NULL );
 440
 441         /* proper positioning of OSD menu image */
 442         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 443         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 444         p_spu->p_region = p_region;
 445         p_spu->i_alpha = 0xFF; /* Picture is completely transparent. */
 446         return p_spu;
 447     }
 448
 449     /* Create new spu regions */
 450     p_region = create_picture_region( p_filter, p_spu,
 451         p_filter->p_sys->p_menu->p_state->i_width,
 452         p_filter->p_sys->p_menu->p_state->i_height,
 453         p_filter->p_sys->p_menu->p_state->p_pic );
 454 #if 0
 455     p_region->p_next = create_text_region( p_filter, p_spu,
 456         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
 457         p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
 458 #endif
 459
 460     /* proper positioning of OSD menu image */
 461     p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 462     p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 463     p_spu->p_region = p_region;
 464     return p_spu;
 465 }