musix 0.3.5

Music player library for esoteric audio formats (music from C64,Amiga etc)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

/**
 * @ingroup  file68_lib
 * @file     sc68/istream68_z.h
 * @author   Benjamin Gerard
 * @date     2003-10-06
 * @brief    Zlib stream header.
 *
 */

/* $Id: istream68_z.h 102 2009-03-14 17:21:58Z benjihan $ */

/* Copyright (C) 1998-2009 Benjamin Gerard */

#ifndef _FILE68_ISTREAM68_Z_H_
#define _FILE68_ISTREAM68_Z_H_

#include "istream68.h"

/** @name     Z stream
 *  @ingroup  file68_istream
 *
 *  @anchor zlib
 *
 *    Implements istream68_t for Z library.
 *    Z is a famous compression/decompression library. For more informations
 *    see <a href="http://www.gzip.org">gzip website</a>.
 *
 *  @todo      deflate (compression) mode.
 *  @{
 */

/** gzip options. */
typedef struct {
  unsigned int gzip:1;     /**< Read/Write gzip file format.                */
  unsigned int level:4;    /**< Compression level [0..9] or -1 for default. */
  unsigned int strategy:3; /**< Compression strategy (0 is default).        */
  unsigned int name:1;     /**< Include original name to gzip.              */
} istream68_z_option_t;

/** Default gzip option. */
FILE68_EXTERN
const istream68_z_option_t istream68_z_default_option;

FILE68_EXTERN
/** Create a @ref zlib "Z" stream.
 *
 *  @param  is     Stream to compress/decompress.
 *  @param  mode   bit-0: read access, bit-1: write access.
 *  @param  opt    gzip options.
 *
 *  @return stream
 *  @retval 0 on error
 */
istream68_t * istream68_z_create(istream68_t * is, int mode,
                                 const istream68_z_option_t opt);

/** @} */

#endif /* #define _FILE68_ISTREAM68_Z_H_ */