]> git.sesse.net Git - ffmpeg/blob - libavformat/webm_chunk.c
lavf/hls: add http_seekable option for HTTP partial requests
[ffmpeg] / 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     int64_t prev_pts;
56     ff_const59 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[MAX_FILENAME_SIZE])
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         int len;
96         if (!wc->header_filename) {
97             av_log(oc, AV_LOG_ERROR, "No header filename provided\n");
98             return AVERROR(EINVAL);
99         }
100         len = av_strlcpy(filename, wc->header_filename, MAX_FILENAME_SIZE);
101         if (len >= MAX_FILENAME_SIZE) {
102             av_log(oc, AV_LOG_ERROR, "Header filename too long\n");
103             return AVERROR(EINVAL);
104         }
105     } else {
106         if (av_get_frame_filename(filename, MAX_FILENAME_SIZE,
107                                   s->url, wc->chunk_index - 1) < 0) {
108             av_log(oc, AV_LOG_ERROR, "Invalid chunk filename template '%s'\n", s->url);
109             return AVERROR(EINVAL);
110         }
111     }
112     return 0;
113 }
114
115 static int webm_chunk_write_header(AVFormatContext *s)
116 {
117     WebMChunkContext *wc = s->priv_data;
118     AVFormatContext *oc = NULL;
119     int ret;
120     int i;
121     AVDictionary *options = NULL;
122     char oc_filename[MAX_FILENAME_SIZE];
123     char *oc_url;
124
125     // DASH Streams can only have either one track per file.
126     if (s->nb_streams != 1) { return AVERROR_INVALIDDATA; }
127
128     wc->chunk_index = wc->chunk_start_index;
129     wc->oformat = av_guess_format("webm", s->url, "video/webm");
130     if (!wc->oformat)
131         return AVERROR_MUXER_NOT_FOUND;
132     wc->prev_pts = AV_NOPTS_VALUE;
133
134     ret = chunk_mux_init(s);
135     if (ret < 0)
136         return ret;
137     oc = wc->avf;
138     ret = get_chunk_filename(s, 1, oc_filename);
139     if (ret < 0)
140         return ret;
141     oc_url = av_strdup(oc_filename);
142     if (!oc_url)
143         return AVERROR(ENOMEM);
144     ff_format_set_url(oc, oc_url);
145     if (wc->http_method)
146         av_dict_set(&options, "method", wc->http_method, 0);
147     ret = s->io_open(s, &oc->pb, oc->url, AVIO_FLAG_WRITE, &options);
148     av_dict_free(&options);
149     if (ret < 0)
150         return ret;
151
152     oc->pb->seekable = 0;
153     ret = oc->oformat->write_header(oc);
154     if (ret < 0)
155         return ret;
156     ff_format_io_close(s, &oc->pb);
157     for (i = 0; i < s->nb_streams; i++) {
158         // ms precision is the de-facto standard timescale for mkv files.
159         avpriv_set_pts_info(s->streams[i], 64, 1, 1000);
160     }
161     return 0;
162 }
163
164 static int chunk_start(AVFormatContext *s)
165 {
166     WebMChunkContext *wc = s->priv_data;
167     AVFormatContext *oc = wc->avf;
168     int ret;
169
170     ret = avio_open_dyn_buf(&oc->pb);
171     if (ret < 0)
172         return ret;
173     wc->chunk_index++;
174     return 0;
175 }
176
177 static int chunk_end(AVFormatContext *s, int flush)
178 {
179     WebMChunkContext *wc = s->priv_data;
180     AVFormatContext *oc = wc->avf;
181     int ret;
182     int buffer_size;
183     uint8_t *buffer;
184     AVIOContext *pb;
185     char filename[MAX_FILENAME_SIZE];
186     AVDictionary *options = NULL;
187
188     if (!oc->pb)
189         return 0;
190
191     if (flush)
192         // Flush the cluster in WebM muxer.
193         oc->oformat->write_packet(oc, NULL);
194     buffer_size = avio_close_dyn_buf(oc->pb, &buffer);
195     oc->pb = NULL;
196     ret = get_chunk_filename(s, 0, filename);
197     if (ret < 0)
198         goto fail;
199     if (wc->http_method)
200         av_dict_set(&options, "method", wc->http_method, 0);
201     ret = s->io_open(s, &pb, filename, AVIO_FLAG_WRITE, &options);
202     if (ret < 0)
203         goto fail;
204     avio_write(pb, buffer, buffer_size);
205     ff_format_io_close(s, &pb);
206 fail:
207     av_dict_free(&options);
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     ret = oc->oformat->write_packet(oc, pkt);
241
242     return ret;
243 }
244
245 static int webm_chunk_write_trailer(AVFormatContext *s)
246 {
247     WebMChunkContext *wc = s->priv_data;
248     AVFormatContext *oc = wc->avf;
249     int ret;
250
251     if (!oc->pb) {
252         ret = chunk_start(s);
253         if (ret < 0)
254             goto fail;
255     }
256     oc->oformat->write_trailer(oc);
257     ret = chunk_end(s, 0);
258 fail:
259     oc->streams = NULL;
260     oc->nb_streams = 0;
261     avformat_free_context(oc);
262     return ret;
263 }
264
265 #define OFFSET(x) offsetof(WebMChunkContext, x)
266 static const AVOption options[] = {
267     { "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 },
268     { "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 },
269     { "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 },
270     { "method", "set the HTTP method", OFFSET(http_method), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0, AV_OPT_FLAG_ENCODING_PARAM },
271     { NULL },
272 };
273
274 #if CONFIG_WEBM_CHUNK_MUXER
275 static const AVClass webm_chunk_class = {
276     .class_name = "WebM Chunk Muxer",
277     .item_name  = av_default_item_name,
278     .option     = options,
279     .version    = LIBAVUTIL_VERSION_INT,
280 };
281
282 AVOutputFormat ff_webm_chunk_muxer = {
283     .name           = "webm_chunk",
284     .long_name      = NULL_IF_CONFIG_SMALL("WebM Chunk Muxer"),
285     .mime_type      = "video/webm",
286     .extensions     = "chk",
287     .flags          = AVFMT_NOFILE | AVFMT_GLOBALHEADER | AVFMT_NEEDNUMBER |
288                       AVFMT_TS_NONSTRICT,
289     .priv_data_size = sizeof(WebMChunkContext),
290     .write_header   = webm_chunk_write_header,
291     .write_packet   = webm_chunk_write_packet,
292     .write_trailer  = webm_chunk_write_trailer,
293     .priv_class     = &webm_chunk_class,
294 };
295 #endif