avformat/dashenc: Added comments
[ffmpeg.git] / 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 <float.h>
28 #include <time.h>
29
30 #include "avformat.h"
31 #include "avio.h"
32 #include "avio_internal.h"
33 #include "internal.h"
34
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"
44
45 #define MAX_FILENAME_SIZE 1024
46
47 typedef struct WebMChunkContext {
48     const AVClass *class;
49     int chunk_start_index;
50     char *header_filename;
51     int chunk_duration;
52     int chunk_index;
53     char *http_method;
54     uint64_t duration_written;
55     int prev_pts;
56     AVOutputFormat *oformat;
57     AVFormatContext *avf;
58 } WebMChunkContext;
59
60 static int chunk_mux_init(AVFormatContext *s)
61 {
62     WebMChunkContext *wc = s->priv_data;
63     AVFormatContext *oc;
64     int ret;
65
66     ret = avformat_alloc_output_context2(&wc->avf, wc->oformat, NULL, NULL);
67     if (ret < 0)
68         return ret;
69     oc = wc->avf;
70
71     oc->interrupt_callback = s->interrupt_callback;
72     oc->max_delay          = s->max_delay;
73     av_dict_copy(&oc->metadata, s->metadata, 0);
74
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);
80
81     oc->streams = s->streams;
82     oc->nb_streams = s->nb_streams;
83
84     return 0;
85 }
86
87 static int get_chunk_filename(AVFormatContext *s, int is_header, char *filename)
88 {
89     WebMChunkContext *wc = s->priv_data;
90     AVFormatContext *oc = wc->avf;
91     if (!filename) {
92         return AVERROR(EINVAL);
93     }
94     if (is_header) {
95         if (!wc->header_filename) {
96             av_log(oc, AV_LOG_ERROR, "No header filename provided\n");
97             return AVERROR(EINVAL);
98         }
99         av_strlcpy(filename, wc->header_filename, strlen(wc->header_filename) + 1);
100     } else {
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);
105         }
106     }
107     return 0;
108 }
109
110 static int webm_chunk_write_header(AVFormatContext *s)
111 {
112     WebMChunkContext *wc = s->priv_data;
113     AVFormatContext *oc = NULL;
114     int ret;
115     int i;
116     AVDictionary *options = NULL;
117     char oc_filename[MAX_FILENAME_SIZE];
118     char *oc_url;
119
120     // DASH Streams can only have either one track per file.
121     if (s->nb_streams != 1) { return AVERROR_INVALIDDATA; }
122
123     wc->chunk_index = wc->chunk_start_index;
124     wc->oformat = av_guess_format("webm", s->url, "video/webm");
125     if (!wc->oformat)
126         return AVERROR_MUXER_NOT_FOUND;
127
128     ret = chunk_mux_init(s);
129     if (ret < 0)
130         return ret;
131     oc = wc->avf;
132     ret = get_chunk_filename(s, 1, oc_filename);
133     if (ret < 0)
134         return ret;
135     oc_url = av_strdup(oc_filename);
136     if (!oc_url)
137         return AVERROR(ENOMEM);
138     ff_format_set_url(oc, oc_url);
139     if (wc->http_method)
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);
143     if (ret < 0)
144         return ret;
145
146     oc->pb->seekable = 0;
147     ret = oc->oformat->write_header(oc);
148     if (ret < 0)
149         return ret;
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);
154     }
155     return 0;
156 }
157
158 static int chunk_start(AVFormatContext *s)
159 {
160     WebMChunkContext *wc = s->priv_data;
161     AVFormatContext *oc = wc->avf;
162     int ret;
163
164     ret = avio_open_dyn_buf(&oc->pb);
165     if (ret < 0)
166         return ret;
167     wc->chunk_index++;
168     return 0;
169 }
170
171 static int chunk_end(AVFormatContext *s)
172 {
173     WebMChunkContext *wc = s->priv_data;
174     AVFormatContext *oc = wc->avf;
175     int ret;
176     int buffer_size;
177     uint8_t *buffer;
178     AVIOContext *pb;
179     char filename[MAX_FILENAME_SIZE];
180     AVDictionary *options = NULL;
181
182     if (wc->chunk_start_index == wc->chunk_index)
183         return 0;
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);
188     if (ret < 0)
189         goto fail;
190     if (wc->http_method)
191         av_dict_set(&options, "method", wc->http_method, 0);
192     ret = s->io_open(s, &pb, filename, AVIO_FLAG_WRITE, &options);
193     if (ret < 0)
194         goto fail;
195     avio_write(pb, buffer, buffer_size);
196     ff_format_io_close(s, &pb);
197     oc->pb = NULL;
198 fail:
199     av_dict_free(&options);
200     av_free(buffer);
201     return (ret < 0) ? ret : 0;
202 }
203
204 static int webm_chunk_write_packet(AVFormatContext *s, AVPacket *pkt)
205 {
206     WebMChunkContext *wc = s->priv_data;
207     AVFormatContext *oc = wc->avf;
208     AVStream *st = s->streams[pkt->stream_index];
209     int ret;
210
211     if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO) {
212         wc->duration_written += av_rescale_q(pkt->pts - wc->prev_pts,
213                                              st->time_base,
214                                              (AVRational) {1, 1000});
215         wc->prev_pts = pkt->pts;
216     }
217
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) {
226             goto fail;
227         }
228     }
229
230     ret = oc->oformat->write_packet(oc, pkt);
231     if (ret < 0)
232         goto fail;
233
234 fail:
235     if (ret < 0) {
236         oc->streams = NULL;
237         oc->nb_streams = 0;
238         avformat_free_context(oc);
239     }
240
241     return ret;
242 }
243
244 static int webm_chunk_write_trailer(AVFormatContext *s)
245 {
246     WebMChunkContext *wc = s->priv_data;
247     AVFormatContext *oc = wc->avf;
248     oc->oformat->write_trailer(oc);
249     chunk_end(s);
250     oc->streams = NULL;
251     oc->nb_streams = 0;
252     avformat_free_context(oc);
253     return 0;
254 }
255
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 },
262     { NULL },
263 };
264
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,
269     .option     = options,
270     .version    = LIBAVUTIL_VERSION_INT,
271 };
272
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",
277     .extensions     = "chk",
278     .flags          = AVFMT_NOFILE | AVFMT_GLOBALHEADER | AVFMT_NEEDNUMBER |
279                       AVFMT_TS_NONSTRICT,
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,
285 };
286 #endif