1 /* poppler-movie.h: glib interface to Movie
2  *
3  * Copyright (C) 2010 Carlos Garcia Campos <carlosgc@gnome.org>
4  * Copyright (C) 2008 Hugo Mercier <hmercier31[@]gmail.com>
5  * Copyright (C) 2017 Francesco Poli <invernomuto@paranoici.org>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
20  */
21 
22 #ifndef __POPPLER_MOVIE_H__
23 #define __POPPLER_MOVIE_H__
24 
25 #include <glib-object.h>
26 #include "poppler.h"
27 
28 G_BEGIN_DECLS
29 
30 #define POPPLER_TYPE_MOVIE (poppler_movie_get_type())
31 #define POPPLER_MOVIE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), POPPLER_TYPE_MOVIE, PopplerMovie))
32 #define POPPLER_IS_MOVIE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), POPPLER_TYPE_MOVIE))
33 
34 /**
35  * PopplerMoviePlayMode:
36  * @POPPLER_MOVIE_PLAY_MODE_ONCE: the movie should be played once and controls should be closed at the end.
37  * @POPPLER_MOVIE_PLAY_MODE_OPEN: the movie should be played once, but controls should be left open.
38  * @POPPLER_MOVIE_PLAY_MODE_REPEAT: the movie should be played in loop, until manually stopped.
39  * @POPPLER_MOVIE_PLAY_MODE_PALINDROME: the movie should be played forward and backward, forward and backward,
40  *   and so forth, until manually stopped.
41  *
42  * Play mode enum values.
43  *
44  * Since: 0.54
45  */
46 typedef enum
47 {
48     POPPLER_MOVIE_PLAY_MODE_ONCE,
49     POPPLER_MOVIE_PLAY_MODE_OPEN,
50     POPPLER_MOVIE_PLAY_MODE_REPEAT,
51     POPPLER_MOVIE_PLAY_MODE_PALINDROME
52 } PopplerMoviePlayMode;
53 
54 POPPLER_PUBLIC
55 GType poppler_movie_get_type(void) G_GNUC_CONST;
56 POPPLER_PUBLIC
57 const gchar *poppler_movie_get_filename(PopplerMovie *poppler_movie);
58 POPPLER_PUBLIC
59 gboolean poppler_movie_need_poster(PopplerMovie *poppler_movie);
60 POPPLER_PUBLIC
61 gboolean poppler_movie_show_controls(PopplerMovie *poppler_movie);
62 POPPLER_PUBLIC
63 PopplerMoviePlayMode poppler_movie_get_play_mode(PopplerMovie *poppler_movie);
64 POPPLER_PUBLIC
65 gboolean poppler_movie_is_synchronous(PopplerMovie *poppler_movie);
66 POPPLER_PUBLIC
67 gdouble poppler_movie_get_volume(PopplerMovie *poppler_movie);
68 POPPLER_PUBLIC
69 gdouble poppler_movie_get_rate(PopplerMovie *poppler_movie);
70 POPPLER_PUBLIC
71 gushort poppler_movie_get_rotation_angle(PopplerMovie *poppler_movie);
72 POPPLER_PUBLIC
73 guint64 poppler_movie_get_start(PopplerMovie *poppler_movie);
74 POPPLER_PUBLIC
75 guint64 poppler_movie_get_duration(PopplerMovie *poppler_movie);
76 POPPLER_PUBLIC
77 void poppler_movie_get_aspect(PopplerMovie *poppler_movie, gint *width, gint *height);
78 
79 G_END_DECLS
80 
81 #endif /* __POPPLER_MOVIE_H__ */
82