]> git.sesse.net Git - vlc/blobdiff - src/video_output/video_text.c
Use var_Inherit* instead of var_CreateGet*.
[vlc] / src / video_output / video_text.c
index aaed0a5b93e1bf8e527c92a7f07ee3861a941774..8bf7a716981329757bdbba3c2f24bee4ba28bffd 100644 (file)
@@ -1,10 +1,11 @@
 /*****************************************************************************
- * video_text.c : text manipulation functions
+ * video_text.c : OSD text manipulation functions
  *****************************************************************************
- * Copyright (C) 1999-2007 the VideoLAN team
+ * Copyright (C) 1999-2010 the VideoLAN team
  * $Id$
  *
  * Author: Sigmund Augdal Helberg <dnumgis@videolan.org>
+ *         Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+#include <assert.h>
+
+#include <vlc_common.h>
 #include <vlc_vout.h>
-#include <vlc_block.h>
-#include <vlc_filter.h>
-#include <vlc_osd.h>
-
-/**
- * \brief Show text on the video for some time
- * \param p_vout pointer to the vout the text is to be showed on
- * \param i_channel Subpicture channel
- * \param psz_string The text to be shown
- * \param p_style Pointer to a struct with text style info
- * \param i_flags flags for alignment and such
- * \param i_hmargin horizontal margin in pixels
- * \param i_vmargin vertical margin in pixels
- * \param i_duration Amount of time the text is to be shown.
- */
-int vout_ShowTextRelative( vout_thread_t *p_vout, int i_channel,
-                           char *psz_string, text_style_t *p_style,
-                           int i_flags, int i_hmargin, int i_vmargin,
-                           mtime_t i_duration )
+#include <vlc_vout_osd.h>
+
+struct subpicture_updater_sys_t {
+    int  position;
+    char *text;
+};
+
+static int OSDTextValidate(subpicture_t *subpic,
+                           bool has_src_changed, const video_format_t *fmt_src,
+                           bool has_dst_changed, const video_format_t *fmt_dst,
+                           mtime_t ts)
 {
-    mtime_t i_now = mdate();
+    VLC_UNUSED(subpic); VLC_UNUSED(ts); VLC_UNUSED(fmt_src);
+    VLC_UNUSED(has_dst_changed); VLC_UNUSED(fmt_dst);
 
-    return vout_ShowTextAbsolute( p_vout, i_channel, psz_string,
-                                  p_style, i_flags, i_hmargin, i_vmargin,
-                                  i_now, i_now + i_duration );
+    if( !has_src_changed && !has_dst_changed)
+        return VLC_SUCCESS;
+    return VLC_EGENERIC;
 }
 
-/**
- * \brief Show text on the video from a given start date to a given end date
- * \param p_vout pointer to the vout the text is to be showed on
- * \param i_channel Subpicture channel
- * \param psz_string The text to be shown
- * \param p_style Pointer to a struct with text style info
- * \param i_flags flags for alignment and such
- * \param i_hmargin horizontal margin in pixels
- * \param i_vmargin vertical margin in pixels
- * \param i_start the time when this string is to appear on the video
- * \param i_stop the time when this string should stop to be displayed
- *               if this is 0 the string will be shown untill the next string
- *               is about to be shown
- */
-int vout_ShowTextAbsolute( vout_thread_t *p_vout, int i_channel,
-                           const char *psz_string, text_style_t *p_style,
-                           int i_flags, int i_hmargin, int i_vmargin,
-                           mtime_t i_start, mtime_t i_stop )
+static void OSDTextUpdate(subpicture_t *subpic,
+                          const video_format_t *fmt_src,
+                          const video_format_t *fmt_dst,
+                          mtime_t ts)
 {
-    subpicture_t *p_spu;
-    video_format_t fmt;
-    (void)p_style; // FIXME: <-- why ask for this if it's unused?!?
-
-    if( !psz_string ) return VLC_EGENERIC;
-
-    p_spu = spu_CreateSubpicture( p_vout->p_spu );
-    if( !p_spu ) return VLC_EGENERIC;
-
-    /* Create a new subpicture region */
-    memset( &fmt, 0, sizeof(video_format_t) );
-    fmt.i_chroma = VLC_FOURCC('T','E','X','T');
-    fmt.i_aspect = 0;
-    fmt.i_width = fmt.i_height = 0;
-    fmt.i_x_offset = fmt.i_y_offset = 0;
-    p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_vout), &fmt );
-    if( !p_spu->p_region )
-    {
-        msg_Err( p_vout, "cannot allocate SPU region" );
-        spu_DestroySubpicture( p_vout->p_spu, p_spu );
-        return VLC_EGENERIC;
-    }
+    subpicture_updater_sys_t *sys = subpic->updater.p_sys;
+    VLC_UNUSED(fmt_dst); VLC_UNUSED(ts);
 
