libavformat/hdsenc.c

   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
  39 typedef struct Fragment {
  40     char file[1024];
  41     int64_t start_time, duration;
  42     int n;
  43 } Fragment;
  44
  45 typedef 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
  68 typedef 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
  79 static 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
 118 static 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
 135 static 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             avio_context_free(&os->ctx->pb);
 149         avformat_free_context(os->ctx);
 150         av_freep(&os->metadata);
 151         for (j = 0; j < os->nb_extra_packets; j++)
 152             av_freep(&os->extra_packets[j]);
 153         for (j = 0; j < os->nb_fragments; j++)
 154             av_freep(&os->fragments[j]);
 155         av_freep(&os->fragments);
 156     }
 157     av_freep(&c->streams);
 158 }
 159
 160 static int write_manifest(AVFormatContext *s, int final)
 161 {
 162     HDSContext *c = s->priv_data;
 163     AVIOContext *out;
 164     char filename[1024], temp_filename[1024];
 165     int ret, i;
 166     double duration = 0;
 167
 168     if (c->nb_streams > 0)
 169         duration = c->streams[0].last_ts * av_q2d(s->streams[0]->time_base);
 170
 171     snprintf(filename, sizeof(filename), "%s/index.f4m", s->url);
 172     snprintf(temp_filename, sizeof(temp_filename), "%s/index.f4m.tmp", s->url);
 173     ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, NULL);
 174     if (ret < 0) {
 175         av_log(s, AV_LOG_ERROR, "Unable to open %s for writing\n", temp_filename);
 176         return ret;
 177     }
 178     avio_printf(out, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
 179     avio_printf(out, "<manifest xmlns=\"http://ns.adobe.com/f4m/1.0\">\n");
 180     avio_printf(out, "\t<id>%s</id>\n", av_basename(s->url));
 181     avio_printf(out, "\t<streamType>%s</streamType>\n",
 182                      final ? "recorded" : "live");
 183     avio_printf(out, "\t<deliveryType>streaming</deliveryType>\n");
 184     if (final)
 185         avio_printf(out, "\t<duration>%f</duration>\n", duration);
 186     for (i = 0; i < c->nb_streams; i++) {
 187         OutputStream *os = &c->streams[i];
 188         int b64_size = AV_BASE64_SIZE(os->metadata_size);
 189         char *base64 = av_malloc(b64_size);
 190         if (!base64) {
 191             ff_format_io_close(s, &out);
 192             return AVERROR(ENOMEM);
 193         }
 194         av_base64_encode(base64, b64_size, os->metadata, os->metadata_size);
 195
 196         avio_printf(out, "\t<bootstrapInfo profile=\"named\" url=\"stream%d.abst\" id=\"bootstrap%d\" />\n", i, i);
 197         avio_printf(out, "\t<media bitrate=\"%d\" url=\"stream%d\" bootstrapInfoId=\"bootstrap%d\">\n", os->bitrate/1000, i, i);
 198         avio_printf(out, "\t\t<metadata>%s</metadata>\n", base64);
 199         avio_printf(out, "\t</media>\n");
 200         av_free(base64);
 201     }
 202     avio_printf(out, "</manifest>\n");
 203     avio_flush(out);
 204     ff_format_io_close(s, &out);
 205     return ff_rename(temp_filename, filename, s);
 206 }
 207
 208 static void update_size(AVIOContext *out, int64_t pos)
 209 {
 210     int64_t end = avio_tell(out);
 211     avio_seek(out, pos, SEEK_SET);
 212     avio_wb32(out, end - pos);
 213     avio_seek(out, end, SEEK_SET);
 214 }
 215
 216 /* Note, the .abst files need to be served with the "binary/octet"
 217  * mime type, otherwise at least the OSMF player can easily fail
 218  * with "stream not found" when polling for the next fragment. */
 219 static int write_abst(AVFormatContext *s, OutputStream *os, int final)
 220 {
 221     HDSContext *c = s->priv_data;
 222     AVIOContext *out;
 223     char filename[1024], temp_filename[1024];
 224     int i, ret;
 225     int64_t asrt_pos, afrt_pos;
 226     int start = 0, fragments;
 227     int index = s->streams[os->first_stream]->id;
 228     int64_t cur_media_time = 0;
 229     if (c->window_size)
 230         start = FFMAX(os->nb_fragments - c->window_size, 0);
 231     fragments = os->nb_fragments - start;
 232     if (final)
 233         cur_media_time = os->last_ts;
 234     else if (os->nb_fragments)
 235         cur_media_time = os->fragments[os->nb_fragments - 1]->start_time;
 236
 237     snprintf(filename, sizeof(filename),
 238              "%s/stream%d.abst", s->url, index);
 239     snprintf(temp_filename, sizeof(temp_filename),
 240              "%s/stream%d.abst.tmp", s->url, index);
 241     ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, NULL);
 242     if (ret < 0) {
 243         av_log(s, AV_LOG_ERROR, "Unable to open %s for writing\n", temp_filename);
 244         return ret;
 245     }
 246     avio_wb32(out, 0); // abst size
 247     avio_wl32(out, MKTAG('a','b','s','t'));
 248     avio_wb32(out, 0); // version + flags
 249     avio_wb32(out, os->fragment_index - 1); // BootstrapinfoVersion
 250     avio_w8(out, final ? 0 : 0x20); // profile, live, update
 251     avio_wb32(out, 1000); // timescale
 252     avio_wb64(out, cur_media_time);
 253     avio_wb64(out, 0); // SmpteTimeCodeOffset
 254     avio_w8(out, 0); // MovieIdentifer (null string)
 255     avio_w8(out, 0); // ServerEntryCount
 256     avio_w8(out, 0); // QualityEntryCount
 257     avio_w8(out, 0); // DrmData (null string)
 258     avio_w8(out, 0); // MetaData (null string)
 259     avio_w8(out, 1); // SegmentRunTableCount
 260     asrt_pos = avio_tell(out);
 261     avio_wb32(out, 0); // asrt size
 262     avio_wl32(out, MKTAG('a','s','r','t'));
 263     avio_wb32(out, 0); // version + flags
 264     avio_w8(out, 0); // QualityEntryCount
 265     avio_wb32(out, 1); // SegmentRunEntryCount
 266     avio_wb32(out, 1); // FirstSegment
 267     avio_wb32(out, final ? (os->fragment_index - 1) : 0xffffffff); // FragmentsPerSegment
 268     update_size(out, asrt_pos);
 269     avio_w8(out, 1); // FragmentRunTableCount
 270     afrt_pos = avio_tell(out);
 271     avio_wb32(out, 0); // afrt size
 272     avio_wl32(out, MKTAG('a','f','r','t'));
 273     avio_wb32(out, 0); // version + flags
 274     avio_wb32(out, 1000); // timescale
 275     avio_w8(out, 0); // QualityEntryCount
 276     avio_wb32(out, fragments); // FragmentRunEntryCount
 277     for (i = start; i < os->nb_fragments; i++) {
 278         avio_wb32(out, os->fragments[i]->n);
 279         avio_wb64(out, os->fragments[i]->start_time);
 280         avio_wb32(out, os->fragments[i]->duration);
 281     }
 282     update_size(out, afrt_pos);
 283     update_size(out, 0);
 284     ff_format_io_close(s, &out);
 285     return ff_rename(temp_filename, filename, s);
 286 }
 287
 288 static int init_file(AVFormatContext *s, OutputStream *os, int64_t start_ts)
 289 {
 290     int ret, i;
 291     ret = s->io_open(s, &os->out, os->temp_filename, AVIO_FLAG_WRITE, NULL);
 292     if (ret < 0)
 293         return ret;
 294     avio_wb32(os->out, 0);
 295     avio_wl32(os->out, MKTAG('m','d','a','t'));
 296     for (i = 0; i < os->nb_extra_packets; i++) {
 297         AV_WB24(os->extra_packets[i] + 4, start_ts);
 298         os->extra_packets[i][7] = (start_ts >> 24) & 0x7f;
 299         avio_write(os->out, os->extra_packets[i], os->extra_packet_sizes[i]);
 300     }
 301     return 0;
 302 }
 303
 304 static void close_file(AVFormatContext *s, OutputStream *os)
 305 {
 306     int64_t pos = avio_tell(os->out);
 307     avio_seek(os->out, 0, SEEK_SET);
 308     avio_wb32(os->out, pos);
 309     avio_flush(os->out);
 310     ff_format_io_close(s, &os->out);
 311 }
 312
 313 static int hds_write_header(AVFormatContext *s)
 314 {
 315     HDSContext *c = s->priv_data;
 316     int ret = 0, i;
 317     ff_const59 AVOutputFormat *oformat;
 318
 319     if (mkdir(s->url, 0777) == -1 && errno != EEXIST) {
 320         av_log(s, AV_LOG_ERROR , "Failed to create directory %s\n", s->url);
 321         return AVERROR(errno);
 322     }
 323
 324     oformat = av_guess_format("flv", NULL, NULL);
 325     if (!oformat) {
 326         return AVERROR_MUXER_NOT_FOUND;
 327     }
 328
 329     c->streams = av_mallocz_array(s->nb_streams, sizeof(*c->streams));
 330     if (!c->streams) {
 331         return AVERROR(ENOMEM);
 332     }
 333
 334     for (i = 0; i < s->nb_streams; i++) {
 335         OutputStream *os = &c->streams[c->nb_streams];
 336         AVFormatContext *ctx;
 337         AVStream *st = s->streams[i];
 338
 339         if (!st->codecpar->bit_rate) {
 340             av_log(s, AV_LOG_ERROR, "No bit rate set for stream %d\n", i);
 341             return AVERROR(EINVAL);
 342         }
 343         if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
 344             if (os->has_video) {
 345                 c->nb_streams++;
 346                 os++;
 347             }
 348             os->has_video = 1;
 349         } else if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO) {
 350             if (os->has_audio) {
 351                 c->nb_streams++;
 352                 os++;
 353             }
 354             os->has_audio = 1;
 355         } else {
 356             av_log(s, AV_LOG_ERROR, "Unsupported stream type in stream %d\n", i);
 357             return AVERROR(EINVAL);
 358         }
 359         os->bitrate += s->streams[i]->codecpar->bit_rate;
 360
 361         if (!os->ctx) {
 362             os->first_stream = i;
 363             ctx = avformat_alloc_context();
 364             if (!ctx) {
 365                 return AVERROR(ENOMEM);
 366             }
 367             os->ctx = ctx;
 368             ctx->oformat = oformat;
 369             ctx->interrupt_callback = s->interrupt_callback;
 370             ctx->flags = s->flags;
 371
 372             ctx->pb = avio_alloc_context(os->iobuf, sizeof(os->iobuf),
 373                                          AVIO_FLAG_WRITE, os,
 374                                          NULL, hds_write, NULL);
 375             if (!ctx->pb) {
 376                 return AVERROR(ENOMEM);
 377             }
 378         } else {
 379             ctx = os->ctx;
 380         }
 381         s->streams[i]->id = c->nb_streams;
 382
 383         if (!(st = avformat_new_stream(ctx, NULL))) {
 384             return AVERROR(ENOMEM);
 385         }
 386         avcodec_parameters_copy(st->codecpar, s->streams[i]->codecpar);
 387         st->codecpar->codec_tag = 0;
 388         st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
 389         st->time_base = s->streams[i]->time_base;
 390     }
 391     if (c->streams[c->nb_streams].ctx)
 392         c->nb_streams++;
 393
 394     for (i = 0; i < c->nb_streams; i++) {
 395         OutputStream *os = &c->streams[i];
 396         int j;
 397         if ((ret = avformat_write_header(os->ctx, NULL)) < 0) {
 398              return ret;
 399         }
 400         os->ctx_inited = 1;
 401         avio_flush(os->ctx->pb);
 402         for (j = 0; j < os->ctx->nb_streams; j++)
 403             s->streams[os->first_stream + j]->time_base = os->ctx->streams[j]->time_base;
 404
 405         snprintf(os->temp_filename, sizeof(os->temp_filename),
 406                  "%s/stream%d_temp", s->url, i);
 407         ret = init_file(s, os, 0);
 408         if (ret < 0)
 409             return ret;
 410
 411         if (!os->has_video && c->min_frag_duration <= 0) {
 412             av_log(s, AV_LOG_WARNING,
 413                    "No video stream in output stream %d and no min frag duration set\n", i);
 414         }
 415         os->fragment_index = 1;
 416         write_abst(s, os, 0);
 417     }
 418     ret = write_manifest(s, 0);
 419
 420     return ret;
 421 }
 422
 423 static int add_fragment(OutputStream *os, const char *file,
 424                         int64_t start_time, int64_t duration)
 425 {
 426     Fragment *frag;
 427     if (duration == 0)
 428         duration = 1;
 429     if (os->nb_fragments >= os->fragments_size) {
 430         int ret;
 431         os->fragments_size = (os->fragments_size + 1) * 2;
 432         if ((ret = av_reallocp_array(&os->fragments, os->fragments_size,
 433                                      sizeof(*os->fragments))) < 0) {
 434             os->fragments_size = 0;
 435             os->nb_fragments   = 0;
 436             return ret;
 437         }
 438     }
 439     frag = av_mallocz(sizeof(*frag));
 440     if (!frag)
 441         return AVERROR(ENOMEM);
 442     av_strlcpy(frag->file, file, sizeof(frag->file));
 443     frag->start_time = start_time;
 444     frag->duration   = duration;
 445     frag->n          = os->fragment_index;
 446     os->fragments[os->nb_fragments++] = frag;
 447     os->fragment_index++;
 448     return 0;
 449 }
 450
 451 static int hds_flush(AVFormatContext *s, OutputStream *os, int final,
 452                      int64_t end_ts)
 453 {
 454     HDSContext *c = s->priv_data;
 455     int i, ret = 0;
 456     char target_filename[1024];
 457     int index = s->streams[os->first_stream]->id;
 458
 459     if (!os->packets_written)
 460         return 0;
 461
 462     avio_flush(os->ctx->pb);
 463     os->packets_written = 0;
 464     close_file(s, os);
 465
 466     snprintf(target_filename, sizeof(target_filename),
 467              "%s/stream%dSeg1-Frag%d", s->url, index, os->fragment_index);
 468     ret = ff_rename(os->temp_filename, target_filename, s);
 469     if (ret < 0)
 470         return ret;
 471     add_fragment(os, target_filename, os->frag_start_ts, end_ts - os->frag_start_ts);
 472
 473     if (!final) {
 474         ret = init_file(s, os, end_ts);
 475         if (ret < 0)
 476             return ret;
 477     }
 478
 479     if (c->window_size || (final && c->remove_at_exit)) {
 480         int remove = os->nb_fragments - c->window_size - c->extra_window_size;
 481         if (final && c->remove_at_exit)
 482             remove = os->nb_fragments;
 483         if (remove > 0) {
 484             for (i = 0; i < remove; i++) {
 485                 unlink(os->fragments[i]->file);
 486                 av_freep(&os->fragments[i]);
 487             }
 488             os->nb_fragments -= remove;
 489             memmove(os->fragments, os->fragments + remove,
 490                     os->nb_fragments * sizeof(*os->fragments));
 491         }
 492     }
 493
 494     if (ret >= 0)
 495         ret = write_abst(s, os, final);
 496     return ret;
 497 }
 498
 499 static int hds_write_packet(AVFormatContext *s, AVPacket *pkt)
 500 {
 501     HDSContext *c = s->priv_data;
 502     AVStream *st = s->streams[pkt->stream_index];
 503     OutputStream *os = &c->streams[s->streams[pkt->stream_index]->id];
 504     int64_t end_dts = os->fragment_index * (int64_t)c->min_frag_duration;
 505     int ret;
 506
 507     if (st->first_dts == AV_NOPTS_VALUE)
 508         st->first_dts = pkt->dts;
 509
 510     if ((!os->has_video || st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
 511         av_compare_ts(pkt->dts - st->first_dts, st->time_base,
 512                       end_dts, AV_TIME_BASE_Q) >= 0 &&
 513         pkt->flags & AV_PKT_FLAG_KEY && os->packets_written) {
 514
 515         if ((ret = hds_flush(s, os, 0, pkt->dts)) < 0)
 516             return ret;
 517     }
 518
 519     // Note, these fragment start timestamps, that represent a whole
 520     // OutputStream, assume all streams in it have the same time base.
 521     if (!os->packets_written)
 522         os->frag_start_ts = pkt->dts;
 523     os->last_ts = pkt->dts;
 524
 525     os->packets_written++;
 526     return ff_write_chained(os->ctx, pkt->stream_index - os->first_stream, pkt, s, 0);
 527 }
 528
 529 static int hds_write_trailer(AVFormatContext *s)
 530 {
 531     HDSContext *c = s->priv_data;
 532     int i;
 533
 534     for (i = 0; i < c->nb_streams; i++)
 535         hds_flush(s, &c->streams[i], 1, c->streams[i].last_ts);
 536     write_manifest(s, 1);
 537
 538     if (c->remove_at_exit) {
 539         char filename[1024];
 540         snprintf(filename, sizeof(filename), "%s/index.f4m", s->url);
 541         unlink(filename);
 542         for (i = 0; i < c->nb_streams; i++) {
 543             snprintf(filename, sizeof(filename), "%s/stream%d.abst", s->url, i);
 544             unlink(filename);
 545         }
 546         rmdir(s->url);
 547     }
 548
 549     return 0;
 550 }
 551
 552 #define OFFSET(x) offsetof(HDSContext, x)
 553 #define E AV_OPT_FLAG_ENCODING_PARAM
 554 static const AVOption options[] = {
 555     { "window_size", "number of fragments kept in the manifest", OFFSET(window_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, E },
 556     { "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 },
 557     { "min_frag_duration", "minimum fragment duration (in microseconds)", OFFSET(min_frag_duration), AV_OPT_TYPE_INT64, { .i64 = 10000000 }, 0, INT_MAX, E },
 558     { "remove_at_exit", "remove all fragments when finished", OFFSET(remove_at_exit), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, E },
 559     { NULL },
 560 };
 561
 562 static const AVClass hds_class = {
 563     .class_name = "HDS muxer",
 564     .item_name  = av_default_item_name,
 565     .option     = options,
 566     .version    = LIBAVUTIL_VERSION_INT,
 567 };
 568
 569 AVOutputFormat ff_hds_muxer = {
 570     .name           = "hds",
 571     .long_name      = NULL_IF_CONFIG_SMALL("HDS Muxer"),
 572     .priv_data_size = sizeof(HDSContext),
 573     .audio_codec    = AV_CODEC_ID_AAC,
 574     .video_codec    = AV_CODEC_ID_H264,
 575     .flags          = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
 576     .write_header   = hds_write_header,
 577     .write_packet   = hds_write_packet,
 578     .write_trailer  = hds_write_trailer,
 579     .deinit         = hds_free,
 580     .priv_class     = &hds_class,
 581 };