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