bmp: Rewrote the RLE decompressor

[deark.git] / modules / asf.c

// This file is part of Deark.
// Copyright (C) 2018 Jason Summers
// See the file COPYING for terms of use.

// Microsoft ASF

#include <deark-config.h>
#include <deark-private.h>
#include <deark-fmtutil.h>
DE_DECLARE_MODULE(de_module_asf);

#define SID_ECD          210
#define SID_METADATA     307
#define SID_METADATALIB  308

typedef struct localctx_struct {
        int reserved;
} lctx;

struct uuid_info;

struct handler_params {
        i64 objpos;
        i64 objlen;
        i64 dpos;
        i64 dlen;
        int level;
        const struct uuid_info *uui;
};
typedef void (*handler_fn_type)(deark *c, lctx *d, struct handler_params *hp);

struct uuid_info {
        u32 short_id;
        u32 flags;
        const u8 uuid[16];
        const char *name;
        handler_fn_type hfn;
};

static const char *get_uuid_name(const u8 *uuid);

static int do_object_sequence(deark *c, lctx *d, i64 pos1, i64 len, int level,
        int known_object_count, i64 num_objects_expected);

// Returns a copy of the 'buf' param
static char *format_date(i64 t_FILETIME, char *buf, size_t buf_len)
{
        struct de_timestamp timestamp;

        if(t_FILETIME==0) {
                de_strlcpy(buf, "unknown", buf_len);
        }
        else {
                de_FILETIME_to_timestamp(t_FILETIME, &timestamp, 0x1);
                de_timestamp_to_string(&timestamp, buf, buf_len, 0);
        }
        return buf;
}

// Returns a copy of the 'buf' param
static char *format_duration(i64 n, char *buf, size_t buf_len)
{
        // TODO: Better formatting
        de_snprintf(buf, buf_len, "%.3f sec", (double)n/10000000.0);
        return buf;
}

static const char *get_metadata_dtype_name(unsigned int t)
{
        static const char *names[7] = { "string", "bytes", "BOOL", "DWORD",
                "QWORD", "WORD", "GUID" };

        if(t<DE_ARRAYCOUNT(names)) {
                return names[t];
        }
        return "?";
}

// Read a GUID into the caller's buf[16], and convert it to UUID-style byte order.
// Also write a printable form of it to id_string.
static void read_and_render_guid(dbuf *f, u8 *id, i64 pos,
        char *id_string, size_t id_string_len)
{
        dbuf_read(f, id, pos, 16);
        fmtutil_guid_to_uuid(id);
        if(id_string) {
                fmtutil_render_uuid(f->c, id, id_string, id_string_len);
        }
}

static void handler_Header(deark *c, lctx *d, struct handler_params *hp)
{
        i64 numhdrobj;

        if(hp->dlen<6) return;
        numhdrobj = de_getu32le(hp->dpos);
        de_dbg(c, "number of header objects: %u", (unsigned int)numhdrobj);
        do_object_sequence(c, d, hp->dpos+6, hp->dlen-6, hp->level+1, 1, numhdrobj);
}

static void handler_FileProperties(deark *c, lctx *d, struct handler_params *hp)
{
        i64 pos = hp->dpos;
        i64 create_date;
        i64 x;
        unsigned int flags;
        u8 guid_raw[16];
        char guid_string[50];
        char buf[64];

        if(hp->dlen<80) return;

        // Some fields before the 'flags' field depend on it, so look ahead at it.
        flags = (unsigned int)de_getu32le(pos+64);

        read_and_render_guid(c->infile, guid_raw, pos, guid_string, sizeof(guid_string));
        de_dbg(c, "file id: {%s}", guid_string);
        pos += 16;

        if(!(flags&0x1)) {
                x = de_geti64le(pos);
                de_dbg(c, "file size: %"I64_FMT, x);
        }
        pos += 8;

        create_date = de_geti64le(pos);
        de_dbg(c, "creation date: %"I64_FMT" (%s)", create_date,
                format_date(create_date, buf, sizeof(buf)));
        pos += 8;

        if(!(flags&0x1)) {
                x = de_geti64le(pos);
                de_dbg(c, "data packets count: %"I64_FMT, x);
        }
        pos += 8;

        if(!(flags&0x1)) {
                x = de_geti64le(pos);
                de_dbg(c, "play duration: %"I64_FMT" (%s)", x, format_duration(x, buf, sizeof(buf)));
        }
        pos += 8;

        if(!(flags&0x1)) {
                x = de_geti64le(pos);
                de_dbg(c, "send duration: %"I64_FMT" (%s)", x, format_duration(x, buf, sizeof(buf)));
        }
        pos += 8;

        x = de_geti64le(pos);
        de_dbg(c, "preroll: %"I64_FMT, x);
        pos += 8;

        // Already read, above.
        de_dbg(c, "flags: 0x%08x", flags);
        pos += 4;

        x = de_getu32le_p(&pos);
        de_dbg(c, "min data packet size: %u", (unsigned int)x);

        x = de_getu32le_p(&pos);
        de_dbg(c, "max data packet size: %u", (unsigned int)x);

        x = de_getu32le_p(&pos);
        de_dbg(c, "max bitrate: %u bits/sec", (unsigned int)x);
}

