Change the gmp download URL to https://gmplib.org/download
[vlc/gmpfix.git] / include / vlc_epg.h
blobc0fd0f559ac3bb7ed6201889dcda998ebff3a413
1 /*****************************************************************************
2 * vlc_epg.h: Electronic Program Guide
3 *****************************************************************************
4 * Copyright (C) 2007 VLC authors and VideoLAN
5 * $Id$
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #ifndef VLC_EPG_H
25 #define VLC_EPG_H 1
27 /**
28 * \file
29 * This file defines functions and structures for storing dvb epg information
32 typedef struct
34 int64_t i_start; /* Interpreted as a value return by time() */
35 int i_duration; /* Duration of the event in second */
37 char *psz_name;
38 char *psz_short_description;
39 char *psz_description;
41 uint8_t i_rating; /* Parental control, set to 0 when undefined */
42 } vlc_epg_event_t;
44 typedef struct
46 char *psz_name;
47 vlc_epg_event_t *p_current; /* Can be null or should be the same than one of pp_event entry */
49 int i_event;
50 vlc_epg_event_t **pp_event;
51 } vlc_epg_t;
53 /**
54 * It initializes a vlc_epg_t.
56 * You must call vlc_epg_Clean to release the associated resource.
58 VLC_API void vlc_epg_Init(vlc_epg_t *p_epg, const char *psz_name);
60 /**
61 * It releases all resources associated to a vlc_epg_t
63 VLC_API void vlc_epg_Clean(vlc_epg_t *p_epg);
65 /**
66 * It creates and appends a new vlc_epg_event_t to a vlc_epg_t.
68 * \see vlc_epg_t for the definitions of the parameters.
70 VLC_API void vlc_epg_AddEvent(vlc_epg_t *p_epg, int64_t i_start, int i_duration, const char *psz_name, const char *psz_short_description, const char *psz_description, uint8_t i_rating );
72 /**
73 * It creates a new vlc_epg_t*
75 * You must call vlc_epg_Delete to release the associated resource.
77 VLC_API vlc_epg_t * vlc_epg_New(const char *psz_name) VLC_USED;
79 /**
80 * It releases a vlc_epg_t*.
82 VLC_API void vlc_epg_Delete(vlc_epg_t *p_epg);
84 /**
85 * It set the current event of a vlc_epg_t given a start time
87 VLC_API void vlc_epg_SetCurrent(vlc_epg_t *p_epg, int64_t i_start);
89 /**
90 * It merges all the event of \p p_src and \p p_dst into \p p_dst.
92 * \p p_src is not modified.
94 VLC_API void vlc_epg_Merge(vlc_epg_t *p_dst, const vlc_epg_t *p_src);
96 #endif