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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

/**
 * @ingroup  file68_lib
 * @file     sc68/istream68_def.h
 * @author   Benjamin Gerard
 * @date     2003-08-08
 * @brief    Generic stream definition header.
 *
 */

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

#ifndef _FILE68_ISTREAM68_DEF_H_
#define _FILE68_ISTREAM68_DEF_H_

#include "istream68.h"

/**
 *  @name     Open modes
 *  @ingroup  file68_istream
 *  @{
 */

/**
 *Read open mode bit.
 */
#define ISTREAM68_OPEN_READ_BIT 0

/**
 * Read open mode value.
 */
#define ISTREAM68_OPEN_READ  (1<<ISTREAM68_OPEN_READ_BIT)

/**
 * Write open mode bit.
 */
#define ISTREAM68_OPEN_WRITE_BIT 1

/**
 * Write open mode value.
 */
#define ISTREAM68_OPEN_WRITE (1<<ISTREAM68_OPEN_WRITE_BIT)

/**
 * Open modes mask.
 */
#define ISTREAM68_OPEN_MASK (ISTREAM68_OPEN_READ|ISTREAM68_OPEN_WRITE)

/**
 * Test if any open flags is set (returns 0 or 1).
 */
#define ISTREAM68_IS_OPEN(V) (!!((V)&(ISTREAM68_OPEN_READ|ISTREAM68_OPEN_WRITE)))

/**
 * Test if READ open flags is set (returns 0 or 1).
 */
#define ISTREAM68_IS_OPEN_READ(V) (((V)>>ISTREAM68_OPEN_READ_BIT)&1)

/**
 * Test if WRITE open flags is set (returns 0 or 1).
 */
#define ISTREAM68_IS_OPEN_WRITE(V) (((V)>>ISTREAM68_OPEN_WRITE_BIT)&1)

/**
 * @}
 */

/**
 *  @name     Stream function prototypes.
 *  @ingroup  file68_istream
 *  @{
 */
typedef const char * (* istream68_name_t) (istream68_t *);
typedef int  (* istream68_open_t)    (istream68_t *);
typedef int  (* istream68_close_t)   (istream68_t *);
typedef int  (* istream68_length_t)  (istream68_t *);
typedef int  (* istream68_flush_t)   (istream68_t *);
typedef int  (* istream68_tell_t)    (istream68_t *);
typedef int  (* istream68_seek_t)    (istream68_t *, int);
typedef int  (* istream68_read_t)    (istream68_t *, void *, int);
typedef int  (* istream68_write_t)   (istream68_t *, const void *, int);
typedef void (* istream68_destroy_t) (istream68_t *);
/**
 * @}
 */

/**
 *  Generic stream structure.
 *
 *     Set of functions needed to handle a stream.
 *
 *  @ingroup  file68_istream
 */
struct _istream68_t {
  istream68_name_t    name;    /**< Get stream name.        */
  istream68_open_t    open;    /**< Open stream.            */
  istream68_close_t   close;   /**< Close stream.           */
  istream68_read_t    read;    /**< Read data from stream.  */
  istream68_write_t   write;   /**< Write data to stream.   */
  istream68_flush_t   flush;   /**< Flush data.             */
  istream68_length_t  length;  /**< Get stream data length. */
  istream68_tell_t    tell;    /**< Get stream position.    */
  istream68_seek_t    seekf;   /**< Seek forward.           */
  istream68_seek_t    seekb;   /**< Seek backward.          */
  istream68_destroy_t destroy; /**< Destructor.             */
};

#endif /* #ifndef _FILE68_ISTREAM68_DEF_H_ */