static void handler_StreamProperties(deark *c, lctx *d, struct handler_params *hp)
{
        i64 pos = hp->dpos;
        i64 x;
        i64 tsdlen, ecdlen;
        unsigned int flags;
        u8 stream_type[16];
        u8 ec_type[16];
        char stream_type_string[50];
        char ec_type_string[50];
        char buf[64];

        if(hp->dlen<54) return;

        read_and_render_guid(c->infile, stream_type, pos,
                stream_type_string, sizeof(stream_type_string));
        de_dbg(c, "stream type: {%s} (%s)", stream_type_string, get_uuid_name(stream_type));
        pos += 16;

        read_and_render_guid(c->infile, ec_type, pos, ec_type_string, sizeof(ec_type_string));
        de_dbg(c, "error correction type: {%s} (%s)", ec_type_string, get_uuid_name(ec_type));
        pos += 16;

        x = de_geti64le(pos);
        de_dbg(c, "time offset: %"I64_FMT" (%s)", x, format_duration(x, buf, sizeof(buf)));
        pos += 8;

        tsdlen = de_getu32le_p(&pos);
        ecdlen = de_getu32le_p(&pos);

        flags = (unsigned int)de_getu16le_p(&pos);
        de_dbg(c, "flags: 0x%08x", flags);
        de_dbg_indent(c, 1);
        de_dbg(c, "stream number: %u", (unsigned int)(flags&0x7f));
        de_dbg_indent(c, -1);

        pos += 4; // reserved

        if(tsdlen) {
                de_dbg(c, "[%d bytes of type-specific data at %"I64_FMT"]", (int)tsdlen, pos);
                de_dbg_indent(c, 1);
                de_dbg_hexdump(c, c->infile, pos, tsdlen, 256, NULL, 0x1);
                de_dbg_indent(c, -1);
                pos += tsdlen;
        }
        if(ecdlen) {
                de_dbg(c, "[%d bytes of error correction data at %"I64_FMT"]", (int)ecdlen, pos);
                de_dbg_indent(c, 1);
                de_dbg_hexdump(c, c->infile, pos, ecdlen, 256, NULL, 0x1);
                de_dbg_indent(c, -1);
                pos += ecdlen;
        }
}

static void handler_HeaderExtension(deark *c, lctx *d, struct handler_params *hp)
{
        i64 datasize;

        if(hp->dlen<22) return;
        datasize = de_getu32le(hp->dpos+18);
        de_dbg(c, "extension data size: %u", (unsigned int)datasize);
        if(datasize > hp->dlen-22) datasize = hp->dlen-22;
        do_object_sequence(c, d, hp->dpos+22, datasize, hp->level+1, 0, 0);
}

static void handler_ContentDescr(deark *c, lctx *d, struct handler_params *hp)
{
        i64 lengths[5];
        const char *names[5] = { "title", "author", "copyright",
                "description", "rating" };
        de_ucstring *s = NULL;
        i64 pos = hp->dpos;
        size_t k;

        if(hp->dlen<10) return;

        for(k=0; k<5; k++) {
                lengths[k] = de_getu16le_p(&pos);
        }

        s = ucstring_create(c);
        for(k=0; k<5; k++) {
                if(pos+lengths[k] > hp->dpos+hp->dlen) break;
                ucstring_empty(s);
                dbuf_read_to_ucstring_n(c->infile, pos, lengths[k], DE_DBG_MAX_STRLEN*2, s,
                        0, DE_ENCODING_UTF16LE);
                ucstring_truncate_at_NUL(s);
                de_dbg(c, "%s: \"%s\"", names[k], ucstring_getpsz_d(s));
                pos += lengths[k];
        }

        ucstring_destroy(s);
}

static void handler_ContentEncr(deark *c, lctx *d, struct handler_params *hp)
{
        i64 pos = hp->dpos;
        i64 xlen;
        de_ucstring *s = NULL;

        xlen = de_getu32le_p(&pos);
        if(pos+xlen > hp->dpos+hp->dlen) goto done;
        if(xlen>0) {
                de_dbg(c, "[%d bytes of secret data at %"I64_FMT"]", (int)xlen, pos);
                de_dbg_indent(c, 1);
                de_dbg_hexdump(c, c->infile, pos, xlen, 256, NULL, 0x0);
                de_dbg_indent(c, -1);
        }
        pos += xlen;

        s = ucstring_create(c);
        xlen = de_getu32le_p(&pos);
        if(pos+xlen > hp->dpos+hp->dlen) goto done;
        dbuf_read_to_ucstring_n(c->infile, pos, xlen, DE_DBG_MAX_STRLEN, s,
                        0, DE_ENCODING_ASCII);
        ucstring_truncate_at_NUL(s);
        de_dbg(c, "protection type: \"%s\"", ucstring_getpsz_d(s));
        // TODO: What should we do if this is not "DRM"?
        pos += xlen;

        ucstring_empty(s);
        xlen = de_getu32le_p(&pos);
        if(pos+xlen > hp->dpos+hp->dlen) goto done;
        dbuf_read_to_ucstring_n(c->infile, pos, xlen, DE_DBG_MAX_STRLEN, s,
                        0, DE_ENCODING_ASCII);
        ucstring_truncate_at_NUL(s);
        de_dbg(c, "key id: \"%s\"", ucstring_getpsz_d(s));
        pos += xlen;

        ucstring_empty(s);
        xlen = de_getu32le_p(&pos);
        if(pos+xlen > hp->dpos+hp->dlen) goto done;
        dbuf_read_to_ucstring_n(c->infile, pos, xlen, DE_DBG_MAX_STRLEN, s,
                        0, DE_ENCODING_ASCII);
        ucstring_truncate_at_NUL(s);
        de_dbg(c, "license url: \"%s\"", ucstring_getpsz_d(s));
        pos += xlen;

done:
        ucstring_destroy(s);
}

