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