osdmenu.c 17.7 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * osdmenu.c: osd filter module
 *****************************************************************************
 * Copyright (C) 2004-2005 M2X
dionoea's avatar
dionoea committed
5
 * $Id$
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implid warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
dionoea's avatar
dionoea committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <stdlib.h>
#include <string.h>
#include <vlc/vlc.h>
#include <vlc/input.h>

#include <vlc_filter.h>
#include <vlc_video.h>

#include <vlc_osd.h>

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/

/* FIXME: Future extension make the definition file in XML format. */
42
#define OSD_FILE_TEXT N_("Configuration file")
zorglub's avatar
zorglub committed
43
/// \bug [String] missing dot
44
#define OSD_FILE_LONGTEXT N_( \
45
    "Configuration file for the OSD Menu" )
46 47
#define OSD_PATH_TEXT N_("Path to OSD menu images")
#define OSD_PATH_LONGTEXT N_( \
48
    "Path to the OSD menu images. This will override the path defined in the " \
49 50
    "OSD configuration file." )

51
#define POSX_TEXT N_("X coordinate")
52 53
#define POSX_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )

54
#define POSY_TEXT N_("Y coordinate")
55 56
#define POSY_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )

57
#define POS_TEXT N_("Menu position")
58 59 60
#define POS_LONGTEXT N_( \
  "You can enforce the OSD menu position on the video " \
  "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
61
  "also use combinations of these values, eg. 6 = top-right).")
62

63
#define TIMEOUT_TEXT N_("Menu timeout")
64
#define TIMEOUT_LONGTEXT N_( \
Felix Paul Kühne's avatar
Felix Paul Kühne committed
65 66 67
    "OSD menu pictures get a default timeout of 15 seconds added to their " \
    "remaining time. This will ensure that they are at least the specified " \
    "time visible.")
68

69
#define OSD_UPDATE_TEXT N_("Menu update interval" )
70
#define OSD_UPDATE_LONGTEXT N_( \
71 72 73 74
    "The default is to update the OSD menu picture every 200 ms. Shorten the" \
    " update time for environments that experience transmissions errors. " \
    "Be careful with this option as encoding OSD menu pictures is very " \
    "computing intensive. The range is 0 - 1000 ms." )
Jean-Paul Saman's avatar
Jean-Paul Saman committed
75

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
static char *ppsz_pos_descriptions[] =
{ N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
  N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };

/* subfilter functions */
static int  CreateFilter ( vlc_object_t * );
static void DestroyFilter( vlc_object_t * );
static subpicture_t *Filter( filter_t *, mtime_t );
static int OSDMenuUpdateEvent( vlc_object_t *, char const *,
                    vlc_value_t, vlc_value_t, void * );                    
static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
                    vlc_value_t, vlc_value_t, void * );

#define OSD_CFG "osdmenu-"

92 93 94 95 96 97
#if defined( WIN32 ) || defined( UNDER_CE )
#define OSD_DEFAULT_CFG "osdmenu/default.cfg"
#else
#define OSD_DEFAULT_CFG "share/osdmenu/default.cfg"
#endif

98 99
#define OSD_UPDATE_MIN     0
#define OSD_UPDATE_DEFAULT 0
Jean-Paul Saman's avatar
Jean-Paul Saman committed
100
#define OSD_UPDATE_MAX     1000
101

102 103 104 105 106
vlc_module_begin();
    add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
    add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
    add_integer( OSD_CFG "position", 8, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
        change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
107 108 109 110
    add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT,
        OSD_FILE_LONGTEXT, VLC_FALSE );
    add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT,
        OSD_PATH_LONGTEXT, VLC_FALSE );
111
    add_integer( OSD_CFG "timeout", 15, NULL, TIMEOUT_TEXT,
112
        TIMEOUT_LONGTEXT, VLC_FALSE );
113 114 115
    add_integer_with_range( OSD_CFG "update", OSD_UPDATE_DEFAULT,
        OSD_UPDATE_MIN, OSD_UPDATE_MAX, NULL, OSD_UPDATE_TEXT,
        OSD_UPDATE_LONGTEXT, VLC_TRUE );
116 117

    set_capability( "sub filter", 100 );
118
    set_description( N_("On Screen Display menu") );
119 120
    set_shortname( N_("OSD menu") );
    add_shortcut( "osdmenu" );
zorglub's avatar
zorglub committed
121
/*
122 123
    set_category( CAT_VIDEO );
    set_subcategory( SUBCAT_VIDEO_SUBPIC );
zorglub's avatar
zorglub committed
124
*/
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
    set_callbacks( CreateFilter, DestroyFilter );
