libavformat/img2dec.c
15b4b505
 /*
  * Image format
  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
  * Copyright (c) 2004 Michael Niedermayer
  *
e99f1a8c
  * This file is part of FFmpeg.
15b4b505
  *
e99f1a8c
  * FFmpeg is free software; you can redistribute it and/or
15b4b505
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
e99f1a8c
  * FFmpeg is distributed in the hope that it will be useful,
15b4b505
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
e99f1a8c
  * License along with FFmpeg; if not, write to the Free Software
15b4b505
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #include "libavutil/avstring.h"
 #include "libavutil/log.h"
 #include "libavutil/opt.h"
 #include "libavutil/pixdesc.h"
 #include "libavutil/parseutils.h"
 #include "avformat.h"
 #include "internal.h"
0be130e3
 #if HAVE_GLOB
 #include <glob.h>
 
 /* Locally define as 0 (bitwise-OR no-op) any missing glob options that
    are non-posix glibc/bsd extensions. */
 #ifndef GLOB_NOMAGIC
 #define GLOB_NOMAGIC 0
 #endif
 #ifndef GLOB_BRACE
 #define GLOB_BRACE 0
 #endif
 
 #endif /* HAVE_GLOB */
15b4b505
 
 typedef struct {
     const AVClass *class;  /**< Class for private options. */
     int img_first;
     int img_last;
     int img_number;
05340be9
     int64_t pts;
15b4b505
     int img_count;
     int is_pipe;
e99f1a8c
     int split_planes;       /**< use independent file for each Y, U, V plane */
15b4b505
     char path[1024];
     char *pixel_format;     /**< Set by a private option. */
     char *video_size;       /**< Set by a private option. */
     char *framerate;        /**< Set by a private option. */
     int loop;
3a06ea84
     enum { PT_GLOB_SEQUENCE, PT_GLOB, PT_SEQUENCE } pattern_type;
0be130e3
     int use_glob;
 #if HAVE_GLOB
     glob_t globstate;
 #endif
98b3f17b
     int start_number;
9bece760
     int start_number_range;
b56ff0b2
     int frame_size;
15b4b505
 } VideoDemuxData;
 
 static const int sizes[][2] = {
     { 640, 480 },
     { 720, 480 },
     { 720, 576 },
     { 352, 288 },
     { 352, 240 },
     { 160, 128 },
     { 512, 384 },
     { 640, 352 },
     { 640, 240 },
 };
 
 static int infer_size(int *width_ptr, int *height_ptr, int size)
 {
     int i;
 
cc7d5cfe
     for (i = 0; i < FF_ARRAY_ELEMS(sizes); i++) {
15b4b505
         if ((sizes[i][0] * sizes[i][1]) == size) {
cc7d5cfe
             *width_ptr  = sizes[i][0];
15b4b505
             *height_ptr = sizes[i][1];
             return 0;
         }
     }
cc7d5cfe
 
15b4b505
     return -1;
 }
 
0be130e3
 static int is_glob(const char *path)
 {
 #if HAVE_GLOB
3e1ff8eb
     size_t span = 0;
     const char *p = path;
 
     while (p = strchr(p, '%')) {
         if (*(++p) == '%') {
             ++p;
             continue;
         }
         if (span = strspn(p, "*?[]{}"))
             break;
     }
0be130e3
     /* Did we hit a glob char or get to the end? */
3e1ff8eb
     return span != 0;
0be130e3
 #else
     return 0;
 #endif
 }
 
59e4e406
 /**
  * Get index range of image files matched by path.
  *
  * @param pfirst_index pointer to index updated with the first number in the range
  * @param plast_index  pointer to index updated with the last number in the range
  * @param path         path which has to be matched by the image files in the range
  * @param start_index  minimum accepted value for the first index in the range
  * @return -1 if no image file could be found
  */
15b4b505
 static int find_image_range(int *pfirst_index, int *plast_index,
9bece760
                             const char *path, int start_index, int start_index_range)
