summaryrefslogtreecommitdiff
path: root/clutter-gst/clutter-gst-player.h
blob: 0f953c3136a1ac46291adacee3e88fc0fe76eb93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/*
 * Clutter-GStreamer.
 *
 * GStreamer integration library for Clutter.
 *
 * clutter-gst-player.h - Wrap some convenience functions around playbin2
 *
 * Authored By Damien Lespiau    <damien.lespiau@intel.com>
 *             Lionel Landwerlin <lionel.g.landwerlin@linux.intel.com>
 *             Matthew Allum     <mallum@openedhand.com>
 *             Emmanuele Bassi   <ebassi@linux.intel.com>
 *             Andre Moreira Magalhaes <andre.magalhaes@collabora.co.uk>
 *
 * Copyright (C) 2006 OpenedHand
 * Copyright (C) 2009-2013 Intel Corporation
 * Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#if !defined(__CLUTTER_GST_H_INSIDE__) && !defined(CLUTTER_GST_COMPILATION)
#error "Only <clutter-gst/clutter-gst.h> can be include directly."
#endif

#ifndef __CLUTTER_GST_PLAYER_H__
#define __CLUTTER_GST_PLAYER_H__

#include <glib-object.h>
#include <gst/gst.h>

#include <clutter-gst/clutter-gst-types.h>
#include <clutter-gst/clutter-gst-video-sink.h>

G_BEGIN_DECLS

#define CLUTTER_GST_TYPE_PLAYER clutter_gst_player_get_type()

#define CLUTTER_GST_PLAYER(obj)                                         \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj),                                   \
                               CLUTTER_GST_TYPE_PLAYER,                 \
                               ClutterGstPlayer))
#define CLUTTER_GST_IS_PLAYER(obj)                              \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj),                           \
                               CLUTTER_GST_TYPE_PLAYER))
#define CLUTTER_GST_PLAYER_GET_INTERFACE(obj)                           \
  (G_TYPE_INSTANCE_GET_INTERFACE ((obj),                                \
                                  CLUTTER_GST_TYPE_PLAYER,              \
                                  ClutterGstPlayerIface))

typedef struct _ClutterGstPlayer ClutterGstPlayer;
typedef struct _ClutterGstPlayerIface ClutterGstPlayerIface;
typedef struct _ClutterGstPlayerIfacePrivate ClutterGstPlayerIfacePrivate;


/**
 * ClutterGstPlayer:
 *
 * #ClutterGstPlayer is an opaque structure whose members cannot be
 * directly accessed
 *
 * Since: 1.4
 */

/**
 * ClutterGstPlayerIface:
 * @get_frame: virtual function; returns the current visible frame
 * @get_pipeline: virtual function; returns the current GStreamer pipeline
 * @get_video_sink: virtual function; returns the current ClutterGst video sink
 * @get_idle: virtual function; returns whether the player is currently in idle state
 * @get_audio_volume: virtual function; returns the current audio volume
 * @set_audio_volume: virtual function; sets the audio volume
 * @get_playing: virtual function; returns whether the player is currently playing
 * @set_playing: virtual function; starts or stops the player from playing
 * @new_frame: signal class closure for #ClutterGstPlayer::new-frame
 * @ready: signal class closure for #ClutterGstPlayer::ready
 * @eos: signal class closure for #ClutterGstPlayer::eos
 * @error: signal class closure for #ClutterGstPlayer::error
 * @size_change: signal class closure for #ClutterGstPlayer::size-change
 *
 * Interface vtable for #ClutterGstPlayer implementations
 *
 * Since: 1.4
 */
struct _ClutterGstPlayerIface
{
  /*< private >*/
  GTypeInterface base_iface;

  ClutterGstPlayerIfacePrivate *priv;

  /*< public >*/
  ClutterGstFrame     *(* get_frame)        (ClutterGstPlayer *self);
  GstElement *         (* get_pipeline)     (ClutterGstPlayer *self);
  ClutterGstVideoSink *(* get_video_sink)   (ClutterGstPlayer *self);

  gboolean             (* get_idle)         (ClutterGstPlayer *self);

  gdouble              (* get_audio_volume) (ClutterGstPlayer *self);
  void                 (* set_audio_volume) (ClutterGstPlayer *self,
                                             gdouble           volume);

  gboolean             (* get_playing)      (ClutterGstPlayer *self);
  void                 (* set_playing)      (ClutterGstPlayer *self,
                                             gboolean          playing);

  /*< private >*/
  gpointer _padding_vfuncs[16];

  /*< public >*/
  /* signals */
  void (* new_frame)           (ClutterGstPlayer *self, ClutterGstFrame *frame);
  void (* ready)               (ClutterGstPlayer *self);
  void (* eos)                 (ClutterGstPlayer *self);
  void (* error)               (ClutterGstPlayer *self,
                                const GError     *error);
  void (* size_change)         (ClutterGstPlayer *self,
                                gint              width,
                                gint              height);

  /*< private >*/
  gpointer _padding_signals[8];
};

GType clutter_gst_player_get_type (void) G_GNUC_CONST;

ClutterGstFrame *         clutter_gst_player_get_frame        (ClutterGstPlayer        *self);

GstElement *              clutter_gst_player_get_pipeline     (ClutterGstPlayer        *self);

ClutterGstVideoSink *     clutter_gst_player_get_video_sink   (ClutterGstPlayer        *self);

gboolean                  clutter_gst_player_get_idle         (ClutterGstPlayer        *self);

gboolean                  clutter_gst_player_get_playing      (ClutterGstPlayer        *self);
void                      clutter_gst_player_set_playing      (ClutterGstPlayer        *self,
                                                               gboolean                 playing);

gdouble                   clutter_gst_player_get_audio_volume (ClutterGstPlayer        *self);
void                      clutter_gst_player_set_audio_volume (ClutterGstPlayer        *self,
                                                               gdouble                  volume);

G_END_DECLS

#endif /* __CLUTTER_GST_PLAYER_H__ */