vlc_module_end();

/*****************************************************************************
 * Sub filter code
 *****************************************************************************/

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
struct filter_sys_t
{
    vlc_mutex_t  lock;

    int          position;      /* relative positioning of SPU images */
    mtime_t      i_last_date;   /* last mdate SPU object has been sent to SPU subsytem */
141
    mtime_t      i_timeout;     /* duration SPU object is valid on the video output in seconds */
142

143 144 145
    vlc_bool_t   b_absolute;    /* do we use absolute positioning or relative? */
    vlc_bool_t   b_update;      /* Update OSD Menu by sending SPU objects */
    vlc_bool_t   b_visible;     /* OSD Menu is visible */
146 147
    mtime_t      i_update;      /* Update the OSD menu every n ms */
    mtime_t      i_end_date;    /* End data of display OSD menu */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
148

149 150 151 152 153 154 155 156 157 158 159
    char        *psz_file;      /* OSD Menu configuration file */
    osd_menu_t  *p_menu;        /* pointer to OSD Menu object */
};

/*****************************************************************************
 * CreateFilter: Create the filter and open the definition file
 *****************************************************************************/
static int CreateFilter ( vlc_object_t *p_this )
{
    filter_t *p_filter = (filter_t *)p_this;
    vlc_value_t val;
160
    int i_posx, i_posy;
161 162 163 164 165 166

    p_filter->p_sys = (filter_sys_t *) malloc( sizeof( filter_sys_t ) );
    if( !p_filter->p_sys )
    {
        msg_Err( p_filter, "out of memory" );
        return VLC_ENOMEM;
167 168
    }

169 170 171
    /* Populating struct */
    p_filter->p_sys->p_menu = NULL;
    p_filter->p_sys->psz_file = NULL;
172

173 174 175 176 177 178 179 180 181 182 183 184 185 186
    vlc_mutex_init( p_filter, &p_filter->p_sys->lock );

    p_filter->p_sys->psz_file = config_GetPsz( p_filter, OSD_CFG "file" );
    if( p_filter->p_sys->psz_file == NULL || *p_filter->p_sys->psz_file == '\0' ) 
    {
        msg_Err( p_filter, "unable to get filename" );
        goto error;
    }

    var_Create( p_this, OSD_CFG "position", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    var_Get( p_this, OSD_CFG "position", &val );
    p_filter->p_sys->position = val.i_int;
    var_Create( p_this, OSD_CFG "x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    var_Get( p_this, OSD_CFG "x", &val );
187
    i_posx = val.i_int;
188 189
    var_Create( p_this, OSD_CFG "y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    var_Get( p_this, OSD_CFG "y", &val );
190
    i_posy = val.i_int;
Jean-Paul Saman's avatar
Jean-Paul Saman committed
191

192
    /* in micro seconds - divide by 2 to match user expectations */
193 194
    var_Create( p_this, OSD_CFG "timeout", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    var_Get( p_this, OSD_CFG "timeout", &val );
195 196 197 198 199
    p_filter->p_sys->i_timeout = (mtime_t)(val.i_int * 1000000) >> 2; 
    var_Create( p_this, OSD_CFG "update", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    var_Get( p_this, OSD_CFG "update", &val );
    p_filter->p_sys->i_update = (mtime_t)(val.i_int * 1000); /* in micro seconds */

200 201 202 203
    /* Load the osd menu subsystem */
    p_filter->p_sys->p_menu = osd_MenuCreate( p_this, p_filter->p_sys->psz_file );
    if( p_filter->p_sys->p_menu == NULL )
        goto error;
204

205 206
    /* Check if menu position was overridden */
    p_filter->p_sys->b_absolute = VLC_TRUE;
207
    if( i_posx < 0 || i_posy < 0)
208 209 210 211 212
    {
        p_filter->p_sys->b_absolute = VLC_FALSE;
        p_filter->p_sys->p_menu->i_x = 0;
        p_filter->p_sys->p_menu->i_y = 0;
    }
213
    else if( i_posx >= 0 || i_posy >= 0 )
214
    {
215 216
        p_filter->p_sys->p_menu->i_x = i_posx;
        p_filter->p_sys->p_menu->i_y = i_posy;
217 218 219 220 221 222 223
    }
    else if( p_filter->p_sys->p_menu->i_x < 0 || p_filter->p_sys->p_menu->i_y < 0 )
    {
        p_filter->p_sys->b_absolute = VLC_FALSE;
        p_filter->p_sys->p_menu->i_x = 0;
        p_filter->p_sys->p_menu->i_y = 0;
    }
224

225 226
    /* Set up p_filter */
    p_filter->p_sys->i_last_date = mdate();
227

228
    /* Keep track of OSD Events */
229
    p_filter->p_sys->b_update  = VLC_FALSE;
230
    p_filter->p_sys->b_visible = VLC_FALSE;
231

232 233 234 235 236
    var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );        
    var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );        

    /* Attach subpicture filter callback */
    p_filter->pf_sub_filter = Filter;
237

238 239
    es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
    p_filter->fmt_out.i_priority = 0;
240

241 242
    msg_Dbg( p_filter, "successfully loaded osdmenu filter" );    
    return VLC_SUCCESS;
243

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
error:
    msg_Err( p_filter, "osdmenu filter discarded" );
    vlc_mutex_destroy( &p_filter->p_sys->lock );
    if( p_filter->p_sys->p_menu )
    {
        osd_MenuDelete( p_this, p_filter->p_sys->p_menu );
        p_filter->p_sys->p_menu = NULL;
    }
    if( p_filter->p_sys->psz_file ) free( p_filter->p_sys->psz_file );
    if( p_filter->p_sys ) free( p_filter->p_sys );
    return VLC_EGENERIC;    
}

/*****************************************************************************
 * DestroyFilter: Make a clean exit of this plugin
 *****************************************************************************/
static void DestroyFilter( vlc_object_t *p_this )
{
    filter_t     *p_filter = (filter_t*)p_this;
    filter_sys_t *p_sys = p_filter->p_sys;

    var_Destroy( p_this, OSD_CFG "file" );
    var_Destroy( p_this, OSD_CFG "x" );
    var_Destroy( p_this, OSD_CFG "y" );
    var_Destroy( p_this, OSD_CFG "position" );
    var_Destroy( p_this, OSD_CFG "timeout" );
270
    var_Destroy( p_this, OSD_CFG "update" );
271 272 273

    var_DelCallback( p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
    var_DelCallback( p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
274 275

    osd_MenuDelete( p_filter, p_sys->p_menu );
276 277 278 279 280 281

    vlc_mutex_destroy( &p_filter->p_sys->lock );
    if( p_sys->psz_file) free( p_sys->psz_file );
    if( p_sys ) free( p_sys );

    msg_Dbg( p_filter, "osdmenu filter destroyed" );
282 283 284 285 286 287 288 289 290
}

/*****************************************************************************
 * OSDMenuEvent: callback for OSD Menu events
 *****************************************************************************/
static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
                    vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
    filter_t *p_filter = (filter_t *) p_data;
291 292

    p_filter->p_sys->b_visible = VLC_TRUE;
293 294 295 296 297 298 299
    return VLC_SUCCESS;
}

static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
                    vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
    filter_t *p_filter = (filter_t *) p_data;
300 301

    p_filter->p_sys->b_update = VLC_TRUE;
302
    p_filter->p_sys->i_end_date = (mtime_t) 0;
303 304 305 306 307 308 309 310 311 312 313
    return VLC_SUCCESS;
}

#if 0
/*****************************************************************************
 * create_text_region : compose a text region SPU
 *****************************************************************************/
static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu, 
    int i_width, int i_height, const char *psz_text )
{
    subpicture_region_t *p_region;
314 315
    video_format_t       fmt;

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
    /* Create new SPU region */
    memset( &fmt, 0, sizeof(video_format_t) );
    fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
    fmt.i_aspect = VOUT_ASPECT_FACTOR;
    fmt.i_sar_num = fmt.i_sar_den = 1;
    fmt.i_width = fmt.i_visible_width = i_width;
    fmt.i_height = fmt.i_visible_height = i_height;
    fmt.i_x_offset = fmt.i_y_offset = 0;
    p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
    if( !p_region )
    {
        msg_Err( p_filter, "cannot allocate another SPU region" );
        return NULL;
    }
    p_region->psz_text = strdup( psz_text );
    p_region->i_x = 0; 
    p_region->i_y = 40;
333
#if 1
334 335 336 337
    msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]", 
        p_region->i_x, p_region->i_y, 
        p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
#endif
338 339
    return p_region;
}
340 341 342
#endif

/*****************************************************************************
343
 * create_picture_region : compose a picture region SPU
344 345 346 347 348
 *****************************************************************************/
static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
    int i_width, int i_height, picture_t *p_pic )
{
    subpicture_region_t *p_region;
349
    video_format_t       fmt;
350

351
    if( !p_spu ) return NULL;
352

353
    /* Create new SPU region */
354
    memset( &fmt, 0, sizeof(video_format_t) );
355
    fmt.i_chroma = (p_pic == NULL) ? VLC_FOURCC('Y','U','V','P') : VLC_FOURCC('Y','U','V','A');
356 357 358 359 360
    fmt.i_aspect = VOUT_ASPECT_FACTOR;
    fmt.i_sar_num = fmt.i_sar_den = 1;
    fmt.i_width = fmt.i_visible_width = i_width;
    fmt.i_height = fmt.i_visible_height = i_height;
    fmt.i_x_offset = fmt.i_y_offset = 0;
361
    p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
362 363 364 365 366 367
    if( !p_region )
    {
        msg_Err( p_filter, "cannot allocate SPU region" );
        p_filter->pf_sub_buffer_del( p_filter, p_spu );
        return NULL;
    }
368
    if( !p_pic && ( fmt.i_chroma == VLC_FOURCC('Y','U','V','P') ) )
369
    {
370
        p_region->fmt.p_palette->i_entries = 0;
371 372
        p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
        p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
373
    }
374 375 376
    if( p_pic != NULL )
        vout_CopyPicture( p_filter, &p_region->picture, p_pic );

377 378
    p_region->i_x = 0;
    p_region->i_y = 0;
379
#if 0
380 381
    msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
        p_region->i_x, p_region->i_y,
382 383 384 385 386 387 388 389 390 391 392 393
        p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
#endif
    return p_region;
}