15b4b505
 {
     char buf[1024];
     int range, last_index, range1, first_index;
 
     /* find the first image */
9bece760
     for (first_index = start_index; first_index < start_index + start_index_range; first_index++) {
cc7d5cfe
         if (av_get_frame_filename(buf, sizeof(buf), path, first_index) < 0) {
15b4b505
             *pfirst_index =
cc7d5cfe
             *plast_index  = 1;
15b4b505
             if (avio_check(buf, AVIO_FLAG_READ) > 0)
                 return 0;
             return -1;
         }
         if (avio_check(buf, AVIO_FLAG_READ) > 0)
             break;
     }
9bece760
     if (first_index == start_index + start_index_range)
15b4b505
         goto fail;
 
     /* find the last image */
     last_index = first_index;
cc7d5cfe
     for (;;) {
15b4b505
         range = 0;
cc7d5cfe
         for (;;) {
15b4b505
             if (!range)
                 range1 = 1;
             else
                 range1 = 2 * range;
             if (av_get_frame_filename(buf, sizeof(buf), path,
                                       last_index + range1) < 0)
                 goto fail;
             if (avio_check(buf, AVIO_FLAG_READ) <= 0)
                 break;
             range = range1;
             /* just in case... */
             if (range >= (1 << 30))
                 goto fail;
         }
         /* we are sure than image last_index + range exists */
         if (!range)
             break;
         last_index += range;
     }
     *pfirst_index = first_index;
cc7d5cfe
     *plast_index  = last_index;
15b4b505
     return 0;
cc7d5cfe
 
 fail:
15b4b505
     return -1;
 }
 
cc7d5cfe
 static int img_read_probe(AVProbeData *p)
15b4b505
 {
     if (p->filename && ff_guess_image2_codec(p->filename)) {
         if (av_filename_number_test(p->filename))
             return AVPROBE_SCORE_MAX;
0be130e3
         else if (is_glob(p->filename))
             return AVPROBE_SCORE_MAX;
f83657fc
         else if (av_match_ext(p->filename, "raw") || av_match_ext(p->filename, "gif"))
b47396b6
             return 5;
15b4b505
         else
cc7d5cfe
             return AVPROBE_SCORE_MAX / 2;
15b4b505
     }
     return 0;
 }
 
cc7d5cfe
 static int img_read_header(AVFormatContext *s1)
