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/intreadwrite.h"
29 #include "libavutil/rational.h"
34 #define MLV_VERSION "v2.0"
36 #define MLV_VIDEO_CLASS_RAW 1
37 #define MLV_VIDEO_CLASS_YUV 2
38 #define MLV_VIDEO_CLASS_JPEG 3
39 #define MLV_VIDEO_CLASS_H264 4
41 #define MLV_AUDIO_CLASS_WAV 1
43 #define MLV_CLASS_FLAG_DELTA 0x40
44 #define MLV_CLASS_FLAG_LZMA 0x80
52 unsigned int buffer_size;
55 static int probe(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, int 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)
101 snprintf(value, sizeof(value), "%i", avio_r8(pb));
102 av_dict_set(&avctx->metadata, tag, value, 0);
105 static void read_uint16(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
108 snprintf(value, sizeof(value), "%i", avio_rl16(pb));
109 av_dict_set(&avctx->metadata, tag, value, 0);
112 static void read_uint32(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
115 snprintf(value, sizeof(value), fmt, avio_rl32(pb));
116 av_dict_set(&avctx->metadata, tag, value, 0);
119 static void read_uint64(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
122 snprintf(value, sizeof(value), fmt, avio_rl64(pb));
123 av_dict_set(&avctx->metadata, tag, value, 0);
126 static void scan_file(AVFormatContext *avctx, AVStream *vst, AVStream *ast, int file)
128 MlvContext *mlv = avctx->priv_data;
129 AVIOContext *pb = mlv->pb[file];
130 while (!url_feof(pb)) {
133 type = avio_rl32(pb);
134 size = avio_rl32(pb);
135 avio_skip(pb, 8); //timestamp
139 if (vst && type == MKTAG('R','A','W','I') && size >= 164) {
140 vst->codec->width = avio_rl16(pb);
141 vst->codec->height = avio_rl16(pb);
142 if (avio_rl32(pb) != 1)
143 avpriv_request_sample(avctx, "raw api version");
144 avio_skip(pb, 20); // pointer, width, height, pitch, frame_size
145 vst->codec->bits_per_coded_sample = avio_rl32(pb);
146 avio_skip(pb, 8 + 16 + 24); // black_level, white_level, xywh, active_area, exposure_bias
147 if (avio_rl32(pb) != 0x2010100) /* RGGB */
148 avpriv_request_sample(avctx, "cfa_pattern");
149 avio_skip(pb, 80); // calibration_illuminant1, color_matrix1, dynamic_range
150 vst->codec->pix_fmt = AV_PIX_FMT_BAYER_RGGB16LE;
151 vst->codec->codec_tag = MKTAG('B', 'I', 'T', 16);
153 } else if (ast && type == MKTAG('W', 'A', 'V', 'I') && size >= 16) {
154 ff_get_wav_header(pb, ast->codec, 16);
156 } else if (type == MKTAG('I','N','F','O')) {
158 read_string(avctx, pb, "info", size);
160 } else if (type == MKTAG('I','D','N','T') && size >= 36) {
161 read_string(avctx, pb, "cameraName", 32);
162 read_uint32(avctx, pb, "cameraModel", "0x%"PRIx32);
165 read_string(avctx, pb, "cameraSerial", 32);
168 } else if (type == MKTAG('L','E','N','S') && size >= 48) {
169 read_uint16(avctx, pb, "focalLength", "%i");
170 read_uint16(avctx, pb, "focalDist", "%i");
171 read_uint16(avctx, pb, "aperture", "%i");
172 read_uint8(avctx, pb, "stabilizerMode", "%i");
173 read_uint8(avctx, pb, "autofocusMode", "%i");
174 read_uint32(avctx, pb, "flags", "0x%"PRIx32);
175 read_uint32(avctx, pb, "lensID", "%"PRIi32);
176 read_string(avctx, pb, "lensName", 32);
179 read_string(avctx, pb, "lensSerial", 32);
182 } else if (vst && type == MKTAG('V', 'I', 'D', 'F') && size >= 4) {
183 uint64_t pts = avio_rl32(pb);
184 ff_add_index_entry(&vst->index_entries, &vst->nb_index_entries, &vst->index_entries_allocated_size,
185 avio_tell(pb) - 20, pts, file, 0, AVINDEX_KEYFRAME);
187 } else if (ast && type == MKTAG('A', 'U', 'D', 'F') && size >= 4) {
188 uint64_t pts = avio_rl32(pb);
189 ff_add_index_entry(&ast->index_entries, &ast->nb_index_entries, &ast->index_entries_allocated_size,
190 avio_tell(pb) - 20, pts, file, 0, AVINDEX_KEYFRAME);
192 } else if (vst && type == MKTAG('W','B','A','L') && size >= 28) {
193 read_uint32(avctx, pb, "wb_mode", "%"PRIi32);
194 read_uint32(avctx, pb, "kelvin", "%"PRIi32);
195 read_uint32(avctx, pb, "wbgain_r", "%"PRIi32);
196 read_uint32(avctx, pb, "wbgain_g", "%"PRIi32);
197 read_uint32(avctx, pb, "wbgain_b", "%"PRIi32);
198 read_uint32(avctx, pb, "wbs_gm", "%"PRIi32);
199 read_uint32(avctx, pb, "wbs_ba", "%"PRIi32);
201 } else if (type == MKTAG('R','T','C','I') && size >= 20) {
203 struct tm time = { 0 };
204 time.tm_sec = avio_rl16(pb);
205 time.tm_min = avio_rl16(pb);
206 time.tm_hour = avio_rl16(pb);
207 time.tm_mday = avio_rl16(pb);
208 time.tm_mon = avio_rl16(pb);
209 time.tm_year = avio_rl16(pb);
210 time.tm_wday = avio_rl16(pb);
211 time.tm_yday = avio_rl16(pb);
212 time.tm_isdst = avio_rl16(pb);
214 strftime(str, sizeof(str), "%Y-%m-%d %H:%M:%S", &time);
215 av_dict_set(&avctx->metadata, "time", str, 0);
217 } else if (type == MKTAG('E','X','P','O') && size >= 16) {
218 av_dict_set(&avctx->metadata, "isoMode", avio_rl32(pb) ? "auto" : "manual", 0);
219 read_uint32(avctx, pb, "isoValue", "%"PRIi32);
220 read_uint32(avctx, pb, "isoAnalog", "%"PRIi32);
221 read_uint32(avctx, pb, "digitalGain", "%"PRIi32);
224 read_uint64(avctx, pb, "shutterValue", "%"PRIi64);
227 } else if (type == MKTAG('S','T','Y','L') && size >= 36) {
228 read_uint32(avctx, pb, "picStyleId", "%"PRIi32);
229 read_uint32(avctx, pb, "contrast", "%"PRIi32);
230 read_uint32(avctx, pb, "sharpness", "%"PRIi32);
231 read_uint32(avctx, pb, "saturation", "%"PRIi32);
232 read_uint32(avctx, pb, "colortone", "%"PRIi32);
233 read_string(avctx, pb, "picStyleName", 16);
235 } else if (type == MKTAG('M','A','R','K')) {
236 } else if (type == MKTAG('N','U','L','L')) {
237 } else if (type == MKTAG('M','L','V','I')) { /* occurs when MLV and Mnn files are concatenated */
239 av_log(avctx, AV_LOG_INFO, "unsupported tag %c%c%c%c, size %d\n", type&0xFF, (type>>8)&0xFF, (type>>16)&0xFF, (type>>24)&0xFF, size);
245 static int read_header(AVFormatContext *avctx)
247 MlvContext *mlv = avctx->priv_data;
248 AVIOContext *pb = avctx->pb;
249 AVStream *vst = NULL, *ast = NULL;
255 size = avio_rl32(pb);
257 return AVERROR_INVALIDDATA;
261 guid = avio_rl64(pb);
262 snprintf(guidstr, sizeof(guidstr), "0x%"PRIx64, guid);
263 av_dict_set(&avctx->metadata, "guid", guidstr, 0);
265 avio_skip(pb, 8); //fileNum, fileCount, fileFlags
267 mlv->class[0] = avio_rl16(pb);
269 vst = avformat_new_stream(avctx, NULL);
271 return AVERROR(ENOMEM);
273 if ((mlv->class[0] & (MLV_CLASS_FLAG_DELTA|MLV_CLASS_FLAG_LZMA)))
274 avpriv_request_sample(avctx, "compression");
275 vst->codec->codec_type = AVMEDIA_TYPE_VIDEO;
276 switch (mlv->class[0] & ~(MLV_CLASS_FLAG_DELTA|MLV_CLASS_FLAG_LZMA)) {
277 case MLV_VIDEO_CLASS_RAW:
278 vst->codec->codec_id = AV_CODEC_ID_RAWVIDEO;
280 case MLV_VIDEO_CLASS_YUV:
281 vst->codec->pix_fmt = AV_PIX_FMT_YUV420P;
282 vst->codec->codec_id = AV_CODEC_ID_RAWVIDEO;
283 vst->codec->codec_tag = 0;
285 case MLV_VIDEO_CLASS_JPEG:
286 vst->codec->codec_id = AV_CODEC_ID_MJPEG;
287 vst->codec->codec_tag = 0;
289 case MLV_VIDEO_CLASS_H264:
290 vst->codec->codec_id = AV_CODEC_ID_H264;
291 vst->codec->codec_tag = 0;
294 avpriv_request_sample(avctx, "unknown video class");
298 mlv->class[1] = avio_rl16(pb);
300 ast = avformat_new_stream(avctx, NULL);
302 return AVERROR(ENOMEM);
304 if ((mlv->class[1] & MLV_CLASS_FLAG_LZMA))
305 avpriv_request_sample(avctx, "compression");
306 if ((mlv->class[1] & ~MLV_CLASS_FLAG_LZMA) != MLV_AUDIO_CLASS_WAV)
307 avpriv_request_sample(avctx, "unknown audio class");
309 ast->codec->codec_type = AVMEDIA_TYPE_AUDIO;
310 avpriv_set_pts_info(ast, 33, 1, ast->codec->sample_rate);
314 vst->nb_frames = avio_rl32(pb);
319 ast->nb_frames = avio_rl32(pb);
324 AVRational framerate;
325 framerate.num = avio_rl32(pb);
326 framerate.den = avio_rl32(pb);
327 avpriv_set_pts_info(vst, 64, framerate.den, framerate.num);
331 avio_skip(pb, size - 52);
333 /* scan primary file */
334 mlv->pb[100] = avctx->pb;
335 scan_file(avctx, vst, ast, 100);
337 /* scan secondary files */
338 if (strlen(avctx->filename) > 2) {
340 char *filename = av_strdup(avctx->filename);
342 return AVERROR(ENOMEM);
343 for (i = 0; i < 100; i++) {
344 snprintf(filename + strlen(filename) - 2, 3, "%02d", i);
345 if (avio_open2(&mlv->pb[i], filename, AVIO_FLAG_READ, &avctx->interrupt_callback, NULL) < 0)
347 if (check_file_header(mlv->pb[i], guid) < 0) {
348 av_log(avctx, AV_LOG_WARNING, "ignoring %s; bad format or guid mismatch\n", filename);
349 avio_close(mlv->pb[i]);
353 av_log(avctx, AV_LOG_INFO, "scanning %s\n", filename);
354 scan_file(avctx, vst, ast, i);
360 vst->duration = vst->nb_index_entries;
362 ast->duration = ast->nb_index_entries;
365 avio_seek(pb, FFMIN(vst->index_entries[0].pos, ast->index_entries[0].pos), SEEK_SET);
367 avio_seek(pb, vst->index_entries[0].pos, SEEK_SET);
369 avio_seek(pb, ast->index_entries[0].pos, SEEK_SET);
374 static int read_packet(AVFormatContext *avctx, AVPacket *pkt)
376 MlvContext *mlv = avctx->priv_data;
378 AVStream *st = avctx->streams[mlv->stream_index];
380 unsigned int size, space;
382 if (mlv->pts >= st->duration)
385 index = av_index_search_timestamp(st, mlv->pts, AVSEEK_FLAG_ANY);
387 av_log(avctx, AV_LOG_ERROR, "could not find index entry for frame %"PRId64"\n", mlv->pts);
391 pb = mlv->pb[st->index_entries[index].size];
392 avio_seek(pb, st->index_entries[index].pos, SEEK_SET);
394 avio_skip(pb, 4); // blockType
395 size = avio_rl32(pb);
397 return AVERROR_INVALIDDATA;
398 avio_skip(pb, 12); //timestamp, frameNumber
399 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
400 avio_skip(pb, 8); // cropPosX, cropPosY, panPosX, panPosY
401 space = avio_rl32(pb);
402 avio_skip(pb, space);
404 if ((mlv->class[st->id] & (MLV_CLASS_FLAG_DELTA|MLV_CLASS_FLAG_LZMA))) {
405 ret = AVERROR_PATCHWELCOME;
406 } else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
407 ret = av_get_packet(pb, pkt, (st->codec->width * st->codec->height * st->codec->bits_per_coded_sample + 7) >> 3);
408 } else { // AVMEDIA_TYPE_AUDIO
409 if (space > UINT_MAX - 24 || size < (24 + space))
410 return AVERROR_INVALIDDATA;
411 ret = av_get_packet(pb, pkt, size - (24 + space));
417 pkt->stream_index = mlv->stream_index;
421 if (mlv->stream_index == avctx->nb_streams) {
422 mlv->stream_index = 0;
428 static int read_seek(AVFormatContext *avctx, int stream_index, int64_t timestamp, int flags)
430 MlvContext *mlv = avctx->priv_data;
432 if ((flags & AVSEEK_FLAG_FRAME) || (flags & AVSEEK_FLAG_BYTE))
433 return AVERROR(ENOSYS);
435 if (!avctx->pb->seekable)
438 mlv->pts = timestamp;
442 static int read_close(AVFormatContext *s)
444 MlvContext *mlv = s->priv_data;
445 av_freep(&mlv->buffer);
449 AVInputFormat ff_mlv_demuxer = {
451 .long_name = NULL_IF_CONFIG_SMALL("Magic Lantern Video (MLV)"),
452 .priv_data_size = sizeof(MlvContext),
454 .read_header = read_header,
455 .read_packet = read_packet,
456 .read_close = read_close,
457 .read_seek = read_seek,