~sipe-collab/sipe-collab/gstreamer-plugins-base

<a href="#gst-plugins-base-libs-GstVideoEncoder.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>

<a href="#gst-plugins-base-libs-GstVideoEncoder.object-hierarchy" class="shortcut">Object Hierarchy</a></span>

</td>

</tr></table>

<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-GstVideoEncoder.top_of_page"></a>GstVideoEncoder</span></h2>

<p>GstVideoEncoder — Base class for video encoders</p>

</td>

</tr></table></div>

<a name="gst-plugins-base-libs-GstVideoEncoder.synopsis"></a><h2>Synopsis</h2>

<pre class="synopsis">#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-CAST:CAPS" title="GST_VIDEO_ENCODER_CAST()">GST_VIDEO_ENCODER_CAST</a> (enc)

#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-FLOW-DROPPED:CAPS" title="GST_VIDEO_ENCODER_FLOW_DROPPED">GST_VIDEO_ENCODER_FLOW_DROPPED</a>

#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-FLOW-NEED-DATA:CAPS" title="GST_VIDEO_ENCODER_FLOW_NEED_DATA">GST_VIDEO_ENCODER_FLOW_NEED_DATA</a>

#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-SINK-NAME:CAPS" title="GST_VIDEO_ENCODER_SINK_NAME">GST_VIDEO_ENCODER_SINK_NAME</a>

#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-SINK-PAD:CAPS" title="GST_VIDEO_ENCODER_SINK_PAD()">GST_VIDEO_ENCODER_SINK_PAD</a> (obj)

#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-SRC-NAME:CAPS" title="GST_VIDEO_ENCODER_SRC_NAME">GST_VIDEO_ENCODER_SRC_NAME</a>

#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-SRC-PAD:CAPS" title="GST_VIDEO_ENCODER_SRC_PAD()">GST_VIDEO_ENCODER_SRC_PAD</a> (obj)

#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-INPUT-SEGMENT:CAPS" title="GST_VIDEO_ENCODER_INPUT_SEGMENT()">GST_VIDEO_ENCODER_INPUT_SEGMENT</a> (obj)

#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-OUTPUT-SEGMENT:CAPS" title="GST_VIDEO_ENCODER_OUTPUT_SEGMENT()">GST_VIDEO_ENCODER_OUTPUT_SEGMENT</a> (obj)

#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-STREAM-LOCK:CAPS" title="GST_VIDEO_ENCODER_STREAM_LOCK()">GST_VIDEO_ENCODER_STREAM_LOCK</a> (encoder)

#define <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-STREAM-UNLOCK:CAPS" title="GST_VIDEO_ENCODER_STREAM_UNLOCK()">GST_VIDEO_ENCODER_STREAM_UNLOCK</a> (encoder)

struct <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder">GstVideoEncoder</a>;

struct <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoderClass" title="struct GstVideoEncoderClass">GstVideoEncoderClass</a>;

<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> * <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-allocate-output-buffer" title="gst_video_encoder_allocate_output_buffer ()">gst_video_encoder_allocate_output_buffer</a>

(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

<em class="parameter"><code><span class="type">gsize</span> size</code></em>);

<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a> *frame</code></em>,

<em class="parameter"><code><span class="type">gsize</span> size</code></em>);

<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-allocator" title="gst_video_encoder_get_allocator ()">gst_video_encoder_get_allocator</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstAllocator.html"><span class="type">GstAllocator</span></a> **allocator</code></em>,

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstAllocator.html#GstAllocationParams"><span class="type">GstAllocationParams</span></a> *params</code></em>);

<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-finish-frame" title="gst_video_encoder_finish_frame ()">gst_video_encoder_finish_frame</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-negotiate" title="gst_video_encoder_negotiate ()">gst_video_encoder_negotiate</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="returnvalue">GstVideoCodecFrame</span></a> * <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-frame" title="gst_video_encoder_get_frame ()">gst_video_encoder_get_frame</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

<em class="parameter"><code><span class="type">int</span> frame_number</code></em>);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-frames" title="gst_video_encoder_get_frames ()">gst_video_encoder_get_frames</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="returnvalue">GstVideoCodecFrame</span></a> * <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-oldest-frame" title="gst_video_encoder_get_oldest_frame ()">gst_video_encoder_get_oldest_frame</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);

<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-set-headers" title="gst_video_encoder_set_headers ()">gst_video_encoder_set_headers</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *headers</code></em>);

<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-latency" title="gst_video_encoder_get_latency ()">gst_video_encoder_get_latency</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> *min_latency</code></em>,

<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-set-latency" title="gst_video_encoder_set_latency ()">gst_video_encoder_set_latency</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-discont" title="gst_video_encoder_get_discont ()">gst_video_encoder_get_discont</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);

<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-set-discont" title="gst_video_encoder_set_discont ()">gst_video_encoder_set_discont</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="returnvalue">GstVideoCodecState</span></a> * <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-set-output-state" title="gst_video_encoder_set_output_state ()">gst_video_encoder_set_output_state</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,

<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a> *reference</code></em>);

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="returnvalue">GstVideoCodecState</span></a> * <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-output-state" title="gst_video_encoder_get_output_state ()">gst_video_encoder_get_output_state</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);

<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> * <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-proxy-getcaps" title="gst_video_encoder_proxy_getcaps ()">gst_video_encoder_proxy_getcaps</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *enc</code></em>,

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *filter</code></em>);

<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-merge-tags" title="gst_video_encoder_merge_tags ()">gst_video_encoder_merge_tags</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *tags</code></em>,

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagMergeMode"><span class="type">GstTagMergeMode</span></a> mode</code></em>);

<a name="gst-plugins-base-libs-GstVideoEncoder.functions"></a><h2>Functions</h2>

</colgroup>

<tbody>

<tr>

<td class="define_keyword">#define</td>

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-CAST:CAPS" title="GST_VIDEO_ENCODER_CAST()">GST_VIDEO_ENCODER_CAST</a><span class="c_punctuation">()</span>

</td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-SINK-PAD:CAPS" title="GST_VIDEO_ENCODER_SINK_PAD()">GST_VIDEO_ENCODER_SINK_PAD</a><span class="c_punctuation">()</span>

</td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-SRC-PAD:CAPS" title="GST_VIDEO_ENCODER_SRC_PAD()">GST_VIDEO_ENCODER_SRC_PAD</a><span class="c_punctuation">()</span>

</td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-INPUT-SEGMENT:CAPS" title="GST_VIDEO_ENCODER_INPUT_SEGMENT()">GST_VIDEO_ENCODER_INPUT_SEGMENT</a><span class="c_punctuation">()</span>

</td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-OUTPUT-SEGMENT:CAPS" title="GST_VIDEO_ENCODER_OUTPUT_SEGMENT()">GST_VIDEO_ENCODER_OUTPUT_SEGMENT</a><span class="c_punctuation">()</span>

</td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-STREAM-LOCK:CAPS" title="GST_VIDEO_ENCODER_STREAM_LOCK()">GST_VIDEO_ENCODER_STREAM_LOCK</a><span class="c_punctuation">()</span>

</td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-STREAM-UNLOCK:CAPS" title="GST_VIDEO_ENCODER_STREAM_UNLOCK()">GST_VIDEO_ENCODER_STREAM_UNLOCK</a><span class="c_punctuation">()</span>

</td>

</tr>

<tr>

<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *

</td>

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-allocate-output-buffer" title="gst_video_encoder_allocate_output_buffer ()">gst_video_encoder_allocate_output_buffer</a> <span class="c_punctuation">()</span>

</td>

</tr>

<tr>

<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>

</td>

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-allocate-output-frame" title="gst_video_encoder_allocate_output_frame ()">gst_video_encoder_allocate_output_frame</a> <span class="c_punctuation">()</span>

</td>

100

</tr>

101

<tr>

102

103

104

</td>

105

106

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-allocator" title="gst_video_encoder_get_allocator ()">gst_video_encoder_get_allocator</a> <span class="c_punctuation">()</span>

107

</td>

108

</tr>

109

<tr>

110

111

<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>

112

</td>

113

114

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-finish-frame" title="gst_video_encoder_finish_frame ()">gst_video_encoder_finish_frame</a> <span class="c_punctuation">()</span>

115

</td>

116

</tr>

117

<tr>

118

119

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>

120

</td>

121