15b4b505
 {
     VideoDemuxData *s = s1->priv_data;
     int first_index, last_index, ret = 0;
     int width = 0, height = 0;
     AVStream *st;
716d413c
     enum AVPixelFormat pix_fmt = AV_PIX_FMT_NONE;
15b4b505
     AVRational framerate;
 
     s1->ctx_flags |= AVFMTCTX_NOHEADER;
 
     st = avformat_new_stream(s1, NULL);
     if (!st) {
         return AVERROR(ENOMEM);
     }
 
cc7d5cfe
     if (s->pixel_format &&
         (pix_fmt = av_get_pix_fmt(s->pixel_format)) == AV_PIX_FMT_NONE) {
         av_log(s1, AV_LOG_ERROR, "No such pixel format: %s.\n",
                s->pixel_format);
15b4b505
         return AVERROR(EINVAL);
     }
cc7d5cfe
     if (s->video_size &&
         (ret = av_parse_video_size(&width, &height, s->video_size)) < 0) {
         av_log(s, AV_LOG_ERROR,
                "Could not parse video size: %s.\n", s->video_size);
15b4b505
         return ret;
     }
     if ((ret = av_parse_video_rate(&framerate, s->framerate)) < 0) {
cc7d5cfe
         av_log(s, AV_LOG_ERROR,
                "Could not parse framerate: %s.\n", s->framerate);
15b4b505
         return ret;
     }
 
     av_strlcpy(s->path, s1->filename, sizeof(s->path));
     s->img_number = 0;
cc7d5cfe
     s->img_count  = 0;
15b4b505
 
     /* find format */
     if (s1->iformat->flags & AVFMT_NOFILE)
         s->is_pipe = 0;
cc7d5cfe
     else {
         s->is_pipe       = 1;
15b4b505
         st->need_parsing = AVSTREAM_PARSE_FULL;
     }
 
     avpriv_set_pts_info(st, 60, framerate.den, framerate.num);
 
     if (width && height) {
         st->codec->width  = width;
         st->codec->height = height;
     }
 
     if (!s->is_pipe) {
3a06ea84
         if (s->pattern_type == PT_GLOB_SEQUENCE) {
0be130e3
         s->use_glob = is_glob(s->path);
         if (s->use_glob) {
3e1ff8eb
             char *p = s->path, *q, *dup;
0be130e3
             int gerr;
3e1ff8eb
 
3a06ea84
             av_log(s1, AV_LOG_WARNING, "Pattern type 'glob_sequence' is deprecated: "
                    "use pattern_type 'glob' instead\n");
 #if HAVE_GLOB
3e1ff8eb
             dup = q = av_strdup(p);
             while (*q) {
                 /* Do we have room for the next char and a \ insertion? */
                 if ((p - s->path) >= (sizeof(s->path) - 2))
                   break;
                 if (*q == '%' && strspn(q + 1, "%*?[]{}"))
                     ++q;
                 else if (strspn(q, "\\*?[]{}"))
                     *p++ = '\\';
                 *p++ = *q++;
             }
             *p = 0;
             av_free(dup);
 
d3d5e84f
             gerr = glob(s->path, GLOB_NOCHECK|GLOB_BRACE|GLOB_NOMAGIC, NULL, &s->globstate);
0be130e3
             if (gerr != 0) {
                 return AVERROR(ENOENT);
             }
             first_index = 0;
             last_index = s->globstate.gl_pathc - 1;
 #endif
3a06ea84
         }
         }
         if ((s->pattern_type == PT_GLOB_SEQUENCE && !s->use_glob) || s->pattern_type == PT_SEQUENCE) {
244682dd
             if (find_image_range(&first_index, &last_index, s->path,
9bece760
                                  s->start_number, s->start_number_range) < 0) {
b5c7318b
                 av_log(s1, AV_LOG_ERROR,
                        "Could find no file with with path '%s' and index in the range %d-%d\n",
9bece760
                        s->path, s->start_number, s->start_number + s->start_number_range - 1);
98b3f17b
                 return AVERROR(ENOENT);
b5c7318b
             }
3a06ea84
         } else if (s->pattern_type == PT_GLOB) {
 #if HAVE_GLOB
             int gerr;
             gerr = glob(s->path, GLOB_NOCHECK|GLOB_BRACE|GLOB_NOMAGIC, NULL, &s->globstate);
             if (gerr != 0) {
                 return AVERROR(ENOENT);
             }
             first_index = 0;
             last_index = s->globstate.gl_pathc - 1;
             s->use_glob = 1;
 #else
             av_log(s1, AV_LOG_ERROR,
                    "Pattern type 'glob' was selected but globbing "
                    "is not supported by this libavformat build\n");
             return AVERROR(ENOSYS);
 #endif
         } else if (s->pattern_type != PT_GLOB_SEQUENCE) {
             av_log(s1, AV_LOG_ERROR,
                    "Unknown value '%d' for pattern_type option\n", s->pattern_type);
             return AVERROR(EINVAL);
0be130e3
         }
cc7d5cfe
         s->img_first  = first_index;
         s->img_last   = last_index;
15b4b505
         s->img_number = first_index;
         /* compute duration */
         st->start_time = 0;
cc7d5cfe
         st->duration   = last_index - first_index + 1;
15b4b505
     }
 
cc7d5cfe
     if (s1->video_codec_id) {
15b4b505
         st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
cc7d5cfe
         st->codec->codec_id   = s1->video_codec_id;
     } else if (s1->audio_codec_id) {
15b4b505
         st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
cc7d5cfe
         st->codec->codec_id   = s1->audio_codec_id;
     } else {
db29a7c7
         const char *str = strrchr(s->path, '.');
         s->split_planes       = str && !av_strcasecmp(str + 1, "y");
15b4b505
         st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
cc7d5cfe
         st->codec->codec_id   = ff_guess_image2_codec(s->path);
7a72695c
         if (st->codec->codec_id == AV_CODEC_ID_LJPEG)
             st->codec->codec_id = AV_CODEC_ID_MJPEG;
15b4b505
     }
cc7d5cfe
     if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO &&
         pix_fmt != AV_PIX_FMT_NONE)
