marq.c 8.25 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
/*****************************************************************************
 * marq.c : marquee display video plugin for vlc
 *****************************************************************************
 * Copyright (C) 2003-2004 VideoLAN
 * $Id: time.c 8751 2004-09-20 21:51:41Z gbazin $
 *
 * Authors: Mark Moriarty
 *
 * 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 implied 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
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <stdlib.h>                                      /* malloc(), free() */
#include <string.h>

#include <vlc/vlc.h>
#include <vlc/vout.h>

#include "vlc_filter.h"
#include "vlc_block.h"
#include "osd.h"

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static int  CreateFilter ( vlc_object_t * );
static void DestroyFilter( vlc_object_t * );
static subpicture_t *Filter( filter_t *, mtime_t );

zorglub's avatar
zorglub committed
44 45 46 47 48

static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
                            vlc_value_t oldval, vlc_value_t newval,
                            void *p_data );

49 50 51 52 53 54
/*****************************************************************************
 * filter_sys_t: marquee filter descriptor
 *****************************************************************************/
struct filter_sys_t
{
    int i_xoff, i_yoff;  /* offsets for the display string in the video window */
zorglub's avatar
zorglub committed
55 56
    int i_timeout;

57
    char *psz_marquee;    /* marquee string */
zorglub's avatar
zorglub committed
58

59
    time_t last_time;
zorglub's avatar
zorglub committed
60 61

    vlc_bool_t b_need_update;
62 63 64 65 66 67 68 69
};

#define MSG_TEXT N_("Marquee text")
#define MSG_LONGTEXT N_("Marquee text to display")
#define POSX_TEXT N_("X offset, from left")
#define POSX_LONGTEXT N_("X offset, from the left screen edge" )
#define POSY_TEXT N_("Y offset, from the top")
#define POSY_LONGTEXT N_("Y offset, down from the top" )
zorglub's avatar
zorglub committed
70 71 72 73
#define TIMEOUT_TEXT N_("Marquee timeout")
#define TIMEOUT_LONGTEXT N_("Defines the time the marquee must remain " \
                            "displayed, in milliseconds. Default value is " \
                            "0 (remain forever)")