/****************************************************************************
 * Filter: the whole thing
 ****************************************************************************
 * This function outputs subpictures at regular time intervals.
 ****************************************************************************/
static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
{
394
    filter_sys_t *p_sys = p_filter->p_sys;
395 396
    subpicture_t *p_spu;
    subpicture_region_t *p_region;
397

398
    if( !p_sys->b_update )
399
            return NULL;
400 401 402 403 404
            
    /* Am I too early? */
    if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
        ( p_sys->i_end_date > 0 ) )
        return NULL; /* we are too early, so wait */
405
    
406 407 408 409
    /* Allocate the subpicture internal data. */
    p_spu = p_filter->pf_sub_buffer_new( p_filter );
    if( !p_spu ) return NULL;
    p_spu->b_ephemer = VLC_TRUE;
410 411
    p_spu->b_fade = VLC_TRUE;    
    p_spu->b_absolute = p_sys->b_absolute;
412
    p_spu->i_flags = p_sys->position;
413

414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
    /* Determine the duration of the subpicture */
    if( p_sys->i_end_date > 0 )
    {
        /* Display the subpicture again. */
        p_spu->i_stop = p_sys->i_end_date - i_date;
        if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
            p_sys->b_update = VLC_FALSE;
    }
    else
    {
        /* There is a new OSD picture to display */
        p_spu->i_stop = i_date + p_sys->i_timeout;
        p_sys->i_end_date = p_spu->i_stop;
    }
    
    p_sys->i_last_date = i_date;
    p_spu->i_start = p_sys->i_last_date = i_date;