15b4b505
         st->codec->pix_fmt = pix_fmt;
 
     return 0;
 }
 
cc7d5cfe
 static int img_read_packet(AVFormatContext *s1, AVPacket *pkt)
15b4b505
 {
     VideoDemuxData *s = s1->priv_data;
0be130e3
     char filename_bytes[1024];
     char *filename = filename_bytes;
15b4b505
     int i;
cc7d5cfe
     int size[3]           = { 0 }, ret[3] = { 0 };
     AVIOContext *f[3]     = { NULL };
     AVCodecContext *codec = s1->streams[0]->codec;
15b4b505
 
     if (!s->is_pipe) {
         /* loop over input */
         if (s->loop && s->img_number > s->img_last) {
             s->img_number = s->img_first;
         }
         if (s->img_number > s->img_last)
             return AVERROR_EOF;
0be130e3
         if (s->use_glob) {
 #if HAVE_GLOB
             filename = s->globstate.gl_pathv[s->img_number];
 #endif
         } else {
         if (av_get_frame_filename(filename_bytes, sizeof(filename_bytes),
cc7d5cfe
                                   s->path,
                                   s->img_number) < 0 && s->img_number > 1)
15b4b505
             return AVERROR(EIO);
0be130e3
         }
cc7d5cfe
         for (i = 0; i < 3; i++) {
15b4b505
             if (avio_open2(&f[i], filename, AVIO_FLAG_READ,
                            &s1->interrupt_callback, NULL) < 0) {
cc7d5cfe
                 if (i >= 1)
15b4b505
                     break;
cc7d5cfe
                 av_log(s1, AV_LOG_ERROR, "Could not open file : %s\n",
                        filename);
15b4b505
                 return AVERROR(EIO);
             }
cc7d5cfe
             size[i] = avio_size(f[i]);
15b4b505
 
db29a7c7
             if (!s->split_planes)
15b4b505
                 break;
cc7d5cfe
             filename[strlen(filename) - 1] = 'U' + i;
15b4b505
         }
 
cc7d5cfe
         if (codec->codec_id == AV_CODEC_ID_RAWVIDEO && !codec->width)
15b4b505
             infer_size(&codec->width, &codec->height, size[0]);
     } else {
         f[0] = s1->pb;
e99f1a8c
         if (url_feof(f[0]))
15b4b505
             return AVERROR(EIO);
b56ff0b2
         if (s->frame_size > 0) {
             size[0] = s->frame_size;
         } else {
db29a7c7
             size[0] = 4096;
b56ff0b2
         }
15b4b505
     }
 
3f814891
     if (av_new_packet(pkt, size[0] + size[1] + size[2]) < 0)
         return AVERROR(ENOMEM);
15b4b505
     pkt->stream_index = 0;
cc7d5cfe
     pkt->flags       |= AV_PKT_FLAG_KEY;
05340be9
     if (!s->is_pipe)
         pkt->pts      = s->pts;
15b4b505
 
cc7d5cfe
     pkt->size = 0;
     for (i = 0; i < 3; i++) {
         if (f[i]) {
             ret[i] = avio_read(f[i], pkt->data + pkt->size, size[i]);
15b4b505
             if (!s->is_pipe)
                 avio_close(f[i]);
cc7d5cfe
             if (ret[i] > 0)
15b4b505
                 pkt->size += ret[i];
         }
     }
 
cc7d5cfe
     if (ret[0] <= 0 || ret[1] < 0 || ret[2] < 0) {
15b4b505
         av_free_packet(pkt);
         return AVERROR(EIO); /* signal EOF */
     } else {
         s->img_count++;
         s->img_number++;
05340be9
         s->pts++;
15b4b505
         return 0;
     }
 }
 
db29a7c7
 static int img_read_close(struct AVFormatContext* s1)
0be130e3
 {
     VideoDemuxData *s = s1->priv_data;
 #if HAVE_GLOB
     if (s->use_glob) {
         globfree(&s->globstate);
     }
 #endif
     return 0;
 }
 
