git.sesse.net Git - vlc/blob - modules/demux/image.c

   1 /*****************************************************************************
   2  * image.c: Image demuxer
   3  *****************************************************************************
   4  * Copyright (C) 2010 Laurent Aimar
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_demux.h>
  35 #include <vlc_image.h>
  36
  37 /*****************************************************************************
  38  * Module descriptor
  39  *****************************************************************************/
  40 static int  Open (vlc_object_t *);
  41 static void Close(vlc_object_t *);
  42
  43 #define ID_TEXT N_("ES ID")
  44 #define ID_LONGTEXT N_( \
  45     "Set the ID of the elementary stream")
  46
  47 #define GROUP_TEXT N_("Group")
  48 #define GROUP_LONGTEXT N_(\
  49     "Set the group of the elementary stream")
  50
  51 #define DECODE_TEXT N_("Decode")
  52 #define DECODE_LONGTEXT N_( \
  53     "Decode at the demuxer stage")
  54
  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.")
  59
  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.")
  64
  65 #define FPS_TEXT N_("Frame rate")
  66 #define FPS_LONGTEXT N_( \
  67     "Frame rate of the elementary stream produced.")
  68
  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.")
  73
  74 vlc_module_begin()
  75     set_description(N_("Image demuxer"))
  76     set_shortname(N_("Image"))
  77     set_category(CAT_INPUT)
  78     set_subcategory(SUBCAT_INPUT_DEMUX)
  79     add_integer("image-id", -1, ID_TEXT, ID_LONGTEXT, true)
  80         change_safe()
  81     add_integer("image-group", 0, GROUP_TEXT, GROUP_LONGTEXT, true)
  82         change_safe()
  83     add_bool("image-decode", true, DECODE_TEXT, DECODE_LONGTEXT, true)
  84         change_safe()
  85     add_string("image-chroma", "", CHROMA_TEXT, CHROMA_LONGTEXT, true)
  86         change_safe()
  87     add_float("image-duration", 10, DURATION_TEXT, DURATION_LONGTEXT, true)
  88         change_safe()
  89     add_string("image-fps", "10/1", FPS_TEXT, FPS_LONGTEXT, true)
  90         change_safe()
  91     add_bool("image-realtime", false, RT_TEXT, RT_LONGTEXT, true)
  92         change_safe()
  93     set_capability("demux", 10)
  94     set_callbacks(Open, Close)
  95 vlc_module_end()
  96
  97 /*****************************************************************************
  98  * Local prototypes
  99  *****************************************************************************/
 100 struct demux_sys_t
 101 {
 102     block_t     *data;
 103     es_out_id_t *es;
 104     mtime_t     duration;
 105     bool        is_realtime;
 106     mtime_t     pts_origin;
 107     mtime_t     pts_next;
 108     date_t        pts;
 109 };
 110
 111 static block_t *Load(demux_t *demux)
 112 {
 113     const int     max_size = 4096 * 4096 * 8;
 114     const int64_t size = stream_Size(demux->s);
 115     if (size < 0 || size > max_size) {
 116         msg_Err(demux, "Rejecting image based on its size (%"PRId64" > %d)", size, max_size);
 117         return NULL;
 118     }
 119
 120     if (size > 0)
 121         return stream_Block(demux->s, size);
 122     /* TODO */
 123     return NULL;
 124 }
 125
 126 static block_t *Decode(demux_t *demux,
 127                        video_format_t *fmt, vlc_fourcc_t chroma, block_t *data)
 128 {
 129     image_handler_t *handler = image_HandlerCreate(demux);
 130     if (!handler) {
 131         block_Release(data);
 132         return NULL;
 133     }
 134
 135     video_format_t decoded;
 136     video_format_Init(&decoded, chroma);
 137
 138     picture_t *image = image_Read(handler, data, fmt, &decoded);
 139     image_HandlerDelete(handler);
 140
 141     if (!image)
 142         return NULL;
 143
 144     video_format_Clean(fmt);
 145     *fmt = decoded;
 146
 147     size_t size = 0;
 148     for (int i = 0; i < image->i_planes; i++)
 149         size += image->p[i].i_visible_pitch *
 150                 image->p[i].i_visible_lines;
 151
 152     data = block_New(demux, size);
 153     if (!data) {
 154         picture_Release(image);
 155         return NULL;
 156     }
 157
 158     size_t offset = 0;
 159     for (int i = 0; i < image->i_planes; i++) {
 160         const plane_t *src = &image->p[i];
 161         for (int y = 0; y < src->i_visible_lines; y++) {
 162             memcpy(&data->p_buffer[offset],
 163                    &src->p_pixels[y * src->i_pitch],
 164                    src->i_visible_pitch);
 165             offset += src->i_visible_pitch;
 166         }
 167     }
 168
 169     picture_Release(image);
 170     return data;
 171 }
 172
 173 static int Demux(demux_t *demux)
 174 {
 175     demux_sys_t *sys = demux->p_sys;
 176
 177     if (!sys->data)
 178         return 0;
 179
 180     mtime_t deadline;
 181     const mtime_t pts_first = sys->pts_origin + date_Get(&sys->pts);
 182     if (sys->pts_next > VLC_TS_INVALID) {
 183         deadline = sys->pts_next;
 184     } else if (sys->is_realtime) {
 185         deadline = mdate();
 186         const mtime_t max_wait = CLOCK_FREQ / 50;
 187         if (deadline + max_wait < pts_first) {
 188             es_out_Control(demux->out, ES_OUT_SET_PCR, deadline);
 189             /* That's ugly, but not yet easily fixable */
 190             mwait(deadline + max_wait);
 191             return 1;
 192         }
 193     } else {
 194         deadline = 1 + pts_first;
 195     }
 196
 197     for (;;) {
 198         const mtime_t pts = sys->pts_origin + date_Get(&sys->pts);
 199         if (sys->duration >= 0 && pts >= sys->pts_origin + sys->duration)
 200             return 0;
 201
 202         if (pts >= deadline)
 203             return 1;
 204
 205         block_t *data = block_Duplicate(sys->data);
 206         if (!data)
 207             return -1;
 208
 209         data->i_dts =
 210         data->i_pts = VLC_TS_0 + pts;
 211         es_out_Control(demux->out, ES_OUT_SET_PCR, data->i_pts);
 212         es_out_Send(demux->out, sys->es, data);
 213
 214         date_Increment(&sys->pts, 1);
 215     }
 216 }
 217
 218 static int Control(demux_t *demux, int query, va_list args)
 219 {
 220     demux_sys_t *sys = demux->p_sys;
 221
 222     switch (query) {
 223     case DEMUX_GET_POSITION: {
 224         double *position = va_arg(args, double *);
 225         if (sys->duration > 0)
 226             *position = date_Get(&sys->pts) / (double)sys->duration;
 227         else
 228             *position = 0;
 229         return VLC_SUCCESS;
 230     }
 231     case DEMUX_SET_POSITION: {
 232         if (sys->duration < 0 || sys->is_realtime)
 233             return VLC_EGENERIC;
 234         double position = va_arg(args, double);
 235         date_Set(&sys->pts, position * sys->duration);
 236         return VLC_SUCCESS;
 237     }
 238     case DEMUX_GET_TIME: {
 239         int64_t *time = va_arg(args, int64_t *);
 240         *time = sys->pts_origin + date_Get(&sys->pts);
 241         return VLC_SUCCESS;
 242     }
 243     case DEMUX_SET_TIME: {
 244         if (sys->duration < 0 || sys->is_realtime)
 245             return VLC_EGENERIC;
 246         int64_t time = va_arg(args, int64_t);
 247         date_Set(&sys->pts, __MIN(__MAX(time - sys->pts_origin, 0),
 248                                   sys->duration));
 249         return VLC_SUCCESS;
 250     }
 251     case DEMUX_SET_NEXT_DEMUX_TIME: {
 252         int64_t pts_next = VLC_TS_0 + va_arg(args, int64_t);
 253         if (sys->pts_next <= VLC_TS_INVALID)
 254             sys->pts_origin = pts_next;
 255         sys->pts_next = pts_next;
 256         return VLC_SUCCESS;
 257     }
 258     case DEMUX_GET_LENGTH: {
 259         int64_t *length = va_arg(args, int64_t *);
 260         *length = __MAX(sys->duration, 0);
 261         return VLC_SUCCESS;
 262     }
 263     case DEMUX_GET_FPS: {
 264         double *fps = va_arg(args, double *);
 265         *fps = (double)sys->pts.i_divider_num / sys->pts.i_divider_den;
 266         return VLC_SUCCESS;
 267     }
 268     case DEMUX_GET_META:
 269     case DEMUX_HAS_UNSUPPORTED_META:
 270     case DEMUX_GET_ATTACHMENTS:
 271     default:
 272         return VLC_EGENERIC;
 273     }
 274 }
 275
 276 static bool IsBmp(stream_t *s)
 277 {
 278     const uint8_t *header;
 279     if (stream_Peek(s, &header, 18) < 18)
 280         return false;
 281     if (memcmp(header, "BM", 2) &&
 282         memcmp(header, "BA", 2) &&
 283         memcmp(header, "CI", 2) &&
 284         memcmp(header, "CP", 2) &&
 285         memcmp(header, "IC", 2) &&
 286         memcmp(header, "PT", 2))
 287         return false;
 288     uint32_t file_size   = GetDWLE(&header[2]);
 289     uint32_t data_offset = GetDWLE(&header[10]);
 290     uint32_t header_size = GetDWLE(&header[14]);
 291     if (file_size != 14 && file_size != 14 + header_size &&
 292         file_size <= data_offset)
 293         return false;
 294     if (data_offset < header_size + 14)
 295         return false;
 296     if (header_size != 12 && header_size < 40)
 297         return false;
 298     return true;
 299 }
 300
 301 static bool IsPcx(stream_t *s)
 302 {
 303     const uint8_t *header;
 304     if (stream_Peek(s, &header, 66) < 66)
 305         return false;
 306     if (header[0] != 0x0A ||                        /* marker */
 307         (header[1] != 0x00 && header[1] != 0x02 &&
 308          header[1] != 0x03 && header[1] != 0x05) || /* version */
 309         (header[2] != 0 && header[2] != 1) ||       /* encoding */
 310         (header[3] != 1 && header[3] != 2 &&
 311          header[3] != 4 && header[3] != 8) ||       /* bits per pixel per plane */
 312         header[64] != 0 ||                          /* reserved */
 313         header[65] == 0 || header[65] > 4)          /* plane count */
 314         return false;
 315     if (GetWLE(&header[4]) > GetWLE(&header[8]) ||  /* xmin vs xmax */
 316         GetWLE(&header[6]) > GetWLE(&header[10]))   /* ymin vs ymax */
 317         return false;
 318     return true;
 319 }
 320
 321 static bool IsLbm(stream_t *s)
 322 {
 323     const uint8_t *header;
 324     if (stream_Peek(s, &header, 12) < 12)
 325         return false;
 326     if (memcmp(&header[0], "FORM", 4) ||
 327         GetDWBE(&header[4]) <= 4 ||
 328         (memcmp(&header[8], "ILBM", 4) && memcmp(&header[8], "PBM ", 4)))
 329         return false;
 330     return true;
 331 }
 332 static bool IsPnmBlank(uint8_t v)
 333 {
 334     return v == ' ' || v == '\t' || v == '\r' || v == '\n';
 335 }
 336 static bool IsPnm(stream_t *s)
 337 {
 338     const uint8_t *header;
 339     int size = stream_Peek(s, &header, 256);
 340     if (size < 3)
 341         return false;
 342     if (header[0] != 'P' ||
 343         header[1] < '1' || header[1] > '6' ||
 344         !IsPnmBlank(header[2]))
 345         return false;
 346
 347     int number_count = 0;
 348     for (int i = 3, parsing_number = 0; i < size && number_count < 2; i++) {
 349         if (IsPnmBlank(header[i])) {
 350             if (parsing_number) {
 351                 parsing_number = 0;
 352                 number_count++;
 353             }
 354         } else {
 355             if (header[i] < '0' || header[i] > '9')
 356                 break;
 357             parsing_number = 1;
 358         }
 359     }
 360     if (number_count < 2)
 361         return false;
 362     return true;
 363 }
 364
 365 static uint8_t FindJpegMarker(int *position, const uint8_t *data, int size)
 366 {
 367     for (int i = *position; i + 1 < size; i++) {
 368         if (data[i + 0] != 0xff || data[i + 1] == 0x00)
 369             return 0xff;
 370         if (data[i + 1] != 0xff) {
 371             *position = i + 2;
 372             return data[i + 1];
 373         }
 374     }
 375     return 0xff;
 376 }
 377 static bool IsJfif(stream_t *s)
 378 {
 379     const uint8_t *header;
 380     int size = stream_Peek(s, &header, 256);
 381     int position = 0;
 382
 383     if (FindJpegMarker(&position, header, size) != 0xd8)
 384         return false;
 385     if (FindJpegMarker(&position, header, size) != 0xe0)
 386         return false;
 387     position += 2;  /* Skip size */
 388     if (position + 5 > size)
 389         return false;
 390     if (memcmp(&header[position], "JFIF\0", 5))
 391         return false;
 392     return true;
 393 }
 394
 395 static bool IsSpiff(stream_t *s)
 396 {
 397     const uint8_t *header;
 398     if (stream_Peek(s, &header, 36) < 36) /* SPIFF header size */
 399         return false;
 400     if (header[0] != 0xff || header[1] != 0xd8 ||
 401         header[2] != 0xff || header[3] != 0xe8)
 402         return false;
 403     if (memcmp(&header[6], "SPIFF\0", 6))
 404         return false;
 405     return true;
 406 }
 407
 408 static bool IsTarga(stream_t *s)
 409 {
 410     /* The header is not enough to ensure proper detection, we need
 411      * to have a look at the footer. But doing so can be slow. So
 412      * try to avoid it when possible */
 413     const uint8_t *header;
 414     if (stream_Peek(s, &header, 18) < 18)   /* Targa fixed header */
 415         return false;
 416     if (header[1] > 1)                      /* Color Map Type */
 417         return false;
 418     if ((header[1] != 0 || header[3 + 4] != 0) &&
 419         header[3 + 4] != 8  &&
 420         header[3 + 4] != 15 && header[3 + 4] != 16 &&
 421         header[3 + 4] != 24 && header[3 + 4] != 32)
 422         return false;
 423     if ((header[2] > 3 && header[2] < 9) || header[2] > 11) /* Image Type */
 424         return false;
 425     if (GetWLE(&header[8 + 4]) <= 0 ||      /* Width */
 426         GetWLE(&header[8 + 6]) <= 0)        /* Height */
 427         return false;
 428     if (header[8 + 8] != 8  &&
 429         header[8 + 8] != 15 && header[8 + 8] != 16 &&
 430         header[8 + 8] != 24 && header[8 + 8] != 32)
 431         return false;
 432     if (header[8 + 9] & 0xc0)               /* Reserved bits */
 433         return false;
 434
 435     const int64_t size = stream_Size(s);
 436     if (size <= 18 + 26)
 437         return false;
 438     bool can_seek;
 439     if (stream_Control(s, STREAM_CAN_SEEK, &can_seek) || !can_seek)
 440         return false;
 441
 442     const int64_t position = stream_Tell(s);
 443     if (stream_Seek(s, size - 26))
 444         return false;
 445
 446     const uint8_t *footer;
 447     bool is_targa = stream_Peek(s, &footer, 26) >= 26 &&
 448                     !memcmp(&footer[8], "TRUEVISION-XFILE.\x00", 18);
 449     stream_Seek(s, position);
 450     return is_targa;
 451 }
 452
 453 typedef struct {
 454     vlc_fourcc_t  codec;
 455     int           marker_size;
 456     const uint8_t marker[14];
 457     bool          (*detect)(stream_t *s);
 458 } image_format_t;
 459
 460 #define VLC_CODEC_XCF VLC_FOURCC('X', 'C', 'F', ' ')
 461 #define VLC_CODEC_LBM VLC_FOURCC('L', 'B', 'M', ' ')
 462 static const image_format_t formats[] = {
 463     { .codec = VLC_CODEC_XCF,
 464       .marker_size = 9 + 4 + 1,
 465       .marker = { 'g', 'i', 'm', 'p', ' ', 'x', 'c', 'f', ' ',
 466                   'f', 'i', 'l', 'e', '\0' }
 467     },
 468     { .codec = VLC_CODEC_XCF,
 469       .marker_size = 9 + 4 + 1,
 470       .marker = { 'g', 'i', 'm', 'p', ' ', 'x', 'c', 'f', ' ',
 471                   'v', '0', '0', '1', '\0' }
 472     },
 473     { .codec = VLC_CODEC_XCF,
 474       .marker_size = 9 + 4 + 1,
 475       .marker = { 'g', 'i', 'm', 'p', ' ', 'x', 'c', 'f', ' ',
 476                   'v', '0', '0', '2', '\0' }
 477     },
 478     { .codec = VLC_CODEC_PNG,
 479       .marker_size = 8,
 480       .marker = { 0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A }
 481     },
 482     { .codec = VLC_CODEC_GIF,
 483       .marker_size = 6,
 484       .marker = { 'G', 'I', 'F', '8', '7', 'a' }
 485     },
 486     { .codec = VLC_CODEC_GIF,
 487       .marker_size = 6,
 488       .marker = { 'G', 'I', 'F', '8', '9', 'a' }
 489     },
 490     /* XXX TIFF detection may be a bit weak */
 491     { .codec = VLC_CODEC_TIFF,
 492       .marker_size = 4,
 493       .marker = { 'I', 'I', 0x2a, 0x00 },
 494     },
 495     { .codec = VLC_CODEC_TIFF,
 496       .marker_size = 4,
 497       .marker = { 'M', 'M', 0x00, 0x2a },
 498     },
 499     { .codec = VLC_CODEC_BMP,
 500       .detect = IsBmp,
 501     },
 502     { .codec = VLC_CODEC_PCX,
 503       .detect = IsPcx,
 504     },
 505     { .codec = VLC_CODEC_LBM,
 506       .detect = IsLbm,
 507     },
 508     { .codec = VLC_CODEC_PNM,
 509       .detect = IsPnm,
 510     },
 511     { .codec = VLC_CODEC_JPEG,
 512       .detect = IsJfif,
 513     },
 514     { .codec = VLC_CODEC_JPEG,
 515       .detect = IsSpiff,
 516     },
 517     { .codec = VLC_CODEC_TARGA,
 518       .detect = IsTarga,
 519     },
 520     { .codec = 0 }
 521 };
 522
 523 static int Open(vlc_object_t *object)
 524 {
 525     demux_t *demux = (demux_t*)object;
 526
 527     /* Detect the image type */
 528     const image_format_t *img;
 529
 530     const uint8_t *peek;
 531     int peek_size = 0;
 532     for (int i = 0; ; i++) {
 533         img = &formats[i];
 534         if (!img->codec)
 535             return VLC_EGENERIC;
 536
 537         if (img->detect) {
 538             if (img->detect(demux->s))
 539                 break;
 540         } else {
 541             if (peek_size < img->marker_size)
 542                 peek_size = stream_Peek(demux->s, &peek, img->marker_size);
 543             if (peek_size >= img->marker_size &&
 544                 !memcmp(peek, img->marker, img->marker_size))
 545                 break;
 546         }
 547     }
 548     msg_Dbg(demux, "Detected image: %s",
 549             vlc_fourcc_GetDescription(VIDEO_ES, img->codec));
 550
 551     /* Load and if selected decode */
 552     es_format_t fmt;
 553     es_format_Init(&fmt, VIDEO_ES, img->codec);
 554     fmt.video.i_chroma = fmt.i_codec;
 555
 556     block_t *data = Load(demux);
 557     if (data && var_InheritBool(demux, "image-decode")) {
 558         char *string = var_InheritString(demux, "image-chroma");
 559         vlc_fourcc_t chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, string);
 560         free(string);
 561
 562         data = Decode(demux, &fmt.video, chroma, data);
 563         fmt.i_codec = fmt.video.i_chroma;
 564     }
 565     fmt.i_id    = var_InheritInteger(demux, "image-id");
 566     fmt.i_group = var_InheritInteger(demux, "image-group");
 567     if (var_InheritURational(demux,
 568                              &fmt.video.i_frame_rate,
 569                              &fmt.video.i_frame_rate_base,
 570                              "image-fps") ||
 571         fmt.video.i_frame_rate <= 0 || fmt.video.i_frame_rate_base <= 0) {
 572         msg_Err(demux, "Invalid frame rate, using 10/1 instead");
 573         fmt.video.i_frame_rate      = 10;
 574         fmt.video.i_frame_rate_base = 1;
 575     }
 576
 577     /* If loadind failed, we still continue to avoid mis-detection
 578      * by other demuxers. */
 579     if (!data)
 580         msg_Err(demux, "Failed to load the image");
 581
 582     /* */
 583     demux_sys_t *sys = malloc(sizeof(*sys));
 584     if (!sys) {
 585         if (data)
 586             block_Release(data);
 587         es_format_Clean(&fmt);
 588         return VLC_ENOMEM;
 589     }
 590
 591     sys->data        = data;
 592     sys->es          = es_out_Add(demux->out, &fmt);
 593     sys->duration    = CLOCK_FREQ * var_InheritFloat(demux, "image-duration");
 594     sys->is_realtime = var_InheritBool(demux, "image-realtime");
 595     sys->pts_origin  = sys->is_realtime ? mdate() : 0;
 596     sys->pts_next    = VLC_TS_INVALID;
 597     date_Init(&sys->pts, fmt.video.i_frame_rate, fmt.video.i_frame_rate_base);
 598     date_Set(&sys->pts, 0);
 599
 600     es_format_Clean(&fmt);
 601
 602     demux->pf_demux   = Demux;
 603     demux->pf_control = Control;
 604     demux->p_sys      = sys;
 605     return VLC_SUCCESS;
 606 }
 607
 608 static void Close(vlc_object_t *object)
 609 {
 610     demux_t     *demux = (demux_t*)object;
 611     demux_sys_t *sys   = demux->p_sys;
 612
 613     if (sys->data)
 614         block_Release(sys->data);
 615     free(sys);
 616 }
 617