122

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-negotiate" title="gst_video_encoder_negotiate ()">gst_video_encoder_negotiate</a> <span class="c_punctuation">()</span>

123

</td>

124

</tr>

125

<tr>

126

127

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="returnvalue">GstVideoCodecFrame</span></a> *

128

</td>

129

130

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-frame" title="gst_video_encoder_get_frame ()">gst_video_encoder_get_frame</a> <span class="c_punctuation">()</span>

131

</td>

132

</tr>

133

<tr>

134

135

<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *

136

</td>

137

138

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-frames" title="gst_video_encoder_get_frames ()">gst_video_encoder_get_frames</a> <span class="c_punctuation">()</span>

139

</td>

140

</tr>

141

<tr>

142

143

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="returnvalue">GstVideoCodecFrame</span></a> *

144

</td>

145

146

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-oldest-frame" title="gst_video_encoder_get_oldest_frame ()">gst_video_encoder_get_oldest_frame</a> <span class="c_punctuation">()</span>

147

</td>

148

</tr>

149

<tr>

150

151

152

</td>

153

154

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-set-headers" title="gst_video_encoder_set_headers ()">gst_video_encoder_set_headers</a> <span class="c_punctuation">()</span>

155

</td>

156

</tr>

157

<tr>

158

159

160

</td>

161

162

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-latency" title="gst_video_encoder_get_latency ()">gst_video_encoder_get_latency</a> <span class="c_punctuation">()</span>

163

</td>

164

</tr>

165

<tr>

166

167

168

</td>

169

170

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-set-latency" title="gst_video_encoder_set_latency ()">gst_video_encoder_set_latency</a> <span class="c_punctuation">()</span>

171

</td>

172

</tr>

173

<tr>

174

175

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>

176

</td>

177

178

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-discont" title="gst_video_encoder_get_discont ()">gst_video_encoder_get_discont</a> <span class="c_punctuation">()</span>

179

</td>

180

</tr>

181

<tr>

182

183

184

</td>

185

186

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-set-discont" title="gst_video_encoder_set_discont ()">gst_video_encoder_set_discont</a> <span class="c_punctuation">()</span>

187

</td>

188

</tr>

189

<tr>

190

191

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="returnvalue">GstVideoCodecState</span></a> *

192

</td>

193

194

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-set-output-state" title="gst_video_encoder_set_output_state ()">gst_video_encoder_set_output_state</a> <span class="c_punctuation">()</span>

195

</td>

196

</tr>

197

<tr>

198

199

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="returnvalue">GstVideoCodecState</span></a> *

200

</td>

201

202

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-get-output-state" title="gst_video_encoder_get_output_state ()">gst_video_encoder_get_output_state</a> <span class="c_punctuation">()</span>

203

</td>

204

</tr>

205

<tr>

206

207

<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> *

208

</td>

209

210

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-proxy-getcaps" title="gst_video_encoder_proxy_getcaps ()">gst_video_encoder_proxy_getcaps</a> <span class="c_punctuation">()</span>

211

</td>

212

</tr>

213

<tr>

214

215

216

</td>

217

218

<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-merge-tags" title="gst_video_encoder_merge_tags ()">gst_video_encoder_merge_tags</a> <span class="c_punctuation">()</span>

219

</td>

220

</tr>

221

</tbody>

222

</table></div>

223

</div>

224

225

<a name="gst-plugins-base-libs-GstVideoEncoder.other"></a><h2>Types and Values</h2>

226

227

228

229

230

</colgroup>

231

<tbody>

232

<tr>

233

<td class="define_keyword">#define</td>

234

<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-FLOW-DROPPED:CAPS" title="GST_VIDEO_ENCODER_FLOW_DROPPED">GST_VIDEO_ENCODER_FLOW_DROPPED</a></td>

235

</tr>

236

<tr>

237

<td class="define_keyword">#define</td>

238

<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-FLOW-NEED-DATA:CAPS" title="GST_VIDEO_ENCODER_FLOW_NEED_DATA">GST_VIDEO_ENCODER_FLOW_NEED_DATA</a></td>

239

</tr>

240

<tr>

241

<td class="define_keyword">#define</td>

242

<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-SINK-NAME:CAPS" title="GST_VIDEO_ENCODER_SINK_NAME">GST_VIDEO_ENCODER_SINK_NAME</a></td>

243

</tr>

244

<tr>

245

<td class="define_keyword">#define</td>

246

<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GST-VIDEO-ENCODER-SRC-NAME:CAPS" title="GST_VIDEO_ENCODER_SRC_NAME">GST_VIDEO_ENCODER_SRC_NAME</a></td>

247

</tr>

248

<tr>

249

<td class="datatype_keyword">struct</td>

250

<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder">GstVideoEncoder</a></td>

251

</tr>

252

<tr>

253

<td class="datatype_keyword">struct</td>

254

<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoderClass" title="struct GstVideoEncoderClass">GstVideoEncoderClass</a></td>

255

</tr>

256

</tbody>

257

</table></div>

258

</div>

259

260

<a name="gst-plugins-base-libs-GstVideoEncoder.object-hierarchy"></a><h2>Object Hierarchy</h2>

261

262

</pre>

263

</div>

264

265

<a name="gst-plugins-base-libs-GstVideoEncoder.description"></a><h2>Description</h2>

<p>

This base class is for video encoders turning raw video into

encoded video data.

</p>

<p>

GstVideoEncoder and subclass should cooperate as follows.

100

</p>

266

<p>This base class is for video encoders turning raw video into

267

encoded video data.</p>

268

<p>GstVideoEncoder and subclass should cooperate as follows.</p>

101

269

102

270

103

271

<p class="title"><b>Configuration</b></p>

151

319

</p></li></ul>

152

320

</div></li>

153

321

</ol></div>

154

<p>

155

</p>

156

<p>

157

Subclass is responsible for providing pad template caps for

322

<p>Subclass is responsible for providing pad template caps for

158

323

source and sink pads. The pads need to be named "sink" and "src". It should

159

also be able to provide fixed src pad caps in <em class="parameter"><code>getcaps</code></em> by the time it calls

160

<em class="parameter"><code>gst_video_encoder_finish_frame</code></em>.

161

</p>

162

<p>

163

Things that subclass need to take care of:

164

</p>

324

also be able to provide fixed src pad caps in <em class="parameter"><code>getcaps</code></em>

325

by the time it calls

326

<em class="parameter"><code>gst_video_encoder_finish_frame</code></em>

327

.</p>

328

<p>Things that subclass need to take care of:</p>

165

329

166

330

<li class="listitem"><p>Provide pad templates</p></li>

167

331

172

336

<em class="parameter"><code>gst_video_encoder_finish_frame</code></em>.

173

337

</p></li>

174

338

</ul></div>

175

<p>

176

</p>

177

339

</div>

178

340

179

<a name="gst-plugins-base-libs-GstVideoEncoder.details"></a><h2>Details</h2>

341

<a name="gst-plugins-base-libs-GstVideoEncoder.functions_details"></a><h2>Functions</h2>

180

342

181

343

<a name="GST-VIDEO-ENCODER-CAST:CAPS"></a><h3>GST_VIDEO_ENCODER_CAST()</h3>

182

344

<pre class="programlisting">#define GST_VIDEO_ENCODER_CAST(enc) ((GstVideoEncoder*)enc)

184

346

</div>

185

347

<hr>

186

348

187

<a name="GST-VIDEO-ENCODER-FLOW-DROPPED:CAPS"></a><h3>GST_VIDEO_ENCODER_FLOW_DROPPED</h3>

188

<pre class="programlisting">#define GST_VIDEO_ENCODER_FLOW_DROPPED GST_FLOW_CUSTOM_SUCCESS_1

189

</pre>

190

<p>

191

Returned when the event/buffer should be dropped.

192

</p>

193

</div>

194

<hr>

195

196

<a name="GST-VIDEO-ENCODER-FLOW-NEED-DATA:CAPS"></a><h3>GST_VIDEO_ENCODER_FLOW_NEED_DATA</h3>

197

<pre class="programlisting">#define GST_VIDEO_ENCODER_FLOW_NEED_DATA GST_FLOW_CUSTOM_SUCCESS

198

</pre>

199

<p>

200

Returned while parsing to indicate more data is needed.

201

</p>

202

</div>

203

<hr>

204

205

