FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavformat/hdsenc.c
Date: 2024-02-16 17:37:06
Exec Total Coverage
Lines: 0 330 0.0%
Functions: 0 13 0.0%
Branches: 0 172 0.0%

Line Branch Exec Source
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 #if HAVE_UNISTD_H
24 #include <unistd.h>
25 #endif
26
27 #include "avformat.h"
28 #include "internal.h"
29 #include "mux.h"
30 #include "os_support.h"
31
32 #include "libavutil/avstring.h"
33 #include "libavutil/base64.h"
34 #include "libavutil/intreadwrite.h"
35 #include "libavutil/mathematics.h"
36 #include "libavutil/opt.h"
37
38 typedef struct Fragment {
39 char file[1024];
40 int64_t start_time, duration;
41 int n;
42 } Fragment;
43
44 typedef struct OutputStream {
45 int bitrate;
46 int first_stream;
47 AVFormatContext *ctx;
48 int ctx_inited;
49 uint8_t iobuf[32768];
50 char temp_filename[1024];
51 int64_t frag_start_ts, last_ts;
52 AVIOContext *out;
53 int packets_written;
54 int nb_fragments, fragments_size, fragment_index;
55 Fragment **fragments;
56
57 int has_audio, has_video;
58
59 uint8_t *metadata;
60 int metadata_size;
61
62 uint8_t *extra_packets[2];
63 int extra_packet_sizes[2];
64 int nb_extra_packets;
65 } OutputStream;
66
67 typedef struct HDSContext {
68 const AVClass *class; /* Class for private options. */
69 int window_size;
70 int extra_window_size;
71 int min_frag_duration;
72 int remove_at_exit;
73
74 OutputStream *streams;
75 int nb_streams;
76 } HDSContext;
77
78 static int parse_header(OutputStream *os, const uint8_t *buf, int buf_size)
79 {
80 if (buf_size < 13)
81 return AVERROR_INVALIDDATA;
82 if (memcmp(buf, "FLV", 3))
83 return AVERROR_INVALIDDATA;
84 buf += 13;
85 buf_size -= 13;
86 while (buf_size >= 11 + 4) {
87 int type = buf[0];
88 int size = AV_RB24(&buf[1]) + 11 + 4;
89 if (size > buf_size)
90 return AVERROR_INVALIDDATA;
91 if (type == 8 || type == 9) {
92 if (os->nb_extra_packets >= FF_ARRAY_ELEMS(os->extra_packets))
93 return AVERROR_INVALIDDATA;
94 os->extra_packet_sizes[os->nb_extra_packets] = size;
95 os->extra_packets[os->nb_extra_packets] = av_memdup(buf, size);
96 if (!os->extra_packets[os->nb_extra_packets])
97 return AVERROR(ENOMEM);
98 os->nb_extra_packets++;
99 } else if (type == 0x12) {
100 if (os->metadata)
101 return AVERROR_INVALIDDATA;
102 os->metadata_size = size - 11 - 4;
103 os->metadata = av_memdup(buf + 11, os->metadata_size);
104 if (!os->metadata)
105 return AVERROR(ENOMEM);
106 }
107 buf += size;
108 buf_size -= size;
109 }
110 if (!os->metadata)
111 return AVERROR_INVALIDDATA;
112 return 0;
113 }
114
115 #if FF_API_AVIO_WRITE_NONCONST
116 static int hds_write(void *opaque, uint8_t *buf, int buf_size)
117 #else
118 static int hds_write(void *opaque, const uint8_t *buf, int buf_size)
119 #endif
120 {
121 OutputStream *os = opaque;
122 if (os->out) {
123 avio_write(os->out, buf, buf_size);
124 } else {
125 if (!os->metadata_size) {
126 int ret;
127 // Assuming the IO buffer is large enough to fit the
128 // FLV header and all metadata and extradata packets
129 if ((ret = parse_header(os, buf, buf_size)) < 0)
130 return ret;
131 }
132 }
133 return buf_size;
134 }
135
136 static void hds_free(AVFormatContext *s)
137 {
138 HDSContext *c = s->priv_data;
139 int i, j;
140 if (!c->streams)
141 return;
142 for (i = 0; i < s->nb_streams; i++) {
143 OutputStream *os = &c->streams[i];
144 if (os->out)
145 ff_format_io_close(s, &os->out);
146 if (os->ctx && os->ctx_inited)
147 av_write_trailer(os->ctx);
148 if (os->ctx)
149 avio_context_free(&os->ctx->pb);
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
161 static 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->url);
173 snprintf(temp_filename, sizeof(temp_filename), "%s/index.f4m.tmp", s->url);
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->url));
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
209 static 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. */
220 static 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->url, index);
240 snprintf(temp_filename, sizeof(temp_filename),
241 "%s/stream%d.abst.tmp", s->url, 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
289 static 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
305 static 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
314 static int hds_write_header(AVFormatContext *s)
315 {
316 HDSContext *c = s->priv_data;
317 const AVOutputFormat *oformat;
318 int ret = 0, i;
319
320 if (mkdir(s->url, 0777) == -1 && errno != EEXIST) {
321 av_log(s, AV_LOG_ERROR , "Failed to create directory %s\n", s->url);
322 return AVERROR(errno);
323 }
324
325 oformat = av_guess_format("flv", NULL, NULL);
326 if (!oformat) {
327 return AVERROR_MUXER_NOT_FOUND;
328 }
329
330 c->streams = av_calloc(s->nb_streams, sizeof(*c->streams));
331 if (!c->streams) {
332 return AVERROR(ENOMEM);
333 }
334
335 for (i = 0; i < s->nb_streams; i++) {
336 OutputStream *os = &c->streams[c->nb_streams];
337 AVFormatContext *ctx;
338 AVStream *st = s->streams[i];
339
340 if (!st->codecpar->bit_rate) {
341 av_log(s, AV_LOG_ERROR, "No bit rate set for stream %d\n", i);
342 return AVERROR(EINVAL);
343 }
344 if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
345 if (os->has_video) {
346 c->nb_streams++;
347 os++;
348 }
349 os->has_video = 1;
350 } else if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO) {
351 if (os->has_audio) {
352 c->nb_streams++;
353 os++;
354 }
355 os->has_audio = 1;
356 } else {
357 av_log(s, AV_LOG_ERROR, "Unsupported stream type in stream %d\n", i);
358 return AVERROR(EINVAL);
359 }
360 os->bitrate += s->streams[i]->codecpar->bit_rate;
361
362 if (!os->ctx) {
363 os->first_stream = i;
364 ctx = avformat_alloc_context();
365 if (!ctx) {
366 return AVERROR(ENOMEM);
367 }
368 os->ctx = ctx;
369 ctx->oformat = oformat;
370 ctx->interrupt_callback = s->interrupt_callback;
371 ctx->flags = s->flags;
372
373 ctx->pb = avio_alloc_context(os->iobuf, sizeof(os->iobuf),
374 1, os,
375 NULL, hds_write, NULL);
376 if (!ctx->pb) {
377 return AVERROR(ENOMEM);
378 }
379 } else {
380 ctx = os->ctx;
381 }
382 s->streams[i]->id = c->nb_streams;
383
384 if (!(st = avformat_new_stream(ctx, NULL))) {
385 return AVERROR(ENOMEM);
386 }
387 avcodec_parameters_copy(st->codecpar, s->streams[i]->codecpar);
388 st->codecpar->codec_tag = 0;
389 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
390 st->time_base = s->streams[i]->time_base;
391 }
392 if (c->streams[c->nb_streams].ctx)
393 c->nb_streams++;
394
395 for (i = 0; i < c->nb_streams; i++) {
396 OutputStream *os = &c->streams[i];
397 int j;
398 if ((ret = avformat_write_header(os->ctx, NULL)) < 0) {
399 return ret;
400 }
401 os->ctx_inited = 1;
402 avio_flush(os->ctx->pb);
403 for (j = 0; j < os->ctx->nb_streams; j++)
404 s->streams[os->first_stream + j]->time_base = os->ctx->streams[j]->time_base;
405
406 snprintf(os->temp_filename, sizeof(os->temp_filename),
407 "%s/stream%d_temp", s->url, i);
408 ret = init_file(s, os, 0);
409 if (ret < 0)
410 return ret;
411
412 if (!os->has_video && c->min_frag_duration <= 0) {
413 av_log(s, AV_LOG_WARNING,
414 "No video stream in output stream %d and no min frag duration set\n", i);
415 }
416 os->fragment_index = 1;
417 write_abst(s, os, 0);
418 }
419 ret = write_manifest(s, 0);
420
421 return ret;
422 }
423
424 static int add_fragment(OutputStream *os, const char *file,
425 int64_t start_time, int64_t duration)
426 {
427 Fragment *frag;
428 if (duration == 0)
429 duration = 1;
430 if (os->nb_fragments >= os->fragments_size) {
431 int ret;
432 os->fragments_size = (os->fragments_size + 1) * 2;
433 if ((ret = av_reallocp_array(&os->fragments, os->fragments_size,
434 sizeof(*os->fragments))) < 0) {
435 os->fragments_size = 0;
436 os->nb_fragments = 0;
437 return ret;
438 }
439 }
440 frag = av_mallocz(sizeof(*frag));
441 if (!frag)
442 return AVERROR(ENOMEM);
443 av_strlcpy(frag->file, file, sizeof(frag->file));
444 frag->start_time = start_time;
445 frag->duration = duration;
446 frag->n = os->fragment_index;
447 os->fragments[os->nb_fragments++] = frag;
448 os->fragment_index++;
449 return 0;
450 }
451
452 static int hds_flush(AVFormatContext *s, OutputStream *os, int final,
453 int64_t end_ts)
454 {
455 HDSContext *c = s->priv_data;
456 int i, ret = 0;
457 char target_filename[1024];
458 int index = s->streams[os->first_stream]->id;
459
460 if (!os->packets_written)
461 return 0;
462
463 avio_flush(os->ctx->pb);
464 os->packets_written = 0;
465 close_file(s, os);
466
467 snprintf(target_filename, sizeof(target_filename),
468 "%s/stream%dSeg1-Frag%d", s->url, index, os->fragment_index);
469 ret = ff_rename(os->temp_filename, target_filename, s);
470 if (ret < 0)
471 return ret;
472 add_fragment(os, target_filename, os->frag_start_ts, end_ts - os->frag_start_ts);
473
474 if (!final) {
475 ret = init_file(s, os, end_ts);
476 if (ret < 0)
477 return ret;
478 }
479
480 if (c->window_size || (final && c->remove_at_exit)) {
481 int remove = os->nb_fragments - c->window_size - c->extra_window_size;
482 if (final && c->remove_at_exit)
483 remove = os->nb_fragments;
484 if (remove > 0) {
485 for (i = 0; i < remove; i++) {
486 unlink(os->fragments[i]->file);
487 av_freep(&os->fragments[i]);
488 }
489 os->nb_fragments -= remove;
490 memmove(os->fragments, os->fragments + remove,
491 os->nb_fragments * sizeof(*os->fragments));
492 }
493 }
494
495 if (ret >= 0)
496 ret = write_abst(s, os, final);
497 return ret;
498 }
499
500 static int hds_write_packet(AVFormatContext *s, AVPacket *pkt)
501 {
502 HDSContext *c = s->priv_data;
503 AVStream *st = s->streams[pkt->stream_index];
504 FFStream *const sti = ffstream(st);
505 OutputStream *os = &c->streams[s->streams[pkt->stream_index]->id];
506 int64_t end_dts = os->fragment_index * (int64_t)c->min_frag_duration;
507 int ret;
508
509 if (sti->first_dts == AV_NOPTS_VALUE)
510 sti->first_dts = pkt->dts;
511
512 if ((!os->has_video || st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
513 av_compare_ts(pkt->dts - sti->first_dts, st->time_base,
514 end_dts, AV_TIME_BASE_Q) >= 0 &&
515 pkt->flags & AV_PKT_FLAG_KEY && os->packets_written) {
516
517 if ((ret = hds_flush(s, os, 0, pkt->dts)) < 0)
518 return ret;
519 }
520
521 // Note, these fragment start timestamps, that represent a whole
522 // OutputStream, assume all streams in it have the same time base.
523 if (!os->packets_written)
524 os->frag_start_ts = pkt->dts;
525 os->last_ts = pkt->dts;
526
527 os->packets_written++;
528 return ff_write_chained(os->ctx, pkt->stream_index - os->first_stream, pkt, s, 0);
529 }
530
531 static int hds_write_trailer(AVFormatContext *s)
532 {
533 HDSContext *c = s->priv_data;
534 int i;
535
536 for (i = 0; i < c->nb_streams; i++)
537 hds_flush(s, &c->streams[i], 1, c->streams[i].last_ts);
538 write_manifest(s, 1);
539
540 if (c->remove_at_exit) {
541 char filename[1024];
542 snprintf(filename, sizeof(filename), "%s/index.f4m", s->url);
543 unlink(filename);
544 for (i = 0; i < c->nb_streams; i++) {
545 snprintf(filename, sizeof(filename), "%s/stream%d.abst", s->url, i);
546 unlink(filename);
547 }
548 rmdir(s->url);
549 }
550
551 return 0;
552 }
553
554 #define OFFSET(x) offsetof(HDSContext, x)
555 #define E AV_OPT_FLAG_ENCODING_PARAM
556 static const AVOption options[] = {
557 { "window_size", "number of fragments kept in the manifest", OFFSET(window_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, E },
558 { "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 },
559 { "min_frag_duration", "minimum fragment duration (in microseconds)", OFFSET(min_frag_duration), AV_OPT_TYPE_INT64, { .i64 = 10000000 }, 0, INT_MAX, E },
560 { "remove_at_exit", "remove all fragments when finished", OFFSET(remove_at_exit), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, E },
561 { NULL },
562 };
563
564 static const AVClass hds_class = {
565 .class_name = "HDS muxer",
566 .item_name = av_default_item_name,
567 .option = options,
568 .version = LIBAVUTIL_VERSION_INT,
569 };
570
571 const FFOutputFormat ff_hds_muxer = {
572 .p.name = "hds",
573 .p.long_name = NULL_IF_CONFIG_SMALL("HDS Muxer"),
574 .p.audio_codec = AV_CODEC_ID_AAC,
575 .p.video_codec = AV_CODEC_ID_H264,
576 .p.flags = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
577 .p.priv_class = &hds_class,
578 .priv_data_size = sizeof(HDSContext),
579 .write_header = hds_write_header,
580 .write_packet = hds_write_packet,
581 .write_trailer = hds_write_trailer,
582 .deinit = hds_free,
583 };
584