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 GST_DEBUG_CATEGORY (videobox_debug);
30 #define GST_CAT_DEFAULT videobox_debug
32 #define GST_TYPE_VIDEO_BOX \
33 (gst_video_box_get_type())
34 #define GST_VIDEO_BOX(obj) \
35 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_VIDEO_BOX,GstVideoBox))
36 #define GST_VIDEO_BOX_CLASS(klass) \
37 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_VIDEO_BOX,GstVideoBoxClass))
38 #define GST_IS_VIDEO_BOX(obj) \
39 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_VIDEO_BOX))
40 #define GST_IS_VIDEO_BOX_CLASS(obj) \
41 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VIDEO_BOX))
43 typedef struct _GstVideoBox GstVideoBox;
44 typedef struct _GstVideoBoxClass GstVideoBoxClass;
56 GstBaseTransform element;
59 gint in_width, in_height;
60 gint out_width, out_height;
62 gint box_left, box_right, box_top, box_bottom;
64 gint border_left, border_right, border_top, border_bottom;
65 gint crop_left, crop_right, crop_top, crop_bottom;
71 GstVideoBoxFill fill_type;
74 struct _GstVideoBoxClass
76 GstBaseTransformClass parent_class;
79 /* elementfactory information */
80 static GstElementDetails gst_video_box_details =
81 GST_ELEMENT_DETAILS ("video box filter",
82 "Filter/Effect/Video",
83 "Resizes a video by adding borders or cropping",
84 "Wim Taymans <wim@fluendo.com>");
87 #define DEFAULT_LEFT 0
88 #define DEFAULT_RIGHT 0
90 #define DEFAULT_BOTTOM 0
91 #define DEFAULT_FILL_TYPE VIDEO_BOX_FILL_BLACK
92 #define DEFAULT_ALPHA 1.0
93 #define DEFAULT_BORDER_ALPHA 1.0
108 static GstStaticPadTemplate gst_video_box_src_template =
109 GST_STATIC_PAD_TEMPLATE ("src",
112 GST_STATIC_CAPS (GST_VIDEO_CAPS_YUV ("{ AYUV, I420 }"))
115 static GstStaticPadTemplate gst_video_box_sink_template =
116 GST_STATIC_PAD_TEMPLATE ("sink",
119 GST_STATIC_CAPS (GST_VIDEO_CAPS_YUV ("I420"))
123 GST_BOILERPLATE (GstVideoBox, gst_video_box, GstBaseTransform,
124 GST_TYPE_BASE_TRANSFORM);
126 static void gst_video_box_set_property (GObject * object, guint prop_id,
127 const GValue * value, GParamSpec * pspec);
128 static void gst_video_box_get_property (GObject * object, guint prop_id,
129 GValue * value, GParamSpec * pspec);
131 static GstCaps *gst_video_box_transform_caps (GstBaseTransform * trans,
132 GstPadDirection direction, GstCaps * from);
133 static gboolean gst_video_box_set_caps (GstBaseTransform * trans,
134 GstCaps * in, GstCaps * out);
135 static gboolean gst_video_box_get_unit_size (GstBaseTransform * trans,
136 GstCaps * caps, guint * size);
137 static GstFlowReturn gst_video_box_transform (GstBaseTransform * trans,
138 GstBuffer * in, GstBuffer * out);
141 #define GST_TYPE_VIDEO_BOX_FILL (gst_video_box_fill_get_type())
143 gst_video_box_fill_get_type (void)
145 static GType video_box_fill_type = 0;
146 static GEnumValue video_box_fill[] = {
147 {VIDEO_BOX_FILL_BLACK, "0", "Black"},
148 {VIDEO_BOX_FILL_GREEN, "1", "Colorkey green"},
149 {VIDEO_BOX_FILL_BLUE, "2", "Colorkey blue"},
153 if (!video_box_fill_type) {
154 video_box_fill_type =
155 g_enum_register_static ("GstVideoBoxFill", video_box_fill);
157 return video_box_fill_type;
162 gst_video_box_base_init (gpointer g_class)
164 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
166 gst_element_class_set_details (element_class, &gst_video_box_details);
168 gst_element_class_add_pad_template (element_class,
169 gst_static_pad_template_get (&gst_video_box_sink_template));
170 gst_element_class_add_pad_template (element_class,
171 gst_static_pad_template_get (&gst_video_box_src_template));
175 gst_video_box_class_init (GstVideoBoxClass * klass)
177 GObjectClass *gobject_class;
178 GstBaseTransformClass *trans_class;
180 gobject_class = (GObjectClass *) klass;
181 trans_class = (GstBaseTransformClass *) klass;
183 gobject_class->set_property = gst_video_box_set_property;
184 gobject_class->get_property = gst_video_box_get_property;
186 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_FILL_TYPE,
187 g_param_spec_enum ("fill", "Fill", "How to fill the borders",
188 GST_TYPE_VIDEO_BOX_FILL, DEFAULT_FILL_TYPE,
189 (GParamFlags) G_PARAM_READWRITE));
190 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_LEFT,
191 g_param_spec_int ("left", "Left",
192 "Pixels to box at left (<0 = add a border)", G_MININT, G_MAXINT,
193 DEFAULT_LEFT, G_PARAM_READWRITE));
194 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_RIGHT,
195 g_param_spec_int ("right", "Right",
196 "Pixels to box at right (<0 = add a border)", G_MININT, G_MAXINT,
197 DEFAULT_RIGHT, G_PARAM_READWRITE));
198 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TOP,
199 g_param_spec_int ("top", "Top",
200 "Pixels to box at top (<0 = add a border)", G_MININT, G_MAXINT,
201 DEFAULT_TOP, G_PARAM_READWRITE));
202 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BOTTOM,
203 g_param_spec_int ("bottom", "Bottom",
204 "Pixels to box at bottom (<0 = add a border)", G_MININT, G_MAXINT,
205 DEFAULT_BOTTOM, G_PARAM_READWRITE));
206 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_ALPHA,
207 g_param_spec_double ("alpha", "Alpha", "Alpha value picture", 0.0, 1.0,
208 DEFAULT_ALPHA, G_PARAM_READWRITE));
209 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BORDER_ALPHA,
210 g_param_spec_double ("border_alpha", "Border Alpha",
211 "Alpha value of the border", 0.0, 1.0, DEFAULT_BORDER_ALPHA,
214 trans_class->transform_caps = gst_video_box_transform_caps;
215 trans_class->set_caps = gst_video_box_set_caps;
216 trans_class->get_unit_size = gst_video_box_get_unit_size;
217 trans_class->transform = gst_video_box_transform;
219 GST_DEBUG_CATEGORY_INIT (videobox_debug, "videobox", 0,
220 "Resizes a video by adding borders or cropping");
224 gst_video_box_init (GstVideoBox * video_box, GstVideoBoxClass * g_class)
226 video_box->box_right = DEFAULT_RIGHT;
227 video_box->box_left = DEFAULT_LEFT;
228 video_box->box_top = DEFAULT_TOP;
229 video_box->box_bottom = DEFAULT_BOTTOM;
230 video_box->crop_right = 0;
231 video_box->crop_left = 0;
232 video_box->crop_top = 0;
233 video_box->crop_bottom = 0;
234 video_box->fill_type = DEFAULT_FILL_TYPE;
235 video_box->alpha = DEFAULT_ALPHA;
236 video_box->border_alpha = DEFAULT_BORDER_ALPHA;
240 gst_video_box_set_property (GObject * object, guint prop_id,
241 const GValue * value, GParamSpec * pspec)
243 GstVideoBox *video_box = GST_VIDEO_BOX (object);
247 video_box->box_left = g_value_get_int (value);
248 if (video_box->box_left < 0) {
249 video_box->border_left = -video_box->box_left;
250 video_box->crop_left = 0;
252 video_box->border_left = 0;
253 video_box->crop_left = video_box->box_left;
257 video_box->box_right = g_value_get_int (value);
258 if (video_box->box_right < 0) {
259 video_box->border_right = -video_box->box_right;
260 video_box->crop_right = 0;
262 video_box->border_right = 0;
263 video_box->crop_right = video_box->box_right;
267 video_box->box_top = g_value_get_int (value);
268 if (video_box->box_top < 0) {
269 video_box->border_top = -video_box->box_top;
270 video_box->crop_top = 0;
272 video_box->border_top = 0;
273 video_box->crop_top = video_box->box_top;
277 video_box->box_bottom = g_value_get_int (value);
278 if (video_box->box_bottom < 0) {
279 video_box->border_bottom = -video_box->box_bottom;
280 video_box->crop_bottom = 0;
282 video_box->border_bottom = 0;
283 video_box->crop_bottom = video_box->box_bottom;
287 video_box->fill_type = g_value_get_enum (value);
290 video_box->alpha = g_value_get_double (value);
292 case PROP_BORDER_ALPHA:
293 video_box->border_alpha = g_value_get_double (value);
296 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
300 if (video_box->box_left == 0 && video_box->box_right == 0 &&
301 video_box->box_top == 0 && video_box->box_bottom == 0)
302 gst_base_transform_set_passthrough (GST_BASE_TRANSFORM (video_box), TRUE);
304 gst_base_transform_set_passthrough (GST_BASE_TRANSFORM (video_box), FALSE);
308 gst_video_box_get_property (GObject * object, guint prop_id, GValue * value,
311 GstVideoBox *video_box = GST_VIDEO_BOX (object);
315 g_value_set_int (value, video_box->box_left);
318 g_value_set_int (value, video_box->box_right);
321 g_value_set_int (value, video_box->box_top);
324 g_value_set_int (value, video_box->box_bottom);
327 g_value_set_enum (value, video_box->fill_type);
330 g_value_set_double (value, video_box->alpha);
332 case PROP_BORDER_ALPHA:
333 g_value_set_double (value, video_box->border_alpha);
336 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
342 gst_video_box_transform_caps (GstBaseTransform * trans,
343 GstPadDirection direction, GstCaps * from)
345 GstVideoBox *video_box;
347 GstStructure *structure;
348 GValue list_value = { 0 }, value = {
352 video_box = GST_VIDEO_BOX (trans);
354 g_value_init (&list_value, GST_TYPE_LIST);
355 g_value_init (&value, GST_TYPE_FOURCC);
356 gst_value_set_fourcc (&value, GST_MAKE_FOURCC ('I', '4', '2', '0'));
357 gst_value_list_append_value (&list_value, &value);
358 g_value_unset (&value);
360 to = gst_caps_copy (from);
361 dir = (direction == GST_PAD_SINK) ? -1 : 1;
363 for (i = 0; i < gst_caps_get_size (to); i++) {
364 structure = gst_caps_get_structure (to, i);
365 if (direction == GST_PAD_SINK) { /* I420 to { I420, AYUV } */
366 g_value_init (&value, GST_TYPE_FOURCC);
367 gst_value_set_fourcc (&value, GST_MAKE_FOURCC ('A', 'Y', 'U', 'V'));
368 gst_value_list_append_value (&list_value, &value);
369 g_value_unset (&value);
370 gst_structure_set_value (structure, "format", &list_value);
371 } else if (direction == GST_PAD_SRC) {
372 gst_structure_set_value (structure, "format", &list_value);
374 if (gst_structure_get_int (structure, "width", &tmp))
375 gst_structure_set (structure, "width", G_TYPE_INT,
376 tmp + dir * (video_box->box_left + video_box->box_right), NULL);
377 if (gst_structure_get_int (structure, "height", &tmp))
378 gst_structure_set (structure, "height", G_TYPE_INT,
379 tmp + dir * (video_box->box_top + video_box->box_bottom), NULL);
382 g_value_unset (&list_value);
384 GST_DEBUG_OBJECT (video_box, "transformed %" GST_PTR_FORMAT
385 " to %" GST_PTR_FORMAT, from, to);
391 gst_video_box_set_caps (GstBaseTransform * trans, GstCaps * in, GstCaps * out)
393 GstVideoBox *video_box;
394 GstStructure *structure;
398 video_box = GST_VIDEO_BOX (trans);
400 structure = gst_caps_get_structure (in, 0);
401 ret = gst_structure_get_int (structure, "width", &video_box->in_width);
402 ret &= gst_structure_get_int (structure, "height", &video_box->in_height);
404 structure = gst_caps_get_structure (out, 0);
405 ret &= gst_structure_get_int (structure, "width", &video_box->out_width);
406 ret &= gst_structure_get_int (structure, "height", &video_box->out_height);
407 ret &= gst_structure_get_fourcc (structure, "format", &fourcc);
409 video_box->use_alpha = fourcc == GST_STR_FOURCC ("AYUV");
414 /* see gst-plugins/gst/games/gstvideoimage.c, paint_setup_I420() */
415 #define GST_VIDEO_I420_Y_ROWSTRIDE(width) (GST_ROUND_UP_4(width))
416 #define GST_VIDEO_I420_U_ROWSTRIDE(width) (GST_ROUND_UP_8(width)/2)
417 #define GST_VIDEO_I420_V_ROWSTRIDE(width) ((GST_ROUND_UP_8(GST_VIDEO_I420_Y_ROWSTRIDE(width)))/2)
419 #define GST_VIDEO_I420_Y_OFFSET(w,h) (0)
420 #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)))
421 #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))
423 #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))
426 gst_video_box_get_unit_size (GstBaseTransform * trans, GstCaps * caps,
429 GstVideoBox *video_box;
430 GstStructure *structure = NULL;
434 g_return_val_if_fail (size, FALSE);
435 video_box = GST_VIDEO_BOX (trans);
437 structure = gst_caps_get_structure (caps, 0);
438 gst_structure_get_fourcc (structure, "format", &fourcc);
439 gst_structure_get_int (structure, "width", &width);
440 gst_structure_get_int (structure, "height", &height);
443 case GST_MAKE_FOURCC ('A', 'Y', 'U', 'V'):
444 *size = width * height * 4;
446 case GST_MAKE_FOURCC ('I', '4', '2', '0'):
447 *size = GST_VIDEO_I420_SIZE (width, height);
457 static int yuv_colors_Y[] = { 16, 150, 29 };
458 static int yuv_colors_U[] = { 128, 46, 255 };
459 static int yuv_colors_V[] = { 128, 21, 107 };
462 gst_video_box_copy_plane_i420 (GstVideoBox * video_box, guint8 * src,
463 guint8 * dest, gint br, gint bl, gint bt, gint bb, gint src_crop_width,
464 gint src_crop_height, gint src_stride, gint dest_width, gint dest_stride,
470 for (j = 0; j < bt; j++) {
471 memset (dest, fill_color, dest_width);
475 /* copy and add left and right border */
476 for (j = 0; j < src_crop_height; j++) {
477 memset (dest, fill_color, bl);
478 memcpy (dest + bl, src, src_crop_width);
479 memset (dest + bl + src_crop_width, fill_color, br);
485 for (j = 0; j < bb; j++) {
486 memset (dest, fill_color, dest_width);
492 gst_video_box_i420 (GstVideoBox * video_box, guint8 * src, guint8 * dest)
494 guint8 *srcY, *srcU, *srcV;
495 guint8 *destY, *destU, *destV;
496 gint crop_width, crop_height;
497 gint out_width, out_height;
498 gint src_width, src_height;
499 gint src_stride, dest_stride;
502 br = video_box->border_right;
503 bl = video_box->border_left;
504 bt = video_box->border_top;
505 bb = video_box->border_bottom;
507 out_width = video_box->out_width;
508 out_height = video_box->out_height;
510 src_width = video_box->in_width;
511 src_height = video_box->in_height;
513 crop_width = src_width - (video_box->crop_left + video_box->crop_right);
514 crop_height = src_height - (video_box->crop_top + video_box->crop_bottom);
517 src_stride = GST_VIDEO_I420_Y_ROWSTRIDE (src_width);
518 dest_stride = GST_VIDEO_I420_Y_ROWSTRIDE (out_width);
520 destY = dest + GST_VIDEO_I420_Y_OFFSET (out_width, out_height);
522 srcY = src + GST_VIDEO_I420_Y_OFFSET (src_width, src_height);
523 srcY += src_stride * video_box->crop_top + video_box->crop_left;
525 gst_video_box_copy_plane_i420 (video_box, srcY, destY, br, bl, bt, bb,
526 crop_width, crop_height, src_stride, out_width, dest_stride,
527 yuv_colors_Y[video_box->fill_type]);
530 src_stride = GST_VIDEO_I420_U_ROWSTRIDE (src_width);
531 dest_stride = GST_VIDEO_I420_U_ROWSTRIDE (out_width);
533 destU = dest + GST_VIDEO_I420_U_OFFSET (out_width, out_height);
535 srcU = src + GST_VIDEO_I420_U_OFFSET (src_width, src_height);
536 srcU += src_stride * (video_box->crop_top / 2) + (video_box->crop_left / 2);
538 gst_video_box_copy_plane_i420 (video_box, srcU, destU, br / 2, bl / 2, bt / 2,
539 bb / 2, crop_width / 2, crop_height / 2, src_stride, out_width / 2,
540 dest_stride, yuv_colors_U[video_box->fill_type]);
543 src_stride = GST_VIDEO_I420_V_ROWSTRIDE (src_width);
544 dest_stride = GST_VIDEO_I420_V_ROWSTRIDE (out_width);
546 destV = dest + GST_VIDEO_I420_V_OFFSET (out_width, out_height);
548 srcV = src + GST_VIDEO_I420_V_OFFSET (src_width, src_height);
549 srcV += src_stride * (video_box->crop_top / 2) + (video_box->crop_left / 2);
551 gst_video_box_copy_plane_i420 (video_box, srcV, destV, br / 2, bl / 2, bt / 2,
552 bb / 2, crop_width / 2, crop_height / 2, src_stride, out_width / 2,
553 dest_stride, yuv_colors_V[video_box->fill_type]);
556 /* Note the source image is always I420, we
557 * are converting to AYUV on the fly here */
560 gst_video_box_ayuv (GstVideoBox * video_box, guint8 * src, guint8 * dest)
562 guint8 *srcY, *srcU, *srcV;
563 gint crop_width, crop_width2, crop_height;
564 gint out_width, out_height;
565 gint src_stridey, src_strideu, src_stridev;
567 gint colorY, colorU, colorV;
569 guint8 b_alpha = (guint8) (video_box->border_alpha * 255);
570 guint8 i_alpha = (guint8) (video_box->alpha * 255);
571 guint32 *destp = (guint32 *) dest;
574 br = video_box->border_right;
575 bl = video_box->border_left;
576 bt = video_box->border_top;
577 bb = video_box->border_bottom;
579 out_width = video_box->out_width;
580 out_height = video_box->out_height;
582 src_stridey = GST_VIDEO_I420_Y_ROWSTRIDE (video_box->in_width);
583 src_strideu = GST_VIDEO_I420_U_ROWSTRIDE (video_box->in_width);
584 src_stridev = GST_VIDEO_I420_V_ROWSTRIDE (video_box->in_width);
587 video_box->in_width - (video_box->crop_left + video_box->crop_right);
588 crop_width2 = crop_width / 2;
590 video_box->in_height - (video_box->crop_top + video_box->crop_bottom);
593 src + GST_VIDEO_I420_Y_OFFSET (video_box->in_width, video_box->in_height);
594 srcY += src_stridey * video_box->crop_top + video_box->crop_left;
596 src + GST_VIDEO_I420_U_OFFSET (video_box->in_width, video_box->in_height);
597 srcU += src_strideu * (video_box->crop_top / 2) + (video_box->crop_left / 2);
599 src + GST_VIDEO_I420_V_OFFSET (video_box->in_width, video_box->in_height);
600 srcV += src_stridev * (video_box->crop_top / 2) + (video_box->crop_left / 2);
602 colorY = yuv_colors_Y[video_box->fill_type];
603 colorU = yuv_colors_U[video_box->fill_type];
604 colorV = yuv_colors_V[video_box->fill_type];
607 GUINT32_FROM_BE ((b_alpha << 24) | (colorY << 16) | (colorU << 8) |
611 for (i = 0; i < bt; i++) {
612 for (j = 0; j < out_width; j++) {
616 for (i = 0; i < crop_height; i++) {
618 for (j = 0; j < bl; j++) {
621 dest = (guint8 *) destp;
623 for (j = 0; j < crop_width2; j++) {
637 srcU += src_strideu - crop_width2;
638 srcV += src_stridev - crop_width2;
640 srcY += src_stridey - crop_width;
642 destp = (guint32 *) dest;
644 for (j = 0; j < br; j++) {
649 for (i = 0; i < bb; i++) {
650 for (j = 0; j < out_width; j++) {
657 gst_video_box_transform (GstBaseTransform * trans, GstBuffer * in,
660 GstVideoBox *video_box;
662 video_box = GST_VIDEO_BOX (trans);
664 if (video_box->use_alpha) {
665 gst_video_box_ayuv (video_box, GST_BUFFER_DATA (in), GST_BUFFER_DATA (out));
667 gst_video_box_i420 (video_box, GST_BUFFER_DATA (in), GST_BUFFER_DATA (out));
674 plugin_init (GstPlugin * plugin)
676 return gst_element_register (plugin, "videobox", GST_RANK_NONE,
680 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
683 "resizes a video by adding borders or cropping",
684 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE, GST_ORIGIN)