PAF demuxer and decoder

Signed-off-by: Vittorio Giovara <vittorio.giovara@gmail.com>
Signed-off-by: Luca Barbato <lu_zero@gentoo.org>

Changelog

@@ -7,6 +7,7 @@ version <next>:
 - replaygain data export
 - Alias PIX image encoder and decoder
 - BRender PIX image decoder
+- Amazing Studio PAF playback support
 
 
 version 10:

doc/general.texi

@@ -179,6 +179,8 @@ library:
 @item American Laser Games MM   @tab   @tab X
     @tab Multimedia format used in games like Mad Dog McCree.
 @item 3GPP AMR                  @tab X @tab X
+@item Amazing Studio Packed Animation File  @tab   @tab X
+    @tab Multimedia format used in game Heart Of Darkness.
 @item Apple HTTP Live Streaming @tab   @tab X
 @item ASF                       @tab X @tab X
 @item AVI                       @tab X @tab X
@@ -490,6 +492,7 @@ following image formats are supported:
 @item 8SVX fibonacci         @tab     @tab  X
 @item A64 multicolor         @tab  X  @tab
     @tab Creates video suitable to be played on a commodore 64 (multicolor mode).
+@item Amazing Studio PAF Video @tab     @tab  X
 @item American Laser Games MM  @tab    @tab X
     @tab Used in games like Mad Dog McCree.
 @item AMV Video              @tab     @tab  X
@@ -778,6 +781,7 @@ following image formats are supported:
     @tab encoding supported through external library libopencore-amrnb
 @item AMR-WB                 @tab  E  @tab  X
     @tab encoding supported through external library libvo-amrwbenc
+@item Amazing Studio PAF Audio @tab     @tab  X
 @item Apple lossless audio   @tab  X  @tab  X
     @tab QuickTime fourcc 'alac'
 @item ATRAC1                 @tab     @tab  X

libavcodec/Makefile

@@ -275,6 +275,8 @@ OBJS-$(CONFIG_MXPEG_DECODER)           += mxpegdec.o
 OBJS-$(CONFIG_NELLYMOSER_DECODER)      += nellymoserdec.o nellymoser.o
 OBJS-$(CONFIG_NELLYMOSER_ENCODER)      += nellymoserenc.o nellymoser.o
 OBJS-$(CONFIG_NUV_DECODER)             += nuv.o rtjpeg.o
+OBJS-$(CONFIG_PAF_VIDEO_DECODER)       += paf.o
+OBJS-$(CONFIG_PAF_AUDIO_DECODER)       += paf.o
 OBJS-$(CONFIG_PAM_DECODER)             += pnmdec.o pnm.o
 OBJS-$(CONFIG_PAM_ENCODER)             += pamenc.o
 OBJS-$(CONFIG_PBM_DECODER)             += pnmdec.o pnm.o

libavcodec/allcodecs.c

@@ -200,6 +200,7 @@ void avcodec_register_all(void)
     REGISTER_DECODER(MTS2,              mts2);
     REGISTER_DECODER(MXPEG,             mxpeg);
     REGISTER_DECODER(NUV,               nuv);
+    REGISTER_DECODER(PAF_VIDEO,         paf_video);
     REGISTER_ENCDEC (PAM,               pam);
     REGISTER_ENCDEC (PBM,               pbm);
     REGISTER_ENCDEC (PCX,               pcx);
@@ -321,6 +322,7 @@ void avcodec_register_all(void)
     REGISTER_DECODER(MPC7,              mpc7);
     REGISTER_DECODER(MPC8,              mpc8);
     REGISTER_ENCDEC (NELLYMOSER,        nellymoser);
+    REGISTER_DECODER(PAF_AUDIO,         paf_audio);
     REGISTER_DECODER(QCELP,             qcelp);
     REGISTER_DECODER(QDM2,              qdm2);
     REGISTER_ENCDEC (RA_144,            ra_144);

libavcodec/avcodec.h

