git.sesse.net Git - ffmpeg/blob - libavcodec/snappy.h

   1 /*
   2  * Snappy module
   3  * Copyright (c) Luca Barbato
   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  * Snappy decompression
  25  *
  26  * Snappy is a compression/decompression algorithm that does not aim for
  27  * maximum compression, but rather for very high speeds and reasonable
  28  * compression.
  29  *
  30  * http://en.wikipedia.org/wiki/Snappy_%28software%29
  31  */
  32
  33 #ifndef AVCODEC_SNAPPY_H
  34 #define AVCODEC_SNAPPY_H
  35
  36 #include <stdint.h>
  37
  38 #include "bytestream.h"
  39
  40 /**
  41  * Get the uncompressed length of an input buffer compressed using the Snappy
  42  * algorithm. The GetByteContext is not advanced.
  43  *
  44  * @param gb    input GetByteContext.
  45  * @return      A positive length on success, AVERROR otherwise.
  46  */
  47  int64_t ff_snappy_peek_uncompressed_length(GetByteContext *gb);
  48
  49 /**
  50  * Decompress an input buffer using Snappy algorithm.
  51  *
  52  * @param gb    input GetByteContext.
  53  * @param buf   input buffer pointer.
  54  * @param size  input/output on input, the size of buffer, on output, the size
  55  *              of the uncompressed data.
  56  * @return      0 if success, AVERROR otherwise.
  57  */
  58 int ff_snappy_uncompress(GetByteContext *gb, uint8_t *buf, int64_t *size);
  59
  60 #endif /* AVCODEC_SNAPPY_H */