1 /*****************************************************************************
2 * image.c: Image demuxer
3 *****************************************************************************
4 * Copyright (C) 2010 Laurent Aimar
7 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_demux.h>
35 #include <vlc_image.h>
37 /*****************************************************************************
39 *****************************************************************************/
40 static int Open (vlc_object_t *);
41 static void Close(vlc_object_t *);
43 #define ID_TEXT N_("ES ID")
44 #define ID_LONGTEXT N_( \
45 "Set the ID of the elementary stream")
47 #define GROUP_TEXT N_("Group")
48 #define GROUP_LONGTEXT N_(\
49 "Set the group of the elementary stream")
51 #define DECODE_TEXT N_("Decode")
52 #define DECODE_LONGTEXT N_( \
53 "Decode at the demuxer stage")
55 #define CHROMA_TEXT N_("Forced chroma")
56 #define CHROMA_LONGTEXT N_( \
57 "If non empty and image-decode is true, the image will be " \
58 "converted to the specified chroma.")
60 #define DURATION_TEXT N_("Duration in second")
61 #define DURATION_LONGTEXT N_( \
62 "Duration in second before simulating an end of file. " \
63 "A negative value means an unlimited play time.")
65 #define FPS_TEXT N_("Frame rate")
66 #define FPS_LONGTEXT N_( \
67 "Frame rate of the elementary stream produced.")
69 #define RT_TEXT N_("Real-time")
70 #define RT_LONGTEXT N_( \
71 "Use real-time mode suitable for being used as a master input and " \
72 "real-time input slaves.")
75 set_description(N_("Image demuxer"))
76 set_category(CAT_INPUT)
77 set_subcategory(SUBCAT_INPUT_DEMUX)
78 add_integer("image-id", -1, NULL, ID_TEXT, ID_LONGTEXT, true)
80 add_integer("image-group", 0, NULL, GROUP_TEXT, GROUP_LONGTEXT, true)
82 add_bool("image-decode", true, NULL, DECODE_TEXT, DECODE_LONGTEXT, true)
84 add_string("image-chroma", "", NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true)
86 add_float("image-duration", 10, NULL, DURATION_TEXT, DURATION_LONGTEXT, true)
88 add_string("image-fps", "10/1", NULL, FPS_TEXT, FPS_LONGTEXT, true)
90 add_bool("image-realtime", false, NULL, RT_TEXT, RT_LONGTEXT, true)
92 set_capability("demux", 10)
93 set_callbacks(Open, Close)
96 /*****************************************************************************
98 *****************************************************************************/
110 static block_t *Load(demux_t *demux)
112 const int max_size = 4096 * 4096 * 8;
113 const int64_t size = stream_Size(demux->s);
114 if (size < 0 || size > max_size) {
115 msg_Err(demux, "Rejecting image based on its size (%"PRId64" > %d)", size, max_size);
120 return stream_Block(demux->s, size);
125 static block_t *Decode(demux_t *demux,
126 video_format_t *fmt, vlc_fourcc_t chroma, block_t *data)
128 image_handler_t *handler = image_HandlerCreate(demux);
134 video_format_t decoded;
135 video_format_Init(&decoded, chroma);
137 picture_t *image = image_Read(handler, data, fmt, &decoded);
138 image_HandlerDelete(handler);
143 video_format_Clean(fmt);
147 for (int i = 0; i < image->i_planes; i++)
148 size += image->p[i].i_visible_pitch *
149 image->p[i].i_visible_lines;
151 data = block_New(demux, size);
153 picture_Release(image);
158 for (int i = 0; i < image->i_planes; i++) {
159 const plane_t *src = &image->p[i];
160 for (int y = 0; y < src->i_visible_lines; y++) {
161 memcpy(&data->p_buffer[offset],
162 &src->p_pixels[y * src->i_pitch],
163 src->i_visible_pitch);
164 offset += src->i_visible_pitch;
168 picture_Release(image);
172 static int Demux(demux_t *demux)
174 demux_sys_t *sys = demux->p_sys;
180 const mtime_t pts_first = sys->pts_origin + date_Get(&sys->pts);
181 if (sys->pts_next > VLC_TS_INVALID) {
182 deadline = sys->pts_next;
183 } else if (sys->is_realtime) {
185 const mtime_t max_wait = CLOCK_FREQ / 50;
186 if (deadline + max_wait < pts_first) {
187 es_out_Control(demux->out, ES_OUT_SET_PCR, deadline);
188 /* That's ugly, but not yet easily fixable */
189 mwait(deadline + max_wait);
193 deadline = 1 + pts_first;
197 const mtime_t pts = sys->pts_origin + date_Get(&sys->pts);
198 if (sys->duration >= 0 && pts >= sys->pts_origin + sys->duration)
204 block_t *data = block_Duplicate(sys->data);
209 data->i_pts = VLC_TS_0 + pts;
210 es_out_Control(demux->out, ES_OUT_SET_PCR, data->i_pts);
211 es_out_Send(demux->out, sys->es, data);
213 date_Increment(&sys->pts, 1);
217 static int Control(demux_t *demux, int query, va_list args)
219 demux_sys_t *sys = demux->p_sys;
222 case DEMUX_GET_POSITION: {
223 double *position = va_arg(args, double *);
224 if (sys->duration > 0)
225 *position = date_Get(&sys->pts) / (double)sys->duration;
230 case DEMUX_SET_POSITION: {
231 if (sys->duration < 0 || sys->is_realtime)
233 double position = va_arg(args, double);
234 date_Set(&sys->pts, position * sys->duration);
237 case DEMUX_GET_TIME: {
238 int64_t *time = va_arg(args, int64_t *);
239 *time = sys->pts_origin + date_Get(&sys->pts);
242 case DEMUX_SET_TIME: {
243 if (sys->duration < 0 || sys->is_realtime)
245 int64_t time = va_arg(args, int64_t);
246 date_Set(&sys->pts, __MIN(__MAX(time - sys->pts_origin, 0),
250 case DEMUX_SET_NEXT_DEMUX_TIME: {
251 int64_t pts_next = VLC_TS_0 + va_arg(args, int64_t);
252 if (sys->pts_next <= VLC_TS_INVALID)
253 sys->pts_origin = pts_next;
254 sys->pts_next = pts_next;
257 case DEMUX_GET_LENGTH: {
258 int64_t *length = va_arg(args, int64_t *);
259 *length = __MAX(sys->duration, 0);
262 case DEMUX_GET_FPS: {
263 double *fps = va_arg(args, double *);
264 *fps = (double)sys->pts.i_divider_num / sys->pts.i_divider_den;
268 case DEMUX_HAS_UNSUPPORTED_META:
269 case DEMUX_GET_ATTACHMENTS:
275 static bool IsBmp(stream_t *s)
277 const uint8_t *header;
278 if (stream_Peek(s, &header, 18) < 18)
280 if (memcmp(header, "BM", 2) &&
281 memcmp(header, "BA", 2) &&
282 memcmp(header, "CI", 2) &&
283 memcmp(header, "CP", 2) &&
284 memcmp(header, "IC", 2) &&
285 memcmp(header, "PT", 2))
287 uint32_t file_size = GetDWLE(&header[2]);
288 uint32_t data_offset = GetDWLE(&header[10]);
289 uint32_t header_size = GetDWLE(&header[14]);
290 if (file_size != 14 && file_size != 14 + header_size &&
291 file_size <= data_offset)
293 if (data_offset < header_size + 14)
295 if (header_size != 12 && header_size < 40)
300 static bool IsPcx(stream_t *s)
302 const uint8_t *header;
303 if (stream_Peek(s, &header, 66) < 66)
305 if (header[0] != 0x0A || /* marker */
306 (header[1] != 0x00 && header[1] != 0x02 &&
307 header[1] != 0x03 && header[1] != 0x05) || /* version */
308 (header[2] != 0 && header[2] != 1) || /* encoding */
309 (header[3] != 1 && header[3] != 2 &&
310 header[3] != 4 && header[3] != 8) || /* bits per pixel per plane */
311 header[64] != 0 || /* reserved */
312 header[65] == 0 || header[65] > 4) /* plane count */
314 if (GetWLE(&header[4]) > GetWLE(&header[8]) || /* xmin vs xmax */
315 GetWLE(&header[6]) > GetWLE(&header[10])) /* ymin vs ymax */
320 static bool IsLbm(stream_t *s)
322 const uint8_t *header;
323 if (stream_Peek(s, &header, 12) < 12)
325 if (memcmp(&header[0], "FORM", 4) ||
326 GetDWBE(&header[4]) <= 4 ||
327 (memcmp(&header[8], "ILBM", 4) && memcmp(&header[8], "PBM ", 4)))
331 static bool IsPnmBlank(uint8_t v)
333 return v == ' ' || v == '\t' || v == '\r' || v == '\n';
335 static bool IsPnm(stream_t *s)
337 const uint8_t *header;
338 int size = stream_Peek(s, &header, 256);
341 if (header[0] != 'P' ||
342 header[1] < '1' || header[1] > '6' ||
343 !IsPnmBlank(header[2]))
346 int number_count = 0;
347 for (int i = 3, parsing_number = 0; i < size && number_count < 2; i++) {
348 if (IsPnmBlank(header[i])) {
349 if (parsing_number) {
354 if (header[i] < '0' || header[i] > '9')
359 if (number_count < 2)
364 static uint8_t FindJpegMarker(int *position, const uint8_t *data, int size)
366 for (int i = *position; i + 1 < size; i++) {
367 if (data[i + 0] != 0xff || data[i + 1] == 0x00)
369 if (data[i + 1] != 0xff) {
376 static bool IsJfif(stream_t *s)
378 const uint8_t *header;
379 int size = stream_Peek(s, &header, 256);
382 if (FindJpegMarker(&position, header, size) != 0xd8)
384 if (FindJpegMarker(&position, header, size) != 0xe0)
386 position += 2; /* Skip size */
387 if (position + 5 > size)
389 if (memcmp(&header[position], "JFIF\0", 5))
394 static bool IsSpiff(stream_t *s)
396 const uint8_t *header;
397 if (stream_Peek(s, &header, 36) < 36) /* SPIFF header size */
399 if (header[0] != 0xff || header[1] != 0xd8 ||
400 header[2] != 0xff || header[3] != 0xe8)
402 if (memcmp(&header[6], "SPIFF\0", 6))
410 const uint8_t marker[14];
411 bool (*detect)(stream_t *s);
414 #define VLC_CODEC_XCF VLC_FOURCC('X', 'C', 'F', ' ')
415 #define VLC_CODEC_LBM VLC_FOURCC('L', 'B', 'M', ' ')
416 static const image_format_t formats[] = {
417 { .codec = VLC_CODEC_XCF,
418 .marker_size = 9 + 4 + 1,
419 .marker = { 'g', 'i', 'm', 'p', ' ', 'x', 'c', 'f', ' ',
420 'f', 'i', 'l', 'e', '\0' }
422 { .codec = VLC_CODEC_XCF,
423 .marker_size = 9 + 4 + 1,
424 .marker = { 'g', 'i', 'm', 'p', ' ', 'x', 'c', 'f', ' ',
425 'v', '0', '0', '1', '\0' }
427 { .codec = VLC_CODEC_XCF,
428 .marker_size = 9 + 4 + 1,
429 .marker = { 'g', 'i', 'm', 'p', ' ', 'x', 'c', 'f', ' ',
430 'v', '0', '0', '2', '\0' }
432 { .codec = VLC_CODEC_PNG,
434 .marker = { 0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A }
436 { .codec = VLC_CODEC_GIF,
438 .marker = { 'G', 'I', 'F', '8', '7', 'a' }
440 { .codec = VLC_CODEC_GIF,
442 .marker = { 'G', 'I', 'F', '8', '9', 'a' }
444 /* XXX TIFF detection may be a bit weak */
445 { .codec = VLC_CODEC_TIFF,
447 .marker = { 'I', 'I', 0x2a, 0x00 },
449 { .codec = VLC_CODEC_TIFF,
451 .marker = { 'M', 'M', 0x00, 0x2a },
453 { .codec = VLC_CODEC_BMP,
456 { .codec = VLC_CODEC_PCX,
459 { .codec = VLC_CODEC_LBM,
462 { .codec = VLC_CODEC_PNM,
465 { .codec = VLC_CODEC_JPEG,
468 { .codec = VLC_CODEC_JPEG,
474 static int Open(vlc_object_t *object)
476 demux_t *demux = (demux_t*)object;
478 /* Detect the image type */
479 const image_format_t *img;
483 for (int i = 0; ; i++) {
489 if (img->detect(demux->s))
492 if (peek_size < img->marker_size)
493 peek_size = stream_Peek(demux->s, &peek, img->marker_size);
494 if (peek_size >= img->marker_size &&
495 !memcmp(peek, img->marker, img->marker_size))
499 msg_Dbg(demux, "Detected image: %s",
500 vlc_fourcc_GetDescription(VIDEO_ES, img->codec));
502 /* Load and if selected decode */
504 es_format_Init(&fmt, VIDEO_ES, img->codec);
505 fmt.video.i_chroma = fmt.i_codec;
507 block_t *data = Load(demux);
508 if (data && var_InheritBool(demux, "image-decode")) {
509 char *string = var_InheritString(demux, "image-chroma");
510 vlc_fourcc_t chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, string);
513 data = Decode(demux, &fmt.video, chroma, data);
514 fmt.i_codec = fmt.video.i_chroma;
516 fmt.i_id = var_InheritInteger(demux, "image-id");
517 fmt.i_group = var_InheritInteger(demux, "image-group");
518 if (var_InheritURational(demux,
519 &fmt.video.i_frame_rate,
520 &fmt.video.i_frame_rate_base,
522 fmt.video.i_frame_rate <= 0 || fmt.video.i_frame_rate_base <= 0) {
523 msg_Err(demux, "Invalid frame rate, using 10/1 instead");
524 fmt.video.i_frame_rate = 10;
525 fmt.video.i_frame_rate_base = 1;
528 /* If loadind failed, we still continue to avoid mis-detection
529 * by other demuxers. */
531 msg_Err(demux, "Failed to load the image");
534 demux_sys_t *sys = malloc(sizeof(*sys));
538 es_format_Clean(&fmt);
543 sys->es = es_out_Add(demux->out, &fmt);
544 sys->duration = CLOCK_FREQ * var_InheritFloat(demux, "image-duration");
545 sys->is_realtime = var_InheritBool(demux, "image-realtime");
546 sys->pts_origin = sys->is_realtime ? mdate() : 0;
547 sys->pts_next = VLC_TS_INVALID;
548 date_Init(&sys->pts, fmt.video.i_frame_rate, fmt.video.i_frame_rate_base);
549 date_Set(&sys->pts, 0);
551 es_format_Clean(&fmt);
553 demux->pf_demux = Demux;
554 demux->pf_control = Control;
559 static void Close(vlc_object_t *object)
561 demux_t *demux = (demux_t*)object;
562 demux_sys_t *sys = demux->p_sys;
565 block_Release(sys->data);