segment: Add an option for disabling writing of a header/trailer to each segment
[ffmpeg.git] / libavformat / segment.c
1 /*
2  * Generic segmenter
3  * Copyright (c) 2011, Luca Barbato
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include <float.h>
23
24 #include "avformat.h"
25 #include "internal.h"
26
27 #include "libavutil/log.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/avstring.h"
30 #include "libavutil/parseutils.h"
31 #include "libavutil/mathematics.h"
32
33 typedef struct {
34     const AVClass *class;  /**< Class for private options. */
35     int number;
36     AVOutputFormat *oformat;
37     AVFormatContext *avf;
38     char *format;          /**< Set by a private option. */
39     char *list;            /**< Set by a private option. */
40     float time;            /**< Set by a private option. */
41     int  size;             /**< Set by a private option. */
42     int  wrap;             /**< Set by a private option. */
43     int  individual_header_trailer; /**< Set by a private option. */
44     int64_t offset_time;
45     int64_t recording_time;
46     int has_video;
47     AVIOContext *pb;
48 } SegmentContext;
49
50 static int segment_mux_init(AVFormatContext *s)
51 {
52     SegmentContext *seg = s->priv_data;
53     AVFormatContext *oc;
54     int i;
55
56     seg->avf = oc = avformat_alloc_context();
57     if (!oc)
58         return AVERROR(ENOMEM);
59
60     oc->oformat            = seg->oformat;
61     oc->interrupt_callback = s->interrupt_callback;
62
63     for (i = 0; i < s->nb_streams; i++) {
64         AVStream *st;
65         if (!(st = avformat_new_stream(oc, NULL)))
66             return AVERROR(ENOMEM);
67         avcodec_copy_context(st->codec, s->streams[i]->codec);
68         st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
69     }
70
71     return 0;
72 }
73
74 static int segment_start(AVFormatContext *s, int write_header)
75 {
76     SegmentContext *c = s->priv_data;
77     AVFormatContext *oc = c->avf;
78     int err = 0;
79
80     if (write_header) {
81         avformat_free_context(oc);
82         c->avf = NULL;
83         if ((err = segment_mux_init(s)) < 0)
84             return err;
85         oc = c->avf;
86     }
87
88     if (c->wrap)
89         c->number %= c->wrap;
90
91     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
92                               s->filename, c->number++) < 0)
93         return AVERROR(EINVAL);
94
95     if ((err = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
96                           &s->interrupt_callback, NULL)) < 0)
97         return err;
98
99     if (write_header) {
100         if ((err = avformat_write_header(oc, NULL)) < 0)
101             return err;
102     }
103
104     return 0;
105 }
106
107 static int segment_end(AVFormatContext *oc, int write_trailer)
108 {
109     int ret = 0;
110
111     if (write_trailer)
112         av_write_trailer(oc);
113     avio_close(oc->pb);
114
115     return ret;
116 }
117
118 static int seg_write_header(AVFormatContext *s)
119 {
120     SegmentContext *seg = s->priv_data;
121     AVFormatContext *oc = NULL;
122     int ret, i;
123
124     seg->number = 0;
125     seg->offset_time = 0;
126     seg->recording_time = seg->time * 1000000;
127
128     if (seg->list)
129         if ((ret = avio_open2(&seg->pb, seg->list, AVIO_FLAG_WRITE,
130                               &s->interrupt_callback, NULL)) < 0)
131             goto fail;
132
133     for (i = 0; i < s->nb_streams; i++)
134         seg->has_video +=
135             (s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO);
136
137     if (seg->has_video > 1)
138         av_log(s, AV_LOG_WARNING,
139                "More than a single video stream present, "
140                "expect issues decoding it.\n");
141
142     seg->oformat = av_guess_format(seg->format, s->filename, NULL);
143
144     if (!seg->oformat) {
145         ret = AVERROR_MUXER_NOT_FOUND;
146         goto fail;
147     }
148     if (seg->oformat->flags & AVFMT_NOFILE) {
149         av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
150                oc->oformat->name);
151         ret = AVERROR(EINVAL);
152         goto fail;
153     }
154
155     if ((ret = segment_mux_init(s)) < 0)
156         goto fail;
157     oc = seg->avf;
158
159     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
160                               s->filename, seg->number++) < 0) {
161         ret = AVERROR(EINVAL);
162         goto fail;
163     }
164
165     if ((ret = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
166                           &s->interrupt_callback, NULL)) < 0)
167         goto fail;
168
169     if ((ret = avformat_write_header(oc, NULL)) < 0) {
170         avio_close(oc->pb);
171         goto fail;
172     }
173
174     if (seg->list) {
175         avio_printf(seg->pb, "%s\n", oc->filename);
176         avio_flush(seg->pb);
177     }
178
179 fail:
180     if (ret) {
181         if (seg->list)
182             avio_close(seg->pb);
183         if (seg->avf)
184             avformat_free_context(seg->avf);
185     }
186     return ret;
187 }
188
189 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
190 {
191     SegmentContext *seg = s->priv_data;
192     AVFormatContext *oc = seg->avf;
193     AVStream *st = s->streams[pkt->stream_index];
194     int64_t end_pts = seg->recording_time * seg->number;
195     int ret;
196
197     if ((seg->has_video && st->codec->codec_type == AVMEDIA_TYPE_VIDEO) &&
198         av_compare_ts(pkt->pts, st->time_base,
199                       end_pts, AV_TIME_BASE_Q) >= 0 &&
200         pkt->flags & AV_PKT_FLAG_KEY) {
201
202         av_log(s, AV_LOG_DEBUG, "Next segment starts at %d %"PRId64"\n",
203                pkt->stream_index, pkt->pts);
204
205         ret = segment_end(oc, seg->individual_header_trailer);
206
207         if (!ret)
208             ret = segment_start(s, seg->individual_header_trailer);
209
210         if (ret)
211             goto fail;
212
213         oc = seg->avf;
214
215         if (seg->list) {
216             avio_printf(seg->pb, "%s\n", oc->filename);
217             avio_flush(seg->pb);
218             if (seg->size && !(seg->number % seg->size)) {
219                 avio_close(seg->pb);
220                 if ((ret = avio_open2(&seg->pb, seg->list, AVIO_FLAG_WRITE,
221                                       &s->interrupt_callback, NULL)) < 0)
222                     goto fail;
223             }
224         }
225     }
226
227     ret = ff_write_chained(oc, pkt->stream_index, pkt, s);
228
229 fail:
230     if (ret < 0) {
231         if (seg->list)
232             avio_close(seg->pb);
233         avformat_free_context(oc);
234     }
235
236     return ret;
237 }
238
239 static int seg_write_trailer(struct AVFormatContext *s)
240 {
241     SegmentContext *seg = s->priv_data;
242     AVFormatContext *oc = seg->avf;
243     int ret = segment_end(oc);
244     if (seg->list)
245         avio_close(seg->pb);
246     avformat_free_context(oc);
247     return ret;
248 }
249
250 #define OFFSET(x) offsetof(SegmentContext, x)
251 #define E AV_OPT_FLAG_ENCODING_PARAM
252 static const AVOption options[] = {
253     { "segment_format",    "container format used for the segments",  OFFSET(format),  AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
254     { "segment_time",      "segment length in seconds",               OFFSET(time),    AV_OPT_TYPE_FLOAT,  {.dbl = 2},     0, FLT_MAX, E },
255     { "segment_list",      "output the segment list",                 OFFSET(list),    AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
256     { "segment_list_size", "maximum number of playlist entries",      OFFSET(size),    AV_OPT_TYPE_INT,    {.i64 = 5},     0, INT_MAX, E },
257     { "segment_wrap",      "number after which the index wraps",      OFFSET(wrap),    AV_OPT_TYPE_INT,    {.i64 = 0},     0, INT_MAX, E },
258     { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, E },
259     { NULL },
260 };
261
262 static const AVClass seg_class = {
263     .class_name = "segment muxer",
264     .item_name  = av_default_item_name,
265     .option     = options,
266     .version    = LIBAVUTIL_VERSION_INT,
267 };
268
269
270 AVOutputFormat ff_segment_muxer = {
271     .name           = "segment",
272     .long_name      = NULL_IF_CONFIG_SMALL("segment"),
273     .priv_data_size = sizeof(SegmentContext),
274     .flags          = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
275     .write_header   = seg_write_header,
276     .write_packet   = seg_write_packet,
277     .write_trailer  = seg_write_trailer,
278     .priv_class     = &seg_class,
279 };