lavf/segment: apply misc fixes to the private options internal documentation
[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     AVFormatContext *avf;
37     char *format;          ///< format to use for output segment files
38     char *list;            ///< filename for the segment list file
39     int   list_size;       ///< number of entries for the segment list file
40     float time;            ///< segment duration
41     int  wrap;             ///< number after which the index wraps
42     int64_t offset_time;
43     int64_t recording_time;
44     int has_video;
45     AVIOContext *pb;
46 } SegmentContext;
47
48 static int segment_start(AVFormatContext *s)
49 {
50     SegmentContext *seg = s->priv_data;
51     AVFormatContext *oc = seg->avf;
52     int err = 0;
53
54     if (seg->wrap)
55         seg->number %= seg->wrap;
56
57     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
58                               s->filename, seg->number++) < 0)
59         return AVERROR(EINVAL);
60
61     if ((err = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
62                           &s->interrupt_callback, NULL)) < 0)
63         return err;
64
65     if (!oc->priv_data && oc->oformat->priv_data_size > 0) {
66         oc->priv_data = av_mallocz(oc->oformat->priv_data_size);
67         if (!oc->priv_data) {
68             avio_close(oc->pb);
69             return AVERROR(ENOMEM);
70         }
71         if (oc->oformat->priv_class) {
72             *(const AVClass**)oc->priv_data = oc->oformat->priv_class;
73             av_opt_set_defaults(oc->priv_data);
74         }
75     }
76
77     if ((err = oc->oformat->write_header(oc)) < 0) {
78         goto fail;
79     }
80
81     return 0;
82
83 fail:
84     av_log(oc, AV_LOG_ERROR, "Failure occurred when starting segment '%s'\n",
85            oc->filename);
86     avio_close(oc->pb);
87     av_freep(&oc->priv_data);
88
89     return err;
90 }
91
92 static int segment_end(AVFormatContext *s)
93 {
94     SegmentContext *seg = s->priv_data;
95     AVFormatContext *oc = seg->avf;
96     int ret = 0;
97
98     if (oc->oformat->write_trailer)
99         ret = oc->oformat->write_trailer(oc);
100
101     if (ret < 0)
102         av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
103                oc->filename);
104
105     if (seg->list) {
106         if (seg->list_size && !(seg->number % seg->list_size)) {
107             avio_close(seg->pb);
108             if ((ret = avio_open2(&seg->pb, seg->list, AVIO_FLAG_WRITE,
109                                   &s->interrupt_callback, NULL)) < 0)
110                 goto end;
111         }
112         avio_printf(seg->pb, "%s\n", oc->filename);
113         avio_flush(seg->pb);
114     }
115
116 end:
117     avio_close(oc->pb);
118     if (oc->oformat->priv_class)
119         av_opt_free(oc->priv_data);
120     av_freep(&oc->priv_data);
121
122     return ret;
123 }
124
125 static int seg_write_header(AVFormatContext *s)
126 {
127     SegmentContext *seg = s->priv_data;
128     AVFormatContext *oc;
129     int ret, i;
130
131     seg->number = 0;
132     seg->offset_time = 0;
133     seg->recording_time = seg->time * 1000000;
134
135     oc = avformat_alloc_context();
136
137     if (!oc)
138         return AVERROR(ENOMEM);
139
140     if (seg->list)
141         if ((ret = avio_open2(&seg->pb, seg->list, AVIO_FLAG_WRITE,
142                               &s->interrupt_callback, NULL)) < 0)
143             goto fail;
144
145     for (i = 0; i< s->nb_streams; i++)
146         seg->has_video +=
147             (s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO);
148
149     if (seg->has_video > 1)
150         av_log(s, AV_LOG_WARNING,
151                "More than a single video stream present, "
152                "expect issues decoding it.\n");
153
154     oc->oformat = av_guess_format(seg->format, s->filename, NULL);
155
156     if (!oc->oformat) {
157         ret = AVERROR_MUXER_NOT_FOUND;
158         goto fail;
159     }
160     if (oc->oformat->flags & AVFMT_NOFILE) {
161         av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
162                oc->oformat->name);
163         ret = AVERROR(EINVAL);
164         goto fail;
165     }
166
167     seg->avf = oc;
168
169     oc->streams = s->streams;
170     oc->nb_streams = s->nb_streams;
171
172     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
173                               s->filename, seg->number++) < 0) {
174         ret = AVERROR(EINVAL);
175         goto fail;
176     }
177
178     if ((ret = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
179                           &s->interrupt_callback, NULL)) < 0)
180         goto fail;
181
182     if ((ret = avformat_write_header(oc, NULL)) < 0) {
183         avio_close(oc->pb);
184         goto fail;
185     }
186
187 fail:
188     if (ret) {
189         if (oc) {
190             oc->streams = NULL;
191             oc->nb_streams = 0;
192             avformat_free_context(oc);
193         }
194         if (seg->list)
195             avio_close(seg->pb);
196     }
197     return ret;
198 }
199
200 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
201 {
202     SegmentContext *seg = s->priv_data;
203     AVFormatContext *oc = seg->avf;
204     AVStream *st = oc->streams[pkt->stream_index];
205     int64_t end_pts = seg->recording_time * seg->number;
206     int ret;
207
208     if ((seg->has_video && st->codec->codec_type == AVMEDIA_TYPE_VIDEO) &&
209         av_compare_ts(pkt->pts, st->time_base,
210                       end_pts, AV_TIME_BASE_Q) >= 0 &&
211         pkt->flags & AV_PKT_FLAG_KEY) {
212
213         av_log(s, AV_LOG_DEBUG, "Next segment starts at %d %"PRId64"\n",
214                pkt->stream_index, pkt->pts);
215
216         if ((ret = segment_end(s)) < 0 || (ret = segment_start(s)) < 0)
217             goto fail;
218     }
219
220     ret = oc->oformat->write_packet(oc, pkt);
221
222 fail:
223     if (ret < 0) {
224         oc->streams = NULL;
225         oc->nb_streams = 0;
226         if (seg->list)
227             avio_close(seg->pb);
228         avformat_free_context(oc);
229     }
230
231     return ret;
232 }
233
234 static int seg_write_trailer(struct AVFormatContext *s)
235 {
236     SegmentContext *seg = s->priv_data;
237     AVFormatContext *oc = seg->avf;
238     int ret = segment_end(s);
239     if (seg->list)
240         avio_close(seg->pb);
241     oc->streams = NULL;
242     oc->nb_streams = 0;
243     avformat_free_context(oc);
244     return ret;
245 }
246
247 #define OFFSET(x) offsetof(SegmentContext, x)
248 #define E AV_OPT_FLAG_ENCODING_PARAM
249 static const AVOption options[] = {
250     { "segment_format",    "set container format used for the segments", OFFSET(format),  AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
251     { "segment_time",      "set segment length in seconds",              OFFSET(time),    AV_OPT_TYPE_FLOAT,  {.dbl = 2},     0, FLT_MAX, E },
252     { "segment_list",      "set the segment list filename",              OFFSET(list),    AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
253     { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT,  {.dbl = 5},     0, INT_MAX, E },
254     { "segment_wrap",      "set number after which the index wraps",     OFFSET(wrap),    AV_OPT_TYPE_INT,    {.dbl = 0},     0, INT_MAX, E },
255     { NULL },
256 };
257
258 static const AVClass seg_class = {
259     .class_name = "segment muxer",
260     .item_name  = av_default_item_name,
261     .option     = options,
262     .version    = LIBAVUTIL_VERSION_INT,
263 };
264
265 AVOutputFormat ff_segment_muxer = {
266     .name           = "segment",
267     .long_name      = NULL_IF_CONFIG_SMALL("segment muxer"),
268     .priv_data_size = sizeof(SegmentContext),
269     .flags          = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
270     .write_header   = seg_write_header,
271     .write_packet   = seg_write_packet,
272     .write_trailer  = seg_write_trailer,
273     .priv_class     = &seg_class,
274 };
275
276 static const AVClass sseg_class = {
277     .class_name = "stream_segment muxer",
278     .item_name  = av_default_item_name,
279     .option     = options,
280     .version    = LIBAVUTIL_VERSION_INT,
281 };
282
283 AVOutputFormat ff_stream_segment_muxer = {
284     .name           = "stream_segment,ssegment",
285     .long_name      = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
286     .priv_data_size = sizeof(SegmentContext),
287     .flags          = AVFMT_NOFILE,
288     .write_header   = seg_write_header,
289     .write_packet   = seg_write_packet,
290     .write_trailer  = seg_write_trailer,
291     .priv_class     = &sseg_class,
292 };