Merge remote-tracking branch 'origin/0.10'
[platform/upstream/gstreamer.git] / gst / videocrop / gstvideocrop.h
1 /* GStreamer video frame cropping
2  * Copyright (C) 2006 Tim-Philipp Müller <tim centricular net>
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., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 #ifndef __GST_VIDEO_CROP_H__
21 #define __GST_VIDEO_CROP_H__
22
23 #include <gst/base/gstbasetransform.h>
24
25 G_BEGIN_DECLS
26
27 #define GST_TYPE_VIDEO_CROP \
28   (gst_video_crop_get_type())
29 #define GST_VIDEO_CROP(obj) \
30   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_VIDEO_CROP,GstVideoCrop))
31 #define GST_VIDEO_CROP_CLASS(klass) \
32   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_VIDEO_CROP,GstVideoCropClass))
33 #define GST_IS_VIDEO_CROP(obj) \
34   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_VIDEO_CROP))
35 #define GST_IS_VIDEO_CROP_CLASS(klass) \
36   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VIDEO_CROP))
37
38 typedef enum {
39   VIDEO_CROP_PIXEL_FORMAT_PACKED_SIMPLE = 0,  /* RGBx, AYUV */
40   VIDEO_CROP_PIXEL_FORMAT_PACKED_COMPLEX,     /* UYVY, YVYU */
41   VIDEO_CROP_PIXEL_FORMAT_PLANAR              /* I420, YV12 */
42 } VideoCropPixelFormat;
43
44 typedef struct _GstVideoCropImageDetails GstVideoCropImageDetails;
45 struct _GstVideoCropImageDetails
46 {
47   /*< private >*/
48   VideoCropPixelFormat  packing;
49
50   GstVideoInfo info;
51
52   /* for packed RGB and YUV */
53   guint8  macro_y_off;            /* for YUY2, YVYU, UYVY, Y offset within macropixel in bytes */
54 };
55
56 typedef struct _GstVideoCrop GstVideoCrop;
57 typedef struct _GstVideoCropClass GstVideoCropClass;
58
59 struct _GstVideoCrop
60 {
61   GstBaseTransform basetransform;
62
63   /*< private >*/
64   gint crop_left;
65   gint crop_right;
66   gint crop_top;
67   gint crop_bottom;
68
69   GstVideoCropImageDetails in;  /* details of input image */
70   GstVideoCropImageDetails out; /* details of output image */
71
72   GMutex lock;
73 };
74
75 struct _GstVideoCropClass
76 {
77   GstBaseTransformClass basetransform_class;
78 };
79
80 GType gst_video_crop_get_type (void);
81
82 G_END_DECLS
83
84 #endif /* __GST_VIDEO_CROP_H__ */
85