dashenc: add option to provide UTC timing source
[ffmpeg.git] / libavformat / dashenc.c
1 /*
2  * MPEG-DASH ISO BMFF segmenter
3  * Copyright (c) 2014 Martin Storsjo
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include "config.h"
23 #if HAVE_UNISTD_H
24 #include <unistd.h>
25 #endif
26
27 #include "libavutil/avstring.h"
28 #include "libavutil/intreadwrite.h"
29 #include "libavutil/mathematics.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/time_internal.h"
32
33 #include "avc.h"
34 #include "avformat.h"
35 #include "avio_internal.h"
36 #include "internal.h"
37 #include "isom.h"
38 #include "os_support.h"
39 #include "url.h"
40
41 // See ISO/IEC 23009-1:2014 5.3.9.4.4
42 typedef enum {
43     DASH_TMPL_ID_UNDEFINED = -1,
44     DASH_TMPL_ID_ESCAPE,
45     DASH_TMPL_ID_REP_ID,
46     DASH_TMPL_ID_NUMBER,
47     DASH_TMPL_ID_BANDWIDTH,
48     DASH_TMPL_ID_TIME,
49 } DASHTmplId;
50
51 typedef struct Segment {
52     char file[1024];
53     int64_t start_pos;
54     int range_length, index_length;
55     int64_t time;
56     int duration;
57     int n;
58 } Segment;
59
60 typedef struct OutputStream {
61     AVFormatContext *ctx;
62     int ctx_inited;
63     uint8_t iobuf[32768];
64     AVIOContext *out;
65     int packets_written;
66     char initfile[1024];
67     int64_t init_start_pos;
68     int init_range_length;
69     int nb_segments, segments_size, segment_index;
70     Segment **segments;
71     int64_t first_pts, start_pts, max_pts;
72     int64_t last_dts;
73     int bit_rate;
74     char bandwidth_str[64];
75
76     char codec_str[100];
77 } OutputStream;
78
79 typedef struct DASHContext {
80     const AVClass *class;  /* Class for private options. */
81     int window_size;
82     int extra_window_size;
83     int min_seg_duration;
84     int remove_at_exit;
85     int use_template;
86     int use_timeline;
87     int single_file;
88     OutputStream *streams;
89     int has_video, has_audio;
90     int64_t last_duration;
91     int64_t total_duration;
92     char availability_start_time[100];
93     char dirname[1024];
94     const char *single_file_name;
95     const char *init_seg_name;
96     const char *media_seg_name;
97     const char *utc_timing_url;
98 } DASHContext;
99
100 static int dash_write(void *opaque, uint8_t *buf, int buf_size)
101 {
102     OutputStream *os = opaque;
103     if (os->out)
104         avio_write(os->out, buf, buf_size);
105     return buf_size;
106 }
107
108 // RFC 6381
109 static void set_codec_str(AVFormatContext *s, AVCodecParameters *par,
110                           char *str, int size)
111 {
112     const AVCodecTag *tags[2] = { NULL, NULL };
113     uint32_t tag;
114     if (par->codec_type == AVMEDIA_TYPE_VIDEO)
115         tags[0] = ff_codec_movvideo_tags;
116     else if (par->codec_type == AVMEDIA_TYPE_AUDIO)
117         tags[0] = ff_codec_movaudio_tags;
118     else
119         return;
120
121     tag = av_codec_get_tag(tags, par->codec_id);
122     if (!tag)
123         return;
124     if (size < 5)
125         return;
126
127     AV_WL32(str, tag);
128     str[4] = '\0';
129     if (!strcmp(str, "mp4a") || !strcmp(str, "mp4v")) {
130         uint32_t oti;
131         tags[0] = ff_mp4_obj_type;
132         oti = av_codec_get_tag(tags, par->codec_id);
133         if (oti)
134             av_strlcatf(str, size, ".%02"SCNx32, oti);
135         else
136             return;
137
138         if (tag == MKTAG('m', 'p', '4', 'a')) {
139             if (par->extradata_size >= 2) {
140                 int aot = par->extradata[0] >> 3;
141                 if (aot == 31)
142                     aot = ((AV_RB16(par->extradata) >> 5) & 0x3f) + 32;
143                 av_strlcatf(str, size, ".%d", aot);
144             }
145         } else if (tag == MKTAG('m', 'p', '4', 'v')) {
146             // Unimplemented, should output ProfileLevelIndication as a decimal number
147             av_log(s, AV_LOG_WARNING, "Incomplete RFC 6381 codec string for mp4v\n");
148         }
149     } else if (!strcmp(str, "avc1")) {
150         uint8_t *tmpbuf = NULL;
151         uint8_t *extradata = par->extradata;
152         int extradata_size = par->extradata_size;
153         if (!extradata_size)
154             return;
155         if (extradata[0] != 1) {
156             AVIOContext *pb;
157             if (avio_open_dyn_buf(&pb) < 0)
158                 return;
159             if (ff_isom_write_avcc(pb, extradata, extradata_size) < 0) {
160                 ffio_free_dyn_buf(&pb);
161                 return;
162             }
163             extradata_size = avio_close_dyn_buf(pb, &extradata);
164             tmpbuf = extradata;
165         }
166
167         if (extradata_size >= 4)
168             av_strlcatf(str, size, ".%02x%02x%02x",
169                         extradata[1], extradata[2], extradata[3]);
170         av_free(tmpbuf);
171     }
172 }
173
174 static void dash_free(AVFormatContext *s)
175 {
176     DASHContext *c = s->priv_data;
177     int i, j;
178     if (!c->streams)
179         return;
180     for (i = 0; i < s->nb_streams; i++) {
181         OutputStream *os = &c->streams[i];
182         if (os->ctx && os->ctx_inited)
183             av_write_trailer(os->ctx);
184         if (os->ctx && os->ctx->pb)
185             av_free(os->ctx->pb);
186         ff_format_io_close(s, &os->out);
187         if (os->ctx)
188             avformat_free_context(os->ctx);
189         for (j = 0; j < os->nb_segments; j++)
190             av_free(os->segments[j]);
191         av_free(os->segments);
192     }
193     av_freep(&c->streams);
194 }
195
196 static void output_segment_list(OutputStream *os, AVIOContext *out, DASHContext *c)
197 {
198     int i, start_index = 0, start_number = 1;
199     if (c->window_size) {
200         start_index  = FFMAX(os->nb_segments   - c->window_size, 0);
201         start_number = FFMAX(os->segment_index - c->window_size, 1);
202     }
203
204     if (c->use_template) {
205         int timescale = c->use_timeline ? os->ctx->streams[0]->time_base.den : AV_TIME_BASE;
206         avio_printf(out, "\t\t\t\t<SegmentTemplate timescale=\"%d\" ", timescale);
207         if (!c->use_timeline)
208             avio_printf(out, "duration=\"%"PRId64"\" ", c->last_duration);
209         avio_printf(out, "initialization=\"%s\" media=\"%s\" startNumber=\"%d\">\n", c->init_seg_name, c->media_seg_name, c->use_timeline ? start_number : 1);
210         if (c->use_timeline) {
211             int64_t cur_time = 0;
212             avio_printf(out, "\t\t\t\t\t<SegmentTimeline>\n");
213             for (i = start_index; i < os->nb_segments; ) {
214                 Segment *seg = os->segments[i];
215                 int repeat = 0;
216                 avio_printf(out, "\t\t\t\t\t\t<S ");
217                 if (i == start_index || seg->time != cur_time) {
218                     cur_time = seg->time;
219                     avio_printf(out, "t=\"%"PRId64"\" ", seg->time);
220                 }
221                 avio_printf(out, "d=\"%d\" ", seg->duration);
222                 while (i + repeat + 1 < os->nb_segments &&
223                        os->segments[i + repeat + 1]->duration == seg->duration &&
224                        os->segments[i + repeat + 1]->time == os->segments[i + repeat]->time + os->segments[i + repeat]->duration)
225                     repeat++;
226                 if (repeat > 0)
227                     avio_printf(out, "r=\"%d\" ", repeat);
228                 avio_printf(out, "/>\n");
229                 i += 1 + repeat;
230                 cur_time += (1 + repeat) * seg->duration;
231             }
232             avio_printf(out, "\t\t\t\t\t</SegmentTimeline>\n");
233         }
234         avio_printf(out, "\t\t\t\t</SegmentTemplate>\n");
235     } else if (c->single_file) {
236         avio_printf(out, "\t\t\t\t<BaseURL>%s</BaseURL>\n", os->initfile);
237         avio_printf(out, "\t\t\t\t<SegmentList timescale=\"%d\" duration=\"%"PRId64"\" startNumber=\"%d\">\n", AV_TIME_BASE, c->last_duration, start_number);
238         avio_printf(out, "\t\t\t\t\t<Initialization range=\"%"PRId64"-%"PRId64"\" />\n", os->init_start_pos, os->init_start_pos + os->init_range_length - 1);
239         for (i = start_index; i < os->nb_segments; i++) {
240             Segment *seg = os->segments[i];
241             avio_printf(out, "\t\t\t\t\t<SegmentURL mediaRange=\"%"PRId64"-%"PRId64"\" ", seg->start_pos, seg->start_pos + seg->range_length - 1);
242             if (seg->index_length)
243                 avio_printf(out, "indexRange=\"%"PRId64"-%"PRId64"\" ", seg->start_pos, seg->start_pos + seg->index_length - 1);
244             avio_printf(out, "/>\n");
245         }
246         avio_printf(out, "\t\t\t\t</SegmentList>\n");
247     } else {
248         avio_printf(out, "\t\t\t\t<SegmentList timescale=\"%d\" duration=\"%"PRId64"\" startNumber=\"%d\">\n", AV_TIME_BASE, c->last_duration, start_number);
249         avio_printf(out, "\t\t\t\t\t<Initialization sourceURL=\"%s\" />\n", os->initfile);
250         for (i = start_index; i < os->nb_segments; i++) {
251             Segment *seg = os->segments[i];
252             avio_printf(out, "\t\t\t\t\t<SegmentURL media=\"%s\" />\n", seg->file);
253         }
254         avio_printf(out, "\t\t\t\t</SegmentList>\n");
255     }
256 }
257
258 static DASHTmplId dash_read_tmpl_id(const char *identifier, char *format_tag,
259                                     size_t format_tag_size, const char **ptr) {
260     const char *next_ptr;
261     DASHTmplId id_type = DASH_TMPL_ID_UNDEFINED;
262
263     if (av_strstart(identifier, "$$", &next_ptr)) {
264         id_type = DASH_TMPL_ID_ESCAPE;
265         *ptr = next_ptr;
266     } else if (av_strstart(identifier, "$RepresentationID$", &next_ptr)) {
267         id_type = DASH_TMPL_ID_REP_ID;
268         // default to basic format, as $RepresentationID$ identifiers
269         // are not allowed to have custom format-tags.
270         av_strlcpy(format_tag, "%d", format_tag_size);
271         *ptr = next_ptr;
272     } else { // the following identifiers may have an explicit format_tag
273         if (av_strstart(identifier, "$Number", &next_ptr))
274             id_type = DASH_TMPL_ID_NUMBER;
275         else if (av_strstart(identifier, "$Bandwidth", &next_ptr))
276             id_type = DASH_TMPL_ID_BANDWIDTH;
277         else if (av_strstart(identifier, "$Time", &next_ptr))
278             id_type = DASH_TMPL_ID_TIME;
279         else
280             id_type = DASH_TMPL_ID_UNDEFINED;
281
282         // next parse the dash format-tag and generate a c-string format tag
283         // (next_ptr now points at the first '%' at the beginning of the format-tag)
284         if (id_type != DASH_TMPL_ID_UNDEFINED) {
285             const char *number_format = (id_type == DASH_TMPL_ID_TIME) ? PRId64 : "d";
286             if (next_ptr[0] == '$') { // no dash format-tag
287                 snprintf(format_tag, format_tag_size, "%%%s", number_format);
288                 *ptr = &next_ptr[1];
289             } else {
290                 const char *width_ptr;
291                 // only tolerate single-digit width-field (i.e. up to 9-digit width)
292                 if (av_strstart(next_ptr, "%0", &width_ptr) &&
293                     av_isdigit(width_ptr[0]) &&
294                     av_strstart(&width_ptr[1], "d$", &next_ptr)) {
295                     // yes, we're using a format tag to build format_tag.
296                     snprintf(format_tag, format_tag_size, "%s%c%s", "%0", width_ptr[0], number_format);
297                     *ptr = next_ptr;
298                 } else {
299                     av_log(NULL, AV_LOG_WARNING, "Failed to parse format-tag beginning with %s. Expected either a "
300                                                  "closing '$' character or a format-string like '%%0[width]d', "
301                                                  "where width must be a single digit\n", next_ptr);
302                     id_type = DASH_TMPL_ID_UNDEFINED;
303                 }
304             }
305         }
306     }
307     return id_type;
308 }
309
310 static void dash_fill_tmpl_params(char *dst, size_t buffer_size,
311                                   const char *template, int rep_id,
312                                   int number, int bit_rate,
313                                   int64_t time) {
314     int dst_pos = 0;
315     const char *t_cur = template;
316     while (dst_pos < buffer_size - 1 && *t_cur) {
317         char format_tag[7]; // May be "%d", "%0Xd", or "%0Xlld" (for $Time$), where X is in [0-9]
318         int n = 0;
319         DASHTmplId id_type;
320         const char *t_next = strchr(t_cur, '$'); // copy over everything up to the first '$' character
321         if (t_next) {
322             int num_copy_bytes = FFMIN(t_next - t_cur, buffer_size - dst_pos - 1);
323             av_strlcpy(&dst[dst_pos], t_cur, num_copy_bytes + 1);
324             // advance
325             dst_pos += num_copy_bytes;
326             t_cur = t_next;
327         } else { // no more DASH identifiers to substitute - just copy the rest over and break
328             av_strlcpy(&dst[dst_pos], t_cur, buffer_size - dst_pos);
329             break;
330         }
331
332         if (dst_pos >= buffer_size - 1 || !*t_cur)
333             break;
334
335         // t_cur is now pointing to a '$' character
336         id_type = dash_read_tmpl_id(t_cur, format_tag, sizeof(format_tag), &t_next);
337         switch (id_type) {
338         case DASH_TMPL_ID_ESCAPE:
339             av_strlcpy(&dst[dst_pos], "$", 2);
340             n = 1;
341             break;
342         case DASH_TMPL_ID_REP_ID:
343             n = snprintf(&dst[dst_pos], buffer_size - dst_pos, format_tag, rep_id);
344             break;
345         case DASH_TMPL_ID_NUMBER:
346             n = snprintf(&dst[dst_pos], buffer_size - dst_pos, format_tag, number);
347             break;
348         case DASH_TMPL_ID_BANDWIDTH:
349             n = snprintf(&dst[dst_pos], buffer_size - dst_pos, format_tag, bit_rate);
350             break;
351         case DASH_TMPL_ID_TIME:
352             n = snprintf(&dst[dst_pos], buffer_size - dst_pos, format_tag, time);
353             break;
354         case DASH_TMPL_ID_UNDEFINED:
355             // copy over one byte and advance
356             av_strlcpy(&dst[dst_pos], t_cur, 2);
357             n = 1;
358             t_next = &t_cur[1];
359             break;
360         }
361         // t_next points just past the processed identifier
362         // n is the number of bytes that were attempted to be written to dst
363         // (may have failed to write all because buffer_size).
364
365         // advance
366         dst_pos += FFMIN(n, buffer_size - dst_pos - 1);
367         t_cur = t_next;
368     }
369 }
370
371 static char *xmlescape(const char *str) {
372     int outlen = strlen(str)*3/2 + 6;
373     char *out = av_realloc(NULL, outlen + 1);
374     int pos = 0;
375     if (!out)
376         return NULL;
377     for (; *str; str++) {
378         if (pos + 6 > outlen) {
379             char *tmp;
380             outlen = 2 * outlen + 6;
381             tmp = av_realloc(out, outlen + 1);
382             if (!tmp) {
383                 av_free(out);
384                 return NULL;
385             }
386             out = tmp;
387         }
388         if (*str == '&') {
389             memcpy(&out[pos], "&amp;", 5);
390             pos += 5;
391         } else if (*str == '<') {
392             memcpy(&out[pos], "&lt;", 4);
393             pos += 4;
394         } else if (*str == '>') {
395             memcpy(&out[pos], "&gt;", 4);
396             pos += 4;
397         } else if (*str == '\'') {
398             memcpy(&out[pos], "&apos;", 6);
399             pos += 6;
400         } else if (*str == '\"') {
401             memcpy(&out[pos], "&quot;", 6);
402             pos += 6;
403         } else {
404             out[pos++] = *str;
405         }
406     }
407     out[pos] = '\0';
408     return out;
409 }
410
411 static void write_time(AVIOContext *out, int64_t time)
412 {
413     int seconds = time / AV_TIME_BASE;
414     int fractions = time % AV_TIME_BASE;
415     int minutes = seconds / 60;
416     int hours = minutes / 60;
417     seconds %= 60;
418     minutes %= 60;
419     avio_printf(out, "PT");
420     if (hours)
421         avio_printf(out, "%dH", hours);
422     if (hours || minutes)
423         avio_printf(out, "%dM", minutes);
424     avio_printf(out, "%d.%dS", seconds, fractions / (AV_TIME_BASE / 10));
425 }
426
427 static void format_date_now(char *buf, int size)
428 {
429     time_t t = time(NULL);
430     struct tm *ptm, tmbuf;
431     ptm = gmtime_r(&t, &tmbuf);
432     if (ptm) {
433         if (!strftime(buf, size, "%Y-%m-%dT%H:%M:%SZ", ptm))
434             buf[0] = '\0';
435     }
436 }
437
438 static int write_manifest(AVFormatContext *s, int final)
439 {
440     DASHContext *c = s->priv_data;
441     AVIOContext *out;
442     char temp_filename[1024];
443     int ret, i, as_id = 0;
444     AVDictionaryEntry *title = av_dict_get(s->metadata, "title", NULL, 0);
445
446     snprintf(temp_filename, sizeof(temp_filename), "%s.tmp", s->filename);
447     ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, NULL);
448     if (ret < 0) {
449         av_log(s, AV_LOG_ERROR, "Unable to open %s for writing\n", temp_filename);
450         return ret;
451     }
452     avio_printf(out, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
453     avio_printf(out, "<MPD xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n"
454                 "\txmlns=\"urn:mpeg:dash:schema:mpd:2011\"\n"
455                 "\txmlns:xlink=\"http://www.w3.org/1999/xlink\"\n"
456                 "\txsi:schemaLocation=\"urn:mpeg:DASH:schema:MPD:2011 http://standards.iso.org/ittf/PubliclyAvailableStandards/MPEG-DASH_schema_files/DASH-MPD.xsd\"\n"
457                 "\tprofiles=\"urn:mpeg:dash:profile:isoff-live:2011\"\n"
458                 "\ttype=\"%s\"\n", final ? "static" : "dynamic");
459     if (final) {
460         avio_printf(out, "\tmediaPresentationDuration=\"");
461         write_time(out, c->total_duration);
462         avio_printf(out, "\"\n");
463     } else {
464         int64_t update_period = c->last_duration / AV_TIME_BASE;
465         char now_str[100];
466         if (c->use_template && !c->use_timeline)
467             update_period = 500;
468         avio_printf(out, "\tminimumUpdatePeriod=\"PT%"PRId64"S\"\n", update_period);
469         avio_printf(out, "\tsuggestedPresentationDelay=\"PT%"PRId64"S\"\n", c->last_duration / AV_TIME_BASE);
470         if (!c->availability_start_time[0] && s->nb_streams > 0 && c->streams[0].nb_segments > 0) {
471             format_date_now(c->availability_start_time, sizeof(c->availability_start_time));
472         }
473         if (c->availability_start_time[0])
474             avio_printf(out, "\tavailabilityStartTime=\"%s\"\n", c->availability_start_time);
475         format_date_now(now_str, sizeof(now_str));
476         if (now_str[0])
477             avio_printf(out, "\tpublishTime=\"%s\"\n", now_str);
478         if (c->window_size && c->use_template) {
479             avio_printf(out, "\ttimeShiftBufferDepth=\"");
480             write_time(out, c->last_duration * c->window_size);
481             avio_printf(out, "\"\n");
482         }
483     }
484     avio_printf(out, "\tminBufferTime=\"");
485     write_time(out, c->last_duration * 2);
486     avio_printf(out, "\">\n");
487     avio_printf(out, "\t<ProgramInformation>\n");
488     if (title) {
489         char *escaped = xmlescape(title->value);
490         avio_printf(out, "\t\t<Title>%s</Title>\n", escaped);
491         av_free(escaped);
492     }
493     avio_printf(out, "\t</ProgramInformation>\n");
494     if (c->utc_timing_url)
495         avio_printf(out, "\t<UTCTiming schemeIdUri=\"urn:mpeg:dash:utc:http-xsdate:2014\" value=\"%s\"/>\n", c->utc_timing_url);
496
497     if (c->window_size && s->nb_streams > 0 && c->streams[0].nb_segments > 0 && !c->use_template) {
498         OutputStream *os = &c->streams[0];
499         int start_index = FFMAX(os->nb_segments - c->window_size, 0);
500         int64_t start_time = av_rescale_q(os->segments[start_index]->time, s->streams[0]->time_base, AV_TIME_BASE_Q);
501         avio_printf(out, "\t<Period id=\"0\" start=\"");
502         write_time(out, start_time);
503         avio_printf(out, "\">\n");
504     } else {
505         avio_printf(out, "\t<Period id=\"0\" start=\"PT0.0S\">\n");
506     }
507
508     if (c->has_video) {
509         avio_printf(out, "\t\t<AdaptationSet id=\"%d\" contentType=\"video\" segmentAlignment=\"true\" bitstreamSwitching=\"true\">\n", as_id++);
510         for (i = 0; i < s->nb_streams; i++) {
511             AVStream *st = s->streams[i];
512             OutputStream *os = &c->streams[i];
513             if (st->codecpar->codec_type != AVMEDIA_TYPE_VIDEO)
514                 continue;
515             avio_printf(out, "\t\t\t<Representation id=\"%d\" mimeType=\"video/mp4\" codecs=\"%s\"%s width=\"%d\" height=\"%d\">\n", i, os->codec_str, os->bandwidth_str, st->codecpar->width, st->codecpar->height);
516             output_segment_list(&c->streams[i], out, c);
517             avio_printf(out, "\t\t\t</Representation>\n");
518         }
519         avio_printf(out, "\t\t</AdaptationSet>\n");
520     }
521     if (c->has_audio) {
522         avio_printf(out, "\t\t<AdaptationSet id=\"%d\" contentType=\"audio\" segmentAlignment=\"true\" bitstreamSwitching=\"true\">\n", as_id++);
523         for (i = 0; i < s->nb_streams; i++) {
524             AVStream *st = s->streams[i];
525             OutputStream *os = &c->streams[i];
526             if (st->codecpar->codec_type != AVMEDIA_TYPE_AUDIO)
527                 continue;
528             avio_printf(out, "\t\t\t<Representation id=\"%d\" mimeType=\"audio/mp4\" codecs=\"%s\"%s audioSamplingRate=\"%d\">\n", i, os->codec_str, os->bandwidth_str, st->codecpar->sample_rate);
529             avio_printf(out, "\t\t\t\t<AudioChannelConfiguration schemeIdUri=\"urn:mpeg:dash:23003:3:audio_channel_configuration:2011\" value=\"%d\" />\n", st->codecpar->channels);
530             output_segment_list(&c->streams[i], out, c);
531             avio_printf(out, "\t\t\t</Representation>\n");
532         }
533         avio_printf(out, "\t\t</AdaptationSet>\n");
534     }
535     avio_printf(out, "\t</Period>\n");
536     avio_printf(out, "</MPD>\n");
537     avio_flush(out);
538     ff_format_io_close(s, &out);
539     return ff_rename(temp_filename, s->filename);
540 }
541
542 static int dash_write_header(AVFormatContext *s)
543 {
544     DASHContext *c = s->priv_data;
545     int ret = 0, i;
546     AVOutputFormat *oformat;
547     char *ptr;
548     char basename[1024];
549
550     if (c->single_file_name)
551         c->single_file = 1;
552     if (c->single_file)
553         c->use_template = 0;
554
555     av_strlcpy(c->dirname, s->filename, sizeof(c->dirname));
556     ptr = strrchr(c->dirname, '/');
557     if (ptr) {
558         av_strlcpy(basename, &ptr[1], sizeof(basename));
559         ptr[1] = '\0';
560     } else {
561         c->dirname[0] = '\0';
562         av_strlcpy(basename, s->filename, sizeof(basename));
563     }
564
565     ptr = strrchr(basename, '.');
566     if (ptr)
567         *ptr = '\0';
568
569     oformat = av_guess_format("mp4", NULL, NULL);
570     if (!oformat) {
571         ret = AVERROR_MUXER_NOT_FOUND;
572         goto fail;
573     }
574
575     c->streams = av_mallocz(sizeof(*c->streams) * s->nb_streams);
576     if (!c->streams) {
577         ret = AVERROR(ENOMEM);
578         goto fail;
579     }
580
581     for (i = 0; i < s->nb_streams; i++) {
582         OutputStream *os = &c->streams[i];
583         AVFormatContext *ctx;
584         AVStream *st;
585         AVDictionary *opts = NULL;
586         char filename[1024];
587
588         os->bit_rate = s->streams[i]->codecpar->bit_rate;
589         if (os->bit_rate) {
590             snprintf(os->bandwidth_str, sizeof(os->bandwidth_str),
591                      " bandwidth=\"%d\"", os->bit_rate);
592         } else {
593             int level = s->strict_std_compliance >= FF_COMPLIANCE_STRICT ?
594                         AV_LOG_ERROR : AV_LOG_WARNING;
595             av_log(s, level, "No bit rate set for stream %d\n", i);
596             if (s->strict_std_compliance >= FF_COMPLIANCE_STRICT) {
597                 ret = AVERROR(EINVAL);
598                 goto fail;
599             }
600         }
601
602         ctx = avformat_alloc_context();
603         if (!ctx) {
604             ret = AVERROR(ENOMEM);
605             goto fail;
606         }
607         os->ctx = ctx;
608         ctx->oformat = oformat;
609         ctx->interrupt_callback = s->interrupt_callback;
610         ctx->opaque             = s->opaque;
611         ctx->io_close           = s->io_close;
612         ctx->io_open            = s->io_open;
613
614         if (!(st = avformat_new_stream(ctx, NULL))) {
615             ret = AVERROR(ENOMEM);
616             goto fail;
617         }
618         avcodec_parameters_copy(st->codecpar, s->streams[i]->codecpar);
619         st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
620         st->time_base = s->streams[i]->time_base;
621         ctx->avoid_negative_ts = s->avoid_negative_ts;
622
623         ctx->pb = avio_alloc_context(os->iobuf, sizeof(os->iobuf), AVIO_FLAG_WRITE, os, NULL, dash_write, NULL);
624         if (!ctx->pb) {
625             ret = AVERROR(ENOMEM);
626             goto fail;
627         }
628
629         if (c->single_file) {
630             if (c->single_file_name)
631                 dash_fill_tmpl_params(os->initfile, sizeof(os->initfile), c->single_file_name, i, 0, os->bit_rate, 0);
632             else
633                 snprintf(os->initfile, sizeof(os->initfile), "%s-stream%d.m4s", basename, i);
634         } else {
635             dash_fill_tmpl_params(os->initfile, sizeof(os->initfile), c->init_seg_name, i, 0, os->bit_rate, 0);
636         }
637         snprintf(filename, sizeof(filename), "%s%s", c->dirname, os->initfile);
638         ret = s->io_open(s, &os->out, filename, AVIO_FLAG_WRITE, NULL);
639         if (ret < 0)
640             goto fail;
641         os->init_start_pos = 0;
642
643         av_dict_set(&opts, "movflags", "frag_custom+dash+delay_moov", 0);
644         if ((ret = avformat_write_header(ctx, &opts)) < 0) {
645              goto fail;
646         }
647         os->ctx_inited = 1;
648         avio_flush(ctx->pb);
649         av_dict_free(&opts);
650
651         av_log(s, AV_LOG_VERBOSE, "Representation %d init segment will be written to: %s\n", i, filename);
652
653         s->streams[i]->time_base = st->time_base;
654         // If the muxer wants to shift timestamps, request to have them shifted
655         // already before being handed to this muxer, so we don't have mismatches
656         // between the MPD and the actual segments.
657         s->avoid_negative_ts = ctx->avoid_negative_ts;
658         if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)
659             c->has_video = 1;
660         else if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO)
661             c->has_audio = 1;
662
663         set_codec_str(s, st->codecpar, os->codec_str, sizeof(os->codec_str));
664         os->first_pts = AV_NOPTS_VALUE;
665         os->max_pts = AV_NOPTS_VALUE;
666         os->last_dts = AV_NOPTS_VALUE;
667         os->segment_index = 1;
668     }
669
670     if (!c->has_video && c->min_seg_duration <= 0) {
671         av_log(s, AV_LOG_WARNING, "no video stream and no min seg duration set\n");
672         ret = AVERROR(EINVAL);
673     }
674     ret = write_manifest(s, 0);
675     if (!ret)
676         av_log(s, AV_LOG_VERBOSE, "Manifest written to: %s\n", s->filename);
677
678 fail:
679     if (ret)
680         dash_free(s);
681     return ret;
682 }
683
684 static int add_segment(OutputStream *os, const char *file,
685                        int64_t time, int duration,
686                        int64_t start_pos, int64_t range_length,
687                        int64_t index_length)
688 {
689     int err;
690     Segment *seg;
691     if (os->nb_segments >= os->segments_size) {
692         os->segments_size = (os->segments_size + 1) * 2;
693         if ((err = av_reallocp(&os->segments, sizeof(*os->segments) *
694                                os->segments_size)) < 0) {
695             os->segments_size = 0;
696             os->nb_segments = 0;
697             return err;
698         }
699     }
700     seg = av_mallocz(sizeof(*seg));
701     if (!seg)
702         return AVERROR(ENOMEM);
703     av_strlcpy(seg->file, file, sizeof(seg->file));
704     seg->time = time;
705     seg->duration = duration;
706     if (seg->time < 0) { // If pts<0, it is expected to be cut away with an edit list
707         seg->duration += seg->time;
708         seg->time = 0;
709     }
710     seg->start_pos = start_pos;
711     seg->range_length = range_length;
712     seg->index_length = index_length;
713     os->segments[os->nb_segments++] = seg;
714     os->segment_index++;
715     return 0;
716 }
717
718 static void write_styp(AVIOContext *pb)
719 {
720     avio_wb32(pb, 24);
721     ffio_wfourcc(pb, "styp");
722     ffio_wfourcc(pb, "msdh");
723     avio_wb32(pb, 0); /* minor */
724     ffio_wfourcc(pb, "msdh");
725     ffio_wfourcc(pb, "msix");
726 }
727
728 static void find_index_range(AVFormatContext *s, const char *full_path,
729                              int64_t pos, int *index_length)
730 {
731     uint8_t buf[8];
732     AVIOContext *pb;
733     int ret;
734
735     ret = s->io_open(s, &pb, full_path, AVIO_FLAG_READ, NULL);
736     if (ret < 0)
737         return;
738     if (avio_seek(pb, pos, SEEK_SET) != pos) {
739         ff_format_io_close(s, &pb);
740         return;
741     }
742     ret = avio_read(pb, buf, 8);
743     ff_format_io_close(s, &pb);
744     if (ret < 8)
745         return;
746     if (AV_RL32(&buf[4]) != MKTAG('s', 'i', 'd', 'x'))
747         return;
748     *index_length = AV_RB32(&buf[0]);
749 }
750
751 static int update_stream_extradata(AVFormatContext *s, OutputStream *os,
752                                    AVCodecParameters *par)
753 {
754     uint8_t *extradata;
755
756     if (os->ctx->streams[0]->codecpar->extradata_size || !par->extradata_size)
757         return 0;
758
759     extradata = av_malloc(par->extradata_size);
760
761     if (!extradata)
762         return AVERROR(ENOMEM);
763
764     memcpy(extradata, par->extradata, par->extradata_size);
765
766     os->ctx->streams[0]->codecpar->extradata = extradata;
767     os->ctx->streams[0]->codecpar->extradata_size = par->extradata_size;
768
769     set_codec_str(s, par, os->codec_str, sizeof(os->codec_str));
770
771     return 0;
772 }
773
774 static int dash_flush(AVFormatContext *s, int final, int stream)
775 {
776     DASHContext *c = s->priv_data;
777     int i, ret = 0;
778     int cur_flush_segment_index = 0;
779     if (stream >= 0)
780         cur_flush_segment_index = c->streams[stream].segment_index;
781
782     for (i = 0; i < s->nb_streams; i++) {
783         OutputStream *os = &c->streams[i];
784         char filename[1024] = "", full_path[1024], temp_path[1024];
785         int64_t start_pos;
786         int range_length, index_length = 0;
787
788         if (!os->packets_written)
789             continue;
790
791         // Flush the single stream that got a keyframe right now.
792         // Flush all audio streams as well, in sync with video keyframes,
793         // but not the other video streams.
794         if (stream >= 0 && i != stream) {
795             if (s->streams[i]->codecpar->codec_type != AVMEDIA_TYPE_AUDIO)
796                 continue;
797             // Make sure we don't flush audio streams multiple times, when
798             // all video streams are flushed one at a time.
799             if (c->has_video && os->segment_index > cur_flush_segment_index)
800                 continue;
801         }
802
803         if (!os->init_range_length) {
804             av_write_frame(os->ctx, NULL);
805             os->init_range_length = avio_tell(os->ctx->pb);
806             if (!c->single_file)
807                 ff_format_io_close(s, &os->out);
808         }
809
810         start_pos = avio_tell(os->ctx->pb);
811
812         if (!c->single_file) {
813             dash_fill_tmpl_params(filename, sizeof(filename), c->media_seg_name, i, os->segment_index, os->bit_rate, os->start_pts);
814             snprintf(full_path, sizeof(full_path), "%s%s", c->dirname, filename);
815             snprintf(temp_path, sizeof(temp_path), "%s.tmp", full_path);
816             ret = s->io_open(s, &os->out, temp_path, AVIO_FLAG_WRITE, NULL);
817             if (ret < 0)
818                 break;
819             write_styp(os->ctx->pb);
820         } else {
821             snprintf(full_path, sizeof(full_path), "%s%s", c->dirname, os->initfile);
822         }
823
824         av_write_frame(os->ctx, NULL);
825         avio_flush(os->ctx->pb);
826         os->packets_written = 0;
827
828         range_length = avio_tell(os->ctx->pb) - start_pos;
829         if (c->single_file) {
830             find_index_range(s, full_path, start_pos, &index_length);
831         } else {
832             ff_format_io_close(s, &os->out);
833             ret = ff_rename(temp_path, full_path);
834             if (ret < 0)
835                 break;
836         }
837         add_segment(os, filename, os->start_pts, os->max_pts - os->start_pts, start_pos, range_length, index_length);
838         av_log(s, AV_LOG_VERBOSE, "Representation %d media segment %d written to: %s\n", i, os->segment_index, full_path);
839     }
840
841     if (c->window_size || (final && c->remove_at_exit)) {
842         for (i = 0; i < s->nb_streams; i++) {
843             OutputStream *os = &c->streams[i];
844             int j;
845             int remove = os->nb_segments - c->window_size - c->extra_window_size;
846             if (final && c->remove_at_exit)
847                 remove = os->nb_segments;
848             if (remove > 0) {
849                 for (j = 0; j < remove; j++) {
850                     char filename[1024];
851                     snprintf(filename, sizeof(filename), "%s%s", c->dirname, os->segments[j]->file);
852                     unlink(filename);
853                     av_free(os->segments[j]);
854                 }
855                 os->nb_segments -= remove;
856                 memmove(os->segments, os->segments + remove, os->nb_segments * sizeof(*os->segments));
857             }
858         }
859     }
860
861     if (ret >= 0)
862         ret = write_manifest(s, final);
863     return ret;
864 }
865
866 static int dash_write_packet(AVFormatContext *s, AVPacket *pkt)
867 {
868     DASHContext *c = s->priv_data;
869     AVStream *st = s->streams[pkt->stream_index];
870     OutputStream *os = &c->streams[pkt->stream_index];
871     int64_t seg_end_duration = (os->segment_index) * (int64_t) c->min_seg_duration;
872     int ret;
873
874     ret = update_stream_extradata(s, os, st->codecpar);
875     if (ret < 0)
876         return ret;
877
878     // Fill in a heuristic guess of the packet duration, if none is available.
879     // The mp4 muxer will do something similar (for the last packet in a fragment)
880     // if nothing is set (setting it for the other packets doesn't hurt).
881     // By setting a nonzero duration here, we can be sure that the mp4 muxer won't
882     // invoke its heuristic (this doesn't have to be identical to that algorithm),
883     // so that we know the exact timestamps of fragments.
884     if (!pkt->duration && os->last_dts != AV_NOPTS_VALUE)
885         pkt->duration = pkt->dts - os->last_dts;
886     os->last_dts = pkt->dts;
887
888     // If forcing the stream to start at 0, the mp4 muxer will set the start
889     // timestamps to 0. Do the same here, to avoid mismatches in duration/timestamps.
890     if (os->first_pts == AV_NOPTS_VALUE &&
891         s->avoid_negative_ts == AVFMT_AVOID_NEG_TS_MAKE_ZERO) {
892         pkt->pts -= pkt->dts;
893         pkt->dts  = 0;
894     }
895
896     if (os->first_pts == AV_NOPTS_VALUE)
897         os->first_pts = pkt->pts;
898
899     if ((!c->has_video || st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
900         pkt->flags & AV_PKT_FLAG_KEY && os->packets_written &&
901         av_compare_ts(pkt->pts - os->first_pts, st->time_base,
902                       seg_end_duration, AV_TIME_BASE_Q) >= 0) {
903         int64_t prev_duration = c->last_duration;
904
905         c->last_duration = av_rescale_q(pkt->pts - os->start_pts,
906                                         st->time_base,
907                                         AV_TIME_BASE_Q);
908         c->total_duration = av_rescale_q(pkt->pts - os->first_pts,
909                                          st->time_base,
910                                          AV_TIME_BASE_Q);
911
912         if ((!c->use_timeline || !c->use_template) && prev_duration) {
913             if (c->last_duration < prev_duration*9/10 ||
914                 c->last_duration > prev_duration*11/10) {
915                 av_log(s, AV_LOG_WARNING,
916                        "Segment durations differ too much, enable use_timeline "
917                        "and use_template, or keep a stricter keyframe interval\n");
918             }
919         }
920
921         if ((ret = dash_flush(s, 0, pkt->stream_index)) < 0)
922             return ret;
923     }
924
925     if (!os->packets_written) {
926         // If we wrote a previous segment, adjust the start time of the segment
927         // to the end of the previous one (which is the same as the mp4 muxer
928         // does). This avoids gaps in the timeline.
929         if (os->max_pts != AV_NOPTS_VALUE)
930             os->start_pts = os->max_pts;
931         else
932             os->start_pts = pkt->pts;
933     }
934     if (os->max_pts == AV_NOPTS_VALUE)
935         os->max_pts = pkt->pts + pkt->duration;
936     else
937         os->max_pts = FFMAX(os->max_pts, pkt->pts + pkt->duration);
938     os->packets_written++;
939     return ff_write_chained(os->ctx, 0, pkt, s);
940 }
941
942 static int dash_write_trailer(AVFormatContext *s)
943 {
944     DASHContext *c = s->priv_data;
945
946     if (s->nb_streams > 0) {
947         OutputStream *os = &c->streams[0];
948         // If no segments have been written so far, try to do a crude
949         // guess of the segment duration
950         if (!c->last_duration)
951             c->last_duration = av_rescale_q(os->max_pts - os->start_pts,
952                                             s->streams[0]->time_base,
953                                             AV_TIME_BASE_Q);
954         c->total_duration = av_rescale_q(os->max_pts - os->first_pts,
955                                          s->streams[0]->time_base,
956                                          AV_TIME_BASE_Q);
957     }
958     dash_flush(s, 1, -1);
959
960     if (c->remove_at_exit) {
961         char filename[1024];
962         int i;
963         for (i = 0; i < s->nb_streams; i++) {
964             OutputStream *os = &c->streams[i];
965             snprintf(filename, sizeof(filename), "%s%s", c->dirname, os->initfile);
966             unlink(filename);
967         }
968         unlink(s->filename);
969     }
970
971     dash_free(s);
972     return 0;
973 }
974
975 #define OFFSET(x) offsetof(DASHContext, x)
976 #define E AV_OPT_FLAG_ENCODING_PARAM
977 static const AVOption options[] = {
978     { "window_size", "number of segments kept in the manifest", OFFSET(window_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, E },
979     { "extra_window_size", "number of segments kept outside of the manifest before removing from disk", OFFSET(extra_window_size), AV_OPT_TYPE_INT, { .i64 = 5 }, 0, INT_MAX, E },
980     { "min_seg_duration", "minimum segment duration (in microseconds)", OFFSET(min_seg_duration), AV_OPT_TYPE_INT64, { .i64 = 5000000 }, 0, INT_MAX, E },
981     { "remove_at_exit", "remove all segments when finished", OFFSET(remove_at_exit), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, E },
982     { "use_template", "Use SegmentTemplate instead of SegmentList", OFFSET(use_template), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, E },
983     { "use_timeline", "Use SegmentTimeline in SegmentTemplate", OFFSET(use_timeline), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, E },
984     { "single_file", "Store all segments in one file, accessed using byte ranges", OFFSET(single_file), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, E },
985     { "single_file_name", "DASH-templated name to be used for baseURL. Implies storing all segments in one file, accessed using byte ranges", OFFSET(single_file_name), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, E },
986     { "init_seg_name", "DASH-templated name to used for the initialization segment", OFFSET(init_seg_name), AV_OPT_TYPE_STRING, {.str = "init-stream$RepresentationID$.m4s"}, 0, 0, E },
987     { "media_seg_name", "DASH-templated name to used for the media segments", OFFSET(media_seg_name), AV_OPT_TYPE_STRING, {.str = "chunk-stream$RepresentationID$-$Number%05d$.m4s"}, 0, 0, E },
988     { "utc_timing_url", "URL of the page that will return the UTC timestamp in ISO format", OFFSET(utc_timing_url), AV_OPT_TYPE_STRING, { 0 }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
989     { NULL },
990 };
991
992 static const AVClass dash_class = {
993     .class_name = "dash muxer",
994     .item_name  = av_default_item_name,
995     .option     = options,
996     .version    = LIBAVUTIL_VERSION_INT,
997 };
998
999 AVOutputFormat ff_dash_muxer = {
1000     .name           = "dash",
1001     .long_name      = NULL_IF_CONFIG_SMALL("DASH Muxer"),
1002     .priv_data_size = sizeof(DASHContext),
1003     .audio_codec    = AV_CODEC_ID_AAC,
1004     .video_codec    = AV_CODEC_ID_H264,
1005     .flags          = AVFMT_GLOBALHEADER | AVFMT_NOFILE | AVFMT_TS_NEGATIVE,
1006     .write_header   = dash_write_header,
1007     .write_packet   = dash_write_packet,
1008     .write_trailer  = dash_write_trailer,
1009     .codec_tag      = (const AVCodecTag* const []){ ff_mp4_obj_type, 0 },
1010     .priv_class     = &dash_class,
1011 };