libavformat/mlvdec.c
ab683efb
 /*
  * Magic Lantern Video (MLV) demuxer
  * Copyright (c) 2014 Peter Ross
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
  * @file
  * Magic Lantern Video (MLV) demuxer
  */
 
 #include "libavutil/eval.h"
 #include "libavutil/intreadwrite.h"
 #include "libavutil/rational.h"
 #include "avformat.h"
62a1e003
 #include "avio_internal.h"
ab683efb
 #include "internal.h"
 #include "riff.h"
 
 #define MLV_VERSION "v2.0"
 
 #define MLV_VIDEO_CLASS_RAW  1
 #define MLV_VIDEO_CLASS_YUV  2
 #define MLV_VIDEO_CLASS_JPEG 3
 #define MLV_VIDEO_CLASS_H264 4
 
 #define MLV_AUDIO_CLASS_WAV  1
 
 #define MLV_CLASS_FLAG_DELTA 0x40
 #define MLV_CLASS_FLAG_LZMA  0x80
 
 typedef struct {
     AVIOContext *pb[101];
     int class[2];
     int stream_index;
     uint64_t pts;
 } MlvContext;
 
 static int probe(AVProbeData *p)
 {
     if (AV_RL32(p->buf) == MKTAG('M','L','V','I') &&
         AV_RL32(p->buf + 4) >= 52 &&
         !memcmp(p->buf + 8, MLV_VERSION, 5))
         return AVPROBE_SCORE_MAX;
     return 0;
 }
 
 static int check_file_header(AVIOContext *pb, uint64_t guid)
 {
     unsigned int size;
     uint8_t version[8];
 
     avio_skip(pb, 4);
     size = avio_rl32(pb);
     if (size < 52)
         return AVERROR_INVALIDDATA;
     avio_read(pb, version, 8);
     if (memcmp(version, MLV_VERSION, 5) || avio_rl64(pb) != guid)
         return AVERROR_INVALIDDATA;
     avio_skip(pb, size - 24);
     return 0;
 }
 
 static void read_string(AVFormatContext *avctx, AVIOContext *pb, const char *tag, int size)
 {
     char * value = av_malloc(size + 1);
     if (!value) {
         avio_skip(pb, size);
         return;
     }
 
     avio_read(pb, value, size);
     if (!value[0]) {
         av_free(value);
         return;
     }
 
     value[size] = 0;
     av_dict_set(&avctx->metadata, tag, value, AV_DICT_DONT_STRDUP_VAL);
 }
 
 static void read_uint8(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
 {
a0941c8a
     av_dict_set_int(&avctx->metadata, tag, avio_r8(pb), 0);
ab683efb
 }
 
 static void read_uint16(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
 {
a0941c8a
     av_dict_set_int(&avctx->metadata, tag, avio_rl16(pb), 0);
ab683efb
 }
 
 static void read_uint32(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
 {
a0941c8a
     av_dict_set_int(&avctx->metadata, tag, avio_rl32(pb), 0);
ab683efb
 }
 
 static void read_uint64(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
 {
a0941c8a
     av_dict_set_int(&avctx->metadata, tag, avio_rl64(pb), 0);
ab683efb
 }
 
bdab0c2d
 static int scan_file(AVFormatContext *avctx, AVStream *vst, AVStream *ast, int file)
ab683efb
 {
     MlvContext *mlv = avctx->priv_data;
     AVIOContext *pb = mlv->pb[file];
bdab0c2d
     int ret;
d34ec64a
     while (!avio_feof(pb)) {
ab683efb
         int type;
         unsigned int size;
         type = avio_rl32(pb);
         size = avio_rl32(pb);
         avio_skip(pb, 8); //timestamp
         if (size < 16)
             break;
         size -= 16;
         if (vst && type == MKTAG('R','A','W','I') && size >= 164) {
             vst->codec->width  = avio_rl16(pb);
             vst->codec->height = avio_rl16(pb);
             if (avio_rl32(pb) != 1)
                 avpriv_request_sample(avctx, "raw api version");
             avio_skip(pb, 20); // pointer, width, height, pitch, frame_size
             vst->codec->bits_per_coded_sample = avio_rl32(pb);
             avio_skip(pb, 8 + 16 + 24); // black_level, white_level, xywh, active_area, exposure_bias
             if (avio_rl32(pb) != 0x2010100) /* RGGB */
                 avpriv_request_sample(avctx, "cfa_pattern");
             avio_skip(pb, 80); // calibration_illuminant1, color_matrix1, dynamic_range
             vst->codec->pix_fmt  = AV_PIX_FMT_BAYER_RGGB16LE;
             vst->codec->codec_tag = MKTAG('B', 'I', 'T', 16);
             size -= 164;
         } else if (ast && type == MKTAG('W', 'A', 'V', 'I') && size >= 16) {
ba77fb61
             ret = ff_get_wav_header(avctx, pb, ast->codec, 16, 0);
bdab0c2d
             if (ret < 0)
                 return ret;
ab683efb
             size -= 16;
         } else if (type == MKTAG('I','N','F','O')) {
             if (size > 0)
                 read_string(avctx, pb, "info", size);
             continue;
         } else if (type == MKTAG('I','D','N','T') && size >= 36) {
             read_string(avctx, pb, "cameraName", 32);
             read_uint32(avctx, pb, "cameraModel", "0x%"PRIx32);
             size -= 36;
             if (size >= 32) {
                 read_string(avctx, pb, "cameraSerial", 32);
                 size -= 32;
             }
         } else if (type == MKTAG('L','E','N','S') && size >= 48) {
             read_uint16(avctx, pb, "focalLength", "%i");
             read_uint16(avctx, pb, "focalDist", "%i");
             read_uint16(avctx, pb, "aperture", "%i");
             read_uint8(avctx, pb, "stabilizerMode", "%i");
             read_uint8(avctx, pb, "autofocusMode", "%i");
             read_uint32(avctx, pb, "flags", "0x%"PRIx32);
             read_uint32(avctx, pb, "lensID", "%"PRIi32);
             read_string(avctx, pb, "lensName", 32);
             size -= 48;
             if (size >= 32) {
                 read_string(avctx, pb, "lensSerial", 32);
                 size -= 32;
             }
         } else if (vst && type == MKTAG('V', 'I', 'D', 'F') && size >= 4) {
             uint64_t pts = avio_rl32(pb);
             ff_add_index_entry(&vst->index_entries, &vst->nb_index_entries, &vst->index_entries_allocated_size,
                                avio_tell(pb) - 20, pts, file, 0, AVINDEX_KEYFRAME);
             size -= 4;
         } else if (ast && type == MKTAG('A', 'U', 'D', 'F') && size >= 4) {
             uint64_t pts = avio_rl32(pb);
             ff_add_index_entry(&ast->index_entries, &ast->nb_index_entries, &ast->index_entries_allocated_size,
                                avio_tell(pb) - 20, pts, file, 0, AVINDEX_KEYFRAME);
             size -= 4;
         } else if (vst && type == MKTAG('W','B','A','L') && size >= 28) {
             read_uint32(avctx, pb, "wb_mode", "%"PRIi32);
             read_uint32(avctx, pb, "kelvin", "%"PRIi32);
             read_uint32(avctx, pb, "wbgain_r", "%"PRIi32);
             read_uint32(avctx, pb, "wbgain_g", "%"PRIi32);
             read_uint32(avctx, pb, "wbgain_b", "%"PRIi32);
             read_uint32(avctx, pb, "wbs_gm", "%"PRIi32);
             read_uint32(avctx, pb, "wbs_ba", "%"PRIi32);
             size -= 28;
         } else if (type == MKTAG('R','T','C','I') && size >= 20) {
             char str[32];
             struct tm time = { 0 };
             time.tm_sec    = avio_rl16(pb);
             time.tm_min    = avio_rl16(pb);
             time.tm_hour   = avio_rl16(pb);
             time.tm_mday   = avio_rl16(pb);
             time.tm_mon    = avio_rl16(pb);
             time.tm_year   = avio_rl16(pb);
             time.tm_wday   = avio_rl16(pb);
             time.tm_yday   = avio_rl16(pb);
             time.tm_isdst  = avio_rl16(pb);
             avio_skip(pb, 2);
a9564e85
             if (strftime(str, sizeof(str), "%Y-%m-%d %H:%M:%S", &time))
                 av_dict_set(&avctx->metadata, "time", str, 0);
ab683efb
             size -= 20;
         } else if (type == MKTAG('E','X','P','O') && size >= 16) {
             av_dict_set(&avctx->metadata, "isoMode", avio_rl32(pb) ? "auto" : "manual", 0);
             read_uint32(avctx, pb, "isoValue", "%"PRIi32);
             read_uint32(avctx, pb, "isoAnalog", "%"PRIi32);
             read_uint32(avctx, pb, "digitalGain", "%"PRIi32);
             size -= 16;
             if (size >= 8) {
                 read_uint64(avctx, pb, "shutterValue", "%"PRIi64);
                 size -= 8;
             }
         } else if (type == MKTAG('S','T','Y','L') && size >= 36) {
             read_uint32(avctx, pb, "picStyleId", "%"PRIi32);
             read_uint32(avctx, pb, "contrast", "%"PRIi32);
             read_uint32(avctx, pb, "sharpness", "%"PRIi32);
             read_uint32(avctx, pb, "saturation", "%"PRIi32);
             read_uint32(avctx, pb, "colortone", "%"PRIi32);
             read_string(avctx, pb, "picStyleName", 16);
             size -= 36;
         } else if (type == MKTAG('M','A','R','K')) {
         } else if (type == MKTAG('N','U','L','L')) {
         } else if (type == MKTAG('M','L','V','I')) { /* occurs when MLV and Mnn files are concatenated */
         } else {
9abf08f7
             av_log(avctx, AV_LOG_INFO, "unsupported tag %c%c%c%c, size %u\n", type&0xFF, (type>>8)&0xFF, (type>>16)&0xFF, (type>>24)&0xFF, size);
ab683efb
         }
         avio_skip(pb, size);
     }
bdab0c2d
     return 0;
ab683efb
 }
 
 static int read_header(AVFormatContext *avctx)
 {
     MlvContext *mlv = avctx->priv_data;
     AVIOContext *pb = avctx->pb;
     AVStream *vst = NULL, *ast = NULL;
bdab0c2d
     int size, ret;
ac923ed4
     unsigned nb_video_frames, nb_audio_frames;
ab683efb
     uint64_t guid;
     char guidstr[32];
 
     avio_skip(pb, 4);
     size = avio_rl32(pb);
     if (size < 52)
         return AVERROR_INVALIDDATA;
 
     avio_skip(pb, 8);
 
     guid = avio_rl64(pb);
     snprintf(guidstr, sizeof(guidstr), "0x%"PRIx64, guid);
     av_dict_set(&avctx->metadata, "guid", guidstr, 0);
 
     avio_skip(pb, 8); //fileNum, fileCount, fileFlags
 
     mlv->class[0] = avio_rl16(pb);
ac923ed4
     mlv->class[1] = avio_rl16(pb);
 
     nb_video_frames = avio_rl32(pb);
     nb_audio_frames = avio_rl32(pb);
 
     if (nb_video_frames && mlv->class[0]) {
ab683efb
         vst = avformat_new_stream(avctx, NULL);
         if (!vst)
             return AVERROR(ENOMEM);
         vst->id = 0;
ac923ed4
         vst->nb_frames = nb_video_frames;
ab683efb
         if ((mlv->class[0] & (MLV_CLASS_FLAG_DELTA|MLV_CLASS_FLAG_LZMA)))
             avpriv_request_sample(avctx, "compression");
         vst->codec->codec_type = AVMEDIA_TYPE_VIDEO;
         switch (mlv->class[0] & ~(MLV_CLASS_FLAG_DELTA|MLV_CLASS_FLAG_LZMA)) {
         case MLV_VIDEO_CLASS_RAW:
             vst->codec->codec_id = AV_CODEC_ID_RAWVIDEO;
             break;
         case MLV_VIDEO_CLASS_YUV:
             vst->codec->pix_fmt  = AV_PIX_FMT_YUV420P;
             vst->codec->codec_id = AV_CODEC_ID_RAWVIDEO;
             vst->codec->codec_tag = 0;
             break;
         case MLV_VIDEO_CLASS_JPEG:
             vst->codec->codec_id = AV_CODEC_ID_MJPEG;
             vst->codec->codec_tag = 0;
             break;
         case MLV_VIDEO_CLASS_H264:
             vst->codec->codec_id = AV_CODEC_ID_H264;
             vst->codec->codec_tag = 0;
             break;
         default:
             avpriv_request_sample(avctx, "unknown video class");
         }
     }
 
ac923ed4
     if (nb_audio_frames && mlv->class[1]) {
ab683efb
         ast = avformat_new_stream(avctx, NULL);
         if (!ast)
             return AVERROR(ENOMEM);
         ast->id = 1;
ac923ed4
         ast->nb_frames = nb_audio_frames;
ab683efb
         if ((mlv->class[1] & MLV_CLASS_FLAG_LZMA))
             avpriv_request_sample(avctx, "compression");
         if ((mlv->class[1] & ~MLV_CLASS_FLAG_LZMA) != MLV_AUDIO_CLASS_WAV)
             avpriv_request_sample(avctx, "unknown audio class");
 
         ast->codec->codec_type = AVMEDIA_TYPE_AUDIO;
         avpriv_set_pts_info(ast, 33, 1, ast->codec->sample_rate);
     }
 
     if (vst) {
        AVRational framerate;
        framerate.num = avio_rl32(pb);
        framerate.den = avio_rl32(pb);
        avpriv_set_pts_info(vst, 64, framerate.den, framerate.num);
     } else
        avio_skip(pb, 8);
 
     avio_skip(pb, size - 52);
 
     /* scan primary file */
     mlv->pb[100] = avctx->pb;
bdab0c2d
     ret = scan_file(avctx, vst, ast, 100);
     if (ret < 0)
         return ret;
ab683efb
 
     /* scan secondary files */
     if (strlen(avctx->filename) > 2) {
         int i;
         char *filename = av_strdup(avctx->filename);
62a1e003
         AVOpenCallback open_func = avctx->open_cb;
 
ab683efb
         if (!filename)
             return AVERROR(ENOMEM);
62a1e003
 
         if (!open_func)
             open_func = ffio_open2_wrapper;
 
ab683efb
         for (i = 0; i < 100; i++) {
             snprintf(filename + strlen(filename) - 2, 3, "%02d", i);
62a1e003
             if (open_func(avctx, &mlv->pb[i], filename, AVIO_FLAG_READ, &avctx->interrupt_callback, NULL) < 0)
ab683efb
                 break;
             if (check_file_header(mlv->pb[i], guid) < 0) {
                 av_log(avctx, AV_LOG_WARNING, "ignoring %s; bad format or guid mismatch\n", filename);
edeaf6f3
                 avio_closep(&mlv->pb[i]);
ab683efb
                 continue;
             }
             av_log(avctx, AV_LOG_INFO, "scanning %s\n", filename);
bdab0c2d
             ret = scan_file(avctx, vst, ast, i);
             if (ret < 0) {
                 av_log(avctx, AV_LOG_WARNING, "ignoring %s; %s\n", filename, av_err2str(ret));
edeaf6f3
                 avio_closep(&mlv->pb[i]);
bdab0c2d
                 continue;
             }
ab683efb
         }
         av_free(filename);
     }
 
     if (vst)
         vst->duration = vst->nb_index_entries;
     if (ast)
         ast->duration = ast->nb_index_entries;
 
63ecbb82
     if ((vst && !vst->nb_index_entries) || (ast && !ast->nb_index_entries)) {
         av_log(avctx, AV_LOG_ERROR, "no index entries found\n");
         return AVERROR_INVALIDDATA;
     }
 
ab683efb
     if (vst && ast)
         avio_seek(pb, FFMIN(vst->index_entries[0].pos, ast->index_entries[0].pos), SEEK_SET);
     else if (vst)
         avio_seek(pb, vst->index_entries[0].pos, SEEK_SET);
     else if (ast)
         avio_seek(pb, ast->index_entries[0].pos, SEEK_SET);
 
     return 0;
 }
 
 static int read_packet(AVFormatContext *avctx, AVPacket *pkt)
 {
     MlvContext *mlv = avctx->priv_data;
     AVIOContext *pb;
     AVStream *st = avctx->streams[mlv->stream_index];
     int index, ret;
     unsigned int size, space;
 
     if (mlv->pts >= st->duration)
         return AVERROR_EOF;
 
     index = av_index_search_timestamp(st, mlv->pts, AVSEEK_FLAG_ANY);
     if (index < 0) {
         av_log(avctx, AV_LOG_ERROR, "could not find index entry for frame %"PRId64"\n", mlv->pts);
         return AVERROR(EIO);
     }
 
     pb = mlv->pb[st->index_entries[index].size];
     avio_seek(pb, st->index_entries[index].pos, SEEK_SET);
 
     avio_skip(pb, 4); // blockType
     size = avio_rl32(pb);
     if (size < 16)
         return AVERROR_INVALIDDATA;
     avio_skip(pb, 12); //timestamp, frameNumber
     if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
         avio_skip(pb, 8); // cropPosX, cropPosY, panPosX, panPosY
     space = avio_rl32(pb);
     avio_skip(pb, space);
 
     if ((mlv->class[st->id] & (MLV_CLASS_FLAG_DELTA|MLV_CLASS_FLAG_LZMA))) {
         ret = AVERROR_PATCHWELCOME;
     } else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
         ret = av_get_packet(pb, pkt, (st->codec->width * st->codec->height * st->codec->bits_per_coded_sample + 7) >> 3);
     } else { // AVMEDIA_TYPE_AUDIO
         if (space > UINT_MAX - 24 || size < (24 + space))
             return AVERROR_INVALIDDATA;
         ret = av_get_packet(pb, pkt, size - (24 + space));
     }
 
     if (ret < 0)
         return ret;
 
     pkt->stream_index = mlv->stream_index;
     pkt->pts = mlv->pts;
 
     mlv->stream_index++;
     if (mlv->stream_index == avctx->nb_streams) {
         mlv->stream_index = 0;
         mlv->pts++;
     }
     return 0;
 }
 
 static int read_seek(AVFormatContext *avctx, int stream_index, int64_t timestamp, int flags)
 {
     MlvContext *mlv = avctx->priv_data;
 
     if ((flags & AVSEEK_FLAG_FRAME) || (flags & AVSEEK_FLAG_BYTE))
         return AVERROR(ENOSYS);
 
     if (!avctx->pb->seekable)
         return AVERROR(EIO);
 
     mlv->pts = timestamp;
     return 0;
 }
 
 static int read_close(AVFormatContext *s)
 {
     MlvContext *mlv = s->priv_data;
b3c0d010
     int i;
     for (i = 0; i < 100; i++)
         if (mlv->pb[i])
d1d8f866
             avio_closep(&mlv->pb[i]);
ab683efb
     return 0;
 }
 
 AVInputFormat ff_mlv_demuxer = {
     .name           = "mlv",
     .long_name      = NULL_IF_CONFIG_SMALL("Magic Lantern Video (MLV)"),
     .priv_data_size = sizeof(MlvContext),
     .read_probe     = probe,
     .read_header    = read_header,
     .read_packet    = read_packet,
     .read_close     = read_close,
     .read_seek      = read_seek,
 };