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$
   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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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 <vlc_osd.h>
  36
  37 /*****************************************************************************
  38  * Module descriptor
  39  *****************************************************************************/
  40
  41 /* FIXME: Future extension make the definition file in XML format. */
  42 #define OSD_FILE_TEXT N_("OSD menu configuration file")
  43 #define OSD_FILE_LONGTEXT N_( \
  44     "An OSD menu configuration file that menu actions with button images" )
  45
  46 #define OSD_PATH_TEXT N_("Path to OSD menu images")
  47 #define OSD_PATH_LONGTEXT N_( \
  48     "Specify another path to the OSD menu images. This will override the path as defined in the " \
  49     "OSD configuration file." )
  50
  51 #define POSX_TEXT N_("X coordinate of the OSD menu")
  52 #define POSX_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
  53
  54 #define POSY_TEXT N_("Y coordinate of the OSD menu")
  55 #define POSY_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
  56
  57 #define POS_TEXT N_("OSD menu position")
  58 #define POS_LONGTEXT N_( \
  59   "You can enforce the OSD menu position on the video " \
  60   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
  61   "also use combinations of these values).")
  62
  63 #define TIMEOUT_TEXT N_("Timeout of OSD menu")
  64 #define TIMEOUT_LONGTEXT N_( \
  65     "OSD menu pictures get a default timeout of 15 seconds added to their " \
  66     "remaining time. This will ensure that they are at least the specified " \
  67     "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 200 ms (default). Shorten the update time for " \
  72     "environments that experience transmissions errors. Be careful 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 /*
 121     set_category( CAT_VIDEO );
 122     set_subcategory( SUBCAT_VIDEO_SUBPIC );
 123 */
 124     set_callbacks( CreateFilter, DestroyFilter );
 125 vlc_module_end();
 126
 127 /*****************************************************************************
 128  * Sub filter code
 129  *****************************************************************************/
 130
 131 /*****************************************************************************
 132  * Local prototypes
 133  *****************************************************************************/
 134 struct filter_sys_t
 135 {
 136     vlc_mutex_t  lock;
 137
 138     int          position;      /* relative positioning of SPU images */
 139     mtime_t      i_last_date;   /* last mdate SPU object has been sent to SPU subsytem */
 140     mtime_t      i_timeout;     /* duration SPU object is valid on the video output in seconds */
 141
 142     vlc_bool_t   b_absolute;    /* do we use absolute positioning or relative? */
 143     vlc_bool_t   b_update;      /* Update OSD Menu by sending SPU objects */
 144     vlc_bool_t   b_visible;     /* OSD Menu is visible */
 145     mtime_t      i_update;      /* Update the OSD menu every n ms */
 146     mtime_t      i_end_date;    /* End data of display OSD menu */
 147
 148     char        *psz_file;      /* OSD Menu configuration file */
 149     osd_menu_t  *p_menu;        /* pointer to OSD Menu object */
 150 };
 151
 152 /*****************************************************************************
 153  * CreateFilter: Create the filter and open the definition file
 154  *****************************************************************************/
 155 static int CreateFilter ( vlc_object_t *p_this )
 156 {
 157     filter_t *p_filter = (filter_t *)p_this;
 158     vlc_value_t val;
 159     int i_posx, i_posy;
 160
 161     p_filter->p_sys = (filter_sys_t *) malloc( sizeof( filter_sys_t ) );
 162     if( !p_filter->p_sys )
 163     {
 164         msg_Err( p_filter, "out of memory" );
 165         return VLC_ENOMEM;
 166     }
 167
 168     /* Populating struct */
 169     p_filter->p_sys->p_menu = NULL;
 170     p_filter->p_sys->psz_file = NULL;
 171
 172     vlc_mutex_init( p_filter, &p_filter->p_sys->lock );
 173
 174     p_filter->p_sys->psz_file = config_GetPsz( p_filter, OSD_CFG "file" );
 175     if( p_filter->p_sys->psz_file == NULL || *p_filter->p_sys->psz_file == '\0' )
 176     {
 177         msg_Err( p_filter, "unable to get filename" );
 178         goto error;
 179     }
 180
 181     var_Create( p_this, OSD_CFG "position", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 182     var_Get( p_this, OSD_CFG "position", &val );
 183     p_filter->p_sys->position = val.i_int;
 184     var_Create( p_this, OSD_CFG "x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 185     var_Get( p_this, OSD_CFG "x", &val );
 186     i_posx = val.i_int;
 187     var_Create( p_this, OSD_CFG "y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 188     var_Get( p_this, OSD_CFG "y", &val );
 189     i_posy = val.i_int;
 190
 191     /* in micro seconds - divide by 2 to match user expectations */
 192     var_Create( p_this, OSD_CFG "timeout", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 193     var_Get( p_this, OSD_CFG "timeout", &val );
 194     p_filter->p_sys->i_timeout = (mtime_t)(val.i_int * 1000000) >> 2;
 195     var_Create( p_this, OSD_CFG "update", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 196     var_Get( p_this, OSD_CFG "update", &val );
 197     p_filter->p_sys->i_update = (mtime_t)(val.i_int * 1000); /* in micro seconds */
 198
 199     /* Load the osd menu subsystem */
 200     p_filter->p_sys->p_menu = osd_MenuCreate( p_this, p_filter->p_sys->psz_file );
 201     if( p_filter->p_sys->p_menu == NULL )
 202         goto error;
 203
 204     /* Check if menu position was overridden */
 205     p_filter->p_sys->b_absolute = VLC_TRUE;
 206     if( i_posx < 0 || i_posy < 0)
 207     {
 208         p_filter->p_sys->b_absolute = VLC_FALSE;
 209         p_filter->p_sys->p_menu->i_x = 0;
 210         p_filter->p_sys->p_menu->i_y = 0;
 211     }
 212     else if( i_posx >= 0 || i_posy >= 0 )
 213     {
 214         p_filter->p_sys->p_menu->i_x = i_posx;
 215         p_filter->p_sys->p_menu->i_y = i_posy;
 216     }
 217     else if( p_filter->p_sys->p_menu->i_x < 0 || p_filter->p_sys->p_menu->i_y < 0 )
 218     {
 219         p_filter->p_sys->b_absolute = VLC_FALSE;
 220         p_filter->p_sys->p_menu->i_x = 0;
 221         p_filter->p_sys->p_menu->i_y = 0;
 222     }
 223
 224     /* Set up p_filter */
 225     p_filter->p_sys->i_last_date = mdate();
 226
 227     /* Keep track of OSD Events */
 228     p_filter->p_sys->b_update  = VLC_FALSE;
 229     p_filter->p_sys->b_visible = VLC_FALSE;
 230
 231     var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
 232     var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
 233
 234     /* Attach subpicture filter callback */
 235     p_filter->pf_sub_filter = Filter;
 236
 237     es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
 238     p_filter->fmt_out.i_priority = 0;
 239
 240     msg_Dbg( p_filter, "successfully loaded osdmenu filter" );
 241     return VLC_SUCCESS;
 242
 243 error:
 244     msg_Err( p_filter, "osdmenu filter discarded" );
 245     vlc_mutex_destroy( &p_filter->p_sys->lock );
 246     if( p_filter->p_sys->p_menu )
 247     {
 248         osd_MenuDelete( p_this, p_filter->p_sys->p_menu );
 249         p_filter->p_sys->p_menu = NULL;
 250     }
 251     if( p_filter->p_sys->psz_file ) free( p_filter->p_sys->psz_file );
 252     if( p_filter->p_sys ) free( p_filter->p_sys );
 253     return VLC_EGENERIC;
 254 }
 255
 256 /*****************************************************************************
 257  * DestroyFilter: Make a clean exit of this plugin
 258  *****************************************************************************/
 259 static void DestroyFilter( vlc_object_t *p_this )
 260 {
 261     filter_t     *p_filter = (filter_t*)p_this;
 262     filter_sys_t *p_sys = p_filter->p_sys;
 263
 264     var_Destroy( p_this, OSD_CFG "file" );
 265     var_Destroy( p_this, OSD_CFG "x" );
 266     var_Destroy( p_this, OSD_CFG "y" );
 267     var_Destroy( p_this, OSD_CFG "position" );
 268     var_Destroy( p_this, OSD_CFG "timeout" );
 269     var_Destroy( p_this, OSD_CFG "update" );
 270
 271     var_DelCallback( p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
 272     var_DelCallback( p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
 273
 274     osd_MenuDelete( p_filter, p_sys->p_menu );
 275
 276     vlc_mutex_destroy( &p_filter->p_sys->lock );
 277     if( p_sys->psz_file) free( p_sys->psz_file );
 278     if( p_sys ) free( p_sys );
 279
 280     msg_Dbg( p_filter, "osdmenu filter destroyed" );
 281 }
 282
 283 /*****************************************************************************
 284  * OSDMenuEvent: callback for OSD Menu events
 285  *****************************************************************************/
 286 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
 287                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 288 {
 289     filter_t *p_filter = (filter_t *) p_data;
 290
 291     p_filter->p_sys->b_visible = VLC_TRUE;
 292     return VLC_SUCCESS;
 293 }
 294
 295 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
 296                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 297 {
 298     filter_t *p_filter = (filter_t *) p_data;
 299
 300     p_filter->p_sys->b_update = VLC_TRUE;
 301     p_filter->p_sys->i_end_date = (mtime_t) 0;
 302     return VLC_SUCCESS;
 303 }
 304
 305 #if 0
 306 /*****************************************************************************
 307  * create_text_region : compose a text region SPU
 308  *****************************************************************************/
 309 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
 310     int i_width, int i_height, const char *psz_text )
 311 {
 312     subpicture_region_t *p_region;
 313     video_format_t       fmt;
 314
 315     /* Create new SPU region */
 316     memset( &fmt, 0, sizeof(video_format_t) );
 317     fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
 318     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 319     fmt.i_sar_num = fmt.i_sar_den = 1;
 320     fmt.i_width = fmt.i_visible_width = i_width;
 321     fmt.i_height = fmt.i_visible_height = i_height;
 322     fmt.i_x_offset = fmt.i_y_offset = 0;
 323     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 324     if( !p_region )
 325     {
 326         msg_Err( p_filter, "cannot allocate another SPU region" );
 327         return NULL;
 328     }
 329     p_region->psz_text = strdup( psz_text );
 330     p_region->i_x = 0;
 331     p_region->i_y = 40;
 332 #if 1
 333     msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
 334         p_region->i_x, p_region->i_y,
 335         p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
 336 #endif
 337     return p_region;
 338 }
 339 #endif
 340
 341 /*****************************************************************************
 342  * create_picture_region : compose a picture region SPU
 343  *****************************************************************************/
 344 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
 345     int i_width, int i_height, picture_t *p_pic )
 346 {
 347     subpicture_region_t *p_region;
 348     video_format_t       fmt;
 349
 350     if( !p_spu ) return NULL;
 351
 352     /* Create new SPU region */
 353     memset( &fmt, 0, sizeof(video_format_t) );
 354     fmt.i_chroma = (p_pic == NULL) ? VLC_FOURCC('Y','U','V','P') : VLC_FOURCC('Y','U','V','A');
 355     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 356     fmt.i_sar_num = fmt.i_sar_den = 1;
 357     fmt.i_width = fmt.i_visible_width = i_width;
 358     fmt.i_height = fmt.i_visible_height = i_height;
 359     fmt.i_x_offset = fmt.i_y_offset = 0;
 360     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 361     if( !p_region )
 362     {
 363         msg_Err( p_filter, "cannot allocate SPU region" );
 364         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 365         return NULL;
 366     }
 367     if( !p_pic && ( fmt.i_chroma == VLC_FOURCC('Y','U','V','P') ) )
 368     {
 369         p_region->fmt.p_palette->i_entries = 0;
 370         p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
 371         p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
 372     }
 373     if( p_pic != NULL )
 374         vout_CopyPicture( p_filter, &p_region->picture, p_pic );
 375
 376     p_region->i_x = 0;
 377     p_region->i_y = 0;
 378 #if 0
 379     msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
 380         p_region->i_x, p_region->i_y,
 381         p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
 382 #endif
 383     return p_region;
 384 }
 385
 386 /****************************************************************************
 387  * Filter: the whole thing
 388  ****************************************************************************
 389  * This function outputs subpictures at regular time intervals.
 390  ****************************************************************************/
 391 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
 392 {
 393     filter_sys_t *p_sys = p_filter->p_sys;
 394     subpicture_t *p_spu;
 395     subpicture_region_t *p_region;
 396
 397     if( !p_sys->b_update )
 398             return NULL;
 399
 400     /* Am I too early? */
 401     if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
 402         ( p_sys->i_end_date > 0 ) )
 403         return NULL; /* we are too early, so wait */
 404
 405     /* Allocate the subpicture internal data. */
 406     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 407     if( !p_spu ) return NULL;
 408     p_spu->b_ephemer = VLC_TRUE;
 409     p_spu->b_fade = VLC_TRUE;
 410     p_spu->b_absolute = p_sys->b_absolute;
 411     p_spu->i_flags = p_sys->position;
 412
 413     /* Determine the duration of the subpicture */
 414     if( p_sys->i_end_date > 0 )
 415     {
 416         /* Display the subpicture again. */
 417         p_spu->i_stop = p_sys->i_end_date - i_date;
 418         if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
 419             p_sys->b_update = VLC_FALSE;
 420     }
 421     else
 422     {
 423         /* There is a new OSD picture to display */
 424         p_spu->i_stop = i_date + p_sys->i_timeout;
 425         p_sys->i_end_date = p_spu->i_stop;
 426     }
 427
 428     p_sys->i_last_date = i_date;
 429     p_spu->i_start = p_sys->i_last_date = i_date;
 430
 431     /* Send an empty subpicture to clear the display
 432      * when OSD menu should be hidden and menu picture is not allocated.
 433      */
 434     if( !p_filter->p_sys->p_menu->p_state->p_pic ||
 435         ( p_filter->p_sys->b_visible == VLC_FALSE ) )
 436     {
 437         /* Create new spu regions and allocate an empty picture in it. */
 438         p_region = create_picture_region( p_filter, p_spu,
 439             p_filter->p_sys->p_menu->p_state->i_width,
 440             p_filter->p_sys->p_menu->p_state->i_height,
 441             NULL );
 442
 443         /* proper positioning of OSD menu image */
 444         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 445         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 446         p_spu->p_region = p_region;
 447         p_spu->i_alpha = 0xFF; /* Picture is completely transparent. */
 448         return p_spu;
 449     }
 450
 451     /* Create new spu regions */
 452     p_region = create_picture_region( p_filter, p_spu,
 453         p_filter->p_sys->p_menu->p_state->i_width,
 454         p_filter->p_sys->p_menu->p_state->i_height,
 455         p_filter->p_sys->p_menu->p_state->p_pic );
 456 #if 0
 457     p_region->p_next = create_text_region( p_filter, p_spu,
 458         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
 459         p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
 460 #endif
 461
 462     /* proper positioning of OSD menu image */
 463     p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 464     p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 465     p_spu->p_region = p_region;
 466     return p_spu;
 467 }