// Extended Stream Properties
static void handler_ESP(deark *c, lctx *d, struct handler_params *hp)
{
        i64 pos = hp->dpos;
        i64 name_count, pes_count;
        i64 k;
        i64 x, xlen;
        i64 bytes_remaining;
        int saved_indent_level;
        u8 guid_raw[16];
        char guid_string[50];

        de_dbg_indent_save(c, &saved_indent_level);
        if(hp->dlen<64) goto done;

        x = de_geti64le(pos);
        de_dbg(c, "start time: %"I64_FMT, x);
        pos += 8;
        x = de_geti64le(pos);
        de_dbg(c, "end time: %"I64_FMT, x);
        pos += 8;

        x = de_getu32le_p(&pos);
        de_dbg(c, "data bitrate: %u", (unsigned int)x);
        x = de_getu32le_p(&pos);
        de_dbg(c, "buffer size: %u", (unsigned int)x);
        x = de_getu32le_p(&pos);
        de_dbg(c, "initial buffer fullness: %u", (unsigned int)x);
        x = de_getu32le_p(&pos);
        de_dbg(c, "alt data bitrate: %u", (unsigned int)x);
        x = de_getu32le_p(&pos);
        de_dbg(c, "alt buffer size: %u", (unsigned int)x);
        x = de_getu32le_p(&pos);
        de_dbg(c, "alt initial buffer fullness: %u", (unsigned int)x);
        x = de_getu32le_p(&pos);
        de_dbg(c, "max object size: %u", (unsigned int)x);
        x = de_getu32le_p(&pos);
        de_dbg(c, "flags: 0x%08x", (unsigned int)x);

        x = de_getu16le_p(&pos);
        de_dbg(c, "stream number: %d", (int)x);
        x = de_getu16le_p(&pos);
        de_dbg(c, "language id index: %d", (int)x);
        x = de_geti64le(pos);
        de_dbg(c, "average time per frame: %"I64_FMT, x);
        pos += 8;

        name_count = de_getu16le_p(&pos);
        de_dbg(c, "name count: %d", (int)name_count);
        pes_count = de_getu16le_p(&pos);
        de_dbg(c, "payload ext. system count: %d", (int)pes_count);

        // Stream names (TODO)
        for(k=0; k<name_count; k++) {
                if(pos+4 > hp->dpos+hp->dlen) goto done;
                de_dbg(c, "name[%d] at %"I64_FMT, (int)k, pos);
                pos += 2; // language id index
                xlen = de_getu16le_p(&pos);
                pos += xlen;
        }

        // Payload extension systems
        for(k=0; k<pes_count; k++) {
                if(pos+22 > hp->dpos+hp->dlen) {
                        goto done;
                }
                de_dbg(c, "payload ext. system[%d] at %"I64_FMT, (int)k, pos);
                de_dbg_indent(c, 1);

                read_and_render_guid(c->infile, guid_raw, pos, guid_string, sizeof(guid_string));
                de_dbg(c, "ext. system id: {%s} (%s)", guid_string, get_uuid_name(guid_raw));
                pos += 16;

                x = de_getu16le_p(&pos);
                de_dbg(c, "ext. data size: %d", (int)x);

                xlen = de_getu32le_p(&pos);
                de_dbg(c, "payload ext. system info length: %d", (int)xlen);

                if(pos+xlen > hp->dpos+hp->dlen) {
                        goto done;
                }
                if(xlen>0) {
                        de_dbg(c, "[%d bytes of payload ext. system info at %"I64_FMT, (int)xlen, pos);
                        de_dbg_indent(c, 1);
                        de_dbg_hexdump(c, c->infile, pos, xlen, 256, NULL, 0x1);
                        de_dbg_indent(c, -1);
                }
                pos += xlen;
                de_dbg_indent(c, -1);
        }

        bytes_remaining = hp->dpos + hp->dlen - pos;
        // There is an optional Stream Properties object here, but the spec seems
        // less than clear about how to tell whether it is present.
        if(bytes_remaining>24+54) {
                do_object_sequence(c, d, pos, bytes_remaining, hp->level+1, 1, 1);
        }

done:
        de_dbg_indent_restore(c, saved_indent_level);
}

static void handler_LanguageList(deark *c, lctx *d, struct handler_params *hp)
{
        i64 pos = hp->dpos;
        i64 nlangs;
        i64 k;
        de_ucstring *s = NULL;

        if(hp->dlen<2) goto done;

        nlangs = de_getu16le_p(&pos);
        de_dbg(c, "language id record count: %d", (int)nlangs);

        s = ucstring_create(c);

        for(k=0; k<nlangs; k++) {
                i64 id_len;

                if(pos+1 > hp->dpos+hp->dlen) goto done;
                de_dbg(c, "language id record[%d] at %"I64_FMT, (int)k, pos);
                de_dbg_indent(c, 1);

                id_len = (i64)de_getbyte_p(&pos);

                ucstring_empty(s);
                dbuf_read_to_ucstring_n(c->infile, pos, id_len, DE_DBG_MAX_STRLEN*2, s,
                        0, DE_ENCODING_UTF16LE);
                ucstring_truncate_at_NUL(s);
                de_dbg(c, "id: \"%s\"", ucstring_getpsz_d(s));
                pos += id_len;

                de_dbg_indent(c, -1);
        }

done:
        ucstring_destroy(s);
}

static const char *get_codec_type_name(unsigned int t)
{
        const char *name = "?";
        switch(t) {
        case 0x0001: name="video"; break;
        case 0x0002: name="audio"; break;
        case 0xffff: name="unknown"; break;
        }
        return name;
}

static int do_codec_entry(deark *c, lctx *d, i64 pos1, i64 len, i64 *bytes_consumed)
{
        de_ucstring *name = NULL;
        de_ucstring *descr = NULL;
        unsigned int type;
        i64 namelen, descrlen, infolen;
        i64 pos = pos1;
        int retval = 0;
        int saved_indent_level;

        *bytes_consumed = 0;
        de_dbg_indent_save(c, &saved_indent_level);
        de_dbg(c, "codec entry at %"I64_FMT, pos1);
        de_dbg_indent(c, 1);

        if(len<8) goto done;
        type = (unsigned int)de_getu16le_p(&pos);
        de_dbg(c, "type: %u (%s)", type, get_codec_type_name(type));

        namelen = de_getu16le_p(&pos);
        name = ucstring_create(c);
        dbuf_read_to_ucstring_n(c->infile, pos, namelen*2, DE_DBG_MAX_STRLEN*2, name,
                0, DE_ENCODING_UTF16LE);
        ucstring_truncate_at_NUL(name);
        de_dbg(c, "name: \"%s\"", ucstring_getpsz(name));
        pos += namelen*2;

        descrlen = de_getu16le_p(&pos);
        descr = ucstring_create(c);
        dbuf_read_to_ucstring_n(c->infile, pos, descrlen*2, DE_DBG_MAX_STRLEN*2, descr,
                0, DE_ENCODING_UTF16LE);
        ucstring_truncate_at_NUL(descr);
        de_dbg(c, "description: \"%s\"", ucstring_getpsz(descr));
        pos += descrlen*2;

        infolen = de_getu16le_p(&pos);
        if(infolen>0) {
                de_dbg(c, "[%d bytes of codec information at %"I64_FMT"]", (int)infolen, pos);
                de_dbg_indent(c, 1);
                de_dbg_hexdump(c, c->infile, pos, infolen, 256, NULL, 0x1);
                de_dbg_indent(c, -1);
        }
        pos += infolen;

        *bytes_consumed = pos-pos1;
        retval = 1;
done:
        de_dbg_indent_restore(c, saved_indent_level);
        ucstring_destroy(name);
        ucstring_destroy(descr);
        return retval;
}

