3 * Copyright (c) 2012 Nicolas George
5 * This file is part of FFmpeg.
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.
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.
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
23 #include "libavutil/avutil.h"
24 #include "libavutil/avstring.h"
25 #include "libavutil/opt.h"
28 #include "avio_internal.h"
29 #include "tee_common.h"
32 ON_SLAVE_FAILURE_ABORT = 1,
33 ON_SLAVE_FAILURE_IGNORE = 2
36 #define DEFAULT_SLAVE_FAILURE_POLICY ON_SLAVE_FAILURE_ABORT
40 AVBSFContext **bsfs; ///< bitstream filters per stream
42 SlaveFailurePolicy on_fail;
44 /** map from input to output streams indexes,
45 * disabled output streams are set to -1 */
50 typedef struct TeeContext {
57 static const char *const slave_delim = "|";
58 static const char *const slave_bsfs_spec_sep = "/";
59 static const char *const slave_select_sep = ",";
61 static const AVClass tee_muxer_class = {
62 .class_name = "Tee muxer",
63 .item_name = av_default_item_name,
64 .version = LIBAVUTIL_VERSION_INT,
67 static inline int parse_slave_failure_policy_option(const char *opt, TeeSlave *tee_slave)
70 tee_slave->on_fail = DEFAULT_SLAVE_FAILURE_POLICY;
72 } else if (!av_strcasecmp("abort", opt)) {
73 tee_slave->on_fail = ON_SLAVE_FAILURE_ABORT;
75 } else if (!av_strcasecmp("ignore", opt)) {
76 tee_slave->on_fail = ON_SLAVE_FAILURE_IGNORE;
79 /* Set failure behaviour to abort, so invalid option error will not be ignored */
80 tee_slave->on_fail = ON_SLAVE_FAILURE_ABORT;
81 return AVERROR(EINVAL);
84 static int close_slave(TeeSlave *tee_slave)
94 if (tee_slave->header_written)
95 ret = av_write_trailer(avf);
97 if (tee_slave->bsfs) {
98 for (i = 0; i < avf->nb_streams; ++i)
99 av_bsf_free(&tee_slave->bsfs[i]);
101 av_freep(&tee_slave->stream_map);
102 av_freep(&tee_slave->bsfs);
104 ff_format_io_close(avf, &avf->pb);
105 avformat_free_context(avf);
106 tee_slave->avf = NULL;
110 static void close_slaves(AVFormatContext *avf)
112 TeeContext *tee = avf->priv_data;
115 for (i = 0; i < tee->nb_slaves; i++) {
116 close_slave(&tee->slaves[i]);
118 av_freep(&tee->slaves);
121 static int open_slave(AVFormatContext *avf, char *slave, TeeSlave *tee_slave)
124 AVDictionary *options = NULL;
125 AVDictionaryEntry *entry;
127 char *format = NULL, *select = NULL, *on_fail = NULL;
128 AVFormatContext *avf2 = NULL;
132 char *subselect = NULL, *next_subselect = NULL, *first_subselect = NULL, *tmp_select = NULL;
134 if ((ret = ff_tee_parse_slave_options(avf, slave, &options, &filename)) < 0)
137 #define STEAL_OPTION(option, field) do { \
138 if ((entry = av_dict_get(options, option, NULL, 0))) { \
139 field = entry->value; \
140 entry->value = NULL; /* prevent it from being freed */ \
141 av_dict_set(&options, option, NULL, 0); \
145 STEAL_OPTION("f", format);
146 STEAL_OPTION("select", select);
147 STEAL_OPTION("onfail", on_fail);
149 ret = parse_slave_failure_policy_option(on_fail, tee_slave);
151 av_log(avf, AV_LOG_ERROR,
152 "Invalid onfail option value, valid options are 'abort' and 'ignore'\n");
156 ret = avformat_alloc_output_context2(&avf2, NULL, format, filename);
159 tee_slave->avf = avf2;
160 av_dict_copy(&avf2->metadata, avf->metadata, 0);
161 avf2->opaque = avf->opaque;
162 avf2->io_open = avf->io_open;
163 avf2->io_close = avf->io_close;
164 avf2->interrupt_callback = avf->interrupt_callback;
165 avf2->flags = avf->flags;
167 tee_slave->stream_map = av_calloc(avf->nb_streams, sizeof(*tee_slave->stream_map));
168 if (!tee_slave->stream_map) {
169 ret = AVERROR(ENOMEM);
174 for (i = 0; i < avf->nb_streams; i++) {
175 st = avf->streams[i];
177 tmp_select = av_strdup(select); // av_strtok is destructive so we regenerate it in each loop
179 ret = AVERROR(ENOMEM);
183 first_subselect = tmp_select;
184 next_subselect = NULL;
185 while (subselect = av_strtok(first_subselect, slave_select_sep, &next_subselect)) {
186 first_subselect = NULL;
188 ret = avformat_match_stream_specifier(avf, avf->streams[i], subselect);
190 av_log(avf, AV_LOG_ERROR,
191 "Invalid stream specifier '%s' for output '%s'\n",
196 fullret = 1; // match
200 av_freep(&tmp_select);
202 if (fullret == 0) { /* no match */
203 tee_slave->stream_map[i] = -1;
207 tee_slave->stream_map[i] = stream_count++;
209 if (!(st2 = avformat_new_stream(avf2, NULL))) {
210 ret = AVERROR(ENOMEM);
214 ret = ff_stream_encode_params_copy(st2, st);
219 ret = ff_format_output_open(avf2, filename, NULL);
221 av_log(avf, AV_LOG_ERROR, "Slave '%s': error opening: %s\n", slave,
226 if ((ret = avformat_write_header(avf2, &options)) < 0) {
227 av_log(avf, AV_LOG_ERROR, "Slave '%s': error writing header: %s\n",
228 slave, av_err2str(ret));
231 tee_slave->header_written = 1;
233 tee_slave->bsfs = av_calloc(avf2->nb_streams, sizeof(*tee_slave->bsfs));
234 if (!tee_slave->bsfs) {
235 ret = AVERROR(ENOMEM);
240 while (entry = av_dict_get(options, "bsfs", NULL, AV_DICT_IGNORE_SUFFIX)) {
241 const char *spec = entry->key + strlen("bsfs");
243 if (strspn(spec, slave_bsfs_spec_sep) != 1) {
244 av_log(avf, AV_LOG_ERROR,
245 "Specifier separator in '%s' is '%c', but only characters '%s' "
246 "are allowed\n", entry->key, *spec, slave_bsfs_spec_sep);
247 ret = AVERROR(EINVAL);
250 spec++; /* consume separator */
253 for (i = 0; i < avf2->nb_streams; i++) {
254 ret = avformat_match_stream_specifier(avf2, avf2->streams[i], spec);
256 av_log(avf, AV_LOG_ERROR,
257 "Invalid stream specifier '%s' in bsfs option '%s' for slave "
258 "output '%s'\n", spec, entry->key, filename);
263 av_log(avf, AV_LOG_DEBUG, "spec:%s bsfs:%s matches stream %d of slave "
264 "output '%s'\n", spec, entry->value, i, filename);
265 if (tee_slave->bsfs[i]) {
266 av_log(avf, AV_LOG_WARNING,
267 "Duplicate bsfs specification associated to stream %d of slave "
268 "output '%s', filters will be ignored\n", i, filename);
271 ret = av_bsf_list_parse_str(entry->value, &tee_slave->bsfs[i]);
273 av_log(avf, AV_LOG_ERROR,
274 "Error parsing bitstream filter sequence '%s' associated to "
275 "stream %d of slave output '%s'\n", entry->value, i, filename);
281 av_dict_set(&options, entry->key, NULL, 0);
284 for (i = 0; i < avf->nb_streams; i++){
285 int target_stream = tee_slave->stream_map[i];
286 if (target_stream < 0)
289 if (!tee_slave->bsfs[target_stream]) {
290 /* Add pass-through bitstream filter */
291 ret = av_bsf_get_null_filter(&tee_slave->bsfs[target_stream]);
293 av_log(avf, AV_LOG_ERROR,
294 "Failed to create pass-through bitstream filter: %s\n",
300 tee_slave->bsfs[target_stream]->time_base_in = avf->streams[i]->time_base;
301 ret = avcodec_parameters_copy(tee_slave->bsfs[target_stream]->par_in,
302 avf->streams[i]->codecpar);
306 ret = av_bsf_init(tee_slave->bsfs[target_stream]);
308 av_log(avf, AV_LOG_ERROR,
309 "Failed to initialize bitstream filter(s): %s\n",
317 while ((entry = av_dict_get(options, "", entry, AV_DICT_IGNORE_SUFFIX)))
318 av_log(avf2, AV_LOG_ERROR, "Unknown option '%s'\n", entry->key);
319 ret = AVERROR_OPTION_NOT_FOUND;
327 av_dict_free(&options);
328 av_freep(&tmp_select);
332 static void log_slave(TeeSlave *slave, void *log_ctx, int log_level)
335 av_log(log_ctx, log_level, "filename:'%s' format:%s\n",
336 slave->avf->filename, slave->avf->oformat->name);
337 for (i = 0; i < slave->avf->nb_streams; i++) {
338 AVStream *st = slave->avf->streams[i];
339 AVBSFContext *bsf = slave->bsfs[i];
340 const char *bsf_name;
342 av_log(log_ctx, log_level, " stream:%d codec:%s type:%s",
343 i, avcodec_get_name(st->codecpar->codec_id),
344 av_get_media_type_string(st->codecpar->codec_type));
346 bsf_name = bsf->filter->priv_class ?
347 bsf->filter->priv_class->item_name(bsf) : bsf->filter->name;
348 av_log(log_ctx, log_level, " bsfs: %s\n", bsf_name);
352 static int tee_process_slave_failure(AVFormatContext *avf, unsigned slave_idx, int err_n)
354 TeeContext *tee = avf->priv_data;
355 TeeSlave *tee_slave = &tee->slaves[slave_idx];
359 close_slave(tee_slave);
361 if (!tee->nb_alive) {
362 av_log(avf, AV_LOG_ERROR, "All tee outputs failed.\n");
364 } else if (tee_slave->on_fail == ON_SLAVE_FAILURE_ABORT) {
365 av_log(avf, AV_LOG_ERROR, "Slave muxer #%u failed, aborting.\n", slave_idx);
368 av_log(avf, AV_LOG_ERROR, "Slave muxer #%u failed: %s, continuing with %u/%u slaves.\n",
369 slave_idx, av_err2str(err_n), tee->nb_alive, tee->nb_slaves);
374 static int tee_write_header(AVFormatContext *avf)
376 TeeContext *tee = avf->priv_data;
377 unsigned nb_slaves = 0, i;
378 const char *filename = avf->filename;
379 char **slaves = NULL;
383 char *slave = av_get_token(&filename, slave_delim);
385 ret = AVERROR(ENOMEM);
388 ret = av_dynarray_add_nofree(&slaves, &nb_slaves, slave);
393 if (strspn(filename, slave_delim))
397 if (!(tee->slaves = av_mallocz_array(nb_slaves, sizeof(*tee->slaves)))) {
398 ret = AVERROR(ENOMEM);
401 tee->nb_slaves = tee->nb_alive = nb_slaves;
403 for (i = 0; i < nb_slaves; i++) {
404 if ((ret = open_slave(avf, slaves[i], &tee->slaves[i])) < 0) {
405 ret = tee_process_slave_failure(avf, i, ret);
409 log_slave(&tee->slaves[i], avf, AV_LOG_VERBOSE);
411 av_freep(&slaves[i]);
414 for (i = 0; i < avf->nb_streams; i++) {
416 for (j = 0; j < tee->nb_slaves; j++)
417 if (tee->slaves[j].avf)
418 mapped += tee->slaves[j].stream_map[i] >= 0;
420 av_log(avf, AV_LOG_WARNING, "Input stream #%d is not mapped "
421 "to any slave.\n", i);
427 for (i = 0; i < nb_slaves; i++)
428 av_freep(&slaves[i]);
434 static int tee_write_trailer(AVFormatContext *avf)
436 TeeContext *tee = avf->priv_data;
437 int ret_all = 0, ret;
440 for (i = 0; i < tee->nb_slaves; i++) {
441 if ((ret = close_slave(&tee->slaves[i])) < 0) {
442 ret = tee_process_slave_failure(avf, i, ret);
443 if (!ret_all && ret < 0)
447 av_freep(&tee->slaves);
451 static int tee_write_packet(AVFormatContext *avf, AVPacket *pkt)
453 TeeContext *tee = avf->priv_data;
454 AVFormatContext *avf2;
457 int ret_all = 0, ret;
461 for (i = 0; i < tee->nb_slaves; i++) {
462 if (!(avf2 = tee->slaves[i].avf))
465 /* Flush slave if pkt is NULL*/
467 ret = av_interleaved_write_frame(avf2, NULL);
469 ret = tee_process_slave_failure(avf, i, ret);
470 if (!ret_all && ret < 0)
476 s = pkt->stream_index;
477 s2 = tee->slaves[i].stream_map[s];
481 memset(&pkt2, 0, sizeof(AVPacket));
482 if ((ret = av_packet_ref(&pkt2, pkt)) < 0)
487 bsfs = tee->slaves[i].bsfs[s2];
488 pkt2.stream_index = s2;
490 ret = av_bsf_send_packet(bsfs, &pkt2);
492 av_log(avf, AV_LOG_ERROR, "Error while sending packet to bitstream filter: %s\n",
494 ret = tee_process_slave_failure(avf, i, ret);
495 if (!ret_all && ret < 0)
500 ret = av_bsf_receive_packet(bsfs, &pkt2);
501 if (ret == AVERROR(EAGAIN)) {
504 } else if (ret < 0) {
508 av_packet_rescale_ts(&pkt2, bsfs->time_base_out,
509 avf2->streams[s2]->time_base);
510 ret = av_interleaved_write_frame(avf2, &pkt2);
516 ret = tee_process_slave_failure(avf, i, ret);
517 if (!ret_all && ret < 0)
524 AVOutputFormat ff_tee_muxer = {
526 .long_name = NULL_IF_CONFIG_SMALL("Multiple muxer tee"),
527 .priv_data_size = sizeof(TeeContext),
528 .write_header = tee_write_header,
529 .write_trailer = tee_write_trailer,
530 .write_packet = tee_write_packet,
531 .priv_class = &tee_muxer_class,
532 .flags = AVFMT_NOFILE | AVFMT_ALLOW_FLUSH,