FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
webm_chunk.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, Vignesh Venkatasubramanian
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 WebM Chunk Muxer
23  * The chunk muxer enables writing WebM Live chunks where there is a header
24  * chunk, followed by data chunks where each Cluster is written out as a Chunk.
25  */
26 
27 #include <float.h>
28 #include <time.h>
29 
30 #include "avformat.h"
31 #include "avio.h"
32 #include "avio_internal.h"
33 #include "internal.h"
34 
35 #include "libavutil/avassert.h"
36 #include "libavutil/log.h"
37 #include "libavutil/opt.h"
38 #include "libavutil/avstring.h"
39 #include "libavutil/parseutils.h"
40 #include "libavutil/mathematics.h"
41 #include "libavutil/time.h"
43 #include "libavutil/timestamp.h"
44 
45 #define MAX_FILENAME_SIZE 1024
46 
47 typedef struct WebMChunkContext {
48  const AVClass *class;
53  char *http_method;
54  uint64_t duration_written;
55  int prev_pts;
59 
61 {
62  WebMChunkContext *wc = s->priv_data;
63  AVFormatContext *oc;
64  int ret;
65 
67  if (ret < 0)
68  return ret;
69  oc = wc->avf;
70 
72  oc->max_delay = s->max_delay;
73  av_dict_copy(&oc->metadata, s->metadata, 0);
74 
75  *(const AVClass**)oc->priv_data = oc->oformat->priv_class;
77  av_opt_set_int(oc->priv_data, "dash", 1, 0);
78  av_opt_set_int(oc->priv_data, "cluster_time_limit", wc->chunk_duration, 0);
79  av_opt_set_int(oc->priv_data, "live", 1, 0);
80 
81  oc->streams = s->streams;
82  oc->nb_streams = s->nb_streams;
83 
84  return 0;
85 }
86 
87 static int get_chunk_filename(AVFormatContext *s, int is_header, char *filename)
88 {
89  WebMChunkContext *wc = s->priv_data;
90  AVFormatContext *oc = wc->avf;
91  if (!filename) {
92  return AVERROR(EINVAL);
93  }
94  if (is_header) {
95  if (!wc->header_filename) {
96  av_log(oc, AV_LOG_ERROR, "No header filename provided\n");
97  return AVERROR(EINVAL);
98  }
99  av_strlcpy(filename, wc->header_filename, strlen(wc->header_filename) + 1);
100  } else {
102  s->url, wc->chunk_index - 1) < 0) {
103  av_log(oc, AV_LOG_ERROR, "Invalid chunk filename template '%s'\n", s->url);
104  return AVERROR(EINVAL);
105  }
106  }
107  return 0;
108 }
109 
111 {
112  WebMChunkContext *wc = s->priv_data;
113  AVFormatContext *oc = NULL;
114  int ret;
115  int i;
117 
118  // DASH Streams can only have either one track per file.
119  if (s->nb_streams != 1) { return AVERROR_INVALIDDATA; }
120 
121  wc->chunk_index = wc->chunk_start_index;
122  wc->oformat = av_guess_format("webm", s->url, "video/webm");
123  if (!wc->oformat)
125 
126  ret = chunk_mux_init(s);
127  if (ret < 0)
128  return ret;
129  oc = wc->avf;
130  ret = get_chunk_filename(s, 1, oc->url);
131  if (ret < 0)
132  return ret;
133  if (wc->http_method)
134  av_dict_set(&options, "method", wc->http_method, 0);
135  ret = s->io_open(s, &oc->pb, oc->url, AVIO_FLAG_WRITE, &options);
136  av_dict_free(&options);
137  if (ret < 0)
138  return ret;
139 
140  oc->pb->seekable = 0;
141  ret = oc->oformat->write_header(oc);
142  if (ret < 0)
143  return ret;
144  ff_format_io_close(s, &oc->pb);
145  for (i = 0; i < s->nb_streams; i++) {
146  // ms precision is the de-facto standard timescale for mkv files.
147  avpriv_set_pts_info(s->streams[i], 64, 1, 1000);
148  }
149  return 0;
150 }
151 
153 {
154  WebMChunkContext *wc = s->priv_data;
155  AVFormatContext *oc = wc->avf;
156  int ret;
157 
158  ret = avio_open_dyn_buf(&oc->pb);
159  if (ret < 0)
160  return ret;
161  wc->chunk_index++;
162  return 0;
163 }
164 
166 {
167  WebMChunkContext *wc = s->priv_data;
168  AVFormatContext *oc = wc->avf;
169  int ret;
170  int buffer_size;
171  uint8_t *buffer;
172  AVIOContext *pb;
173  char filename[MAX_FILENAME_SIZE];
175 
176  if (wc->chunk_start_index == wc->chunk_index)
177  return 0;
178  // Flush the cluster in WebM muxer.
179  oc->oformat->write_packet(oc, NULL);
180  buffer_size = avio_close_dyn_buf(oc->pb, &buffer);
181  ret = get_chunk_filename(s, 0, filename);
182  if (ret < 0)
183  goto fail;
184  if (wc->http_method)
185  av_dict_set(&options, "method", wc->http_method, 0);
186  ret = s->io_open(s, &pb, filename, AVIO_FLAG_WRITE, &options);
187  if (ret < 0)
188  goto fail;
189  avio_write(pb, buffer, buffer_size);
190  ff_format_io_close(s, &pb);
191  oc->pb = NULL;
192 fail:
193  av_dict_free(&options);
194  av_free(buffer);
195  return (ret < 0) ? ret : 0;
196 }
197 
199 {
200  WebMChunkContext *wc = s->priv_data;
201  AVFormatContext *oc = wc->avf;
202  AVStream *st = s->streams[pkt->stream_index];
203  int ret;
204 
205  if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO) {
206  wc->duration_written += av_rescale_q(pkt->pts - wc->prev_pts,
207  st->time_base,
208  (AVRational) {1, 1000});
209  wc->prev_pts = pkt->pts;
210  }
211 
212  // For video, a new chunk is started only on key frames. For audio, a new
213  // chunk is started based on chunk_duration.
214  if ((st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
215  (pkt->flags & AV_PKT_FLAG_KEY)) ||
216  (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO &&
217  (pkt->pts == 0 || wc->duration_written >= wc->chunk_duration))) {
218  wc->duration_written = 0;
219  if ((ret = chunk_end(s)) < 0 || (ret = chunk_start(s)) < 0) {
220  goto fail;
221  }
222  }
223 
224  ret = oc->oformat->write_packet(oc, pkt);
225  if (ret < 0)
226  goto fail;
227 
228 fail:
229  if (ret < 0) {
230  oc->streams = NULL;
231  oc->nb_streams = 0;
233  }
234 
235  return ret;
236 }
237 
239 {
240  WebMChunkContext *wc = s->priv_data;
241  AVFormatContext *oc = wc->avf;
242  oc->oformat->write_trailer(oc);
243  chunk_end(s);
244  oc->streams = NULL;
245  oc->nb_streams = 0;
247  return 0;
248 }
249 
250 #define OFFSET(x) offsetof(WebMChunkContext, x)
251 static const AVOption options[] = {
252  { "chunk_start_index", "start index of the chunk", OFFSET(chunk_start_index), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
253  { "header", "filename of the header where the initialization data will be written", OFFSET(header_filename), AV_OPT_TYPE_STRING, { 0 }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
254  { "audio_chunk_duration", "duration of each chunk in milliseconds", OFFSET(chunk_duration), AV_OPT_TYPE_INT, {.i64 = 5000}, 0, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
255  { "method", "set the HTTP method", OFFSET(http_method), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
256  { NULL },
257 };
258 
259 #if CONFIG_WEBM_CHUNK_MUXER
260 static const AVClass webm_chunk_class = {
261  .class_name = "WebM Chunk Muxer",
262  .item_name = av_default_item_name,
263  .option = options,
264  .version = LIBAVUTIL_VERSION_INT,
265 };
266 
268  .name = "webm_chunk",
269  .long_name = NULL_IF_CONFIG_SMALL("WebM Chunk Muxer"),
270  .mime_type = "video/webm",
271  .extensions = "chk",
274  .priv_data_size = sizeof(WebMChunkContext),
278  .priv_class = &webm_chunk_class,
279 };
280 #endif
static void write_packet(OutputFile *of, AVPacket *pkt, OutputStream *ost, int unqueue)
Definition: ffmpeg.c:679
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:768
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
Buffered I/O operations.
AVIOInterruptCB interrupt_callback
Custom interrupt callbacks for the I/O layer.
Definition: avformat.h:1618
int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer)
Return the written size and a pointer to the buffer.
Definition: aviobuf.c:1420
AVOption.
Definition: opt.h:246
static int chunk_start(AVFormatContext *s)
Definition: webm_chunk.c:152
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4820
void av_opt_set_defaults(void *s)
Set the values of all AVOption fields to their default values.
Definition: opt.c:1292
AVFormatContext * avf
Definition: webm_chunk.c:57
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
uint64_t duration_written
Definition: webm_chunk.c:54
#define AVIO_FLAG_WRITE
write-only
Definition: avio.h:655
int av_dict_copy(AVDictionary **dst, const AVDictionary *src, int flags)
Copy entries from one AVDictionary struct into another.
Definition: dict.c:217
int(* write_packet)(struct AVFormatContext *, AVPacket *pkt)
Write a packet.
Definition: avformat.h:558
static AVPacket pkt
int avio_open_dyn_buf(AVIOContext **s)
Open a write only memory stream.
Definition: aviobuf.c:1391
char * http_method
Definition: webm_chunk.c:53
#define AVFMT_TS_NONSTRICT
Format does not require strictly increasing timestamps, but they must still be monotonic.
Definition: avformat.h:479
Format I/O context.
Definition: avformat.h:1342
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
uint8_t
AVOptions.
timestamp utils, mostly useful for debugging/logging purposes
void ff_format_io_close(AVFormatContext *s, AVIOContext **pb)
Definition: utils.c:5608
#define MAX_FILENAME_SIZE
Definition: webm_chunk.c:45
static int get_chunk_filename(AVFormatContext *s, int is_header, char *filename)
Definition: webm_chunk.c:87
char * header_filename
Definition: webm_chunk.c:50
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1410
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:218
AVOutputFormat * oformat
Definition: webm_chunk.c:56
#define av_log(a,...)
#define AV_OPT_FLAG_ENCODING_PARAM
a generic parameter which can be set by the user for muxing or encoding
Definition: opt.h:276
struct AVOutputFormat * oformat
The output container format.
Definition: avformat.h:1361
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1462
int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat, const char *format_name, const char *filename)
Allocate an AVFormatContext for an output format.
Definition: mux.c:148
int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq)
Rescale a 64-bit integer by 2 rational numbers.
Definition: mathematics.c:142
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
AVDictionary * metadata
Metadata that applies to the whole file.
Definition: avformat.h:1580
#define AVERROR(e)
Definition: error.h:43
static const AVOption options[]
Definition: webm_chunk.c:251
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
int(* write_header)(struct AVFormatContext *)
Definition: avformat.h:550
char * url
input or output URL.
Definition: avformat.h:1438
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values. ...
Definition: dict.c:203
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3880
int av_opt_set_int(void *obj, const char *name, int64_t val, int search_flags)
Definition: opt.c:558
static int chunk_mux_init(AVFormatContext *s)
Definition: webm_chunk.c:60
simple assert() macros that are a bit more flexible than ISO C assert().
size_t av_strlcpy(char *dst, const char *src, size_t size)
Copy the string src to dst, but no more than size - 1 bytes, and null-terminate dst.
Definition: avstring.c:83
#define fail()
Definition: checkasm.h:116
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1436
unsigned int nb_streams
Number of elements in AVFormatContext.streams.
Definition: avformat.h:1398
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:260
static int write_trailer(AVFormatContext *s1)
Definition: v4l2enc.c:94
#define AVFMT_GLOBALHEADER
Format wants global header.
Definition: avformat.h:468
const char * name
Definition: avformat.h:507
#define OFFSET(x)
Definition: webm_chunk.c:250
static int webm_chunk_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: webm_chunk.c:198
AVOutputFormat * av_guess_format(const char *short_name, const char *filename, const char *mime_type)
Return the output format in the list of registered output formats which best matches the provided par...
Definition: format.c:51
const AVClass * priv_class
AVClass for the private context.
Definition: avformat.h:535
int av_get_frame_filename(char *buf, int buf_size, const char *path, int number)
Definition: utils.c:4695
Stream structure.
Definition: avformat.h:873
AVIOContext * pb
I/O context.
Definition: avformat.h:1384
static int webm_chunk_write_header(AVFormatContext *s)
Definition: webm_chunk.c:110
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:70
Describe the class of an AVClass context structure.
Definition: log.h:67
AVOutputFormat ff_webm_chunk_muxer
Rational number (pair of numerator and denominator).
Definition: rational.h:58
void avformat_free_context(AVFormatContext *s)
Free an AVFormatContext and all its streams.
Definition: utils.c:4384
misc parsing utilities
static int chunk_end(AVFormatContext *s)
Definition: webm_chunk.c:165
Main libavformat public API header.
#define AVFMT_NOFILE
Demuxer will use avio_open, no opened file should be provided by the caller.
Definition: avformat.h:465
static int webm_chunk_write_trailer(AVFormatContext *s)
Definition: webm_chunk.c:238
#define av_free(p)
void * priv_data
Format private data.
Definition: avformat.h:1370
static void write_header(FFV1Context *f)
Definition: ffv1enc.c:337
#define AVERROR_MUXER_NOT_FOUND
Muxer not found.
Definition: error.h:60
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1020
int stream_index
Definition: avcodec.h:1432
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avformat.h:902
int(* io_open)(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags, AVDictionary **options)
A callback for opening new IO streams.
Definition: avformat.h:1922
This structure stores compressed data.
Definition: avcodec.h:1407
int(* write_trailer)(struct AVFormatContext *)
Definition: avformat.h:559
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1423
GLuint buffer
Definition: opengl_enc.c:102
#define AVFMT_NEEDNUMBER
Needs 'd' in filename.
Definition: avformat.h:466