1 /*****************************************************************************
2 * jpeg.c: jpeg decoder module making use of libjpeg.
3 *****************************************************************************
4 * Copyright (C) 2013-2014 VLC authors and VideoLAN
6 * Authors: Maxim Bublis <b@codemonkey.ru>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU Lesser General Public License as published by
10 * the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
27 #include <vlc_common.h>
28 #include <vlc_plugin.h>
29 #include <vlc_codec.h>
33 /* JPEG_SYS_COMMON_MEMBERS:
34 * members common to encoder and decoder descriptors
36 #define JPEG_SYS_COMMON_MEMBERS \
38 /* libjpeg error handler manager */ \
39 struct jpeg_error_mgr err; \
41 /* setjmp buffer for internal libjpeg error handling */ \
42 jmp_buf setjmp_buffer; \
44 vlc_object_t *p_obj; \
48 #define ENC_CFG_PREFIX "sout-jpeg-"
49 #define ENC_QUALITY_TEXT N_("Quality level")
50 #define ENC_QUALITY_LONGTEXT N_("Quality level " \
51 "for encoding (this can enlarge or reduce output image size).")
55 * jpeg common descriptor
59 JPEG_SYS_COMMON_MEMBERS
62 typedef struct jpeg_sys_t jpeg_sys_t;
65 * jpeg decoder descriptor
69 JPEG_SYS_COMMON_MEMBERS
71 struct jpeg_decompress_struct p_jpeg;
74 static int OpenDecoder(vlc_object_t *);
75 static void CloseDecoder(vlc_object_t *);
77 static picture_t *DecodeBlock(decoder_t *, block_t **);
80 * jpeg encoder descriptor
84 JPEG_SYS_COMMON_MEMBERS
86 struct jpeg_compress_struct p_jpeg;
92 static const char * const ppsz_enc_options[] = {
97 static int OpenEncoder(vlc_object_t *);
98 static void CloseEncoder(vlc_object_t *);
100 static block_t *EncodeBlock(encoder_t *, picture_t *);
106 set_category(CAT_INPUT)
107 set_subcategory(SUBCAT_INPUT_VCODEC)
108 /* decoder main module */
109 set_description(N_("JPEG image decoder"))
110 set_capability("decoder", 1000)
111 set_callbacks(OpenDecoder, CloseDecoder)
114 /* encoder submodule */
117 set_section(N_("Encoding"), NULL)
118 set_description(N_("JPEG image encoder"))
119 set_capability("encoder", 1000)
120 set_callbacks(OpenEncoder, CloseEncoder)
121 add_integer_with_range(ENC_CFG_PREFIX "quality", 95, 0, 100,
122 ENC_QUALITY_TEXT, ENC_QUALITY_LONGTEXT, true)
127 * Exit error handler for libjpeg
129 static void user_error_exit(j_common_ptr p_jpeg)
131 jpeg_sys_t *p_sys = (jpeg_sys_t *)p_jpeg->err;
132 p_sys->err.output_message(p_jpeg);
133 longjmp(p_sys->setjmp_buffer, 1);
137 * Emit message error handler for libjpeg
139 static void user_error_message(j_common_ptr p_jpeg)
141 char error_msg[JMSG_LENGTH_MAX];
143 jpeg_sys_t *p_sys = (jpeg_sys_t *)p_jpeg->err;
144 p_sys->err.format_message(p_jpeg, error_msg);
145 msg_Err(p_sys->p_obj, "%s", error_msg);
149 * Probe the decoder and return score
151 static int OpenDecoder(vlc_object_t *p_this)
153 decoder_t *p_dec = (decoder_t *)p_this;
155 if (p_dec->fmt_in.i_codec != VLC_CODEC_JPEG)
160 /* Allocate the memory needed to store the decoder's structure */
161 decoder_sys_t *p_sys = malloc(sizeof(decoder_sys_t));
167 p_dec->p_sys = p_sys;
169 p_sys->p_obj = p_this;
171 p_sys->p_jpeg.err = jpeg_std_error(&p_sys->err);
172 p_sys->err.error_exit = user_error_exit;
173 p_sys->err.output_message = user_error_message;
175 /* Set output properties */
176 p_dec->fmt_out.i_cat = VIDEO_ES;
179 p_dec->pf_decode_video = DecodeBlock;
185 * This function must be fed with a complete compressed frame.
187 static picture_t *DecodeBlock(decoder_t *p_dec, block_t **pp_block)
189 decoder_sys_t *p_sys = p_dec->p_sys;
191 picture_t *p_pic = 0;
193 JSAMPARRAY p_row_pointers = NULL;
195 if (!pp_block || !*pp_block)
202 if (p_block->i_flags & BLOCK_FLAG_DISCONTINUITY)
204 block_Release(p_block);
209 /* libjpeg longjmp's there in case of error */
210 if (setjmp(p_sys->setjmp_buffer))
215 jpeg_create_decompress(&p_sys->p_jpeg);
216 jpeg_mem_src(&p_sys->p_jpeg, p_block->p_buffer, p_block->i_buffer);
217 jpeg_read_header(&p_sys->p_jpeg, TRUE);
219 p_sys->p_jpeg.out_color_space = JCS_RGB;
221 jpeg_start_decompress(&p_sys->p_jpeg);
223 /* Set output properties */
224 p_dec->fmt_out.i_codec = VLC_CODEC_RGB24;
225 p_dec->fmt_out.video.i_visible_width = p_dec->fmt_out.video.i_width = p_sys->p_jpeg.output_width;
226 p_dec->fmt_out.video.i_visible_height = p_dec->fmt_out.video.i_height = p_sys->p_jpeg.output_height;
227 p_dec->fmt_out.video.i_sar_num = 1;
228 p_dec->fmt_out.video.i_sar_den = 1;
229 p_dec->fmt_out.video.i_rmask = 0x000000ff;
230 p_dec->fmt_out.video.i_gmask = 0x0000ff00;
231 p_dec->fmt_out.video.i_bmask = 0x00ff0000;
233 /* Get a new picture */
234 p_pic = decoder_NewPicture(p_dec);
241 p_row_pointers = malloc(sizeof(JSAMPROW) * p_sys->p_jpeg.output_height);
246 for (unsigned i = 0; i < p_sys->p_jpeg.output_height; i++) {
247 p_row_pointers[i] = p_pic->p->p_pixels + p_pic->p->i_pitch * i;
250 while (p_sys->p_jpeg.output_scanline < p_sys->p_jpeg.output_height)
252 jpeg_read_scanlines(&p_sys->p_jpeg,
253 p_row_pointers + p_sys->p_jpeg.output_scanline,
254 p_sys->p_jpeg.output_height - p_sys->p_jpeg.output_scanline);
257 jpeg_finish_decompress(&p_sys->p_jpeg);
258 jpeg_destroy_decompress(&p_sys->p_jpeg);
259 free(p_row_pointers);
261 p_pic->date = p_block->i_pts > VLC_TS_INVALID ? p_block->i_pts : p_block->i_dts;
263 block_Release(p_block);
270 jpeg_destroy_decompress(&p_sys->p_jpeg);
271 free(p_row_pointers);
273 block_Release(p_block);
280 * jpeg decoder destruction
282 static void CloseDecoder(vlc_object_t *p_this)
284 decoder_t *p_dec = (decoder_t *)p_this;
285 decoder_sys_t *p_sys = p_dec->p_sys;
291 * Probe the encoder and return score
293 static int OpenEncoder(vlc_object_t *p_this)
295 encoder_t *p_enc = (encoder_t *)p_this;
297 config_ChainParse(p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg);
299 if (p_enc->fmt_out.i_codec != VLC_CODEC_JPEG)
304 /* Allocate the memory needed to store encoder's structure */
305 encoder_sys_t *p_sys = malloc(sizeof(encoder_sys_t));
311 p_enc->p_sys = p_sys;
313 p_sys->p_obj = p_this;
315 p_sys->p_jpeg.err = jpeg_std_error(&p_sys->err);
316 p_sys->err.error_exit = user_error_exit;
317 p_sys->err.output_message = user_error_message;
319 p_sys->i_quality = var_GetInteger(p_enc, ENC_CFG_PREFIX "quality");
320 p_sys->i_blocksize = 3 * p_enc->fmt_in.video.i_visible_width * p_enc->fmt_in.video.i_visible_height;
322 p_enc->fmt_in.i_codec = VLC_CODEC_J420;
323 p_enc->pf_encode_video = EncodeBlock;
331 static block_t *EncodeBlock(encoder_t *p_enc, picture_t *p_pic)
333 encoder_sys_t *p_sys = p_enc->p_sys;
335 if (unlikely(!p_pic))
339 block_t *p_block = block_Alloc(p_sys->i_blocksize);
345 JSAMPIMAGE p_row_pointers = NULL;
347 /* libjpeg longjmp's there in case of error */
348 if (setjmp(p_sys->setjmp_buffer))
353 jpeg_create_compress(&p_sys->p_jpeg);
354 jpeg_mem_dest(&p_sys->p_jpeg, &p_block->p_buffer, &p_block->i_buffer);
356 p_sys->p_jpeg.image_width = p_enc->fmt_in.video.i_visible_width;
357 p_sys->p_jpeg.image_height = p_enc->fmt_in.video.i_visible_height;
358 p_sys->p_jpeg.input_components = 3;
359 p_sys->p_jpeg.in_color_space = JCS_YCbCr;
361 jpeg_set_defaults(&p_sys->p_jpeg);
362 jpeg_set_colorspace(&p_sys->p_jpeg, JCS_YCbCr);
364 p_sys->p_jpeg.raw_data_in = TRUE;
365 #if JPEG_LIB_VERSION >= 70
366 p_sys->p_jpeg.do_fancy_downsampling = FALSE;
369 jpeg_set_quality(&p_sys->p_jpeg, p_sys->i_quality, TRUE);
371 jpeg_start_compress(&p_sys->p_jpeg, TRUE);
374 p_row_pointers = malloc(sizeof(JSAMPARRAY) * p_pic->i_planes);
375 if (p_row_pointers == NULL)
380 for (int i = 0; i < p_pic->i_planes; i++)
382 p_row_pointers[i] = malloc(sizeof(JSAMPROW) * p_sys->p_jpeg.comp_info[i].v_samp_factor * DCTSIZE);
385 while (p_sys->p_jpeg.next_scanline < p_sys->p_jpeg.image_height)
387 for (int i = 0; i < p_pic->i_planes; i++)
389 int i_offset = p_sys->p_jpeg.next_scanline * p_sys->p_jpeg.comp_info[i].v_samp_factor / p_sys->p_jpeg.max_v_samp_factor;
391 for (int j = 0; j < p_sys->p_jpeg.comp_info[i].v_samp_factor * DCTSIZE; j++)
393 p_row_pointers[i][j] = p_pic->p[i].p_pixels + p_pic->p[i].i_pitch * (i_offset + j);
396 jpeg_write_raw_data(&p_sys->p_jpeg, p_row_pointers, p_sys->p_jpeg.max_v_samp_factor * DCTSIZE);
399 jpeg_finish_compress(&p_sys->p_jpeg);
400 jpeg_destroy_compress(&p_sys->p_jpeg);
402 for (int i = 0; i < p_pic->i_planes; i++)
404 free(p_row_pointers[i]);
406 free(p_row_pointers);
408 p_block->i_dts = p_block->i_pts = p_pic->date;
413 jpeg_destroy_compress(&p_sys->p_jpeg);
415 if (p_row_pointers != NULL)
417 for (int i = 0; i < p_pic->i_planes; i++)
419 free(p_row_pointers[i]);
422 free(p_row_pointers);
424 block_Release(p_block);
430 * jpeg encoder destruction
432 static void CloseEncoder(vlc_object_t *p_this)
434 encoder_t *p_enc = (encoder_t *)p_this;
435 encoder_sys_t *p_sys = p_enc->p_sys;