Add a function to display EPG event information for the current program of an input_item_t.

Signed-off-by: Laurent Aimar <fenrir@videolan.org>

include/vlc_osd.h

@@ -635,6 +635,8 @@ VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, const te
 
 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t ) );
 
+VLC_EXPORT( int, vout_OSDEpg, ( vout_thread_t *, input_item_t * ) );
+
 /**
  * Write an informative message at the default location,
  * for the default duration and only if the OSD option is enabled.

src/Makefile.am

@@ -379,6 +379,7 @@ SOURCES_libvlc_common = \
 	video_output/vout_pictures.c \
 	video_output/vout_pictures.h \
 	video_output/video_text.c \
+	video_output/video_epg.c \
 	video_output/video_widgets.c \
 	video_output/vout_subpictures.c \
 	video_output/window.c \

src/libvlccore.sym

@@ -606,6 +606,7 @@ vout_GetSpu
 vout_LinkPicture
 vout_OSDIcon
 __vout_OSDMessage
+vout_OSDEpg
 vout_OSDSlider
 vout_PlacePicture
 __vout_Request

src/video_output/video_epg.c

+/*****************************************************************************
+ * video_epg.c : EPG manipulation functions
+ *****************************************************************************
+ * Copyright (C) 2010 Adrien Maglo
+ *
+ * Author: Adrien Maglo <magsoft@videolan.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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_vout.h>
+#include <vlc_block.h>
+#include <vlc_filter.h>
+#include <vlc_osd.h>
+#include <vlc_events.h>
+#include <vlc_input_item.h>
+#include <vlc_epg.h>
+
+
+/* Layout percentage defines */
+#define EPG_TOP 0.7
+#define EPG_LEFT 0.1
+#define EPG_NAME_SIZE 0.05
+#define EPG_PROGRAM_SIZE 0.03
+
+#define NO_EPG N_( "No EPG found for this program." )
+
+
+static subpicture_region_t * vout_OSDEpgSlider( vout_thread_t *p_vout,
+                                                int i_x, int i_y,
+                                                int i_width, int i_height,
+                                                float f_ratio )
+{
+    video_format_t fmt;
+    subpicture_region_t *p_region;
+
+    /* Create a new subpicture region */
+    video_format_Init( &fmt, VLC_CODEC_YUVA );
+    fmt.i_width = fmt.i_visible_width = i_width;
+    fmt.i_height = fmt.i_visible_height = i_height;
+
+    p_region = subpicture_region_New( &fmt );
+    if( !p_region )
+    {
+        msg_Err( p_vout, "Cannot allocate SPU region." );
+        return NULL;
+    }
+
+    p_region->i_x = i_x;
+    p_region->i_y = i_y;
+
+    picture_t *p_picture = p_region->p_picture;
+
+    f_ratio = __MIN( __MAX( f_ratio, 0 ), 1 );
+    int i_filled_part_width = f_ratio * i_width;
+
+    for( int j = 0; j < i_height; j++ )
+    {
+        for( int i = 0; i < i_width; i++ )
+        {
+            #define WRITE_COMP( plane, value ) \
+                p_picture->p[plane].p_pixels[p_picture->p[plane].i_pitch * j + i] = value
+
+            /* Draw the slider. */
+            bool is_outline = j == 0 || j == i_height - 1
+                              || i == 0 || i == i_width - 1;
+            WRITE_COMP( 0, is_outline ? 0x00 : 0xff );
+            WRITE_COMP( 1, 0x80 );
+            WRITE_COMP( 2, 0x80 );
+
+            /* We can see the video through the part of the slider
+               which corresponds to the leaving time. */
+            bool is_border = j < 3 || j > i_height - 4
+                             || i < 3 || i > i_width - 4
+                             || i < i_filled_part_width;
+            WRITE_COMP( 3, is_border ? 0xff : 0x00 );
+
+            #undef WRITE_COMP
+        }
+    }
+
+    return p_region;
+}
+
+
+static subpicture_region_t * vout_OSDEpgText( vout_thread_t *p_vout,
+                                              const char *psz_string,
+                                              int i_x, int i_y,
+                                              int i_size, uint32_t i_color )
+{
+    video_format_t fmt;
+    subpicture_region_t *p_region;
+
+    if( !psz_string )
+        return NULL;
+
+    /* Create a new subpicture region */
+    video_format_Init( &fmt, VLC_CODEC_TEXT );
+
+    p_region = subpicture_region_New( &fmt );
+    if( !p_region )
+    {
+        msg_Err( p_vout, "Cannot allocate SPU region." );
+        return NULL;
+    }
+
+    /* Set subpicture parameters */
+    p_region->psz_text = strdup( psz_string );
+    p_region->i_align = 0;
+    p_region->i_x = i_x;
+    p_region->i_y = i_y;
+
+    /* Set text style */
+    p_region->p_style = text_style_New();
+    if( p_region->p_style )
+    {
+        p_region->p_style->i_font_size = i_size;
+        p_region->p_style->i_font_color = i_color;
+        p_region->p_style->i_font_alpha = 0;
+    }
+
+    return p_region;
+}
+
+
+static subpicture_region_t * vout_BuildOSDEpg( vout_thread_t *p_vout,
+                                               vlc_epg_t *p_epg,
+                                               int i_visible_width,
+                                               int i_visible_height )
+{
+    subpicture_region_t *p_region_ret;
+    subpicture_region_t **pp_region = &p_region_ret;
+
+    time_t i_test = time( NULL );
+
+    /* Display the name of the channel. */
+    *pp_region = vout_OSDEpgText( p_vout,
+                                  p_epg->psz_name,
+                                  i_visible_width * EPG_LEFT,
+                                  i_visible_height * EPG_TOP,
+                                  i_visible_height * EPG_NAME_SIZE,
+                                  0x00ffffff );
+
+    if( !*pp_region )
+        return p_region_ret;
+
+    /* Display the name of the current program. */
+    pp_region = &(* pp_region)->p_next;
+    *pp_region = vout_OSDEpgText( p_vout, p_epg->p_current->psz_name,
+                                  i_visible_width * ( EPG_LEFT + 0.025 ),
+                                  i_visible_height * ( EPG_TOP + 0.05 ),
+                                  i_visible_height * EPG_PROGRAM_SIZE,
+                                  0x00ffffff );
+
+    if( !*pp_region )
+        return p_region_ret;
+
+    /* Display the current program time slider. */
+    pp_region = &(* pp_region)->p_next;
+    *pp_region = vout_OSDEpgSlider( p_vout,
+                                    i_visible_width * EPG_LEFT,
+                                    i_visible_height * ( EPG_TOP + 0.1 ),
+                                    i_visible_width * ( 1 - 2 * EPG_LEFT ),
+                                    i_visible_height * 0.05,
+                                    ( i_test - p_epg->p_current->i_start )
+                                    / (float)p_epg->p_current->i_duration );
+
+    if( !*pp_region )
+        return p_region_ret;
+
+    /* Format the hours of the beginning and the end of the current program. */
+    struct tm tm_start, tm_end;
+    time_t t_start = p_epg->p_current->i_start;
+    time_t t_end = p_epg->p_current->i_start + p_epg->p_current->i_duration;
+    localtime_r( &t_start, &tm_start );
+    localtime_r( &t_end, &tm_end );
+    char psz_start[128];
+    char psz_end[128];
+    snprintf( psz_start, sizeof(psz_start), "%2.2d:%2.2d",
+              tm_start.tm_hour, tm_start.tm_min );
+    snprintf( psz_end, sizeof(psz_end), "%2.2d:%2.2d",
+              tm_end.tm_hour, tm_end.tm_min );
+
+    /* Display those hours. */
+    pp_region = &(* pp_region)->p_next;
+    *pp_region = vout_OSDEpgText( p_vout, psz_start,
+                                  i_visible_width * ( EPG_LEFT + 0.02 ),
+                                  i_visible_height * ( EPG_TOP + 0.15 ),
+                                  i_visible_height * EPG_PROGRAM_SIZE,
+                                  0x00ffffff );
+
+    if( !*pp_region )
+        return p_region_ret;
+
+    pp_region = &(* pp_region)->p_next;
+    *pp_region = vout_OSDEpgText( p_vout, psz_end,
+                                  i_visible_width * ( 1 - EPG_LEFT - 0.085 ),
+                                  i_visible_height * ( EPG_TOP + 0.15 ),
+                                  i_visible_height * EPG_PROGRAM_SIZE,
+                                  0x00ffffff );
+
+    return p_region_ret;
+}
+
+
+/**
+ * \brief Show EPG information about the current program of an input item
+ * \param p_vout pointer to the vout the information is to be showed on
+ * \param p_input pointer to the input item the information is to be showed
+ */
+int vout_OSDEpg( vout_thread_t *p_vout, input_item_t *p_input )
+{
+    subpicture_t *p_spu;
+    mtime_t i_now = mdate();
+
+    int i_visible_width = p_vout->fmt_in.i_width;
+    int i_visible_height = p_vout->fmt_in.i_height;
+
+    if( !p_input )
+        return VLC_EGENERIC;
+
+    p_spu = subpicture_New();
+    if( !p_spu )
+        return VLC_EGENERIC;
+
+    p_spu->i_channel = DEFAULT_CHAN;
+    p_spu->i_start = i_now;
+    p_spu->i_stop = i_now + 10000 * INT64_C(1000);
+    p_spu->b_ephemer = true;
+    p_spu->b_absolute = true;
+    p_spu->b_fade = false;
+
+    char *psz_now_playing = input_item_GetNowPlaying( p_input );
+    vlc_epg_t *p_epg = NULL;
+
+    vlc_mutex_lock( &p_input->lock );
+
+    /* Look for the current program EPG event */
+    for( int i = 0; i < p_input->i_epg; i++ )
+    {
+        vlc_epg_t *p_tmp = p_input->pp_epg[i];
+
+        if( p_tmp->p_current && p_tmp->p_current->psz_name
+            && psz_now_playing != NULL
+            && !strcmp( p_tmp->p_current->psz_name, psz_now_playing ) )
+        {
+            p_epg = vlc_epg_New( p_tmp->psz_name );
+            vlc_epg_Merge( p_epg, p_tmp );
+            break;
+        }
+    }
+
+    vlc_mutex_unlock( &p_input->lock );
+
+    if( p_epg != NULL )
+    {
+        /* Build the EPG event subpictures. */
+        p_spu->p_region = vout_BuildOSDEpg( p_vout, p_epg,
+                                            i_visible_width,
+                                            i_visible_height );
+        vlc_epg_Delete( p_epg );
+    }
+    else
+    {
+        /* If no EPG event has been found, then display a warning message. */
+        p_spu->p_region = vout_OSDEpgText( p_vout, NO_EPG,
+                                           i_visible_width * EPG_LEFT,
+                                           i_visible_height * EPG_TOP,
+                                           i_visible_height * EPG_NAME_SIZE,
+                                           0x00ffffff );
+    }
+
+    spu_DisplaySubpicture( p_vout->p_spu, p_spu );
+
+    return VLC_SUCCESS;
+}