HNM4/HNM4A demuxer & video decoder

Signed-off-by: Diego Biurrun <diego@biurrun.de>

Changelog

@@ -40,6 +40,7 @@ version 10:
 - Opus in Ogg demuxing
 - Enhanced Low Delay AAC (ER AAC ELD) decoding (no LD SBR support)
 - F4V muxer
+- HNM version 4 demuxer and video decoder
 
 
 version 9:

doc/general.texi

@@ -194,6 +194,8 @@ library:
 @item GXF                       @tab X @tab X
     @tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley
          playout servers.
+@item HNM @tab   @tab X
+    @tab Only version 4 supported, used in some games from Cryo Interactive
 @item id Quake II CIN video     @tab   @tab X
 @item id RoQ                    @tab X @tab X
     @tab Used in Quake III, Jedi Knight 2, other computer games.
@@ -524,6 +526,7 @@ following image formats are supported:
 @item H.263+ / H.263-1998 / H.263 version 2  @tab  X  @tab  X
 @item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10  @tab  E  @tab  X
     @tab encoding supported through external library libx264
+@item HNM version 4          @tab     @tab  X
 @item HuffYUV                @tab  X  @tab  X
 @item HuffYUV FFmpeg variant @tab  X  @tab  X
 @item IBM Ultimotion         @tab     @tab  X

libavcodec/Makefile

@@ -196,6 +196,7 @@ OBJS-$(CONFIG_H264_DECODER)            += h264.o                               \
                                           h264_loopfilter.o h264_direct.o      \
                                           cabac.o h264_sei.o h264_ps.o         \
                                           h264_refs.o h264_cavlc.o h264_cabac.o
+OBJS-$(CONFIG_HNM4_VIDEO_DECODER)      += hnm4video.o
 OBJS-$(CONFIG_HUFFYUV_DECODER)         += huffyuv.o huffyuvdec.o
 OBJS-$(CONFIG_HUFFYUV_ENCODER)         += huffyuv.o huffyuvenc.o
 OBJS-$(CONFIG_IAC_DECODER)             += imc.o

libavcodec/allcodecs.c

@@ -153,6 +153,7 @@ void avcodec_register_all(void)
     REGISTER_DECODER(H263I,             h263i);
     REGISTER_ENCODER(H263P,             h263p);
     REGISTER_DECODER(H264,              h264);
+    REGISTER_DECODER(HNM4_VIDEO,        hnm4_video);
     REGISTER_ENCDEC (HUFFYUV,           huffyuv);
     REGISTER_DECODER(IDCIN,             idcin);
     REGISTER_DECODER(IFF_BYTERUN1,      iff_byterun1);

libavcodec/avcodec.h

