summaryrefslogtreecommitdiff
path: root/pjmedia/include/pjmedia/file_port.h
blob: 363f94e0416de067e98814c05c8d7c5d930699cf (plain)
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
/* $Id$ */
/* 
 * Copyright (C) 2003-2006 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJMEDIA_FILE_PORT_H__
#define __PJMEDIA_FILE_PORT_H__

/**
 * @file file_port.h
 * @brief File player and recorder.
 */
#include <pjmedia/port.h>



PJ_BEGIN_DECL


/**
 * Create a media port to play streams from a WAV file.
 *
 * @param pool		Pool to create memory buffers for this port.
 * @param filename	File name to open.
 * @param flags		Port creation flags.
 * @param buf_size	Buffer size to be allocated. If the value is zero or
 *			negative, the port will use default buffer size (which
 *			is about 4KB).
 * @param user_data	User data to be associated with the file player port.
 * @param p_port	Pointer to receive the file port instance.
 *
 * @return		PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjmedia_file_player_port_create( pj_pool_t *pool,
						      const char *filename,
						      unsigned flags,
						      pj_ssize_t buff_size,
						      void *user_data,
						      pjmedia_port **p_port );



/**
 * Create a media port to record streams to a WAV file. Note that the port
 * must be closed properly (with #pjmedia_port_destroy()) so that the WAV
 * header can be filled with correct values (such as the file length).
 *
 * @param pool		Pool to create memory buffers for this port.
 * @param filename	File name.
 * @param flags		Port creation flags.
 * @param buf_size	Buffer size to be allocated. If the value is zero or
 *			negative, the port will use default buffer size (which
 *			is about 4KB).
 * @param user_data	User data to be associated with the file writer port.
 * @param p_port	Pointer to receive the file port instance.
 *
 * @return		PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjmedia_file_writer_port_create( pj_pool_t *pool,
						      const char *filename,
						      unsigned sampling_rate,
						      unsigned channel_count,
						      unsigned samples_per_frame,
						      unsigned bits_per_sample,
						      unsigned flags,
						      pj_ssize_t buff_size,
						      void *user_data,
						      pjmedia_port **p_port );




PJ_END_DECL


#endif	/* __PJMEDIA_FILE_PORT_H__ */