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