55d32eed
 static int img_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
 {
     VideoDemuxData *s1 = s->priv_data;
 
05340be9
     if (timestamp < 0 || !s1->loop && timestamp > s1->img_last - s1->img_first)
55d32eed
         return -1;
05340be9
     s1->img_number = timestamp%(s1->img_last - s1->img_first + 1) + s1->img_first;
     s1->pts = timestamp;
55d32eed
     return 0;
 }
 
15b4b505
 #define OFFSET(x) offsetof(VideoDemuxData, x)
 #define DEC AV_OPT_FLAG_DECODING_PARAM
 static const AVOption options[] = {
db29a7c7
     { "framerate",    "set the video framerate",             OFFSET(framerate),    AV_OPT_TYPE_STRING, {.str = "25"}, 0, 0,       DEC },
     { "loop",         "force loop over input file sequence", OFFSET(loop),         AV_OPT_TYPE_INT,    {.i64 = 0   }, 0, 1,       DEC },
3a06ea84
 
db29a7c7
     { "pattern_type", "set pattern type",                    OFFSET(pattern_type), AV_OPT_TYPE_INT,    {.i64=PT_GLOB_SEQUENCE}, 0,       INT_MAX, DEC, "pattern_type"},
069d1564
     { "glob_sequence","select glob/sequence pattern type",   0, AV_OPT_TYPE_CONST,  {.i64=PT_GLOB_SEQUENCE}, INT_MIN, INT_MAX, DEC, "pattern_type" },
     { "glob",         "select glob pattern type",            0, AV_OPT_TYPE_CONST,  {.i64=PT_GLOB         }, INT_MIN, INT_MAX, DEC, "pattern_type" },
     { "sequence",     "select sequence pattern type",        0, AV_OPT_TYPE_CONST,  {.i64=PT_SEQUENCE     }, INT_MIN, INT_MAX, DEC, "pattern_type" },
3a06ea84
 
db29a7c7
     { "pixel_format", "set video pixel format",              OFFSET(pixel_format), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0,       DEC },
     { "start_number", "set first number in the sequence",    OFFSET(start_number), AV_OPT_TYPE_INT,    {.i64 = 0   }, 0, INT_MAX, DEC },
d46c1c72
     { "start_number_range", "set range for looking at the first sequence number", OFFSET(start_number_range), AV_OPT_TYPE_INT, {.i64 = 5}, 1, INT_MAX, DEC },
db29a7c7
     { "video_size",   "set video size",                      OFFSET(video_size),   AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0,       DEC },
     { "frame_size",   "force frame size in bytes",           OFFSET(frame_size),   AV_OPT_TYPE_INT,    {.i64 = 0   }, 0, INT_MAX, DEC },
15b4b505
     { NULL },
 };
 
 #if CONFIG_IMAGE2_DEMUXER
 static const AVClass img2_class = {
     .class_name = "image2 demuxer",
     .item_name  = av_default_item_name,
     .option     = options,
     .version    = LIBAVUTIL_VERSION_INT,
 };
 AVInputFormat ff_image2_demuxer = {
     .name           = "image2",
     .long_name      = NULL_IF_CONFIG_SMALL("image2 sequence"),
     .priv_data_size = sizeof(VideoDemuxData),
cc7d5cfe
     .read_probe     = img_read_probe,
     .read_header    = img_read_header,
     .read_packet    = img_read_packet,
db29a7c7
     .read_close     = img_read_close,
55d32eed
     .read_seek      = img_read_seek,
15b4b505
     .flags          = AVFMT_NOFILE,
     .priv_class     = &img2_class,
 };
 #endif
 #if CONFIG_IMAGE2PIPE_DEMUXER
 static const AVClass img2pipe_class = {
     .class_name = "image2pipe demuxer",
     .item_name  = av_default_item_name,
     .option     = options,
     .version    = LIBAVUTIL_VERSION_INT,
 };
 AVInputFormat ff_image2pipe_demuxer = {
     .name           = "image2pipe",
     .long_name      = NULL_IF_CONFIG_SMALL("piped image2 sequence"),
     .priv_data_size = sizeof(VideoDemuxData),
cc7d5cfe
     .read_header    = img_read_header,
     .read_packet    = img_read_packet,
15b4b505
     .priv_class     = &img2pipe_class,
 };
 #endif