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

/**
 * @ingroup  file68_lib
 * @file     sc68/istream68_curl.h
 * @author   Benjamin Gerard
 * @date     2003-08-08
 * @brief    @ref cURL stream header.
 *
 */

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

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

#ifndef _FILE68_ISTREAM68_CURL_H_
#define _FILE68_ISTREAM68_CURL_H_

#include "istream68.h"

/** @name     cURL stream
 *  @ingroup  file68_istream
 *
 *  @anchor cURL
 *
 *    @b cURL is a client-side URL transfer library. For more informations
 *    see <a href="http://curl.planetmirror.com/libcurl/">cURL website</a>.
 *
 *  @{
 */

FILE68_EXTERN
/** Initialize curl engine.
 *
 *    The istream68_curl_init() function initializes curl library.  It
 *    is called by the file68_init() function and everytime a new curl
 *    stream is created with the istream68_curl_create() function.
 *
 *  @return error code
 *  @retval  0   success
 *  @retval  -1  failure
 */
int istream68_curl_init(void);

FILE68_EXTERN
/** Shutdown curl engine.
 *
 *    The istream68_curl_shutdoen() function shutdown curl library. It
 *    is called by the file68_shutdown() function.
 */
void istream68_curl_shutdown(void);

FILE68_EXTERN
/** Creates an URL based stream using @ref cURL.
 *
 *  @param  url     URL
 *  @param  mode    bit#0: read access, bit#1: write access.
 *
 *  @return stream
 *  @retval 0 on error
 *
 *  @note     url is internally copied.
 *  @todo     Implement write mode.
 */
istream68_t * istream68_curl_create(const char * url, int mode);

/** @} */

#endif /* #define _FILE68_ISTREAM68_CURL_H_ */