qt: add device preferences for mmdevice
[vlc.git] / modules / demux / image.c
blob038cf5e43fb51b8da8afd341316daa672b56e2e4
1 /*****************************************************************************
2 * image.c: Image demuxer
3 *****************************************************************************
4 * Copyright (C) 2010 Laurent Aimar
5 * $Id$
7 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
25 * Preamble
26 *****************************************************************************/
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_demux.h>
35 #include <vlc_image.h>
36 #include "mxpeg_helper.h"
38 /*****************************************************************************
39 * Module descriptor
40 *****************************************************************************/
41 static int Open (vlc_object_t *);
42 static void Close(vlc_object_t *);
44 #define ID_TEXT N_("ES ID")
45 #define ID_LONGTEXT N_( \
46 "Set the ID of the elementary stream")
48 #define GROUP_TEXT N_("Group")
49 #define GROUP_LONGTEXT N_(\
50 "Set the group of the elementary stream")
52 #define DECODE_TEXT N_("Decode")
53 #define DECODE_LONGTEXT N_( \
54 "Decode at the demuxer stage")
56 #define CHROMA_TEXT N_("Forced chroma")
57 #define CHROMA_LONGTEXT N_( \
58 "If non empty and image-decode is true, the image will be " \
59 "converted to the specified chroma.")
61 #define DURATION_TEXT N_("Duration in seconds")
62 #define DURATION_LONGTEXT N_( \
63 "Duration in seconds before simulating an end of file. " \
64 "A negative value means an unlimited play time.")
66 #define FPS_TEXT N_("Frame rate")
67 #define FPS_LONGTEXT N_( \
68 "Frame rate of the elementary stream produced.")
70 #define RT_TEXT N_("Real-time")
71 #define RT_LONGTEXT N_( \
72 "Use real-time mode suitable for being used as a master input and " \
73 "real-time input slaves.")
75 vlc_module_begin()
76 set_description(N_("Image demuxer"))
77 set_shortname(N_("Image"))
78 set_category(CAT_INPUT)
79 set_subcategory(SUBCAT_INPUT_DEMUX)
80 add_integer("image-id", -1, ID_TEXT, ID_LONGTEXT, true)
81 change_safe()
82 add_integer("image-group", 0, GROUP_TEXT, GROUP_LONGTEXT, true)
83 change_safe()
84 add_bool("image-decode", true, DECODE_TEXT, DECODE_LONGTEXT, true)
85 change_safe()
86 add_string("image-chroma", "", CHROMA_TEXT, CHROMA_LONGTEXT, true)
87 change_safe()
88 add_float("image-duration", 10, DURATION_TEXT, DURATION_LONGTEXT, false)
89 change_safe()
90 add_string("image-fps", "10/1", FPS_TEXT, FPS_LONGTEXT, true)
91 change_safe()
92 add_bool("image-realtime", false, RT_TEXT, RT_LONGTEXT, true)
93 change_safe()
94 set_capability("demux", 10)
95 set_callbacks(Open, Close)
96 vlc_module_end()
98 /*****************************************************************************
99 * Local prototypes
100 *****************************************************************************/
101 struct demux_sys_t
103 block_t *data;
104 es_out_id_t *es;
105 mtime_t duration;
106 bool is_realtime;
107 mtime_t pts_origin;
108 mtime_t pts_next;
109 date_t pts;
112 static block_t *Load(demux_t *demux)
114 const unsigned max_size = 4096 * 4096 * 8;
115 uint64_t size;
117 if (vlc_stream_GetSize(demux->s, &size) == VLC_SUCCESS) {
118 if (size > max_size) {
119 msg_Err(demux, "image too large (%"PRIu64" > %u), rejected",
120 size, max_size);
121 return NULL;
123 } else
124 size = max_size;
126 block_t *block = block_Alloc(size);
127 if (block == NULL)
128 return NULL;
130 ssize_t val = vlc_stream_Read(demux->s, block->p_buffer, size);
131 if (val < 0) {
132 block_Release(block);
133 return NULL;
136 block->i_buffer = val;
137 return block;
140 static block_t *Decode(demux_t *demux,
141 video_format_t *fmt, vlc_fourcc_t chroma, block_t *data)
143 image_handler_t *handler = image_HandlerCreate(demux);
144 if (!handler) {
145 block_Release(data);
146 return NULL;
149 video_format_t decoded;
150 video_format_Init(&decoded, chroma);
152 picture_t *image = image_Read(handler, data, fmt, &decoded);
153 image_HandlerDelete(handler);
155 if (!image)
156 return NULL;
158 video_format_Clean(fmt);
159 *fmt = decoded;
161 size_t size = 0;
162 for (int i = 0; i < image->i_planes; i++)
163 size += image->p[i].i_pitch * image->p[i].i_lines;
165 data = block_Alloc(size);
166 if (!data) {
167 picture_Release(image);
168 return NULL;
171 size_t offset = 0;
172 for (int i = 0; i < image->i_planes; i++) {
173 const plane_t *src = &image->p[i];
174 for (int y = 0; y < src->i_visible_lines; y++) {
175 memcpy(&data->p_buffer[offset],
176 &src->p_pixels[y * src->i_pitch],
177 src->i_visible_pitch);
178 offset += src->i_visible_pitch;
182 picture_Release(image);
183 return data;
186 static int Demux(demux_t *demux)
188 demux_sys_t *sys = demux->p_sys;
190 if (!sys->data)
191 return 0;
193 mtime_t deadline;
194 const mtime_t pts_first = sys->pts_origin + date_Get(&sys->pts);
195 if (sys->pts_next > VLC_TS_INVALID) {
196 deadline = sys->pts_next;
197 } else if (sys->is_realtime) {
198 deadline = mdate();
199 const mtime_t max_wait = CLOCK_FREQ / 50;
200 if (deadline + max_wait < pts_first) {
201 es_out_SetPCR(demux->out, deadline);
202 /* That's ugly, but not yet easily fixable */
203 mwait(deadline + max_wait);
204 return 1;
206 } else {
207 deadline = 1 + pts_first;
210 for (;;) {
211 const mtime_t pts = sys->pts_origin + date_Get(&sys->pts);
212 if (sys->duration >= 0 && pts >= sys->pts_origin + sys->duration)
213 return 0;
215 if (pts >= deadline)
216 return 1;
218 block_t *data = block_Duplicate(sys->data);
219 if (!data)
220 return -1;
222 data->i_dts =
223 data->i_pts = VLC_TS_0 + pts;
224 es_out_SetPCR(demux->out, data->i_pts);
225 es_out_Send(demux->out, sys->es, data);
227 date_Increment(&sys->pts, 1);
231 static int Control(demux_t *demux, int query, va_list args)
233 demux_sys_t *sys = demux->p_sys;
235 switch (query) {
236 case DEMUX_CAN_SEEK:
237 *va_arg(args, bool *) = sys->duration >= 0 && !sys->is_realtime;
238 return VLC_SUCCESS;
239 case DEMUX_GET_POSITION: {
240 double *position = va_arg(args, double *);
241 if (sys->duration > 0)
242 *position = date_Get(&sys->pts) / (double)sys->duration;
243 else
244 *position = 0;
245 return VLC_SUCCESS;
247 case DEMUX_SET_POSITION: {
248 if (sys->duration < 0 || sys->is_realtime)
249 return VLC_EGENERIC;
250 double position = va_arg(args, double);
251 date_Set(&sys->pts, position * sys->duration);
252 return VLC_SUCCESS;
254 case DEMUX_GET_TIME: {
255 int64_t *time = va_arg(args, int64_t *);
256 *time = sys->pts_origin + date_Get(&sys->pts);
257 return VLC_SUCCESS;
259 case DEMUX_SET_TIME: {
260 if (sys->duration < 0 || sys->is_realtime)
261 return VLC_EGENERIC;
262 int64_t time = va_arg(args, int64_t);
263 date_Set(&sys->pts, VLC_CLIP(time - sys->pts_origin, 0, sys->duration));
264 return VLC_SUCCESS;
266 case DEMUX_SET_NEXT_DEMUX_TIME: {
267 int64_t pts_next = VLC_TS_0 + va_arg(args, int64_t);
268 if (sys->pts_next <= VLC_TS_INVALID)
269 sys->pts_origin = pts_next;
270 sys->pts_next = pts_next;
271 return VLC_SUCCESS;
273 case DEMUX_GET_LENGTH: {
274 int64_t *length = va_arg(args, int64_t *);
275 *length = __MAX(sys->duration, 0);
276 return VLC_SUCCESS;
278 case DEMUX_GET_FPS: {
279 double *fps = va_arg(args, double *);
280 *fps = (double)sys->pts.i_divider_num / sys->pts.i_divider_den;
281 return VLC_SUCCESS;
283 case DEMUX_GET_META:
284 case DEMUX_HAS_UNSUPPORTED_META:
285 case DEMUX_GET_ATTACHMENTS:
286 return VLC_EGENERIC;
288 case DEMUX_CAN_PAUSE:
289 case DEMUX_SET_PAUSE_STATE:
290 case DEMUX_CAN_CONTROL_PACE:
291 case DEMUX_GET_PTS_DELAY:
292 return demux_vaControlHelper( demux->s, 0, -1, 0, 1, query, args );
294 default:
295 return VLC_EGENERIC;
300 static bool IsBmp(stream_t *s)
302 const uint8_t *header;
303 if (vlc_stream_Peek(s, &header, 18) < 18)
304 return false;
305 if (memcmp(header, "BM", 2) &&
306 memcmp(header, "BA", 2) &&
307 memcmp(header, "CI", 2) &&
308 memcmp(header, "CP", 2) &&
309 memcmp(header, "IC", 2) &&
310 memcmp(header, "PT", 2))
311 return false;
312 uint32_t file_size = GetDWLE(&header[2]);
313 uint32_t data_offset = GetDWLE(&header[10]);
314 uint32_t header_size = GetDWLE(&header[14]);
315 if (file_size != 14 && file_size != 14 + header_size &&
316 file_size <= data_offset)
317 return false;
318 if (data_offset < header_size + 14)
319 return false;
320 if (header_size != 12 && header_size < 40)
321 return false;
322 return true;
325 static bool IsPcx(stream_t *s)
327 const uint8_t *header;
328 if (vlc_stream_Peek(s, &header, 66) < 66)
329 return false;
330 if (header[0] != 0x0A || /* marker */
331 (header[1] != 0x00 && header[1] != 0x02 &&
332 header[1] != 0x03 && header[1] != 0x05) || /* version */
333 (header[2] != 0 && header[2] != 1) || /* encoding */
334 (header[3] != 1 && header[3] != 2 &&
335 header[3] != 4 && header[3] != 8) || /* bits per pixel per plane */
336 header[64] != 0 || /* reserved */
337 header[65] == 0 || header[65] > 4) /* plane count */
338 return false;
339 if (GetWLE(&header[4]) > GetWLE(&header[8]) || /* xmin vs xmax */
340 GetWLE(&header[6]) > GetWLE(&header[10])) /* ymin vs ymax */
341 return false;
342 return true;
345 static bool IsLbm(stream_t *s)
347 const uint8_t *header;
348 if (vlc_stream_Peek(s, &header, 12) < 12)
349 return false;
350 if (memcmp(&header[0], "FORM", 4) ||
351 GetDWBE(&header[4]) <= 4 ||
352 (memcmp(&header[8], "ILBM", 4) && memcmp(&header[8], "PBM ", 4)))
353 return false;
354 return true;
356 static bool IsPnmBlank(uint8_t v)
358 return v == ' ' || v == '\t' || v == '\r' || v == '\n';
360 static bool IsPnm(stream_t *s)
362 const uint8_t *header;
363 int size = vlc_stream_Peek(s, &header, 256);
364 if (size < 3)
365 return false;
366 if (header[0] != 'P' ||
367 header[1] < '1' || header[1] > '6' ||
368 !IsPnmBlank(header[2]))
369 return false;
371 int number_count = 0;
372 for (int i = 3, parsing_number = 0; i < size && number_count < 2; i++) {
373 if (IsPnmBlank(header[i])) {
374 if (parsing_number) {
375 parsing_number = 0;
376 number_count++;
378 } else {
379 if (header[i] < '0' || header[i] > '9')
380 break;
381 parsing_number = 1;
384 if (number_count < 2)
385 return false;
386 return true;
389 static uint8_t FindJpegMarker(int *position, const uint8_t *data, int size)
391 for (int i = *position; i + 1 < size; i++) {
392 if (data[i + 0] != 0xff || data[i + 1] == 0x00)
393 return 0xff;
394 if (data[i + 1] != 0xff) {
395 *position = i + 2;
396 return data[i + 1];
399 return 0xff;
401 static bool IsJfif(stream_t *s)
403 const uint8_t *header;
404 int size = vlc_stream_Peek(s, &header, 256);
405 int position = 0;
407 if (FindJpegMarker(&position, header, size) != 0xd8)
408 return false;
409 if (FindJpegMarker(&position, header, size) != 0xe0)
410 return false;
411 position += 2; /* Skip size */
412 if (position + 5 > size)
413 return false;
414 if (memcmp(&header[position], "JFIF\0", 5))
415 return false;
416 return true;
419 static bool IsSpiff(stream_t *s)
421 const uint8_t *header;
422 if (vlc_stream_Peek(s, &header, 36) < 36) /* SPIFF header size */
423 return false;
424 if (header[0] != 0xff || header[1] != 0xd8 ||
425 header[2] != 0xff || header[3] != 0xe8)
426 return false;
427 if (memcmp(&header[6], "SPIFF\0", 6))
428 return false;
429 return true;
432 static bool IsExif(stream_t *s)
434 const uint8_t *header;
435 ssize_t size = vlc_stream_Peek(s, &header, 256);
436 if (size == -1)
437 return false;
438 int position = 0;
440 if (FindJpegMarker(&position, header, size) != 0xd8)
441 return false;
442 if (FindJpegMarker(&position, header, size) != 0xe1)
443 return false;
444 position += 2; /* Skip size */
445 if (position + 5 > size)
446 return false;
447 if (memcmp(&header[position], "Exif\0", 5))
448 return false;
449 return true;
452 static bool FindSVGmarker(int *position, const uint8_t *data, const int size, const char *marker)
454 for( int i = *position; i < size; i++)
456 if (memcmp(&data[i], marker, strlen(marker)) == 0)
458 *position = i;
459 return true;
462 return false;
465 static bool IsSVG(stream_t *s)
467 if (s->psz_url == NULL)
468 return false;
470 char *ext = strstr(s->psz_url, ".svg");
471 if (!ext) return false;
473 const uint8_t *header;
474 ssize_t size = vlc_stream_Peek(s, &header, 4096);
475 if (size == -1)
476 return false;
477 int position = 0;
479 const char xml[] = "<?xml version=\"";
480 if (!FindSVGmarker(&position, header, size, xml))
481 return false;
482 if (position != 0)
483 return false;
485 const char endxml[] = ">\0";
486 if (!FindSVGmarker(&position, header, size, endxml))
487 return false;
488 if (position <= 15)
489 return false;
491 const char svg[] = "<svg";
492 if (!FindSVGmarker(&position, header, size, svg))
493 return false;
494 if (position < 19)
495 return false;
497 /* SVG Scalable Vector Graphics image */
499 /* NOTE: some SVG images have the mimetype set in a meta data section
500 * and some do not */
501 return true;
504 static bool IsTarga(stream_t *s)
506 /* The header is not enough to ensure proper detection, we need
507 * to have a look at the footer. But doing so can be slow. So
508 * try to avoid it when possible */
509 const uint8_t *header;
510 if (vlc_stream_Peek(s, &header, 18) < 18) /* Targa fixed header */
511 return false;
512 if (header[1] > 1) /* Color Map Type */
513 return false;
514 if ((header[1] != 0 || header[3 + 4] != 0) &&
515 header[3 + 4] != 8 &&
516 header[3 + 4] != 15 && header[3 + 4] != 16 &&
517 header[3 + 4] != 24 && header[3 + 4] != 32)
518 return false;
519 if ((header[2] > 3 && header[2] < 9) || header[2] > 11) /* Image Type */
520 return false;
521 if (GetWLE(&header[8 + 4]) <= 0 || /* Width */
522 GetWLE(&header[8 + 6]) <= 0) /* Height */
523 return false;
524 if (header[8 + 8] != 8 &&
525 header[8 + 8] != 15 && header[8 + 8] != 16 &&
526 header[8 + 8] != 24 && header[8 + 8] != 32)
527 return false;
528 if (header[8 + 9] & 0xc0) /* Reserved bits */
529 return false;
531 const int64_t size = stream_Size(s);
532 if (size <= 18 + 26)
533 return false;
534 bool can_seek;
535 if (vlc_stream_Control(s, STREAM_CAN_SEEK, &can_seek) || !can_seek)
536 return false;
538 const int64_t position = vlc_stream_Tell(s);
539 if (vlc_stream_Seek(s, size - 26))
540 return false;
542 const uint8_t *footer;
543 bool is_targa = vlc_stream_Peek(s, &footer, 26) >= 26 &&
544 !memcmp(&footer[8], "TRUEVISION-XFILE.\x00", 18);
545 vlc_stream_Seek(s, position);
546 return is_targa;
549 typedef struct {
550 vlc_fourcc_t codec;
551 size_t marker_size;
552 const uint8_t marker[14];
553 bool (*detect)(stream_t *s);
554 } image_format_t;
556 #define VLC_CODEC_XCF VLC_FOURCC('X', 'C', 'F', ' ')
557 #define VLC_CODEC_LBM VLC_FOURCC('L', 'B', 'M', ' ')
558 static const image_format_t formats[] = {
559 { .codec = VLC_CODEC_XCF,
560 .marker_size = 9 + 4 + 1,
561 .marker = { 'g', 'i', 'm', 'p', ' ', 'x', 'c', 'f', ' ',
562 'f', 'i', 'l', 'e', '\0' }
564 { .codec = VLC_CODEC_XCF,
565 .marker_size = 9 + 4 + 1,
566 .marker = { 'g', 'i', 'm', 'p', ' ', 'x', 'c', 'f', ' ',
567 'v', '0', '0', '1', '\0' }
569 { .codec = VLC_CODEC_XCF,
570 .marker_size = 9 + 4 + 1,
571 .marker = { 'g', 'i', 'm', 'p', ' ', 'x', 'c', 'f', ' ',
572 'v', '0', '0', '2', '\0' }
574 { .codec = VLC_CODEC_PNG,
575 .marker_size = 8,
576 .marker = { 0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A }
578 { .codec = VLC_CODEC_GIF,
579 .marker_size = 6,
580 .marker = { 'G', 'I', 'F', '8', '7', 'a' }
582 { .codec = VLC_CODEC_GIF,
583 .marker_size = 6,
584 .marker = { 'G', 'I', 'F', '8', '9', 'a' }
586 /* XXX TIFF detection may be a bit weak */
587 { .codec = VLC_CODEC_TIFF,
588 .marker_size = 4,
589 .marker = { 'I', 'I', 0x2a, 0x00 },
591 { .codec = VLC_CODEC_TIFF,
592 .marker_size = 4,
593 .marker = { 'M', 'M', 0x00, 0x2a },
595 { .codec = VLC_CODEC_BMP,
596 .detect = IsBmp,
598 { .codec = VLC_CODEC_PCX,
599 .detect = IsPcx,
601 { .codec = VLC_CODEC_LBM,
602 .detect = IsLbm,
604 { .codec = VLC_CODEC_PNM,
605 .detect = IsPnm,
607 { .codec = VLC_CODEC_MXPEG,
608 .detect = IsMxpeg,
610 { .codec = VLC_CODEC_JPEG,
611 .detect = IsJfif,
613 { .codec = VLC_CODEC_JPEG,
614 .detect = IsSpiff,
616 { .codec = VLC_CODEC_JPEG,
617 .detect = IsExif,
619 { .codec = VLC_CODEC_BPG,
620 .marker_size = 4,
621 .marker = { 'B', 'P', 'G', 0xFB },
623 { .codec = VLC_CODEC_SVG,
624 .detect = IsSVG,
626 { .codec = VLC_CODEC_TARGA,
627 .detect = IsTarga,
629 { .codec = 0 }
632 static int Open(vlc_object_t *object)
634 demux_t *demux = (demux_t*)object;
636 /* Detect the image type */
637 const image_format_t *img;
639 const uint8_t *peek;
640 ssize_t peek_size = 0;
641 for (int i = 0; ; i++) {
642 img = &formats[i];
643 if (!img->codec)
644 return VLC_EGENERIC;
646 if (img->detect) {
647 if (img->detect(demux->s))
648 break;
649 /* detect callbacks can invalidate the current peek buffer */
650 peek_size = 0;
651 } else {
652 if ((size_t) peek_size < img->marker_size)
654 peek_size = vlc_stream_Peek(demux->s, &peek, img->marker_size);
655 if (peek_size == -1)
656 return VLC_ENOMEM;
658 if ((size_t) peek_size >= img->marker_size &&
659 !memcmp(peek, img->marker, img->marker_size))
660 break;
663 msg_Dbg(demux, "Detected image: %s",
664 vlc_fourcc_GetDescription(VIDEO_ES, img->codec));
666 if( img->codec == VLC_CODEC_MXPEG )
668 return VLC_EGENERIC; //let avformat demux this file
671 /* Load and if selected decode */
672 es_format_t fmt;
673 es_format_Init(&fmt, VIDEO_ES, img->codec);
674 fmt.video.i_chroma = fmt.i_codec;
676 block_t *data = Load(demux);
677 if (data && var_InheritBool(demux, "image-decode")) {
678 char *string = var_InheritString(demux, "image-chroma");
679 vlc_fourcc_t chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, string);
680 free(string);
682 data = Decode(demux, &fmt.video, chroma, data);
683 fmt.i_codec = fmt.video.i_chroma;
685 fmt.i_id = var_InheritInteger(demux, "image-id");
686 fmt.i_group = var_InheritInteger(demux, "image-group");
687 if (var_InheritURational(demux,
688 &fmt.video.i_frame_rate,
689 &fmt.video.i_frame_rate_base,
690 "image-fps") ||
691 fmt.video.i_frame_rate <= 0 || fmt.video.i_frame_rate_base <= 0) {
692 msg_Err(demux, "Invalid frame rate, using 10/1 instead");
693 fmt.video.i_frame_rate = 10;
694 fmt.video.i_frame_rate_base = 1;
697 /* If loadind failed, we still continue to avoid mis-detection
698 * by other demuxers. */
699 if (!data)
700 msg_Err(demux, "Failed to load the image");
702 /* */
703 demux_sys_t *sys = malloc(sizeof(*sys));
704 if (!sys) {
705 if (data)
706 block_Release(data);
707 es_format_Clean(&fmt);
708 return VLC_ENOMEM;
711 sys->data = data;
712 sys->es = es_out_Add(demux->out, &fmt);
713 sys->duration = CLOCK_FREQ * var_InheritFloat(demux, "image-duration");
714 sys->is_realtime = var_InheritBool(demux, "image-realtime");
715 sys->pts_origin = sys->is_realtime ? mdate() : 0;
716 sys->pts_next = VLC_TS_INVALID;
717 date_Init(&sys->pts, fmt.video.i_frame_rate, fmt.video.i_frame_rate_base);
718 date_Set(&sys->pts, 0);
720 es_format_Clean(&fmt);
722 demux->pf_demux = Demux;
723 demux->pf_control = Control;
724 demux->p_sys = sys;
725 return VLC_SUCCESS;
728 static void Close(vlc_object_t *object)
730 demux_t *demux = (demux_t*)object;
731 demux_sys_t *sys = demux->p_sys;
733 if (sys->data)
734 block_Release(sys->data);
735 free(sys);