summaryrefslogtreecommitdiff
path: root/tools/element-templates/basesink
blob: 35a2cf09695662fa47ca96d5a96e132966a08e14 (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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/* vim: set filetype=c: */
% ClassName
GstBaseSink
% TYPE_CLASS_NAME
GST_TYPE_BASE_SINK
% pads
sinkpad-simple
% pkg-config
gstreamer-base-1.0
% includes
#include <gst/base/gstbasesink.h>
% prototypes
static GstCaps *gst_replace_get_caps (GstBaseSink * sink, GstCaps * filter);
static gboolean gst_replace_set_caps (GstBaseSink * sink, GstCaps * caps);
static GstCaps *gst_replace_fixate (GstBaseSink * sink, GstCaps * caps);
static gboolean gst_replace_activate_pull (GstBaseSink * sink, gboolean active);
static void gst_replace_get_times (GstBaseSink * sink, GstBuffer * buffer,
    GstClockTime * start, GstClockTime * end);
static gboolean gst_replace_propose_allocation (GstBaseSink * sink,
    GstQuery * query);
static gboolean gst_replace_start (GstBaseSink * sink);
static gboolean gst_replace_stop (GstBaseSink * sink);
static gboolean gst_replace_unlock (GstBaseSink * sink);
static gboolean gst_replace_unlock_stop (GstBaseSink * sink);
static gboolean gst_replace_query (GstBaseSink * sink, GstQuery * query);
static gboolean gst_replace_event (GstBaseSink * sink, GstEvent * event);
static GstFlowReturn gst_replace_wait_event (GstBaseSink * sink,
    GstEvent * event);
static GstFlowReturn gst_replace_prepare (GstBaseSink * sink,
    GstBuffer * buffer);
static GstFlowReturn gst_replace_prepare_list (GstBaseSink * sink,
    GstBufferList * buffer_list);
static GstFlowReturn gst_replace_preroll (GstBaseSink * sink,
    GstBuffer * buffer);
static GstFlowReturn gst_replace_render (GstBaseSink * sink,
    GstBuffer * buffer);
static GstFlowReturn gst_replace_render_list (GstBaseSink * sink,
    GstBufferList * buffer_list);
% declare-class
  GstBaseSinkClass *base_sink_class = GST_BASE_SINK_CLASS (klass);
% set-methods
  base_sink_class->get_caps = GST_DEBUG_FUNCPTR (gst_replace_get_caps);
  base_sink_class->set_caps = GST_DEBUG_FUNCPTR (gst_replace_set_caps);
  base_sink_class->fixate = GST_DEBUG_FUNCPTR (gst_replace_fixate);
  base_sink_class->activate_pull = GST_DEBUG_FUNCPTR (gst_replace_activate_pull);
  base_sink_class->get_times = GST_DEBUG_FUNCPTR (gst_replace_get_times);
  base_sink_class->propose_allocation = GST_DEBUG_FUNCPTR (gst_replace_propose_allocation);
  base_sink_class->start = GST_DEBUG_FUNCPTR (gst_replace_start);
  base_sink_class->stop = GST_DEBUG_FUNCPTR (gst_replace_stop);
  base_sink_class->unlock = GST_DEBUG_FUNCPTR (gst_replace_unlock);
  base_sink_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_replace_unlock_stop);
  base_sink_class->query = GST_DEBUG_FUNCPTR (gst_replace_query);
  base_sink_class->event = GST_DEBUG_FUNCPTR (gst_replace_event);
  base_sink_class->wait_event = GST_DEBUG_FUNCPTR (gst_replace_wait_event);
  base_sink_class->prepare = GST_DEBUG_FUNCPTR (gst_replace_prepare);
  base_sink_class->prepare_list = GST_DEBUG_FUNCPTR (gst_replace_prepare_list);
  base_sink_class->preroll = GST_DEBUG_FUNCPTR (gst_replace_preroll);
  base_sink_class->render = GST_DEBUG_FUNCPTR (gst_replace_render);
  base_sink_class->render_list = GST_DEBUG_FUNCPTR (gst_replace_render_list);
% methods
static GstCaps *
gst_replace_get_caps (GstBaseSink * sink, GstCaps * filter)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "get_caps");

  return NULL;
}

/* notify subclass of new caps */
static gboolean
gst_replace_set_caps (GstBaseSink * sink, GstCaps * caps)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "set_caps");

  return TRUE;
}

/* fixate sink caps during pull-mode negotiation */
static GstCaps *
gst_replace_fixate (GstBaseSink * sink, GstCaps * caps)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "fixate");

  return NULL;
}

/* start or stop a pulling thread */
static gboolean
gst_replace_activate_pull (GstBaseSink * sink, gboolean active)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "activate_pull");

  return TRUE;
}

/* get the start and end times for syncing on this buffer */
static void
gst_replace_get_times (GstBaseSink * sink, GstBuffer * buffer,
    GstClockTime * start, GstClockTime * end)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "get_times");

}

/* propose allocation parameters for upstream */
static gboolean
gst_replace_propose_allocation (GstBaseSink * sink, GstQuery * query)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "propose_allocation");

  return TRUE;
}

/* start and stop processing, ideal for opening/closing the resource */
static gboolean
gst_replace_start (GstBaseSink * sink)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "start");

  return TRUE;
}

static gboolean
gst_replace_stop (GstBaseSink * sink)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "stop");

  return TRUE;
}

/* unlock any pending access to the resource. subclasses should unlock
 * any function ASAP. */
static gboolean
gst_replace_unlock (GstBaseSink * sink)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "unlock");

  return TRUE;
}

/* Clear a previously indicated unlock request not that unlocking is
 * complete. Sub-classes should clear any command queue or indicator they
 * set during unlock */
static gboolean
gst_replace_unlock_stop (GstBaseSink * sink)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "unlock_stop");

  return TRUE;
}

/* notify subclass of query */
static gboolean
gst_replace_query (GstBaseSink * sink, GstQuery * query)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "query");

  return TRUE;
}

/* notify subclass of event */
static gboolean
gst_replace_event (GstBaseSink * sink, GstEvent * event)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "event");

  return TRUE;
}

/* wait for eos or gap, subclasses should chain up to parent first */
static GstFlowReturn
gst_replace_wait_event (GstBaseSink * sink, GstEvent * event)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "wait_event");

  return GST_FLOW_OK;
}

/* notify subclass of buffer or list before doing sync */
static GstFlowReturn
gst_replace_prepare (GstBaseSink * sink, GstBuffer * buffer)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "prepare");

  return GST_FLOW_OK;
}

static GstFlowReturn
gst_replace_prepare_list (GstBaseSink * sink, GstBufferList * buffer_list)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "prepare_list");

  return GST_FLOW_OK;
}

/* notify subclass of preroll buffer or real buffer */
static GstFlowReturn
gst_replace_preroll (GstBaseSink * sink, GstBuffer * buffer)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "preroll");

  return GST_FLOW_OK;
}

static GstFlowReturn
gst_replace_render (GstBaseSink * sink, GstBuffer * buffer)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "render");

  return GST_FLOW_OK;
}

/* Render a BufferList */
static GstFlowReturn
gst_replace_render_list (GstBaseSink * sink, GstBufferList * buffer_list)
{
  GstReplace *replace = GST_REPLACE (sink);

  GST_DEBUG_OBJECT (replace, "render_list");

  return GST_FLOW_OK;
}
% end