-    p_spu->p_region->psz_text = strdup( psz_string );
-    p_spu->i_start = i_start;
-    p_spu->i_stop = i_stop;
-    p_spu->b_ephemer = VLC_TRUE;
-    p_spu->b_absolute = VLC_FALSE;
+    subpic->i_original_picture_width  = fmt_src->i_width;
+    subpic->i_original_picture_height = fmt_src->i_height;
 
-    p_spu->i_x = i_hmargin;
-    p_spu->i_y = i_vmargin;
-    p_spu->i_flags = i_flags;
-    p_spu->i_channel = i_channel;
+    video_format_t fmt;
+    video_format_Init( &fmt, VLC_CODEC_TEXT);
+    fmt.i_sar_num = 0;
+    fmt.i_sar_den = 1;
+
+    subpicture_region_t *r = subpic->p_region = subpicture_region_New(&fmt);
+    if (!r)
+        return;
+
+    r->psz_text = strdup(sys->text);
+    r->i_align  = sys->position;
+    r->i_x      = 30 + fmt_src->i_width
+                     - fmt_src->i_visible_width
+                     - fmt_src->i_x_offset;
+    r->i_y      = 20 + fmt_src->i_y_offset;
+}
 
-    spu_DisplaySubpicture( p_vout->p_spu, p_spu );
+static void OSDTextDestroy(subpicture_t *subpic)
+{
+    subpicture_updater_sys_t *sys = subpic->updater.p_sys;
 
-    return VLC_SUCCESS;
+    free(sys->text);
+    free(sys);
 }
 
-
-/**
- * \brief Write an informative message at the default location,
- *        for the default duration and only if the OSD option is enabled.
- * \param p_caller The object that called the function.
- * \param i_channel Subpicture channel
- * \param psz_format printf style formatting
- **/
-void __vout_OSDMessage( vlc_object_t *p_caller, int i_channel,
-                        const char *psz_format, ... )
+void vout_OSDText(vout_thread_t *vout, int channel,
+                   int position, mtime_t duration, const char *text)
 {
-    vout_thread_t *p_vout;
-    char *psz_string;
-    va_list args;
-
-    if( !config_GetInt( p_caller, "osd" ) ) return;
+    assert( (position & ~SUBPICTURE_ALIGN_MASK) == 0);
+    if (!var_InheritBool(vout, "osd") || duration <= 0)
+        return;
+
+    subpicture_updater_sys_t *sys = malloc(sizeof(*sys));
+    if (!sys)
+        return;
+    sys->position = position;
+    sys->text     = strdup(text);
+
+    subpicture_updater_t updater = {
+        .pf_validate = OSDTextValidate,
+        .pf_update   = OSDTextUpdate,
+        .pf_destroy  = OSDTextDestroy,
+        .p_sys       = sys,
+    };
+    subpicture_t *subpic = subpicture_New(&updater);
+    if (!subpic) {
+        free(sys->text);
+        free(sys);
+        return;
+    }
 
-    p_vout = vlc_object_find( p_caller, VLC_OBJECT_VOUT, FIND_ANYWHERE );
-    if( p_vout )
-    {
-        va_start( args, psz_format );
-        vasprintf( &psz_string, psz_format, args );
+    subpic->i_channel  = channel;
+    subpic->i_start    = mdate();
+    subpic->i_stop     = subpic->i_start + duration;
+    subpic->b_ephemer  = true;
+    subpic->b_absolute = false;
+    subpic->b_fade     = true;
 
-        vout_ShowTextRelative( p_vout, i_channel, psz_string, NULL,
-                               OSD_ALIGN_TOP|OSD_ALIGN_RIGHT,
-                               30 + p_vout->fmt_in.i_width
-                                  - p_vout->fmt_in.i_visible_width
-                                  - p_vout->fmt_in.i_x_offset,
-                               20 + p_vout->fmt_in.i_y_offset, 1000000 );
+    vout_PutSubpicture(vout, subpic);
+}
 
-        vlc_object_release( p_vout );
-        free( psz_string );
-        va_end( args );
+void vout_OSDMessage(vout_thread_t *vout, int channel, const char *format, ...)
+{
+    va_list args;
+    va_start(args, format);
+
+    char *string;
+    if (vasprintf(&string, format, args) != -1) {
+        vout_OSDText(vout, channel,
+                     SUBPICTURE_ALIGN_TOP|SUBPICTURE_ALIGN_RIGHT, 1000000,
+                     string);
+        free(string);
     }
+    va_end(args);
 }
+