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