2 * Copyright (c) 2015, Vignesh Venkatasubramanian
4 * This file is part of FFmpeg.
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.
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.
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
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.
32 #include "avio_internal.h"
35 #include "libavutil/avassert.h"
36 #include "libavutil/log.h"
37 #include "libavutil/opt.h"
38 #include "libavutil/avstring.h"
39 #include "libavutil/parseutils.h"
40 #include "libavutil/mathematics.h"
41 #include "libavutil/time.h"
42 #include "libavutil/time_internal.h"
43 #include "libavutil/timestamp.h"
45 #define MAX_FILENAME_SIZE 1024
47 typedef struct WebMChunkContext {
49 int chunk_start_index;
50 char *header_filename;
54 uint64_t duration_written;
56 AVOutputFormat *oformat;
60 static int chunk_mux_init(AVFormatContext *s)
62 WebMChunkContext *wc = s->priv_data;
66 ret = avformat_alloc_output_context2(&wc->avf, wc->oformat, NULL, NULL);
71 oc->interrupt_callback = s->interrupt_callback;
72 oc->max_delay = s->max_delay;
73 av_dict_copy(&oc->metadata, s->metadata, 0);
75 *(const AVClass**)oc->priv_data = oc->oformat->priv_class;
76 av_opt_set_defaults(oc->priv_data);
77 av_opt_set_int(oc->priv_data, "dash", 1, 0);
78 av_opt_set_int(oc->priv_data, "cluster_time_limit", wc->chunk_duration, 0);
79 av_opt_set_int(oc->priv_data, "live", 1, 0);
81 oc->streams = s->streams;
82 oc->nb_streams = s->nb_streams;
87 static int get_chunk_filename(AVFormatContext *s, int is_header, char *filename)
89 WebMChunkContext *wc = s->priv_data;
90 AVFormatContext *oc = wc->avf;
92 return AVERROR(EINVAL);
95 if (!wc->header_filename) {
96 av_log(oc, AV_LOG_ERROR, "No header filename provided\n");
97 return AVERROR(EINVAL);
99 av_strlcpy(filename, wc->header_filename, strlen(wc->header_filename) + 1);
101 if (av_get_frame_filename(filename, MAX_FILENAME_SIZE,
102 s->url, wc->chunk_index - 1) < 0) {
103 av_log(oc, AV_LOG_ERROR, "Invalid chunk filename template '%s'\n", s->url);
104 return AVERROR(EINVAL);
110 static int webm_chunk_write_header(AVFormatContext *s)
112 WebMChunkContext *wc = s->priv_data;
113 AVFormatContext *oc = NULL;
116 AVDictionary *options = NULL;
117 char oc_filename[MAX_FILENAME_SIZE];
120 // DASH Streams can only have either one track per file.
121 if (s->nb_streams != 1) { return AVERROR_INVALIDDATA; }
123 wc->chunk_index = wc->chunk_start_index;
124 wc->oformat = av_guess_format("webm", s->url, "video/webm");
126 return AVERROR_MUXER_NOT_FOUND;
128 ret = chunk_mux_init(s);
132 ret = get_chunk_filename(s, 1, oc_filename);
135 oc_url = av_strdup(oc_filename);
137 return AVERROR(ENOMEM);
138 ff_format_set_url(oc, oc_url);
140 av_dict_set(&options, "method", wc->http_method, 0);
141 ret = s->io_open(s, &oc->pb, oc->url, AVIO_FLAG_WRITE, &options);
142 av_dict_free(&options);
146 oc->pb->seekable = 0;
147 ret = oc->oformat->write_header(oc);
150 ff_format_io_close(s, &oc->pb);
151 for (i = 0; i < s->nb_streams; i++) {
152 // ms precision is the de-facto standard timescale for mkv files.
153 avpriv_set_pts_info(s->streams[i], 64, 1, 1000);
158 static int chunk_start(AVFormatContext *s)
160 WebMChunkContext *wc = s->priv_data;
161 AVFormatContext *oc = wc->avf;
164 ret = avio_open_dyn_buf(&oc->pb);
171 static int chunk_end(AVFormatContext *s)
173 WebMChunkContext *wc = s->priv_data;
174 AVFormatContext *oc = wc->avf;
179 char filename[MAX_FILENAME_SIZE];
180 AVDictionary *options = NULL;
182 if (wc->chunk_start_index == wc->chunk_index)
184 // Flush the cluster in WebM muxer.
185 oc->oformat->write_packet(oc, NULL);
186 buffer_size = avio_close_dyn_buf(oc->pb, &buffer);
187 ret = get_chunk_filename(s, 0, filename);
191 av_dict_set(&options, "method", wc->http_method, 0);
192 ret = s->io_open(s, &pb, filename, AVIO_FLAG_WRITE, &options);
195 avio_write(pb, buffer, buffer_size);
196 ff_format_io_close(s, &pb);
199 av_dict_free(&options);
201 return (ret < 0) ? ret : 0;
204 static int webm_chunk_write_packet(AVFormatContext *s, AVPacket *pkt)
206 WebMChunkContext *wc = s->priv_data;
207 AVFormatContext *oc = wc->avf;
208 AVStream *st = s->streams[pkt->stream_index];
211 if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO) {
212 wc->duration_written += av_rescale_q(pkt->pts - wc->prev_pts,
214 (AVRational) {1, 1000});
215 wc->prev_pts = pkt->pts;
218 // For video, a new chunk is started only on key frames. For audio, a new
219 // chunk is started based on chunk_duration.
220 if ((st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
221 (pkt->flags & AV_PKT_FLAG_KEY)) ||
222 (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO &&
223 (pkt->pts == 0 || wc->duration_written >= wc->chunk_duration))) {
224 wc->duration_written = 0;
225 if ((ret = chunk_end(s)) < 0 || (ret = chunk_start(s)) < 0) {
230 ret = oc->oformat->write_packet(oc, pkt);
238 avformat_free_context(oc);
244 static int webm_chunk_write_trailer(AVFormatContext *s)
246 WebMChunkContext *wc = s->priv_data;
247 AVFormatContext *oc = wc->avf;
248 oc->oformat->write_trailer(oc);
252 avformat_free_context(oc);
256 #define OFFSET(x) offsetof(WebMChunkContext, x)
257 static const AVOption options[] = {
258 { "chunk_start_index", "start index of the chunk", OFFSET(chunk_start_index), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
259 { "header", "filename of the header where the initialization data will be written", OFFSET(header_filename), AV_OPT_TYPE_STRING, { 0 }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
260 { "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 },
261 { "method", "set the HTTP method", OFFSET(http_method), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
265 #if CONFIG_WEBM_CHUNK_MUXER
266 static const AVClass webm_chunk_class = {
267 .class_name = "WebM Chunk Muxer",
268 .item_name = av_default_item_name,
270 .version = LIBAVUTIL_VERSION_INT,
273 AVOutputFormat ff_webm_chunk_muxer = {
274 .name = "webm_chunk",
275 .long_name = NULL_IF_CONFIG_SMALL("WebM Chunk Muxer"),
276 .mime_type = "video/webm",
278 .flags = AVFMT_NOFILE | AVFMT_GLOBALHEADER | AVFMT_NEEDNUMBER |
280 .priv_data_size = sizeof(WebMChunkContext),
281 .write_header = webm_chunk_write_header,
282 .write_packet = webm_chunk_write_packet,
283 .write_trailer = webm_chunk_write_trailer,
284 .priv_class = &webm_chunk_class,