libavformat/hashenc.c

   1 /*
   2  * Hash/MD5 encoder (for codec/format testing)
   3  * Copyright (c) 2009 Reimar Döffinger, based on crcenc (c) 2002 Fabrice Bellard
   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 #include "libavutil/avassert.h"
  23 #include "libavutil/avstring.h"
  24 #include "libavutil/hash.h"
  25 #include "libavutil/intreadwrite.h"
  26 #include "libavutil/opt.h"
  27 #include "avformat.h"
  28 #include "internal.h"
  29
  30 struct HashContext {
  31     const AVClass *avclass;
  32     struct AVHashContext **hashes;
  33     char *hash_name;
  34     int per_stream;
  35     int format_version;
  36 };
  37
  38 #define OFFSET(x) offsetof(struct HashContext, x)
  39 #define ENC AV_OPT_FLAG_ENCODING_PARAM
  40 #define HASH_OPT(defaulttype) \
  41     { "hash", "set hash to use", OFFSET(hash_name), AV_OPT_TYPE_STRING, {.str = defaulttype}, 0, 0, ENC }
  42 #define FORMAT_VERSION_OPT \
  43     { "format_version", "file format version", OFFSET(format_version), AV_OPT_TYPE_INT, {.i64 = 2}, 1, 2, ENC }
  44
  45 #if CONFIG_HASH_MUXER
  46 static const AVOption hash_options[] = {
  47     HASH_OPT("sha256"),
  48     { NULL },
  49 };
  50 #endif
  51
  52 #if CONFIG_FRAMEHASH_MUXER
  53 static const AVOption framehash_options[] = {
  54     HASH_OPT("sha256"),
  55     FORMAT_VERSION_OPT,
  56     { NULL },
  57 };
  58 #endif
  59
  60 #if CONFIG_STREAMHASH_MUXER
  61 static const AVOption streamhash_options[] = {
  62     HASH_OPT("sha256"),
  63     { NULL },
  64 };
  65 #endif
  66
  67 #if CONFIG_MD5_MUXER
  68 static const AVOption md5_options[] = {
  69     HASH_OPT("md5"),
  70     { NULL },
  71 };
  72 #endif
  73
  74 #if CONFIG_FRAMEMD5_MUXER
  75 static const AVOption framemd5_options[] = {
  76     HASH_OPT("md5"),
  77     FORMAT_VERSION_OPT,
  78     { NULL },
  79 };
  80 #endif
  81
  82 #if CONFIG_HASH_MUXER || CONFIG_MD5_MUXER
  83 static int hash_init(struct AVFormatContext *s)
  84 {
  85     int res;
  86     struct HashContext *c = s->priv_data;
  87     c->per_stream = 0;
  88     c->hashes = av_mallocz_array(1, sizeof(*c->hashes));
  89     if (!c->hashes)
  90         return AVERROR(ENOMEM);
  91     res = av_hash_alloc(&c->hashes[0], c->hash_name);
  92     if (res < 0)
  93         return res;
  94     av_hash_init(c->hashes[0]);
  95     return 0;
  96 }
  97 #endif
  98
  99 #if CONFIG_STREAMHASH_MUXER
 100 static int streamhash_init(struct AVFormatContext *s)
 101 {
 102     int res, i;
 103     struct HashContext *c = s->priv_data;
 104     c->per_stream = 1;
 105     c->hashes = av_mallocz_array(s->nb_streams, sizeof(*c->hashes));
 106     if (!c->hashes)
 107         return AVERROR(ENOMEM);
 108     for (i = 0; i < s->nb_streams; i++) {
 109         res = av_hash_alloc(&c->hashes[i], c->hash_name);
 110         if (res < 0) {
 111             return res;
 112         }
 113         av_hash_init(c->hashes[i]);
 114     }
 115     return 0;
 116 }
 117 #endif
 118
 119 #if CONFIG_HASH_MUXER || CONFIG_MD5_MUXER || CONFIG_STREAMHASH_MUXER
 120 static char get_media_type_char(enum AVMediaType type)
 121 {
 122     switch (type) {
 123     case AVMEDIA_TYPE_VIDEO:      return 'v';
 124     case AVMEDIA_TYPE_AUDIO:      return 'a';
 125     case AVMEDIA_TYPE_DATA:       return 'd';
 126     case AVMEDIA_TYPE_SUBTITLE:   return 's';
 127     case AVMEDIA_TYPE_ATTACHMENT: return 't';
 128     default:                      return '?';
 129     }
 130 }
 131
 132 static int hash_write_packet(struct AVFormatContext *s, AVPacket *pkt)
 133 {
 134     struct HashContext *c = s->priv_data;
 135     av_hash_update(c->hashes[c->per_stream ? pkt->stream_index : 0], pkt->data, pkt->size);
 136     return 0;
 137 }
 138
 139 static int hash_write_trailer(struct AVFormatContext *s)
 140 {
 141     struct HashContext *c = s->priv_data;
 142     int num_hashes = c->per_stream ? s->nb_streams : 1;
 143     for (int i = 0; i < num_hashes; i++) {
 144         char buf[AV_HASH_MAX_SIZE*2+128];
 145         if (c->per_stream) {
 146             AVStream *st = s->streams[i];
 147             snprintf(buf, sizeof(buf) - 200, "%d,%c,%s=", i, get_media_type_char(st->codecpar->codec_type),
 148                      av_hash_get_name(c->hashes[i]));
 149         } else {
 150             snprintf(buf, sizeof(buf) - 200, "%s=", av_hash_get_name(c->hashes[i]));
 151         }
 152         av_hash_final_hex(c->hashes[i], buf + strlen(buf), sizeof(buf) - strlen(buf));
 153         av_strlcatf(buf, sizeof(buf), "\n");
 154         avio_write(s->pb, buf, strlen(buf));
 155     }
 156
 157     return 0;
 158 }
 159
 160 static void hash_free(struct AVFormatContext *s)
 161 {
 162     struct HashContext *c = s->priv_data;
 163     if (c->hashes) {
 164         int num_hashes = c->per_stream ? s->nb_streams : 1;
 165         for (int i = 0; i < num_hashes; i++) {
 166             av_hash_freep(&c->hashes[i]);
 167         }
 168     }
 169     av_freep(&c->hashes);
 170 }
 171 #endif
 172
 173 #if CONFIG_HASH_MUXER
 174 static const AVClass hashenc_class = {
 175     .class_name = "hash muxer",
 176     .item_name  = av_default_item_name,
 177     .option     = hash_options,
 178     .version    = LIBAVUTIL_VERSION_INT,
 179 };
 180
 181 AVOutputFormat ff_hash_muxer = {
 182     .name              = "hash",
 183     .long_name         = NULL_IF_CONFIG_SMALL("Hash testing"),
 184     .priv_data_size    = sizeof(struct HashContext),
 185     .audio_codec       = AV_CODEC_ID_PCM_S16LE,
 186     .video_codec       = AV_CODEC_ID_RAWVIDEO,
 187     .init              = hash_init,
 188     .write_packet      = hash_write_packet,
 189     .write_trailer     = hash_write_trailer,
 190     .deinit            = hash_free,
 191     .flags             = AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT |
 192                          AVFMT_TS_NEGATIVE,
 193     .priv_class        = &hashenc_class,
 194 };
 195 #endif
 196
 197 #if CONFIG_MD5_MUXER
 198 static const AVClass md5enc_class = {
 199     .class_name = "MD5 muxer",
 200     .item_name  = av_default_item_name,
 201     .option     = md5_options,
 202     .version    = LIBAVUTIL_VERSION_INT,
 203 };
 204
 205 AVOutputFormat ff_md5_muxer = {
 206     .name              = "md5",
 207     .long_name         = NULL_IF_CONFIG_SMALL("MD5 testing"),
 208     .priv_data_size    = sizeof(struct HashContext),
 209     .audio_codec       = AV_CODEC_ID_PCM_S16LE,
 210     .video_codec       = AV_CODEC_ID_RAWVIDEO,
 211     .init              = hash_init,
 212     .write_packet      = hash_write_packet,
 213     .write_trailer     = hash_write_trailer,
 214     .deinit            = hash_free,
 215     .flags             = AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT |
 216                          AVFMT_TS_NEGATIVE,
 217     .priv_class        = &md5enc_class,
 218 };
 219 #endif
 220
 221 #if CONFIG_STREAMHASH_MUXER
 222 static const AVClass streamhashenc_class = {
 223     .class_name = "stream hash muxer",
 224     .item_name  = av_default_item_name,
 225     .option     = streamhash_options,
 226     .version    = LIBAVUTIL_VERSION_INT,
 227 };
 228
 229 AVOutputFormat ff_streamhash_muxer = {
 230     .name              = "streamhash",
 231     .long_name         = NULL_IF_CONFIG_SMALL("Per-stream hash testing"),
 232     .priv_data_size    = sizeof(struct HashContext),
 233     .audio_codec       = AV_CODEC_ID_PCM_S16LE,
 234     .video_codec       = AV_CODEC_ID_RAWVIDEO,
 235     .init              = streamhash_init,
 236     .write_packet      = hash_write_packet,
 237     .write_trailer     = hash_write_trailer,
 238     .deinit            = hash_free,
 239     .flags             = AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT |
 240                          AVFMT_TS_NEGATIVE,
 241     .priv_class        = &streamhashenc_class,
 242 };
 243 #endif
 244
 245 #if CONFIG_FRAMEHASH_MUXER || CONFIG_FRAMEMD5_MUXER
 246 static void framehash_print_extradata(struct AVFormatContext *s)
 247 {
 248     int i;
 249
 250     for (i = 0; i < s->nb_streams; i++) {
 251         AVStream *st = s->streams[i];
 252         AVCodecParameters *par = st->codecpar;
 253         if (par->extradata) {
 254             struct HashContext *c = s->priv_data;
 255             char buf[AV_HASH_MAX_SIZE*2+1];
 256
 257             avio_printf(s->pb, "#extradata %d, %31d, ", i, par->extradata_size);
 258             av_hash_init(c->hashes[0]);
 259             av_hash_update(c->hashes[0], par->extradata, par->extradata_size);
 260             av_hash_final_hex(c->hashes[0], buf, sizeof(buf));
 261             avio_write(s->pb, buf, strlen(buf));
 262             avio_printf(s->pb, "\n");
 263         }
 264     }
 265 }
 266
 267 static int framehash_init(struct AVFormatContext *s)
 268 {
 269     int res;
 270     struct HashContext *c = s->priv_data;
 271     c->per_stream = 0;
 272     c->hashes = av_mallocz_array(1, sizeof(*c->hashes));
 273     if (!c->hashes)
 274         return AVERROR(ENOMEM);
 275     res = av_hash_alloc(&c->hashes[0], c->hash_name);
 276     if (res < 0)
 277         return res;
 278     return 0;
 279 }
 280
 281 static int framehash_write_header(struct AVFormatContext *s)
 282 {
 283     struct HashContext *c = s->priv_data;
 284     avio_printf(s->pb, "#format: frame checksums\n");
 285     avio_printf(s->pb, "#version: %d\n", c->format_version);
 286     avio_printf(s->pb, "#hash: %s\n", av_hash_get_name(c->hashes[0]));
 287     framehash_print_extradata(s);
 288     ff_framehash_write_header(s);
 289     avio_printf(s->pb, "#stream#, dts,        pts, duration,     size, hash\n");
 290     return 0;
 291 }
 292
 293 static int framehash_write_packet(struct AVFormatContext *s, AVPacket *pkt)
 294 {
 295     struct HashContext *c = s->priv_data;
 296     char buf[AV_HASH_MAX_SIZE*2+128];
 297     int len;
 298     av_hash_init(c->hashes[0]);
 299     av_hash_update(c->hashes[0], pkt->data, pkt->size);
 300
 301     snprintf(buf, sizeof(buf) - (AV_HASH_MAX_SIZE * 2 + 1), "%d, %10"PRId64", %10"PRId64", %8"PRId64", %8d, ",
 302              pkt->stream_index, pkt->dts, pkt->pts, pkt->duration, pkt->size);
 303     len = strlen(buf);
 304     av_hash_final_hex(c->hashes[0], buf + len, sizeof(buf) - len);
 305     avio_write(s->pb, buf, strlen(buf));
 306
 307     if (c->format_version > 1 && pkt->side_data_elems) {
 308         int i, j;
 309         avio_printf(s->pb, ", S=%d", pkt->side_data_elems);
 310         for (i = 0; i < pkt->side_data_elems; i++) {
 311             av_hash_init(c->hashes[0]);
 312             if (HAVE_BIGENDIAN && pkt->side_data[i].type == AV_PKT_DATA_PALETTE) {
 313                 for (j = 0; j < pkt->side_data[i].size; j += sizeof(uint32_t)) {
 314                     uint32_t data = AV_RL32(pkt->side_data[i].data + j);
 315                     av_hash_update(c->hashes[0], (uint8_t *)&data, sizeof(uint32_t));
 316                 }
 317             } else
 318                 av_hash_update(c->hashes[0], pkt->side_data[i].data, pkt->side_data[i].size);
 319             snprintf(buf, sizeof(buf) - (AV_HASH_MAX_SIZE * 2 + 1), ", %8d, ", pkt->side_data[i].size);
 320             len = strlen(buf);
 321             av_hash_final_hex(c->hashes[0], buf + len, sizeof(buf) - len);
 322             avio_write(s->pb, buf, strlen(buf));
 323         }
 324     }
 325
 326     avio_printf(s->pb, "\n");
 327     return 0;
 328 }
 329
 330 static void framehash_free(struct AVFormatContext *s)
 331 {
 332     struct HashContext *c = s->priv_data;
 333     if (c->hashes)
 334         av_hash_freep(&c->hashes[0]);
 335     av_freep(&c->hashes);
 336 }
 337 #endif
 338
 339 #if CONFIG_FRAMEHASH_MUXER
 340 static const AVClass framehash_class = {
 341     .class_name = "frame hash muxer",
 342     .item_name  = av_default_item_name,
 343     .option     = framehash_options,
 344     .version    = LIBAVUTIL_VERSION_INT,
 345 };
 346
 347 AVOutputFormat ff_framehash_muxer = {
 348     .name              = "framehash",
 349     .long_name         = NULL_IF_CONFIG_SMALL("Per-frame hash testing"),
 350     .priv_data_size    = sizeof(struct HashContext),
 351     .audio_codec       = AV_CODEC_ID_PCM_S16LE,
 352     .video_codec       = AV_CODEC_ID_RAWVIDEO,
 353     .init              = framehash_init,
 354     .write_header      = framehash_write_header,
 355     .write_packet      = framehash_write_packet,
 356     .deinit            = framehash_free,
 357     .flags             = AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT |
 358                          AVFMT_TS_NEGATIVE,
 359     .priv_class        = &framehash_class,
 360 };
 361 #endif
 362
 363 #if CONFIG_FRAMEMD5_MUXER
 364 static const AVClass framemd5_class = {
 365     .class_name = "frame MD5 muxer",
 366     .item_name  = av_default_item_name,
 367     .option     = framemd5_options,
 368     .version    = LIBAVUTIL_VERSION_INT,
 369 };
 370
 371 AVOutputFormat ff_framemd5_muxer = {
 372     .name              = "framemd5",
 373     .long_name         = NULL_IF_CONFIG_SMALL("Per-frame MD5 testing"),
 374     .priv_data_size    = sizeof(struct HashContext),
 375     .audio_codec       = AV_CODEC_ID_PCM_S16LE,
 376     .video_codec       = AV_CODEC_ID_RAWVIDEO,
 377     .init              = framehash_init,
 378     .write_header      = framehash_write_header,
 379     .write_packet      = framehash_write_packet,
 380     .deinit            = framehash_free,
 381     .flags             = AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT |
 382                          AVFMT_TS_NEGATIVE,
 383     .priv_class        = &framemd5_class,
 384 };
 385 #endif