filters/xz/xzfile.h

   1 /* nbdkit
   2  * Copyright Red Hat
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *
  11  * * Redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the distribution.
  14  *
  15  * * Neither the name of Red Hat nor the names of its contributors may be
  16  * used to endorse or promote products derived from this software without
  17  * specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 /* liblzma is a complex interface, so abstract it here. */
  34
  35 #ifndef NBDKIT_XZFILE_H
  36 #define NBDKIT_XZFILE_H
  37
  38 #include <nbdkit-filter.h>
  39
  40 typedef struct xzfile xzfile;
  41
  42 /* Open (and verify) the named xz file. */
  43 extern xzfile *xzfile_open (nbdkit_next *next);
  44
  45 /* Close the file and free up all resources. */
  46 extern void xzfile_close (xzfile *);
  47
  48 /* Get (uncompressed) size of the largest block in the file. */
  49 extern uint64_t xzfile_max_uncompressed_block_size (xzfile *);
  50
  51 /* Get the total uncompressed size of the file. */
  52 extern uint64_t xzfile_get_size (xzfile *);
  53
  54 /* Read the xz file block that contains the byte at 'offset' in the
  55  * uncompressed file.
  56  *
  57  * The uncompressed block of data, which probably begins before the
  58  * requested byte and ends after it, is returned.  The caller must
  59  * free it.  NULL is returned if there was an error.
  60  *
  61  * The start offset & size of the block relative to the uncompressed
  62  * file are returned in *start and *size.
  63  */
  64 extern char *xzfile_read_block (xzfile *xz,
  65                                 nbdkit_next *next,
  66                                 uint32_t flags, int *err,
  67                                 uint64_t offset,
  68                                 uint64_t *start, uint64_t *size);
  69
  70 #endif /* NBDKIT_XZFILE_H */