modules/notify/xosd.c

   1 /*****************************************************************************
   2  * xosd.c : X On Screen Display interface
   3  *****************************************************************************
   4  * Copyright (C) 2001 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Loïc Minier <lool@videolan.org>
   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 implied 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
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_playlist.h>
  35 #include <vlc_input.h>
  36 #include <vlc_interface.h>
  37
  38 #include <xosd.h>
  39
  40 /*****************************************************************************
  41  * intf_sys_t: description and status of rc interface
  42  *****************************************************************************/
  43 struct intf_sys_t
  44 {
  45     xosd *      p_osd;          /* libxosd handle */
  46     bool        b_need_update;  /* Update display ? */
  47     vlc_mutex_t lock;           /* lock for the condition variable */
  48     vlc_cond_t  cond;           /* condition variable to know when to update */
  49 };
  50
  51 #define MAX_LINE_LENGTH 256
  52
  53 /*****************************************************************************
  54  * Local prototypes.
  55  *****************************************************************************/
  56 static int  Open        ( vlc_object_t * );
  57 static void Close       ( vlc_object_t * );
  58
  59 static void Run         ( intf_thread_t * );
  60
  61 static int PlaylistNext ( vlc_object_t *p_this, const char *psz_variable,
  62                           vlc_value_t oval, vlc_value_t nval, void *param );
  63
  64 /*****************************************************************************
  65  * Module descriptor
  66  *****************************************************************************/
  67 #define POSITION_TEXT N_("Flip vertical position")
  68 #define POSITION_LONGTEXT N_("Display XOSD output at the bottom of the " \
  69                              "screen instead of the top.")
  70
  71 #define TXT_OFS_TEXT N_("Vertical offset")
  72 #define TXT_OFS_LONGTEXT N_("Vertical offset between the border of the screen "\
  73                             "and the displayed text (in pixels, defaults to "\
  74                             "30 pixels)." )
  75
  76 #define SHD_OFS_TEXT N_("Shadow offset")
  77 #define SHD_OFS_LONGTEXT N_("Offset between the text and the shadow (in " \
  78                             "pixels, defaults to 2 pixels)." )
  79
  80 #define FONT_TEXT N_("Font")
  81 #define FONT_LONGTEXT N_("Font used to display text in the XOSD output.")
  82 #define COLOUR_TEXT N_("Color")
  83 #define COLOUR_LONGTEXT N_("Color used to display text in the XOSD output.")
  84
  85 vlc_module_begin ()
  86     set_category( CAT_INTERFACE )
  87     set_subcategory( SUBCAT_INTERFACE_CONTROL )
  88     set_description( N_("XOSD interface") )
  89     set_shortname( "XOSD" )
  90     add_bool( "xosd-position", true, POSITION_TEXT, POSITION_LONGTEXT, true )
  91     add_integer( "xosd-text-offset", 30, TXT_OFS_TEXT, TXT_OFS_LONGTEXT, true )
  92     add_integer( "xosd-shadow-offset", 2,
  93                  SHD_OFS_TEXT, SHD_OFS_LONGTEXT, true )
  94     add_string( "xosd-font", "-adobe-helvetica-bold-r-normal-*-*-160-*-*-p-*-iso8859-1",
  95                 FONT_TEXT, FONT_LONGTEXT, true )
  96     add_string( "xosd-colour", "LawnGreen",
  97                 COLOUR_TEXT, COLOUR_LONGTEXT, true )
  98     set_capability( "interface", 10 )
  99     set_callbacks( Open, Close )
 100 vlc_module_end ()
 101
 102 /*****************************************************************************
 103  * Open: initialize and create stuff
 104  *****************************************************************************/
 105 static int Open( vlc_object_t *p_this )
 106 {
 107     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 108     intf_sys_t *p_sys;
 109     xosd *p_osd;
 110     char *psz_font, *psz_colour;
 111
 112     if( getenv( "DISPLAY" ) == NULL )
 113     {
 114         msg_Err( p_intf, "no display, please set the DISPLAY variable" );
 115         return VLC_EGENERIC;
 116     }
 117
 118     /* Allocate instance and initialize some members */
 119     p_sys = p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
 120     if( p_sys == NULL )
 121         return VLC_ENOMEM;
 122
 123     /* Initialize library */
 124     psz_font = var_InheritString( p_intf, "xosd-font" );
 125     psz_colour = var_InheritString( p_intf, "xosd-colour" );
 126
 127     p_osd = xosd_create( 1 );
 128     if( p_osd == NULL )
 129     {
 130         msg_Err( p_intf, "couldn't initialize libxosd" );
 131         free( psz_colour );
 132         free( psz_font );
 133         free( p_sys );
 134         return VLC_EGENERIC;
 135     }
 136     p_sys->p_osd = p_osd;
 137
 138     /* Set user preferences */
 139     xosd_set_outline_colour( p_osd, "black" );
 140     xosd_set_font( p_osd, psz_font );
 141     xosd_set_colour( p_osd, psz_colour );
 142     xosd_set_timeout( p_osd, 3 );
 143     xosd_set_pos( p_osd, var_InheritBool( p_intf, "xosd-position" ) ?
 144                                         XOSD_bottom: XOSD_top );
 145     xosd_set_horizontal_offset( p_osd,
 146                     var_InheritInteger( p_intf, "xosd-text-offset" ) );
 147     xosd_set_vertical_offset( p_osd,
 148                     var_InheritInteger( p_intf, "xosd-text-offset" ) );
 149     xosd_set_shadow_offset( p_osd,
 150                     var_InheritInteger( p_intf, "xosd-shadow-offset" ));
 151
 152     /* Initialize to NULL */
 153     xosd_display( p_osd, 0, XOSD_string, "XOSD interface initialized" );
 154
 155     free( psz_colour );
 156     free( psz_font );
 157
 158     // Initialize mutex and condition variable before adding the callbacks
 159     vlc_mutex_init( &p_sys->lock );
 160     vlc_cond_init( &p_sys->cond );
 161     // Add the callbacks
 162     playlist_t *p_playlist = pl_Get( p_intf );
 163     var_AddCallback( p_playlist, "item-current", PlaylistNext, p_this );
 164     var_AddCallback( p_playlist, "item-change", PlaylistNext, p_this );
 165
 166     p_sys->b_need_update = true;
 167     p_intf->pf_run = Run;
 168     return VLC_SUCCESS;
 169 }
 170
 171 /*****************************************************************************
 172  * Close: destroy interface stuff
 173  *****************************************************************************/
 174 static void Close( vlc_object_t *p_this )
 175 {
 176     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 177
 178     playlist_t *p_playlist = pl_Get( p_intf );
 179     var_DelCallback( p_playlist, "item-current", PlaylistNext, p_this );
 180     var_DelCallback( p_playlist, "item-change", PlaylistNext, p_this );
 181
 182     /* Uninitialize library */
 183     xosd_destroy( p_intf->p_sys->p_osd );
 184
 185     /* Destroy structure */
 186     vlc_cond_destroy( &p_intf->p_sys->cond );
 187     vlc_mutex_destroy( &p_intf->p_sys->lock );
 188     free( p_intf->p_sys );
 189 }
 190
 191 /*****************************************************************************
 192  * Run: xosd thread
 193  *****************************************************************************
 194  * This part of the interface runs in a separate thread
 195  *****************************************************************************/
 196 static void Run( intf_thread_t *p_intf )
 197 {
 198     playlist_t *p_playlist;
 199     playlist_item_t *p_item = NULL;
 200     char *psz_display = NULL;
 201     int cancel = vlc_savecancel();
 202
 203     while( true )
 204     {
 205         // Wait for a signal
 206         vlc_restorecancel( cancel );
 207         vlc_mutex_lock( &p_intf->p_sys->lock );
 208         mutex_cleanup_push( &p_intf->p_sys->lock );
 209         while( !p_intf->p_sys->b_need_update )
 210             vlc_cond_wait( &p_intf->p_sys->cond, &p_intf->p_sys->lock );
 211         p_intf->p_sys->b_need_update = false;
 212         vlc_cleanup_run();
 213
 214         // Compute the signal
 215         cancel = vlc_savecancel();
 216         p_playlist = pl_Get( p_intf );
 217         PL_LOCK;
 218
 219         // If the playlist is empty don't do anything
 220         if( playlist_IsEmpty( p_playlist ) )
 221         {
 222             PL_UNLOCK;
 223             continue;
 224         }
 225
 226         free( psz_display );
 227         int i_status = playlist_Status( p_playlist );
 228         if( i_status == PLAYLIST_STOPPED )
 229         {
 230             psz_display = strdup(_("Stop"));
 231         }
 232         else if( i_status == PLAYLIST_PAUSED )
 233         {
 234             psz_display = strdup(_("Pause"));
 235         }
 236         else
 237         {
 238             p_item = playlist_CurrentPlayingItem( p_playlist );
 239             if( !p_item )
 240             {
 241                 psz_display = NULL;
 242                 PL_UNLOCK;
 243                 continue;
 244             }
 245             input_item_t *p_input = p_item->p_input;
 246
 247             mtime_t i_duration = input_item_GetDuration( p_input );
 248             if( i_duration != -1 )
 249             {
 250                 char psz_durationstr[MSTRTIME_MAX_SIZE];
 251                 secstotimestr( psz_durationstr, i_duration / 1000000 );
 252                 if( asprintf( &psz_display, "%s (%s)", p_input->psz_name, psz_durationstr ) == -1 )
 253                     psz_display = NULL;
 254             }
 255             else
 256                 psz_display = strdup( p_input->psz_name );
 257         }
 258         PL_UNLOCK;
 259
 260         /* Display */
 261         xosd_display( p_intf->p_sys->p_osd, 0, /* first line */
 262                       XOSD_string, psz_display );
 263     }
 264 }
 265
 266 static int PlaylistNext( vlc_object_t *p_this, const char *psz_variable,
 267                 vlc_value_t oval, vlc_value_t nval, void *param )
 268 {
 269     (void)p_this;    (void)psz_variable;    (void)oval;    (void)nval;
 270     intf_thread_t *p_intf = (intf_thread_t *)param;
 271
 272     // Send the signal using the condition variable
 273     vlc_mutex_lock( &p_intf->p_sys->lock );
 274     p_intf->p_sys->b_need_update = true;
 275     vlc_cond_signal( &p_intf->p_sys->cond );
 276     vlc_mutex_unlock( &p_intf->p_sys->lock );
 277
 278     return VLC_SUCCESS;
 279 }
 280