git.sesse.net Git - vlc/blob - src/video_output/video_text.c

   1 /*****************************************************************************
   2  * video_text.c : text manipulation functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 VideoLAN
   5  * $Id: video_text.c,v 1.50 2004/01/06 12:02:06 zorglub Exp $
   6  *
   7  * Author: Sigmund Augdal <sigmunau@idi.ntnu.no>
   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 #include <vlc/vout.h>
  24 #include <osd.h>
  25
  26 /**
  27  * \brief Show text on the video for some time
  28  * \param p_vout pointer to the vout the text is to be showed on
  29  * \param psz_string The text to be shown
  30  * \param p_style Pointer to a struct with text style info
  31  * \param i_flags flags for alignment and such
  32  * \param i_hmargin horizontal margin in pixels
  33  * \param i_vmargin vertical margin in pixels
  34  * \param i_duration Amount of time the text is to be shown.
  35  */
  36 subpicture_t *vout_ShowTextRelative( vout_thread_t *p_vout, char *psz_string,
  37                               text_style_t *p_style, int i_flags,
  38                               int i_hmargin, int i_vmargin,
  39                               mtime_t i_duration )
  40 {
  41     subpicture_t *p_subpic = NULL;
  42     mtime_t i_now = mdate();
  43
  44     if ( p_vout->pf_add_string )
  45     {
  46         p_subpic = p_vout->pf_add_string( p_vout, psz_string, p_style, i_flags,
  47                              i_hmargin, i_vmargin, i_now, i_now + i_duration );
  48     }
  49     else
  50     {
  51         msg_Warn( p_vout, "No text renderer found" );
  52     }
  53
  54     return p_subpic;
  55 }
  56
  57 /**
  58  * \brief Show text on the video from a given start date to a given end date
  59  * \param p_vout pointer to the vout the text is to be showed on
  60  * \param psz_string The text to be shown
  61  * \param p_style Pointer to a struct with text style info
  62  * \param i_flags flags for alignment and such
  63  * \param i_hmargin horizontal margin in pixels
  64  * \param i_vmargin vertical margin in pixels
  65  * \param i_start the time when this string is to appear on the video
  66  * \param i_stop the time when this string should stop to be displayed
  67  *               if this is 0 the string will be shown untill the next string
  68  *               is about to be shown
  69  */
  70 void vout_ShowTextAbsolute( vout_thread_t *p_vout, char *psz_string,
  71                               text_style_t *p_style, int i_flags,
  72                               int i_hmargin, int i_vmargin, mtime_t i_start,
  73                               mtime_t i_stop )
  74 {
  75     if ( p_vout->pf_add_string )
  76     {
  77         p_vout->pf_add_string( p_vout, psz_string, p_style, i_flags, i_hmargin,
  78                                i_vmargin, i_start, i_stop );
  79     }
  80     else
  81     {
  82         msg_Warn( p_vout, "No text renderer found" );
  83     }
  84 }
  85
  86
  87 /**
  88  * \brief Write an informative message at the default location,
  89  *        for the default duration and only if the OSD option is enabled.
  90  * \param p_caller The object that called the function.
  91  * \param psz_string The text to be shown
  92  **/
  93 void vout_OSDMessage( vlc_object_t *p_caller, char *psz_string )
  94 {
  95     vout_thread_t *p_vout;
  96
  97     if( !config_GetInt( p_caller, "osd" ) ) return;
  98
  99     p_vout = vlc_object_find( p_caller, VLC_OBJECT_VOUT, FIND_ANYWHERE );
 100
 101     if( p_vout )
 102     {
 103         vlc_mutex_lock( &p_vout->change_lock );
 104
 105         if( p_vout->p_last_osd_message )
 106         {
 107             vout_DestroySubPicture( p_vout, p_vout->p_last_osd_message );
 108         }
 109
 110         p_vout->p_last_osd_message = vout_ShowTextRelative( p_vout, psz_string,
 111                         NULL, OSD_ALIGN_TOP|OSD_ALIGN_RIGHT, 30,20,1000000 );
 112
 113         vlc_mutex_unlock( &p_vout->change_lock );
 114
 115         vlc_object_release( p_vout );
 116     }
 117 }
 118