static void handler_CodecList(deark *c, lctx *d, struct handler_params *hp)
{
        i64 numentries;
        i64 k;
        i64 pos;

        if(hp->dlen<20) return;
        numentries = de_getu32le(hp->dpos+16);
        de_dbg(c, "number of codec entries: %d", (int)numentries);

        pos = hp->dpos+20;
        for(k=0; k<numentries; k++) {
                i64 bytes_consumed = 0;
                int ret;

                if(pos >= hp->dpos + hp->dlen) break;
                ret = do_codec_entry(c, d, pos, hp->dpos+hp->dlen-pos, &bytes_consumed);
                if(!ret || (bytes_consumed<8)) break;
                pos += bytes_consumed;
        }
}

static void handler_ScriptCommand(deark *c, lctx *d, struct handler_params *hp)
{
        i64 cmd_count, cmd_type_count;
        i64 pos = hp->dpos;
        i64 k;
        de_ucstring *s = NULL;
        int saved_indent_level;

        de_dbg_indent_save(c, &saved_indent_level);
        if(hp->dlen<20) goto done;
        pos += 16; // Reserved GUID

        cmd_count = de_getu16le_p(&pos);
        de_dbg(c, "commands count: %d", (int)cmd_count);

        cmd_type_count = de_getu16le_p(&pos);
        de_dbg(c, "command types count: %d", (int)cmd_type_count);

        s = ucstring_create(c);

        for(k=0; k<cmd_type_count; k++) {
                i64 type_name_len;

                if(pos+2 > hp->dpos+hp->dlen) goto done;
                de_dbg(c, "command type[%d] at %"I64_FMT, (int)k, pos);
                de_dbg_indent(c, 1);

                type_name_len = de_getu16le_p(&pos);

                ucstring_empty(s);
                dbuf_read_to_ucstring_n(c->infile, pos, type_name_len*2, DE_DBG_MAX_STRLEN*2, s,
                        0, DE_ENCODING_UTF16LE);
                ucstring_truncate_at_NUL(s);
                de_dbg(c, "name: \"%s\"", ucstring_getpsz_d(s));
                pos += type_name_len*2;

                de_dbg_indent(c, -1);
        }

        for(k=0; k<cmd_count; k++) {
                i64 cmd_name_len;
                i64 n;

                if(pos+8 > hp->dpos+hp->dlen) goto done;
                de_dbg(c, "command[%d] at %"I64_FMT, (int)k, pos);
                de_dbg_indent(c, 1);

                n = de_getu32le_p(&pos);
                de_dbg(c, "presentation time: %u ms", (unsigned int)n);

                n = de_getu16le_p(&pos);
                de_dbg(c, "type index: %d", (int)n);
                        
                cmd_name_len = de_getu16le_p(&pos);

                ucstring_empty(s);
                dbuf_read_to_ucstring_n(c->infile, pos, cmd_name_len*2, DE_DBG_MAX_STRLEN*2, s,
                        0, DE_ENCODING_UTF16LE);
                ucstring_truncate_at_NUL(s);
                de_dbg(c, "name: \"%s\"", ucstring_getpsz_d(s));
                pos += cmd_name_len*2;

                de_dbg_indent(c, -1);
        }

done:
        de_dbg_indent_restore(c, saved_indent_level);
        ucstring_destroy(s);
}

static void do_ECD_ID3(deark *c, lctx *d, i64 pos, i64 len)
{
        de_dbg(c, "ID3 data at %"I64_FMT", len=%"I64_FMT, pos, len);
        de_dbg_indent(c, 1);
        de_run_module_by_id_on_slice2(c, "id3", "I", c->infile, pos, len);
        de_dbg_indent(c, -1);
}

static void do_ECD_WMPicture(deark *c, lctx *d, i64 pos, i64 len)
{
        de_dbg(c, "WM/Picture data at %"I64_FMT", len=%"I64_FMT, pos, len);
        de_dbg_indent(c, 1);
        de_run_module_by_id_on_slice2(c, "id3", "P", c->infile, pos, len);
        de_dbg_indent(c, -1);
}

static void do_WMEncodingTime(deark *c, lctx *d, i64 t)
{
        char buf[64];

        de_dbg(c, "value: %"I64_FMT" (%s)", t, format_date(t, buf, sizeof(buf)));
}

static void do_metadata_item(deark *c, lctx *d, i64 pos, i64 val_len,
        unsigned int val_data_type_ori, struct de_stringreaderdata *name_srd,
        u32 object_sid)
{
        de_ucstring *val_str = NULL;
        i64 val_int;
        int handled = 0;
        unsigned int val_data_type; // adjusted type

        de_dbg(c, "value data at %"I64_FMT", len=%d", pos, (int)val_len);

        val_data_type = val_data_type_ori; // default
        if(val_data_type_ori==2) {
                if(object_sid==SID_ECD) {
                        val_data_type = 3; // Pretend a 32-bit BOOL is a DWORD
                }
                else {
                        val_data_type = 5; // Pretend a 16-bit BOOL is a WORD
                }
        }

        if(val_data_type==0 && val_len>=2) { // Unicode string
                val_str = ucstring_create(c);
                dbuf_read_to_ucstring_n(c->infile, pos, val_len-2, DE_DBG_MAX_STRLEN*2, val_str,
                        0, DE_ENCODING_UTF16LE);
                de_dbg(c, "value: \"%s\"", ucstring_getpsz(val_str));
                handled = 1;
        }
        else if(val_data_type==3 && val_len>=4) { // DWORD
                val_int = de_getu32le(pos);
                de_dbg(c, "value: %u", (unsigned int)val_int);
                handled = 1;
        }
        else if(val_data_type==4 && val_len>=8) {
                val_int = de_geti64le(pos);
                if(!de_strcmp(name_srd->sz_utf8, "WM/EncodingTime")) {
                        do_WMEncodingTime(c, d, val_int);
                }
                else {
                        de_dbg(c, "value: %"I64_FMT, val_int);
                }
                handled = 1;
        }
        else if(val_data_type==5 && val_len>=2) { // WORD
                val_int = de_getu16le(pos);
                de_dbg(c, "value: %u", (unsigned int)val_int);
                handled = 1;
        }
        else if(val_data_type==6 && val_len>=16) { // GUID
                u8 guid_raw[16];
                char guid_string[50];

                read_and_render_guid(c->infile, guid_raw, pos, guid_string, sizeof(guid_string));
                de_dbg(c, "value: {%s}", guid_string);
                handled = 1;
        }
        else if(val_data_type==1) { // binary
                if(!de_strcmp(name_srd->sz_utf8, "ID3")) {
                        do_ECD_ID3(c, d, pos, val_len);
                        handled = 1;
                }
                else if(!de_strcmp(name_srd->sz_utf8, "WM/Picture")) {
                        do_ECD_WMPicture(c, d, pos, val_len);
                        handled = 1;
                }
        }

        if(!handled) {
                de_dbg_indent(c, 1);
                de_dbg_hexdump(c, c->infile, pos, val_len, 256, NULL, 0x1);
                de_dbg_indent(c, -1);
        }

        ucstring_destroy(val_str);
}