74 75 76 77 78 79 80 81 82 83

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
vlc_module_begin();
    set_capability( "sub filter", 0 );
    set_callbacks( CreateFilter, DestroyFilter );
    add_string( "marquee", "Marquee", NULL, MSG_TEXT, MSG_LONGTEXT, VLC_FALSE );
    add_integer( "marq-x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
    add_integer( "marq-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
zorglub's avatar
zorglub committed
84 85
    add_integer( "marq-timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
                 VLC_FALSE );
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
    set_description( _("Marquee display sub filter") );
    add_shortcut( "marq" );
vlc_module_end();

/*****************************************************************************
 * CreateFilter: allocates marquee video filter
 *****************************************************************************/
static int CreateFilter( vlc_object_t *p_this )
{
    filter_t *p_filter = (filter_t *)p_this;
    filter_sys_t *p_sys;

    /* Allocate structure */
    p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
    if( p_sys == NULL )
    {
        msg_Err( p_filter, "out of memory" );
        return VLC_ENOMEM;
    }

zorglub's avatar
zorglub committed
106
    /* hook to the playlist */
107 108 109 110 111 112 113 114
    vlc_object_t *p_pl =
          vlc_object_find( p_this, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
    if( !p_pl )
    {
        return VLC_ENOOBJ;
    }


zorglub's avatar
zorglub committed
115 116 117 118 119 120 121 122 123
    p_sys->i_xoff = var_CreateGetInteger( p_pl , "marq-x" );
    p_sys->i_yoff = var_CreateGetInteger( p_pl , "marq-y" );
    p_sys->i_timeout = var_CreateGetInteger( p_pl , "marq-timeout" );
    p_sys->psz_marquee =  var_CreateGetString( p_pl, "marquee" );

    var_AddCallback( p_pl, "marq-x", MarqueeCallback, p_sys );
    var_AddCallback( p_pl, "marq-y", MarqueeCallback, p_sys );
    var_AddCallback( p_pl, "marquee", MarqueeCallback, p_sys );
    var_AddCallback( p_pl, "marq-timeout", MarqueeCallback, p_sys );
124 125

    vlc_object_release( p_pl );
zorglub's avatar
zorglub committed
126

127 128 129
    /* Misc init */
    p_filter->pf_sub_filter = Filter;
    p_sys->last_time = ((time_t)-1);
zorglub's avatar
zorglub committed
130
    p_sys->b_need_update = VLC_TRUE;
131 132 133 134 135 136 137 138 139 140 141 142 143

    return VLC_SUCCESS;
}
/*****************************************************************************
 * DestroyFilter: destroy marquee video filter
 *****************************************************************************/
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;

    if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
    free( p_sys );
zorglub's avatar
zorglub committed
144 145

    /* Delete the marquee variables from playlist */
146 147
    vlc_object_t *p_pl =
        vlc_object_find( p_this, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
zorglub's avatar
zorglub committed
148 149 150 151 152 153 154 155
    if( !p_pl )
    {
        return;
    }
    var_Destroy( p_pl , "marquee" );
    var_Destroy( p_pl , "marq-x" );
    var_Destroy( p_pl , "marq_y" );
    vlc_object_release( p_pl );
156 157 158 159 160 161 162 163 164 165 166 167 168 169
}

/****************************************************************************
 * Filter: the whole thing
 ****************************************************************************
 * This function outputs subpictures at regular time intervals.
 ****************************************************************************/
static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
{
    filter_sys_t *p_sys = p_filter->p_sys;
    subpicture_t *p_spu;
    video_format_t fmt;
    time_t t;

zorglub's avatar
zorglub committed
170 171 172 173 174 175 176 177 178
    if( p_sys->last_time == time( NULL ) )
    {
        return NULL;
    }

    if( p_sys->b_need_update == VLC_FALSE )
    {
        return NULL;
    }
179 180 181

    p_spu = p_filter->pf_sub_buffer_new( p_filter );
    if( !p_spu ) return NULL;
zorglub's avatar
zorglub committed
182

183 184 185
    memset( &fmt, 0, sizeof(video_format_t) );
    fmt.i_chroma = VLC_FOURCC('T','E','X','T');
    fmt.i_aspect = 0;
zorglub's avatar
zorglub committed
186
    fmt.i_width = fmt.i_height = 0;
187 188
    fmt.i_x_offset = 0;
    fmt.i_y_offset = 0;
zorglub's avatar
zorglub committed
189

190 191 192 193 194 195 196 197 198
    p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
    if( !p_spu->p_region )
    {
        p_filter->pf_sub_buffer_del( p_filter, p_spu );
        return NULL;
    }

    t = p_sys->last_time = time( NULL );

zorglub's avatar
zorglub committed
199
    p_spu->p_region->psz_text = strdup(p_sys->psz_marquee);
200
    p_spu->i_start = date;
zorglub's avatar
zorglub committed
201
    p_spu->i_stop  = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
202 203 204 205 206 207
    p_spu->b_ephemer = VLC_TRUE;
    p_spu->b_absolute = VLC_FALSE;
    p_spu->i_x = p_sys->i_xoff;
    p_spu->i_y = p_sys->i_yoff;

    p_spu->i_flags = OSD_ALIGN_LEFT|OSD_ALIGN_TOP ;
zorglub's avatar
zorglub committed
208 209

    p_sys->b_need_update = VLC_FALSE;
210 211
    return p_spu;
}
zorglub's avatar
zorglub committed
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

/**********************************************************************
 * Callback to update params on the fly
 **********************************************************************/
static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
                            vlc_value_t oldval, vlc_value_t newval,
                            void *p_data )
{
    filter_sys_t *p_sys = (filter_sys_t *) p_data;

    if( !strncmp( psz_var, "marquee", 7 ) )
    {
        if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
        p_sys->psz_marquee = strdup( newval.psz_string );
    }
    else if ( !strncmp( psz_var, "marq-x", 6 ) )
    {
        p_sys->i_xoff = newval.i_int;
    }
    else if ( !strncmp( psz_var, "marq-y", 6 ) )
    {
        p_sys->i_yoff = newval.i_int;
    }
    else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
    {
        p_sys->i_timeout = newval.i_int;
    }
    p_sys->b_need_update = VLC_TRUE;
    return VLC_SUCCESS;
}