git.sesse.net Git - ffmpeg/blob - libavformat/webm_chunk.c

   1 /*
   2  * Copyright (c) 2015, Vignesh Venkatasubramanian
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file WebM Chunk Muxer
  23  * The chunk muxer enables writing WebM Live chunks where there is a header
  24  * chunk, followed by data chunks where each Cluster is written out as a Chunk.
  25  */
  26
  27 #include "avformat.h"
  28 #include "avio.h"
  29 #include "avio_internal.h"
  30 #include "internal.h"
  31
  32 #include "libavutil/log.h"
  33 #include "libavutil/opt.h"
  34 #include "libavutil/mathematics.h"
  35
  36 #define MAX_FILENAME_SIZE 1024
  37
  38 typedef struct WebMChunkContext {
  39     const AVClass *class;
  40     char *header_filename;
  41     int chunk_duration;
  42     int chunk_index;
  43     char *http_method;
  44     uint64_t duration_written;
  45     int64_t prev_pts;
  46     AVFormatContext *avf;
  47     int header_written;
  48 } WebMChunkContext;
  49
  50 static int webm_chunk_init(AVFormatContext *s)
  51 {
  52     WebMChunkContext *wc = s->priv_data;
  53     const AVOutputFormat *oformat;
  54     AVFormatContext *oc;
  55     AVStream *st, *ost = s->streams[0];
  56     AVDictionary *dict = NULL;
  57     int ret;
  58
  59     // DASH Streams can only have one track per file.
  60     if (s->nb_streams != 1)
  61         return AVERROR(EINVAL);
  62
  63     if (!wc->header_filename) {
  64         av_log(s, AV_LOG_ERROR, "No header filename provided\n");
  65         return AVERROR(EINVAL);
  66     }
  67
  68     wc->prev_pts = AV_NOPTS_VALUE;
  69
  70     oformat = av_guess_format("webm", s->url, "video/webm");
  71     if (!oformat)
  72         return AVERROR_MUXER_NOT_FOUND;
  73
  74     ret = avformat_alloc_output_context2(&wc->avf, oformat, NULL, NULL);
  75     if (ret < 0)
  76         return ret;
  77     oc = wc->avf;
  78
  79     ff_format_set_url(oc, wc->header_filename);
  80     wc->header_filename = NULL;
  81
  82     oc->interrupt_callback    = s->interrupt_callback;
  83     oc->max_delay             = s->max_delay;
  84     oc->flags                 = s->flags & ~AVFMT_FLAG_FLUSH_PACKETS;
  85     oc->strict_std_compliance = s->strict_std_compliance;
  86     oc->avoid_negative_ts     = s->avoid_negative_ts;
  87
  88     oc->flush_packets         = 0;
  89
  90     if ((ret = av_dict_copy(&oc->metadata, s->metadata, 0)) < 0)
  91         return ret;
  92
  93     if (!(st = avformat_new_stream(oc, NULL)))
  94         return AVERROR(ENOMEM);
  95
  96     if ((ret = ff_stream_encode_params_copy(st, ost)) < 0)
  97         return ret;
  98
  99     if (wc->http_method)
 100         if ((ret = av_dict_set(&dict, "method", wc->http_method, 0)) < 0)
 101             return ret;
 102     ret = s->io_open(s, &oc->pb, oc->url, AVIO_FLAG_WRITE, &dict);
 103     av_dict_free(&dict);
 104     if (ret < 0)
 105         return ret;
 106     oc->pb->seekable = 0;
 107
 108     if ((ret = av_dict_set_int(&dict, "dash", 1, 0))   < 0 ||
 109         (ret = av_dict_set_int(&dict, "cluster_time_limit",
 110                                wc->chunk_duration, 0)) < 0 ||
 111         (ret = av_dict_set_int(&dict, "live", 1, 0))   < 0)
 112         goto fail;
 113
 114     ret = avformat_init_output(oc, &dict);
 115 fail:
 116     av_dict_free(&dict);
 117     if (ret < 0)
 118         return ret;
 119
 120     // Copy the timing info back to the original stream
 121     // so that the timestamps of the packets are directly usable
 122     avpriv_set_pts_info(ost, st->pts_wrap_bits, st->time_base.num,
 123                                                 st->time_base.den);
 124
 125     // This ensures that the timestamps will already be properly shifted
 126     // when the packets arrive here, so we don't need to shift again.
 127     s->avoid_negative_ts  = oc->avoid_negative_ts;
 128     s->internal->avoid_negative_ts_use_pts =
 129         oc->internal->avoid_negative_ts_use_pts;
 130     oc->avoid_negative_ts = 0;
 131
 132     return 0;
 133 }
 134
 135 static int get_chunk_filename(AVFormatContext *s, char filename[MAX_FILENAME_SIZE])
 136 {
 137     WebMChunkContext *wc = s->priv_data;
 138     if (!filename) {
 139         return AVERROR(EINVAL);
 140     }
 141     if (av_get_frame_filename(filename, MAX_FILENAME_SIZE,
 142                               s->url, wc->chunk_index - 1) < 0) {
 143         av_log(s, AV_LOG_ERROR, "Invalid chunk filename template '%s'\n", s->url);
 144         return AVERROR(EINVAL);
 145     }
 146     return 0;
 147 }
 148
 149 static int webm_chunk_write_header(AVFormatContext *s)
 150 {
 151     WebMChunkContext *wc = s->priv_data;
 152     AVFormatContext *oc = wc->avf;
 153     int ret;
 154
 155     ret = avformat_write_header(oc, NULL);
 156     ff_format_io_close(s, &oc->pb);
 157     wc->header_written = 1;
 158     if (ret < 0)
 159         return ret;
 160     return 0;
 161 }
 162
 163 static int chunk_start(AVFormatContext *s)
 164 {
 165     WebMChunkContext *wc = s->priv_data;
 166     AVFormatContext *oc = wc->avf;
 167     int ret;
 168
 169     ret = avio_open_dyn_buf(&oc->pb);
 170     if (ret < 0)
 171         return ret;
 172     wc->chunk_index++;
 173     return 0;
 174 }
 175
 176 static int chunk_end(AVFormatContext *s, int flush)
 177 {
 178     WebMChunkContext *wc = s->priv_data;
 179     AVFormatContext *oc = wc->avf;
 180     int ret;
 181     int buffer_size;
 182     uint8_t *buffer;
 183     AVIOContext *pb;
 184     char filename[MAX_FILENAME_SIZE];
 185     AVDictionary *options = NULL;
 186
 187     if (!oc->pb)
 188         return 0;
 189
 190     if (flush)
 191         // Flush the cluster in WebM muxer.
 192         av_write_frame(oc, NULL);
 193     buffer_size = avio_close_dyn_buf(oc->pb, &buffer);
 194     oc->pb = NULL;
 195     ret = get_chunk_filename(s, filename);
 196     if (ret < 0)
 197         goto fail;
 198     if (wc->http_method)
 199         if ((ret = av_dict_set(&options, "method", wc->http_method, 0)) < 0)
 200             goto fail;
 201     ret = s->io_open(s, &pb, filename, AVIO_FLAG_WRITE, &options);
 202     av_dict_free(&options);
 203     if (ret < 0)
 204         goto fail;
 205     avio_write(pb, buffer, buffer_size);
 206     ff_format_io_close(s, &pb);
 207 fail:
 208     av_free(buffer);
 209     return (ret < 0) ? ret : 0;
 210 }
 211
 212 static int webm_chunk_write_packet(AVFormatContext *s, AVPacket *pkt)
 213 {
 214     WebMChunkContext *wc = s->priv_data;
 215     AVFormatContext *oc = wc->avf;
 216     AVStream *st = s->streams[pkt->stream_index];
 217     int ret;
 218
 219     if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO) {
 220         if (wc->prev_pts != AV_NOPTS_VALUE)
 221             wc->duration_written += av_rescale_q(pkt->pts - wc->prev_pts,
 222                                                  st->time_base,
 223                                                  (AVRational) {1, 1000});
 224         wc->prev_pts = pkt->pts;
 225     }
 226
 227     // For video, a new chunk is started only on key frames. For audio, a new
 228     // chunk is started based on chunk_duration. Also, a new chunk is started
 229     // unconditionally if there is no currently open chunk.
 230     if (!oc->pb || (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
 231          (pkt->flags & AV_PKT_FLAG_KEY)) ||
 232         (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO &&
 233          wc->duration_written >= wc->chunk_duration)) {
 234         wc->duration_written = 0;
 235         if ((ret = chunk_end(s, 1)) < 0 || (ret = chunk_start(s)) < 0) {
 236             return ret;
 237         }
 238     }
 239
 240     // We only have one stream, so use the non-interleaving av_write_frame.
 241     return av_write_frame(oc, pkt);
 242 }
 243
 244 static int webm_chunk_write_trailer(AVFormatContext *s)
 245 {
 246     WebMChunkContext *wc = s->priv_data;
 247     AVFormatContext *oc = wc->avf;
 248     int ret;
 249
 250     if (!oc->pb) {
 251         ret = chunk_start(s);
 252         if (ret < 0)
 253             return ret;
 254     }
 255     ret = av_write_trailer(oc);
 256     if (ret < 0)
 257         return ret;
 258     return chunk_end(s, 0);
 259 }
 260
 261 static void webm_chunk_deinit(AVFormatContext *s)
 262 {
 263     WebMChunkContext *wc = s->priv_data;
 264
 265     if (!wc->avf)
 266         return;
 267
 268     if (wc->header_written)
 269         ffio_free_dyn_buf(&wc->avf->pb);
 270     else
 271         ff_format_io_close(s, &wc->avf->pb);
 272     avformat_free_context(wc->avf);
 273     wc->avf = NULL;
 274 }
 275
 276 #define OFFSET(x) offsetof(WebMChunkContext, x)
 277 static const AVOption options[] = {
 278     { "chunk_start_index",  "start index of the chunk", OFFSET(chunk_index), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
 279     { "header", "filename of the header where the initialization data will be written", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
 280     { "audio_chunk_duration", "duration of each chunk in milliseconds", OFFSET(chunk_duration), AV_OPT_TYPE_INT, {.i64 = 5000}, 0, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
 281     { "method", "set the HTTP method", OFFSET(http_method), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0, AV_OPT_FLAG_ENCODING_PARAM },
 282     { NULL },
 283 };
 284
 285 static const AVClass webm_chunk_class = {
 286     .class_name = "WebM Chunk Muxer",
 287     .item_name  = av_default_item_name,
 288     .option     = options,
 289     .version    = LIBAVUTIL_VERSION_INT,
 290 };
 291
 292 const AVOutputFormat ff_webm_chunk_muxer = {
 293     .name           = "webm_chunk",
 294     .long_name      = NULL_IF_CONFIG_SMALL("WebM Chunk Muxer"),
 295     .mime_type      = "video/webm",
 296     .extensions     = "chk",
 297     .flags          = AVFMT_NOFILE | AVFMT_GLOBALHEADER | AVFMT_NEEDNUMBER |
 298                       AVFMT_TS_NONSTRICT,
 299     .priv_data_size = sizeof(WebMChunkContext),
 300     .init           = webm_chunk_init,
 301     .write_header   = webm_chunk_write_header,
 302     .write_packet   = webm_chunk_write_packet,
 303     .write_trailer  = webm_chunk_write_trailer,
 304     .deinit         = webm_chunk_deinit,
 305     .priv_class     = &webm_chunk_class,
 306 };