<a name="GST-VIDEO-ENCODER-SINK-NAME:CAPS"></a><h3>GST_VIDEO_ENCODER_SINK_NAME</h3>

206

<pre class="programlisting">#define GST_VIDEO_ENCODER_SINK_NAME "sink"

207

</pre>

208

<p>

209

The name of the templates for the sink pad.

210

</p>

211

</div>

212

<hr>

213

214

349

<a name="GST-VIDEO-ENCODER-SINK-PAD:CAPS"></a><h3>GST_VIDEO_ENCODER_SINK_PAD()</h3>

215

350

<pre class="programlisting">#define GST_VIDEO_ENCODER_SINK_PAD(obj) (((GstVideoEncoder *) (obj))->sinkpad)

216

351

</pre>

217

<p>

218

Gives the pointer to the sink <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> object of the element.

219

</p>

220

352

<p>Gives the pointer to the sink <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> object of the element.</p>

353

354

<a name="id-1.2.14.13.7.3.5"></a><h4>Parameters</h4>

355

221

356

222

223

<col>

357

358

359

224

360

</colgroup>

225

361

226

227

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

228

</td>

362

363

<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a></p></td>

364

229

365

</tr></tbody>

230

366

</table></div>

231

367

</div>

232

<hr>

233

234

<a name="GST-VIDEO-ENCODER-SRC-NAME:CAPS"></a><h3>GST_VIDEO_ENCODER_SRC_NAME</h3>

235

<pre class="programlisting">#define GST_VIDEO_ENCODER_SRC_NAME "src"

236

</pre>

237

<p>

238

The name of the templates for the source pad.

239

</p>

240

368

</div>

241

369

<hr>

242

370

243

371

<a name="GST-VIDEO-ENCODER-SRC-PAD:CAPS"></a><h3>GST_VIDEO_ENCODER_SRC_PAD()</h3>

244

372

<pre class="programlisting">#define GST_VIDEO_ENCODER_SRC_PAD(obj) (((GstVideoEncoder *) (obj))->srcpad)

245

373

</pre>

246

<p>

247

Gives the pointer to the source <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> object of the element.

248

</p>

249

374

<p>Gives the pointer to the source <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> object of the element.</p>

375

376

<a name="id-1.2.14.13.7.4.5"></a><h4>Parameters</h4>

377

250

378

251

252

<col>

379

380

381

253

382

</colgroup>

254

383

255

256

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

257

</td>

384

385

386

258

387

</tr></tbody>

259

388

</table></div>

260

389

</div>

390

</div>

261

391

<hr>

262

392

263

393

<a name="GST-VIDEO-ENCODER-INPUT-SEGMENT:CAPS"></a><h3>GST_VIDEO_ENCODER_INPUT_SEGMENT()</h3>

264

394

<pre class="programlisting">#define GST_VIDEO_ENCODER_INPUT_SEGMENT(obj) (GST_VIDEO_ENCODER_CAST (obj)->input_segment)

265

395

</pre>

266

<p>

267

Gives the segment of the element.

268

</p>

269

396

<p>Gives the segment of the element.</p>

397

398

<a name="id-1.2.14.13.7.5.5"></a><h4>Parameters</h4>

399

270

400

271

272

<col>

401

402

403

273

404

</colgroup>

274

405

275

276

<td>base parse instance</td>

406

407

<td class="parameter_description"><p>base parse instance</p></td>

408

277

409

</tr></tbody>

278

410

</table></div>

279

411

</div>

412

</div>

280

413

<hr>

281

414

282

415

<a name="GST-VIDEO-ENCODER-OUTPUT-SEGMENT:CAPS"></a><h3>GST_VIDEO_ENCODER_OUTPUT_SEGMENT()</h3>

283

416

<pre class="programlisting">#define GST_VIDEO_ENCODER_OUTPUT_SEGMENT(obj) (GST_VIDEO_ENCODER_CAST (obj)->output_segment)

284

417

</pre>

285

<p>

286

Gives the segment of the element.

287

</p>

288

418

<p>Gives the segment of the element.</p>

419

420

<a name="id-1.2.14.13.7.6.5"></a><h4>Parameters</h4>

421

289

422

290

291

<col>

423

424

425

292

426

</colgroup>

293

427

294

295

<td>base parse instance</td>

428

429

<td class="parameter_description"><p>base parse instance</p></td>

430

296

431

</tr></tbody>

297

432

</table></div>

298

433

</div>

434

</div>

299

435

<hr>

300

436

301

437

<a name="GST-VIDEO-ENCODER-STREAM-LOCK:CAPS"></a><h3>GST_VIDEO_ENCODER_STREAM_LOCK()</h3>

302

438

<pre class="programlisting">#define GST_VIDEO_ENCODER_STREAM_LOCK(encoder) g_rec_mutex_lock (&GST_VIDEO_ENCODER (encoder)->stream_lock)

303

439

</pre>

304

<p>

305

Obtain a lock to protect the encoder function from concurrent access.

306

</p>

307

440

<p>Obtain a lock to protect the encoder function from concurrent access.</p>

441

442

<a name="id-1.2.14.13.7.7.5"></a><h4>Parameters</h4>

443

308

444

309

310

<col>

445

446

447

311

448

</colgroup>

312

449

313

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

314

<td>video encoder instance</td>

450

<td class="parameter_name"><p>encoder</p></td>

451

<td class="parameter_description"><p>video encoder instance</p></td>

452

315

453

</tr></tbody>

316

454

</table></div>

317

455

</div>

456

</div>

318

457

<hr>

319

458

320

459

<a name="GST-VIDEO-ENCODER-STREAM-UNLOCK:CAPS"></a><h3>GST_VIDEO_ENCODER_STREAM_UNLOCK()</h3>

321

460

<pre class="programlisting">#define GST_VIDEO_ENCODER_STREAM_UNLOCK(encoder) g_rec_mutex_unlock (&GST_VIDEO_ENCODER (encoder)->stream_lock)

322

461

</pre>

323

<p>

324

Release the lock that protects the encoder function from concurrent access.

325

</p>

326

327

328

329

<col>

330

</colgroup>

331

332

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

333

<td>video encoder instance</td>

334

</tr></tbody>

335

</table></div>

462

<p>Release the lock that protects the encoder function from concurrent access.</p>

463

464

<a name="id-1.2.14.13.7.8.5"></a><h4>Parameters</h4>

465

466

467

468

469

470

</colgroup>

471

472

<td class="parameter_name"><p>encoder</p></td>

473

<td class="parameter_description"><p>video encoder instance</p></td>

474

475

</tr></tbody>

476

</table></div>

477

</div>

478

</div>

479

<hr>

480

481

<a name="gst-video-encoder-allocate-output-buffer"></a><h3>gst_video_encoder_allocate_output_buffer ()</h3>

482

<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *

483

gst_video_encoder_allocate_output_buffer

484

485

<em class="parameter"><code><span class="type">gsize</span> size</code></em>);</pre>

486

<p>Helper function that allocates a buffer to hold an encoded video frame

487

for <em class="parameter"><code>encoder</code></em>

488

's current <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a>.</p>

489

490

<a name="id-1.2.14.13.7.9.5"></a><h4>Parameters</h4>

491

492

493

494

495

496

</colgroup>

497

<tbody>

498

<tr>

499

<td class="parameter_name"><p>encoder</p></td>

500

501

502

</tr>

503

<tr>

504

505

<td class="parameter_description"><p>size of the buffer</p></td>

506

507

</tr>

508

</tbody>

509

</table></div>

510

</div>

511

512

<a name="id-1.2.14.13.7.9.6"></a><h4>Returns</h4>

513

<p> allocated buffer. </p>

514

<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>

515

</div>

516

</div>

517

<hr>

518

519

<a name="gst-video-encoder-allocate-output-frame"></a><h3>gst_video_encoder_allocate_output_frame ()</h3>

520

<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>

521

gst_video_encoder_allocate_output_frame

522

523

524

<em class="parameter"><code><span class="type">gsize</span> size</code></em>);</pre>

525

<p>Helper function that allocates a buffer to hold an encoded video frame for <em class="parameter"><code>encoder</code></em>

526

527

current <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a>. Subclass should already have configured video

528

state and set src pad caps.</p>

529

<p>The buffer allocated here is owned by the frame and you should only

530

keep references to the frame, not the buffer.</p>

531

532

<a name="id-1.2.14.13.7.10.6"></a><h4>Parameters</h4>