432 433 434
    /* Send an empty subpicture to clear the display
     * when OSD menu should be hidden and menu picture is not allocated.
     */
435 436 437
    if( !p_filter->p_sys->p_menu->p_state->p_pic ||
        ( p_filter->p_sys->b_visible == VLC_FALSE ) )
    {
438 439
        /* Create new spu regions and allocate an empty picture in it. */
        p_region = create_picture_region( p_filter, p_spu,
440
            p_filter->p_sys->p_menu->p_state->i_width,
441
            p_filter->p_sys->p_menu->p_state->i_height,
442
            NULL );
443

444 445
        /* proper positioning of OSD menu image */
        p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
446
        p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
447
        p_spu->p_region = p_region;
448
        p_spu->i_alpha = 0xFF; /* Picture is completely transparent. */
449
        return p_spu;
450
    }
451 452 453

    /* Create new spu regions */
    p_region = create_picture_region( p_filter, p_spu,
454
        p_filter->p_sys->p_menu->p_state->i_width,
455
        p_filter->p_sys->p_menu->p_state->i_height,
456
        p_filter->p_sys->p_menu->p_state->p_pic );
457
#if 0
458 459
    p_region->p_next = create_text_region( p_filter, p_spu,
        p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
460
        p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
461
#endif
462

463 464
    /* proper positioning of OSD menu image */
    p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
465
    p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
466 467 468
    p_spu->p_region = p_region;
    return p_spu;
}