8e032703fcea6478192846b867cfb4786f8fd8df
[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 "internal.h"
33
34 #include "libavutil/avassert.h"
35 #include "libavutil/log.h"
36 #include "libavutil/opt.h"
37 #include "libavutil/avstring.h"
38 #include "libavutil/parseutils.h"
39 #include "libavutil/mathematics.h"
40 #include "libavutil/time.h"
41 #include "libavutil/time_internal.h"
42 #include "libavutil/timestamp.h"
43
44 #define MAX_FILENAME_SIZE 1024
45
46 typedef struct WebMChunkContext {
47     const AVClass *class;
48     int chunk_start_index;
49     char *header_filename;
50     int chunk_duration;
51     int chunk_index;
52     uint64_t duration_written;
53     int prev_pts;
54     AVOutputFormat *oformat;
55     AVFormatContext *avf;
56 } WebMChunkContext;
57
58 static int chunk_mux_init(AVFormatContext *s)
59 {
60     WebMChunkContext *wc = s->priv_data;
61     AVFormatContext *oc;
62     int ret;
63
64     ret = avformat_alloc_output_context2(&wc->avf, wc->oformat, NULL, NULL);
65     if (ret < 0)
66         return ret;
67     oc = wc->avf;
68
69     oc->interrupt_callback = s->interrupt_callback;
70     oc->max_delay          = s->max_delay;
71     av_dict_copy(&oc->metadata, s->metadata, 0);
72
73     oc->priv_data = av_mallocz(oc->oformat->priv_data_size);
74     if (!oc->priv_data) {
75         avio_close(oc->pb);
76         return AVERROR(ENOMEM);
77     }
78     *(const AVClass**)oc->priv_data = oc->oformat->priv_class;
79     av_opt_set_defaults(oc->priv_data);
80     av_opt_set_int(oc->priv_data, "dash", 1, 0);
81     av_opt_set_int(oc->priv_data, "cluster_time_limit", wc->chunk_duration, 0);
82     av_opt_set_int(oc->priv_data, "live", 1, 0);
83
84     oc->streams = s->streams;
85     oc->nb_streams = s->nb_streams;
86
87     return 0;
88 }
89
90 static int get_chunk_filename(AVFormatContext *s, int is_header, char *filename)
91 {
92     WebMChunkContext *wc = s->priv_data;
93     AVFormatContext *oc = wc->avf;
94     if (!filename) {
95         return AVERROR(EINVAL);
96     }
97     if (is_header) {
98         if (!wc->header_filename) {
99             return AVERROR(EINVAL);
100         }
101         av_strlcpy(filename, wc->header_filename, strlen(wc->header_filename) + 1);
102     } else {
103         if (av_get_frame_filename(filename, MAX_FILENAME_SIZE,
104                                   s->filename, wc->chunk_index - 1) < 0) {
105             av_log(oc, AV_LOG_ERROR, "Invalid chunk filename template '%s'\n", s->filename);
106             return AVERROR(EINVAL);
107         }
108     }
109     return 0;
110 }
111
112 static int webm_chunk_write_header(AVFormatContext *s)
113 {
114     WebMChunkContext *wc = s->priv_data;
115     AVFormatContext *oc = NULL;
116     int ret;
117
118     // DASH Streams can only have either one track per file.
119     if (s->nb_streams != 1) { return AVERROR_INVALIDDATA; }
120
121     wc->chunk_index = wc->chunk_start_index;
122     wc->oformat = av_guess_format("webm", s->filename, "video/webm");
123     if (!wc->oformat)
124         return AVERROR_MUXER_NOT_FOUND;
125
126     ret = chunk_mux_init(s);
127     if (ret < 0)
128         return ret;
129     oc = wc->avf;
130     ret = get_chunk_filename(s, 1, oc->filename);
131     if (ret < 0)
132         return ret;
133     ret = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
134                      &s->interrupt_callback, NULL);
135     if (ret < 0)
136         return ret;
137
138     oc->pb->seekable = 0;
139     ret = oc->oformat->write_header(oc);
140     if (ret < 0)
141         return ret;
142     avio_close(oc->pb);
143     return 0;
144 }
145
146 static int chunk_start(AVFormatContext *s)
147 {
148     WebMChunkContext *wc = s->priv_data;
149     AVFormatContext *oc = wc->avf;
150     int ret;
151
152     ret = avio_open_dyn_buf(&oc->pb);
153     if (ret < 0)
154         return ret;
155     wc->chunk_index++;
156     return 0;
157 }
158
159 static int chunk_end(AVFormatContext *s)
160 {
161     WebMChunkContext *wc = s->priv_data;
162     AVFormatContext *oc = wc->avf;
163     int ret;
164     int buffer_size;
165     uint8_t *buffer;
166     AVIOContext *pb;
167     char filename[MAX_FILENAME_SIZE];
168
169     if (wc->chunk_start_index == wc->chunk_index)
170         return 0;
171     // Flush the cluster in WebM muxer.
172     oc->oformat->write_packet(oc, NULL);
173     buffer_size = avio_close_dyn_buf(oc->pb, &buffer);
174     ret = get_chunk_filename(s, 0, filename);
175     if (ret < 0)
176         goto fail;
177     ret = avio_open2(&pb, filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL);
178     if (ret < 0)
179         goto fail;
180     avio_write(pb, buffer, buffer_size);
181     ret = avio_close(pb);
182     if (ret < 0)
183         goto fail;
184     oc->pb = NULL;
185 fail:
186     av_free(buffer);
187     return (ret < 0) ? ret : 0;
188 }
189
190 static int webm_chunk_write_packet(AVFormatContext *s, AVPacket *pkt)
191 {
192     WebMChunkContext *wc = s->priv_data;
193     AVFormatContext *oc = wc->avf;
194     AVStream *st = s->streams[pkt->stream_index];
195     int ret;
196
197     if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
198         wc->duration_written += av_rescale_q(pkt->pts - wc->prev_pts,
199                                              st->time_base,
200                                              (AVRational) {1, 1000});
201         wc->prev_pts = pkt->pts;
202     }
203
204     // For video, a new chunk is started only on key frames. For audio, a new
205     // chunk is started based on chunk_duration.
206     if ((st->codec->codec_type == AVMEDIA_TYPE_VIDEO &&
207          (pkt->flags & AV_PKT_FLAG_KEY)) ||
208         (st->codec->codec_type == AVMEDIA_TYPE_AUDIO &&
209          (pkt->pts == 0 || wc->duration_written >= wc->chunk_duration))) {
210         wc->duration_written = 0;
211         if ((ret = chunk_end(s)) < 0 || (ret = chunk_start(s)) < 0) {
212             goto fail;
213         }
214     }
215
216     ret = oc->oformat->write_packet(oc, pkt);
217     if (ret < 0)
218         goto fail;
219
220 fail:
221     if (ret < 0) {
222         oc->streams = NULL;
223         oc->nb_streams = 0;
224         avformat_free_context(oc);
225     }
226
227     return ret;
228 }
229
230 static int webm_chunk_write_trailer(AVFormatContext *s)
231 {
232     WebMChunkContext *wc = s->priv_data;
233     AVFormatContext *oc = wc->avf;
234     oc->oformat->write_trailer(oc);
235     chunk_end(s);
236     oc->streams = NULL;
237     oc->nb_streams = 0;
238     avformat_free_context(oc);
239     return 0;
240 }
241
242 #define OFFSET(x) offsetof(WebMChunkContext, x)
243 static const AVOption options[] = {
244     { "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 },
245     { "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 },
246     { "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 },
247     { NULL },
248 };
249
250 #if CONFIG_WEBM_CHUNK_MUXER
251 static const AVClass webm_chunk_class = {
252     .class_name = "WebM Chunk Muxer",
253     .item_name  = av_default_item_name,
254     .option     = options,
255     .version    = LIBAVUTIL_VERSION_INT,
256 };
257
258 AVOutputFormat ff_webm_chunk_muxer = {
259     .name           = "webm_chunk",
260     .long_name      = NULL_IF_CONFIG_SMALL("WebM Chunk Muxer"),
261     .mime_type      = "video/webm",
262     .extensions     = "chk",
263     .flags          = AVFMT_NOFILE | AVFMT_GLOBALHEADER | AVFMT_NEEDNUMBER |
264                       AVFMT_TS_NONSTRICT | AVFMT_ALLOW_FLUSH,
265     .priv_data_size = sizeof(WebMChunkContext),
266     .write_header   = webm_chunk_write_header,
267     .write_packet   = webm_chunk_write_packet,
268     .write_trailer  = webm_chunk_write_trailer,
269     .priv_class     = &webm_chunk_class,
270 };
271 #endif