static int do_ECD_entry(deark *c, lctx *d, i64 pos1, i64 len, i64 *bytes_consumed)
{
        i64 pos = pos1;
        struct de_stringreaderdata *name_srd = NULL;
        i64 namelen;
        i64 namelen_to_keep;
        unsigned int val_data_type;
        i64 val_len;
        int retval = 0;
        int saved_indent_level;

        *bytes_consumed = 0;
        de_dbg_indent_save(c, &saved_indent_level);
        de_dbg(c, "ECD object at %"I64_FMT, pos1);
        de_dbg_indent(c, 1);

        if(len<6) goto done;
        namelen = de_getu16le_p(&pos); // # of bytes, including the expected 0x00 0x00 terminator
        namelen_to_keep = namelen-2;
        if(namelen_to_keep<0) namelen_to_keep=0;
        if(namelen_to_keep>256) namelen_to_keep=256;
        name_srd = dbuf_read_string(c->infile, pos, namelen_to_keep, namelen_to_keep,
                DE_CONVFLAG_WANT_UTF8, DE_ENCODING_UTF16LE);
        de_dbg(c, "name: \"%s\"", ucstring_getpsz_d(name_srd->str));
        pos += namelen;

        val_data_type = (unsigned int)de_getu16le_p(&pos);
        de_dbg(c, "value data type: %u (%s)", val_data_type,
                get_metadata_dtype_name(val_data_type));

        val_len = de_getu16le_p(&pos);

        do_metadata_item(c, d, pos, val_len, val_data_type, name_srd, SID_ECD);

        pos += val_len;

        *bytes_consumed = pos-pos1;
        retval = 1;
done:
        de_dbg_indent_restore(c, saved_indent_level);
        de_destroy_stringreaderdata(c, name_srd);
        return retval;
}

// Supports:
//   Metadata
//   Metadata Library
// This is a lot like do_ECD_entry().
static int do_metadata_entry(deark *c, lctx *d, struct handler_params *hp,
        i64 pos1, i64 len, i64 *bytes_consumed)
{
        i64 pos = pos1;
        struct de_stringreaderdata *name_srd = NULL;
        i64 namelen;
        i64 namelen_to_keep;
        unsigned int val_data_type;
        i64 val_len;
        i64 stream_number;
        int retval = 0;
        int saved_indent_level;

        *bytes_consumed = 0;
        de_dbg_indent_save(c, &saved_indent_level);
        de_dbg(c, "metadata object at %"I64_FMT, pos1);
        de_dbg_indent(c, 1);

        if(len<14) goto done;

        if(hp->uui->short_id==SID_METADATALIB) {
                i64 lang_list_idx;
                lang_list_idx = de_getu16le(pos);
                de_dbg(c, "language list index: %d", (int)lang_list_idx);
        }
        pos += 2; // Lang list index, or reserved

        stream_number = de_getu16le_p(&pos);
        de_dbg(c, "stream number: %d", (int)stream_number);

        namelen = de_getu16le_p(&pos); // # of bytes, including the expected 0x00 0x00 terminator

        val_data_type = (unsigned int)de_getu16le_p(&pos);
        de_dbg(c, "value data type: %u (%s)", val_data_type,
                get_metadata_dtype_name(val_data_type));

        val_len = de_getu32le_p(&pos);

        namelen_to_keep = namelen-2;
        if(namelen_to_keep<0) namelen_to_keep=0;
        if(namelen_to_keep>256) namelen_to_keep=256;
        name_srd = dbuf_read_string(c->infile, pos, namelen_to_keep, namelen_to_keep,
                DE_CONVFLAG_WANT_UTF8, DE_ENCODING_UTF16LE);
        de_dbg(c, "name: \"%s\"", ucstring_getpsz_d(name_srd->str));
        pos += namelen;

        do_metadata_item(c, d, pos, val_len, val_data_type, name_srd, hp->uui->short_id);

        pos += val_len;

        *bytes_consumed = pos-pos1;
        retval = 1;
done:
        de_dbg_indent_restore(c, saved_indent_level);
        de_destroy_stringreaderdata(c, name_srd);
        return retval;
}

// Supports:
//   Extended Content Description
//   Metadata
//   Metadata Library
static void handler_ECD_or_metadata(deark *c, lctx *d, struct handler_params *hp)
{
        i64 descr_count;
        i64 k;
        i64 pos = hp->dpos;

        descr_count = de_getu16le_p(&pos);
        de_dbg(c, "descriptor count: %d", (int)descr_count);

        for(k=0; k<descr_count; k++) {
                i64 bytes_consumed = 0;
                int ret;

                if(pos >= hp->dpos + hp->dlen) {
                        break;
                }
                if(hp->uui->short_id==SID_ECD) {
                        ret = do_ECD_entry(c, d, pos, hp->dpos+hp->dlen-pos, &bytes_consumed);
                }
                else if(hp->uui->short_id==SID_METADATA || hp->uui->short_id==SID_METADATALIB) {
                        ret = do_metadata_entry(c, d, hp, pos, hp->dpos+hp->dlen-pos, &bytes_consumed);
                }
                else {
                        break;
                }
                if(!ret || (bytes_consumed<6)) break;
                pos += bytes_consumed;
        }
}

