text: /*
   * Copyright (c) 2010 Stefano Sabatini
   * Copyright (c) 2008 Victor Paesa
   *
   * This file is part of FFmpeg.
   *
   * FFmpeg is free software; you can redistribute it and/or
   * 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.
   *
   * FFmpeg is distributed in the hope that it will be useful,
   * 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
   * License along with FFmpeg; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
   */
  
  /**
   * @file
   * movie video source
   *
   * @todo use direct rendering (no allocation of a new frame)
   * @todo support a PTS correction mechanism
   */
  
  #include <float.h>
  #include <stdint.h>
  
  #include "libavutil/attributes.h"
  #include "libavutil/avstring.h"
  #include "libavutil/avassert.h"
  #include "libavutil/opt.h"
  #include "libavutil/imgutils.h"
  #include "libavutil/timestamp.h"
  #include "libavformat/avformat.h"
  #include "audio.h"
  #include "avcodec.h"
  #include "avfilter.h"
  #include "formats.h"
  #include "internal.h"
  #include "video.h"
  
  typedef struct MovieStream {
      AVStream *st;
      int done;
  } MovieStream;
  
  typedef struct MovieContext {
      /* common A/V fields */
      const AVClass *class;
      int64_t seek_point;   ///< seekpoint in microseconds
      double seek_point_d;
      char *format_name;
      char *file_name;
      char *stream_specs; /**< user-provided list of streams, separated by + */
      int stream_index; /**< for compatibility */
      int loop_count;
  
      AVFormatContext *format_ctx;
      int eof;
      AVPacket pkt, pkt0;
      AVFrame *frame;   ///< video frame to store the decoded images in
  
      int max_stream_index; /**< max stream # actually used for output */
      MovieStream *st; /**< array of all streams, one per output */
      int *out_index; /**< stream number -> output number map, or -1 */
  } MovieContext;
  
  #define OFFSET(x) offsetof(MovieContext, x)
  #define FLAGS AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_VIDEO_PARAM
  
  static const AVOption movie_options[]= {
      { "filename",     NULL,                      OFFSET(file_name),    AV_OPT_TYPE_STRING,                                    .flags = FLAGS },
      { "format_name",  "set format name",         OFFSET(format_name),  AV_OPT_TYPE_STRING,                                    .flags = FLAGS },
      { "f",            "set format name",         OFFSET(format_name),  AV_OPT_TYPE_STRING,                                    .flags = FLAGS },
      { "stream_index", "set stream index",        OFFSET(stream_index), AV_OPT_TYPE_INT,    { .i64 = -1 }, -1, INT_MAX,                 FLAGS  },
      { "si",           "set stream index",        OFFSET(stream_index), AV_OPT_TYPE_INT,    { .i64 = -1 }, -1, INT_MAX,                 FLAGS  },
      { "seek_point",   "set seekpoint (seconds)", OFFSET(seek_point_d), AV_OPT_TYPE_DOUBLE, { .dbl =  0 },  0, (INT64_MAX-1) / 1000000, FLAGS },
      { "sp",           "set seekpoint (seconds)", OFFSET(seek_point_d), AV_OPT_TYPE_DOUBLE, { .dbl =  0 },  0, (INT64_MAX-1) / 1000000, FLAGS },
      { "streams",      "set streams",             OFFSET(stream_specs), AV_OPT_TYPE_STRING, {.str =  0},  CHAR_MAX, CHAR_MAX, FLAGS },
      { "s",            "set streams",             OFFSET(stream_specs), AV_OPT_TYPE_STRING, {.str =  0},  CHAR_MAX, CHAR_MAX, FLAGS },
      { "loop",         "set loop count",          OFFSET(loop_count),   AV_OPT_TYPE_INT,    {.i64 =  1},  0,        INT_MAX, FLAGS },
      { NULL },
  };
  
  static int movie_config_output_props(AVFilterLink *outlink);
  static int movie_request_frame(AVFilterLink *outlink);
  
  static AVStream *find_stream(void *log, AVFormatContext *avf, const char *spec)
  {
      int i, ret, already = 0, stream_id = -1;
      char type_char[2], dummy;
      AVStream *found = NULL;
      enum AVMediaType type;
  
      ret = sscanf(spec, "d%1[av]%d%c", type_char, &stream_id, &dummy);
      if (ret >= 1 && ret <= 2) {
          type = type_char[0] == 'v' ? AVMEDIA_TYPE_VIDEO : AVMEDIA_TYPE_AUDIO;
          ret = av_find_best_stream(avf, type, stream_id, -1, NULL, 0);
          if (ret < 0) {
              av_log(log, AV_LOG_ERROR, "No %s stream with index '%d' found\n",
                     av_get_media_type_string(type), stream_id);
              return NULL;
          }
          return avf->streams[ret];
      }
      for (i = 0; i < avf->nb_streams; i++) {
          ret = avformat_match_stream_specifier(avf, avf->streams[i], spec);
          if (ret < 0) {
              av_log(log, AV_LOG_ERROR,
                     "Invalid stream specifier \"%s\"\n", spec);
              return NULL;
          }
          if (!ret)
              continue;
          if (avf->streams[i]->discard != AVDISCARD_ALL) {
              already++;
              continue;
          }
          if (found) {
              av_log(log, AV_LOG_WARNING,
                     "Ambiguous stream specifier \"%s\", using #%d\n", spec, i);
              break;
          }
          found = avf->streams[i];
      }
      if (!found) {
          av_log(log, AV_LOG_WARNING, "Stream specifier \"%s\" %s\n", spec,
                 already ? "matched only already used streams" :
                           "did not match any stream");
          return NULL;
      }
      if (found->codec->codec_type != AVMEDIA_TYPE_VIDEO &&
          found->codec->codec_type != AVMEDIA_TYPE_AUDIO) {
          av_log(log, AV_LOG_ERROR, "Stream specifier \"%s\" matched a %s stream,"
                 "currently unsupported by libavfilter\n", spec,
                 av_get_media_type_string(found->codec->codec_type));
          return NULL;
      }
      return found;
  }
  
  static int open_stream(void *log, MovieStream *st)
  {
      AVCodec *codec;
      int ret;
  
      codec = avcodec_find_decoder(st->st->codec->codec_id);
      if (!codec) {
          av_log(log, AV_LOG_ERROR, "Failed to find any codec\n");
          return AVERROR(EINVAL);
      }
  
      st->st->codec->refcounted_frames = 1;
  
      if ((ret = avcodec_open2(st->st->codec, codec, NULL)) < 0) {
          av_log(log, AV_LOG_ERROR, "Failed to open codec\n");
          return ret;
      }
  
      return 0;
  }
  
  static int guess_channel_layout(MovieStream *st, int st_index, void *log_ctx)
  {
      AVCodecContext *dec_ctx = st->st->codec;
      char buf[256];
      int64_t chl = av_get_default_channel_layout(dec_ctx->channels);
  
      if (!chl) {
          av_log(log_ctx, AV_LOG_ERROR,
                 "Channel layout is not set in stream %d, and could not "
                 "be guessed from the number of channels (%d)\n",
                 st_index, dec_ctx->channels);
          return AVERROR(EINVAL);
      }
  
      av_get_channel_layout_string(buf, sizeof(buf), dec_ctx->channels, chl);
      av_log(log_ctx, AV_LOG_WARNING,
             "Channel layout is not set in output stream %d, "
             "guessed channel layout is '%s'\n",
             st_index, buf);
      dec_ctx->channel_layout = chl;
      return 0;
  }
  
  static av_cold int movie_common_init(AVFilterContext *ctx)
  {
      MovieContext *movie = ctx->priv;
      AVInputFormat *iformat = NULL;
      int64_t timestamp;
      int nb_streams, ret, i;
      char default_streams[16], *stream_specs, *spec, *cursor;
      char name[16];
      AVStream *st;
  
      if (!movie->file_name) {
          av_log(ctx, AV_LOG_ERROR, "No filename provided!\n");
          return AVERROR(EINVAL);
      }
  
      movie->seek_point = movie->seek_point_d * 1000000 + 0.5;
  
      stream_specs = movie->stream_specs;
      if (!stream_specs) {
          snprintf(default_streams, sizeof(default_streams), "d%c%d",
                   !strcmp(ctx->filter->name, "amovie") ? 'a' : 'v',
                   movie->stream_index);
          stream_specs = default_streams;
      }
      for (cursor = stream_specs, nb_streams = 1; *cursor; cursor++)
          if (*cursor == '+')
              nb_streams++;
  
      if (movie->loop_count != 1 && nb_streams != 1) {
          av_log(ctx, AV_LOG_ERROR,
                 "Loop with several streams is currently unsupported\n");
          return AVERROR_PATCHWELCOME;
      }
  
      av_register_all();
  
      // Try to find the movie format (container)
      iformat = movie->format_name ? av_find_input_format(movie->format_name) : NULL;
  
      movie->format_ctx = NULL;
      if ((ret = avformat_open_input(&movie->format_ctx, movie->file_name, iformat, NULL)) < 0) {
          av_log(ctx, AV_LOG_ERROR,
                 "Failed to avformat_open_input '%s'\n", movie->file_name);
          return ret;
      }
      if ((ret = avformat_find_stream_info(movie->format_ctx, NULL)) < 0)
          av_log(ctx, AV_LOG_WARNING, "Failed to find stream info\n");
  
      // if seeking requested, we execute it
      if (movie->seek_point > 0) {
          timestamp = movie->seek_point;
          // add the stream start time, should it exist
          if (movie->format_ctx->start_time != AV_NOPTS_VALUE) {
              if (timestamp > INT64_MAX - movie->format_ctx->start_time) {
                  av_log(ctx, AV_LOG_ERROR,
                         "%s: seek value overflow with start_time:%"PRId64" seek_point:%"PRId64"\n",
                         movie->file_name, movie->format_ctx->start_time, movie->seek_point);
                  return AVERROR(EINVAL);
              }
              timestamp += movie->format_ctx->start_time;
          }
          if ((ret = av_seek_frame(movie->format_ctx, -1, timestamp, AVSEEK_FLAG_BACKWARD)) < 0) {
              av_log(ctx, AV_LOG_ERROR, "%s: could not seek to position %"PRId64"\n",
                     movie->file_name, timestamp);
              return ret;
          }
      }
  
      for (i = 0; i < movie->format_ctx->nb_streams; i++)
          movie->format_ctx->streams[i]->discard = AVDISCARD_ALL;
  
      movie->st = av_calloc(nb_streams, sizeof(*movie->st));
      if (!movie->st)
          return AVERROR(ENOMEM);
  
      for (i = 0; i < nb_streams; i++) {
          spec = av_strtok(stream_specs, "+", &cursor);
          if (!spec)
              return AVERROR_BUG;
          stream_specs = NULL; /* for next strtok */
          st = find_stream(ctx, movie->format_ctx, spec);
          if (!st)
              return AVERROR(EINVAL);
          st->discard = AVDISCARD_DEFAULT;
          movie->st[i].st = st;
          movie->max_stream_index = FFMAX(movie->max_stream_index, st->index);
      }
      if (av_strtok(NULL, "+", &cursor))
          return AVERROR_BUG;
  
      movie->out_index = av_calloc(movie->max_stream_index + 1,
                                   sizeof(*movie->out_index));
      if (!movie->out_index)
          return AVERROR(ENOMEM);
      for (i = 0; i <= movie->max_stream_index; i++)
          movie->out_index[i] = -1;
      for (i = 0; i < nb_streams; i++)
          movie->out_index[movie->st[i].st->index] = i;
  
      for (i = 0; i < nb_streams; i++) {
          AVFilterPad pad = { 0 };
          snprintf(name, sizeof(name), "out%d", i);
          pad.type          = movie->st[i].st->codec->codec_type;
          pad.name          = av_strdup(name);
          if (!pad.name)
              return AVERROR(ENOMEM);
          pad.config_props  = movie_config_output_props;
          pad.request_frame = movie_request_frame;
          ff_insert_outpad(ctx, i, &pad);
          ret = open_stream(ctx, &movie->st[i]);
          if (ret < 0)
              return ret;
          if ( movie->st[i].st->codec->codec->type == AVMEDIA_TYPE_AUDIO &&
              !movie->st[i].st->codec->channel_layout) {
              ret = guess_channel_layout(&movie->st[i], i, ctx);
              if (ret < 0)
                  return ret;
          }
      }
  
      av_log(ctx, AV_LOG_VERBOSE, "seek_point:%"PRIi64" format_name:%s file_name:%s stream_index:%d\n",
             movie->seek_point, movie->format_name, movie->file_name,
             movie->stream_index);
  
      return 0;
  }
  
  static av_cold void movie_uninit(AVFilterContext *ctx)
  {
      MovieContext *movie = ctx->priv;
      int i;
  
      for (i = 0; i < ctx->nb_outputs; i++) {
          av_freep(&ctx->output_pads[i].name);
          if (movie->st[i].st)
              avcodec_close(movie->st[i].st->codec);
      }
      av_freep(&movie->st);
      av_freep(&movie->out_index);
      av_frame_free(&movie->frame);
      if (movie->format_ctx)
          avformat_close_input(&movie->format_ctx);
  }
  
  static int movie_query_formats(AVFilterContext *ctx)
  {
      MovieContext *movie = ctx->priv;
      int list[] = { 0, -1 };
      int64_t list64[] = { 0, -1 };
      int i;
  
      for (i = 0; i < ctx->nb_outputs; i++) {
          MovieStream *st = &movie->st[i];
          AVCodecContext *c = st->st->codec;
          AVFilterLink *outlink = ctx->outputs[i];
  
          switch (c->codec_type) {
          case AVMEDIA_TYPE_VIDEO:
              list[0] = c->pix_fmt;
              ff_formats_ref(ff_make_format_list(list), &outlink->in_formats);
              break;
          case AVMEDIA_TYPE_AUDIO:
              list[0] = c->sample_fmt;
              ff_formats_ref(ff_make_format_list(list), &outlink->in_formats);
              list[0] = c->sample_rate;
              ff_formats_ref(ff_make_format_list(list), &outlink->in_samplerates);
              list64[0] = c->channel_layout;
              ff_channel_layouts_ref(avfilter_make_format64_list(list64),
                                     &outlink->in_channel_layouts);
              break;
          }
      }
  
      return 0;
  }
  
  static int movie_config_output_props(AVFilterLink *outlink)
  {
      AVFilterContext *ctx = outlink->src;
      MovieContext *movie  = ctx->priv;
      unsigned out_id = FF_OUTLINK_IDX(outlink);
      MovieStream *st = &movie->st[out_id];
      AVCodecContext *c = st->st->codec;
  
      outlink->time_base = st->st->time_base;
  
      switch (c->codec_type) {
      case AVMEDIA_TYPE_VIDEO:
          outlink->w          = c->width;
          outlink->h          = c->height;
          outlink->frame_rate = st->st->r_frame_rate;
          break;
      case AVMEDIA_TYPE_AUDIO:
          break;
      }
  
      return 0;
  }
  
  static char *describe_frame_to_str(char *dst, size_t dst_size,
                                     AVFrame *frame, enum AVMediaType frame_type,
                                     AVFilterLink *link)
  {
      switch (frame_type) {
      case AVMEDIA_TYPE_VIDEO:
          snprintf(dst, dst_size,
                   "video pts:%s time:%s size:%dx%d aspect:%d/%d",
                   av_ts2str(frame->pts), av_ts2timestr(frame->pts, &link->time_base),
                   frame->width, frame->height,
                   frame->sample_aspect_ratio.num,
                   frame->sample_aspect_ratio.den);
                   break;
      case AVMEDIA_TYPE_AUDIO:
          snprintf(dst, dst_size,
                   "audio pts:%s time:%s samples:%d",
                   av_ts2str(frame->pts), av_ts2timestr(frame->pts, &link->time_base),
                   frame->nb_samples);
                   break;
      default:
          snprintf(dst, dst_size, "%s BUG", av_get_media_type_string(frame_type));
          break;
      }
      return dst;
  }
  
  static int rewind_file(AVFilterContext *ctx)
  {
      MovieContext *movie = ctx->priv;
      int64_t timestamp = movie->seek_point;
      int ret, i;
  
      if (movie->format_ctx->start_time != AV_NOPTS_VALUE)
          timestamp += movie->format_ctx->start_time;
      ret = av_seek_frame(movie->format_ctx, -1, timestamp, AVSEEK_FLAG_BACKWARD);
      if (ret < 0) {
          av_log(ctx, AV_LOG_ERROR, "Unable to loop: %s\n", av_err2str(ret));
          movie->loop_count = 1; /* do not try again */
          return ret;
      }
  
      for (i = 0; i < ctx->nb_outputs; i++) {
          avcodec_flush_buffers(movie->st[i].st->codec);
          movie->st[i].done = 0;
      }
      movie->eof = 0;
      return 0;
  }
  
  /**
   * Try to push a frame to the requested output.
   *
   * @param ctx     filter context
   * @param out_id  number of output where a frame is wanted;
   *                if the frame is read from file, used to set the return value;
   *                if the codec is being flushed, flush the corresponding stream
   * @return  1 if a frame was pushed on the requested output,
   *          0 if another attempt is possible,
   *          <0 AVERROR code
   */
  static int movie_push_frame(AVFilterContext *ctx, unsigned out_id)
  {
      MovieContext *movie = ctx->priv;
      AVPacket *pkt = &movie->pkt;
      enum AVMediaType frame_type;
      MovieStream *st;
      int ret, got_frame = 0, pkt_out_id;
      AVFilterLink *outlink;
  
      if (!pkt->size) {
          if (movie->eof) {
              if (movie->st[out_id].done) {
                  if (movie->loop_count != 1) {
                      ret = rewind_file(ctx);
                      if (ret < 0)
                          return ret;
                      movie->loop_count -= movie->loop_count > 1;
                      av_log(ctx, AV_LOG_VERBOSE, "Stream finished, looping.\n");
                      return 0; /* retry */
                  }
                  return AVERROR_EOF;
              }
              pkt->stream_index = movie->st[out_id].st->index;
              /* packet is already ready for flushing */
          } else {
              ret = av_read_frame(movie->format_ctx, &movie->pkt0);
              if (ret < 0) {
                  av_init_packet(&movie->pkt0); /* ready for flushing */
                  *pkt = movie->pkt0;
                  if (ret == AVERROR_EOF) {
                      movie->eof = 1;
                      return 0; /* start flushing */
                  }
                  return ret;
              }
              *pkt = movie->pkt0;
          }
      }
  
      pkt_out_id = pkt->stream_index > movie->max_stream_index ? -1 :
                   movie->out_index[pkt->stream_index];
      if (pkt_out_id < 0) {
          av_free_packet(&movie->pkt0);
          pkt->size = 0; /* ready for next run */
          pkt->data = NULL;
          return 0;
      }
      st = &movie->st[pkt_out_id];
      outlink = ctx->outputs[pkt_out_id];
  
      movie->frame = av_frame_alloc();
      if (!movie->frame)
          return AVERROR(ENOMEM);
  
      frame_type = st->st->codec->codec_type;
      switch (frame_type) {
      case AVMEDIA_TYPE_VIDEO:
          ret = avcodec_decode_video2(st->st->codec, movie->frame, &got_frame, pkt);
          break;
      case AVMEDIA_TYPE_AUDIO:
          ret = avcodec_decode_audio4(st->st->codec, movie->frame, &got_frame, pkt);
          break;
      default:
          ret = AVERROR(ENOSYS);
          break;
      }
      if (ret < 0) {
          av_log(ctx, AV_LOG_WARNING, "Decode error: %s\n", av_err2str(ret));
          av_frame_free(&movie->frame);
          av_free_packet(&movie->pkt0);
          movie->pkt.size = 0;
          movie->pkt.data = NULL;
          return 0;
      }
      if (!ret || st->st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
          ret = pkt->size;
  
      pkt->data += ret;
      pkt->size -= ret;
      if (pkt->size <= 0) {
          av_free_packet(&movie->pkt0);
          pkt->size = 0; /* ready for next run */
          pkt->data = NULL;
      }
      if (!got_frame) {
          if (!ret)
              st->done = 1;
          av_frame_free(&movie->frame);
          return 0;
      }
  
      movie->frame->pts = av_frame_get_best_effort_timestamp(movie->frame);
      av_dlog(ctx, "movie_push_frame(): file:'%s' %s\n", movie->file_name,
              describe_frame_to_str((char[1024]){0}, 1024, movie->frame, frame_type, outlink));
  
      if (st->st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
          if (movie->frame->format != outlink->format) {
              av_log(ctx, AV_LOG_ERROR, "Format changed %s -> %s, discarding frame\n",
                  av_get_pix_fmt_name(outlink->format),
                  av_get_pix_fmt_name(movie->frame->format)
                  );
              av_frame_free(&movie->frame);
              return 0;
          }
      }
      ret = ff_filter_frame(outlink, movie->frame);
      movie->frame = NULL;
  
      if (ret < 0)
          return ret;
      return pkt_out_id == out_id;
  }
  
  static int movie_request_frame(AVFilterLink *outlink)
  {
      AVFilterContext *ctx = outlink->src;
      unsigned out_id = FF_OUTLINK_IDX(outlink);
      int ret;
  
      while (1) {
          ret = movie_push_frame(ctx, out_id);
          if (ret)
              return FFMIN(ret, 0);
      }
  }
  
  #if CONFIG_MOVIE_FILTER
  
  AVFILTER_DEFINE_CLASS(movie);
  
  AVFilter ff_avsrc_movie = {
      .name          = "movie",
      .description   = NULL_IF_CONFIG_SMALL("Read from a movie source."),
      .priv_size     = sizeof(MovieContext),
      .priv_class    = &movie_class,
      .init          = movie_common_init,
      .uninit        = movie_uninit,
      .query_formats = movie_query_formats,
  
      .inputs    = NULL,
      .outputs   = NULL,
      .flags     = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
  };
  
  #endif  /* CONFIG_MOVIE_FILTER */
  
  #if CONFIG_AMOVIE_FILTER
  
  #define amovie_options movie_options
  AVFILTER_DEFINE_CLASS(amovie);
  
  AVFilter ff_avsrc_amovie = {
      .name          = "amovie",
      .description   = NULL_IF_CONFIG_SMALL("Read audio from a movie source."),
      .priv_size     = sizeof(MovieContext),
      .init          = movie_common_init,
      .uninit        = movie_uninit,
      .query_formats = movie_query_formats,
  
      .inputs     = NULL,
      .outputs    = NULL,
      .priv_class = &amovie_class,
      .flags      = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
  };
  
  #endif /* CONFIG_AMOVIE_FILTER */
  