2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3 * Copyright (C) 2012 Collabora Ltd.
4 * Author : Edward Hervey <edward@collabora.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
22 * SECTION:element-jpegenc
24 * Encodes jpeg images.
27 * <title>Example launch line</title>
29 * gst-launch-1.0 videotestsrc num-buffers=50 ! video/x-raw, framerate='(fraction)'5/1 ! jpegenc ! avimux ! filesink location=mjpeg.avi
30 * ]| a pipeline to mux 5 JPEG frames per second into a 10 sec. long motion jpeg
40 #include "gstjpegenc.h"
42 #include <gst/video/video.h>
43 #include <gst/video/gstvideometa.h>
44 #include <gst/base/base.h>
47 /* setting smoothig seems to have no effect in libjepeg
48 #define ENABLE_SMOOTHING 1
51 GST_DEBUG_CATEGORY_STATIC (jpegenc_debug);
52 #define GST_CAT_DEFAULT jpegenc_debug
54 #define JPEG_DEFAULT_QUALITY 85
55 #define JPEG_DEFAULT_SMOOTHING 0
56 #define JPEG_DEFAULT_IDCT_METHOD JDCT_FASTEST
57 #define JPEG_DEFAULT_SNAPSHOT FALSE
59 /* JpegEnc signals and args */
75 static void gst_jpegenc_finalize (GObject * object);
77 static void gst_jpegenc_resync (GstJpegEnc * jpegenc);
78 static void gst_jpegenc_set_property (GObject * object, guint prop_id,
79 const GValue * value, GParamSpec * pspec);
80 static void gst_jpegenc_get_property (GObject * object, guint prop_id,
81 GValue * value, GParamSpec * pspec);
83 static gboolean gst_jpegenc_start (GstVideoEncoder * benc);
84 static gboolean gst_jpegenc_stop (GstVideoEncoder * benc);
85 static gboolean gst_jpegenc_set_format (GstVideoEncoder * encoder,
86 GstVideoCodecState * state);
87 static GstFlowReturn gst_jpegenc_handle_frame (GstVideoEncoder * encoder,
88 GstVideoCodecFrame * frame);
89 static gboolean gst_jpegenc_propose_allocation (GstVideoEncoder * encoder,
92 /* static guint gst_jpegenc_signals[LAST_SIGNAL] = { 0 }; */
94 #define gst_jpegenc_parent_class parent_class
95 G_DEFINE_TYPE (GstJpegEnc, gst_jpegenc, GST_TYPE_VIDEO_ENCODER);
98 static GstStaticPadTemplate gst_jpegenc_sink_pad_template =
99 GST_STATIC_PAD_TEMPLATE ("sink",
102 GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE
103 ("{ I420, YV12, YUY2, UYVY, Y41B, Y42B, YVYU, Y444, NV21, "
104 "NV12, RGB, BGR, RGBx, xRGB, BGRx, xBGR, GRAY8 }"))
108 static GstStaticPadTemplate gst_jpegenc_src_pad_template =
109 GST_STATIC_PAD_TEMPLATE ("src",
112 GST_STATIC_CAPS ("image/jpeg, "
113 "width = (int) [ 16, 65535 ], "
114 "height = (int) [ 16, 65535 ], "
115 "framerate = (fraction) [ 0/1, MAX ], "
116 "sof-marker = (int) { 0, 1, 2, 9 }")
120 gst_jpegenc_class_init (GstJpegEncClass * klass)
122 GObjectClass *gobject_class;
123 GstElementClass *element_class;
124 GstVideoEncoderClass *venc_class;
126 gobject_class = (GObjectClass *) klass;
127 element_class = (GstElementClass *) klass;
128 venc_class = (GstVideoEncoderClass *) klass;
130 parent_class = g_type_class_peek_parent (klass);
132 gobject_class->finalize = gst_jpegenc_finalize;
133 gobject_class->set_property = gst_jpegenc_set_property;
134 gobject_class->get_property = gst_jpegenc_get_property;
136 g_object_class_install_property (gobject_class, PROP_QUALITY,
137 g_param_spec_int ("quality", "Quality", "Quality of encoding",
138 0, 100, JPEG_DEFAULT_QUALITY,
139 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
140 GST_PARAM_MUTABLE_PLAYING));
142 #ifdef ENABLE_SMOOTHING
143 /* disabled, since it doesn't seem to work */
144 g_object_class_install_property (gobject_class, PROP_SMOOTHING,
145 g_param_spec_int ("smoothing", "Smoothing", "Smoothing factor",
146 0, 100, JPEG_DEFAULT_SMOOTHING,
147 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
150 g_object_class_install_property (gobject_class, PROP_IDCT_METHOD,
151 g_param_spec_enum ("idct-method", "IDCT Method",
152 "The IDCT algorithm to use", GST_TYPE_IDCT_METHOD,
153 JPEG_DEFAULT_IDCT_METHOD,
154 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
156 * GstJpegEnc:snapshot:
158 * Send EOS after encoding a frame, useful for snapshots.
162 g_object_class_install_property (gobject_class, PROP_SNAPSHOT,
163 g_param_spec_boolean ("snapshot", "Snapshot",
164 "Send EOS after encoding a frame, useful for snapshots",
165 JPEG_DEFAULT_SNAPSHOT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
167 gst_element_class_add_static_pad_template (element_class,
168 &gst_jpegenc_sink_pad_template);
169 gst_element_class_add_static_pad_template (element_class,
170 &gst_jpegenc_src_pad_template);
172 gst_element_class_set_static_metadata (element_class, "JPEG image encoder",
173 "Codec/Encoder/Image", "Encode images in JPEG format",
174 "Wim Taymans <wim.taymans@tvd.be>");
176 venc_class->start = gst_jpegenc_start;
177 venc_class->stop = gst_jpegenc_stop;
178 venc_class->set_format = gst_jpegenc_set_format;
179 venc_class->handle_frame = gst_jpegenc_handle_frame;
180 venc_class->propose_allocation = gst_jpegenc_propose_allocation;
182 GST_DEBUG_CATEGORY_INIT (jpegenc_debug, "jpegenc", 0,
183 "JPEG encoding element");
187 gst_jpegenc_init_destination (j_compress_ptr cinfo)
189 GST_DEBUG ("gst_jpegenc_chain: init_destination");
193 ensure_memory (GstJpegEnc * jpegenc)
195 GstMemory *new_memory;
197 gsize old_size, desired_size, new_size;
199 static GstAllocationParams params = { 0, 3, 0, 0, };
201 old_size = jpegenc->output_map.size;
203 desired_size = jpegenc->bufsize;
205 desired_size = old_size * 2;
207 /* Our output memory wasn't big enough.
208 * Make a new memory that's twice the size, */
209 new_memory = gst_allocator_alloc (NULL, desired_size, ¶ms);
210 gst_memory_map (new_memory, &map, GST_MAP_READWRITE);
214 /* copy previous data if any */
215 if (jpegenc->output_mem) {
216 memcpy (new_data, jpegenc->output_map.data, old_size);
217 gst_memory_unmap (jpegenc->output_mem, &jpegenc->output_map);
218 gst_memory_unref (jpegenc->output_mem);
221 /* drop it into place, */
222 jpegenc->output_mem = new_memory;
223 jpegenc->output_map = map;
225 /* and last, update libjpeg on where to work. */
226 jpegenc->jdest.next_output_byte = new_data + old_size;
227 jpegenc->jdest.free_in_buffer = new_size - old_size;
231 gst_jpegenc_flush_destination (j_compress_ptr cinfo)
233 GstJpegEnc *jpegenc = (GstJpegEnc *) (cinfo->client_data);
235 GST_DEBUG_OBJECT (jpegenc,
236 "gst_jpegenc_chain: flush_destination: buffer too small");
238 ensure_memory (jpegenc);
244 gst_jpegenc_term_destination (j_compress_ptr cinfo)
247 GstJpegEnc *jpegenc = (GstJpegEnc *) (cinfo->client_data);
248 gsize memory_size = jpegenc->output_map.size - jpegenc->jdest.free_in_buffer;
249 GstByteReader reader =
250 GST_BYTE_READER_INIT (jpegenc->output_map.data, memory_size);
252 gint sof_marker = -1;
254 GST_DEBUG_OBJECT (jpegenc, "gst_jpegenc_chain: term_source");
256 /* Find the SOF marker */
257 while (gst_byte_reader_get_uint16_be (&reader, &marker)) {
259 if (marker >> 4 == 0x0ffc) {
260 sof_marker = marker & 0x4;
265 gst_memory_unmap (jpegenc->output_mem, &jpegenc->output_map);
266 /* Trim the buffer size. we will push it in the chain function */
267 gst_memory_resize (jpegenc->output_mem, 0, memory_size);
268 jpegenc->output_map.data = NULL;
269 jpegenc->output_map.size = 0;
271 if (jpegenc->sof_marker != sof_marker || jpegenc->input_caps_changed) {
272 GstVideoCodecState *output;
274 gst_video_encoder_set_output_state (GST_VIDEO_ENCODER (jpegenc),
275 gst_caps_new_simple ("image/jpeg", "sof-marker", G_TYPE_INT, sof_marker,
276 NULL), jpegenc->input_state);
277 gst_video_codec_state_unref (output);
278 jpegenc->sof_marker = sof_marker;
279 jpegenc->input_caps_changed = FALSE;
282 outbuf = gst_buffer_new ();
283 gst_buffer_copy_into (outbuf, jpegenc->current_frame->input_buffer,
284 GST_BUFFER_COPY_METADATA, 0, -1);
285 gst_buffer_append_memory (outbuf, jpegenc->output_mem);
286 jpegenc->output_mem = NULL;
288 jpegenc->current_frame->output_buffer = outbuf;
290 gst_video_frame_unmap (&jpegenc->current_vframe);
292 GST_VIDEO_CODEC_FRAME_SET_SYNC_POINT (jpegenc->current_frame);
294 jpegenc->res = gst_video_encoder_finish_frame (GST_VIDEO_ENCODER (jpegenc),
295 jpegenc->current_frame);
296 jpegenc->current_frame = NULL;
300 gst_jpegenc_init (GstJpegEnc * jpegenc)
302 GST_PAD_SET_ACCEPT_TEMPLATE (GST_VIDEO_ENCODER_SINK_PAD (jpegenc));
305 memset (&jpegenc->cinfo, 0, sizeof (jpegenc->cinfo));
306 memset (&jpegenc->jerr, 0, sizeof (jpegenc->jerr));
307 jpegenc->cinfo.err = jpeg_std_error (&jpegenc->jerr);
308 jpeg_create_compress (&jpegenc->cinfo);
310 jpegenc->jdest.init_destination = gst_jpegenc_init_destination;
311 jpegenc->jdest.empty_output_buffer = gst_jpegenc_flush_destination;
312 jpegenc->jdest.term_destination = gst_jpegenc_term_destination;
313 jpegenc->cinfo.dest = &jpegenc->jdest;
314 jpegenc->cinfo.client_data = jpegenc;
316 /* init properties */
317 jpegenc->quality = JPEG_DEFAULT_QUALITY;
318 jpegenc->smoothing = JPEG_DEFAULT_SMOOTHING;
319 jpegenc->idct_method = JPEG_DEFAULT_IDCT_METHOD;
320 jpegenc->snapshot = JPEG_DEFAULT_SNAPSHOT;
324 gst_jpegenc_finalize (GObject * object)
326 GstJpegEnc *filter = GST_JPEGENC (object);
328 jpeg_destroy_compress (&filter->cinfo);
330 if (filter->input_state)
331 gst_video_codec_state_unref (filter->input_state);
333 G_OBJECT_CLASS (parent_class)->finalize (object);
337 gst_jpegenc_set_format (GstVideoEncoder * encoder, GstVideoCodecState * state)
339 GstJpegEnc *enc = GST_JPEGENC (encoder);
341 GstVideoInfo *info = &state->info;
343 if (enc->input_state)
344 gst_video_codec_state_unref (enc->input_state);
345 enc->input_state = gst_video_codec_state_ref (state);
347 /* prepare a cached image description */
348 enc->channels = GST_VIDEO_INFO_N_COMPONENTS (info);
350 /* ... but any alpha is disregarded in encoding */
351 if (GST_VIDEO_INFO_IS_GRAY (info))
356 for (i = 0; i < enc->channels; ++i) {
357 enc->cwidth[i] = GST_VIDEO_INFO_COMP_WIDTH (info, i);
358 enc->cheight[i] = GST_VIDEO_INFO_COMP_HEIGHT (info, i);
359 enc->inc[i] = GST_VIDEO_INFO_COMP_PSTRIDE (info, i);
361 GST_ROUND_UP_4 (GST_VIDEO_INFO_WIDTH (info)) / enc->cwidth[i];
362 enc->h_max_samp = MAX (enc->h_max_samp, enc->h_samp[i]);
364 GST_ROUND_UP_4 (GST_VIDEO_INFO_HEIGHT (info)) / enc->cheight[i];
365 enc->v_max_samp = MAX (enc->v_max_samp, enc->v_samp[i]);
367 /* samp should only be 1, 2 or 4 */
368 g_assert (enc->h_max_samp <= 4);
369 g_assert (enc->v_max_samp <= 4);
372 /* maximum is invariant, as one of the components should have samp 1 */
373 for (i = 0; i < enc->channels; ++i) {
374 GST_DEBUG ("%d %d", enc->h_samp[i], enc->h_max_samp);
375 enc->h_samp[i] = enc->h_max_samp / enc->h_samp[i];
376 enc->v_samp[i] = enc->v_max_samp / enc->v_samp[i];
378 enc->planar = (enc->inc[0] == 1 && enc->inc[1] == 1 && enc->inc[2] == 1);
380 enc->input_caps_changed = TRUE;
381 gst_jpegenc_resync (enc);
387 gst_jpegenc_resync (GstJpegEnc * jpegenc)
393 GST_DEBUG_OBJECT (jpegenc, "resync");
395 if (!jpegenc->input_state)
398 info = &jpegenc->input_state->info;
400 jpegenc->cinfo.image_width = width = GST_VIDEO_INFO_WIDTH (info);
401 jpegenc->cinfo.image_height = height = GST_VIDEO_INFO_HEIGHT (info);
402 jpegenc->cinfo.input_components = jpegenc->channels;
404 GST_DEBUG_OBJECT (jpegenc, "width %d, height %d", width, height);
405 GST_DEBUG_OBJECT (jpegenc, "format %d", GST_VIDEO_INFO_FORMAT (info));
407 if (GST_VIDEO_INFO_IS_RGB (info)) {
408 GST_DEBUG_OBJECT (jpegenc, "RGB");
409 jpegenc->cinfo.in_color_space = JCS_RGB;
410 } else if (GST_VIDEO_INFO_IS_GRAY (info)) {
411 GST_DEBUG_OBJECT (jpegenc, "gray");
412 jpegenc->cinfo.in_color_space = JCS_GRAYSCALE;
414 GST_DEBUG_OBJECT (jpegenc, "YUV");
415 jpegenc->cinfo.in_color_space = JCS_YCbCr;
418 /* input buffer size as max output */
419 jpegenc->bufsize = GST_VIDEO_INFO_SIZE (info);
420 jpeg_set_defaults (&jpegenc->cinfo);
421 jpegenc->cinfo.raw_data_in = TRUE;
422 /* duh, libjpeg maps RGB to YUV ... and don't expect some conversion */
423 if (jpegenc->cinfo.in_color_space == JCS_RGB)
424 jpeg_set_colorspace (&jpegenc->cinfo, JCS_RGB);
426 GST_DEBUG_OBJECT (jpegenc, "h_max_samp=%d, v_max_samp=%d",
427 jpegenc->h_max_samp, jpegenc->v_max_samp);
428 /* image dimension info */
429 for (i = 0; i < jpegenc->channels; i++) {
430 GST_DEBUG_OBJECT (jpegenc, "comp %i: h_samp=%d, v_samp=%d", i,
431 jpegenc->h_samp[i], jpegenc->v_samp[i]);
432 jpegenc->cinfo.comp_info[i].h_samp_factor = jpegenc->h_samp[i];
433 jpegenc->cinfo.comp_info[i].v_samp_factor = jpegenc->v_samp[i];
434 g_free (jpegenc->line[i]);
435 jpegenc->line[i] = g_new (guchar *, jpegenc->v_max_samp * DCTSIZE);
436 if (!jpegenc->planar) {
437 for (j = 0; j < jpegenc->v_max_samp * DCTSIZE; j++) {
438 g_free (jpegenc->row[i][j]);
439 jpegenc->row[i][j] = g_malloc (width);
440 jpegenc->line[i][j] = jpegenc->row[i][j];
445 /* guard against a potential error in gst_jpegenc_term_destination
446 which occurs iff bufsize % 4 < free_space_remaining */
447 jpegenc->bufsize = GST_ROUND_UP_4 (jpegenc->bufsize);
449 jpeg_suppress_tables (&jpegenc->cinfo, TRUE);
451 GST_DEBUG_OBJECT (jpegenc, "resync done");
455 gst_jpegenc_handle_frame (GstVideoEncoder * encoder, GstVideoCodecFrame * frame)
459 guchar *base[3], *end[3];
462 static GstAllocationParams params = { 0, 0, 0, 3, };
464 jpegenc = GST_JPEGENC (encoder);
466 GST_LOG_OBJECT (jpegenc, "got new frame");
468 if (!gst_video_frame_map (&jpegenc->current_vframe,
469 &jpegenc->input_state->info, frame->input_buffer, GST_MAP_READ))
472 jpegenc->current_frame = frame;
474 height = GST_VIDEO_INFO_HEIGHT (&jpegenc->input_state->info);
476 for (i = 0; i < jpegenc->channels; i++) {
477 base[i] = GST_VIDEO_FRAME_COMP_DATA (&jpegenc->current_vframe, i);
478 stride[i] = GST_VIDEO_FRAME_COMP_STRIDE (&jpegenc->current_vframe, i);
480 base[i] + GST_VIDEO_FRAME_COMP_HEIGHT (&jpegenc->current_vframe,
484 jpegenc->res = GST_FLOW_OK;
485 jpegenc->output_mem = gst_allocator_alloc (NULL, jpegenc->bufsize, ¶ms);
486 gst_memory_map (jpegenc->output_mem, &jpegenc->output_map, GST_MAP_READWRITE);
488 jpegenc->jdest.next_output_byte = jpegenc->output_map.data;
489 jpegenc->jdest.free_in_buffer = jpegenc->output_map.size;
491 /* prepare for raw input */
492 #if JPEG_LIB_VERSION >= 70
493 jpegenc->cinfo.do_fancy_downsampling = FALSE;
496 GST_OBJECT_LOCK (jpegenc);
497 jpegenc->cinfo.smoothing_factor = jpegenc->smoothing;
498 jpegenc->cinfo.dct_method = jpegenc->idct_method;
499 jpeg_set_quality (&jpegenc->cinfo, jpegenc->quality, TRUE);
500 GST_OBJECT_UNLOCK (jpegenc);
502 jpeg_start_compress (&jpegenc->cinfo, TRUE);
504 GST_LOG_OBJECT (jpegenc, "compressing");
506 if (jpegenc->planar) {
507 for (i = 0; i < height; i += jpegenc->v_max_samp * DCTSIZE) {
508 for (k = 0; k < jpegenc->channels; k++) {
509 for (j = 0; j < jpegenc->v_samp[k] * DCTSIZE; j++) {
510 jpegenc->line[k][j] = base[k];
511 if (base[k] + stride[k] < end[k])
512 base[k] += stride[k];
515 jpeg_write_raw_data (&jpegenc->cinfo, jpegenc->line,
516 jpegenc->v_max_samp * DCTSIZE);
519 for (i = 0; i < height; i += jpegenc->v_max_samp * DCTSIZE) {
520 for (k = 0; k < jpegenc->channels; k++) {
521 for (j = 0; j < jpegenc->v_samp[k] * DCTSIZE; j++) {
525 /* ouch, copy line */
527 dst = jpegenc->line[k][j];
528 for (l = jpegenc->cwidth[k]; l > 0; l--) {
530 src += jpegenc->inc[k];
533 if (base[k] + stride[k] < end[k])
534 base[k] += stride[k];
537 jpeg_write_raw_data (&jpegenc->cinfo, jpegenc->line,
538 jpegenc->v_max_samp * DCTSIZE);
542 /* This will ensure that gst_jpegenc_term_destination is called */
543 jpeg_finish_compress (&jpegenc->cinfo);
544 GST_LOG_OBJECT (jpegenc, "compressing done");
546 return (jpegenc->snapshot) ? GST_FLOW_EOS : jpegenc->res;
550 GST_WARNING_OBJECT (jpegenc, "invalid frame received");
551 return gst_video_encoder_finish_frame (encoder, frame);
556 gst_jpegenc_propose_allocation (GstVideoEncoder * encoder, GstQuery * query)
558 gst_query_add_allocation_meta (query, GST_VIDEO_META_API_TYPE, NULL);
560 return GST_VIDEO_ENCODER_CLASS (parent_class)->propose_allocation (encoder,
565 gst_jpegenc_set_property (GObject * object, guint prop_id,
566 const GValue * value, GParamSpec * pspec)
568 GstJpegEnc *jpegenc = GST_JPEGENC (object);
570 GST_OBJECT_LOCK (jpegenc);
574 jpegenc->quality = g_value_get_int (value);
576 #ifdef ENABLE_SMOOTHING
578 jpegenc->smoothing = g_value_get_int (value);
581 case PROP_IDCT_METHOD:
582 jpegenc->idct_method = g_value_get_enum (value);
585 jpegenc->snapshot = g_value_get_boolean (value);
588 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
592 GST_OBJECT_UNLOCK (jpegenc);
596 gst_jpegenc_get_property (GObject * object, guint prop_id, GValue * value,
599 GstJpegEnc *jpegenc = GST_JPEGENC (object);
601 GST_OBJECT_LOCK (jpegenc);
605 g_value_set_int (value, jpegenc->quality);
607 #ifdef ENABLE_SMOOTHING
609 g_value_set_int (value, jpegenc->smoothing);
612 case PROP_IDCT_METHOD:
613 g_value_set_enum (value, jpegenc->idct_method);
616 g_value_set_boolean (value, jpegenc->snapshot);
619 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
623 GST_OBJECT_UNLOCK (jpegenc);
627 gst_jpegenc_start (GstVideoEncoder * benc)
629 GstJpegEnc *enc = (GstJpegEnc *) benc;
634 enc->sof_marker = -1;
640 gst_jpegenc_stop (GstVideoEncoder * benc)
642 GstJpegEnc *enc = (GstJpegEnc *) benc;
645 g_free (enc->line[0]);
646 g_free (enc->line[1]);
647 g_free (enc->line[2]);
651 for (i = 0; i < 3; i++) {
652 for (j = 0; j < 4 * DCTSIZE; j++) {
653 g_free (enc->row[i][j]);
654 enc->row[i][j] = NULL;