static const struct uuid_info object_info_arr[] = {
        {101, 0, {0x75,0xb2,0x26,0x30,0x66,0x8e,0x11,0xcf,0xa6,0xd9,0x00,0xaa,0x00,0x62,0xce,0x6c}, "Header", handler_Header},
        {102, 0, {0x75,0xb2,0x26,0x36,0x66,0x8e,0x11,0xcf,0xa6,0xd9,0x00,0xaa,0x00,0x62,0xce,0x6c}, "Data", NULL},
        {103, 0, {0x33,0x00,0x08,0x90,0xe5,0xb1,0x11,0xcf,0x89,0xf4,0x00,0xa0,0xc9,0x03,0x49,0xcb}, "Simple Index", NULL},
        {104, 0, {0xd6,0xe2,0x29,0xd3,0x35,0xda,0x11,0xd1,0x90,0x34,0x00,0xa0,0xc9,0x03,0x49,0xbe}, "Index", NULL},
        {105, 0, {0xfe,0xb1,0x03,0xf8,0x12,0xad,0x4c,0x64,0x84,0x0f,0x2a,0x1d,0x2f,0x7a,0xd4,0x8c}, "Media Object Index", NULL},
        {106, 0, {0x3c,0xb7,0x3f,0xd0,0x0c,0x4a,0x48,0x03,0x95,0x3d,0xed,0xf7,0xb6,0x22,0x8f,0x0c}, "Timecode Index", NULL},
        {201, 0, {0x8c,0xab,0xdc,0xa1,0xa9,0x47,0x11,0xcf,0x8e,0xe4,0x00,0xc0,0x0c,0x20,0x53,0x65}, "File Properties", handler_FileProperties},
        {202, 0, {0xb7,0xdc,0x07,0x91,0xa9,0xb7,0x11,0xcf,0x8e,0xe6,0x00,0xc0,0x0c,0x20,0x53,0x65}, "Stream Properties", handler_StreamProperties},
        {203, 0, {0x5f,0xbf,0x03,0xb5,0xa9,0x2e,0x11,0xcf,0x8e,0xe3,0x00,0xc0,0x0c,0x20,0x53,0x65}, "Header Extension", handler_HeaderExtension},
        {204, 0, {0x86,0xd1,0x52,0x40,0x31,0x1d,0x11,0xd0,0xa3,0xa4,0x00,0xa0,0xc9,0x03,0x48,0xf6}, "Codec List", handler_CodecList},
        {205, 0, {0x1e,0xfb,0x1a,0x30,0x0b,0x62,0x11,0xd0,0xa3,0x9b,0x00,0xa0,0xc9,0x03,0x48,0xf6}, "Script Command", handler_ScriptCommand},
        {206, 0, {0xf4,0x87,0xcd,0x01,0xa9,0x51,0x11,0xcf,0x8e,0xe6,0x00,0xc0,0x0c,0x20,0x53,0x65}, "Marker", NULL},
        {207, 0, {0xd6,0xe2,0x29,0xdc,0x35,0xda,0x11,0xd1,0x90,0x34,0x00,0xa0,0xc9,0x03,0x49,0xbe}, "Bitrate Mutual Exclusion", NULL},
        {208, 0, {0x75,0xb2,0x26,0x35,0x66,0x8e,0x11,0xcf,0xa6,0xd9,0x00,0xaa,0x00,0x62,0xce,0x6c}, "Error Correction", NULL},
        {209, 0, {0x75,0xb2,0x26,0x33,0x66,0x8e,0x11,0xcf,0xa6,0xd9,0x00,0xaa,0x00,0x62,0xce,0x6c}, "Content Description", handler_ContentDescr},
        {SID_ECD, 0, {0xd2,0xd0,0xa4,0x40,0xe3,0x07,0x11,0xd2,0x97,0xf0,0x00,0xa0,0xc9,0x5e,0xa8,0x50},
         "Extended Content Description", handler_ECD_or_metadata},
        {211, 0, {0x22,0x11,0xb3,0xfa,0xbd,0x23,0x11,0xd2,0xb4,0xb7,0x00,0xa0,0xc9,0x55,0xfc,0x6e}, "Content Branding", NULL},
        {212, 0, {0x7b,0xf8,0x75,0xce,0x46,0x8d,0x11,0xd1,0x8d,0x82,0x00,0x60,0x97,0xc9,0xa2,0xb2}, "Stream Bitrate Properties", NULL},
        {213, 0, {0x22,0x11,0xb3,0xfb,0xbd,0x23,0x11,0xd2,0xb4,0xb7,0x00,0xa0,0xc9,0x55,0xfc,0x6e}, "Content Encryption", handler_ContentEncr},
        {214, 0, {0x29,0x8a,0xe6,0x14,0x26,0x22,0x4c,0x17,0xb9,0x35,0xda,0xe0,0x7e,0xe9,0x28,0x9c}, "Extended Content Encryption", NULL},
        {215, 0, {0x22,0x11,0xb3,0xfc,0xbd,0x23,0x11,0xd2,0xb4,0xb7,0x00,0xa0,0xc9,0x55,0xfc,0x6e}, "Digital Signature", NULL},
        {216, 0, {0x18,0x06,0xd4,0x74,0xca,0xdf,0x45,0x09,0xa4,0xba,0x9a,0xab,0xcb,0x96,0xaa,0xe8}, "Padding", NULL},
        {301, 0, {0x14,0xe6,0xa5,0xcb,0xc6,0x72,0x43,0x32,0x83,0x99,0xa9,0x69,0x52,0x06,0x5b,0x5a}, "Extended Stream Properties", handler_ESP},
        {302, 0, {0xa0,0x86,0x49,0xcf,0x47,0x75,0x46,0x70,0x8a,0x16,0x6e,0x35,0x35,0x75,0x66,0xcd}, "Advanced Mutual Exclusion", NULL},
        {303, 0, {0xd1,0x46,0x5a,0x40,0x5a,0x79,0x43,0x38,0xb7,0x1b,0xe3,0x6b,0x8f,0xd6,0xc2,0x49}, "Group Mutual Exclusion", NULL},
        {304, 0, {0xd4,0xfe,0xd1,0x5b,0x88,0xd3,0x45,0x4f,0x81,0xf0,0xed,0x5c,0x45,0x99,0x9e,0x24}, "Stream Prioritization", NULL},
        {305, 0, {0xa6,0x96,0x09,0xe6,0x51,0x7b,0x11,0xd2,0xb6,0xaf,0x00,0xc0,0x4f,0xd9,0x08,0xe9}, "Bandwidth Sharing", NULL},
        {306, 0, {0x7c,0x43,0x46,0xa9,0xef,0xe0,0x4b,0xfc,0xb2,0x29,0x39,0x3e,0xde,0x41,0x5c,0x85}, "Language List", handler_LanguageList},
        {SID_METADATA, 0, {0xc5,0xf8,0xcb,0xea,0x5b,0xaf,0x48,0x77,0x84,0x67,0xaa,0x8c,0x44,0xfa,0x4c,0xca},
         "Metadata", handler_ECD_or_metadata},
        {SID_METADATALIB, 0, {0x44,0x23,0x1c,0x94,0x94,0x98,0x49,0xd1,0xa1,0x41,0x1d,0x13,0x4e,0x45,0x70,0x54},
         "Metadata Library", handler_ECD_or_metadata},
        {309, 0, {0xd6,0xe2,0x29,0xdf,0x35,0xda,0x11,0xd1,0x90,0x34,0x00,0xa0,0xc9,0x03,0x49,0xbe}, "Index Parameters", NULL},
        {310, 0, {0x6b,0x20,0x3b,0xad,0x3f,0x11,0x48,0xe4,0xac,0xa8,0xd7,0x61,0x3d,0xe2,0xcf,0xa7}, "Media Object Index Parameters", NULL},
        {311, 0, {0xf5,0x5e,0x49,0x6d,0x97,0x97,0x4b,0x5d,0x8c,0x8b,0x60,0x4d,0xfe,0x9b,0xfb,0x24}, "Timecode Index Parameters", NULL},
        {312, 0, {0x26,0xf1,0x8b,0x5d,0x45,0x84,0x47,0xec,0x9f,0x5f,0x0e,0x65,0x1f,0x04,0x52,0xc9}, "Compatibility", NULL},
        {313, 0, {0x43,0x05,0x85,0x33,0x69,0x81,0x49,0xe6,0x9b,0x74,0xad,0x12,0xcb,0x86,0xd5,0x8c}, "Advanced Content Encryption", NULL},
        {330, 0, {0xd9,0xaa,0xde,0x20,0x7c,0x17,0x4f,0x9c,0xbc,0x28,0x85,0x55,0xdd,0x98,0xe2,0xa2}, "Index Placeholder", NULL}
};

