git.sesse.net Git - ffmpeg/blob - libavformat/mlvdec.c

   1 /*
   2  * Magic Lantern Video (MLV) demuxer
   3  * Copyright (c) 2014 Peter Ross
   4  *
   5  * This file is part of FFmpeg.
   6  *
   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.
  11  *
  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.
  16  *
  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
  20  */
  21
  22 /**
  23  * @file
  24  * Magic Lantern Video (MLV) demuxer
  25  */
  26
  27 #include "libavutil/eval.h"
  28 #include "libavutil/imgutils.h"
  29 #include "libavutil/intreadwrite.h"
  30 #include "libavutil/rational.h"
  31 #include "avformat.h"
  32 #include "avio_internal.h"
  33 #include "internal.h"
  34 #include "riff.h"
  35
  36 #define MLV_VERSION "v2.0"
  37
  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
  42
  43 #define MLV_AUDIO_CLASS_WAV  1
  44
  45 #define MLV_CLASS_FLAG_DELTA 0x40
  46 #define MLV_CLASS_FLAG_LZMA  0x80
  47
  48 typedef struct {
  49     AVIOContext *pb[101];
  50     int class[2];
  51     int stream_index;
  52     uint64_t pts;
  53 } MlvContext;
  54
  55 static int probe(const AVProbeData *p)
  56 {
  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;
  61     return 0;
  62 }
  63
  64 static int check_file_header(AVIOContext *pb, uint64_t guid)
  65 {
  66     unsigned int size;
  67     uint8_t version[8];
  68
  69     avio_skip(pb, 4);
  70     size = avio_rl32(pb);
  71     if (size < 52)
  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);
  77     return 0;
  78 }
  79
  80 static void read_string(AVFormatContext *avctx, AVIOContext *pb, const char *tag, unsigned size)
  81 {
  82     char * value = av_malloc(size + 1);
  83     if (!value) {
  84         avio_skip(pb, size);
  85         return;
  86     }
  87
  88     avio_read(pb, value, size);
  89     if (!value[0]) {
  90         av_free(value);
  91         return;
  92     }
  93
  94     value[size] = 0;
  95     av_dict_set(&avctx->metadata, tag, value, AV_DICT_DONT_STRDUP_VAL);
  96 }
  97
  98 static void read_uint8(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
  99 {
 100     av_dict_set_int(&avctx->metadata, tag, avio_r8(pb), 0);
 101 }
 102
 103 static void read_uint16(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
 104 {
 105     av_dict_set_int(&avctx->metadata, tag, avio_rl16(pb), 0);
 106 }
 107
 108 static void read_uint32(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
 109 {
 110     av_dict_set_int(&avctx->metadata, tag, avio_rl32(pb), 0);
 111 }
 112
 113 static void read_uint64(AVFormatContext *avctx, AVIOContext *pb, const char *tag, const char *fmt)
 114 {
 115     av_dict_set_int(&avctx->metadata, tag, avio_rl64(pb), 0);
 116 }
 117
 118 static int scan_file(AVFormatContext *avctx, AVStream *vst, AVStream *ast, int file)
 119 {
 120     MlvContext *mlv = avctx->priv_data;
 121     AVIOContext *pb = mlv->pb[file];
 122     int ret;
 123     while (!avio_feof(pb)) {
 124         int type;
 125         unsigned int size;
 126         type = avio_rl32(pb);
 127         size = avio_rl32(pb);
 128         avio_skip(pb, 8); //timestamp
 129         if (size < 16)
 130             break;
 131         size -= 16;
 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);
 136             if (ret < 0)
 137                 return ret;
 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;
 149             }
 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);
 156             size -= 164;
 157         } else if (ast && type == MKTAG('W', 'A', 'V', 'I') && size >= 16) {
 158             ret = ff_get_wav_header(avctx, pb, ast->codecpar, 16, 0);
 159             if (ret < 0)
 160                 return ret;
 161             size -= 16;
 162         } else if (type == MKTAG('I','N','F','O')) {
 163             if (size > 0)
 164                 read_string(avctx, pb, "info", size);
 165             continue;
 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);
 169             size -= 36;
 170             if (size >= 32) {
 171                 read_string(avctx, pb, "cameraSerial", 32);
 172                 size -= 32;
 173             }
 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);
 183             size -= 48;
 184             if (size >= 32) {
 185                 read_string(avctx, pb, "lensSerial", 32);
 186                 size -= 32;
 187             }
 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);
 192             size -= 4;
 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);
 197             size -= 4;
 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);
 206             size -= 28;
 207         } else if (type == MKTAG('R','T','C','I') && size >= 20) {
 208             char str[32];
 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);
 219             avio_skip(pb, 2);
 220             if (strftime(str, sizeof(str), "%Y-%m-%d %H:%M:%S", &time))
 221                 av_dict_set(&avctx->metadata, "time", str, 0);
 222             size -= 20;
 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);
 228             size -= 16;
 229             if (size >= 8) {
 230                 read_uint64(avctx, pb, "shutterValue", "%"PRIi64);
 231                 size -= 8;
 232             }
 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);
 240             size -= 36;
 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 */
 244         } else {
 245             av_log(avctx, AV_LOG_INFO, "unsupported tag %s, size %u\n",
 246                    av_fourcc2str(type), size);
 247         }
 248         avio_skip(pb, size);
 249     }
 250     return 0;
 251 }
 252
 253 static int read_header(AVFormatContext *avctx)
 254 {
 255     MlvContext *mlv = avctx->priv_data;
 256     AVIOContext *pb = avctx->pb;
 257     AVStream *vst = NULL, *ast = NULL;
 258     int size, ret;
 259     unsigned nb_video_frames, nb_audio_frames;
 260     uint64_t guid;
 261     char guidstr[32];
 262
 263     avio_skip(pb, 4);
 264     size = avio_rl32(pb);
 265     if (size < 52)
 266         return AVERROR_INVALIDDATA;
 267
 268     avio_skip(pb, 8);
 269
 270     guid = avio_rl64(pb);
 271     snprintf(guidstr, sizeof(guidstr), "0x%"PRIx64, guid);
 272     av_dict_set(&avctx->metadata, "guid", guidstr, 0);
 273
 274     avio_skip(pb, 8); //fileNum, fileCount, fileFlags
 275
 276     mlv->class[0] = avio_rl16(pb);
 277     mlv->class[1] = avio_rl16(pb);
 278
 279     nb_video_frames = avio_rl32(pb);
 280     nb_audio_frames = avio_rl32(pb);
 281
 282     if (nb_video_frames && mlv->class[0]) {
 283         vst = avformat_new_stream(avctx, NULL);
 284         if (!vst)
 285             return AVERROR(ENOMEM);
 286         vst->id = 0;
 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;
 294             break;
 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;
 299             break;
 300         case MLV_VIDEO_CLASS_JPEG:
 301             vst->codecpar->codec_id = AV_CODEC_ID_MJPEG;
 302             vst->codecpar->codec_tag = 0;
 303             break;
 304         case MLV_VIDEO_CLASS_H264:
 305             vst->codecpar->codec_id = AV_CODEC_ID_H264;
 306             vst->codecpar->codec_tag = 0;
 307             break;
 308         default:
 309             avpriv_request_sample(avctx, "unknown video class");
 310         }
 311     }
 312
 313     if (nb_audio_frames && mlv->class[1]) {
 314         ast = avformat_new_stream(avctx, NULL);
 315         if (!ast)
 316             return AVERROR(ENOMEM);
 317         ast->id = 1;
 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");
 323
 324         ast->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
 325         avpriv_set_pts_info(ast, 33, 1, ast->codecpar->sample_rate);
 326     }
 327
 328     if (vst) {
 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);
 333     } else
 334        avio_skip(pb, 8);
 335
 336     avio_skip(pb, size - 52);
 337
 338     /* scan primary file */
 339     mlv->pb[100] = avctx->pb;
 340     ret = scan_file(avctx, vst, ast, 100);
 341     if (ret < 0)
 342         return ret;
 343
 344     /* scan secondary files */
 345     if (strlen(avctx->url) > 2) {
 346         int i;
 347         char *filename = av_strdup(avctx->url);
 348
 349         if (!filename)
 350             return AVERROR(ENOMEM);
 351
 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)
 355                 break;
 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]);
 359                 continue;
 360             }
 361             av_log(avctx, AV_LOG_INFO, "scanning %s\n", filename);
 362             ret = scan_file(avctx, vst, ast, i);
 363             if (ret < 0) {
 364                 av_log(avctx, AV_LOG_WARNING, "ignoring %s; %s\n", filename, av_err2str(ret));
 365                 ff_format_io_close(avctx, &mlv->pb[i]);
 366                 continue;
 367             }
 368         }
 369         av_free(filename);
 370     }
 371
 372     if (vst)
 373         vst->duration = vst->nb_index_entries;
 374     if (ast)
 375         ast->duration = ast->nb_index_entries;
 376
 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;
 380     }
 381
 382     if (vst && ast)
 383         avio_seek(pb, FFMIN(vst->index_entries[0].pos, ast->index_entries[0].pos), SEEK_SET);
 384     else if (vst)
 385         avio_seek(pb, vst->index_entries[0].pos, SEEK_SET);
 386     else if (ast)
 387         avio_seek(pb, ast->index_entries[0].pos, SEEK_SET);
 388
 389     return 0;
 390 }
 391
 392 static int read_packet(AVFormatContext *avctx, AVPacket *pkt)
 393 {
 394     MlvContext *mlv = avctx->priv_data;
 395     AVIOContext *pb;
 396     AVStream *st;
 397     int index, ret;
 398     unsigned int size, space;
 399
 400     if (!avctx->nb_streams)
 401         return AVERROR_EOF;
 402
 403     st = avctx->streams[mlv->stream_index];
 404     if (mlv->pts >= st->duration)
 405         return AVERROR_EOF;
 406
 407     index = av_index_search_timestamp(st, mlv->pts, AVSEEK_FLAG_ANY);
 408     if (index < 0) {
 409         av_log(avctx, AV_LOG_ERROR, "could not find index entry for frame %"PRId64"\n", mlv->pts);
 410         return AVERROR(EIO);
 411     }
 412
 413     pb = mlv->pb[st->index_entries[index].size];
 414     avio_seek(pb, st->index_entries[index].pos, SEEK_SET);
 415
 416     avio_skip(pb, 4); // blockType
 417     size = avio_rl32(pb);
 418     if (size < 16)
 419         return AVERROR_INVALIDDATA;
 420     avio_skip(pb, 12); //timestamp, frameNumber
 421     if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)
 422         avio_skip(pb, 8); // cropPosX, cropPosY, panPosX, panPosY
 423     space = avio_rl32(pb);
 424     avio_skip(pb, space);
 425
 426     if ((mlv->class[st->id] & (MLV_CLASS_FLAG_DELTA|MLV_CLASS_FLAG_LZMA))) {
 427         ret = AVERROR_PATCHWELCOME;
 428     } else if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
 429         ret = av_get_packet(pb, pkt, (st->codecpar->width * st->codecpar->height * st->codecpar->bits_per_coded_sample + 7) >> 3);
 430     } else { // AVMEDIA_TYPE_AUDIO
 431         if (space > UINT_MAX - 24 || size < (24 + space))
 432             return AVERROR_INVALIDDATA;
 433         ret = av_get_packet(pb, pkt, size - (24 + space));
 434     }
 435
 436     if (ret < 0)
 437         return ret;
 438
 439     pkt->stream_index = mlv->stream_index;
 440     pkt->pts = mlv->pts;
 441
 442     mlv->stream_index++;
 443     if (mlv->stream_index == avctx->nb_streams) {
 444         mlv->stream_index = 0;
 445         mlv->pts++;
 446     }
 447     return 0;
 448 }
 449
 450 static int read_seek(AVFormatContext *avctx, int stream_index, int64_t timestamp, int flags)
 451 {
 452     MlvContext *mlv = avctx->priv_data;
 453
 454     if ((flags & AVSEEK_FLAG_FRAME) || (flags & AVSEEK_FLAG_BYTE))
 455         return AVERROR(ENOSYS);
 456
 457     if (!(avctx->pb->seekable & AVIO_SEEKABLE_NORMAL))
 458         return AVERROR(EIO);
 459
 460     mlv->pts = timestamp;
 461     return 0;
 462 }
 463
 464 static int read_close(AVFormatContext *s)
 465 {
 466     MlvContext *mlv = s->priv_data;
 467     int i;
 468     for (i = 0; i < 100; i++)
 469         ff_format_io_close(s, &mlv->pb[i]);
 470     return 0;
 471 }
 472
 473 AVInputFormat ff_mlv_demuxer = {
 474     .name           = "mlv",
 475     .long_name      = NULL_IF_CONFIG_SMALL("Magic Lantern Video (MLV)"),
 476     .priv_data_size = sizeof(MlvContext),
 477     .read_probe     = probe,
 478     .read_header    = read_header,
 479     .read_packet    = read_packet,
 480     .read_close     = read_close,
 481     .read_seek      = read_seek,
 482 };