2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
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.
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.
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.
24 #include <gst/base/gstbasetransform.h>
25 #include <gst/video/video.h>
29 #define GST_TYPE_VIDEO_BOX \
30 (gst_video_box_get_type())
31 #define GST_VIDEO_BOX(obj) \
32 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_VIDEO_BOX,GstVideoBox))
33 #define GST_VIDEO_BOX_CLASS(klass) \
34 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_VIDEO_BOX,GstVideoBoxClass))
35 #define GST_IS_VIDEO_BOX(obj) \
36 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_VIDEO_BOX))
37 #define GST_IS_VIDEO_BOX_CLASS(obj) \
38 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VIDEO_BOX))
40 typedef struct _GstVideoBox GstVideoBox;
41 typedef struct _GstVideoBoxClass GstVideoBoxClass;
53 GstBaseTransform element;
56 gint in_width, in_height;
57 gint out_width, out_height;
59 gint box_left, box_right, box_top, box_bottom;
61 gint border_left, border_right, border_top, border_bottom;
62 gint crop_left, crop_right, crop_top, crop_bottom;
68 GstVideoBoxFill fill_type;
71 struct _GstVideoBoxClass
73 GstBaseTransformClass parent_class;
76 /* elementfactory information */
77 static GstElementDetails gst_video_box_details =
78 GST_ELEMENT_DETAILS ("video box filter",
79 "Filter/Effect/Video",
80 "Resizes a video by adding borders or cropping",
81 "Wim Taymans <wim@fluendo.com>");
84 #define DEFAULT_LEFT 0
85 #define DEFAULT_RIGHT 0
87 #define DEFAULT_BOTTOM 0
88 #define DEFAULT_FILL_TYPE VIDEO_BOX_FILL_BLACK
89 #define DEFAULT_ALPHA 1.0
90 #define DEFAULT_BORDER_ALPHA 1.0
105 static GstStaticPadTemplate gst_video_box_src_template =
106 GST_STATIC_PAD_TEMPLATE ("src",
109 GST_STATIC_CAPS (GST_VIDEO_CAPS_YUV ("{ AYUV, I420 }"))
112 static GstStaticPadTemplate gst_video_box_sink_template =
113 GST_STATIC_PAD_TEMPLATE ("sink",
116 GST_STATIC_CAPS (GST_VIDEO_CAPS_YUV ("I420"))
120 GST_BOILERPLATE (GstVideoBox, gst_video_box, GstBaseTransform,
121 GST_TYPE_BASE_TRANSFORM);
123 static void gst_video_box_set_property (GObject * object, guint prop_id,
124 const GValue * value, GParamSpec * pspec);
125 static void gst_video_box_get_property (GObject * object, guint prop_id,
126 GValue * value, GParamSpec * pspec);
128 static GstCaps *gst_video_box_transform_caps (GstBaseTransform * trans,
129 GstPadDirection direction, GstCaps * from);
130 static gboolean gst_video_box_set_caps (GstBaseTransform * trans,
131 GstCaps * in, GstCaps * out);
132 static gboolean gst_video_box_get_unit_size (GstBaseTransform * trans,
133 GstCaps * caps, guint * size);
134 static GstFlowReturn gst_video_box_transform (GstBaseTransform * trans,
135 GstBuffer * in, GstBuffer * out);
138 #define GST_TYPE_VIDEO_BOX_FILL (gst_video_box_fill_get_type())
140 gst_video_box_fill_get_type (void)
142 static GType video_box_fill_type = 0;
143 static GEnumValue video_box_fill[] = {
144 {VIDEO_BOX_FILL_BLACK, "0", "Black"},
145 {VIDEO_BOX_FILL_GREEN, "1", "Colorkey green"},
146 {VIDEO_BOX_FILL_BLUE, "2", "Colorkey blue"},
150 if (!video_box_fill_type) {
151 video_box_fill_type =
152 g_enum_register_static ("GstVideoBoxFill", video_box_fill);
154 return video_box_fill_type;
159 gst_video_box_base_init (gpointer g_class)
161 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
163 gst_element_class_set_details (element_class, &gst_video_box_details);
165 gst_element_class_add_pad_template (element_class,
166 gst_static_pad_template_get (&gst_video_box_sink_template));
167 gst_element_class_add_pad_template (element_class,
168 gst_static_pad_template_get (&gst_video_box_src_template));
172 gst_video_box_class_init (GstVideoBoxClass * klass)
174 GObjectClass *gobject_class;
175 GstBaseTransformClass *trans_class;
177 gobject_class = (GObjectClass *) klass;
178 trans_class = (GstBaseTransformClass *) klass;
180 gobject_class->set_property = gst_video_box_set_property;
181 gobject_class->get_property = gst_video_box_get_property;
183 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_FILL_TYPE,
184 g_param_spec_enum ("fill", "Fill", "How to fill the borders",
185 GST_TYPE_VIDEO_BOX_FILL, DEFAULT_FILL_TYPE,
186 (GParamFlags) G_PARAM_READWRITE));
187 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_LEFT,
188 g_param_spec_int ("left", "Left",
189 "Pixels to box at left (<0 = add a border)", G_MININT, G_MAXINT,
190 DEFAULT_LEFT, G_PARAM_READWRITE));
191 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_RIGHT,
192 g_param_spec_int ("right", "Right",
193 "Pixels to box at right (<0 = add a border)", G_MININT, G_MAXINT,
194 DEFAULT_RIGHT, G_PARAM_READWRITE));
195 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TOP,
196 g_param_spec_int ("top", "Top",
197 "Pixels to box at top (<0 = add a border)", G_MININT, G_MAXINT,
198 DEFAULT_TOP, G_PARAM_READWRITE));
199 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BOTTOM,
200 g_param_spec_int ("bottom", "Bottom",
201 "Pixels to box at bottom (<0 = add a border)", G_MININT, G_MAXINT,
202 DEFAULT_BOTTOM, G_PARAM_READWRITE));
203 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_ALPHA,
204 g_param_spec_double ("alpha", "Alpha", "Alpha value picture", 0.0, 1.0,
205 DEFAULT_ALPHA, G_PARAM_READWRITE));
206 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BORDER_ALPHA,
207 g_param_spec_double ("border_alpha", "Border Alpha",
208 "Alpha value of the border", 0.0, 1.0, DEFAULT_BORDER_ALPHA,
211 trans_class->transform_caps = gst_video_box_transform_caps;
212 trans_class->set_caps = gst_video_box_set_caps;
213 trans_class->get_unit_size = gst_video_box_get_unit_size;
214 trans_class->transform = gst_video_box_transform;
218 gst_video_box_init (GstVideoBox * video_box, GstVideoBoxClass * g_class)
220 video_box->box_right = DEFAULT_RIGHT;
221 video_box->box_left = DEFAULT_LEFT;
222 video_box->box_top = DEFAULT_TOP;
223 video_box->box_bottom = DEFAULT_BOTTOM;
224 video_box->crop_right = 0;
225 video_box->crop_left = 0;
226 video_box->crop_top = 0;
227 video_box->crop_bottom = 0;
228 video_box->fill_type = DEFAULT_FILL_TYPE;
229 video_box->alpha = DEFAULT_ALPHA;
230 video_box->border_alpha = DEFAULT_BORDER_ALPHA;
234 gst_video_box_set_property (GObject * object, guint prop_id,
235 const GValue * value, GParamSpec * pspec)
237 GstVideoBox *video_box = GST_VIDEO_BOX (object);
241 video_box->box_left = g_value_get_int (value);
242 if (video_box->box_left < 0) {
243 video_box->border_left = -video_box->box_left;
244 video_box->crop_left = 0;
246 video_box->border_left = 0;
247 video_box->crop_left = video_box->box_left;
251 video_box->box_right = g_value_get_int (value);
252 if (video_box->box_right < 0) {
253 video_box->border_right = -video_box->box_right;
254 video_box->crop_right = 0;
256 video_box->border_right = 0;
257 video_box->crop_right = video_box->box_right;
261 video_box->box_top = g_value_get_int (value);
262 if (video_box->box_top < 0) {
263 video_box->border_top = -video_box->box_top;
264 video_box->crop_top = 0;
266 video_box->border_top = 0;
267 video_box->crop_top = video_box->box_top;
271 video_box->box_bottom = g_value_get_int (value);
272 if (video_box->box_bottom < 0) {
273 video_box->border_bottom = -video_box->box_bottom;
274 video_box->crop_bottom = 0;
276 video_box->border_bottom = 0;
277 video_box->crop_bottom = video_box->box_bottom;
281 video_box->fill_type = g_value_get_enum (value);
284 video_box->alpha = g_value_get_double (value);
286 case PROP_BORDER_ALPHA:
287 video_box->border_alpha = g_value_get_double (value);
290 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
294 if (video_box->box_left == 0 && video_box->box_right == 0 &&
295 video_box->box_top == 0 && video_box->box_bottom == 0)
296 gst_base_transform_set_passthrough (GST_BASE_TRANSFORM (video_box), TRUE);
298 gst_base_transform_set_passthrough (GST_BASE_TRANSFORM (video_box), FALSE);
301 gst_video_box_get_property (GObject * object, guint prop_id, GValue * value,
304 GstVideoBox *video_box = GST_VIDEO_BOX (object);
308 g_value_set_int (value, video_box->box_left);
311 g_value_set_int (value, video_box->box_right);
314 g_value_set_int (value, video_box->box_top);
317 g_value_set_int (value, video_box->box_bottom);
320 g_value_set_enum (value, video_box->fill_type);
323 g_value_set_double (value, video_box->alpha);
325 case PROP_BORDER_ALPHA:
326 g_value_set_double (value, video_box->border_alpha);
329 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
335 gst_video_box_transform_caps (GstBaseTransform * trans,
336 GstPadDirection direction, GstCaps * from)
338 GstVideoBox *video_box;
340 GstStructure *structure;
343 video_box = GST_VIDEO_BOX (trans);
344 to = gst_caps_copy (from);
345 dir = (direction == GST_PAD_SINK) ? -1 : 1;
347 /* FIXME, include AYUV */
348 for (i = 0; i < gst_caps_get_size (to); i++) {
349 structure = gst_caps_get_structure (to, i);
350 if (gst_structure_get_int (structure, "width", &tmp))
351 gst_structure_set (structure, "width", G_TYPE_INT,
352 tmp + dir * (video_box->box_left + video_box->box_right), NULL);
353 if (gst_structure_get_int (structure, "height", &tmp))
354 gst_structure_set (structure, "height", G_TYPE_INT,
355 tmp + dir * (video_box->box_top + video_box->box_bottom), NULL);
362 gst_video_box_set_caps (GstBaseTransform * trans, GstCaps * in, GstCaps * out)
364 GstVideoBox *video_box;
365 GstStructure *structure;
369 video_box = GST_VIDEO_BOX (trans);
371 structure = gst_caps_get_structure (in, 0);
372 ret = gst_structure_get_int (structure, "width", &video_box->in_width);
373 ret &= gst_structure_get_int (structure, "height", &video_box->in_height);
375 structure = gst_caps_get_structure (out, 0);
376 ret &= gst_structure_get_int (structure, "width", &video_box->out_width);
377 ret &= gst_structure_get_int (structure, "height", &video_box->out_height);
378 ret &= gst_structure_get_fourcc (structure, "format", &fourcc);
380 video_box->use_alpha = fourcc == GST_STR_FOURCC ("AYUV");
385 /* see gst-plugins/gst/games/gstvideoimage.c, paint_setup_I420() */
386 #define GST_VIDEO_I420_Y_ROWSTRIDE(width) (GST_ROUND_UP_4(width))
387 #define GST_VIDEO_I420_U_ROWSTRIDE(width) (GST_ROUND_UP_8(width)/2)
388 #define GST_VIDEO_I420_V_ROWSTRIDE(width) ((GST_ROUND_UP_8(GST_VIDEO_I420_Y_ROWSTRIDE(width)))/2)
390 #define GST_VIDEO_I420_Y_OFFSET(w,h) (0)
391 #define GST_VIDEO_I420_U_OFFSET(w,h) (GST_VIDEO_I420_Y_OFFSET(w,h)+(GST_VIDEO_I420_Y_ROWSTRIDE(w)*GST_ROUND_UP_2(h)))
392 #define GST_VIDEO_I420_V_OFFSET(w,h) (GST_VIDEO_I420_U_OFFSET(w,h)+(GST_VIDEO_I420_U_ROWSTRIDE(w)*GST_ROUND_UP_2(h)/2))
394 #define GST_VIDEO_I420_SIZE(w,h) (GST_VIDEO_I420_V_OFFSET(w,h)+(GST_VIDEO_I420_V_ROWSTRIDE(w)*GST_ROUND_UP_2(h)/2))
397 gst_video_box_get_unit_size (GstBaseTransform * trans, GstCaps * caps,
400 GstVideoBox *video_box;
401 GstStructure *structure = NULL;
405 g_return_val_if_fail (size, FALSE);
406 video_box = GST_VIDEO_BOX (trans);
408 structure = gst_caps_get_structure (caps, 0);
409 gst_structure_get_fourcc (structure, "format", &fourcc);
410 gst_structure_get_int (structure, "width", &width);
411 gst_structure_get_int (structure, "height", &height);
414 case GST_MAKE_FOURCC ('A', 'Y', 'U', 'V'):
415 *size = width * height * 4;
417 case GST_MAKE_FOURCC ('I', '4', '2', '0'):
418 *size = GST_VIDEO_I420_SIZE (width, height);
428 static int yuv_colors_Y[] = { 16, 150, 29 };
429 static int yuv_colors_U[] = { 128, 46, 255 };
430 static int yuv_colors_V[] = { 128, 21, 107 };
433 gst_video_box_copy_plane_i420 (GstVideoBox * video_box, guint8 * src,
434 guint8 * dest, gint br, gint bl, gint bt, gint bb, gint src_crop_width,
435 gint src_crop_height, gint src_stride, gint dest_width, gint dest_stride,
441 for (j = 0; j < bt; j++) {
442 memset (dest, fill_color, dest_width);
446 /* copy and add left and right border */
447 for (j = 0; j < src_crop_height; j++) {
448 memset (dest, fill_color, bl);
449 memcpy (dest + bl, src, src_crop_width);
450 memset (dest + bl + src_crop_width, fill_color, br);
456 for (j = 0; j < bb; j++) {
457 memset (dest, fill_color, dest_width);
463 gst_video_box_i420 (GstVideoBox * video_box, guint8 * src, guint8 * dest)
465 guint8 *srcY, *srcU, *srcV;
466 guint8 *destY, *destU, *destV;
467 gint crop_width, crop_height;
468 gint out_width, out_height;
469 gint src_width, src_height;
470 gint src_stride, dest_stride;
473 br = video_box->border_right;
474 bl = video_box->border_left;
475 bt = video_box->border_top;
476 bb = video_box->border_bottom;
478 out_width = video_box->out_width;
479 out_height = video_box->out_height;
481 src_width = video_box->in_width;
482 src_height = video_box->in_height;
484 crop_width = src_width - (video_box->crop_left + video_box->crop_right);
485 crop_height = src_height - (video_box->crop_top + video_box->crop_bottom);
488 src_stride = GST_VIDEO_I420_Y_ROWSTRIDE (src_width);
489 dest_stride = GST_VIDEO_I420_Y_ROWSTRIDE (out_width);
491 destY = dest + GST_VIDEO_I420_Y_OFFSET (out_width, out_height);
493 srcY = src + GST_VIDEO_I420_Y_OFFSET (src_width, src_height);
494 srcY += src_stride * video_box->crop_top + video_box->crop_left;
496 gst_video_box_copy_plane_i420 (video_box, srcY, destY, br, bl, bt, bb,
497 crop_width, crop_height, src_stride, out_width, dest_stride,
498 yuv_colors_Y[video_box->fill_type]);
501 src_stride = GST_VIDEO_I420_U_ROWSTRIDE (src_width);
502 dest_stride = GST_VIDEO_I420_U_ROWSTRIDE (out_width);
504 destU = dest + GST_VIDEO_I420_U_OFFSET (out_width, out_height);
506 srcU = src + GST_VIDEO_I420_U_OFFSET (src_width, src_height);
507 srcU += src_stride * (video_box->crop_top / 2) + (video_box->crop_left / 2);
509 gst_video_box_copy_plane_i420 (video_box, srcU, destU, br / 2, bl / 2, bt / 2,
510 bb / 2, crop_width / 2, crop_height / 2, src_stride, out_width / 2,
511 dest_stride, yuv_colors_U[video_box->fill_type]);
514 src_stride = GST_VIDEO_I420_V_ROWSTRIDE (src_width);
515 dest_stride = GST_VIDEO_I420_V_ROWSTRIDE (out_width);
517 destV = dest + GST_VIDEO_I420_V_OFFSET (out_width, out_height);
519 srcV = src + GST_VIDEO_I420_V_OFFSET (src_width, src_height);
520 srcV += src_stride * (video_box->crop_top / 2) + (video_box->crop_left / 2);
522 gst_video_box_copy_plane_i420 (video_box, srcV, destV, br / 2, bl / 2, bt / 2,
523 bb / 2, crop_width / 2, crop_height / 2, src_stride, out_width / 2,
524 dest_stride, yuv_colors_V[video_box->fill_type]);
527 /* Note the source image is always I420, we
528 * are converting to AYUV on the fly here */
531 gst_video_box_ayuv (GstVideoBox * video_box, guint8 * src, guint8 * dest)
533 guint8 *srcY, *srcU, *srcV;
534 gint crop_width, crop_width2, crop_height;
535 gint out_width, out_height;
536 gint src_stride, src_stride2;
538 gint colorY, colorU, colorV;
540 guint8 b_alpha = (guint8) (video_box->border_alpha * 255);
541 guint8 i_alpha = (guint8) (video_box->alpha * 255);
542 guint32 *destp = (guint32 *) dest;
545 br = video_box->border_right;
546 bl = video_box->border_left;
547 bt = video_box->border_top;
548 bb = video_box->border_bottom;
550 out_width = video_box->out_width;
551 out_height = video_box->out_height;
553 src_stride = GST_VIDEO_I420_Y_ROWSTRIDE (video_box->in_width);
554 src_stride2 = src_stride / 2;
557 video_box->in_width - (video_box->crop_left + video_box->crop_right);
558 crop_width2 = crop_width / 2;
560 video_box->in_height - (video_box->crop_top + video_box->crop_bottom);
563 src + GST_VIDEO_I420_Y_OFFSET (video_box->in_width, video_box->in_height);
564 srcY += src_stride * video_box->crop_top + video_box->crop_left;
566 src + GST_VIDEO_I420_U_OFFSET (video_box->in_width, video_box->in_height);
567 srcU += src_stride2 * (video_box->crop_top / 2) + (video_box->crop_left / 2);
569 src + GST_VIDEO_I420_V_OFFSET (video_box->in_width, video_box->in_height);
570 srcV += src_stride2 * (video_box->crop_top / 2) + (video_box->crop_left / 2);
572 colorY = yuv_colors_Y[video_box->fill_type];
573 colorU = yuv_colors_U[video_box->fill_type];
574 colorV = yuv_colors_V[video_box->fill_type];
577 GUINT32_FROM_BE ((b_alpha << 24) | (colorY << 16) | (colorU << 8) |
581 for (i = 0; i < bt; i++) {
582 for (j = 0; j < out_width; j++) {
586 for (i = 0; i < crop_height; i++) {
588 for (j = 0; j < bl; j++) {
591 dest = (guint8 *) destp;
593 for (j = 0; j < crop_width2; j++) {
607 srcU += src_stride2 - crop_width2;
608 srcV += src_stride2 - crop_width2;
610 srcY += src_stride - crop_width;
612 destp = (guint32 *) dest;
614 for (j = 0; j < br; j++) {
619 for (i = 0; i < bb; i++) {
620 for (j = 0; j < out_width; j++) {
627 gst_video_box_transform (GstBaseTransform * trans, GstBuffer * in,
630 GstVideoBox *video_box;
632 video_box = GST_VIDEO_BOX (trans);
634 if (video_box->use_alpha) {
635 gst_video_box_ayuv (video_box, GST_BUFFER_DATA (in), GST_BUFFER_DATA (out));
637 gst_video_box_i420 (video_box, GST_BUFFER_DATA (in), GST_BUFFER_DATA (out));
644 plugin_init (GstPlugin * plugin)
646 return gst_element_register (plugin, "videobox", GST_RANK_NONE,
650 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
653 "resizes a video by adding borders or cropping",
654 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE, GST_ORIGIN)