Avoid using vlc_object_find() when not needed
[vlc.git] / src / video_output / video_text.c
1 /*****************************************************************************
2  * video_text.c : text manipulation functions
3  *****************************************************************************
4  * Copyright (C) 1999-2007 the VideoLAN team
5  * $Id$
6  *
7  * Author: Sigmund Augdal Helberg <dnumgis@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 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <vlc/vlc.h>
29 #include <vlc_vout.h>
30 #include <vlc_block.h>
31 #include <vlc_filter.h>
32 #include <vlc_osd.h>
33
34 /**
35  * \brief Show text on the video for some time
36  * \param p_vout pointer to the vout the text is to be showed on
37  * \param i_channel Subpicture channel
38  * \param psz_string The text to be shown
39  * \param p_style Pointer to a struct with text style info
40  * \param i_flags flags for alignment and such
41  * \param i_hmargin horizontal margin in pixels
42  * \param i_vmargin vertical margin in pixels
43  * \param i_duration Amount of time the text is to be shown.
44  */
45 int vout_ShowTextRelative( vout_thread_t *p_vout, int i_channel,
46                            char *psz_string, text_style_t *p_style,
47                            int i_flags, int i_hmargin, int i_vmargin,
48                            mtime_t i_duration )
49 {
50     mtime_t i_now = mdate();
51
52     return vout_ShowTextAbsolute( p_vout, i_channel, psz_string,
53                                   p_style, i_flags, i_hmargin, i_vmargin,
54                                   i_now, i_now + i_duration );
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 i_channel Subpicture channel
61  * \param psz_string The text to be shown
62  * \param p_style Pointer to a struct with text style info
63  * \param i_flags flags for alignment and such
64  * \param i_hmargin horizontal margin in pixels
65  * \param i_vmargin vertical margin in pixels
66  * \param i_start the time when this string is to appear on the video
67  * \param i_stop the time when this string should stop to be displayed
68  *               if this is 0 the string will be shown untill the next string
69  *               is about to be shown
70  */
71 int vout_ShowTextAbsolute( vout_thread_t *p_vout, int i_channel,
72                            const char *psz_string, text_style_t *p_style,
73                            int i_flags, int i_hmargin, int i_vmargin,
74                            mtime_t i_start, mtime_t i_stop )
75 {
76     subpicture_t *p_spu;
77     video_format_t fmt;
78     /* (void)p_style; FIXME: <-- why ask for this if it's unused?!? */
79
80     if( !psz_string ) return VLC_EGENERIC;
81
82     p_spu = spu_CreateSubpicture( p_vout->p_spu );
83     if( !p_spu ) return VLC_EGENERIC;
84
85     /* Create a new subpicture region */
86     memset( &fmt, 0, sizeof(video_format_t) );
87     fmt.i_chroma = VLC_FOURCC('T','E','X','T');
88     fmt.i_aspect = 0;
89     fmt.i_width = fmt.i_height = 0;
90     fmt.i_x_offset = fmt.i_y_offset = 0;
91     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_vout), &fmt );
92     if( !p_spu->p_region )
93     {
94         msg_Err( p_vout, "cannot allocate SPU region" );
95         spu_DestroySubpicture( p_vout->p_spu, p_spu );
96         return VLC_EGENERIC;
97     }
98
99     p_spu->p_region->psz_text = strdup( psz_string );
100     p_spu->p_region->i_align = i_flags & SUBPICTURE_ALIGN_MASK;
101     p_spu->i_start = i_start;
102     p_spu->i_stop = i_stop;
103     p_spu->b_ephemer = true;
104     p_spu->b_absolute = false;
105     p_spu->b_fade = true;
106
107     p_spu->i_x = i_hmargin;
108     p_spu->i_y = i_vmargin;
109     p_spu->i_flags = i_flags & ~SUBPICTURE_ALIGN_MASK;
110     p_spu->i_channel = i_channel;
111
112     spu_DisplaySubpicture( p_vout->p_spu, p_spu );
113
114     return VLC_SUCCESS;
115 }
116
117
118 /**
119  * \brief Write an informative message at the default location,
120  *        for the default duration and only if the OSD option is enabled.
121  * \param p_caller The object that called the function.
122  * \param i_channel Subpicture channel
123  * \param psz_format printf style formatting
124  **/
125 void __vout_OSDMessage( vlc_object_t *p_caller, int i_channel,
126                         const char *psz_format, ... )
127 {
128     vout_thread_t *p_vout;
129     char *psz_string;
130     va_list args;
131
132     if( !config_GetInt( p_caller, "osd" ) ) return;
133
134     if( p_caller->i_object_type == VLC_OBJECT_VOUT )
135     {
136         p_vout = (vout_thread_t*) p_caller;
137         vlc_object_yield( p_vout );
138     }
139     else
140         p_vout = vlc_object_find( p_caller, VLC_OBJECT_VOUT, FIND_ANYWHERE );
141
142     if( p_vout )
143     {
144         va_start( args, psz_format );
145         vasprintf( &psz_string, psz_format, args );
146
147         vout_ShowTextRelative( p_vout, i_channel, psz_string, NULL,
148                                OSD_ALIGN_TOP|OSD_ALIGN_RIGHT,
149                                30 + p_vout->fmt_in.i_width
150                                   - p_vout->fmt_in.i_visible_width
151                                   - p_vout->fmt_in.i_x_offset,
152                                20 + p_vout->fmt_in.i_y_offset, 1000000 );
153
154         vlc_object_release( p_vout );
155         free( psz_string );
156         va_end( args );
157     }
158 }