// GUIDs used for things other than objects
static const struct uuid_info uuid_info_arr[] = {
        // Stream properties object stream types
        {0, 0x01, {0xf8,0x69,0x9e,0x40,0x5b,0x4d,0x11,0xcf,0xa8,0xfd,0x00,0x80,0x5f,0x5c,0x44,0x2b}, "Audio", NULL},
        {0, 0x01, {0xbc,0x19,0xef,0xc0,0x5b,0x4d,0x11,0xcf,0xa8,0xfd,0x00,0x80,0x5f,0x5c,0x44,0x2b}, "Video", NULL},
        {0, 0x01, {0x59,0xda,0xcf,0xc0,0x59,0xe6,0x11,0xd0,0xa3,0xac,0x00,0xa0,0xc9,0x03,0x48,0xf6}, "Command", NULL},
        {0, 0x01, {0xb6,0x1b,0xe1,0x00,0x5b,0x4e,0x11,0xcf,0xa8,0xfd,0x00,0x80,0x5f,0x5c,0x44,0x2b}, "JFIF", NULL},
        {0, 0x01, {0x35,0x90,0x7d,0xe0,0xe4,0x15,0x11,0xcf,0xa9,0x17,0x00,0x80,0x5f,0x5c,0x44,0x2b}, "Degradable JPEG", NULL},
        {0, 0x01, {0x91,0xbd,0x22,0x2c,0xf2,0x1c,0x49,0x7a,0x8b,0x6d,0x5a,0xa8,0x6b,0xfc,0x01,0x85}, "File transfer", NULL},
        {0, 0x01, {0x3a,0xfb,0x65,0xe2,0x47,0xef,0x40,0xf2,0xac,0x2c,0x70,0xa9,0x0d,0x71,0xd3,0x43}, "Binary", NULL},
        // Stream properties object error correction types
        {0, 0x02, {0x20,0xfb,0x57,0x00,0x5b,0x55,0x11,0xcf,0xa8,0xfd,0x00,0x80,0x5f,0x5c,0x44,0x2b}, "No error correction", NULL},
        {0, 0x02, {0xbf,0xc3,0xcd,0x50,0x61,0x8f,0x11,0xcf,0x8b,0xb2,0x00,0xaa,0x00,0xb4,0xe2,0x20}, "Audio spread", NULL},
        // Payload extension system GUIDs
        {0, 0x03, {0x39,0x95,0x95,0xec,0x86,0x67,0x4e,0x2d,0x8f,0xdb,0x98,0x81,0x4c,0xe7,0x6c,0x1e}, "Timecode", NULL},
        {0, 0x03, {0xe1,0x65,0xec,0x0e,0x19,0xed,0x45,0xd7,0xb4,0xa7,0x25,0xcb,0xd1,0xe2,0x8e,0x9b}, "File name", NULL},
        {0, 0x03, {0xd5,0x90,0xdc,0x20,0x07,0xbc,0x43,0x6c,0x9c,0xf7,0xf3,0xbb,0xfb,0xf1,0xa4,0xdc}, "Content type", NULL},
        {0, 0x03, {0x1b,0x1e,0xe5,0x54,0xf9,0xea,0x4b,0xc8,0x82,0x1a,0x37,0x6b,0x74,0xe4,0xc4,0xb8}, "Pixel aspect ratio", NULL},
        {0, 0x03, {0xc6,0xbd,0x94,0x50,0x86,0x7f,0x49,0x07,0x83,0xa3,0xc7,0x79,0x21,0xb7,0x33,0xad}, "Sample duration", NULL},
        {0, 0x03, {0x66,0x98,0xb8,0x4e,0x0a,0xfa,0x43,0x30,0xae,0xb2,0x1c,0x0a,0x98,0xd7,0xa4,0x4d}, "Encryption sample ID", NULL},
        {0, 0x03, {0x00,0xe1,0xaf,0x06,0x7b,0xec,0x11,0xd1,0xa5,0x82,0x00,0xc0,0x4f,0xc2,0x9c,0xfb}, "Degradable JPEG", NULL}
};

