git.sesse.net Git - vlc/blob - modules/visualization/xosd/xosd.c

   1 /*****************************************************************************
   2  * xosd.c : X On Screen Display interface
   3  *****************************************************************************
   4  * Copyright (C) 2001 VideoLAN
   5  * $Id: xosd.c,v 1.1 2002/08/04 17:23:44 sam Exp $
   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     input_thread_t * p_input;   /* associated input thread */
  44     xosd * p_osd;               /* libxosd handle */
  45     char * psz_source;          /* current file || NULL */
  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 /*****************************************************************************
  59  * Module descriptor
  60  *****************************************************************************/
  61 #define POSITION_TEXT N_("flip vertical position")
  62 #define POSITION_LONGTEXT N_("Display xosd output on the bottom of the " \
  63                              "screen instead of the top")
  64
  65 #define TXT_OFS_TEXT N_("vertical offset")
  66 #define TXT_OFS_LONGTEXT N_("Vertical offset in pixels of the displayed text")
  67
  68 #define SHD_OFS_TEXT N_("shadow offset")
  69 #define SHD_OFS_LONGTEXT N_("Offset in pixels of the shadow")
  70
  71 #define FONT_TEXT N_("font")
  72 #define FONT_LONGTEXT N_("Font used to display text in the xosd output")
  73
  74 vlc_module_begin();
  75     add_category_hint( N_("Miscellaneous"), NULL );
  76     add_bool( "xosd-position", 1, NULL, POSITION_TEXT, POSITION_LONGTEXT );
  77     add_integer( "xosd-text-offset", 0, NULL, TXT_OFS_TEXT, TXT_OFS_LONGTEXT );
  78     add_integer( "xosd-shadow-offset", 1, NULL,
  79                  SHD_OFS_TEXT, SHD_OFS_LONGTEXT );
  80     add_string( "xosd-font", "-misc-fixed-medium-r-*-*-*-300-*-*-*-*-*-*",
  81                 NULL, FONT_TEXT, FONT_LONGTEXT );
  82     set_description( _("xosd interface module") );
  83     set_capability( "interface", 40 );
  84     set_callbacks( Open, Close );
  85 vlc_module_end();
  86
  87 /*****************************************************************************
  88  * Open: initialize and create stuff
  89  *****************************************************************************/
  90 static int Open( vlc_object_t *p_this )
  91 {
  92     intf_thread_t *p_intf = (intf_thread_t *)p_this;
  93
  94     /* Allocate instance and initialize some members */
  95     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
  96     if( p_intf->p_sys == NULL )
  97     {
  98         msg_Err( p_intf, "out of memory" );
  99         return( 1 );
 100     }
 101
 102     /* Initialize library */
 103     p_intf->p_sys->p_osd =
 104         xosd_init( "fixed", "LawnGreen", 3, XOSD_top, 0, 1 );
 105
 106     /* Initialize to NULL */
 107     p_intf->p_sys->psz_source = NULL;
 108
 109     xosd_display( p_intf->p_sys->p_osd,
 110                   0,
 111                   XOSD_string,
 112                   "xosd interface initialized" );
 113
 114     p_intf->pf_run = Run;
 115
 116     return( 0 );
 117 }
 118
 119 /*****************************************************************************
 120  * Close: destroy interface stuff
 121  *****************************************************************************/
 122 static void Close( vlc_object_t *p_this )
 123 {
 124     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 125
 126     if( p_intf->p_sys->psz_source ) free( p_intf->p_sys->psz_source );
 127
 128     /* Uninitialize library */
 129     xosd_uninit( p_intf->p_sys->p_osd );
 130
 131     /* Destroy structure */
 132     free( p_intf->p_sys );
 133 }
 134
 135 /*****************************************************************************
 136  * Run: xosd thread
 137  *****************************************************************************
 138  * This part of the interface runs in a separate thread
 139  *****************************************************************************/
 140 static void Run( intf_thread_t *p_intf )
 141 {
 142     p_intf->p_sys->p_input = NULL;
 143
 144     while( !p_intf->b_die )
 145     {
 146         /* Manage the input part */
 147         if( p_intf->p_sys->p_input == NULL )
 148         {
 149             p_intf->p_sys->p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
 150                                                               FIND_ANYWHERE );
 151         }
 152         else if( p_intf->p_sys->p_input->b_dead )
 153         {
 154             vlc_object_release( p_intf->p_sys->p_input );
 155             p_intf->p_sys->p_input = NULL;
 156         }
 157         else /* We have a valid input */
 158         {
 159             /* Did source change? */
 160             if ( (p_intf->p_sys->psz_source == NULL)
 161                  || (strcmp( p_intf->p_sys->psz_source,
 162                              p_intf->p_sys->p_input->psz_source ) != 0)
 163                )
 164             {
 165                 if( p_intf->p_sys->psz_source )
 166                     free( p_intf->p_sys->psz_source );
 167
 168                 p_intf->p_sys->psz_source =
 169                     strdup( p_intf->p_sys->p_input->psz_source );
 170
 171                 /* Set user preferences */
 172                 xosd_set_font( p_intf->p_sys->p_osd,
 173                                config_GetPsz( p_intf, "xosd-font" ) );
 174                 xosd_set_offset( p_intf->p_sys->p_osd,
 175                     config_GetInt( p_intf, "xosd-text-offset" ) );
 176                 xosd_set_shadow_offset( p_intf->p_sys->p_osd,
 177                     config_GetInt( p_intf, "xosd-shadow-offset" ));
 178                 xosd_set_pos( p_intf->p_sys->p_osd,
 179                     config_GetInt( p_intf, "xosd-position" ) ? XOSD_bottom
 180                                                              : XOSD_top );
 181
 182                 /* Display */
 183                 xosd_display( p_intf->p_sys->p_osd,
 184                               0,                               /* first line */
 185                               XOSD_string,
 186                               p_intf->p_sys->psz_source );
 187             }
 188         }
 189
 190         msleep( INTF_IDLE_SLEEP );
 191     }
 192
 193     if( p_intf->p_sys->p_input )
 194     {
 195         vlc_object_release( p_intf->p_sys->p_input );
 196         p_intf->p_sys->p_input = NULL;
 197     }
 198
 199 }
 200