533

534

535

536

537

538

</colgroup>

539

<tbody>

540

<tr>

541

<td class="parameter_name"><p>encoder</p></td>

542

543

544

</tr>

545

<tr>

546

<td class="parameter_name"><p>frame</p></td>

547

<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a></p></td>

548

549

</tr>

550

<tr>

551

552

<td class="parameter_description"><p>size of the buffer</p></td>

553

554

</tr>

555

</tbody>

556

</table></div>

557

</div>

558

559

<a name="id-1.2.14.13.7.10.7"></a><h4>Returns</h4>

560

<p> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-OK:CAPS"><code class="literal">GST_FLOW_OK</code></a> if an output buffer could be allocated</p>

561

<p></p>

562

</div>

563

</div>

564

<hr>

565

566

<a name="gst-video-encoder-get-allocator"></a><h3>gst_video_encoder_get_allocator ()</h3>

567

568

gst_video_encoder_get_allocator (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

569

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstAllocator.html"><span class="type">GstAllocator</span></a> **allocator</code></em>,

570

571

<p>Lets <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> sub-classes to know the memory <em class="parameter"><code>allocator</code></em>

572

573

used by the base class and its <em class="parameter"><code>params</code></em>

574

.</p>

575

<p>Unref the <em class="parameter"><code>allocator</code></em>

576

after use it.</p>

577

578

<a name="id-1.2.14.13.7.11.6"></a><h4>Parameters</h4>

579

580

581

582

583

584

</colgroup>

585

<tbody>

586

<tr>

587

<td class="parameter_name"><p>encoder</p></td>

588

589

590

</tr>

591

<tr>

592

<td class="parameter_name"><p>allocator</p></td>

593

<td class="parameter_description"><p> the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstAllocator.html"><span class="type">GstAllocator</span></a>

594

used. </p></td>

595

<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>

596

</tr>

597

<tr>

598

<td class="parameter_name"><p>params</p></td>

599

<td class="parameter_description"><p> the

600

<span class="type">GstAllocatorParams</span> of <em class="parameter"><code>allocator</code></em>

601

. </p></td>

602

603

</tr>

604

</tbody>

605

</table></div>

606

</div>

607

</div>

608

<hr>

609

610

<a name="gst-video-encoder-finish-frame"></a><h3>gst_video_encoder_finish_frame ()</h3>

611

<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>

612

gst_video_encoder_finish_frame (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

613

614

<p><em class="parameter"><code>frame</code></em>

615

must have a valid encoded data buffer, whose metadata fields

616

are then appropriately set according to frame data or no buffer at

617

all if the frame should be dropped.

618

It is subsequently pushed downstream or provided to <em class="parameter"><code>pre_push</code></em>

619

620

In any case, the frame is considered finished and released.</p>

621

<p>After calling this function the output buffer of the frame is to be

622

considered read-only. This function will also change the metadata

623

of the buffer.</p>

624

625

<a name="id-1.2.14.13.7.12.6"></a><h4>Parameters</h4>

626

627

628

629

630

631

</colgroup>

632

<tbody>

633

<tr>

634

<td class="parameter_name"><p>encoder</p></td>

635

636

637

</tr>

638

<tr>

639

<td class="parameter_name"><p>frame</p></td>

640

<td class="parameter_description"><p> an encoded <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a>. </p></td>

641

<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>

642

</tr>

643

</tbody>

644

</table></div>

645

</div>

646

647

<a name="id-1.2.14.13.7.12.7"></a><h4>Returns</h4>

648

<p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a> resulting from sending data downstream</p>

649

<p></p>

650

</div>

651

</div>

652

<hr>

653

654

<a name="gst-video-encoder-negotiate"></a><h3>gst_video_encoder_negotiate ()</h3>

655

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>

656

gst_video_encoder_negotiate (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

657

<p>Negotiate with downstream elements to currently configured <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a>.

658

Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if

659

negotiate fails.</p>

660

661

<a name="id-1.2.14.13.7.13.5"></a><h4>Parameters</h4>

662

663

664

665

666

667

</colgroup>

668

669

<td class="parameter_name"><p>encoder</p></td>

670

671

672

</tr></tbody>

673

</table></div>

674

</div>

675

676

<a name="id-1.2.14.13.7.13.6"></a><h4>Returns</h4>

677

<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the negotiation succeeded, else <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</p>

678

<p></p>

679

</div>

680

</div>

681

<hr>

682

683

<a name="gst-video-encoder-get-frame"></a><h3>gst_video_encoder_get_frame ()</h3>

684

685

gst_video_encoder_get_frame (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

686

<em class="parameter"><code><span class="type">int</span> frame_number</code></em>);</pre>

687

<p>Get a pending unfinished <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a></p>

688

689

<a name="id-1.2.14.13.7.14.5"></a><h4>Parameters</h4>

690

691

692

693

694

695

</colgroup>

696

<tbody>

697

<tr>

698

<td class="parameter_name"><p>encoder</p></td>

699

<td class="parameter_description"><p>a <span class="type">GstVideoEnccoder</span></p></td>

700

701

</tr>

702

<tr>

703

<td class="parameter_name"><p>frame_number</p></td>

704

<td class="parameter_description"><p>system_frame_number of a frame</p></td>

705

706

</tr>

707

</tbody>

708

</table></div>

709

</div>

710

711

<a name="id-1.2.14.13.7.14.6"></a><h4>Returns</h4>

712

<p> pending unfinished <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a> identified by <em class="parameter"><code>frame_number</code></em>

713

. </p>

714

<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>

715

</div>

716

</div>

717

<hr>

718

719

<a name="gst-video-encoder-get-frames"></a><h3>gst_video_encoder_get_frames ()</h3>

720

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *

721

gst_video_encoder_get_frames (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

722

<p>Get all pending unfinished <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a></p>

723

724

<a name="id-1.2.14.13.7.15.5"></a><h4>Parameters</h4>

725

726

727

728

729

730

</colgroup>

731

732

<td class="parameter_name"><p>encoder</p></td>

733

734

735

</tr></tbody>

736

</table></div>

737

</div>

738

739

<a name="id-1.2.14.13.7.15.6"></a><h4>Returns</h4>

740

<p> pending unfinished <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a>. </p>

741

<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GstVideoCodecFrame]</span></p>

742

</div>

743

</div>

744

<hr>

745

746

<a name="gst-video-encoder-get-oldest-frame"></a><h3>gst_video_encoder_get_oldest_frame ()</h3>

747

748

gst_video_encoder_get_oldest_frame (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

749

<p>Get the oldest unfinished pending <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a></p>

750

751

<a name="id-1.2.14.13.7.16.5"></a><h4>Parameters</h4>

752

753

754

755

756

757

</colgroup>

758

759

<td class="parameter_name"><p>encoder</p></td>

760

761

762

</tr></tbody>

763

</table></div>

764

</div>

765

766

<a name="id-1.2.14.13.7.16.6"></a><h4>Returns</h4>

767

<p> oldest unfinished pending <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a>. </p>

768

<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>

769

</div>

770

</div>

771

<hr>

772

773

<a name="gst-video-encoder-set-headers"></a><h3>gst_video_encoder_set_headers ()</h3>

774

775

gst_video_encoder_set_headers (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

776

<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *headers</code></em>);</pre>

777

<p>Set the codec headers to be sent downstream whenever requested.</p>

778

779

<a name="id-1.2.14.13.7.17.5"></a><h4>Parameters</h4>

780

781

782

783

784

785

</colgroup>

786

<tbody>

787

<tr>

788

<td class="parameter_name"><p>encoder</p></td>

789

790

791

</tr>

792

<tr>

793

<td class="parameter_name"><p>headers</p></td>

794

<td class="parameter_description"><p> a list of <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> containing the codec header. </p></td>

795

<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GstBuffer]</span></td>

796

</tr>

797

</tbody>

798

</table></div>

799

</div>

800

</div>

801

<hr>

802

803

<a name="gst-video-encoder-get-latency"></a><h3>gst_video_encoder_get_latency ()</h3>

804

805

gst_video_encoder_get_latency (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

806

807

808

<p>Query the configured encoding latency. Results will be returned via

809

<em class="parameter"><code>min_latency</code></em>

810

and <em class="parameter"><code>max_latency</code></em>

811

.</p>

812

813

<a name="id-1.2.14.13.7.18.5"></a><h4>Parameters</h4>

814

815

816

817

818

819

</colgroup>

820

<tbody>

821

<tr>

822

<td class="parameter_name"><p>encoder</p></td>

823

824

825

</tr>

826

<tr>

827

<td class="parameter_name"><p>min_latency</p></td>

828

<td class="parameter_description"><p> address of variable in which to store the

829

configured minimum latency, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>

830

831

</tr>

832

<tr>

833

<td class="parameter_name"><p>max_latency</p></td>

834

<td class="parameter_description"><p> address of variable in which to store the

835

configured maximum latency, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>

836

837

</tr>

838

</tbody>

839

</table></div>

840

</div>

841

</div>

842

<hr>

843

844

<a name="gst-video-encoder-set-latency"></a><h3>gst_video_encoder_set_latency ()</h3>

845

846

gst_video_encoder_set_latency (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

847

848

849

<p>Informs baseclass of encoding latency.</p>

850

851

<a name="id-1.2.14.13.7.19.5"></a><h4>Parameters</h4>

852

853

854

855

856

857

</colgroup>

858

<tbody>

859

<tr>

860

<td class="parameter_name"><p>encoder</p></td>

861

862

863

</tr>

864

<tr>

865

<td class="parameter_name"><p>min_latency</p></td>

866

<td class="parameter_description"><p>minimum latency</p></td>

867

868

</tr>

869

<tr>

870

<td class="parameter_name"><p>max_latency</p></td>

871

<td class="parameter_description"><p>maximum latency</p></td>

872

873

</tr>

874

</tbody>

875

</table></div>

876

</div>

877

</div>

878

<hr>

879

880

<a name="gst-video-encoder-get-discont"></a><h3>gst_video_encoder_get_discont ()</h3>

881

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>

882

gst_video_encoder_get_discont (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

883

</div>

884

<hr>

885

886

<a name="gst-video-encoder-set-discont"></a><h3>gst_video_encoder_set_discont ()</h3>

887

888

gst_video_encoder_set_discont (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

889

</div>

890

<hr>

891

892

<a name="gst-video-encoder-set-output-state"></a><h3>gst_video_encoder_set_output_state ()</h3>

893

894

gst_video_encoder_set_output_state (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

895

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,

896

897

<p>Creates a new <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a> with the specified caps as the output state

898

for the encoder.

899

Any previously set output state on <em class="parameter"><code>encoder</code></em>

900

will be replaced by the newly

901

created one.</p>

902

<p>The specified <em class="parameter"><code>caps</code></em>

903

should not contain any resolution, pixel-aspect-ratio,

904

framerate, codec-data, .... Those should be specified instead in the returned

905

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a>.</p>

906

<p>If the subclass wishes to copy over existing fields (like pixel aspect ratio,

907

or framerate) from an existing <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a>, it can be provided as a

908

<em class="parameter"><code>reference</code></em>

909

.</p>

910

<p>If the subclass wishes to override some fields from the output state (like

911

pixel-aspect-ratio or framerate) it can do so on the returned <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a>.</p>

912

<p>The new output state will only take effect (set on pads and buffers) starting

913

from the next call to <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-finish-frame" title="gst_video_encoder_finish_frame ()"><code class="function">gst_video_encoder_finish_frame()</code></a>.</p>

914

915

<a name="id-1.2.14.13.7.22.9"></a><h4>Parameters</h4>

916

917

918

919

920

921

</colgroup>

922

<tbody>

923

<tr>

924

<td class="parameter_name"><p>encoder</p></td>

925

926

927

</tr>

928

<tr>

929

930

<td class="parameter_description"><p> the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> to use for the output. </p></td>

931

<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>

932

</tr>

933

<tr>

934

<td class="parameter_name"><p>reference</p></td>

935

<td class="parameter_description"><p> An optional reference <em class="parameter"><code>GstVideoCodecState</code></em>

936

. </p></td>

937

<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>

938

</tr>

939

</tbody>

940

</table></div>

941

</div>

942

943

<a name="id-1.2.14.13.7.22.10"></a><h4>Returns</h4>

944

<p> the newly configured output state. </p>

945

<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>

946

</div>

947

</div>

948

<hr>

949

950

<a name="gst-video-encoder-get-output-state"></a><h3>gst_video_encoder_get_output_state ()</h3>

951

952

gst_video_encoder_get_output_state (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

953

<p>Get the current <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a></p>

954

955

<a name="id-1.2.14.13.7.23.5"></a><h4>Parameters</h4>

956

957

958

959

960

961

</colgroup>

962

963

<td class="parameter_name"><p>encoder</p></td>

964

965

966

</tr></tbody>

967

</table></div>

968

</div>

969

970

<a name="id-1.2.14.13.7.23.6"></a><h4>Returns</h4>

971

<p> <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a> describing format of video data. </p>

972

<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>

973

</div>

974

</div>

975

<hr>

976

977

<a name="gst-video-encoder-proxy-getcaps"></a><h3>gst_video_encoder_proxy_getcaps ()</h3>

978

<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> *

979

gst_video_encoder_proxy_getcaps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *enc</code></em>,

980

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,

981

982

<p>Returns caps that express <em class="parameter"><code>caps</code></em>

983

(or sink template caps if <em class="parameter"><code>caps</code></em>

984

== NULL)

985

restricted to resolution/format/... combinations supported by downstream

986

elements (e.g. muxers).</p>

987

988

<a name="id-1.2.14.13.7.24.5"></a><h4>Parameters</h4>

989

990

991

992

993

994

</colgroup>

995

<tbody>

996

<tr>

997

998

999

1000

</tr>

1001

<tr>

1002

1003

<td class="parameter_description"><p>initial caps</p></td>

1004

1005

</tr>

1006

<tr>

1007

<td class="parameter_name"><p>filter</p></td>

1008

<td class="parameter_description"><p>filter caps</p></td>

1009

1010

</tr>

1011

</tbody>

1012

</table></div>

1013

</div>

1014

1015

<a name="id-1.2.14.13.7.24.6"></a><h4>Returns</h4>

1016

<p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> owned by caller</p>

1017

<p></p>

1018

</div>

1019

</div>

1020

<hr>

1021

1022

<a name="gst-video-encoder-merge-tags"></a><h3>gst_video_encoder_merge_tags ()</h3>

1023

1024

gst_video_encoder_merge_tags (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

1025

1026

1027

<p>Adds tags to so-called pending tags, which will be processed

1028

before pushing out data downstream.</p>

1029

<p>Note that this is provided for convenience, and the subclass is

1030

not required to use this and can still do tag handling on its own.</p>

1031

1032

1033

<a name="id-1.2.14.13.7.25.7"></a><h4>Parameters</h4>

1034

1035

1036

1037

1038

1039

</colgroup>

1040

<tbody>

1041

<tr>

1042

<td class="parameter_name"><p>encoder</p></td>

1043

1044

1045

</tr>

1046

<tr>

1047

1048

<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> to merge</p></td>

1049

1050

</tr>

1051

<tr>

1052

1053

<td class="parameter_description"><p>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagMergeMode"><span class="type">GstTagMergeMode</span></a> to use</p></td>

1054

1055

</tr>

1056

</tbody>

1057

</table></div>

1058

</div>

1059

</div>

1060

</div>

1061

1062

<a name="gst-plugins-base-libs-GstVideoEncoder.other_details"></a><h2>Types and Values</h2>

1063

1064

<a name="GST-VIDEO-ENCODER-FLOW-DROPPED:CAPS"></a><h3>GST_VIDEO_ENCODER_FLOW_DROPPED</h3>

1065

<pre class="programlisting">#define GST_VIDEO_ENCODER_FLOW_DROPPED GST_FLOW_CUSTOM_SUCCESS_1

1066

</pre>

1067

<p>Returned when the event/buffer should be dropped.</p>

1068

</div>

1069

<hr>

1070

1071

<a name="GST-VIDEO-ENCODER-FLOW-NEED-DATA:CAPS"></a><h3>GST_VIDEO_ENCODER_FLOW_NEED_DATA</h3>

1072

<pre class="programlisting">#define GST_VIDEO_ENCODER_FLOW_NEED_DATA GST_FLOW_CUSTOM_SUCCESS

1073

</pre>

1074

<p>Returned while parsing to indicate more data is needed.</p>

1075

</div>

1076

<hr>

1077

1078

<a name="GST-VIDEO-ENCODER-SINK-NAME:CAPS"></a><h3>GST_VIDEO_ENCODER_SINK_NAME</h3>

1079

<pre class="programlisting">#define GST_VIDEO_ENCODER_SINK_NAME "sink"

1080

</pre>

1081

<p>The name of the templates for the sink pad.</p>

1082

</div>

1083

<hr>

1084

1085

<a name="GST-VIDEO-ENCODER-SRC-NAME:CAPS"></a><h3>GST_VIDEO_ENCODER_SRC_NAME</h3>

1086

<pre class="programlisting">#define GST_VIDEO_ENCODER_SRC_NAME "src"

1087

</pre>

1088

<p>The name of the templates for the source pad.</p>

336

1089

</div>

337

1090

<hr>

338

1091

340

1093

<pre class="programlisting">struct GstVideoEncoder {

341

1094

};

342

1095

</pre>

343

<p>

344

The opaque <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> data structure.

345

</p>

1096

<p>The opaque <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> data structure.</p>

346

1097

</div>

347

1098

<hr>

348

1099

389

1140

gboolean (*flush) (GstVideoEncoder *encoder);

390

1141

};

391

1142

</pre>

392

<p>

393

Subclasses can override any of the available virtual methods or not, as

394

needed. At minimum <em class="parameter"><code>handle_frame</code></em> needs to be overridden, and <em class="parameter"><code>set_format</code></em>

395

and <em class="parameter"><code>get_caps</code></em> are likely needed as well.

396

</p>

397

1143

<p>Subclasses can override any of the available virtual methods or not, as

1144

needed. At minimum <em class="parameter"><code>handle_frame</code></em>

1145

needs to be overridden, and <em class="parameter"><code>set_format</code></em>

1146

1147

and <em class="parameter"><code>get_caps</code></em>

1148

are likely needed as well.</p>

1149

1150

<a name="id-1.2.14.13.8.7.5"></a><h4>Members</h4>

1151

398

1152

399

400

<col>

1153

1154

1155

401

1156

</colgroup>

402

1157

<tbody>

403

1158

<tr>

404

405

<td>Optional.

1159

1160

<td class="struct_member_description"><p>Optional.

406

1161

Called when the element changes to GST_STATE_READY.

407

Allows opening external resources.</td>

1162

Allows opening external resources.</p></td>

1163

408

1164

</tr>

409

1165

<tr>

410

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.close"></a>close</code></em> ()</span></p></td>

411

<td>Optional.

1166

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.close"></a>close</code></em> ()</p></td>

1167

<td class="struct_member_description"><p>Optional.

412

1168

Called when the element changes to GST_STATE_NULL.

413

Allows closing external resources.</td>

1169

Allows closing external resources.</p></td>

1170

414

1171

</tr>

415

1172

<tr>

416

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.start"></a>start</code></em> ()</span></p></td>

417

<td>Optional.

1173

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.start"></a>start</code></em> ()</p></td>

1174

<td class="struct_member_description"><p>Optional.

418

1175

Called when the element starts processing.

419

Allows opening external resources.</td>

1176

Allows opening external resources.</p></td>

1177

420

1178

</tr>

421

1179

<tr>

422

423

<td>Optional.

1180

1181

<td class="struct_member_description"><p>Optional.

424

1182

Called when the element stops processing.

425

Allows closing external resources.</td>

1183

Allows closing external resources.</p></td>

1184

426

1185

</tr>

427

1186

<tr>

428

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.set-format"></a>set_format</code></em> ()</span></p></td>

429

<td>Optional.

1187

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.set-format"></a>set_format</code></em> ()</p></td>

1188

<td class="struct_member_description"><p>Optional.

430

1189

Notifies subclass of incoming data format.

431

1190

GstVideoCodecState fields have already been

432

set according to provided caps.</td>

433

</tr>

434

<tr>

435

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.handle-frame"></a>handle_frame</code></em> ()</span></p></td>

436

<td>Provides input frame to subclass.</td>

437

</tr>

438

<tr>

439

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.reset"></a>reset</code></em> ()</span></p></td>

440

<td>Optional.

1191

set according to provided caps.</p></td>

1192

1193

</tr>

1194

<tr>

1195

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.handle-frame"></a>handle_frame</code></em> ()</p></td>

1196

<td class="struct_member_description"><p>Provides input frame to subclass.</p></td>

1197

1198

</tr>

1199

<tr>

1200

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.reset"></a>reset</code></em> ()</p></td>

1201

<td class="struct_member_description"><p>Optional.

441

1202

Allows subclass (encoder) to perform post-seek semantics reset.

442

Deprecated.</td>

1203

Deprecated.</p></td>

1204

443

1205

</tr>

444

1206

<tr>

445

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.finish"></a>finish</code></em> ()</span></p></td>

446

<td>Optional.

1207

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.finish"></a>finish</code></em> ()</p></td>

1208

<td class="struct_member_description"><p>Optional.

447

1209

Called to request subclass to dispatch any pending remaining

448

data (e.g. at EOS).</td>

1210

data (e.g. at EOS).</p></td>

1211

449

1212

</tr>

450

1213

<tr>

451

452

<td>Optional.

1214

1215

<td class="struct_member_description"><p>Optional.

453

1216

Allows subclass to push frame downstream in whatever

454

1217

shape or form it deems appropriate. If not provided,

455

provided encoded frame data is simply pushed downstream.</td>

1218

provided encoded frame data is simply pushed downstream.</p></td>

1219

456

1220

</tr>

457

1221

<tr>

458

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.getcaps"></a>getcaps</code></em> ()</span></p></td>

459

<td>Optional.

1222

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.getcaps"></a>getcaps</code></em> ()</p></td>

1223

<td class="struct_member_description"><p>Optional.

460

1224

Allows for a custom sink getcaps implementation (e.g.

461

1225

for multichannel input specification). If not implemented,

462

1226

default returns gst_video_encoder_proxy_getcaps

463

applied to sink template caps.</td>

1227

applied to sink template caps.</p></td>

1228

464

1229

</tr>

465

1230

<tr>

466

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.sink-event"></a>sink_event</code></em> ()</span></p></td>

467

<td>Optional.

1231

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.sink-event"></a>sink_event</code></em> ()</p></td>

1232

<td class="struct_member_description"><p>Optional.

468

1233

Event handler on the sink pad. This function should return

469

1234

TRUE if the event was handled and should be discarded

470

1235

(i.e. not unref'ed).

471

1236

Subclasses should chain up to the parent implementation to

472

invoke the default handler.</td>

1237

invoke the default handler.</p></td>

1238

473

1239

</tr>

474

1240

<tr>

475

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.src-event"></a>src_event</code></em> ()</span></p></td>

476

<td>Optional.

1241

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.src-event"></a>src_event</code></em> ()</p></td>

1242

<td class="struct_member_description"><p>Optional.

477

1243

Event handler on the source pad. This function should return

478

1244

TRUE if the event was handled and should be discarded

479

1245

(i.e. not unref'ed).

480

1246

Subclasses should chain up to the parent implementation to

481

invoke the default handler.</td>

1247

invoke the default handler.</p></td>

1248

482

1249

</tr>

483

1250

<tr>

484

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.negotiate"></a>negotiate</code></em> ()</span></p></td>

485

<td>Optional.

1251

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.negotiate"></a>negotiate</code></em> ()</p></td>

1252

<td class="struct_member_description"><p>Optional.

486

1253

Negotiate with downstream and configure buffer pools, etc.

487

1254

Subclasses should chain up to the parent implementation to

488

invoke the default handler.</td>

1255

invoke the default handler.</p></td>

1256

489

1257

</tr>

490

1258

<tr>

491

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.decide-allocation"></a>decide_allocation</code></em> ()</span></p></td>

492

<td>Optional.

1259

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.decide-allocation"></a>decide_allocation</code></em> ()</p></td>

1260

<td class="struct_member_description"><p>Optional.

493

1261

Setup the allocation parameters for allocating output

494

1262

buffers. The passed in query contains the result of the

495

1263

downstream allocation query.

496

1264

Subclasses should chain up to the parent implementation to

497

invoke the default handler.</td>

1265

invoke the default handler.</p></td>

1266

498

1267

</tr>

499

1268

<tr>

500

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.propose-allocation"></a>propose_allocation</code></em> ()</span></p></td>

501

<td>Optional.

1269

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.propose-allocation"></a>propose_allocation</code></em> ()</p></td>

1270

<td class="struct_member_description"><p>Optional.

502

1271

Propose buffer allocation parameters for upstream elements.

503

1272

Subclasses should chain up to the parent implementation to

504

invoke the default handler.</td>

1273

invoke the default handler.</p></td>

1274

505

1275

</tr>

506

1276

<tr>

507

<td><p><span class="term"><em class="structfield"><code><a name="GstVideoEncoderClass.flush"></a>flush</code></em> ()</span></p></td>

508

<td>Optional.

1277

<td class="struct_member_name"><p><em class="structfield"><code><a name="GstVideoEncoderClass.flush"></a>flush</code></em> ()</p></td>

1278

<td class="struct_member_description"><p>Optional.

509

1279

Flush all remaining data from the encoder without

510

pushing it downstream. Since: 1.2</td>

511

</tr>

512

</tbody>

513

</table></div>

514

</div>

515

<hr>

516

517

<a name="gst-video-encoder-allocate-output-buffer"></a><h3>gst_video_encoder_allocate_output_buffer ()</h3>

518

<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> * gst_video_encoder_allocate_output_buffer

519

520

<em class="parameter"><code><span class="type">gsize</span> size</code></em>);</pre>

521

<p>

522

Helper function that allocates a buffer to hold an encoded video frame

523

for <em class="parameter"><code>encoder</code></em>'s current <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a>.

524

</p>

525

526

527

528

<col>

529

</colgroup>

530

<tbody>

531

<tr>

532

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

533

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

534

</td>

535

</tr>

536

<tr>

537

538

<td>size of the buffer</td>

539

</tr>

540

<tr>

541

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

542

<td>allocated buffer. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>

543

</td>

544

</tr>

545

</tbody>

546

</table></div>

547

</div>

548

<hr>

549

550

<a name="gst-video-encoder-allocate-output-frame"></a><h3>gst_video_encoder_allocate_output_frame ()</h3>

551

552

553

554

<em class="parameter"><code><span class="type">gsize</span> size</code></em>);</pre>

555

<p>

556

Helper function that allocates a buffer to hold an encoded video frame for <em class="parameter"><code>encoder</code></em>'s

557

558

state and set src pad caps.

559

</p>

560

<p>

561

The buffer allocated here is owned by the frame and you should only

562

keep references to the frame, not the buffer.

563

</p>

564

565

566

567

<col>

568

</colgroup>

569

<tbody>

570

<tr>

571

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

572

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

573

</td>

574

</tr>

575

<tr>

576

<td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>

577

<td>a <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a>

578

</td>

579

</tr>

580

<tr>

581

582

<td>size of the buffer</td>

583

</tr>

584

<tr>

585

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

586

<td>

587

<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-OK:CAPS"><code class="literal">GST_FLOW_OK</code></a> if an output buffer could be allocated</td>

588

</tr>

589

</tbody>

590

</table></div>

591

</div>

592

<hr>

593

594

<a name="gst-video-encoder-get-allocator"></a><h3>gst_video_encoder_get_allocator ()</h3>

595

<pre class="programlisting"><span class="returnvalue">void</span> gst_video_encoder_get_allocator (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

596

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstAllocator.html"><span class="type">GstAllocator</span></a> **allocator</code></em>,

597

598

<p>

599

Lets <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> sub-classes to know the memory <em class="parameter"><code>allocator</code></em>

600

used by the base class and its <em class="parameter"><code>params</code></em>.

601

</p>

602

<p>

603

Unref the <em class="parameter"><code>allocator</code></em> after use it.

604

</p>

605

606

607

608

<col>

609

</colgroup>

610

<tbody>

611

<tr>

612

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

613

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

614

</td>

615

</tr>

616

<tr>

617

<td><p><span class="term"><em class="parameter"><code>allocator</code></em> :</span></p></td>

618

<td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstAllocator.html"><span class="type">GstAllocator</span></a>

619

used. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>

620

</td>

621

</tr>

622

<tr>

623

<td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>

624

<td>the

625

<span class="type">GstAllocatorParams</span> of <em class="parameter"><code>allocator</code></em>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>

626

</td>

627

</tr>

628

</tbody>

629

</table></div>

630

</div>

631

<hr>

632

633

<a name="gst-video-encoder-finish-frame"></a><h3>gst_video_encoder_finish_frame ()</h3>

634

<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> gst_video_encoder_finish_frame (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

635

636

<p>

637

<em class="parameter"><code>frame</code></em> must have a valid encoded data buffer, whose metadata fields

638

are then appropriately set according to frame data or no buffer at

639

all if the frame should be dropped.

640

It is subsequently pushed downstream or provided to <em class="parameter"><code>pre_push</code></em>.

641

In any case, the frame is considered finished and released.

642

</p>

643

<p>

644

After calling this function the output buffer of the frame is to be

645

considered read-only. This function will also change the metadata

646

of the buffer.

647

</p>

648

649

650

651

<col>

652

</colgroup>

653

<tbody>

654

<tr>

655

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

656

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

657

</td>

658

</tr>

659

<tr>

660

<td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>

661

<td>an encoded <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>

662

</td>

663

</tr>

664

<tr>

665

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

666

<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a> resulting from sending data downstream</td>

667

</tr>

668

</tbody>

669

</table></div>

670

</div>

671

<hr>

672

673

<a name="gst-video-encoder-negotiate"></a><h3>gst_video_encoder_negotiate ()</h3>

674

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_encoder_negotiate (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

675

<p>

676

Negotiate with downstream elements to currently configured <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a>.

677

Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if

678

negotiate fails.

679

</p>

680

681

682

683

<col>

684

</colgroup>

685

<tbody>

686

<tr>

687

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

688

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

689

</td>

690

</tr>

691

<tr>

692

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

693

<td>

694

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the negotiation succeeded, else <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>

695

</tr>

696

</tbody>

697

</table></div>

698

</div>

699

<hr>

700

701

<a name="gst-video-encoder-get-frame"></a><h3>gst_video_encoder_get_frame ()</h3>

702

<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="returnvalue">GstVideoCodecFrame</span></a> * gst_video_encoder_get_frame (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

703

<em class="parameter"><code><span class="type">int</span> frame_number</code></em>);</pre>

704

<p>

705

Get a pending unfinished <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a>

706

</p>

707

708

709

710

<col>

711

</colgroup>

712

<tbody>

713

<tr>

714

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

715

<td>a <span class="type">GstVideoEnccoder</span>

716

</td>

717

</tr>

718

<tr>

719

<td><p><span class="term"><em class="parameter"><code>frame_number</code></em> :</span></p></td>

720

<td>system_frame_number of a frame</td>

721

</tr>

722

<tr>

723

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

724

<td>pending unfinished <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a> identified by <em class="parameter"><code>frame_number</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>

725

</td>

726

</tr>

727

</tbody>

728

</table></div>

729

</div>

730

<hr>

731

732

<a name="gst-video-encoder-get-frames"></a><h3>gst_video_encoder_get_frames ()</h3>

733

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * gst_video_encoder_get_frames (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

734

<p>

735

Get all pending unfinished <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a>

736

</p>

737

738

739

740

<col>

741

</colgroup>

742

<tbody>

743

<tr>

744

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

745

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

746

</td>

747

</tr>

748

<tr>

749

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

750

<td>pending unfinished <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GstVideoCodecFrame]</span>

751

</td>

752

</tr>

753

</tbody>

754

</table></div>

755

</div>

756

<hr>

757

758

<a name="gst-video-encoder-get-oldest-frame"></a><h3>gst_video_encoder_get_oldest_frame ()</h3>

759

<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="returnvalue">GstVideoCodecFrame</span></a> * gst_video_encoder_get_oldest_frame (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

760

<p>

761

Get the oldest unfinished pending <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a>

762

</p>

763

764

765

766

<col>

767

</colgroup>

768

<tbody>

769

<tr>

770

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

771

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

772

</td>

773

</tr>

774

<tr>

775

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

776

<td>oldest unfinished pending <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecFrame" title="struct GstVideoCodecFrame"><span class="type">GstVideoCodecFrame</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>

777

</td>

778

</tr>

779

</tbody>

780

</table></div>

781

</div>

782

<hr>

783

784

<a name="gst-video-encoder-set-headers"></a><h3>gst_video_encoder_set_headers ()</h3>

785

<pre class="programlisting"><span class="returnvalue">void</span> gst_video_encoder_set_headers (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

786

<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *headers</code></em>);</pre>

787

<p>

788

Set the codec headers to be sent downstream whenever requested.

789

</p>

790

791

792

793

<col>

794

</colgroup>

795

<tbody>

796

<tr>

797

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

798

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

799

</td>

800

</tr>

801

<tr>

802

<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>

803

<td>a list of <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> containing the codec header. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GstBuffer]</span>

804

</td>

805

</tr>

806

</tbody>

807

</table></div>

808

</div>

809

<hr>

810

811

<a name="gst-video-encoder-get-latency"></a><h3>gst_video_encoder_get_latency ()</h3>

812

<pre class="programlisting"><span class="returnvalue">void</span> gst_video_encoder_get_latency (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

813

814

815

<p>

816

Query the configured encoding latency. Results will be returned via

817

<em class="parameter"><code>min_latency</code></em> and <em class="parameter"><code>max_latency</code></em>.

818

</p>

819

820

821

822

<col>

823

</colgroup>

824

<tbody>

825

<tr>

826

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

827

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

828

</td>

829

</tr>

830

<tr>

831

<td><p><span class="term"><em class="parameter"><code>min_latency</code></em> :</span></p></td>

832

<td>address of variable in which to store the

833

configured minimum latency, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>

834

</td>

835

</tr>

836

<tr>

837

<td><p><span class="term"><em class="parameter"><code>max_latency</code></em> :</span></p></td>

838

<td>address of variable in which to store the

839

configured maximum latency, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>

840

</td>

841

</tr>

842

</tbody>

843

</table></div>

844

</div>

845

<hr>

846

847

<a name="gst-video-encoder-set-latency"></a><h3>gst_video_encoder_set_latency ()</h3>

848

<pre class="programlisting"><span class="returnvalue">void</span> gst_video_encoder_set_latency (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

849

850

851

<p>

852

Informs baseclass of encoding latency.

853

</p>

854

855

856

857

<col>

858

</colgroup>

859

<tbody>

860

<tr>

861

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

862

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

863

</td>

864

</tr>

865

<tr>

866

<td><p><span class="term"><em class="parameter"><code>min_latency</code></em> :</span></p></td>

867

<td>minimum latency</td>

868

</tr>

869

<tr>

870

<td><p><span class="term"><em class="parameter"><code>max_latency</code></em> :</span></p></td>

871

<td>maximum latency</td>

872

</tr>

873

</tbody>

874

</table></div>

875

</div>

876

<hr>

877

878

<a name="gst-video-encoder-get-discont"></a><h3>gst_video_encoder_get_discont ()</h3>

879

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_encoder_get_discont (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

880

</div>

881

<hr>

882

883

<a name="gst-video-encoder-set-discont"></a><h3>gst_video_encoder_set_discont ()</h3>

884

<pre class="programlisting"><span class="returnvalue">void</span> gst_video_encoder_set_discont (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

885

</div>

886

<hr>

887

888

<a name="gst-video-encoder-set-output-state"></a><h3>gst_video_encoder_set_output_state ()</h3>

889

<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="returnvalue">GstVideoCodecState</span></a> * gst_video_encoder_set_output_state (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

890

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,

891

892

<p>

893

Creates a new <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a> with the specified caps as the output state

894

for the encoder.

895

Any previously set output state on <em class="parameter"><code>encoder</code></em> will be replaced by the newly

896

created one.

897

</p>

898

<p>

899

The specified <em class="parameter"><code>caps</code></em> should not contain any resolution, pixel-aspect-ratio,

900

framerate, codec-data, .... Those should be specified instead in the returned

901

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a>.

902

</p>

903

<p>

904

If the subclass wishes to copy over existing fields (like pixel aspect ratio,

905

906

<em class="parameter"><code>reference</code></em>.

907

</p>

908

<p>

909

If the subclass wishes to override some fields from the output state (like

910

911

</p>

912

<p>

913

The new output state will only take effect (set on pads and buffers) starting

914

from the next call to #<a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#gst-video-encoder-finish-frame" title="gst_video_encoder_finish_frame ()"><code class="function">gst_video_encoder_finish_frame()</code></a>.

915

</p>

916

917

918

919

<col>

920

</colgroup>

921

<tbody>

922

<tr>

923

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

924

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

925

</td>

926

</tr>

927

<tr>

928

929

<td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> to use for the output. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>

930

</td>

931

</tr>

932

<tr>

933

<td><p><span class="term"><em class="parameter"><code>reference</code></em> :</span></p></td>

934

<td>An optional reference <em class="parameter"><code>GstVideoCodecState</code></em>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>

935

</td>

936

</tr>

937

<tr>

938

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

939

<td>the newly configured output state. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>

940

</td>

941

</tr>

942

</tbody>

943

</table></div>

944

</div>

945

<hr>

946

947

<a name="gst-video-encoder-get-output-state"></a><h3>gst_video_encoder_get_output_state ()</h3>

948

<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="returnvalue">GstVideoCodecState</span></a> * gst_video_encoder_get_output_state (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>);</pre>

949

<p>

950

Get the current <a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a>

951

</p>

952

953

954

955

<col>

956

</colgroup>

957

<tbody>

958

<tr>

959

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

960

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

961

</td>

962

</tr>

963

<tr>

964

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

965

<td>

966

<a class="link" href="gst-plugins-base-libs-gstvideoutils.html#GstVideoCodecState" title="struct GstVideoCodecState"><span class="type">GstVideoCodecState</span></a> describing format of video data. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>

967

</td>

968

</tr>

969

</tbody>

970

</table></div>

971

</div>

972

<hr>

973

974

<a name="gst-video-encoder-proxy-getcaps"></a><h3>gst_video_encoder_proxy_getcaps ()</h3>

975

<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> * gst_video_encoder_proxy_getcaps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *enc</code></em>,

976

<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,

977

978

<p>

979

Returns caps that express <em class="parameter"><code>caps</code></em> (or sink template caps if <em class="parameter"><code>caps</code></em> == NULL)

980

restricted to resolution/format/... combinations supported by downstream

981

elements (e.g. muxers).

982

</p>

983

984

985

986

<col>

987

</colgroup>

988

<tbody>

989

<tr>

990

991

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

992

</td>

993

</tr>

994

<tr>

995

996

<td>initial caps</td>

997

</tr>

998

<tr>

999

<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>

1000

<td>filter caps</td>

1001

</tr>

1002

<tr>

1003

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

1004

<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> owned by caller</td>

1005

</tr>

1006

</tbody>

1007

</table></div>

1008

</div>

1009

<hr>

1010

1011

<a name="gst-video-encoder-merge-tags"></a><h3>gst_video_encoder_merge_tags ()</h3>

1012

<pre class="programlisting"><span class="returnvalue">void</span> gst_video_encoder_merge_tags (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a> *encoder</code></em>,

1013

1014

1015

<p>

1016

Adds tags to so-called pending tags, which will be processed

1017

before pushing out data downstream.

1018

</p>

1019

<p>

1020

Note that this is provided for convenience, and the subclass is

1021

not required to use this and can still do tag handling on its own.

1022

</p>

1023

<p>

1024

MT safe.

1025

</p>

1026

1027

1028

1029

<col>

1030

</colgroup>

1031

<tbody>

1032

<tr>

1033

<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>

1034

<td>a <a class="link" href="gst-plugins-base-libs-GstVideoEncoder.html#GstVideoEncoder" title="struct GstVideoEncoder"><span class="type">GstVideoEncoder</span></a>

1035

</td>

1036

</tr>

1037

<tr>

1038

1039

<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> to merge</td>

1040

</tr>

1041

<tr>

1042

1043

<td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagMergeMode"><span class="type">GstTagMergeMode</span></a> to use</td>

1044

</tr>

1045

</tbody>

1046

</table></div>

1280

pushing it downstream. Since: 1.2</p></td>

1281

1282

</tr>

1283

</tbody>

1284

</table></div>

1285

</div>

1047

1286

</div>

1048

1287

</div>

1049

1288

</div>

1050

1289

1051

1290

<hr>

1052

Generated by GTK-Doc V1.19</div>

1291

Generated by GTK-Doc V1.20</div>

1053

1292

</body>

1054

1293

</html>

b'\\ No newline at end of file'

Older »