snappy.h 1.9 KB

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