static const struct uuid_info *find_object_info(const u8 *uuid)
{
        size_t k;
        for(k=0; k<DE_ARRAYCOUNT(object_info_arr); k++) {
                if(!de_memcmp(uuid, object_info_arr[k].uuid, 16)) {
                        return &object_info_arr[k];
                }
        }
        return NULL;
}

static const struct uuid_info *find_uuid_info(const u8 *uuid)
{
        size_t k;
        for(k=0; k<DE_ARRAYCOUNT(uuid_info_arr); k++) {
                if(!de_memcmp(uuid, uuid_info_arr[k].uuid, 16)) {
                        return &uuid_info_arr[k];
                }
        }
        return NULL;
}

static const char *get_uuid_name(const u8 *uuid)
{
        const struct uuid_info *uui;
        uui = find_uuid_info(uuid);
        if(uui && uui->name) return uui->name;
        return "?";
}

static int do_object(deark *c, lctx *d, i64 pos1, i64 len,
        int level, i64 *pbytes_consumed)
{
        u8 id[16];
        char id_string[50];
        const char *id_name = NULL;
        int retval = 0;
        int saved_indent_level;
        struct handler_params *hp = NULL;

        de_dbg_indent_save(c, &saved_indent_level);
        *pbytes_consumed = 0;
        if(len<24) goto done;

        de_dbg(c, "object at %"I64_FMT, pos1);
        de_dbg_indent(c, 1);

        hp = de_malloc(c, sizeof(struct handler_params));
        hp->objpos = pos1;
        hp->level = level;

        read_and_render_guid(c->infile, id, pos1, id_string, sizeof(id_string));

        hp->uui = find_object_info(id);
        if(hp->uui) id_name = hp->uui->name;
        if(!id_name) id_name = "?";

        de_dbg(c, "guid: {%s} (%s)", id_string, id_name);

        hp->objlen = de_geti64le(pos1+16);
        de_sanitize_length(&hp->objlen);
        hp->dpos = pos1 + 24;
        hp->dlen = hp->objlen - 24;
        de_dbg(c, "size: %"I64_FMT", dpos=%"I64_FMT", dlen=%"I64_FMT,
                hp->objlen, hp->dpos, hp->dlen);
        if(hp->objlen<24) goto done;

        if(hp->objlen > len) {
                // TODO: Handle this differently depending on whether the problem was
                // an unexpected end of file.
                de_warn(c, "Object at %"I64_FMT" (length %"I64_FMT") exceeds its parent's bounds",
                        pos1, hp->objlen);
                goto done;
        }

        if(hp->uui && hp->uui->hfn) {
                hp->uui->hfn(c, d, hp);
        }

        *pbytes_consumed = hp->objlen;
        retval = 1;
done:
        de_dbg_indent_restore(c, saved_indent_level);
        de_free(c, hp);
        return retval;
}

static int do_object_sequence(deark *c, lctx *d, i64 pos1, i64 len, int level,
        int known_object_count, i64 num_objects_expected)
{
        int retval = 0;
        i64 pos = pos1;
        int saved_indent_level;
        i64 bytes_remaining;
        i64 objects_found = 0;

        de_dbg_indent_save(c, &saved_indent_level);

        if(level >= 16) { // An arbitrary recursion limit
                goto done;
        }

        while(1) {
                int ret;
                i64 bytes_consumed = 0;

                bytes_remaining = pos1+len-pos;
                if(known_object_count && objects_found>=num_objects_expected) {
                        break;
                }

                if(bytes_remaining<24) {
                        break;
                }

                ret = do_object(c, d, pos, bytes_remaining, level, &bytes_consumed);
                if(!ret) goto done;
                if(bytes_consumed<24) goto done;

                objects_found++;
                pos += bytes_consumed;
        }

        bytes_remaining = pos1+len-pos;
        if(bytes_remaining>0) {
                de_dbg(c, "[%d extra bytes at %"I64_FMT"]", (int)bytes_remaining, pos);
        }

        if(known_object_count && objects_found<num_objects_expected) {
                de_warn(c, "Expected %d objects at %"I64_FMT", only found %d", (int)num_objects_expected,
                        pos1, (int)objects_found);
        }

done:
        de_dbg_indent_restore(c, saved_indent_level);
        return retval;
}

static void de_run_asf(deark *c, de_module_params *mparams)
{
        lctx *d = NULL;

        d = de_malloc(c, sizeof(lctx));

        do_object_sequence(c, d, 0, c->infile->len, 0, 0, 0);

        de_free(c, d);
}

static int de_identify_asf(deark *c)
{
        if(!dbuf_memcmp(c->infile, 0,
                "\x30\x26\xb2\x75\x8e\x66\xcf\x11\xa6\xd9\x00\xaa\x00\x62\xce\x6c", 16))
        {
                return 100;
        }
        return 0;
}

void de_module_asf(deark *c, struct deark_module_info *mi)
{
        mi->id = "asf";
        mi->desc = "ASF, WMV, WMA";
        mi->run_fn = de_run_asf;
        mi->identify_fn = de_identify_asf;
}