2 * Magic Lantern Video (MLV) demuxer
3 * Copyright (c) 2014 Peter Ross
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
9 * License 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 GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Magic Lantern Video (MLV) demuxer
27 #include "libavutil/eval.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/intreadwrite.h"
30 #include "libavutil/rational.h"
32 #include "avio_internal.h"
36 #define MLV_VERSION "v2.0"
38 #define MLV_VIDEO_CLASS_RAW 1
39 #define MLV_VIDEO_CLASS_YUV 2
40 #define MLV_VIDEO_CLASS_JPEG 3
41 #define MLV_VIDEO_CLASS_H264 4
43 #define MLV_AUDIO_CLASS_WAV 1
45 #define MLV_CLASS_FLAG_DELTA 0x40
46 #define MLV_CLASS_FLAG_LZMA 0x80
55 static int probe(const AVProbeData *p)
57 if (AV_RL32(p->buf) == MKTAG('M','L','V','I') &&
58 AV_RL32(p->buf + 4) >= 52 &&
59 !memcmp(p->buf + 8, MLV_VERSION, 5))
60 return AVPROBE_SCORE_MAX;
64 static int check_file_header(AVIOContext *pb, uint64_t guid)
72 return AVERROR_INVALIDDATA;
73 avio_read(pb, version, 8);
74 if (memcmp(version, MLV_VERSION, 5) || avio_rl64(pb) != guid)
75 return AVERROR_INVALIDDATA;
76 avio_skip(pb, size - 24);
80 static void read_string(AVFormatContext *avctx, AVIOContext *pb, const char *tag, unsigned size)
82 char * value = av_malloc(size + 1);
88 avio_read(pb, value, size);
95 av_dict_set(&avctx->metadata, tag, value, AV_DICT_DONT_STRDUP_VAL);
98 static void read_uint8(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
100 av_dict_set_int(&avctx->metadata, tag, avio_r8(pb), 0);
103 static void read_uint16(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
105 av_dict_set_int(&avctx->metadata, tag, avio_rl16(pb), 0);
108 static void read_uint32(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
110 av_dict_set_int(&avctx->metadata, tag, avio_rl32(pb), 0);
113 static void read_uint64(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
115 av_dict_set_int(&avctx->metadata, tag, avio_rl64(pb), 0);
118 static int scan_file(AVFormatContext *avctx, AVStream *vst, AVStream *ast, int file)
120 MlvContext *mlv = avctx->priv_data;
121 AVIOContext *pb = mlv->pb[file];
123 while (!avio_feof(pb)) {
126 type = avio_rl32(pb);
127 size = avio_rl32(pb);
128 avio_skip(pb, 8); //timestamp
132 if (vst && type == MKTAG('R','A','W','I') && size >= 164) {
133 vst->codecpar->width = avio_rl16(pb);
134 vst->codecpar->height = avio_rl16(pb);
135 ret = av_image_check_size(vst->codecpar->width, vst->codecpar->height, 0, avctx);
138 if (avio_rl32(pb) != 1)
139 avpriv_request_sample(avctx, "raw api version");
140 avio_skip(pb, 20); // pointer, width, height, pitch, frame_size
141 vst->codecpar->bits_per_coded_sample = avio_rl32(pb);
142 if (vst->codecpar->bits_per_coded_sample < 0 ||
143 vst->codecpar->bits_per_coded_sample > (INT_MAX - 7) / (vst->codecpar->width * vst->codecpar->height)) {
144 av_log(avctx, AV_LOG_ERROR,
145 "invalid bits_per_coded_sample %d (size: %dx%d)\n",
146 vst->codecpar->bits_per_coded_sample,
147 vst->codecpar->width, vst->codecpar->height);
148 return AVERROR_INVALIDDATA;
150 avio_skip(pb, 8 + 16 + 24); // black_level, white_level, xywh, active_area, exposure_bias
151 if (avio_rl32(pb) != 0x2010100) /* RGGB */
152 avpriv_request_sample(avctx, "cfa_pattern");
153 avio_skip(pb, 80); // calibration_illuminant1, color_matrix1, dynamic_range
154 vst->codecpar->format = AV_PIX_FMT_BAYER_RGGB16LE;
155 vst->codecpar->codec_tag = MKTAG('B', 'I', 'T', 16);
157 } else if (ast && type == MKTAG('W', 'A', 'V', 'I') && size >= 16) {
158 ret = ff_get_wav_header(avctx, pb, ast->codecpar, 16, 0);
162 } else if (type == MKTAG('I','N','F','O')) {
164 read_string(avctx, pb, "info", size);
166 } else if (type == MKTAG('I','D','N','T') && size >= 36) {
167 read_string(avctx, pb, "cameraName", 32);
168 read_uint32(avctx, pb, "cameraModel", "0x%"PRIx32);
171 read_string(avctx, pb, "cameraSerial", 32);
174 } else if (type == MKTAG('L','E','N','S') && size >= 48) {
175 read_uint16(avctx, pb, "focalLength", "%i");
176 read_uint16(avctx, pb, "focalDist", "%i");
177 read_uint16(avctx, pb, "aperture", "%i");
178 read_uint8(avctx, pb, "stabilizerMode", "%i");
179 read_uint8(avctx, pb, "autofocusMode", "%i");
180 read_uint32(avctx, pb, "flags", "0x%"PRIx32);
181 read_uint32(avctx, pb, "lensID", "%"PRIi32);
182 read_string(avctx, pb, "lensName", 32);
185 read_string(avctx, pb, "lensSerial", 32);
188 } else if (vst && type == MKTAG('V', 'I', 'D', 'F') && size >= 4) {
189 uint64_t pts = avio_rl32(pb);
190 ff_add_index_entry(&vst->index_entries, &vst->nb_index_entries, &vst->index_entries_allocated_size,
191 avio_tell(pb) - 20, pts, file, 0, AVINDEX_KEYFRAME);
193 } else if (ast && type == MKTAG('A', 'U', 'D', 'F') && size >= 4) {
194 uint64_t pts = avio_rl32(pb);
195 ff_add_index_entry(&ast->index_entries, &ast->nb_index_entries, &ast->index_entries_allocated_size,
196 avio_tell(pb) - 20, pts, file, 0, AVINDEX_KEYFRAME);
198 } else if (vst && type == MKTAG('W','B','A','L') && size >= 28) {
199 read_uint32(avctx, pb, "wb_mode", "%"PRIi32);
200 read_uint32(avctx, pb, "kelvin", "%"PRIi32);
201 read_uint32(avctx, pb, "wbgain_r", "%"PRIi32);
202 read_uint32(avctx, pb, "wbgain_g", "%"PRIi32);
203 read_uint32(avctx, pb, "wbgain_b", "%"PRIi32);
204 read_uint32(avctx, pb, "wbs_gm", "%"PRIi32);
205 read_uint32(avctx, pb, "wbs_ba", "%"PRIi32);
207 } else if (type == MKTAG('R','T','C','I') && size >= 20) {
209 struct tm time = { 0 };
210 time.tm_sec = avio_rl16(pb);
211 time.tm_min = avio_rl16(pb);
212 time.tm_hour = avio_rl16(pb);
213 time.tm_mday = avio_rl16(pb);
214 time.tm_mon = avio_rl16(pb);
215 time.tm_year = avio_rl16(pb);
216 time.tm_wday = avio_rl16(pb);
217 time.tm_yday = avio_rl16(pb);
218 time.tm_isdst = avio_rl16(pb);
220 if (strftime(str, sizeof(str), "%Y-%m-%d %H:%M:%S", &time))
221 av_dict_set(&avctx->metadata, "time", str, 0);
223 } else if (type == MKTAG('E','X','P','O') && size >= 16) {
224 av_dict_set(&avctx->metadata, "isoMode", avio_rl32(pb) ? "auto" : "manual", 0);
225 read_uint32(avctx, pb, "isoValue", "%"PRIi32);
226 read_uint32(avctx, pb, "isoAnalog", "%"PRIi32);
227 read_uint32(avctx, pb, "digitalGain", "%"PRIi32);
230 read_uint64(avctx, pb, "shutterValue", "%"PRIi64);
233 } else if (type == MKTAG('S','T','Y','L') && size >= 36) {
234 read_uint32(avctx, pb, "picStyleId", "%"PRIi32);
235 read_uint32(avctx, pb, "contrast", "%"PRIi32);
236 read_uint32(avctx, pb, "sharpness", "%"PRIi32);
237 read_uint32(avctx, pb, "saturation", "%"PRIi32);
238 read_uint32(avctx, pb, "colortone", "%"PRIi32);
239 read_string(avctx, pb, "picStyleName", 16);
241 } else if (type == MKTAG('M','A','R','K')) {
242 } else if (type == MKTAG('N','U','L','L')) {
243 } else if (type == MKTAG('M','L','V','I')) { /* occurs when MLV and Mnn files are concatenated */
245 av_log(avctx, AV_LOG_INFO, "unsupported tag %s, size %u\n",
246 av_fourcc2str(type), size);
253 static int read_header(AVFormatContext *avctx)
255 MlvContext *mlv = avctx->priv_data;
256 AVIOContext *pb = avctx->pb;
257 AVStream *vst = NULL, *ast = NULL;
259 unsigned nb_video_frames, nb_audio_frames;
264 size = avio_rl32(pb);
266 return AVERROR_INVALIDDATA;
270 guid = avio_rl64(pb);
271 snprintf(guidstr, sizeof(guidstr), "0x%"PRIx64, guid);
272 av_dict_set(&avctx->metadata, "guid", guidstr, 0);
274 avio_skip(pb, 8); //fileNum, fileCount, fileFlags
276 mlv->class[0] = avio_rl16(pb);
277 mlv->class[1] = avio_rl16(pb);
279 nb_video_frames = avio_rl32(pb);
280 nb_audio_frames = avio_rl32(pb);
282 if (nb_video_frames && mlv->class[0]) {
283 vst = avformat_new_stream(avctx, NULL);
285 return AVERROR(ENOMEM);
287 vst->nb_frames = nb_video_frames;
288 if ((mlv->class[0] & (MLV_CLASS_FLAG_DELTA|MLV_CLASS_FLAG_LZMA)))
289 avpriv_request_sample(avctx, "compression");
290 vst->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
291 switch (mlv->class[0] & ~(MLV_CLASS_FLAG_DELTA|MLV_CLASS_FLAG_LZMA)) {
292 case MLV_VIDEO_CLASS_RAW:
293 vst->codecpar->codec_id = AV_CODEC_ID_RAWVIDEO;
295 case MLV_VIDEO_CLASS_YUV:
296 vst->codecpar->format = AV_PIX_FMT_YUV420P;
297 vst->codecpar->codec_id = AV_CODEC_ID_RAWVIDEO;
298 vst->codecpar->codec_tag = 0;
300 case MLV_VIDEO_CLASS_JPEG:
301 vst->codecpar->codec_id = AV_CODEC_ID_MJPEG;
302 vst->codecpar->codec_tag = 0;
304 case MLV_VIDEO_CLASS_H264:
305 vst->codecpar->codec_id = AV_CODEC_ID_H264;
306 vst->codecpar->codec_tag = 0;
309 avpriv_request_sample(avctx, "unknown video class");
313 if (nb_audio_frames && mlv->class[1]) {
314 ast = avformat_new_stream(avctx, NULL);
316 return AVERROR(ENOMEM);
318 ast->nb_frames = nb_audio_frames;
319 if ((mlv->class[1] & MLV_CLASS_FLAG_LZMA))
320 avpriv_request_sample(avctx, "compression");
321 if ((mlv->class[1] & ~MLV_CLASS_FLAG_LZMA) != MLV_AUDIO_CLASS_WAV)
322 avpriv_request_sample(avctx, "unknown audio class");
324 ast->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
325 avpriv_set_pts_info(ast, 33, 1, ast->codecpar->sample_rate);
329 AVRational framerate;
330 framerate.num = avio_rl32(pb);
331 framerate.den = avio_rl32(pb);
332 avpriv_set_pts_info(vst, 64, framerate.den, framerate.num);
336 avio_skip(pb, size - 52);
338 /* scan primary file */
339 mlv->pb[100] = avctx->pb;
340 ret = scan_file(avctx, vst, ast, 100);
344 /* scan secondary files */
345 if (strlen(avctx->url) > 2) {
347 char *filename = av_strdup(avctx->url);
350 return AVERROR(ENOMEM);
352 for (i = 0; i < 100; i++) {
353 snprintf(filename + strlen(filename) - 2, 3, "%02d", i);
354 if (avctx->io_open(avctx, &mlv->pb[i], filename, AVIO_FLAG_READ, NULL) < 0)
356 if (check_file_header(mlv->pb[i], guid) < 0) {
357 av_log(avctx, AV_LOG_WARNING, "ignoring %s; bad format or guid mismatch\n", filename);
358 ff_format_io_close(avctx, &mlv->pb[i]);
361 av_log(avctx, AV_LOG_INFO, "scanning %s\n", filename);
362 ret = scan_file(avctx, vst, ast, i);
364 av_log(avctx, AV_LOG_WARNING, "ignoring %s; %s\n", filename, av_err2str(ret));
365 ff_format_io_close(avctx, &mlv->pb[i]);
373 vst->duration = vst->nb_index_entries;
375 ast->duration = ast->nb_index_entries;
377 if ((vst && !vst->nb_index_entries) || (ast && !ast->nb_index_entries)) {
378 av_log(avctx, AV_LOG_ERROR, "no index entries found\n");
379 return AVERROR_INVALIDDATA;
383 avio_seek(pb, FFMIN(vst->index_entries[0].pos, ast->index_entries[0].pos), SEEK_SET);
385 avio_seek(pb, vst->index_entries[0].pos, SEEK_SET);
387 avio_seek(pb, ast->index_entries[0].pos, SEEK_SET);
392 static int read_packet(AVFormatContext *avctx, AVPacket *pkt)
394 MlvContext *mlv = avctx->priv_data;
396 AVStream *st = avctx->streams[mlv->stream_index];
398 unsigned int size, space;
400 if (mlv->pts >= st->duration)
403 index = av_index_search_timestamp(st, mlv->pts, AVSEEK_FLAG_ANY);
405 av_log(avctx, AV_LOG_ERROR, "could not find index entry for frame %"PRId64"\n", mlv->pts);
409 pb = mlv->pb[st->index_entries[index].size];
410 avio_seek(pb, st->index_entries[index].pos, SEEK_SET);
412 avio_skip(pb, 4); // blockType
413 size = avio_rl32(pb);
415 return AVERROR_INVALIDDATA;
416 avio_skip(pb, 12); //timestamp, frameNumber
417 if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)
418 avio_skip(pb, 8); // cropPosX, cropPosY, panPosX, panPosY
419 space = avio_rl32(pb);
420 avio_skip(pb, space);
422 if ((mlv->class[st->id] & (MLV_CLASS_FLAG_DELTA|MLV_CLASS_FLAG_LZMA))) {
423 ret = AVERROR_PATCHWELCOME;
424 } else if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
425 ret = av_get_packet(pb, pkt, (st->codecpar->width * st->codecpar->height * st->codecpar->bits_per_coded_sample + 7) >> 3);
426 } else { // AVMEDIA_TYPE_AUDIO
427 if (space > UINT_MAX - 24 || size < (24 + space))
428 return AVERROR_INVALIDDATA;
429 ret = av_get_packet(pb, pkt, size - (24 + space));
435 pkt->stream_index = mlv->stream_index;
439 if (mlv->stream_index == avctx->nb_streams) {
440 mlv->stream_index = 0;
446 static int read_seek(AVFormatContext *avctx, int stream_index, int64_t timestamp, int flags)
448 MlvContext *mlv = avctx->priv_data;
450 if ((flags & AVSEEK_FLAG_FRAME) || (flags & AVSEEK_FLAG_BYTE))
451 return AVERROR(ENOSYS);
453 if (!(avctx->pb->seekable & AVIO_SEEKABLE_NORMAL))
456 mlv->pts = timestamp;
460 static int read_close(AVFormatContext *s)
462 MlvContext *mlv = s->priv_data;
464 for (i = 0; i < 100; i++)
465 ff_format_io_close(s, &mlv->pb[i]);
469 AVInputFormat ff_mlv_demuxer = {
471 .long_name = NULL_IF_CONFIG_SMALL("Magic Lantern Video (MLV)"),
472 .priv_data_size = sizeof(MlvContext),
474 .read_header = read_header,
475 .read_packet = read_packet,
476 .read_close = read_close,
477 .read_seek = read_seek,