c51bf681cf4d2986775134dcdc7139f58ac19c87
[asterisk/asterisk.git] / include / asterisk / mod_format.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Header for providers of file and format handling routines.
21  * Clients of these routines should include "asterisk/file.h" instead.
22  */
23
24 #ifndef _ASTERISK_MOD_FORMAT_H
25 #define _ASTERISK_MOD_FORMAT_H
26
27 #include "asterisk/file.h"
28 #include "asterisk/frame.h"
29
30 #if defined(__cplusplus) || defined(c_plusplus)
31 extern "C" {
32 #endif
33
34 /*! \brief
35  * Each supported file format is described by the following structure.
36  *
37  * Not all are necessary, the support routine implement default
38  * values for some of them.
39  * A handler typically fills a structure initializing the desired
40  * fields, and then calls ast_format_register() with the (readonly)
41  * structure as an argument.
42  */
43 struct ast_format {
44         char name[80];          /*!< Name of format */
45         char exts[80];          /*!< Extensions (separated by | if more than one) 
46                                 this format can read.  First is assumed for writing (e.g. .mp3) */
47         int format;             /*!< Format of frames it uses/provides (one only) */
48         /*! 
49          * \brief Prepare an input stream for playback. 
50          * \return 0 on success, -1 on error.
51          * The FILE is already open (in s->f) so this function only needs to perform
52          * any applicable validity checks on the file. If none is required, the
53          * function can be omitted.
54          */
55         int (*open)(struct ast_filestream *s);
56         /*! 
57          * \brief Prepare a stream for output, and comment it appropriately if applicable.
58          * \return 0 on success, -1 on error. 
59          * Same as the open, the FILE is already open so the function just needs to 
60          * prepare any header and other fields, if any. 
61          * The function can be omitted if nothing is needed.
62          */
63         int (*rewrite)(struct ast_filestream *s, const char *comment);
64         /*! Write a frame to a channel */
65         int (*write)(struct ast_filestream *, struct ast_frame *);
66         /*! seek num samples into file, whence - like a normal seek but with offset in samples */
67         int (*seek)(struct ast_filestream *, off_t, int);
68         int (*trunc)(struct ast_filestream *fs);        /*!< trunc file to current position */
69         off_t (*tell)(struct ast_filestream *fs);       /*!< tell current position */
70         /*! Read the next frame from the filestream (if available) and report
71          * when to get next frame (in samples)
72          */
73         struct ast_frame * (*read)(struct ast_filestream *, int *whennext);
74         /*! Do any closing actions, if any. The descriptor and structure are closed
75          * and destroyed by the generic routines, so they must not be done here. */
76         void (*close)(struct ast_filestream *);
77         char * (*getcomment)(struct ast_filestream *);          /*!< Retrieve file comment */
78
79         AST_LIST_ENTRY(ast_format) list;                        /*!< Link */
80
81         /*!
82          * If the handler needs a buffer (for read, typically)
83          * and/or a private descriptor, put here the
84          * required size (in bytes) and the support routine will allocate them
85          * for you, pointed by s->buf and s->private, respectively.
86          * When allocating a buffer, remember to leave AST_FRIENDLY_OFFSET
87          * spare bytes at the bginning.
88          */
89         int buf_size;                   /*!< size of frame buffer, if any, aligned to 8 bytes. */
90         int desc_size;                  /*!< size of private descriptor, if any */
91
92         struct ast_module *module;
93 };
94
95 /*! \brief
96  * This structure is allocated by file.c in one chunk,
97  * together with buf_size and desc_size bytes of memory
98  * to be used for private purposes (e.g. buffers etc.)
99  */
100 struct ast_filestream {
101         /*! Everybody reserves a block of AST_RESERVED_POINTERS pointers for us */
102         struct ast_format *fmt; /* need to write to the lock and usecnt */
103         int flags;
104         mode_t mode;
105         char *filename;
106         char *realfilename;
107         /*! Video file stream */
108         struct ast_filestream *vfs;
109         /*! Transparently translate from another format -- just once */
110         struct ast_trans_pvt *trans;
111         struct ast_tranlator_pvt *tr;
112         int lastwriteformat;
113         int lasttimeout;
114         struct ast_channel *owner;
115         FILE *f;
116         struct ast_frame fr;    /*!< frame produced by read, typically */
117         char *buf;              /*!< buffer pointed to by ast_frame; */
118         void *_private; /*!< pointer to private buffer */
119         const char *orig_chan_name;
120 };
121
122 /*! 
123  * \brief Register a new file format capability.
124  * Adds a format to Asterisk's format abilities.
125  * \retval 0 on success
126  * \retval -1 on failure
127  */
128 int __ast_format_register(const struct ast_format *f, struct ast_module *mod);
129 #define ast_format_register(f) __ast_format_register(f, ast_module_info->self)
130
131 /*! 
132  * \brief Unregisters a file format 
133  * \param name the name of the format you wish to unregister
134  * Unregisters a format based on the name of the format.
135  * \retval 0 on success
136  * \retval -1 on failure to unregister
137  */
138 int ast_format_unregister(const char *name);
139
140 #if defined(__cplusplus) || defined(c_plusplus)
141 }
142 #endif
143
144 #endif /* _ASTERISK_MOD_FORMAT_H */