@@ -286,6 +286,7 @@ enum AVCodecID {
     AV_CODEC_ID_FIC,
     AV_CODEC_ID_ALIAS_PIX,
     AV_CODEC_ID_BRENDER_PIX,
+    AV_CODEC_ID_PAF_VIDEO,
 
     /* various PCM "codecs" */
     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
@@ -434,6 +435,7 @@ enum AVCodecID {
     AV_CODEC_ID_COMFORT_NOISE,
     AV_CODEC_ID_TAK,
     AV_CODEC_ID_METASOUND,
+    AV_CODEC_ID_PAF_AUDIO,
 
     /* subtitle codecs */
     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.

libavcodec/codec_desc.c

@@ -1092,6 +1092,13 @@ static const AVCodecDescriptor codec_descriptors[] = {
         .long_name = NULL_IF_CONFIG_SMALL("Mirillis FIC"),
         .props     = AV_CODEC_PROP_LOSSY,
     },
+    {
+        .id        = AV_CODEC_ID_PAF_VIDEO,
+        .type      = AVMEDIA_TYPE_VIDEO,
+        .name      = "paf_video",
+        .long_name = NULL_IF_CONFIG_SMALL("Amazing Studio Packed Animation File Video"),
+        .props     = AV_CODEC_PROP_LOSSY,
+    },
 
     /* image codecs */
     {
@@ -2221,6 +2228,13 @@ static const AVCodecDescriptor codec_descriptors[] = {
         .long_name = NULL_IF_CONFIG_SMALL("Voxware MetaSound"),
         .props     = AV_CODEC_PROP_LOSSY,
     },
+    {
+        .id        = AV_CODEC_ID_PAF_AUDIO,
+        .type      = AVMEDIA_TYPE_AUDIO,
+        .name      = "paf_audio",
+        .long_name = NULL_IF_CONFIG_SMALL("Amazing Studio Packed Animation File Audio"),
+        .props     = AV_CODEC_PROP_LOSSY,
+    },
 
     /* subtitle codecs */
     {

libavcodec/version.h

@@ -29,7 +29,7 @@
 #include "libavutil/version.h"
 
 #define LIBAVCODEC_VERSION_MAJOR 55
-#define LIBAVCODEC_VERSION_MINOR 38
+#define LIBAVCODEC_VERSION_MINOR 39
 #define LIBAVCODEC_VERSION_MICRO  0
 
 #define LIBAVCODEC_VERSION_INT  AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \

libavformat/Makefile

@@ -226,6 +226,7 @@ OBJS-$(CONFIG_OGG_MUXER)                 += oggenc.o \
                                             vorbiscomment.o
 OBJS-$(CONFIG_OMA_DEMUXER)               += omadec.o pcm.o oma.o
 OBJS-$(CONFIG_OMA_MUXER)                 += omaenc.o rawenc.o oma.o id3v2enc.o
+OBJS-$(CONFIG_PAF_DEMUXER)               += paf.o
 OBJS-$(CONFIG_PCM_ALAW_DEMUXER)          += pcmdec.o pcm.o
 OBJS-$(CONFIG_PCM_ALAW_MUXER)            += pcmenc.o rawenc.o
 OBJS-$(CONFIG_PCM_F32BE_DEMUXER)         += pcmdec.o pcm.o

libavformat/allformats.c

@@ -176,6 +176,7 @@ void av_register_all(void)
     REGISTER_DEMUXER (NUV,              nuv);
     REGISTER_MUXDEMUX(OGG,              ogg);
     REGISTER_MUXDEMUX(OMA,              oma);
+    REGISTER_DEMUXER (PAF,              paf);
     REGISTER_MUXDEMUX(PCM_ALAW,         pcm_alaw);
     REGISTER_MUXDEMUX(PCM_MULAW,        pcm_mulaw);
     REGISTER_MUXDEMUX(PCM_F64BE,        pcm_f64be);

libavformat/paf.c

+/*
+ * Packed Animation File demuxer
+ * Copyright (c) 2012 Paul B Mahol
+ *
+ * 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/channel_layout.h"
+
+#include "avformat.h"
+#include "internal.h"
+
+#define MAGIC "Packed Animation File V1.0\n(c) 1992-96 Amazing Studio\x0a\x1a"
+#define PAF_SOUND_SAMPLES     2205
+#define PAF_SOUND_FRAME_SIZE  ((256 + PAF_SOUND_SAMPLES) * 2)
+
+typedef struct {
+    uint32_t buffer_size;
+    uint32_t frame_blks;
+    uint32_t nb_frames;
+    uint32_t start_offset;
+    uint32_t preload_count;
+    uint32_t max_video_blks;
+    uint32_t max_audio_blks;
+
+    uint32_t current_frame;
+    uint32_t current_frame_count;
+    uint32_t current_frame_block;
+
+    uint32_t *blocks_count_table;
+    uint32_t *frames_offset_table;
+    uint32_t *blocks_offset_table;
+
+    uint8_t  *video_frame;
+    int video_size;
+
+    uint8_t  *audio_frame;
+    uint8_t  *temp_audio_frame;
+    int audio_size;
+
+    int got_audio;
+} PAFDemuxContext;
+
+static int read_probe(AVProbeData *p)
+{
+    if ((p->buf_size >= strlen(MAGIC)) &&
+        !memcmp(p->buf, MAGIC, strlen(MAGIC)))
+        return AVPROBE_SCORE_MAX;
+    return 0;
+}
+
+static int read_close(AVFormatContext *s)
+{
+    PAFDemuxContext *p = s->priv_data;
+
+    av_freep(&p->blocks_count_table);
+    av_freep(&p->frames_offset_table);
+    av_freep(&p->blocks_offset_table);
+    av_freep(&p->video_frame);
+    av_freep(&p->audio_frame);
+    av_freep(&p->temp_audio_frame);
+
+    return 0;
+}
+
+static void read_table(AVFormatContext *s, uint32_t *table, uint32_t count)
+{
+    int i;
+
+    for (i = 0; i < count; i++)
+        table[i] = avio_rl32(s->pb);
+
+    avio_skip(s->pb, 4 * (FFALIGN(count, 512) - count));
+}
+
+static int read_header(AVFormatContext *s)
+{
+    PAFDemuxContext *p  = s->priv_data;
+    AVIOContext     *pb = s->pb;
+    AVStream        *ast, *vst;
+    int ret = 0;
+
+    avio_skip(pb, 132);
+
+    vst = avformat_new_stream(s, 0);
+    if (!vst)
+        return AVERROR(ENOMEM);
+
+    vst->start_time = 0;
+    vst->nb_frames  =
+    vst->duration   =
+    p->nb_frames    = avio_rl32(pb);
+    avio_skip(pb, 4);
+
+    vst->codec->width  = avio_rl32(pb);
+    vst->codec->height = avio_rl32(pb);
+    avio_skip(pb, 4);
+
+    vst->codec->codec_type = AVMEDIA_TYPE_VIDEO;
+    vst->codec->codec_tag  = 0;
+    vst->codec->codec_id   = AV_CODEC_ID_PAF_VIDEO;
+    avpriv_set_pts_info(vst, 64, 1, 10);
+
+    ast = avformat_new_stream(s, 0);
+    if (!ast)
+        return AVERROR(ENOMEM);
+
+    ast->start_time            = 0;
+    ast->codec->codec_type     = AVMEDIA_TYPE_AUDIO;
+    ast->codec->codec_tag      = 0;
+    ast->codec->codec_id       = AV_CODEC_ID_PAF_AUDIO;
+    ast->codec->channels       = 2;
+    ast->codec->channel_layout = AV_CH_LAYOUT_STEREO;
+    ast->codec->sample_rate    = 22050;
+    avpriv_set_pts_info(ast, 64, 1, 22050);
+
+    p->buffer_size    = avio_rl32(pb);
+    p->preload_count  = avio_rl32(pb);
+    p->frame_blks     = avio_rl32(pb);
+    p->start_offset   = avio_rl32(pb);
+    p->max_video_blks = avio_rl32(pb);
+    p->max_audio_blks = avio_rl32(pb);
+    if (p->buffer_size    < 175  ||
+        p->max_audio_blks < 2    ||
+        p->max_video_blks < 1    ||
+        p->frame_blks     < 1    ||
+        p->nb_frames      < 1    ||
+        p->preload_count  < 1    ||
+        p->buffer_size    > 2048 ||
+        p->max_video_blks > 2048 ||
+        p->max_audio_blks > 2048 ||
+        p->nb_frames      > INT_MAX / sizeof(uint32_t) ||
+        p->frame_blks     > INT_MAX / sizeof(uint32_t))
+        return AVERROR_INVALIDDATA;
+
+    p->blocks_count_table  = av_mallocz(p->nb_frames *
+                                        sizeof(*p->blocks_count_table));
+    p->frames_offset_table = av_mallocz(p->nb_frames *
+                                        sizeof(*p->frames_offset_table));
+    p->blocks_offset_table = av_mallocz(p->frame_blks *
+                                        sizeof(*p->blocks_offset_table));
+
+    p->video_size  = p->max_video_blks * p->buffer_size;
+    p->video_frame = av_mallocz(p->video_size);
+
+    p->audio_size       = p->max_audio_blks * p->buffer_size;
+    p->audio_frame      = av_mallocz(p->audio_size);
+    p->temp_audio_frame = av_mallocz(p->audio_size);
+
+    if (!p->blocks_count_table  ||
+        !p->frames_offset_table ||
+        !p->blocks_offset_table ||
+        !p->video_frame         ||
+        !p->audio_frame         ||
+        !p->temp_audio_frame) {
+        ret = AVERROR(ENOMEM);
+        goto fail;
+    }
+
+    avio_seek(pb, p->buffer_size, SEEK_SET);
+
+    read_table(s, p->blocks_count_table,  p->nb_frames);
+    read_table(s, p->frames_offset_table, p->nb_frames);
+    read_table(s, p->blocks_offset_table, p->frame_blks);
+
+    p->got_audio = 0;
+    p->current_frame = 0;
+    p->current_frame_block = 0;
+
+    avio_seek(pb, p->start_offset, SEEK_SET);
+
+    return 0;
+
+fail:
+    read_close(s);
+
+    return ret;
+}
+
+static int read_packet(AVFormatContext *s, AVPacket *pkt)
+{
+    PAFDemuxContext *p  = s->priv_data;
+    AVIOContext     *pb = s->pb;
+    uint32_t count, offset;
+    int size, i;
+
+    if (p->current_frame >= p->nb_frames || pb->eof_reached)
+        return AVERROR_EOF;
+
+    if (p->got_audio) {
+        if (av_new_packet(pkt, p->audio_size) < 0)
+            return AVERROR(ENOMEM);
+
+        memcpy(pkt->data, p->temp_audio_frame, p->audio_size);
+        pkt->duration     = PAF_SOUND_SAMPLES * (p->audio_size / PAF_SOUND_FRAME_SIZE);
+        pkt->flags       |= AV_PKT_FLAG_KEY;
+        pkt->stream_index = 1;
+        p->got_audio      = 0;
+        return pkt->size;
+    }
+
+    count = (p->current_frame == 0) ? p->preload_count
+                                    : p->blocks_count_table[p->current_frame - 1];
+    for (i = 0; i < count; i++) {
+        if (p->current_frame_block >= p->frame_blks)
+            return AVERROR_INVALIDDATA;
+
+        offset = p->blocks_offset_table[p->current_frame_block] & ~(1U << 31);
+        if (p->blocks_offset_table[p->current_frame_block] & (1U << 31)) {
+            if (offset > p->audio_size - p->buffer_size)
+                return AVERROR_INVALIDDATA;
+
+            avio_read(pb, p->audio_frame + offset, p->buffer_size);
+            if (offset == (p->max_audio_blks - 2) * p->buffer_size) {
+                memcpy(p->temp_audio_frame, p->audio_frame, p->audio_size);
+                p->got_audio = 1;
+            }
+        } else {
+            if (offset > p->video_size - p->buffer_size)
+                return AVERROR_INVALIDDATA;
+
+            avio_read(pb, p->video_frame + offset, p->buffer_size);
+        }
+        p->current_frame_block++;
+    }
+
+    if (p->frames_offset_table[p->current_frame] >= p->video_size)
+        return AVERROR_INVALIDDATA;
+
+    size = p->video_size - p->frames_offset_table[p->current_frame];
+
+    if (av_new_packet(pkt, size) < 0)
+        return AVERROR(ENOMEM);
+
+    pkt->stream_index = 0;
+    pkt->duration     = 1;
+    memcpy(pkt->data, p->video_frame + p->frames_offset_table[p->current_frame], size);
+    if (pkt->data[0] & 0x20)
+        pkt->flags |= AV_PKT_FLAG_KEY;
+    p->current_frame++;
+
+    return pkt->size;
+}
+
+AVInputFormat ff_paf_demuxer = {
+    .name           = "paf",
+    .long_name      = NULL_IF_CONFIG_SMALL("Amazing Studio Packed Animation File"),
+    .priv_data_size = sizeof(PAFDemuxContext),
+    .read_probe     = read_probe,
+    .read_header    = read_header,
+    .read_packet    = read_packet,
+    .read_close     = read_close,
+};

libavformat/version.h

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