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

   1 /*
   2  * Tee pseudo-muxer
   3  * Copyright (c) 2012 Nicolas George
   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 License
   9  * 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
  15  * GNU Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public License
  18  * along with FFmpeg; if not, write to the Free Software * Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22
  23 #include "libavutil/avutil.h"
  24 #include "libavutil/avstring.h"
  25 #include "libavutil/opt.h"
  26 #include "internal.h"
  27 #include "avformat.h"
  28 #include "avio_internal.h"
  29 #include "tee_common.h"
  30
  31 typedef enum {
  32     ON_SLAVE_FAILURE_ABORT  = 1,
  33     ON_SLAVE_FAILURE_IGNORE = 2
  34 } SlaveFailurePolicy;
  35
  36 #define DEFAULT_SLAVE_FAILURE_POLICY ON_SLAVE_FAILURE_ABORT
  37
  38 typedef struct {
  39     AVFormatContext *avf;
  40     AVBSFContext **bsfs; ///< bitstream filters per stream
  41
  42     SlaveFailurePolicy on_fail;
  43     int use_fifo;
  44     AVDictionary *fifo_options;
  45
  46     /** map from input to output streams indexes,
  47      * disabled output streams are set to -1 */
  48     int *stream_map;
  49     int header_written;
  50 } TeeSlave;
  51
  52 typedef struct TeeContext {
  53     const AVClass *class;
  54     unsigned nb_slaves;
  55     unsigned nb_alive;
  56     TeeSlave *slaves;
  57     int use_fifo;
  58     AVDictionary *fifo_options;
  59     char *fifo_options_str;
  60 } TeeContext;
  61
  62 static const char *const slave_delim     = "|";
  63 static const char *const slave_bsfs_spec_sep = "/";
  64 static const char *const slave_select_sep = ",";
  65
  66 #define OFFSET(x) offsetof(TeeContext, x)
  67 static const AVOption options[] = {
  68         {"use_fifo", "Use fifo pseudo-muxer to separate actual muxers from encoder",
  69          OFFSET(use_fifo), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
  70         {"fifo_options", "fifo pseudo-muxer options", OFFSET(fifo_options_str),
  71          AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, AV_OPT_FLAG_ENCODING_PARAM},
  72         {NULL}
  73 };
  74
  75 static const AVClass tee_muxer_class = {
  76     .class_name = "Tee muxer",
  77     .item_name  = av_default_item_name,
  78     .option = options,
  79     .version    = LIBAVUTIL_VERSION_INT,
  80 };
  81
  82 static inline int parse_slave_failure_policy_option(const char *opt, TeeSlave *tee_slave)
  83 {
  84     if (!opt) {
  85         tee_slave->on_fail = DEFAULT_SLAVE_FAILURE_POLICY;
  86         return 0;
  87     } else if (!av_strcasecmp("abort", opt)) {
  88         tee_slave->on_fail = ON_SLAVE_FAILURE_ABORT;
  89         return 0;
  90     } else if (!av_strcasecmp("ignore", opt)) {
  91         tee_slave->on_fail = ON_SLAVE_FAILURE_IGNORE;
  92         return 0;
  93     }
  94     /* Set failure behaviour to abort, so invalid option error will not be ignored */
  95     tee_slave->on_fail = ON_SLAVE_FAILURE_ABORT;
  96     return AVERROR(EINVAL);
  97 }
  98
  99 static int parse_slave_fifo_options(const char *use_fifo,
 100                                     const char *fifo_options, TeeSlave *tee_slave)
 101 {
 102     int ret = 0;
 103
 104     if (use_fifo) {
 105         /*TODO - change this to use proper function for parsing boolean
 106          *       options when there is one */
 107         if (av_match_name(use_fifo, "true,y,yes,enable,enabled,on,1")) {
 108             tee_slave->use_fifo = 1;
 109         } else if (av_match_name(use_fifo, "false,n,no,disable,disabled,off,0")) {
 110             tee_slave->use_fifo = 0;
 111         } else {
 112             return AVERROR(EINVAL);
 113         }
 114     }
 115
 116     if (fifo_options)
 117         ret = av_dict_parse_string(&tee_slave->fifo_options, fifo_options, "=", ":", 0);
 118
 119     return ret;
 120 }
 121
 122 static int close_slave(TeeSlave *tee_slave)
 123 {
 124     AVFormatContext *avf;
 125     unsigned i;
 126     int ret = 0;
 127
 128     avf = tee_slave->avf;
 129     if (!avf)
 130         return 0;
 131
 132     if (tee_slave->header_written)
 133         ret = av_write_trailer(avf);
 134
 135     if (tee_slave->bsfs) {
 136         for (i = 0; i < avf->nb_streams; ++i)
 137             av_bsf_free(&tee_slave->bsfs[i]);
 138     }
 139     av_freep(&tee_slave->stream_map);
 140     av_freep(&tee_slave->bsfs);
 141
 142     ff_format_io_close(avf, &avf->pb);
 143     avformat_free_context(avf);
 144     tee_slave->avf = NULL;
 145     return ret;
 146 }
 147
 148 static void close_slaves(AVFormatContext *avf)
 149 {
 150     TeeContext *tee = avf->priv_data;
 151     unsigned i;
 152
 153     for (i = 0; i < tee->nb_slaves; i++) {
 154         close_slave(&tee->slaves[i]);
 155     }
 156     av_freep(&tee->slaves);
 157 }
 158
 159 static int open_slave(AVFormatContext *avf, char *slave, TeeSlave *tee_slave)
 160 {
 161     int i, ret;
 162     AVDictionary *options = NULL;
 163     AVDictionaryEntry *entry;
 164     char *filename;
 165     char *format = NULL, *select = NULL, *on_fail = NULL;
 166     char *use_fifo = NULL, *fifo_options_str = NULL;
 167     AVFormatContext *avf2 = NULL;
 168     AVStream *st, *st2;
 169     int stream_count;
 170     int fullret;
 171     char *subselect = NULL, *next_subselect = NULL, *first_subselect = NULL, *tmp_select = NULL;
 172
 173     if ((ret = ff_tee_parse_slave_options(avf, slave, &options, &filename)) < 0)
 174         return ret;
 175
 176 #define STEAL_OPTION(option, field) do {                                \
 177         if ((entry = av_dict_get(options, option, NULL, 0))) {          \
 178             field = entry->value;                                       \
 179             entry->value = NULL; /* prevent it from being freed */      \
 180             av_dict_set(&options, option, NULL, 0);                     \
 181         }                                                               \
 182     } while (0)
 183
 184     STEAL_OPTION("f", format);
 185     STEAL_OPTION("select", select);
 186     STEAL_OPTION("onfail", on_fail);
 187     STEAL_OPTION("use_fifo", use_fifo);
 188     STEAL_OPTION("fifo_options", fifo_options_str);
 189
 190     ret = parse_slave_failure_policy_option(on_fail, tee_slave);
 191     if (ret < 0) {
 192         av_log(avf, AV_LOG_ERROR,
 193                "Invalid onfail option value, valid options are 'abort' and 'ignore'\n");
 194         goto end;
 195     }
 196
 197     ret = parse_slave_fifo_options(use_fifo, fifo_options_str, tee_slave);
 198     if (ret < 0) {
 199         av_log(avf, AV_LOG_ERROR, "Error parsing fifo options: %s\n", av_err2str(ret));
 200         goto end;
 201     }
 202
 203     if (tee_slave->use_fifo) {
 204
 205         if (options) {
 206             char *format_options_str = NULL;
 207             ret = av_dict_get_string(options, &format_options_str, '=', ':');
 208             if (ret < 0)
 209                 goto end;
 210
 211             ret = av_dict_set(&tee_slave->fifo_options, "format_opts", format_options_str,
 212                               AV_DICT_DONT_STRDUP_VAL);
 213             if (ret < 0)
 214                 goto end;
 215         }
 216
 217         if (format) {
 218             ret = av_dict_set(&tee_slave->fifo_options, "fifo_format", format,
 219                               AV_DICT_DONT_STRDUP_VAL);
 220             format = NULL;
 221             if (ret < 0)
 222                 goto end;
 223         }
 224
 225         av_dict_free(&options);
 226         options = tee_slave->fifo_options;
 227     }
 228     ret = avformat_alloc_output_context2(&avf2, NULL,
 229                                          tee_slave->use_fifo ? "fifo" :format, filename);
 230     if (ret < 0)
 231         goto end;
 232     tee_slave->avf = avf2;
 233     av_dict_copy(&avf2->metadata, avf->metadata, 0);
 234     avf2->opaque   = avf->opaque;
 235     avf2->io_open  = avf->io_open;
 236     avf2->io_close = avf->io_close;
 237     avf2->interrupt_callback = avf->interrupt_callback;
 238     avf2->flags = avf->flags;
 239     avf2->strict_std_compliance = avf->strict_std_compliance;
 240
 241     tee_slave->stream_map = av_calloc(avf->nb_streams, sizeof(*tee_slave->stream_map));
 242     if (!tee_slave->stream_map) {
 243         ret = AVERROR(ENOMEM);
 244         goto end;
 245     }
 246
 247     stream_count = 0;
 248     for (i = 0; i < avf->nb_streams; i++) {
 249         st = avf->streams[i];
 250         if (select) {
 251             tmp_select = av_strdup(select);  // av_strtok is destructive so we regenerate it in each loop
 252             if (!tmp_select) {
 253                 ret = AVERROR(ENOMEM);
 254                 goto end;
 255             }
 256             fullret = 0;
 257             first_subselect = tmp_select;
 258             next_subselect = NULL;
 259             while (subselect = av_strtok(first_subselect, slave_select_sep, &next_subselect)) {
 260                 first_subselect = NULL;
 261
 262                 ret = avformat_match_stream_specifier(avf, avf->streams[i], subselect);
 263                 if (ret < 0) {
 264                     av_log(avf, AV_LOG_ERROR,
 265                            "Invalid stream specifier '%s' for output '%s'\n",
 266                            subselect, slave);
 267                     goto end;
 268                 }
 269                 if (ret != 0) {
 270                     fullret = 1; // match
 271                     break;
 272                 }
 273             }
 274             av_freep(&tmp_select);
 275
 276             if (fullret == 0) { /* no match */
 277                 tee_slave->stream_map[i] = -1;
 278                 continue;
 279             }
 280         }
 281         tee_slave->stream_map[i] = stream_count++;
 282
 283         if (!(st2 = avformat_new_stream(avf2, NULL))) {
 284             ret = AVERROR(ENOMEM);
 285             goto end;
 286         }
 287
 288         ret = ff_stream_encode_params_copy(st2, st);
 289         if (ret < 0)
 290             goto end;
 291     }
 292
 293     ret = ff_format_output_open(avf2, filename, NULL);
 294     if (ret < 0) {
 295         av_log(avf, AV_LOG_ERROR, "Slave '%s': error opening: %s\n", slave,
 296                av_err2str(ret));
 297         goto end;
 298     }
 299
 300     if ((ret = avformat_write_header(avf2, &options)) < 0) {
 301         av_log(avf, AV_LOG_ERROR, "Slave '%s': error writing header: %s\n",
 302                slave, av_err2str(ret));
 303         goto end;
 304     }
 305     tee_slave->header_written = 1;
 306
 307     tee_slave->bsfs = av_calloc(avf2->nb_streams, sizeof(*tee_slave->bsfs));
 308     if (!tee_slave->bsfs) {
 309         ret = AVERROR(ENOMEM);
 310         goto end;
 311     }
 312
 313     entry = NULL;
 314     while (entry = av_dict_get(options, "bsfs", NULL, AV_DICT_IGNORE_SUFFIX)) {
 315         const char *spec = entry->key + strlen("bsfs");
 316         if (*spec) {
 317             if (strspn(spec, slave_bsfs_spec_sep) != 1) {
 318                 av_log(avf, AV_LOG_ERROR,
 319                        "Specifier separator in '%s' is '%c', but only characters '%s' "
 320                        "are allowed\n", entry->key, *spec, slave_bsfs_spec_sep);
 321                 ret = AVERROR(EINVAL);
 322                 goto end;
 323             }
 324             spec++; /* consume separator */
 325         }
 326
 327         for (i = 0; i < avf2->nb_streams; i++) {
 328             ret = avformat_match_stream_specifier(avf2, avf2->streams[i], spec);
 329             if (ret < 0) {
 330                 av_log(avf, AV_LOG_ERROR,
 331                        "Invalid stream specifier '%s' in bsfs option '%s' for slave "
 332                        "output '%s'\n", spec, entry->key, filename);
 333                 goto end;
 334             }
 335
 336             if (ret > 0) {
 337                 av_log(avf, AV_LOG_DEBUG, "spec:%s bsfs:%s matches stream %d of slave "
 338                        "output '%s'\n", spec, entry->value, i, filename);
 339                 if (tee_slave->bsfs[i]) {
 340                     av_log(avf, AV_LOG_WARNING,
 341                            "Duplicate bsfs specification associated to stream %d of slave "
 342                            "output '%s', filters will be ignored\n", i, filename);
 343                     continue;
 344                 }
 345                 ret = av_bsf_list_parse_str(entry->value, &tee_slave->bsfs[i]);
 346                 if (ret < 0) {
 347                     av_log(avf, AV_LOG_ERROR,
 348                            "Error parsing bitstream filter sequence '%s' associated to "
 349                            "stream %d of slave output '%s'\n", entry->value, i, filename);
 350                     goto end;
 351                 }
 352             }
 353         }
 354
 355         av_dict_set(&options, entry->key, NULL, 0);
 356     }
 357
 358     for (i = 0; i < avf->nb_streams; i++){
 359         int target_stream = tee_slave->stream_map[i];
 360         if (target_stream < 0)
 361             continue;
 362
 363         if (!tee_slave->bsfs[target_stream]) {
 364             /* Add pass-through bitstream filter */
 365             ret = av_bsf_get_null_filter(&tee_slave->bsfs[target_stream]);
 366             if (ret < 0) {
 367                 av_log(avf, AV_LOG_ERROR,
 368                        "Failed to create pass-through bitstream filter: %s\n",
 369                        av_err2str(ret));
 370                 goto end;
 371             }
 372         }
 373
 374         tee_slave->bsfs[target_stream]->time_base_in = avf->streams[i]->time_base;
 375         ret = avcodec_parameters_copy(tee_slave->bsfs[target_stream]->par_in,
 376                                       avf->streams[i]->codecpar);
 377         if (ret < 0)
 378             goto end;
 379
 380         ret = av_bsf_init(tee_slave->bsfs[target_stream]);
 381         if (ret < 0) {
 382             av_log(avf, AV_LOG_ERROR,
 383             "Failed to initialize bitstream filter(s): %s\n",
 384             av_err2str(ret));
 385             goto end;
 386         }
 387     }
 388
 389     if (options) {
 390         entry = NULL;
 391         while ((entry = av_dict_get(options, "", entry, AV_DICT_IGNORE_SUFFIX)))
 392             av_log(avf2, AV_LOG_ERROR, "Unknown option '%s'\n", entry->key);
 393         ret = AVERROR_OPTION_NOT_FOUND;
 394         goto end;
 395     }
 396
 397 end:
 398     av_free(format);
 399     av_free(select);
 400     av_free(on_fail);
 401     av_dict_free(&options);
 402     av_freep(&tmp_select);
 403     return ret;
 404 }
 405
 406 static void log_slave(TeeSlave *slave, void *log_ctx, int log_level)
 407 {
 408     int i;
 409     av_log(log_ctx, log_level, "filename:'%s' format:%s\n",
 410            slave->avf->url, slave->avf->oformat->name);
 411     for (i = 0; i < slave->avf->nb_streams; i++) {
 412         AVStream *st = slave->avf->streams[i];
 413         AVBSFContext *bsf = slave->bsfs[i];
 414         const char *bsf_name;
 415
 416         av_log(log_ctx, log_level, "    stream:%d codec:%s type:%s",
 417                i, avcodec_get_name(st->codecpar->codec_id),
 418                av_get_media_type_string(st->codecpar->codec_type));
 419
 420         bsf_name = bsf->filter->priv_class ?
 421                    bsf->filter->priv_class->item_name(bsf) : bsf->filter->name;
 422         av_log(log_ctx, log_level, " bsfs: %s\n", bsf_name);
 423     }
 424 }
 425
 426 static int tee_process_slave_failure(AVFormatContext *avf, unsigned slave_idx, int err_n)
 427 {
 428     TeeContext *tee = avf->priv_data;
 429     TeeSlave *tee_slave = &tee->slaves[slave_idx];
 430
 431     tee->nb_alive--;
 432
 433     close_slave(tee_slave);
 434
 435     if (!tee->nb_alive) {
 436         av_log(avf, AV_LOG_ERROR, "All tee outputs failed.\n");
 437         return err_n;
 438     } else if (tee_slave->on_fail == ON_SLAVE_FAILURE_ABORT) {
 439         av_log(avf, AV_LOG_ERROR, "Slave muxer #%u failed, aborting.\n", slave_idx);
 440         return err_n;
 441     } else {
 442         av_log(avf, AV_LOG_ERROR, "Slave muxer #%u failed: %s, continuing with %u/%u slaves.\n",
 443                slave_idx, av_err2str(err_n), tee->nb_alive, tee->nb_slaves);
 444         return 0;
 445     }
 446 }
 447
 448 static int tee_write_header(AVFormatContext *avf)
 449 {
 450     TeeContext *tee = avf->priv_data;
 451     unsigned nb_slaves = 0, i;
 452     const char *filename = avf->url;
 453     char **slaves = NULL;
 454     int ret;
 455
 456     while (*filename) {
 457         char *slave = av_get_token(&filename, slave_delim);
 458         if (!slave) {
 459             ret = AVERROR(ENOMEM);
 460             goto fail;
 461         }
 462         ret = av_dynarray_add_nofree(&slaves, &nb_slaves, slave);
 463         if (ret < 0) {
 464             av_free(slave);
 465             goto fail;
 466         }
 467         if (strspn(filename, slave_delim))
 468             filename++;
 469     }
 470
 471     if (tee->fifo_options_str) {
 472         ret = av_dict_parse_string(&tee->fifo_options, tee->fifo_options_str, "=", ":", 0);
 473         if (ret < 0)
 474             goto fail;
 475     }
 476
 477     if (!(tee->slaves = av_mallocz_array(nb_slaves, sizeof(*tee->slaves)))) {
 478         ret = AVERROR(ENOMEM);
 479         goto fail;
 480     }
 481     tee->nb_slaves = tee->nb_alive = nb_slaves;
 482
 483     for (i = 0; i < nb_slaves; i++) {
 484
 485         tee->slaves[i].use_fifo = tee->use_fifo;
 486         ret = av_dict_copy(&tee->slaves[i].fifo_options, tee->fifo_options, 0);
 487         if (ret < 0)
 488             goto fail;
 489
 490         if ((ret = open_slave(avf, slaves[i], &tee->slaves[i])) < 0) {
 491             ret = tee_process_slave_failure(avf, i, ret);
 492             if (ret < 0)
 493                 goto fail;
 494         } else {
 495             log_slave(&tee->slaves[i], avf, AV_LOG_VERBOSE);
 496         }
 497         av_freep(&slaves[i]);
 498     }
 499
 500     for (i = 0; i < avf->nb_streams; i++) {
 501         int j, mapped = 0;
 502         for (j = 0; j < tee->nb_slaves; j++)
 503             if (tee->slaves[j].avf)
 504                 mapped += tee->slaves[j].stream_map[i] >= 0;
 505         if (!mapped)
 506             av_log(avf, AV_LOG_WARNING, "Input stream #%d is not mapped "
 507                    "to any slave.\n", i);
 508     }
 509     av_free(slaves);
 510     return 0;
 511
 512 fail:
 513     for (i = 0; i < nb_slaves; i++)
 514         av_freep(&slaves[i]);
 515     close_slaves(avf);
 516     av_free(slaves);
 517     return ret;
 518 }
 519
 520 static int tee_write_trailer(AVFormatContext *avf)
 521 {
 522     TeeContext *tee = avf->priv_data;
 523     int ret_all = 0, ret;
 524     unsigned i;
 525
 526     for (i = 0; i < tee->nb_slaves; i++) {
 527         if ((ret = close_slave(&tee->slaves[i])) < 0) {
 528             ret = tee_process_slave_failure(avf, i, ret);
 529             if (!ret_all && ret < 0)
 530                 ret_all = ret;
 531         }
 532     }
 533     av_freep(&tee->slaves);
 534     return ret_all;
 535 }
 536
 537 static int tee_write_packet(AVFormatContext *avf, AVPacket *pkt)
 538 {
 539     TeeContext *tee = avf->priv_data;
 540     AVFormatContext *avf2;
 541     AVBSFContext *bsfs;
 542     AVPacket pkt2;
 543     int ret_all = 0, ret;
 544     unsigned i, s;
 545     int s2;
 546
 547     for (i = 0; i < tee->nb_slaves; i++) {
 548         if (!(avf2 = tee->slaves[i].avf))
 549             continue;
 550
 551         /* Flush slave if pkt is NULL*/
 552         if (!pkt) {
 553             ret = av_interleaved_write_frame(avf2, NULL);
 554             if (ret < 0) {
 555                 ret = tee_process_slave_failure(avf, i, ret);
 556                 if (!ret_all && ret < 0)
 557                     ret_all = ret;
 558             }
 559             continue;
 560         }
 561
 562         s = pkt->stream_index;
 563         s2 = tee->slaves[i].stream_map[s];
 564         if (s2 < 0)
 565             continue;
 566
 567         memset(&pkt2, 0, sizeof(AVPacket));
 568         if ((ret = av_packet_ref(&pkt2, pkt)) < 0)
 569             if (!ret_all) {
 570                 ret_all = ret;
 571                 continue;
 572             }
 573         bsfs = tee->slaves[i].bsfs[s2];
 574         pkt2.stream_index = s2;
 575
 576         ret = av_bsf_send_packet(bsfs, &pkt2);
 577         if (ret < 0) {
 578             av_log(avf, AV_LOG_ERROR, "Error while sending packet to bitstream filter: %s\n",
 579                    av_err2str(ret));
 580             ret = tee_process_slave_failure(avf, i, ret);
 581             if (!ret_all && ret < 0)
 582                 ret_all = ret;
 583         }
 584
 585         while(1) {
 586             ret = av_bsf_receive_packet(bsfs, &pkt2);
 587             if (ret == AVERROR(EAGAIN)) {
 588                 ret = 0;
 589                 break;
 590             } else if (ret < 0) {
 591                 break;
 592             }
 593
 594             av_packet_rescale_ts(&pkt2, bsfs->time_base_out,
 595                                  avf2->streams[s2]->time_base);
 596             ret = av_interleaved_write_frame(avf2, &pkt2);
 597             if (ret < 0)
 598                 break;
 599         };
 600
 601         if (ret < 0) {
 602             ret = tee_process_slave_failure(avf, i, ret);
 603             if (!ret_all && ret < 0)
 604                 ret_all = ret;
 605         }
 606     }
 607     return ret_all;
 608 }
 609
 610 AVOutputFormat ff_tee_muxer = {
 611     .name              = "tee",
 612     .long_name         = NULL_IF_CONFIG_SMALL("Multiple muxer tee"),
 613     .priv_data_size    = sizeof(TeeContext),
 614     .write_header      = tee_write_header,
 615     .write_trailer     = tee_write_trailer,
 616     .write_packet      = tee_write_packet,
 617     .priv_class        = &tee_muxer_class,
 618     .flags             = AVFMT_NOFILE | AVFMT_ALLOW_FLUSH,
 619 };