1/* GStreamer
2 * Copyright (C) <2011> Wim Taymans <wim.taymans@gmail.com>
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
18 */
19
20#ifndef __GST_VIDEO_FRAME_H__
21#define __GST_VIDEO_FRAME_H__
22
23#include <gst/video/video-enumtypes.h>
24
25G_BEGIN_DECLS
26
27typedef struct _GstVideoFrame GstVideoFrame;
28
29/**
30 * GstVideoFrameFlags:
31 * @GST_VIDEO_FRAME_FLAG_NONE: no flags
32 * @GST_VIDEO_FRAME_FLAG_INTERLACED: The video frame is interlaced. In mixed
33 * interlace-mode, this flag specifies if the frame is interlaced or
34 * progressive.
35 * @GST_VIDEO_FRAME_FLAG_TFF: The video frame has the top field first
36 * @GST_VIDEO_FRAME_FLAG_RFF: The video frame has the repeat flag
37 * @GST_VIDEO_FRAME_FLAG_ONEFIELD: The video frame has one field
38 * @GST_VIDEO_FRAME_FLAG_MULTIPLE_VIEW: The video contains one or
39 * more non-mono views
40 * @GST_VIDEO_FRAME_FLAG_FIRST_IN_BUNDLE: The video frame is the first
41 * in a set of corresponding views provided as sequential frames.
42 * @GST_VIDEO_FRAME_FLAG_TOP_FIELD: The video frame has the top field only. This
43 * is the same as GST_VIDEO_FRAME_FLAG_TFF | GST_VIDEO_FRAME_FLAG_ONEFIELD
44 * (Since: 1.16).
45 * @GST_VIDEO_FRAME_FLAG_BOTTOM_FIELD: The video frame has the bottom field
46 * only. This is the same as GST_VIDEO_FRAME_FLAG_ONEFIELD
47 * (GST_VIDEO_FRAME_FLAG_TFF flag unset) (Since: 1.16).
48 *
49 * Extra video frame flags
50 */
51typedef enum {
52 GST_VIDEO_FRAME_FLAG_NONE = 0,
53 GST_VIDEO_FRAME_FLAG_INTERLACED = (1 << 0),
54 GST_VIDEO_FRAME_FLAG_TFF = (1 << 1),
55 GST_VIDEO_FRAME_FLAG_RFF = (1 << 2),
56 GST_VIDEO_FRAME_FLAG_ONEFIELD = (1 << 3),
57 GST_VIDEO_FRAME_FLAG_MULTIPLE_VIEW = (1 << 4),
58 GST_VIDEO_FRAME_FLAG_FIRST_IN_BUNDLE = (1 << 5),
59 GST_VIDEO_FRAME_FLAG_TOP_FIELD = GST_VIDEO_FRAME_FLAG_TFF |
60 GST_VIDEO_FRAME_FLAG_ONEFIELD,
61 GST_VIDEO_FRAME_FLAG_BOTTOM_FIELD = GST_VIDEO_FRAME_FLAG_ONEFIELD,
62} GstVideoFrameFlags;
63
64/* circular dependency, need to include this after defining the enums */
65#include <gst/video/video-format.h>
66#include <gst/video/video-info.h>
67
68/**
69 * GstVideoFrame:
70 * @info: the #GstVideoInfo
71 * @flags: #GstVideoFrameFlags for the frame
72 * @buffer: the mapped buffer
73 * @meta: pointer to metadata if any
74 * @id: id of the mapped frame. the id can for example be used to
75 * indentify the frame in case of multiview video.
76 * @data: pointers to the plane data
77 * @map: mappings of the planes
78 *
79 * A video frame obtained from gst_video_frame_map()
80 */
81struct _GstVideoFrame {
82 GstVideoInfo info;
83 GstVideoFrameFlags flags;
84
85 GstBuffer *buffer;
86 gpointer meta;
87 gint id;
88
89 gpointer data[GST_VIDEO_MAX_PLANES];
90 GstMapInfo map[GST_VIDEO_MAX_PLANES];
91
92 /*< private >*/
93 gpointer _gst_reserved[GST_PADDING];
94};
95
96GST_VIDEO_API
97gboolean gst_video_frame_map (GstVideoFrame *frame, GstVideoInfo *info,
98 GstBuffer *buffer, GstMapFlags flags);
99
100GST_VIDEO_API
101gboolean gst_video_frame_map_id (GstVideoFrame *frame, GstVideoInfo *info,
102 GstBuffer *buffer, gint id, GstMapFlags flags);
103
104GST_VIDEO_API
105void gst_video_frame_unmap (GstVideoFrame *frame);
106
107GST_VIDEO_API
108gboolean gst_video_frame_copy (GstVideoFrame *dest, const GstVideoFrame *src);
109
110GST_VIDEO_API
111gboolean gst_video_frame_copy_plane (GstVideoFrame *dest, const GstVideoFrame *src,
112 guint plane);
113
114/* general info */
115#define GST_VIDEO_FRAME_FORMAT(f) (GST_VIDEO_INFO_FORMAT(&(f)->info))
116#define GST_VIDEO_FRAME_WIDTH(f) (GST_VIDEO_INFO_WIDTH(&(f)->info))
117#define GST_VIDEO_FRAME_HEIGHT(f) (GST_VIDEO_INFO_HEIGHT(&(f)->info))
118#define GST_VIDEO_FRAME_SIZE(f) (GST_VIDEO_INFO_SIZE(&(f)->info))
119
120/* flags */
121#define GST_VIDEO_FRAME_FLAGS(f) ((f)->flags)
122#define GST_VIDEO_FRAME_FLAG_IS_SET(f,fl) ((GST_VIDEO_FRAME_FLAGS(f) & (fl)) == (fl))
123#define GST_VIDEO_FRAME_IS_INTERLACED(f) (GST_VIDEO_FRAME_FLAG_IS_SET(f, GST_VIDEO_FRAME_FLAG_INTERLACED))
124#define GST_VIDEO_FRAME_IS_TFF(f) (GST_VIDEO_FRAME_FLAG_IS_SET(f, GST_VIDEO_FRAME_FLAG_TFF))
125#define GST_VIDEO_FRAME_IS_RFF(f) (GST_VIDEO_FRAME_FLAG_IS_SET(f, GST_VIDEO_FRAME_FLAG_RFF))
126#define GST_VIDEO_FRAME_IS_ONEFIELD(f) (GST_VIDEO_FRAME_FLAG_IS_SET(f, GST_VIDEO_FRAME_FLAG_ONEFIELD))
127#define GST_VIDEO_FRAME_IS_TOP_FIELD(f) (GST_VIDEO_FRAME_FLAG_IS_SET(f, GST_VIDEO_FRAME_FLAG_TOP_FIELD))
128#define GST_VIDEO_FRAME_IS_BOTTOM_FIELD(f) (GST_VIDEO_FRAME_FLAG_IS_SET(f, GST_VIDEO_FRAME_FLAG_BOTTOM_FIELD))
129
130/* dealing with planes */
131#define GST_VIDEO_FRAME_N_PLANES(f) (GST_VIDEO_INFO_N_PLANES(&(f)->info))
132#define GST_VIDEO_FRAME_PLANE_DATA(f,p) ((f)->data[p])
133#define GST_VIDEO_FRAME_PLANE_OFFSET(f,p) (GST_VIDEO_INFO_PLANE_OFFSET(&(f)->info,(p)))
134#define GST_VIDEO_FRAME_PLANE_STRIDE(f,p) (GST_VIDEO_INFO_PLANE_STRIDE(&(f)->info,(p)))
135
136/* dealing with components */
137#define GST_VIDEO_FRAME_N_COMPONENTS(f) GST_VIDEO_INFO_N_COMPONENTS(&(f)->info)
138#define GST_VIDEO_FRAME_COMP_DEPTH(f,c) GST_VIDEO_INFO_COMP_DEPTH(&(f)->info,(c))
139#define GST_VIDEO_FRAME_COMP_DATA(f,c) GST_VIDEO_INFO_COMP_DATA(&(f)->info,(f)->data,(c))
140#define GST_VIDEO_FRAME_COMP_STRIDE(f,c) GST_VIDEO_INFO_COMP_STRIDE(&(f)->info,(c))
141#define GST_VIDEO_FRAME_COMP_OFFSET(f,c) GST_VIDEO_INFO_COMP_OFFSET(&(f)->info,(c))
142#define GST_VIDEO_FRAME_COMP_WIDTH(f,c) GST_VIDEO_INFO_COMP_WIDTH(&(f)->info,(c))
143#define GST_VIDEO_FRAME_COMP_HEIGHT(f,c) GST_VIDEO_INFO_COMP_HEIGHT(&(f)->info,(c))
144#define GST_VIDEO_FRAME_COMP_PLANE(f,c) GST_VIDEO_INFO_COMP_PLANE(&(f)->info,(c))
145#define GST_VIDEO_FRAME_COMP_PSTRIDE(f,c) GST_VIDEO_INFO_COMP_PSTRIDE(&(f)->info,(c))
146#define GST_VIDEO_FRAME_COMP_POFFSET(f,c) GST_VIDEO_INFO_COMP_POFFSET(&(f)->info,(c))
147
148/* buffer flags */
149
150/**
151 * GstVideoBufferFlags:
152 * @GST_VIDEO_BUFFER_FLAG_INTERLACED: If the #GstBuffer is interlaced. In mixed
153 * interlace-mode, this flags specifies if the frame is
154 * interlaced or progressive.
155 * @GST_VIDEO_BUFFER_FLAG_TFF: If the #GstBuffer is interlaced, then the first field
156 * in the video frame is the top field. If unset, the
157 * bottom field is first.
158 * @GST_VIDEO_BUFFER_FLAG_RFF: If the #GstBuffer is interlaced, then the first field
159 * (as defined by the %GST_VIDEO_BUFFER_FLAG_TFF flag setting)
160 * is repeated.
161 * @GST_VIDEO_BUFFER_FLAG_ONEFIELD: If the #GstBuffer is interlaced, then only the
162 * first field (as defined by the %GST_VIDEO_BUFFER_FLAG_TFF
163 * flag setting) is to be displayed (Since: 1.16).
164 * @GST_VIDEO_BUFFER_FLAG_MULTIPLE_VIEW: The #GstBuffer contains one or more specific views,
165 * such as left or right eye view. This flags is set on
166 * any buffer that contains non-mono content - even for
167 * streams that contain only a single viewpoint. In mixed
168 * mono / non-mono streams, the absense of the flag marks
169 * mono buffers.
170 * @GST_VIDEO_BUFFER_FLAG_FIRST_IN_BUNDLE: When conveying stereo/multiview content with
171 * frame-by-frame methods, this flag marks the first buffer
172 * in a bundle of frames that belong together.
173 * @GST_VIDEO_BUFFER_FLAG_TOP_FIELD: The video frame has the top field only. This is the
174 * same as GST_VIDEO_BUFFER_FLAG_TFF |
175 * GST_VIDEO_BUFFER_FLAG_ONEFIELD (Since: 1.16).
176 * @GST_VIDEO_BUFFER_FLAG_BOTTOM_FIELD: The video frame has the bottom field only. This is
177 * the same as GST_VIDEO_BUFFER_FLAG_ONEFIELD
178 * (GST_VIDEO_BUFFER_FLAG_TFF flag unset) (Since: 1.16).
179 * @GST_VIDEO_BUFFER_FLAG_LAST: Offset to define more flags
180 *
181 * Additional video buffer flags. These flags can potentially be used on any
182 * buffers carrying video data - even encoded data.
183 *
184 * Note that these are only valid for #GstCaps of type: video/...
185 * They can conflict with other extended buffer flags.
186 */
187typedef enum {
188 GST_VIDEO_BUFFER_FLAG_INTERLACED = (GST_BUFFER_FLAG_LAST << 0),
189 GST_VIDEO_BUFFER_FLAG_TFF = (GST_BUFFER_FLAG_LAST << 1),
190 GST_VIDEO_BUFFER_FLAG_RFF = (GST_BUFFER_FLAG_LAST << 2),
191 GST_VIDEO_BUFFER_FLAG_ONEFIELD = (GST_BUFFER_FLAG_LAST << 3),
192
193 GST_VIDEO_BUFFER_FLAG_MULTIPLE_VIEW = (GST_BUFFER_FLAG_LAST << 4),
194 GST_VIDEO_BUFFER_FLAG_FIRST_IN_BUNDLE = (GST_BUFFER_FLAG_LAST << 5),
195
196 GST_VIDEO_BUFFER_FLAG_TOP_FIELD = GST_VIDEO_BUFFER_FLAG_TFF |
197 GST_VIDEO_BUFFER_FLAG_ONEFIELD,
198 GST_VIDEO_BUFFER_FLAG_BOTTOM_FIELD = GST_VIDEO_BUFFER_FLAG_ONEFIELD,
199
200 GST_VIDEO_BUFFER_FLAG_LAST = (GST_BUFFER_FLAG_LAST << 8)
201} GstVideoBufferFlags;
202
203/**
204 * GstVideoFrameMapFlags:
205 * @GST_VIDEO_FRAME_MAP_FLAG_NO_REF: Don't take another reference of the buffer and store it in
206 * the GstVideoFrame. This makes sure that the buffer stays
207 * writable while the frame is mapped, but requires that the
208 * buffer reference stays valid until the frame is unmapped again.
209 * @GST_VIDEO_FRAME_MAP_FLAG_LAST: Offset to define more flags
210 *
211 * Additional mapping flags for gst_video_frame_map().
212 *
213 * Since: 1.6
214 */
215typedef enum {
216 GST_VIDEO_FRAME_MAP_FLAG_NO_REF = (GST_MAP_FLAG_LAST << 0),
217 GST_VIDEO_FRAME_MAP_FLAG_LAST = (GST_MAP_FLAG_LAST << 8)
218 /* 8 more flags possible afterwards */
219} GstVideoFrameMapFlags;
220
221G_END_DECLS
222
223#endif /* __GST_VIDEO_FRAME_H__ */
224