af0d6b9d760ea676b5e866d74ca2a3c0480752d7
[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     char *header_filename;
50     int chunk_duration;
51     int chunk_index;
52     char *http_method;
53     uint64_t duration_written;
54     int64_t prev_pts;
55     AVFormatContext *avf;
56 } WebMChunkContext;
57
58 static int chunk_mux_init(AVFormatContext *s)
59 {
60     WebMChunkContext *wc = s->priv_data;
61     ff_const59 AVOutputFormat *oformat;
62     AVFormatContext *oc;
63     AVStream *st, *ost = s->streams[0];
64     AVDictionary *dict = NULL;
65     int ret;
66
67     if (!wc->header_filename) {
68         av_log(s, AV_LOG_ERROR, "No header filename provided\n");
69         return AVERROR(EINVAL);
70     }
71
72     oformat = av_guess_format("webm", s->url, "video/webm");
73     if (!oformat)
74         return AVERROR_MUXER_NOT_FOUND;
75
76     ret = avformat_alloc_output_context2(&wc->avf, oformat, NULL, NULL);
77     if (ret < 0)
78         return ret;
79     oc = wc->avf;
80
81     ff_format_set_url(oc, wc->header_filename);
82     wc->header_filename = NULL;
83
84     oc->interrupt_callback = s->interrupt_callback;
85     oc->max_delay          = s->max_delay;
86     oc->flags                 = s->flags & ~AVFMT_FLAG_FLUSH_PACKETS;
87     oc->strict_std_compliance = s->strict_std_compliance;
88     oc->avoid_negative_ts     = s->avoid_negative_ts;
89
90     oc->flush_packets         = 0;
91
92     av_dict_copy(&oc->metadata, s->metadata, 0);
93
94     if (!(st = avformat_new_stream(oc, NULL)))
95         return AVERROR(ENOMEM);
96
97     if ((ret = avcodec_parameters_copy(st->codecpar, ost->codecpar)) < 0 ||
98         (ret = av_dict_copy(&st->metadata, ost->metadata, 0))        < 0)
99         return ret;
100
101     st->sample_aspect_ratio = ost->sample_aspect_ratio;
102     st->disposition         = ost->disposition;
103     avpriv_set_pts_info(st, ost->pts_wrap_bits, ost->time_base.num,
104                                                 ost->time_base.den);
105
106     av_dict_set_int(&dict, "dash", 1, 0);
107     av_dict_set_int(&dict, "cluster_time_limit", wc->chunk_duration, 0);
108     av_dict_set_int(&dict, "live", 1, 0);
109
110     ret = avformat_init_output(oc, &dict);
111     av_dict_free(&dict);
112     if (ret < 0)
113         return ret;
114
115     // Copy the timing info back to the original stream
116     // so that the timestamps of the packets are directly usable
117     avpriv_set_pts_info(ost, st->pts_wrap_bits, st->time_base.num,
118                                                 st->time_base.den);
119
120     // This ensures that the timestamps will already be properly shifted
121     // when the packets arrive here, so we don't need to shift again.
122     s->avoid_negative_ts  = oc->avoid_negative_ts;
123     s->internal->avoid_negative_ts_use_pts =
124         oc->internal->avoid_negative_ts_use_pts;
125     oc->avoid_negative_ts = 0;
126
127     return 0;
128 }
129
130 static int get_chunk_filename(AVFormatContext *s, char filename[MAX_FILENAME_SIZE])
131 {
132     WebMChunkContext *wc = s->priv_data;
133     if (!filename) {
134         return AVERROR(EINVAL);
135     }
136         if (av_get_frame_filename(filename, MAX_FILENAME_SIZE,
137                                   s->url, wc->chunk_index - 1) < 0) {
138             av_log(s, AV_LOG_ERROR, "Invalid chunk filename template '%s'\n", s->url);
139             return AVERROR(EINVAL);
140         }
141     return 0;
142 }
143
144 static int webm_chunk_write_header(AVFormatContext *s)
145 {
146     WebMChunkContext *wc = s->priv_data;
147     AVFormatContext *oc = NULL;
148     int ret;
149     AVDictionary *options = NULL;
150
151     // DASH Streams can only have either one track per file.
152     if (s->nb_streams != 1) { return AVERROR_INVALIDDATA; }
153
154     wc->prev_pts = AV_NOPTS_VALUE;
155
156     ret = chunk_mux_init(s);
157     if (ret < 0)
158         return ret;
159     oc = wc->avf;
160     if (wc->http_method)
161         av_dict_set(&options, "method", wc->http_method, 0);
162     ret = s->io_open(s, &oc->pb, oc->url, AVIO_FLAG_WRITE, &options);
163     av_dict_free(&options);
164     if (ret < 0)
165         return ret;
166
167     oc->pb->seekable = 0;
168     ret = avformat_write_header(oc, NULL);
169     ff_format_io_close(s, &oc->pb);
170     if (ret < 0)
171         return ret;
172     return 0;
173 }
174
175 static int chunk_start(AVFormatContext *s)
176 {
177     WebMChunkContext *wc = s->priv_data;
178     AVFormatContext *oc = wc->avf;
179     int ret;
180
181     ret = avio_open_dyn_buf(&oc->pb);
182     if (ret < 0)
183         return ret;
184     wc->chunk_index++;
185     return 0;
186 }
187
188 static int chunk_end(AVFormatContext *s, int flush)
189 {
190     WebMChunkContext *wc = s->priv_data;
191     AVFormatContext *oc = wc->avf;
192     int ret;
193     int buffer_size;
194     uint8_t *buffer;
195     AVIOContext *pb;
196     char filename[MAX_FILENAME_SIZE];
197     AVDictionary *options = NULL;
198
199     if (!oc->pb)
200         return 0;
201
202     if (flush)
203         // Flush the cluster in WebM muxer.
204         av_write_frame(oc, NULL);
205     buffer_size = avio_close_dyn_buf(oc->pb, &buffer);
206     oc->pb = NULL;
207     ret = get_chunk_filename(s, filename);
208     if (ret < 0)
209         goto fail;
210     if (wc->http_method)
211         av_dict_set(&options, "method", wc->http_method, 0);
212     ret = s->io_open(s, &pb, filename, AVIO_FLAG_WRITE, &options);
213     if (ret < 0)
214         goto fail;
215     avio_write(pb, buffer, buffer_size);
216     ff_format_io_close(s, &pb);
217 fail:
218     av_dict_free(&options);
219     av_free(buffer);
220     return (ret < 0) ? ret : 0;
221 }
222
223 static int webm_chunk_write_packet(AVFormatContext *s, AVPacket *pkt)
224 {
225     WebMChunkContext *wc = s->priv_data;
226     AVFormatContext *oc = wc->avf;
227     AVStream *st = s->streams[pkt->stream_index];
228     int ret;
229
230     if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO) {
231         if (wc->prev_pts != AV_NOPTS_VALUE)
232             wc->duration_written += av_rescale_q(pkt->pts - wc->prev_pts,
233                                                  st->time_base,
234                                                  (AVRational) {1, 1000});
235         wc->prev_pts = pkt->pts;
236     }
237
238     // For video, a new chunk is started only on key frames. For audio, a new
239     // chunk is started based on chunk_duration. Also, a new chunk is started
240     // unconditionally if there is no currently open chunk.
241     if (!oc->pb || (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
242          (pkt->flags & AV_PKT_FLAG_KEY)) ||
243         (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO &&
244          wc->duration_written >= wc->chunk_duration)) {
245         wc->duration_written = 0;
246         if ((ret = chunk_end(s, 1)) < 0 || (ret = chunk_start(s)) < 0) {
247             return ret;
248         }
249     }
250
251     // We only have one stream, so use the non-interleaving av_write_frame.
252     return av_write_frame(oc, pkt);
253 }
254
255 static int webm_chunk_write_trailer(AVFormatContext *s)
256 {
257     WebMChunkContext *wc = s->priv_data;
258     AVFormatContext *oc = wc->avf;
259     int ret;
260
261     if (!oc->pb) {
262         ret = chunk_start(s);
263         if (ret < 0)
264             goto fail;
265     }
266     av_write_trailer(oc);
267     ret = chunk_end(s, 0);
268 fail:
269     avformat_free_context(oc);
270     return ret;
271 }
272
273 #define OFFSET(x) offsetof(WebMChunkContext, x)
274 static const AVOption options[] = {
275     { "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 },
276     { "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 },
277     { "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 },
278     { "method", "set the HTTP method", OFFSET(http_method), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0, AV_OPT_FLAG_ENCODING_PARAM },
279     { NULL },
280 };
281
282 #if CONFIG_WEBM_CHUNK_MUXER
283 static const AVClass webm_chunk_class = {
284     .class_name = "WebM Chunk Muxer",
285     .item_name  = av_default_item_name,
286     .option     = options,
287     .version    = LIBAVUTIL_VERSION_INT,
288 };
289
290 AVOutputFormat ff_webm_chunk_muxer = {
291     .name           = "webm_chunk",
292     .long_name      = NULL_IF_CONFIG_SMALL("WebM Chunk Muxer"),
293     .mime_type      = "video/webm",
294     .extensions     = "chk",
295     .flags          = AVFMT_NOFILE | AVFMT_GLOBALHEADER | AVFMT_NEEDNUMBER |
296                       AVFMT_TS_NONSTRICT,
297     .priv_data_size = sizeof(WebMChunkContext),
298     .write_header   = webm_chunk_write_header,
299     .write_packet   = webm_chunk_write_packet,
300     .write_trailer  = webm_chunk_write_trailer,
301     .priv_class     = &webm_chunk_class,
302 };
303 #endif