@@ -274,6 +274,7 @@ enum AVCodecID {
     AV_CODEC_ID_ESCAPE130,
     AV_CODEC_ID_G2M,
     AV_CODEC_ID_WEBP,
+    AV_CODEC_ID_HNM4_VIDEO,
 
     /* various PCM "codecs" */
     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs

libavcodec/codec_desc.c

@@ -1236,6 +1236,13 @@ static const AVCodecDescriptor codec_descriptors[] = {
         .props     = AV_CODEC_PROP_INTRA_ONLY | AV_CODEC_PROP_LOSSY |
                      AV_CODEC_PROP_LOSSLESS,
     },
+    {
+        .id        = AV_CODEC_ID_HNM4_VIDEO,
+        .type      = AVMEDIA_TYPE_VIDEO,
+        .name      = "hnm4video",
+        .long_name = NULL_IF_CONFIG_SMALL("HNM 4 video"),
+        .props     = AV_CODEC_PROP_LOSSY,
+    },
 
     /* various PCM "codecs" */
     {

libavcodec/version.h

@@ -27,7 +27,7 @@
  */
 
 #define LIBAVCODEC_VERSION_MAJOR 55
-#define LIBAVCODEC_VERSION_MINOR 22
+#define LIBAVCODEC_VERSION_MINOR 23
 #define LIBAVCODEC_VERSION_MICRO  0
 
 #define LIBAVCODEC_VERSION_INT  AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \

libavformat/Makefile

@@ -142,6 +142,7 @@ OBJS-$(CONFIG_H264_DEMUXER)              += h264dec.o rawdec.o
 OBJS-$(CONFIG_H264_MUXER)                += rawenc.o
 OBJS-$(CONFIG_HLS_DEMUXER)               += hls.o
 OBJS-$(CONFIG_HLS_MUXER)                 += hlsenc.o
+OBJS-$(CONFIG_HNM_DEMUXER)               += hnm.o
 OBJS-$(CONFIG_IDCIN_DEMUXER)             += idcin.o
 OBJS-$(CONFIG_IFF_DEMUXER)               += iff.o
 OBJS-$(CONFIG_ILBC_DEMUXER)              += ilbc.o

libavformat/allformats.c

@@ -118,6 +118,7 @@ void av_register_all(void)
     REGISTER_MUXDEMUX(H263,             h263);
     REGISTER_MUXDEMUX(H264,             h264);
     REGISTER_MUXDEMUX(HLS,              hls);
+    REGISTER_DEMUXER (HNM,              hnm);
     REGISTER_DEMUXER (IDCIN,            idcin);
     REGISTER_DEMUXER (IFF,              iff);
     REGISTER_MUXDEMUX(ILBC,             ilbc);

libavformat/hnm.c

+/*
+ * Cryo Interactive Entertainment HNM4 demuxer
+ *
+ * Copyright (c) 2012 David Kment
+ *
+ * This file is part of Libav.
+ *
+ * Libav 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.
+ *
+ * Libav 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 Libav; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#include "libavutil/intreadwrite.h"
+#include "avformat.h"
+#include "internal.h"
+
+#define HNM4_TAG MKTAG('H', 'N', 'M', '4')
+
+#define HNM4_SAMPLE_RATE 22050
+#define HNM4_FRAME_FPS 24
+
+#define HNM4_CHUNK_ID_PL 19536
+#define HNM4_CHUNK_ID_IZ 23113
+#define HNM4_CHUNK_ID_IU 21833
+#define HNM4_CHUNK_ID_SD 17491
+
+typedef struct Hnm4DemuxContext {
+    uint8_t version;
+    uint16_t width;
+    uint16_t height;
+    uint32_t filesize;
+    uint32_t frames;
+    uint32_t taboffset;
+    uint16_t bits;
+    uint16_t channels;
+    uint32_t framesize;
+    uint32_t currentframe;
+    int64_t pts;
+    uint32_t superchunk_remaining;
+    AVPacket vpkt;
+} Hnm4DemuxContext;
+
+static int hnm_probe(AVProbeData *p)
+{
+    if (p->buf_size < 4)
+        return 0;
+
+    // check for HNM4 header.
+    // currently only HNM v4/v4A is supported
+    if (AV_RL32(&p->buf[0]) == HNM4_TAG)
+        return AVPROBE_SCORE_MAX;
+
+    return 0;
+}
+
+static int hnm_read_header(AVFormatContext *s)
+{
+    Hnm4DemuxContext *hnm = s->priv_data;
+    AVIOContext *pb = s->pb;
+    AVStream *vst;
+
+    /* default context members */
+    hnm->pts = 0;
+    av_init_packet(&hnm->vpkt);
+    hnm->vpkt.data = NULL;
+    hnm->vpkt.size = 0;
+
+    hnm->superchunk_remaining = 0;
+
+    avio_skip(pb, 8);
+    hnm->width     = avio_rl16(pb);
+    hnm->height    = avio_rl16(pb);
+    hnm->filesize  = avio_rl32(pb);
+    hnm->frames    = avio_rl32(pb);
+    hnm->taboffset = avio_rl32(pb);
+    hnm->bits      = avio_rl16(pb);
+    hnm->channels  = avio_rl16(pb);
+    hnm->framesize = avio_rl32(pb);
+    avio_skip(pb, 32);
+
+    hnm->currentframe = 0;
+
+    if (hnm->width  < 320 || hnm->width  > 640 ||
+        hnm->height < 150 || hnm->height > 480) {
+        av_log(s, AV_LOG_ERROR,
+               "invalid resolution: %ux%u\n", hnm->width, hnm->height);
+        return AVERROR_INVALIDDATA;
+    }
+
+    // TODO: find a better way to detect HNM4A
+    if (hnm->width == 640)
+        hnm->version = 0x4a;
+    else
+        hnm->version = 0x40;
+
+    if (!(vst = avformat_new_stream(s, NULL)))
+        return AVERROR(ENOMEM);
+
+    vst->codec->codec_type = AVMEDIA_TYPE_VIDEO;
+    vst->codec->codec_id   = AV_CODEC_ID_HNM4_VIDEO;
+    vst->codec->codec_tag  = 0;
+    vst->codec->width      = hnm->width;
+    vst->codec->height     = hnm->height;
+    vst->codec->extradata  = av_mallocz(1);
+
+    vst->codec->extradata_size = 1;
+    memcpy(vst->codec->extradata, &hnm->version, 1);
+
+    vst->start_time = 0;
+
+    avpriv_set_pts_info(vst, 33, 1, HNM4_FRAME_FPS);
+
+    return 0;
+}
+
+static int hnm_read_packet(AVFormatContext *s, AVPacket *pkt)
+{
+    Hnm4DemuxContext *hnm = s->priv_data;
+    AVIOContext *pb = s->pb;
+    int ret = 0;
+
+    uint32_t superchunk_size, chunk_size;
+    uint16_t chunk_id;
+
+    if (hnm->currentframe == hnm->frames || pb->eof_reached)
+        return AVERROR_EOF;
+
+    if (hnm->superchunk_remaining == 0) {
+        /* parse next superchunk */
+        superchunk_size = avio_rl24(pb);
+        avio_skip(pb, 1);
+
+        hnm->superchunk_remaining = superchunk_size - 4;
+    }
+
+    chunk_size = avio_rl24(pb);
+    avio_skip(pb, 1);
+    chunk_id = avio_rl16(pb);
+    avio_skip(pb, 2);
+
+    if (chunk_size > hnm->superchunk_remaining) {
+        av_log(s, AV_LOG_ERROR, "invalid chunk size: %u, offset: %u\n",
+               chunk_size, (int) avio_tell(pb));
+        avio_skip(pb, hnm->superchunk_remaining - 8);
+        hnm->superchunk_remaining = 0;
+    }
+
+    switch (chunk_id) {
+    case HNM4_CHUNK_ID_PL:
+    case HNM4_CHUNK_ID_IZ:
+    case HNM4_CHUNK_ID_IU:
+        avio_seek(pb, -8, SEEK_CUR);
+        ret += av_get_packet(pb, pkt, chunk_size);
+        hnm->superchunk_remaining -= chunk_size;
+        if (chunk_id == HNM4_CHUNK_ID_IZ || chunk_id == HNM4_CHUNK_ID_IU)
+            hnm->currentframe++;
+        break;
+
+    case HNM4_CHUNK_ID_SD:
+        avio_skip(pb, chunk_size - 8);
+        hnm->superchunk_remaining -= chunk_size;
+        break;
+
+    default:
+        av_log(s, AV_LOG_WARNING, "unknown chunk found: %d, offset: %d\n",
+               chunk_id, (int) avio_tell(pb));
+        avio_skip(pb, chunk_size - 8);
+        hnm->superchunk_remaining -= chunk_size;
+        break;
+    }
+
+    return ret;
+}
+
+static int hnm_read_close(AVFormatContext *s)
+{
+    Hnm4DemuxContext *hnm = s->priv_data;
+
+    if (hnm->vpkt.size > 0)
+        av_free_packet(&hnm->vpkt);
+
+    return 0;
+}
+
+AVInputFormat ff_hnm_demuxer = {
+    .name           = "hnm",
+    .long_name      = NULL_IF_CONFIG_SMALL("Cryo HNM v4"),
+    .priv_data_size = sizeof(Hnm4DemuxContext),
+    .read_probe     = hnm_probe,
+    .read_header    = hnm_read_header,
+    .read_packet    = hnm_read_packet,
+    .read_close     = hnm_read_close,
+    .flags          = AVFMT_NO_BYTE_SEEK | AVFMT_NOGENSEARCH | AVFMT_NOBINSEARCH
+};

libavformat/version.h

@@ -30,7 +30,7 @@
 #include "libavutil/avutil.h"
 
 #define LIBAVFORMAT_VERSION_MAJOR 55
-#define LIBAVFORMAT_VERSION_MINOR  7
+#define LIBAVFORMAT_VERSION_MINOR  8
 #define LIBAVFORMAT_VERSION_MICRO  0
 
 #define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \