Mercurial > mplayer.hg
comparison playtreeparser.h @ 18265:1a14fde7680d
Doxygen Attack! - Chapter 3
author | albeu |
---|---|
date | Tue, 25 Apr 2006 01:26:10 +0000 |
parents | 4bc481804519 |
children | b3be7df634b0 |
comparison
equal
deleted
inserted
replaced
18264:bbb63cea568b | 18265:1a14fde7680d |
---|---|
1 | |
2 /// \defgroup PlaytreeParser Playtree parser | |
3 /// \ingroup Playtree | |
4 /// | |
5 /// The playtree parser allow to read various playlist formats. It read from | |
6 /// stream allowing to handle playlist from local files and the network. | |
7 ///@{ | |
8 | |
9 /// \file | |
1 | 10 |
2 #ifndef __PLAYTREEPARSER_H | 11 #ifndef __PLAYTREEPARSER_H |
3 #define __PLAYTREEPARSER_H | 12 #define __PLAYTREEPARSER_H |
4 | 13 |
5 struct stream_st; | 14 struct stream_st; |
9 char *buffer,*iter,*line; | 18 char *buffer,*iter,*line; |
10 int buffer_size , buffer_end; | 19 int buffer_size , buffer_end; |
11 int deep,keep; | 20 int deep,keep; |
12 } play_tree_parser_t; | 21 } play_tree_parser_t; |
13 | 22 |
14 | 23 /// Create a new parser. |
24 /** \param stream The stream to read from. | |
25 * \param deep Parser depth. Some format allow including other files, | |
26 * this is used to track the inclusion depth. | |
27 * \return The new parser. | |
28 */ | |
15 play_tree_parser_t* | 29 play_tree_parser_t* |
16 play_tree_parser_new(struct stream_st* stream,int deep); | 30 play_tree_parser_new(struct stream_st* stream,int deep); |
17 | 31 |
32 /// Destroy a parser. | |
18 void | 33 void |
19 play_tree_parser_free(play_tree_parser_t* p); | 34 play_tree_parser_free(play_tree_parser_t* p); |
20 | 35 |
36 /// Build a playtree from the playlist opened with the parser. | |
37 /** \param p The parser. | |
38 * \param forced If non-zero the playlist file was explicitly | |
39 * given by the user, allow falling back on | |
40 * one filename per line playlist. | |
41 * \return A new playtree or NULL on error. | |
42 */ | |
21 play_tree_t* | 43 play_tree_t* |
22 play_tree_parser_get_play_tree(play_tree_parser_t* p, int forced); | 44 play_tree_parser_get_play_tree(play_tree_parser_t* p, int forced); |
23 | 45 |
46 /// Wrapper for play_tree_add_basepath (add base path from file). | |
24 void | 47 void |
25 play_tree_add_bpf(play_tree_t* pt, char* filename); | 48 play_tree_add_bpf(play_tree_t* pt, char* filename); |
26 | 49 |
27 #endif | 50 #endif |
51 | |
52 ///@} |