git.sesse.net Git - ffmpeg/blob - libavformat/segment.c

   1 /*
   2  * Copyright (c) 2011, Luca Barbato
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file generic segmenter
  23  * M3U8 specification can be find here:
  24  * @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}
  25  */
  26
  27 /* #define DEBUG */
  28
  29 #include <float.h>
  30 #include <time.h>
  31
  32 #include "avformat.h"
  33 #include "avio_internal.h"
  34 #include "internal.h"
  35
  36 #include "libavutil/avassert.h"
  37 #include "libavutil/internal.h"
  38 #include "libavutil/log.h"
  39 #include "libavutil/opt.h"
  40 #include "libavutil/avstring.h"
  41 #include "libavutil/parseutils.h"
  42 #include "libavutil/mathematics.h"
  43 #include "libavutil/time.h"
  44 #include "libavutil/timecode.h"
  45 #include "libavutil/time_internal.h"
  46 #include "libavutil/timestamp.h"
  47
  48 typedef struct SegmentListEntry {
  49     int index;
  50     double start_time, end_time;
  51     int64_t start_pts;
  52     int64_t offset_pts;
  53     char *filename;
  54     struct SegmentListEntry *next;
  55     int64_t last_duration;
  56 } SegmentListEntry;
  57
  58 typedef enum {
  59     LIST_TYPE_UNDEFINED = -1,
  60     LIST_TYPE_FLAT = 0,
  61     LIST_TYPE_CSV,
  62     LIST_TYPE_M3U8,
  63     LIST_TYPE_EXT, ///< deprecated
  64     LIST_TYPE_FFCONCAT,
  65     LIST_TYPE_NB,
  66 } ListType;
  67
  68 #define SEGMENT_LIST_FLAG_CACHE 1
  69 #define SEGMENT_LIST_FLAG_LIVE  2
  70
  71 typedef struct SegmentContext {
  72     const AVClass *class;  /**< Class for private options. */
  73     int segment_idx;       ///< index of the segment file to write, starting from 0
  74     int segment_idx_wrap;  ///< number after which the index wraps
  75     int segment_idx_wrap_nb;  ///< number of time the index has wraped
  76     int segment_count;     ///< number of segment files already written
  77     AVOutputFormat *oformat;
  78     AVFormatContext *avf;
  79     char *format;              ///< format to use for output segment files
  80     char *format_options_str;  ///< format options to use for output segment files
  81     AVDictionary *format_options;
  82     char *list;            ///< filename for the segment list file
  83     int   list_flags;      ///< flags affecting list generation
  84     int   list_size;       ///< number of entries for the segment list file
  85
  86     int use_clocktime;    ///< flag to cut segments at regular clock time
  87     int64_t clocktime_offset; //< clock offset for cutting the segments at regular clock time
  88     int64_t clocktime_wrap_duration; //< wrapping duration considered for starting a new segment
  89     int64_t last_val;      ///< remember last time for wrap around detection
  90     int64_t last_cut;      ///< remember last cut
  91     int cut_pending;
  92
  93     char *entry_prefix;    ///< prefix to add to list entry filenames
  94     int list_type;         ///< set the list type
  95     AVIOContext *list_pb;  ///< list file put-byte context
  96     char *time_str;        ///< segment duration specification string
  97     int64_t time;          ///< segment duration
  98     int use_strftime;      ///< flag to expand filename with strftime
  99     int increment_tc;      ///< flag to increment timecode if found
 100
 101     char *times_str;       ///< segment times specification string
 102     int64_t *times;        ///< list of segment interval specification
 103     int nb_times;          ///< number of elments in the times array
 104
 105     char *frames_str;      ///< segment frame numbers specification string
 106     int *frames;           ///< list of frame number specification
 107     int nb_frames;         ///< number of elments in the frames array
 108     int frame_count;       ///< total number of reference frames
 109     int segment_frame_count; ///< number of reference frames in the segment
 110
 111     int64_t time_delta;
 112     int  individual_header_trailer; /**< Set by a private option. */
 113     int  write_header_trailer; /**< Set by a private option. */
 114     char *header_filename;  ///< filename to write the output header to
 115
 116     int reset_timestamps;  ///< reset timestamps at the begin of each segment
 117     int64_t initial_offset;    ///< initial timestamps offset, expressed in microseconds
 118     char *reference_stream_specifier; ///< reference stream specifier
 119     int   reference_stream_index;
 120     int   break_non_keyframes;
 121     int   write_empty;
 122
 123     int use_rename;
 124     char temp_list_filename[1024];
 125
 126     SegmentListEntry cur_entry;
 127     SegmentListEntry *segment_list_entries;
 128     SegmentListEntry *segment_list_entries_end;
 129 } SegmentContext;
 130
 131 static void print_csv_escaped_str(AVIOContext *ctx, const char *str)
 132 {
 133     int needs_quoting = !!str[strcspn(str, "\",\n\r")];
 134
 135     if (needs_quoting)
 136         avio_w8(ctx, '"');
 137
 138     for (; *str; str++) {
 139         if (*str == '"')
 140             avio_w8(ctx, '"');
 141         avio_w8(ctx, *str);
 142     }
 143     if (needs_quoting)
 144         avio_w8(ctx, '"');
 145 }
 146
 147 static int segment_mux_init(AVFormatContext *s)
 148 {
 149     SegmentContext *seg = s->priv_data;
 150     AVFormatContext *oc;
 151     int i;
 152     int ret;
 153
 154     ret = avformat_alloc_output_context2(&seg->avf, seg->oformat, NULL, NULL);
 155     if (ret < 0)
 156         return ret;
 157     oc = seg->avf;
 158
 159     oc->interrupt_callback = s->interrupt_callback;
 160     oc->max_delay          = s->max_delay;
 161     av_dict_copy(&oc->metadata, s->metadata, 0);
 162     oc->opaque             = s->opaque;
 163     oc->io_close           = s->io_close;
 164     oc->io_open            = s->io_open;
 165     oc->flags              = s->flags;
 166
 167     for (i = 0; i < s->nb_streams; i++) {
 168         AVStream *st;
 169         AVCodecParameters *ipar, *opar;
 170
 171         if (!(st = avformat_new_stream(oc, NULL)))
 172             return AVERROR(ENOMEM);
 173         ipar = s->streams[i]->codecpar;
 174         opar = st->codecpar;
 175         avcodec_parameters_copy(opar, ipar);
 176         if (!oc->oformat->codec_tag ||
 177             av_codec_get_id (oc->oformat->codec_tag, ipar->codec_tag) == opar->codec_id ||
 178             av_codec_get_tag(oc->oformat->codec_tag, ipar->codec_id) <= 0) {
 179             opar->codec_tag = ipar->codec_tag;
 180         } else {
 181             opar->codec_tag = 0;
 182         }
 183         st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
 184         st->time_base = s->streams[i]->time_base;
 185         av_dict_copy(&st->metadata, s->streams[i]->metadata, 0);
 186     }
 187
 188     return 0;
 189 }
 190
 191 static int set_segment_filename(AVFormatContext *s)
 192 {
 193     SegmentContext *seg = s->priv_data;
 194     AVFormatContext *oc = seg->avf;
 195     size_t size;
 196     int ret;
 197
 198     if (seg->segment_idx_wrap)
 199         seg->segment_idx %= seg->segment_idx_wrap;
 200     if (seg->use_strftime) {
 201         time_t now0;
 202         struct tm *tm, tmpbuf;
 203         time(&now0);
 204         tm = localtime_r(&now0, &tmpbuf);
 205         if (!strftime(oc->filename, sizeof(oc->filename), s->filename, tm)) {
 206             av_log(oc, AV_LOG_ERROR, "Could not get segment filename with strftime\n");
 207             return AVERROR(EINVAL);
 208         }
 209     } else if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
 210                                      s->filename, seg->segment_idx) < 0) {
 211         av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->filename);
 212         return AVERROR(EINVAL);
 213     }
 214
 215     /* copy modified name in list entry */
 216     size = strlen(av_basename(oc->filename)) + 1;
 217     if (seg->entry_prefix)
 218         size += strlen(seg->entry_prefix);
 219
 220     if ((ret = av_reallocp(&seg->cur_entry.filename, size)) < 0)
 221         return ret;
 222     snprintf(seg->cur_entry.filename, size, "%s%s",
 223              seg->entry_prefix ? seg->entry_prefix : "",
 224              av_basename(oc->filename));
 225
 226     return 0;
 227 }
 228
 229 static int segment_start(AVFormatContext *s, int write_header)
 230 {
 231     SegmentContext *seg = s->priv_data;
 232     AVFormatContext *oc = seg->avf;
 233     int err = 0;
 234
 235     if (write_header) {
 236         avformat_free_context(oc);
 237         seg->avf = NULL;
 238         if ((err = segment_mux_init(s)) < 0)
 239             return err;
 240         oc = seg->avf;
 241     }
 242
 243     seg->segment_idx++;
 244     if ((seg->segment_idx_wrap) && (seg->segment_idx % seg->segment_idx_wrap == 0))
 245         seg->segment_idx_wrap_nb++;
 246
 247     if ((err = set_segment_filename(s)) < 0)
 248         return err;
 249
 250     if ((err = s->io_open(s, &oc->pb, oc->filename, AVIO_FLAG_WRITE, NULL)) < 0) {
 251         av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->filename);
 252         return err;
 253     }
 254     if (!seg->individual_header_trailer)
 255         oc->pb->seekable = 0;
 256
 257     if (oc->oformat->priv_class && oc->priv_data)
 258         av_opt_set(oc->priv_data, "mpegts_flags", "+resend_headers", 0);
 259
 260     if (write_header) {
 261         AVDictionary *options = NULL;
 262         av_dict_copy(&options, seg->format_options, 0);
 263         err = avformat_write_header(oc, &options);
 264         av_dict_free(&options);
 265         if (err < 0)
 266             return err;
 267     }
 268
 269     seg->segment_frame_count = 0;
 270     return 0;
 271 }
 272
 273 static int segment_list_open(AVFormatContext *s)
 274 {
 275     SegmentContext *seg = s->priv_data;
 276     int ret;
 277
 278     snprintf(seg->temp_list_filename, sizeof(seg->temp_list_filename), seg->use_rename ? "%s.tmp" : "%s", seg->list);
 279     ret = s->io_open(s, &seg->list_pb, seg->temp_list_filename, AVIO_FLAG_WRITE, NULL);
 280     if (ret < 0) {
 281         av_log(s, AV_LOG_ERROR, "Failed to open segment list '%s'\n", seg->list);
 282         return ret;
 283     }
 284
 285     if (seg->list_type == LIST_TYPE_M3U8 && seg->segment_list_entries) {
 286         SegmentListEntry *entry;
 287         double max_duration = 0;
 288
 289         avio_printf(seg->list_pb, "#EXTM3U\n");
 290         avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
 291         avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->segment_list_entries->index);
 292         avio_printf(seg->list_pb, "#EXT-X-ALLOW-CACHE:%s\n",
 293                     seg->list_flags & SEGMENT_LIST_FLAG_CACHE ? "YES" : "NO");
 294
 295         av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
 296                seg->segment_list_entries->index);
 297
 298         for (entry = seg->segment_list_entries; entry; entry = entry->next)
 299             max_duration = FFMAX(max_duration, entry->end_time - entry->start_time);
 300         avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%"PRId64"\n", (int64_t)ceil(max_duration));
 301     } else if (seg->list_type == LIST_TYPE_FFCONCAT) {
 302         avio_printf(seg->list_pb, "ffconcat version 1.0\n");
 303     }
 304
 305     return ret;
 306 }
 307
 308 static void segment_list_print_entry(AVIOContext      *list_ioctx,
 309                                      ListType          list_type,
 310                                      const SegmentListEntry *list_entry,
 311                                      void *log_ctx)
 312 {
 313     switch (list_type) {
 314     case LIST_TYPE_FLAT:
 315         avio_printf(list_ioctx, "%s\n", list_entry->filename);
 316         break;
 317     case LIST_TYPE_CSV:
 318     case LIST_TYPE_EXT:
 319         print_csv_escaped_str(list_ioctx, list_entry->filename);
 320         avio_printf(list_ioctx, ",%f,%f\n", list_entry->start_time, list_entry->end_time);
 321         break;
 322     case LIST_TYPE_M3U8:
 323         avio_printf(list_ioctx, "#EXTINF:%f,\n%s\n",
 324                     list_entry->end_time - list_entry->start_time, list_entry->filename);
 325         break;
 326     case LIST_TYPE_FFCONCAT:
 327     {
 328         char *buf;
 329         if (av_escape(&buf, list_entry->filename, NULL, AV_ESCAPE_MODE_AUTO, AV_ESCAPE_FLAG_WHITESPACE) < 0) {
 330             av_log(log_ctx, AV_LOG_WARNING,
 331                    "Error writing list entry '%s' in list file\n", list_entry->filename);
 332             return;
 333         }
 334         avio_printf(list_ioctx, "file %s\n", buf);
 335         av_free(buf);
 336         break;
 337     }
 338     default:
 339         av_assert0(!"Invalid list type");
 340     }
 341 }
 342
 343 static int segment_end(AVFormatContext *s, int write_trailer, int is_last)
 344 {
 345     SegmentContext *seg = s->priv_data;
 346     AVFormatContext *oc = seg->avf;
 347     int ret = 0;
 348     AVTimecode tc;
 349     AVRational rate;
 350     AVDictionaryEntry *tcr;
 351     char buf[AV_TIMECODE_STR_SIZE];
 352     int i;
 353     int err;
 354
 355     av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
 356     if (write_trailer)
 357         ret = av_write_trailer(oc);
 358
 359     if (ret < 0)
 360         av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
 361                oc->filename);
 362
 363     if (seg->list) {
 364         if (seg->list_size || seg->list_type == LIST_TYPE_M3U8) {
 365             SegmentListEntry *entry = av_mallocz(sizeof(*entry));
 366             if (!entry) {
 367                 ret = AVERROR(ENOMEM);
 368                 goto end;
 369             }
 370
 371             /* append new element */
 372             memcpy(entry, &seg->cur_entry, sizeof(*entry));
 373             entry->filename = av_strdup(entry->filename);
 374             if (!seg->segment_list_entries)
 375                 seg->segment_list_entries = seg->segment_list_entries_end = entry;
 376             else
 377                 seg->segment_list_entries_end->next = entry;
 378             seg->segment_list_entries_end = entry;
 379
 380             /* drop first item */
 381             if (seg->list_size && seg->segment_count >= seg->list_size) {
 382                 entry = seg->segment_list_entries;
 383                 seg->segment_list_entries = seg->segment_list_entries->next;
 384                 av_freep(&entry->filename);
 385                 av_freep(&entry);
 386             }
 387
 388             if ((ret = segment_list_open(s)) < 0)
 389                 goto end;
 390             for (entry = seg->segment_list_entries; entry; entry = entry->next)
 391                 segment_list_print_entry(seg->list_pb, seg->list_type, entry, s);
 392             if (seg->list_type == LIST_TYPE_M3U8 && is_last)
 393                 avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
 394             ff_format_io_close(s, &seg->list_pb);
 395             if (seg->use_rename)
 396                 ff_rename(seg->temp_list_filename, seg->list, s);
 397         } else {
 398             segment_list_print_entry(seg->list_pb, seg->list_type, &seg->cur_entry, s);
 399             avio_flush(seg->list_pb);
 400         }
 401     }
 402
 403     av_log(s, AV_LOG_VERBOSE, "segment:'%s' count:%d ended\n",
 404            seg->avf->filename, seg->segment_count);
 405     seg->segment_count++;
 406
 407     if (seg->increment_tc) {
 408         tcr = av_dict_get(s->metadata, "timecode", NULL, 0);
 409         if (tcr) {
 410             /* search the first video stream */
 411             for (i = 0; i < s->nb_streams; i++) {
 412                 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
 413                     rate = s->streams[i]->avg_frame_rate;/* Get fps from the video stream */
 414                     err = av_timecode_init_from_string(&tc, rate, tcr->value, s);
 415                     if (err < 0) {
 416                         av_log(s, AV_LOG_WARNING, "Could not increment timecode, error occurred during timecode creation.");
 417                         break;
 418                     }
 419                     tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(rate));/* increment timecode */
 420                     av_dict_set(&s->metadata, "timecode",
 421                                 av_timecode_make_string(&tc, buf, 0), 0);
 422                     break;
 423                 }
 424             }
 425         } else {
 426             av_log(s, AV_LOG_WARNING, "Could not increment timecode, no timecode metadata found");
 427         }
 428     }
 429
 430 end:
 431     ff_format_io_close(oc, &oc->pb);
 432
 433     return ret;
 434 }
 435
 436 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
 437                        const char *times_str)
 438 {
 439     char *p;
 440     int i, ret = 0;
 441     char *times_str1 = av_strdup(times_str);
 442     char *saveptr = NULL;
 443
 444     if (!times_str1)
 445         return AVERROR(ENOMEM);
 446
 447 #define FAIL(err) ret = err; goto end
 448
 449     *nb_times = 1;
 450     for (p = times_str1; *p; p++)
 451         if (*p == ',')
 452             (*nb_times)++;
 453
 454     *times = av_malloc_array(*nb_times, sizeof(**times));
 455     if (!*times) {
 456         av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
 457         FAIL(AVERROR(ENOMEM));
 458     }
 459
 460     p = times_str1;
 461     for (i = 0; i < *nb_times; i++) {
 462         int64_t t;
 463         char *tstr = av_strtok(p, ",", &saveptr);
 464         p = NULL;
 465
 466         if (!tstr || !tstr[0]) {
 467             av_log(log_ctx, AV_LOG_ERROR, "Empty time specification in times list %s\n",
 468                    times_str);
 469             FAIL(AVERROR(EINVAL));
 470         }
 471
 472         ret = av_parse_time(&t, tstr, 1);
 473         if (ret < 0) {
 474             av_log(log_ctx, AV_LOG_ERROR,
 475                    "Invalid time duration specification '%s' in times list %s\n", tstr, times_str);
 476             FAIL(AVERROR(EINVAL));
 477         }
 478         (*times)[i] = t;
 479
 480         /* check on monotonicity */
 481         if (i && (*times)[i-1] > (*times)[i]) {
 482             av_log(log_ctx, AV_LOG_ERROR,
 483                    "Specified time %f is greater than the following time %f\n",
 484                    (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
 485             FAIL(AVERROR(EINVAL));
 486         }
 487     }
 488
 489 end:
 490     av_free(times_str1);
 491     return ret;
 492 }
 493
 494 static int parse_frames(void *log_ctx, int **frames, int *nb_frames,
 495                         const char *frames_str)
 496 {
 497     char *p;
 498     int i, ret = 0;
 499     char *frames_str1 = av_strdup(frames_str);
 500     char *saveptr = NULL;
 501
 502     if (!frames_str1)
 503         return AVERROR(ENOMEM);
 504
 505 #define FAIL(err) ret = err; goto end
 506
 507     *nb_frames = 1;
 508     for (p = frames_str1; *p; p++)
 509         if (*p == ',')
 510             (*nb_frames)++;
 511
 512     *frames = av_malloc_array(*nb_frames, sizeof(**frames));
 513     if (!*frames) {
 514         av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced frames array\n");
 515         FAIL(AVERROR(ENOMEM));
 516     }
 517
 518     p = frames_str1;
 519     for (i = 0; i < *nb_frames; i++) {
 520         long int f;
 521         char *tailptr;
 522         char *fstr = av_strtok(p, ",", &saveptr);
 523
 524         p = NULL;
 525         if (!fstr) {
 526             av_log(log_ctx, AV_LOG_ERROR, "Empty frame specification in frame list %s\n",
 527                    frames_str);
 528             FAIL(AVERROR(EINVAL));
 529         }
 530         f = strtol(fstr, &tailptr, 10);
 531         if (*tailptr || f <= 0 || f >= INT_MAX) {
 532             av_log(log_ctx, AV_LOG_ERROR,
 533                    "Invalid argument '%s', must be a positive integer <= INT64_MAX\n",
 534                    fstr);
 535             FAIL(AVERROR(EINVAL));
 536         }
 537         (*frames)[i] = f;
 538
 539         /* check on monotonicity */
 540         if (i && (*frames)[i-1] > (*frames)[i]) {
 541             av_log(log_ctx, AV_LOG_ERROR,
 542                    "Specified frame %d is greater than the following frame %d\n",
 543                    (*frames)[i], (*frames)[i-1]);
 544             FAIL(AVERROR(EINVAL));
 545         }
 546     }
 547
 548 end:
 549     av_free(frames_str1);
 550     return ret;
 551 }
 552
 553 static int open_null_ctx(AVIOContext **ctx)
 554 {
 555     int buf_size = 32768;
 556     uint8_t *buf = av_malloc(buf_size);
 557     if (!buf)
 558         return AVERROR(ENOMEM);
 559     *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
 560     if (!*ctx) {
 561         av_free(buf);
 562         return AVERROR(ENOMEM);
 563     }
 564     return 0;
 565 }
 566
 567 static void close_null_ctxp(AVIOContext **pb)
 568 {
 569     av_freep(&(*pb)->buffer);
 570     av_freep(pb);
 571 }
 572
 573 static int select_reference_stream(AVFormatContext *s)
 574 {
 575     SegmentContext *seg = s->priv_data;
 576     int ret, i;
 577
 578     seg->reference_stream_index = -1;
 579     if (!strcmp(seg->reference_stream_specifier, "auto")) {
 580         /* select first index of type with highest priority */
 581         int type_index_map[AVMEDIA_TYPE_NB];
 582         static const enum AVMediaType type_priority_list[] = {
 583             AVMEDIA_TYPE_VIDEO,
 584             AVMEDIA_TYPE_AUDIO,
 585             AVMEDIA_TYPE_SUBTITLE,
 586             AVMEDIA_TYPE_DATA,
 587             AVMEDIA_TYPE_ATTACHMENT
 588         };
 589         enum AVMediaType type;
 590
 591         for (i = 0; i < AVMEDIA_TYPE_NB; i++)
 592             type_index_map[i] = -1;
 593
 594         /* select first index for each type */
 595         for (i = 0; i < s->nb_streams; i++) {
 596             type = s->streams[i]->codecpar->codec_type;
 597             if ((unsigned)type < AVMEDIA_TYPE_NB && type_index_map[type] == -1
 598                 /* ignore attached pictures/cover art streams */
 599                 && !(s->streams[i]->disposition & AV_DISPOSITION_ATTACHED_PIC))
 600                 type_index_map[type] = i;
 601         }
 602
 603         for (i = 0; i < FF_ARRAY_ELEMS(type_priority_list); i++) {
 604             type = type_priority_list[i];
 605             if ((seg->reference_stream_index = type_index_map[type]) >= 0)
 606                 break;
 607         }
 608     } else {
 609         for (i = 0; i < s->nb_streams; i++) {
 610             ret = avformat_match_stream_specifier(s, s->streams[i],
 611                                                   seg->reference_stream_specifier);
 612             if (ret < 0)
 613                 return ret;
 614             if (ret > 0) {
 615                 seg->reference_stream_index = i;
 616                 break;
 617             }
 618         }
 619     }
 620
 621     if (seg->reference_stream_index < 0) {
 622         av_log(s, AV_LOG_ERROR, "Could not select stream matching identifier '%s'\n",
 623                seg->reference_stream_specifier);
 624         return AVERROR(EINVAL);
 625     }
 626
 627     return 0;
 628 }
 629
 630 static void seg_free_context(SegmentContext *seg)
 631 {
 632     ff_format_io_close(seg->avf, &seg->list_pb);
 633     avformat_free_context(seg->avf);
 634     seg->avf = NULL;
 635 }
 636
 637 static int seg_init(AVFormatContext *s)
 638 {
 639     SegmentContext *seg = s->priv_data;
 640     AVFormatContext *oc = seg->avf;
 641     AVDictionary *options = NULL;
 642     int ret;
 643     int i;
 644
 645     seg->segment_count = 0;
 646     if (!seg->write_header_trailer)
 647         seg->individual_header_trailer = 0;
 648
 649     if (seg->header_filename) {
 650         seg->write_header_trailer = 1;
 651         seg->individual_header_trailer = 0;
 652     }
 653
 654     if (seg->initial_offset > 0) {
 655         av_log(s, AV_LOG_WARNING, "NOTE: the option initial_offset is deprecated,"
 656                "you can use output_ts_offset instead of it\n");
 657     }
 658
 659     if (!!seg->time_str + !!seg->times_str + !!seg->frames_str > 1) {
 660         av_log(s, AV_LOG_ERROR,
 661                "segment_time, segment_times, and segment_frames options "
 662                "are mutually exclusive, select just one of them\n");
 663         return AVERROR(EINVAL);
 664     }
 665
 666     if (seg->times_str) {
 667         if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
 668             return ret;
 669     } else if (seg->frames_str) {
 670         if ((ret = parse_frames(s, &seg->frames, &seg->nb_frames, seg->frames_str)) < 0)
 671             return ret;
 672     } else {
 673         /* set default value if not specified */
 674         if (!seg->time_str)
 675             seg->time_str = av_strdup("2");
 676         if ((ret = av_parse_time(&seg->time, seg->time_str, 1)) < 0) {
 677             av_log(s, AV_LOG_ERROR,
 678                    "Invalid time duration specification '%s' for segment_time option\n",
 679                    seg->time_str);
 680             return ret;
 681         }
 682         if (seg->use_clocktime) {
 683             if (seg->time <= 0) {
 684                 av_log(s, AV_LOG_ERROR, "Invalid negative segment_time with segment_atclocktime option set\n");
 685                 return AVERROR(EINVAL);
 686             }
 687             seg->clocktime_offset = seg->time - (seg->clocktime_offset % seg->time);
 688         }
 689     }
 690
 691     if (seg->format_options_str) {
 692         ret = av_dict_parse_string(&seg->format_options, seg->format_options_str, "=", ":", 0);
 693         if (ret < 0) {
 694             av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n",
 695                    seg->format_options_str);
 696             goto fail;
 697         }
 698     }
 699
 700     if (seg->list) {
 701         if (seg->list_type == LIST_TYPE_UNDEFINED) {
 702             if      (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
 703             else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
 704             else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
 705             else if (av_match_ext(seg->list, "ffcat,ffconcat")) seg->list_type = LIST_TYPE_FFCONCAT;
 706             else                                      seg->list_type = LIST_TYPE_FLAT;
 707         }
 708         if (!seg->list_size && seg->list_type != LIST_TYPE_M3U8) {
 709             if ((ret = segment_list_open(s)) < 0)
 710                 goto fail;
 711         } else {
 712             const char *proto = avio_find_protocol_name(s->filename);
 713             seg->use_rename = proto && !strcmp(proto, "file");
 714         }
 715     }
 716
 717     if (seg->list_type == LIST_TYPE_EXT)
 718         av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
 719
 720     if ((ret = select_reference_stream(s)) < 0)
 721         goto fail;
 722     av_log(s, AV_LOG_VERBOSE, "Selected stream id:%d type:%s\n",
 723            seg->reference_stream_index,
 724            av_get_media_type_string(s->streams[seg->reference_stream_index]->codecpar->codec_type));
 725
 726     seg->oformat = av_guess_format(seg->format, s->filename, NULL);
 727
 728     if (!seg->oformat) {
 729         ret = AVERROR_MUXER_NOT_FOUND;
 730         goto fail;
 731     }
 732     if (seg->oformat->flags & AVFMT_NOFILE) {
 733         av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
 734                seg->oformat->name);
 735         ret = AVERROR(EINVAL);
 736         goto fail;
 737     }
 738
 739     if ((ret = segment_mux_init(s)) < 0)
 740         goto fail;
 741
 742     if ((ret = set_segment_filename(s)) < 0)
 743         goto fail;
 744     oc = seg->avf;
 745
 746     if (seg->write_header_trailer) {
 747         if ((ret = s->io_open(s, &oc->pb,
 748                               seg->header_filename ? seg->header_filename : oc->filename,
 749                               AVIO_FLAG_WRITE, NULL)) < 0) {
 750             av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->filename);
 751             goto fail;
 752         }
 753         if (!seg->individual_header_trailer)
 754             oc->pb->seekable = 0;
 755     } else {
 756         if ((ret = open_null_ctx(&oc->pb)) < 0)
 757             goto fail;
 758     }
 759
 760     av_dict_copy(&options, seg->format_options, 0);
 761     ret = avformat_write_header(oc, &options);
 762     if (av_dict_count(options)) {
 763         av_log(s, AV_LOG_ERROR,
 764                "Some of the provided format options in '%s' are not recognized\n", seg->format_options_str);
 765         ret = AVERROR(EINVAL);
 766         goto fail;
 767     }
 768
 769     if (ret < 0) {
 770         ff_format_io_close(oc, &oc->pb);
 771         goto fail;
 772     }
 773     seg->segment_frame_count = 0;
 774
 775     av_assert0(s->nb_streams == oc->nb_streams);
 776     for (i = 0; i < s->nb_streams; i++) {
 777         AVStream *inner_st  = oc->streams[i];
 778         AVStream *outer_st = s->streams[i];
 779         avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
 780     }
 781
 782     if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
 783         s->avoid_negative_ts = 1;
 784
 785     if (!seg->write_header_trailer || seg->header_filename) {
 786         if (seg->header_filename) {
 787             av_write_frame(oc, NULL);
 788             ff_format_io_close(oc, &oc->pb);
 789         } else {
 790             close_null_ctxp(&oc->pb);
 791         }
 792         if ((ret = oc->io_open(oc, &oc->pb, oc->filename, AVIO_FLAG_WRITE, NULL)) < 0)
 793             goto fail;
 794         if (!seg->individual_header_trailer)
 795             oc->pb->seekable = 0;
 796     }
 797
 798 fail:
 799     av_dict_free(&options);
 800     if (ret < 0)
 801         seg_free_context(seg);
 802
 803     return ret;
 804 }
 805
 806 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
 807 {
 808     SegmentContext *seg = s->priv_data;
 809     AVStream *st = s->streams[pkt->stream_index];
 810     int64_t end_pts = INT64_MAX, offset;
 811     int start_frame = INT_MAX;
 812     int ret;
 813     struct tm ti;
 814     int64_t usecs;
 815     int64_t wrapped_val;
 816
 817     if (!seg->avf)
 818         return AVERROR(EINVAL);
 819
 820 calc_times:
 821     if (seg->times) {
 822         end_pts = seg->segment_count < seg->nb_times ?
 823             seg->times[seg->segment_count] : INT64_MAX;
 824     } else if (seg->frames) {
 825         start_frame = seg->segment_count < seg->nb_frames ?
 826             seg->frames[seg->segment_count] : INT_MAX;
 827     } else {
 828         if (seg->use_clocktime) {
 829             int64_t avgt = av_gettime();
 830             time_t sec = avgt / 1000000;
 831             localtime_r(&sec, &ti);
 832             usecs = (int64_t)(ti.tm_hour * 3600 + ti.tm_min * 60 + ti.tm_sec) * 1000000 + (avgt % 1000000);
 833             wrapped_val = (usecs + seg->clocktime_offset) % seg->time;
 834             if (seg->last_cut != usecs && wrapped_val < seg->last_val && wrapped_val < seg->clocktime_wrap_duration) {
 835                 seg->cut_pending = 1;
 836                 seg->last_cut = usecs;
 837             }
 838             seg->last_val = wrapped_val;
 839         } else {
 840             end_pts = seg->time * (seg->segment_count + 1);
 841         }
 842     }
 843
 844     ff_dlog(s, "packet stream:%d pts:%s pts_time:%s duration_time:%s is_key:%d frame:%d\n",
 845             pkt->stream_index, av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
 846             av_ts2timestr(pkt->duration, &st->time_base),
 847             pkt->flags & AV_PKT_FLAG_KEY,
 848             pkt->stream_index == seg->reference_stream_index ? seg->frame_count : -1);
 849
 850     if (pkt->stream_index == seg->reference_stream_index &&
 851         (pkt->flags & AV_PKT_FLAG_KEY || seg->break_non_keyframes) &&
 852         (seg->segment_frame_count > 0 || seg->write_empty) &&
 853         (seg->cut_pending || seg->frame_count >= start_frame ||
 854          (pkt->pts != AV_NOPTS_VALUE &&
 855           av_compare_ts(pkt->pts, st->time_base,
 856                         end_pts - seg->time_delta, AV_TIME_BASE_Q) >= 0))) {
 857         /* sanitize end time in case last packet didn't have a defined duration */
 858         if (seg->cur_entry.last_duration == 0)
 859             seg->cur_entry.end_time = (double)pkt->pts * av_q2d(st->time_base);
 860
 861         if ((ret = segment_end(s, seg->individual_header_trailer, 0)) < 0)
 862             goto fail;
 863
 864         if ((ret = segment_start(s, seg->individual_header_trailer)) < 0)
 865             goto fail;
 866
 867         seg->cut_pending = 0;
 868         seg->cur_entry.index = seg->segment_idx + seg->segment_idx_wrap * seg->segment_idx_wrap_nb;
 869         seg->cur_entry.start_time = (double)pkt->pts * av_q2d(st->time_base);
 870         seg->cur_entry.start_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
 871         seg->cur_entry.end_time = seg->cur_entry.start_time;
 872
 873         if (seg->times || (!seg->frames && !seg->use_clocktime) && seg->write_empty)
 874             goto calc_times;
 875     }
 876
 877     if (pkt->stream_index == seg->reference_stream_index) {
 878         if (pkt->pts != AV_NOPTS_VALUE)
 879             seg->cur_entry.end_time =
 880                 FFMAX(seg->cur_entry.end_time, (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
 881         seg->cur_entry.last_duration = pkt->duration;
 882     }
 883
 884     if (seg->segment_frame_count == 0) {
 885         av_log(s, AV_LOG_VERBOSE, "segment:'%s' starts with packet stream:%d pts:%s pts_time:%s frame:%d\n",
 886                seg->avf->filename, pkt->stream_index,
 887                av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base), seg->frame_count);
 888     }
 889
 890     av_log(s, AV_LOG_DEBUG, "stream:%d start_pts_time:%s pts:%s pts_time:%s dts:%s dts_time:%s",
 891            pkt->stream_index,
 892            av_ts2timestr(seg->cur_entry.start_pts, &AV_TIME_BASE_Q),
 893            av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
 894            av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
 895
 896     /* compute new timestamps */
 897     offset = av_rescale_q(seg->initial_offset - (seg->reset_timestamps ? seg->cur_entry.start_pts : 0),
 898                           AV_TIME_BASE_Q, st->time_base);
 899     if (pkt->pts != AV_NOPTS_VALUE)
 900         pkt->pts += offset;
 901     if (pkt->dts != AV_NOPTS_VALUE)
 902         pkt->dts += offset;
 903
 904     av_log(s, AV_LOG_DEBUG, " -> pts:%s pts_time:%s dts:%s dts_time:%s\n",
 905            av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
 906            av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
 907
 908     ret = ff_write_chained(seg->avf, pkt->stream_index, pkt, s, seg->initial_offset || seg->reset_timestamps);
 909
 910 fail:
 911     if (pkt->stream_index == seg->reference_stream_index) {
 912         seg->frame_count++;
 913         seg->segment_frame_count++;
 914     }
 915
 916     if (ret < 0)
 917         seg_free_context(seg);
 918
 919     return ret;
 920 }
 921
 922 static int seg_write_trailer(struct AVFormatContext *s)
 923 {
 924     SegmentContext *seg = s->priv_data;
 925     AVFormatContext *oc = seg->avf;
 926     SegmentListEntry *cur, *next;
 927     int ret = 0;
 928
 929     if (!oc)
 930         goto fail;
 931
 932     if (!seg->write_header_trailer) {
 933         if ((ret = segment_end(s, 0, 1)) < 0)
 934             goto fail;
 935         if ((ret = open_null_ctx(&oc->pb)) < 0)
 936             goto fail;
 937         ret = av_write_trailer(oc);
 938         close_null_ctxp(&oc->pb);
 939     } else {
 940         ret = segment_end(s, 1, 1);
 941     }
 942 fail:
 943     if (seg->list)
 944         ff_format_io_close(s, &seg->list_pb);
 945
 946     av_dict_free(&seg->format_options);
 947     av_opt_free(seg);
 948     av_freep(&seg->times);
 949     av_freep(&seg->frames);
 950     av_freep(&seg->cur_entry.filename);
 951
 952     cur = seg->segment_list_entries;
 953     while (cur) {
 954         next = cur->next;
 955         av_freep(&cur->filename);
 956         av_free(cur);
 957         cur = next;
 958     }
 959
 960     avformat_free_context(oc);
 961     seg->avf = NULL;
 962     return ret;
 963 }
 964
 965 #define OFFSET(x) offsetof(SegmentContext, x)
 966 #define E AV_OPT_FLAG_ENCODING_PARAM
 967 static const AVOption options[] = {
 968     { "reference_stream",  "set reference stream", OFFSET(reference_stream_specifier), AV_OPT_TYPE_STRING, {.str = "auto"}, CHAR_MIN, CHAR_MAX, E },
 969     { "segment_format",    "set container format used for the segments", OFFSET(format),  AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
 970     { "segment_format_options", "set list of options for the container format used for the segments", OFFSET(format_options_str), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
 971     { "segment_list",      "set the segment list filename",              OFFSET(list),    AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
 972     { "segment_header_filename", "write a single file containing the header", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
 973
 974     { "segment_list_flags","set flags affecting segment list generation", OFFSET(list_flags), AV_OPT_TYPE_FLAGS, {.i64 = SEGMENT_LIST_FLAG_CACHE }, 0, UINT_MAX, E, "list_flags"},
 975     { "cache",             "allow list caching",                                    0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX,   E, "list_flags"},
 976     { "live",              "enable live-friendly list generation (useful for HLS)", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_LIVE }, INT_MIN, INT_MAX,    E, "list_flags"},
 977
 978     { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT,  {.i64 = 0},     0, INT_MAX, E },
 979
 980     { "segment_list_type", "set the segment list type",                  OFFSET(list_type), AV_OPT_TYPE_INT,  {.i64 = LIST_TYPE_UNDEFINED}, -1, LIST_TYPE_NB-1, E, "list_type" },
 981     { "flat", "flat format",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, E, "list_type" },
 982     { "csv",  "csv format",      0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV  }, INT_MIN, INT_MAX, E, "list_type" },
 983     { "ext",  "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT  }, INT_MIN, INT_MAX, E, "list_type" },
 984     { "ffconcat", "ffconcat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FFCONCAT }, INT_MIN, INT_MAX, E, "list_type" },
 985     { "m3u8", "M3U8 format",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
 986     { "hls", "Apple HTTP Live Streaming compatible", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
 987
 988     { "segment_atclocktime",      "set segment to be cut at clocktime",  OFFSET(use_clocktime), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
 989     { "segment_clocktime_offset", "set segment clocktime offset",        OFFSET(clocktime_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 86400000000LL, E},
 990     { "segment_clocktime_wrap_duration", "set segment clocktime wrapping duration", OFFSET(clocktime_wrap_duration), AV_OPT_TYPE_DURATION, {.i64 = INT64_MAX}, 0, INT64_MAX, E},
 991     { "segment_time",      "set segment duration",                       OFFSET(time_str),AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
 992     { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 0, E },
 993     { "segment_times",     "set segment split time points",              OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL},  0, 0,       E },
 994     { "segment_frames",    "set segment split frame numbers",            OFFSET(frames_str),AV_OPT_TYPE_STRING,{.str = NULL},  0, 0,       E },
 995     { "segment_wrap",      "set number after which the index wraps",     OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
 996     { "segment_list_entry_prefix", "set base url prefix for segments", OFFSET(entry_prefix), AV_OPT_TYPE_STRING,  {.str = NULL}, 0, 0, E },
 997     { "segment_start_number", "set the sequence number of the first segment", OFFSET(segment_idx), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
 998     { "segment_wrap_number", "set the number of wrap before the first segment", OFFSET(segment_idx_wrap_nb), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
 999     { "strftime",          "set filename expansion with strftime at segment creation", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1000     { "increment_tc", "increment timecode between each segment", OFFSET(increment_tc), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1001     { "break_non_keyframes", "allow breaking segments on non-keyframes", OFFSET(break_non_keyframes), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1002
1003     { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1004     { "write_header_trailer", "write a header to the first segment and a trailer to the last one", OFFSET(write_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1005     { "reset_timestamps", "reset timestamps at the begin of each segment", OFFSET(reset_timestamps), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1006     { "initial_offset", "set initial timestamp offset", OFFSET(initial_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, -INT64_MAX, INT64_MAX, E },
1007     { "write_empty_segments", "allow writing empty 'filler' segments", OFFSET(write_empty), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1008     { NULL },
1009 };
1010
1011 static const AVClass seg_class = {
1012     .class_name = "segment muxer",
1013     .item_name  = av_default_item_name,
1014     .option     = options,
1015     .version    = LIBAVUTIL_VERSION_INT,
1016 };
1017
1018 AVOutputFormat ff_segment_muxer = {
1019     .name           = "segment",
1020     .long_name      = NULL_IF_CONFIG_SMALL("segment"),
1021     .priv_data_size = sizeof(SegmentContext),
1022     .flags          = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
1023     .init           = seg_init,
1024     .write_packet   = seg_write_packet,
1025     .write_trailer  = seg_write_trailer,
1026     .priv_class     = &seg_class,
1027 };
1028
1029 static const AVClass sseg_class = {
1030     .class_name = "stream_segment muxer",
1031     .item_name  = av_default_item_name,
1032     .option     = options,
1033     .version    = LIBAVUTIL_VERSION_INT,
1034 };
1035
1036 AVOutputFormat ff_stream_segment_muxer = {
1037     .name           = "stream_segment,ssegment",
1038     .long_name      = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
1039     .priv_data_size = sizeof(SegmentContext),
1040     .flags          = AVFMT_NOFILE,
1041     .init           = seg_init,
1042     .write_packet   = seg_write_packet,
1043     .write_trailer  = seg_write_trailer,
1044     .priv_class     = &sseg_class,
1045 };