summaryrefslogtreecommitdiff
path: root/libavformat/hdsenc.c (plain)
blob: 347df83a5166fd7462eb644a9db6c92484c29496
1/*
2 * Live HDS fragmenter
3 * Copyright (c) 2013 Martin Storsjo
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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#include <float.h>
24#if HAVE_UNISTD_H
25#include <unistd.h>
26#endif
27
28#include "avformat.h"
29#include "avio_internal.h"
30#include "internal.h"
31#include "os_support.h"
32
33#include "libavutil/avstring.h"
34#include "libavutil/base64.h"
35#include "libavutil/intreadwrite.h"
36#include "libavutil/mathematics.h"
37#include "libavutil/opt.h"
38
39typedef struct Fragment {
40 char file[1024];
41 int64_t start_time, duration;
42 int n;
43} Fragment;
44
45typedef struct OutputStream {
46 int bitrate;
47 int first_stream;
48 AVFormatContext *ctx;
49 int ctx_inited;
50 uint8_t iobuf[32768];
51 char temp_filename[1024];
52 int64_t frag_start_ts, last_ts;
53 AVIOContext *out;
54 int packets_written;
55 int nb_fragments, fragments_size, fragment_index;
56 Fragment **fragments;
57
58 int has_audio, has_video;
59
60 uint8_t *metadata;
61 int metadata_size;
62
63 uint8_t *extra_packets[2];
64 int extra_packet_sizes[2];
65 int nb_extra_packets;
66} OutputStream;
67
68typedef struct HDSContext {
69 const AVClass *class; /* Class for private options. */
70 int window_size;
71 int extra_window_size;
72 int min_frag_duration;
73 int remove_at_exit;
74
75 OutputStream *streams;
76 int nb_streams;
77} HDSContext;
78
79static int parse_header(OutputStream *os, const uint8_t *buf, int buf_size)
80{
81 if (buf_size < 13)
82 return AVERROR_INVALIDDATA;
83 if (memcmp(buf, "FLV", 3))
84 return AVERROR_INVALIDDATA;
85 buf += 13;
86 buf_size -= 13;
87 while (buf_size >= 11 + 4) {
88 int type = buf[0];
89 int size = AV_RB24(&buf[1]) + 11 + 4;
90 if (size > buf_size)
91 return AVERROR_INVALIDDATA;
92 if (type == 8 || type == 9) {
93 if (os->nb_extra_packets >= FF_ARRAY_ELEMS(os->extra_packets))
94 return AVERROR_INVALIDDATA;
95 os->extra_packet_sizes[os->nb_extra_packets] = size;
96 os->extra_packets[os->nb_extra_packets] = av_malloc(size);
97 if (!os->extra_packets[os->nb_extra_packets])
98 return AVERROR(ENOMEM);
99 memcpy(os->extra_packets[os->nb_extra_packets], buf, size);
100 os->nb_extra_packets++;
101 } else if (type == 0x12) {
102 if (os->metadata)
103 return AVERROR_INVALIDDATA;
104 os->metadata_size = size - 11 - 4;
105 os->metadata = av_malloc(os->metadata_size);
106 if (!os->metadata)
107 return AVERROR(ENOMEM);
108 memcpy(os->metadata, buf + 11, os->metadata_size);
109 }
110 buf += size;
111 buf_size -= size;
112 }
113 if (!os->metadata)
114 return AVERROR_INVALIDDATA;
115 return 0;
116}
117
118static int hds_write(void *opaque, uint8_t *buf, int buf_size)
119{
120 OutputStream *os = opaque;
121 if (os->out) {
122 avio_write(os->out, buf, buf_size);
123 } else {
124 if (!os->metadata_size) {
125 int ret;
126 // Assuming the IO buffer is large enough to fit the
127 // FLV header and all metadata and extradata packets
128 if ((ret = parse_header(os, buf, buf_size)) < 0)
129 return ret;
130 }
131 }
132 return buf_size;
133}
134
135static void hds_free(AVFormatContext *s)
136{
137 HDSContext *c = s->priv_data;
138 int i, j;
139 if (!c->streams)
140 return;
141 for (i = 0; i < s->nb_streams; i++) {
142 OutputStream *os = &c->streams[i];
143 if (os->out)
144 ff_format_io_close(s, &os->out);
145 if (os->ctx && os->ctx_inited)
146 av_write_trailer(os->ctx);
147 if (os->ctx)
148 av_freep(&os->ctx->pb);
149 if (os->ctx)
150 avformat_free_context(os->ctx);
151 av_freep(&os->metadata);
152 for (j = 0; j < os->nb_extra_packets; j++)
153 av_freep(&os->extra_packets[j]);
154 for (j = 0; j < os->nb_fragments; j++)
155 av_freep(&os->fragments[j]);
156 av_freep(&os->fragments);
157 }
158 av_freep(&c->streams);
159}
160
161static int write_manifest(AVFormatContext *s, int final)
162{
163 HDSContext *c = s->priv_data;
164 AVIOContext *out;
165 char filename[1024], temp_filename[1024];
166 int ret, i;
167 double duration = 0;
168
169 if (c->nb_streams > 0)
170 duration = c->streams[0].last_ts * av_q2d(s->streams[0]->time_base);
171
172 snprintf(filename, sizeof(filename), "%s/index.f4m", s->filename);
173 snprintf(temp_filename, sizeof(temp_filename), "%s/index.f4m.tmp", s->filename);
174 ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, NULL);
175 if (ret < 0) {
176 av_log(s, AV_LOG_ERROR, "Unable to open %s for writing\n", temp_filename);
177 return ret;
178 }
179 avio_printf(out, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
180 avio_printf(out, "<manifest xmlns=\"http://ns.adobe.com/f4m/1.0\">\n");
181 avio_printf(out, "\t<id>%s</id>\n", av_basename(s->filename));
182 avio_printf(out, "\t<streamType>%s</streamType>\n",
183 final ? "recorded" : "live");
184 avio_printf(out, "\t<deliveryType>streaming</deliveryType>\n");
185 if (final)
186 avio_printf(out, "\t<duration>%f</duration>\n", duration);
187 for (i = 0; i < c->nb_streams; i++) {
188 OutputStream *os = &c->streams[i];
189 int b64_size = AV_BASE64_SIZE(os->metadata_size);
190 char *base64 = av_malloc(b64_size);
191 if (!base64) {
192 ff_format_io_close(s, &out);
193 return AVERROR(ENOMEM);
194 }
195 av_base64_encode(base64, b64_size, os->metadata, os->metadata_size);
196
197 avio_printf(out, "\t<bootstrapInfo profile=\"named\" url=\"stream%d.abst\" id=\"bootstrap%d\" />\n", i, i);
198 avio_printf(out, "\t<media bitrate=\"%d\" url=\"stream%d\" bootstrapInfoId=\"bootstrap%d\">\n", os->bitrate/1000, i, i);
199 avio_printf(out, "\t\t<metadata>%s</metadata>\n", base64);
200 avio_printf(out, "\t</media>\n");
201 av_free(base64);
202 }
203 avio_printf(out, "</manifest>\n");
204 avio_flush(out);
205 ff_format_io_close(s, &out);
206 return ff_rename(temp_filename, filename, s);
207}
208
209static void update_size(AVIOContext *out, int64_t pos)
210{
211 int64_t end = avio_tell(out);
212 avio_seek(out, pos, SEEK_SET);
213 avio_wb32(out, end - pos);
214 avio_seek(out, end, SEEK_SET);
215}
216
217/* Note, the .abst files need to be served with the "binary/octet"
218 * mime type, otherwise at least the OSMF player can easily fail
219 * with "stream not found" when polling for the next fragment. */
220static int write_abst(AVFormatContext *s, OutputStream *os, int final)
221{
222 HDSContext *c = s->priv_data;
223 AVIOContext *out;
224 char filename[1024], temp_filename[1024];
225 int i, ret;
226 int64_t asrt_pos, afrt_pos;
227 int start = 0, fragments;
228 int index = s->streams[os->first_stream]->id;
229 int64_t cur_media_time = 0;
230 if (c->window_size)
231 start = FFMAX(os->nb_fragments - c->window_size, 0);
232 fragments = os->nb_fragments - start;
233 if (final)
234 cur_media_time = os->last_ts;
235 else if (os->nb_fragments)
236 cur_media_time = os->fragments[os->nb_fragments - 1]->start_time;
237
238 snprintf(filename, sizeof(filename),
239 "%s/stream%d.abst", s->filename, index);
240 snprintf(temp_filename, sizeof(temp_filename),
241 "%s/stream%d.abst.tmp", s->filename, index);
242 ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, NULL);
243 if (ret < 0) {
244 av_log(s, AV_LOG_ERROR, "Unable to open %s for writing\n", temp_filename);
245 return ret;
246 }
247 avio_wb32(out, 0); // abst size
248 avio_wl32(out, MKTAG('a','b','s','t'));
249 avio_wb32(out, 0); // version + flags
250 avio_wb32(out, os->fragment_index - 1); // BootstrapinfoVersion
251 avio_w8(out, final ? 0 : 0x20); // profile, live, update
252 avio_wb32(out, 1000); // timescale
253 avio_wb64(out, cur_media_time);
254 avio_wb64(out, 0); // SmpteTimeCodeOffset
255 avio_w8(out, 0); // MovieIdentifer (null string)
256 avio_w8(out, 0); // ServerEntryCount
257 avio_w8(out, 0); // QualityEntryCount
258 avio_w8(out, 0); // DrmData (null string)
259 avio_w8(out, 0); // MetaData (null string)
260 avio_w8(out, 1); // SegmentRunTableCount
261 asrt_pos = avio_tell(out);
262 avio_wb32(out, 0); // asrt size
263 avio_wl32(out, MKTAG('a','s','r','t'));
264 avio_wb32(out, 0); // version + flags
265 avio_w8(out, 0); // QualityEntryCount
266 avio_wb32(out, 1); // SegmentRunEntryCount
267 avio_wb32(out, 1); // FirstSegment
268 avio_wb32(out, final ? (os->fragment_index - 1) : 0xffffffff); // FragmentsPerSegment
269 update_size(out, asrt_pos);
270 avio_w8(out, 1); // FragmentRunTableCount
271 afrt_pos = avio_tell(out);
272 avio_wb32(out, 0); // afrt size
273 avio_wl32(out, MKTAG('a','f','r','t'));
274 avio_wb32(out, 0); // version + flags
275 avio_wb32(out, 1000); // timescale
276 avio_w8(out, 0); // QualityEntryCount
277 avio_wb32(out, fragments); // FragmentRunEntryCount
278 for (i = start; i < os->nb_fragments; i++) {
279 avio_wb32(out, os->fragments[i]->n);
280 avio_wb64(out, os->fragments[i]->start_time);
281 avio_wb32(out, os->fragments[i]->duration);
282 }
283 update_size(out, afrt_pos);
284 update_size(out, 0);
285 ff_format_io_close(s, &out);
286 return ff_rename(temp_filename, filename, s);
287}
288
289static int init_file(AVFormatContext *s, OutputStream *os, int64_t start_ts)
290{
291 int ret, i;
292 ret = s->io_open(s, &os->out, os->temp_filename, AVIO_FLAG_WRITE, NULL);
293 if (ret < 0)
294 return ret;
295 avio_wb32(os->out, 0);
296 avio_wl32(os->out, MKTAG('m','d','a','t'));
297 for (i = 0; i < os->nb_extra_packets; i++) {
298 AV_WB24(os->extra_packets[i] + 4, start_ts);
299 os->extra_packets[i][7] = (start_ts >> 24) & 0x7f;
300 avio_write(os->out, os->extra_packets[i], os->extra_packet_sizes[i]);
301 }
302 return 0;
303}
304
305static void close_file(AVFormatContext *s, OutputStream *os)
306{
307 int64_t pos = avio_tell(os->out);
308 avio_seek(os->out, 0, SEEK_SET);
309 avio_wb32(os->out, pos);
310 avio_flush(os->out);
311 ff_format_io_close(s, &os->out);
312}
313
314static int hds_write_header(AVFormatContext *s)
315{
316 HDSContext *c = s->priv_data;
317 int ret = 0, i;
318 AVOutputFormat *oformat;
319
320 if (mkdir(s->filename, 0777) == -1 && errno != EEXIST) {
321 ret = AVERROR(errno);
322 av_log(s, AV_LOG_ERROR , "Failed to create directory %s\n", s->filename);
323 goto fail;
324 }
325
326 oformat = av_guess_format("flv", NULL, NULL);
327 if (!oformat) {
328 ret = AVERROR_MUXER_NOT_FOUND;
329 goto fail;
330 }
331
332 c->streams = av_mallocz_array(s->nb_streams, sizeof(*c->streams));
333 if (!c->streams) {
334 ret = AVERROR(ENOMEM);
335 goto fail;
336 }
337
338 for (i = 0; i < s->nb_streams; i++) {
339 OutputStream *os = &c->streams[c->nb_streams];
340 AVFormatContext *ctx;
341 AVStream *st = s->streams[i];
342
343 if (!st->codecpar->bit_rate) {
344 av_log(s, AV_LOG_ERROR, "No bit rate set for stream %d\n", i);
345 ret = AVERROR(EINVAL);
346 goto fail;
347 }
348 if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
349 if (os->has_video) {
350 c->nb_streams++;
351 os++;
352 }
353 os->has_video = 1;
354 } else if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO) {
355 if (os->has_audio) {
356 c->nb_streams++;
357 os++;
358 }
359 os->has_audio = 1;
360 } else {
361 av_log(s, AV_LOG_ERROR, "Unsupported stream type in stream %d\n", i);
362 ret = AVERROR(EINVAL);
363 goto fail;
364 }
365 os->bitrate += s->streams[i]->codecpar->bit_rate;
366
367 if (!os->ctx) {
368 os->first_stream = i;
369 ctx = avformat_alloc_context();
370 if (!ctx) {
371 ret = AVERROR(ENOMEM);
372 goto fail;
373 }
374 os->ctx = ctx;
375 ctx->oformat = oformat;
376 ctx->interrupt_callback = s->interrupt_callback;
377 ctx->flags = s->flags;
378
379 ctx->pb = avio_alloc_context(os->iobuf, sizeof(os->iobuf),
380 AVIO_FLAG_WRITE, os,
381 NULL, hds_write, NULL);
382 if (!ctx->pb) {
383 ret = AVERROR(ENOMEM);
384 goto fail;
385 }
386 } else {
387 ctx = os->ctx;
388 }
389 s->streams[i]->id = c->nb_streams;
390
391 if (!(st = avformat_new_stream(ctx, NULL))) {
392 ret = AVERROR(ENOMEM);
393 goto fail;
394 }
395 avcodec_parameters_copy(st->codecpar, s->streams[i]->codecpar);
396 st->codecpar->codec_tag = 0;
397 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
398 st->time_base = s->streams[i]->time_base;
399 }
400 if (c->streams[c->nb_streams].ctx)
401 c->nb_streams++;
402
403 for (i = 0; i < c->nb_streams; i++) {
404 OutputStream *os = &c->streams[i];
405 int j;
406 if ((ret = avformat_write_header(os->ctx, NULL)) < 0) {
407 goto fail;
408 }
409 os->ctx_inited = 1;
410 avio_flush(os->ctx->pb);
411 for (j = 0; j < os->ctx->nb_streams; j++)
412 s->streams[os->first_stream + j]->time_base = os->ctx->streams[j]->time_base;
413
414 snprintf(os->temp_filename, sizeof(os->temp_filename),
415 "%s/stream%d_temp", s->filename, i);
416 ret = init_file(s, os, 0);
417 if (ret < 0)
418 goto fail;
419
420 if (!os->has_video && c->min_frag_duration <= 0) {
421 av_log(s, AV_LOG_WARNING,
422 "No video stream in output stream %d and no min frag duration set\n", i);
423 ret = AVERROR(EINVAL);
424 }
425 os->fragment_index = 1;
426 write_abst(s, os, 0);
427 }
428 ret = write_manifest(s, 0);
429
430fail:
431 if (ret)
432 hds_free(s);
433 return ret;
434}
435
436static int add_fragment(OutputStream *os, const char *file,
437 int64_t start_time, int64_t duration)
438{
439 Fragment *frag;
440 if (duration == 0)
441 duration = 1;
442 if (os->nb_fragments >= os->fragments_size) {
443 int ret;
444 os->fragments_size = (os->fragments_size + 1) * 2;
445 if ((ret = av_reallocp_array(&os->fragments, os->fragments_size,
446 sizeof(*os->fragments))) < 0) {
447 os->fragments_size = 0;
448 os->nb_fragments = 0;
449 return ret;
450 }
451 }
452 frag = av_mallocz(sizeof(*frag));
453 if (!frag)
454 return AVERROR(ENOMEM);
455 av_strlcpy(frag->file, file, sizeof(frag->file));
456 frag->start_time = start_time;
457 frag->duration = duration;
458 frag->n = os->fragment_index;
459 os->fragments[os->nb_fragments++] = frag;
460 os->fragment_index++;
461 return 0;
462}
463
464static int hds_flush(AVFormatContext *s, OutputStream *os, int final,
465 int64_t end_ts)
466{
467 HDSContext *c = s->priv_data;
468 int i, ret = 0;
469 char target_filename[1024];
470 int index = s->streams[os->first_stream]->id;
471
472 if (!os->packets_written)
473 return 0;
474
475 avio_flush(os->ctx->pb);
476 os->packets_written = 0;
477 close_file(s, os);
478
479 snprintf(target_filename, sizeof(target_filename),
480 "%s/stream%dSeg1-Frag%d", s->filename, index, os->fragment_index);
481 ret = ff_rename(os->temp_filename, target_filename, s);
482 if (ret < 0)
483 return ret;
484 add_fragment(os, target_filename, os->frag_start_ts, end_ts - os->frag_start_ts);
485
486 if (!final) {
487 ret = init_file(s, os, end_ts);
488 if (ret < 0)
489 return ret;
490 }
491
492 if (c->window_size || (final && c->remove_at_exit)) {
493 int remove = os->nb_fragments - c->window_size - c->extra_window_size;
494 if (final && c->remove_at_exit)
495 remove = os->nb_fragments;
496 if (remove > 0) {
497 for (i = 0; i < remove; i++) {
498 unlink(os->fragments[i]->file);
499 av_freep(&os->fragments[i]);
500 }
501 os->nb_fragments -= remove;
502 memmove(os->fragments, os->fragments + remove,
503 os->nb_fragments * sizeof(*os->fragments));
504 }
505 }
506
507 if (ret >= 0)
508 ret = write_abst(s, os, final);
509 return ret;
510}
511
512static int hds_write_packet(AVFormatContext *s, AVPacket *pkt)
513{
514 HDSContext *c = s->priv_data;
515 AVStream *st = s->streams[pkt->stream_index];
516 OutputStream *os = &c->streams[s->streams[pkt->stream_index]->id];
517 int64_t end_dts = os->fragment_index * (int64_t)c->min_frag_duration;
518 int ret;
519
520 if (st->first_dts == AV_NOPTS_VALUE)
521 st->first_dts = pkt->dts;
522
523 if ((!os->has_video || st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
524 av_compare_ts(pkt->dts - st->first_dts, st->time_base,
525 end_dts, AV_TIME_BASE_Q) >= 0 &&
526 pkt->flags & AV_PKT_FLAG_KEY && os->packets_written) {
527
528 if ((ret = hds_flush(s, os, 0, pkt->dts)) < 0)
529 return ret;
530 }
531
532 // Note, these fragment start timestamps, that represent a whole
533 // OutputStream, assume all streams in it have the same time base.
534 if (!os->packets_written)
535 os->frag_start_ts = pkt->dts;
536 os->last_ts = pkt->dts;
537
538 os->packets_written++;
539 return ff_write_chained(os->ctx, pkt->stream_index - os->first_stream, pkt, s, 0);
540}
541
542static int hds_write_trailer(AVFormatContext *s)
543{
544 HDSContext *c = s->priv_data;
545 int i;
546
547 for (i = 0; i < c->nb_streams; i++)
548 hds_flush(s, &c->streams[i], 1, c->streams[i].last_ts);
549 write_manifest(s, 1);
550
551 if (c->remove_at_exit) {
552 char filename[1024];
553 snprintf(filename, sizeof(filename), "%s/index.f4m", s->filename);
554 unlink(filename);
555 for (i = 0; i < c->nb_streams; i++) {
556 snprintf(filename, sizeof(filename), "%s/stream%d.abst", s->filename, i);
557 unlink(filename);
558 }
559 rmdir(s->filename);
560 }
561
562 hds_free(s);
563 return 0;
564}
565
566#define OFFSET(x) offsetof(HDSContext, x)
567#define E AV_OPT_FLAG_ENCODING_PARAM
568static const AVOption options[] = {
569 { "window_size", "number of fragments kept in the manifest", OFFSET(window_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, E },
570 { "extra_window_size", "number of fragments kept outside of the manifest before removing from disk", OFFSET(extra_window_size), AV_OPT_TYPE_INT, { .i64 = 5 }, 0, INT_MAX, E },
571 { "min_frag_duration", "minimum fragment duration (in microseconds)", OFFSET(min_frag_duration), AV_OPT_TYPE_INT64, { .i64 = 10000000 }, 0, INT_MAX, E },
572 { "remove_at_exit", "remove all fragments when finished", OFFSET(remove_at_exit), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, E },
573 { NULL },
574};
575
576static const AVClass hds_class = {
577 .class_name = "HDS muxer",
578 .item_name = av_default_item_name,
579 .option = options,
580 .version = LIBAVUTIL_VERSION_INT,
581};
582
583AVOutputFormat ff_hds_muxer = {
584 .name = "hds",
585 .long_name = NULL_IF_CONFIG_SMALL("HDS Muxer"),
586 .priv_data_size = sizeof(HDSContext),
587 .audio_codec = AV_CODEC_ID_AAC,
588 .video_codec = AV_CODEC_ID_H264,
589 .flags = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
590 .write_header = hds_write_header,
591 .write_packet = hds_write_packet,
592 .write_trailer = hds_write_trailer,
593 .priv_class = &hds_class,
594};
595
generated by cgit at 2024-05-17 06:09:15 (GMT)