Asterisk - The Open Source Telephony Project GIT-master-754dea3
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Modules Pages
Macros | Typedefs | Enumerations | Functions
file.h File Reference

Generic File Format Support. Should be included by clients of the file handling routines. File service providers should instead include mod_format.h. More...

Go to the source code of this file.

Macros

#define AST_DIGIT_ANY   "0123456789#*ABCD"
 
#define AST_DIGIT_ANYNUM   "0123456789"
 
#define AST_DIGIT_NONE   ""
 
#define ast_file_read_dir(dir_name, on_file, obj)   ast_file_read_dirs(dir_name, on_file, obj, 1)
 Iterate over each file in a given directory. More...
 
#define AST_MAX_FORMATS   10
 
#define AST_RESERVED_POINTERS   20
 
#define SEEK_FORCECUR   10
 

Typedefs

typedef int(* ast_file_on_file) (const char *dir_name, const char *filename, void *obj)
 Callback called for each file found when reading directories. More...
 
typedef void() ast_waitstream_fr_cb(struct ast_channel *chan, long ms, enum ast_waitstream_fr_cb_values val)
 callback used during dtmf controlled file playback to indicate location of playback in a file after rewinding or fastforwarding a file. More...
 

Enumerations

enum  ast_waitstream_fr_cb_values { AST_WAITSTREAM_CB_REWIND = 1 , AST_WAITSTREAM_CB_FASTFORWARD , AST_WAITSTREAM_CB_START }
 

Functions

int ast_applystream (struct ast_channel *chan, struct ast_filestream *s)
 Applies a open stream to a channel. More...
 
int ast_closestream (struct ast_filestream *f)
 Closes a stream. More...
 
int ast_file_fdtemp (const char *path, char **filename, const char *template_name)
 Create a temporary file located at path. More...
 
int ast_file_init (void)
 
FILE * ast_file_mkftemp (char *template_name, mode_t mode)
 same as mkstemp, but return a FILE More...
 
int ast_file_read_dirs (const char *dir_name, ast_file_on_file on_file, void *obj, int max_depth)
 Recursively iterate through files and directories up to max_depth. More...
 
int ast_filecopy (const char *oldname, const char *newname, const char *fmt)
 Copies a file. More...
 
int ast_filedelete (const char *filename, const char *fmt)
 Deletes a file. More...
 
int ast_fileexists (const char *filename, const char *fmt, const char *preflang)
 Checks for the existence of a given file. More...
 
int ast_filerename (const char *oldname, const char *newname, const char *fmt)
 Renames a file. More...
 
char * ast_format_str_reduce (char *fmts)
 
int ast_get_extension_for_mime_type (const char *mime_type, char *buffer, size_t capacity)
 Get a suitable filename extension for the given MIME type. More...
 
struct ast_formatast_get_format_for_file_ext (const char *file_ext)
 Get the ast_format associated with the given file extension. More...
 
struct ast_filestreamast_openstream (struct ast_channel *chan, const char *filename, const char *preflang)
 Opens stream for use in seeking, playing. More...
 
struct ast_filestreamast_openstream_full (struct ast_channel *chan, const char *filename, const char *preflang, int asis)
 Opens stream for use in seeking, playing. More...
 
struct ast_filestreamast_openvstream (struct ast_channel *chan, const char *filename, const char *preflang)
 Opens stream for use in seeking, playing. More...
 
int ast_playstream (struct ast_filestream *s)
 Play a open stream on a channel. More...
 
int ast_ratestream (struct ast_filestream *fs)
 Return the sample rate of the stream's format. More...
 
struct ast_filestreamast_readfile (const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
 Starts reading from a file. More...
 
struct ast_frameast_readframe (struct ast_filestream *s)
 Read a frame from a filestream. More...
 
int ast_seekstream (struct ast_filestream *fs, off_t sample_offset, int whence)
 Seeks into stream. More...
 
int ast_stopstream (struct ast_channel *c)
 Stops a stream. More...
 
int ast_stream_and_wait (struct ast_channel *chan, const char *file, const char *digits)
 stream file until digit If the file name is non-empty, try to play it. More...
 
int ast_stream_fastforward (struct ast_filestream *fs, off_t ms)
 Fast forward stream ms. More...
 
int ast_stream_rewind (struct ast_filestream *fs, off_t ms)
 Rewind stream ms. More...
 
int ast_streamfile (struct ast_channel *c, const char *filename, const char *preflang)
 Streams a file. More...
 
off_t ast_tellstream (struct ast_filestream *fs)
 Tell where we are in a stream. More...
 
int ast_truncstream (struct ast_filestream *fs)
 Trunc stream at current location. More...
 
int ast_waitstream (struct ast_channel *c, const char *breakon)
 Waits for a stream to stop or digit to be pressed. More...
 
int ast_waitstream_exten (struct ast_channel *c, const char *context)
 Waits for a stream to stop or digit matching a valid one digit exten to be pressed. More...
 
int ast_waitstream_fr (struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms)
 Same as waitstream but allows stream to be forwarded or rewound. More...
 
int ast_waitstream_fr_w_cb (struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms, ast_waitstream_fr_cb cb)
 Same as waitstream_fr but allows a callback to be alerted when a user fastforwards or rewinds the file. More...
 
int ast_waitstream_full (struct ast_channel *c, const char *breakon, int audiofd, int monfd)
 
struct ast_filestreamast_writefile (const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
 Starts writing a file. More...
 
int ast_writestream (struct ast_filestream *fs, struct ast_frame *f)
 Writes a frame to a stream. More...
 

Detailed Description

Generic File Format Support. Should be included by clients of the file handling routines. File service providers should instead include mod_format.h.

Definition in file file.h.

Macro Definition Documentation

◆ AST_DIGIT_ANY

#define AST_DIGIT_ANY   "0123456789#*ABCD"

Definition at line 48 of file file.h.

◆ AST_DIGIT_ANYNUM

#define AST_DIGIT_ANYNUM   "0123456789"

Definition at line 49 of file file.h.

◆ AST_DIGIT_NONE

#define AST_DIGIT_NONE   ""

Convenient for waiting

Definition at line 47 of file file.h.

◆ ast_file_read_dir

#define ast_file_read_dir (   dir_name,
  on_file,
  obj 
)    ast_file_read_dirs(dir_name, on_file, obj, 1)

Iterate over each file in a given directory.

Parameters
dir_namethe name of the directory to search
on_filecallback called on each file
objuser data object
Returns
-1
Return values
errnoon failure
0otherwise

Definition at line 203 of file file.h.

◆ AST_MAX_FORMATS

#define AST_MAX_FORMATS   10

The maximum number of formats we expect to see in a format string

Definition at line 44 of file file.h.

◆ AST_RESERVED_POINTERS

#define AST_RESERVED_POINTERS   20

Definition at line 441 of file file.h.

◆ SEEK_FORCECUR

#define SEEK_FORCECUR   10

Definition at line 51 of file file.h.

Typedef Documentation

◆ ast_file_on_file

typedef int(* ast_file_on_file) (const char *dir_name, const char *filename, void *obj)

Callback called for each file found when reading directories.

Parameters
dir_namethe name of the directory
filenamethe name of the file
objuser data object
Return values
non-zeroto stop reading, otherwise zero to continue
Note
dir_name is not processed by realpath or other functions, symbolic links are not resolved. This ensures dir_name always starts with the exact string originally passed to ast_file_read_dir or ast_file_read_dirs.

Definition at line 180 of file file.h.

◆ ast_waitstream_fr_cb

typedef void() ast_waitstream_fr_cb(struct ast_channel *chan, long ms, enum ast_waitstream_fr_cb_values val)

callback used during dtmf controlled file playback to indicate location of playback in a file after rewinding or fastforwarding a file.

Definition at line 65 of file file.h.

Enumeration Type Documentation

◆ ast_waitstream_fr_cb_values

The type of event associated with a ast_waitstream_fr_cb invocation

Enumerator
AST_WAITSTREAM_CB_REWIND 
AST_WAITSTREAM_CB_FASTFORWARD 
AST_WAITSTREAM_CB_START 

Definition at line 54 of file file.h.

54 {
58};
@ AST_WAITSTREAM_CB_FASTFORWARD
Definition: file.h:56
@ AST_WAITSTREAM_CB_REWIND
Definition: file.h:55
@ AST_WAITSTREAM_CB_START
Definition: file.h:57

Function Documentation

◆ ast_applystream()

int ast_applystream ( struct ast_channel chan,
struct ast_filestream s 
)

Applies a open stream to a channel.

Parameters
chanchannel to work
sast_filestream to apply
Return values
0on success.
-1on failure.

Definition at line 1065 of file file.c.

1066{
1067 s->owner = chan;
1068 return 0;
1069}
struct ast_channel * owner
Definition: mod_format.h:116

References ast_filestream::owner.

Referenced by ast_streamfile(), handle_getoption(), handle_recordfile(), handle_streamfile(), and speech_streamfile().

◆ ast_closestream()

int ast_closestream ( struct ast_filestream f)

Closes a stream.

Parameters
ffilestream to close Close a playback or recording stream
Return values
0on success.
-1on failure.

Definition at line 1119 of file file.c.

1120{
1121 /* This used to destroy the filestream, but it now just decrements a refcount.
1122 * We close the stream in order to quit queuing frames now, because we might
1123 * change the writeformat, which could result in a subsequent write error, if
1124 * the format is different. */
1125 if (f == NULL) {
1126 return 0;
1127 }
1129 ao2_ref(f, -1);
1130 return 0;
1131}
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
static void filestream_close(struct ast_filestream *f)
Definition: file.c:392
#define NULL
Definition: resample.c:96

References ao2_ref, ast_filestream::f, filestream_close(), and NULL.

Referenced by __ast_play_and_record(), ast_hangup(), ast_moh_files_next(), ast_readfile(), ast_stopstream(), ast_writefile(), dictate_exec(), filehelper(), filestream_destructor(), gen_closestream(), handle_cli_file_convert(), handle_recordfile(), local_ast_moh_stop(), mixmonitor_ds_close_fs(), moh_files_release(), msg_create_from_file(), record_exec(), and recordthread().

◆ ast_file_fdtemp()

int ast_file_fdtemp ( const char *  path,
char **  filename,
const char *  template_name 
)

Create a temporary file located at path.

Note
The directory containing path will be created if it does not exist
This function assumes path does not end with a '/'
Parameters
pathThe directory path to create the file in
filenameFunction allocates memory and stores full filename (including path) here
template_namemkstemp template to use. Must end with XXXXXX.
Note
filename will need to be freed with ast_free if this function succeeds
Return values
-1on failure
Returns
file descriptor on success

Definition at line 202 of file file.c.

203{
204 int fd;
205
206 if (ast_asprintf(filename, "%s/%s", path, template_name) < 0) {
207 ast_log(LOG_ERROR, "Failed to set up temporary file path\n");
208 return -1;
209 }
210
211 ast_mkdir(path, 0644);
212
213 if ((fd = mkstemp(*filename)) < 0) {
214 ast_log(LOG_NOTICE, "Failed to create temporary file\n");
215 ast_free(*filename);
216 return -1;
217 }
218
219 return fd;
220}
#define ast_free(a)
Definition: astmm.h:180
#define ast_asprintf(ret, fmt,...)
A wrapper for asprintf()
Definition: astmm.h:267
#define ast_log
Definition: astobj2.c:42
#define LOG_ERROR
#define LOG_NOTICE
int ast_mkdir(const char *path, int mode)
Recursively create directory path.
Definition: utils.c:2479

References ast_asprintf, ast_free, ast_log, ast_mkdir(), LOG_ERROR, and LOG_NOTICE.

◆ ast_file_init()

int ast_file_init ( void  )

Initialize file stuff

Initializes all the various file stuff. Basically just registers the cli stuff Returns 0 all the time

Provided by file.c

Definition at line 2059 of file file.c.

2060{
2065 return 0;
2066}
int ast_register_cleanup(void(*func)(void))
Register a function to be executed before Asterisk gracefully exits.
Definition: clicompat.c:19
#define ast_cli_register_multiple(e, len)
Register multiple commands.
Definition: cli.h:265
static void file_shutdown(void)
Definition: file.c:2052
static struct ast_cli_entry cli_file[]
Definition: file.c:2048
struct stasis_message_type * ast_format_unregister_type(void)
Get the message type used for signaling a format unregistration.
struct stasis_message_type * ast_format_register_type(void)
Get the message type used for signaling a format registration.
#define STASIS_MESSAGE_TYPE_INIT(name)
Boiler-plate messaging macro for initializing message types.
Definition: stasis.h:1493
#define ARRAY_LEN(a)
Definition: utils.h:666

◆ ast_file_mkftemp()

FILE * ast_file_mkftemp ( char *  template_name,
mode_t  mode 
)

same as mkstemp, but return a FILE

Parameters
template_nameThe template for the unique file name to generate. Modified in place to return the file name.
modeThe mode for file permissions
Returns
FILE handle to the temporary file on success or NULL if creation failed

Definition at line 187 of file file.c.

188{
189 FILE *p = NULL;
190 int pfd = mkstemp(template_name);
191 chmod(template_name, mode);
192 if (pfd > -1) {
193 p = fdopen(pfd, "w+");
194 if (!p) {
195 close(pfd);
196 pfd = -1;
197 }
198 }
199 return p;
200}

References ast_format_def::close, and NULL.

Referenced by AST_TEST_DEFINE(), sendmail(), and sendpage().

◆ ast_file_read_dirs()

int ast_file_read_dirs ( const char *  dir_name,
ast_file_on_file  on_file,
void *  obj,
int  max_depth 
)

Recursively iterate through files and directories up to max_depth.

Parameters
dir_namethe name of the directory to search
on_filecallback called on each file
objuser data object
max_depthre-curse into sub-directories up to a given maximum (-1 = infinite)
Return values
-1on failure
errnoon failure
0otherwise

Definition at line 1282 of file file.c.

1283{
1284 int res;
1285
1286 errno = 0;
1287
1288#if !defined(__GLIBC__)
1290#endif
1291
1292 res = __ast_file_read_dirs(dir_name, on_file, obj, max_depth);
1293
1294#if !defined(__GLIBC__)
1296#endif
1297
1298 return res;
1299}
static ast_mutex_t read_dirs_lock
Lock to hold when iterating over directories.
Definition: file.c:1279
static int __ast_file_read_dirs(const char *path, ast_file_on_file on_file, void *obj, int max_depth)
Definition: file.c:1164
#define ast_mutex_unlock(a)
Definition: lock.h:194
#define ast_mutex_lock(a)
Definition: lock.h:193
int errno

References __ast_file_read_dirs(), ast_mutex_lock, ast_mutex_unlock, errno, and read_dirs_lock.

Referenced by _crypto_load_cert_store(), _crypto_load_crl_store(), ast_media_index_update_for_file(), AST_TEST_DEFINE(), crypto_load(), module_load_helper(), and stasis_app_stored_recording_find_all().

◆ ast_filecopy()

int ast_filecopy ( const char *  oldname,
const char *  newname,
const char *  fmt 
)

Copies a file.

Parameters
oldnamename of the file you wish to copy (minus extension)
newnamename you wish the file to be copied to (minus extension)
fmtthe format of the file Copy a given file in a given format, or if fmt is NULL, then do so for all

Definition at line 1159 of file file.c.

1160{
1161 return filehelper(filename, filename2, fmt, ACTION_COPY);
1162}
static int filehelper(const char *filename, const void *arg2, const char *fmt, const enum file_action action)
Definition: file.c:549
@ ACTION_COPY
Definition: file.c:535

References ACTION_COPY, filehelper(), ast_filestream::filename, and ast_filestream::fmt.

Referenced by copy_plain_file(), msg_create_from_file(), stasis_app_stored_recording_copy(), and vm_forwardoptions().

◆ ast_filedelete()

int ast_filedelete ( const char *  filename,
const char *  fmt 
)

Deletes a file.

Parameters
filenamename of the file you wish to delete (minus the extension)
fmtof the file Delete a given file in a given format, or if fmt is NULL, then do so for all

Definition at line 1149 of file file.c.

1150{
1151 return filehelper(filename, NULL, fmt, ACTION_DELETE);
1152}
@ ACTION_DELETE
Definition: file.c:532

References ACTION_DELETE, filehelper(), ast_filestream::filename, ast_filestream::fmt, and NULL.

Referenced by __ast_play_and_record(), announce_thread(), async_delete_name_rec_task(), conf_free(), conf_rec_name(), conf_run(), confbridge_exec(), dial_exec_full(), handle_cli_file_convert(), leave_voicemail(), mixmonitor_thread(), msg_create_from_file(), play_record_review(), record_exec(), recording_cancel(), setup_privacy_args(), and vm_delete().

◆ ast_fileexists()

int ast_fileexists ( const char *  filename,
const char *  fmt,
const char *  preflang 
)

Checks for the existence of a given file.

Parameters
filenamename of the file you wish to check, minus the extension
fmtthe format you wish to check (the extension)
preflang(the preferred language you wisht to find the file in) See if a given file exists in a given format. If fmt is NULL, any format is accepted.
Return values
0The file does not exist
1The file does exist.

Definition at line 1137 of file file.c.

1138{
1139 char *buf;
1140 int buflen;
1141
1142 if (preflang == NULL)
1143 preflang = "";
1144 buflen = strlen(preflang) + strlen(filename) + 4; /* room for everything */
1145 buf = ast_alloca(buflen);
1146 return fileexists_core(filename, fmt, preflang, buf, buflen, NULL) ? 1 : 0;
1147}
#define ast_alloca(size)
call __builtin_alloca to ensure we get gcc builtin semantics
Definition: astmm.h:288
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
static int fileexists_core(const char *filename, const char *fmt, const char *preflang, char *buf, int buflen, struct ast_format_cap *result_cap)
helper routine to locate a file with a given format and language preference.
Definition: file.c:741

References ast_alloca, buf, fileexists_core(), ast_filestream::filename, ast_filestream::fmt, and NULL.

Referenced by announce_thread(), app_exec(), ast_get_character_str(), ast_get_digit_str(), ast_get_phonetic_str(), ast_moh_files_next(), common_exec(), conf_run(), dial_exec_full(), eivr_comm(), forward_message(), get_folder(), invent_message(), leave_voicemail(), meetme_menu_admin_extended(), minivm_delete_exec(), msg_create_from_file(), page_exec(), play_file(), play_message(), play_message_by_id_helper(), play_message_callerid(), readexten_exec(), record_exec(), retrydial_exec(), sayname(), setup_privacy_args(), sound_file_exists(), stasis_app_control_record(), vm_intro(), vm_msg_play(), vm_newuser_setup(), vm_options(), and vm_tempgreeting().

◆ ast_filerename()

int ast_filerename ( const char *  oldname,
const char *  newname,
const char *  fmt 
)

Renames a file.

Parameters
oldnamethe name of the file you wish to act upon (minus the extension)
newnamethe name you wish to rename the file to (minus the extension)
fmtthe format of the file Rename a given file in a given format, or if fmt is NULL, then do so for all
Return values
-1on failure

Definition at line 1154 of file file.c.

1155{
1156 return filehelper(filename, filename2, fmt, ACTION_RENAME);
1157}
@ ACTION_RENAME
Definition: file.c:533

References ACTION_RENAME, filehelper(), ast_filestream::filename, and ast_filestream::fmt.

Referenced by __ast_play_and_record(), forward_message(), leave_voicemail(), msg_create_from_file(), play_record_review(), rename_file(), and vm_forwardoptions().

◆ ast_format_str_reduce()

char * ast_format_str_reduce ( char *  fmts)

Remove duplicate formats from a format string.

Parameters
fmtsa format string, this string will be modified
Return values
NULLerror
Returns
a pointer to the reduced format string, this is a pointer to fmts

Definition at line 1902 of file file.c.

1903{
1904 struct ast_format_def *f;
1905 struct ast_format_def *fmts_ptr[AST_MAX_FORMATS];
1906 char *fmts_str[AST_MAX_FORMATS];
1907 char *stringp, *type;
1908 char *orig = fmts;
1909 int i, j, x, first, found = 0;
1910 int len = strlen(fmts) + 1;
1911 int res;
1912
1913 if (AST_RWLIST_RDLOCK(&formats)) {
1914 ast_log(LOG_WARNING, "Unable to lock format list\n");
1915 return NULL;
1916 }
1917
1918 stringp = ast_strdupa(fmts);
1919
1920 for (x = 0; (type = strsep(&stringp, "|")) && x < AST_MAX_FORMATS; x++) {
1922 if (exts_compare(f->exts, type)) {
1923 found = 1;
1924 break;
1925 }
1926 }
1927
1928 fmts_str[x] = type;
1929 if (found) {
1930 fmts_ptr[x] = f;
1931 } else {
1932 fmts_ptr[x] = NULL;
1933 }
1934 }
1936
1937 first = 1;
1938 for (i = 0; i < x; i++) {
1939 /* ignore invalid entries */
1940 if (!fmts_ptr[i]) {
1941 ast_log(LOG_WARNING, "ignoring unknown format '%s'\n", fmts_str[i]);
1942 continue;
1943 }
1944
1945 /* special handling for the first entry */
1946 if (first) {
1947 res = snprintf(fmts, len, "%s", fmts_str[i]);
1948 fmts += res;
1949 len -= res;
1950 first = 0;
1951 continue;
1952 }
1953
1954 found = 0;
1955 for (j = 0; j < i; j++) {
1956 /* this is a duplicate */
1957 if (fmts_ptr[j] == fmts_ptr[i]) {
1958 found = 1;
1959 break;
1960 }
1961 }
1962
1963 if (!found) {
1964 res = snprintf(fmts, len, "|%s", fmts_str[i]);
1965 fmts += res;
1966 len -= res;
1967 }
1968 }
1969
1970 if (first) {
1971 ast_log(LOG_WARNING, "no known formats found in format list (%s)\n", orig);
1972 return NULL;
1973 }
1974
1975 return orig;
1976}
struct sla_ringing_trunk * first
Definition: app_sla.c:338
char * strsep(char **str, const char *delims)
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
static const char type[]
Definition: chan_ooh323.c:109
#define exts_compare(list, type)
Definition: file.c:386
#define AST_MAX_FORMATS
Definition: file.h:44
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
#define LOG_WARNING
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:78
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
#define AST_RWLIST_TRAVERSE
Definition: linkedlists.h:494
Each supported file format is described by the following structure.
Definition: mod_format.h:43
char exts[80]
Definition: mod_format.h:45
struct ast_format_def::@241 list
Definition: file.c:69

References ast_log, AST_MAX_FORMATS, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strdupa, ast_format_def::exts, exts_compare, first, len(), ast_format_def::list, LOG_WARNING, NULL, strsep(), and type.

Referenced by actual_load_config(), and AST_TEST_DEFINE().

◆ ast_get_extension_for_mime_type()

int ast_get_extension_for_mime_type ( const char *  mime_type,
char *  buffer,
size_t  capacity 
)

Get a suitable filename extension for the given MIME type.

Parameters
mime_typeThe MIME type for which to find extensions
bufferA pointer to a buffer to receive the extension
capacityThe size of 'buffer' in bytes
Return values
1if an extension was found for the provided MIME type
0if the MIME type was not found

Definition at line 2027 of file file.c.

2028{
2029 struct ast_format_def *f;
2031
2032 ast_assert(buffer && capacity);
2033
2035 if (type_in_list(f->mime_types, mime_type, strcasecmp)) {
2036 size_t item_len = strcspn(f->exts, "|");
2037 size_t bytes_written = snprintf(buffer, capacity, ".%.*s", (int) item_len, f->exts);
2038 if (bytes_written < capacity) {
2039 /* Only return success if we didn't truncate */
2040 return 1;
2041 }
2042 }
2043 }
2044
2045 return 0;
2046}
ast_mutex_t lock
Definition: app_sla.c:337
static int type_in_list(const char *list, const char *type, int(*cmp)(const char *s1, const char *s2))
Definition: file.c:373
#define SCOPED_RDLOCK(varname, lock)
scoped lock specialization for read locks
Definition: lock.h:598
char mime_types[80]
Definition: mod_format.h:47
ast_rwlock_t lock
Definition: file.c:69
#define ast_assert(a)
Definition: utils.h:739

References ast_assert, AST_RWLIST_TRAVERSE, ast_format_def::exts, ast_format_def::list, lock, formats::lock, ast_format_def::mime_types, SCOPED_RDLOCK, and type_in_list().

Referenced by derive_extension_from_mime_type().

◆ ast_get_format_for_file_ext()

struct ast_format * ast_get_format_for_file_ext ( const char *  file_ext)

Get the ast_format associated with the given file extension.

Since
12
Parameters
file_extThe file extension for which to find the format
Return values
NULLif not found
Returns
A pointer to the ast_format associated with this file extension

Definition at line 2014 of file file.c.

2015{
2016 struct ast_format_def *f;
2019 if (exts_compare(f->exts, file_ext)) {
2020 return f->format;
2021 }
2022 }
2023
2024 return NULL;
2025}
struct ast_format * format
Definition: mod_format.h:48

References AST_RWLIST_TRAVERSE, ast_format_def::exts, exts_compare, ast_format_def::format, ast_format_def::list, lock, formats::lock, NULL, and SCOPED_RDLOCK.

Referenced by ast_ari_bridges_record(), ast_ari_channels_record(), ast_ari_recordings_get_stored_file(), file_extension_from_string(), is_recording(), and process_media_file().

◆ ast_openstream()

struct ast_filestream * ast_openstream ( struct ast_channel chan,
const char *  filename,
const char *  preflang 
)

Opens stream for use in seeking, playing.

Parameters
chanchannel to work with
filenameto use
preflangprefered language to use
Returns
a ast_filestream pointer if it opens the file.
Return values
NULLon error.

Definition at line 845 of file file.c.

846{
847 return openstream_internal(chan, filename, preflang, 0, 0);
848}
static struct ast_filestream * openstream_internal(struct ast_channel *chan, const char *filename, const char *preflang, int asis, int quiet)
Definition: file.c:790

References ast_filestream::filename, and openstream_internal().

Referenced by ast_streamfile(), dictate_exec(), handle_getoption(), handle_streamfile(), and speech_streamfile().

◆ ast_openstream_full()

struct ast_filestream * ast_openstream_full ( struct ast_channel chan,
const char *  filename,
const char *  preflang,
int  asis 
)

Opens stream for use in seeking, playing.

Parameters
chanchannel to work with
filenameto use
preflangprefered language to use
asisif set, don't clear generators
Return values
aast_filestream pointer if it opens the file.
NULLon error.

Definition at line 850 of file file.c.

852{
853 return openstream_internal(chan, filename, preflang, asis, 0);
854}

References ast_filestream::filename, and openstream_internal().

Referenced by ast_moh_files_next(), and gen_nextfile().

◆ ast_openvstream()

struct ast_filestream * ast_openvstream ( struct ast_channel chan,
const char *  filename,
const char *  preflang 
)

Opens stream for use in seeking, playing.

Parameters
chanchannel to work with
filenameto use
preflangprefered language to use
Returns
a ast_filestream pointer if it opens the file.
Return values
NULLon error.

Definition at line 856 of file file.c.

858{
859 /* As above, but for video. But here we don't have translators
860 * so we must enforce a format.
861 */
862 struct ast_format_cap *nativeformats, *tmp_cap;
863 char *buf;
864 int buflen;
865 int i, fd;
866
867 if (preflang == NULL) {
868 preflang = "";
869 }
870 buflen = strlen(preflang) + strlen(filename) + 4;
871 buf = ast_alloca(buflen);
872
873 ast_channel_lock(chan);
874 nativeformats = ao2_bump(ast_channel_nativeformats(chan));
875 ast_channel_unlock(chan);
876
877 /* is the channel capable of video without translation ?*/
878 if (!ast_format_cap_has_type(nativeformats, AST_MEDIA_TYPE_VIDEO)) {
879 ao2_cleanup(nativeformats);
880 return NULL;
881 }
883 ao2_cleanup(nativeformats);
884 return NULL;
885 }
886 /* Video is supported, so see what video formats exist for this file */
887 if (!fileexists_core(filename, NULL, preflang, buf, buflen, tmp_cap)) {
888 ao2_ref(tmp_cap, -1);
889 ao2_cleanup(nativeformats);
890 return NULL;
891 }
892
893 /* iterate over file formats and pick the first one compatible with the channel's native formats */
894 for (i = 0; i < ast_format_cap_count(tmp_cap); ++i) {
895 struct ast_format *format = ast_format_cap_get_format(tmp_cap, i);
896
897 if ((ast_format_get_type(format) != AST_MEDIA_TYPE_VIDEO) ||
898 !ast_format_cap_iscompatible(nativeformats, tmp_cap)) {
899 ao2_ref(format, -1);
900 continue;
901 }
902
903 fd = filehelper(buf, chan, ast_format_get_name(format), ACTION_OPEN);
904 if (fd >= 0) {
905 ao2_ref(format, -1);
906 ao2_ref(tmp_cap, -1);
907 ao2_cleanup(nativeformats);
908 return ast_channel_vstream(chan);
909 }
910 ast_log(LOG_WARNING, "File %s has video but couldn't be opened\n", filename);
911 ao2_ref(format, -1);
912 }
913 ao2_ref(tmp_cap, -1);
914 ao2_cleanup(nativeformats);
915
916 return NULL;
917}
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition: astobj2.h:480
#define ast_channel_lock(chan)
Definition: channel.h:2970
struct ast_format_cap * ast_channel_nativeformats(const struct ast_channel *chan)
struct ast_filestream * ast_channel_vstream(const struct ast_channel *chan)
#define ast_channel_unlock(chan)
Definition: channel.h:2971
@ AST_MEDIA_TYPE_VIDEO
Definition: codec.h:33
@ ACTION_OPEN
Definition: file.c:534
enum ast_media_type ast_format_get_type(const struct ast_format *format)
Get the media type of a format.
Definition: format.c:354
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition: format.c:334
struct ast_format * ast_format_cap_get_format(const struct ast_format_cap *cap, int position)
Get the format at a specific index.
Definition: format_cap.c:400
@ AST_FORMAT_CAP_FLAG_DEFAULT
Definition: format_cap.h:38
int ast_format_cap_has_type(const struct ast_format_cap *cap, enum ast_media_type type)
Find out if the capabilities structure has any formats of a specific type.
Definition: format_cap.c:613
int ast_format_cap_iscompatible(const struct ast_format_cap *cap1, const struct ast_format_cap *cap2)
Determine if any joint capabilities exist between two capabilities structures.
Definition: format_cap.c:653
#define ast_format_cap_alloc(flags)
Allocate a new ast_format_cap structure.
Definition: format_cap.h:49
size_t ast_format_cap_count(const struct ast_format_cap *cap)
Get the number of formats present within the capabilities structure.
Definition: format_cap.c:395
Format capabilities structure, holds formats + preference order + etc.
Definition: format_cap.c:54
Definition of a media format.
Definition: format.c:43

References ACTION_OPEN, ao2_bump, ao2_cleanup, ao2_ref, ast_alloca, ast_channel_lock, ast_channel_nativeformats(), ast_channel_unlock, ast_channel_vstream(), ast_format_cap_alloc, ast_format_cap_count(), AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_get_format(), ast_format_cap_has_type(), ast_format_cap_iscompatible(), ast_format_get_name(), ast_format_get_type(), ast_log, AST_MEDIA_TYPE_VIDEO, buf, fileexists_core(), filehelper(), LOG_WARNING, and NULL.

Referenced by ast_streamfile(), handle_getoption(), and handle_streamfile().

◆ ast_playstream()

int ast_playstream ( struct ast_filestream s)

Play a open stream on a channel.

Parameters
sfilestream to play
Return values
0on success.
-1on failure.

Definition at line 1071 of file file.c.

1072{
1073 enum fsread_res res;
1074
1076 res = ast_readaudio_callback(s);
1077 else
1078 res = ast_readvideo_callback(s);
1079
1080 return (res == FSREAD_FAILURE) ? -1 : 0;
1081}
@ AST_MEDIA_TYPE_AUDIO
Definition: codec.h:32
fsread_res
Definition: file.c:951
@ FSREAD_FAILURE
Definition: file.c:952
static enum fsread_res ast_readaudio_callback(struct ast_filestream *s)
Definition: file.c:959
static enum fsread_res ast_readvideo_callback(struct ast_filestream *s)
Definition: file.c:1022
struct ast_format_def * fmt
Definition: mod_format.h:103

References ast_format_get_type(), AST_MEDIA_TYPE_AUDIO, ast_readaudio_callback(), ast_readvideo_callback(), ast_filestream::fmt, ast_format_def::format, and FSREAD_FAILURE.

Referenced by ast_streamfile(), handle_getoption(), handle_streamfile(), and speech_streamfile().

◆ ast_ratestream()

int ast_ratestream ( struct ast_filestream fs)

Return the sample rate of the stream's format.

Parameters
fsfs to act on
Returns
sample rate in Hz

Definition at line 1098 of file file.c.

1099{
1101}
unsigned int ast_format_get_sample_rate(const struct ast_format *format)
Get the sample rate of a media format.
Definition: format.c:379

References ast_format_get_sample_rate(), ast_filestream::fmt, and ast_format_def::format.

Referenced by msg_create_from_file().

◆ ast_readfile()

struct ast_filestream * ast_readfile ( const char *  filename,
const char *  type,
const char *  comment,
int  flags,
int  check,
mode_t  mode 
)

Starts reading from a file.

Parameters
filenamethe name of the file to read from
typeformat of file you wish to read from
commentcomment to go with
flagsfile flags
check(unimplemented, hence negligible)
modeOpen mode Open an incoming file stream. flags are flags for the open() command, and if check is non-zero, then it will not read a file if there are any files that start with that name and have an extension Please note, this is a blocking function. Program execution will not return until ast_waitstream completes it's execution.
Returns
a struct ast_filestream on success.
Return values
NULLon failure.

Definition at line 1379 of file file.c.

1380{
1381 FILE *bfile;
1382 struct ast_format_def *f;
1383 struct ast_filestream *fs = NULL;
1384 char *fn;
1385 int format_found = 0;
1386
1388
1389 AST_RWLIST_TRAVERSE(&formats, f, list) {
1390 fs = NULL;
1391 if (!exts_compare(f->exts, type))
1392 continue;
1393 else
1394 format_found = 1;
1395
1397 if (!fn) {
1398 continue;
1399 }
1400 errno = 0;
1401 bfile = fopen(fn, "r");
1402
1403 if (!bfile || (fs = get_filestream(f, bfile)) == NULL || open_wrapper(fs) ) {
1404 ast_log(LOG_WARNING, "Unable to open %s\n", fn);
1405 if (fs) {
1406 ast_closestream(fs);
1407 }
1408 fs = NULL;
1409 bfile = NULL;
1410 ast_free(fn);
1411 break;
1412 }
1413 /* found it */
1414 fs->trans = NULL;
1415 fs->fmt = f;
1416 fs->flags = flags;
1417 fs->mode = mode;
1419 fs->vfs = NULL;
1420 ast_free(fn);
1421 break;
1422 }
1423
1425 if (!format_found)
1426 ast_log(LOG_WARNING, "No such format '%s'\n", type);
1427
1428 return fs;
1429}
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
static char * build_filename(const char *filename, const char *ext)
construct a filename. Absolute pathnames are preserved, relative names are prefixed by the sounds/ di...
Definition: file.c:349
int ast_closestream(struct ast_filestream *f)
Closes a stream.
Definition: file.c:1119
static int open_wrapper(struct ast_filestream *s)
Definition: file.c:525
static struct ast_filestream * get_filestream(struct ast_format_def *fmt, FILE *bfile)
Definition: file.c:463
This structure is allocated by file.c in one chunk, together with buf_size and desc_size bytes of mem...
Definition: mod_format.h:101
struct ast_filestream * vfs
Definition: mod_format.h:110
struct ast_trans_pvt * trans
Definition: mod_format.h:112
char * filename
Definition: mod_format.h:107

References ast_closestream(), ast_free, ast_log, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strdup, build_filename(), errno, exts_compare, ast_filestream::f, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, get_filestream(), LOG_WARNING, ast_filestream::mode, NULL, open_wrapper(), ast_filestream::trans, type, and ast_filestream::vfs.

Referenced by __ast_play_and_record(), handle_cli_file_convert(), and msg_create_from_file().

◆ ast_readframe()

struct ast_frame * ast_readframe ( struct ast_filestream s)

Read a frame from a filestream.

Parameters
sast_filestream to act on
Returns
a frame.
Return values
NULLif read failed.

Definition at line 944 of file file.c.

945{
946 int whennext = 0;
947
948 return read_frame(s, &whennext);
949}
static struct ast_frame * read_frame(struct ast_filestream *s, int *whennext)
Definition: file.c:919

References read_frame().

Referenced by __ast_play_and_record(), dictate_exec(), gen_readframe(), handle_cli_file_convert(), and moh_files_readframe().

◆ ast_seekstream()

int ast_seekstream ( struct ast_filestream fs,
off_t  sample_offset,
int  whence 
)

Seeks into stream.

Parameters
fsast_filestream to perform seek on
sample_offsetnumbers of samples to seek
whenceSEEK_SET, SEEK_CUR, SEEK_END
Return values
0on success.
-1on failure.

Definition at line 1083 of file file.c.

1084{
1085 return fs->fmt->seek(fs, sample_offset, whence);
1086}
int(* seek)(struct ast_filestream *, off_t, int)
Definition: mod_format.h:68

References ast_filestream::fmt, and ast_format_def::seek.

Referenced by ast_moh_files_next(), ast_stream_fastforward(), ast_stream_rewind(), ast_streamfile(), control_streamfile(), dictate_exec(), handle_getoption(), handle_recordfile(), handle_streamfile(), msg_create_from_file(), and speech_streamfile().

◆ ast_stopstream()

int ast_stopstream ( struct ast_channel c)

Stops a stream.

Parameters
cThe channel you wish to stop playback on

Stop playback of a stream

Return values
0always
Note
The channel does not need to be locked before calling this function.
Examples
app_skel.c.

Definition at line 222 of file file.c.

223{
224 ast_channel_lock(tmp);
225
226 /* Stop a running stream if there is one */
227 if (ast_channel_stream(tmp)) {
231 ast_log(LOG_WARNING, "Unable to restore format back to %s\n", ast_format_get_name(ast_channel_oldwriteformat(tmp)));
232 }
233 /* Stop the video stream too */
234 if (ast_channel_vstream(tmp) != NULL) {
237 }
238
240
241 return 0;
242}
void ast_channel_stream_set(struct ast_channel *chan, struct ast_filestream *value)
struct ast_format * ast_channel_oldwriteformat(struct ast_channel *chan)
int ast_set_write_format(struct ast_channel *chan, struct ast_format *format)
Sets write format on channel chan.
Definition: channel.c:5820
struct ast_filestream * ast_channel_stream(const struct ast_channel *chan)
void ast_channel_vstream_set(struct ast_channel *chan, struct ast_filestream *value)

References ast_channel_lock, ast_channel_oldwriteformat(), ast_channel_stream(), ast_channel_stream_set(), ast_channel_unlock, ast_channel_vstream(), ast_channel_vstream_set(), ast_closestream(), ast_format_get_name(), ast_log, ast_set_write_format(), LOG_WARNING, and NULL.

Referenced by action_playback_and_continue(), adsi_transmit_message_full(), agent_alert(), announce_to_dial(), ast_play_and_wait(), ast_readstring_full(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_enumeration_full_he(), ast_say_enumeration_full_is(), ast_say_enumeration_full_vi(), ast_say_number_full_cs(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_gr(), ast_say_number_full_he(), ast_say_number_full_hu(), ast_say_number_full_is(), ast_say_number_full_it(), ast_say_number_full_ja(), ast_say_number_full_ka(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_th(), ast_say_number_full_ur(), ast_say_number_full_vi(), ast_say_number_full_zh(), ast_stream_and_wait(), background_detect_exec(), conf_exec(), conf_run(), control_streamfile(), dial_exec_full(), directory_exec(), grab_transfer(), handle_getoption(), handle_speechrecognize(), handle_streamfile(), isAnsweringMachine(), ivr_dispatch(), leave_voicemail(), meetme_menu_admin(), meetme_menu_admin_extended(), minivm_greet_exec(), mp3_exec(), openstream_internal(), pbx_builtin_background(), pl_odtworz_plik(), play_file(), play_files_helper(), play_mailbox_owner(), playback_exec(), queue_exec(), read_exec(), readexten_exec(), record_exec(), recordthread(), s_streamwait3(), say_filenames(), select_item_seq(), send_waveform_to_channel(), speech_background(), vm_authenticate(), vm_execmain(), wait_for_winner(), waitstream_core(), and zapateller_exec().

◆ ast_stream_and_wait()

int ast_stream_and_wait ( struct ast_channel chan,
const char *  file,
const char *  digits 
)

stream file until digit If the file name is non-empty, try to play it.

Note
If digits == "" then we can simply check for non-zero.
If a failure is encountered, the stream will be closed before returning.
Return values
0if success.
-1if error.
digitif interrupted by a digit.
Examples
app_skel.c.

Definition at line 1886 of file file.c.

1887{
1888 int res = 0;
1889 if (!ast_strlen_zero(file)) {
1890 res = ast_streamfile(chan, file, ast_channel_language(chan));
1891 if (!res) {
1892 res = ast_waitstream(chan, digits);
1893 }
1894 }
1895 if (res == -1) {
1896 ast_stopstream(chan);
1897 }
1898
1899 return res;
1900}
const char * ast_channel_language(const struct ast_channel *chan)
int ast_streamfile(struct ast_channel *chan, const char *filename, const char *preflang)
Streams a file.
Definition: file.c:1301
int ast_stopstream(struct ast_channel *tmp)
Stops a stream.
Definition: file.c:222
int ast_waitstream(struct ast_channel *c, const char *breakon)
Waits for a stream to stop or digit to be pressed.
Definition: file.c:1848
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65

References ast_channel_language(), ast_stopstream(), ast_streamfile(), ast_strlen_zero(), ast_waitstream(), and make_ari_stubs::file.

Referenced by __ast_play_and_record(), action_playback(), action_toggle_mute_participants(), agent_alert(), agent_login_exec(), announce_user_count(), app_exec(), ast_bridge_channel_playfile(), ast_pickup_call(), ast_record_review(), bridge_features_duration_callback(), confbridge_exec(), directory_exec(), forward_message(), grab_transfer(), invent_message(), ivr_dispatch(), join_conference_bridge(), leave_voicemail(), limits_interval_playback(), mixmonitor_thread(), park_app_exec(), parked_call_app_exec(), play_file(), play_files_helper(), play_mailbox_owner(), play_message_callerid(), play_prompt_to_user(), play_record_review(), playback_common(), sayname(), select_item_seq(), setup_mixmonitor_ds(), stream_failsound(), vm_forwardoptions(), vmsayname_exec(), and wait_file2().

◆ ast_stream_fastforward()

int ast_stream_fastforward ( struct ast_filestream fs,
off_t  ms 
)

Fast forward stream ms.

Parameters
fsfilestream to act on
msmilliseconds to move
Return values
0on success.
-1on failure.

Definition at line 1103 of file file.c.

1104{
1105 return ast_seekstream(fs, ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
1106}
#define DEFAULT_SAMPLES_PER_MS
Definition: asterisk.h:49
int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence)
Seeks into stream.
Definition: file.c:1083

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

Referenced by waitstream_control().

◆ ast_stream_rewind()

int ast_stream_rewind ( struct ast_filestream fs,
off_t  ms 
)

Rewind stream ms.

Parameters
fsfilestream to act on
msmilliseconds to move
Return values
0on success.
-1on failure.

Definition at line 1108 of file file.c.

1109{
1110 off_t offset = ast_tellstream(fs);
1111 if (ms * DEFAULT_SAMPLES_PER_MS > offset) {
1112 /* Don't even bother asking the file format to seek to a negative offset... */
1113 ast_debug(1, "Restarting, rather than seeking to negative offset %ld\n", (long) (offset - (ms * DEFAULT_SAMPLES_PER_MS)));
1114 return ast_seekstream(fs, 0, SEEK_SET);
1115 }
1116 return ast_seekstream(fs, -ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
1117}
off_t ast_tellstream(struct ast_filestream *fs)
Tell where we are in a stream.
Definition: file.c:1093
#define ast_debug(level,...)
Log a DEBUG message.

References ast_debug, ast_seekstream(), ast_tellstream(), and DEFAULT_SAMPLES_PER_MS.

Referenced by __ast_play_and_record(), handle_recordfile(), record_exec(), and waitstream_control().

◆ ast_streamfile()

int ast_streamfile ( struct ast_channel c,
const char *  filename,
const char *  preflang 
)

Streams a file.

Parameters
cchannel to stream the file to
filenamethe name of the file you wish to stream, minus the extension
preflangthe preferred language you wish to have the file streamed to you in Prepares a channel for the streaming of a file. To start the stream, afterward do a ast_waitstream() on the channel Also, it will stop any existing streams on the channel.
Return values
0on success.
-1on failure.

Definition at line 1301 of file file.c.

1303{
1304 struct ast_filestream *fs = NULL;
1305 struct ast_filestream *vfs = NULL;
1306 off_t pos;
1307 int seekattempt;
1308 int res;
1309 char custom_filename[256];
1310 char *tmp_filename;
1311
1312 /* If file with the same name exists in /var/lib/asterisk/sounds/custom directory, use that file.
1313 * Otherwise, use the original file*/
1314
1316 memset(custom_filename, 0, sizeof(custom_filename));
1317 snprintf(custom_filename, sizeof(custom_filename), "custom/%s", filename);
1318 fs = openstream_internal(chan, filename, preflang, 0, 1); /* open stream, do not warn for missing files */
1319 if (fs) {
1320 tmp_filename = custom_filename;
1321 ast_debug(3, "Found file %s in custom directory\n", filename);
1322 }
1323 }
1324
1325 if (!fs) {
1326 fs = ast_openstream(chan, filename, preflang);
1327 if (!fs) {
1328 struct ast_str *codec_buf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
1329 ast_channel_lock(chan);
1330 ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n",
1331 filename, ast_format_cap_get_names(ast_channel_nativeformats(chan), &codec_buf), strerror(errno));
1332 ast_channel_unlock(chan);
1333 return -1;
1334 }
1335 tmp_filename = (char *)filename;
1336 }
1337
1338 /* check to see if there is any data present (not a zero length file),
1339 * done this way because there is no where for ast_openstream_full to
1340 * return the file had no data. */
1341 pos = ftello(fs->f);
1342 seekattempt = fseeko(fs->f, -1, SEEK_END);
1343 if (seekattempt) {
1344 if (errno == EINVAL) {
1345 /* Zero-length file, as opposed to a pipe */
1346 return 0;
1347 } else {
1348 ast_seekstream(fs, 0, SEEK_SET);
1349 }
1350 } else {
1351 fseeko(fs->f, pos, SEEK_SET);
1352 }
1353
1354 vfs = ast_openvstream(chan, tmp_filename, preflang);
1355 if (vfs) {
1356 ast_debug(1, "Ooh, found a video stream, too, format %s\n", ast_format_get_name(vfs->fmt->format));
1357 }
1358
1361 if (ast_applystream(chan, fs))
1362 return -1;
1363 if (vfs && ast_applystream(chan, vfs))
1364 return -1;
1365 ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", tmp_filename, ast_channel_name(chan));
1366 res = ast_playstream(fs);
1367 if (!res && vfs)
1368 res = ast_playstream(vfs);
1369
1370 if (VERBOSITY_ATLEAST(3)) {
1371 ast_channel_lock(chan);
1372 ast_verb(3, "<%s> Playing '%s.%s' (language '%s')\n", ast_channel_name(chan), tmp_filename, ast_format_get_name(ast_channel_writeformat(chan)), preflang ? preflang : "default");
1373 ast_channel_unlock(chan);
1374 }
1375
1376 return res;
1377}
const char * ast_channel_name(const struct ast_channel *chan)
struct ast_flags * ast_channel_flags(struct ast_channel *chan)
struct ast_format * ast_channel_writeformat(struct ast_channel *chan)
@ AST_FLAG_MASQ_NOSTREAM
Definition: channel.h:1034
struct ast_filestream * ast_openstream(struct ast_channel *chan, const char *filename, const char *preflang)
Opens stream for use in seeking, playing.
Definition: file.c:845
int ast_applystream(struct ast_channel *chan, struct ast_filestream *s)
Applies a open stream to a channel.
Definition: file.c:1065
struct ast_filestream * ast_openvstream(struct ast_channel *chan, const char *filename, const char *preflang)
Opens stream for use in seeking, playing.
Definition: file.c:856
static int is_absolute_path(const char *filename)
Definition: file.c:675
int ast_playstream(struct ast_filestream *s)
Play a open stream on a channel.
Definition: file.c:1071
#define AST_FORMAT_CAP_NAMES_LEN
Definition: format_cap.h:324
const char * ast_format_cap_get_names(const struct ast_format_cap *cap, struct ast_str **buf)
Get the names of codecs of a set of formats.
Definition: format_cap.c:734
#define VERBOSITY_ATLEAST(level)
#define ast_verb(level,...)
#define ast_opt_sounds_search_custom
Definition: options.h:138
#define ast_str_alloca(init_len)
Definition: strings.h:848
const char * orig_chan_name
Definition: mod_format.h:125
Support for dynamic strings.
Definition: strings.h:623
#define ast_test_suite_event_notify(s, f,...)
Definition: test.h:189
#define ast_test_flag(p, flag)
Definition: utils.h:63

References ast_applystream(), ast_channel_flags(), ast_channel_lock, ast_channel_name(), ast_channel_nativeformats(), ast_channel_unlock, ast_channel_writeformat(), ast_debug, AST_FLAG_MASQ_NOSTREAM, ast_format_cap_get_names(), AST_FORMAT_CAP_NAMES_LEN, ast_format_get_name(), ast_log, ast_openstream(), ast_openvstream(), ast_opt_sounds_search_custom, ast_playstream(), ast_seekstream(), ast_str_alloca, ast_strdup, ast_test_flag, ast_test_suite_event_notify, ast_verb, errno, ast_filestream::f, ast_filestream::filename, ast_filestream::fmt, ast_format_def::format, is_absolute_path(), LOG_WARNING, NULL, openstream_internal(), ast_filestream::orig_chan_name, VERBOSITY_ATLEAST, and ast_filestream::vfs.

Referenced by __analog_ss_thread(), action_playback_and_continue(), analog_ss_thread(), announce_thread(), announce_to_dial(), app_exec(), ast_app_getdata_full(), ast_app_getdata_terminator(), ast_play_and_wait(), ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_gr(), ast_say_date_he(), ast_say_date_hu(), ast_say_date_is(), ast_say_date_ja(), ast_say_date_ka(), ast_say_date_nl(), ast_say_date_th(), ast_say_date_with_format_gr(), ast_say_datetime_en(), ast_say_datetime_fr(), ast_say_datetime_from_now_en(), ast_say_datetime_from_now_fr(), ast_say_datetime_from_now_he(), ast_say_datetime_from_now_ka(), ast_say_datetime_gr(), ast_say_datetime_he(), ast_say_datetime_ja(), ast_say_datetime_nl(), ast_say_datetime_pt(), ast_say_datetime_th(), ast_say_datetime_zh(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_enumeration_full_he(), ast_say_enumeration_full_is(), ast_say_enumeration_full_vi(), ast_say_number_full_cs(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_gr(), ast_say_number_full_he(), ast_say_number_full_hu(), ast_say_number_full_is(), ast_say_number_full_it(), ast_say_number_full_ja(), ast_say_number_full_ka(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_th(), ast_say_number_full_ur(), ast_say_number_full_vi(), ast_say_number_full_zh(), ast_say_time_de(), ast_say_time_en(), ast_say_time_fr(), ast_say_time_gr(), ast_say_time_hu(), ast_say_time_ja(), ast_say_time_ka(), ast_say_time_nl(), ast_say_time_zh(), ast_stream_and_wait(), auth_exec(), background_detect_exec(), common_exec(), conf_exec(), conf_get_pin(), conf_run(), control_streamfile(), dial_exec_full(), do_directory(), find_conf_realtime(), forward_message(), gr_say_number_female(), handle_recordfile(), invent_message(), isAnsweringMachine(), leave_voicemail(), meetme_menu_admin(), meetme_menu_admin_extended(), meetme_menu_normal(), minivm_greet_exec(), page_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_and_wait(), play_file(), play_record_review(), playback_exec(), privacy_exec(), readexten_exec(), record_exec(), retrydial_exec(), s_streamwait3(), say_filenames(), select_item_menu(), setup_privacy_args(), vm_authenticate(), wait_file(), and wait_for_winner().

◆ ast_tellstream()

off_t ast_tellstream ( struct ast_filestream fs)

Tell where we are in a stream.

Parameters
fsfs to act on
Returns
a long as a sample offset into stream

Definition at line 1093 of file file.c.

1094{
1095 return fs->fmt->tell(fs);
1096}
off_t(* tell)(struct ast_filestream *fs)
Definition: mod_format.h:70

References ast_filestream::fmt, and ast_format_def::tell.

Referenced by __ast_play_and_record(), ast_moh_files_next(), ast_stream_rewind(), control_streamfile(), handle_getoption(), handle_recordfile(), handle_speechrecognize(), handle_streamfile(), msg_create_from_file(), waitstream_control(), and waitstream_core().

◆ ast_truncstream()

int ast_truncstream ( struct ast_filestream fs)

Trunc stream at current location.

Parameters
fsfilestream to act on
Return values
0on success.
-1on failure.

Definition at line 1088 of file file.c.

1089{
1090 return fs->fmt->trunc(fs);
1091}
int(* trunc)(struct ast_filestream *fs)
Definition: mod_format.h:69

References ast_filestream::fmt, and ast_format_def::trunc.

Referenced by __ast_play_and_record(), handle_recordfile(), and record_exec().

◆ ast_waitstream()

int ast_waitstream ( struct ast_channel c,
const char *  breakon 
)

Waits for a stream to stop or digit to be pressed.

Parameters
cchannel to waitstream on
breakonstring of DTMF digits to break upon Begins playback of a stream... Wait for a stream to stop or for any one of a given digit to arrive,
Return values
0if the stream finishes
characterif it was interrupted by the channel.
-1on error

Definition at line 1848 of file file.c.

1849{
1850 int res;
1851
1852 res = waitstream_core(c, breakon, NULL, NULL, 0, -1, -1, NULL, NULL /* no callback */);
1853
1854 return sanitize_waitstream_return(res);
1855}
static int sanitize_waitstream_return(int return_value)
Definition: file.c:1831
static int waitstream_core(struct ast_channel *c, const char *breakon, const char *forward, const char *reverse, int skip_ms, int audiofd, int cmdfd, const char *context, ast_waitstream_fr_cb cb)
the core of all waitstream() functions
Definition: file.c:1621
static struct test_val c

References c, NULL, sanitize_waitstream_return(), and waitstream_core().

Referenced by __analog_ss_thread(), action_playback_and_continue(), analog_ss_thread(), announce_thread(), announce_to_dial(), app_exec(), ast_play_and_wait(), ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_gr(), ast_say_date_he(), ast_say_date_hu(), ast_say_date_is(), ast_say_date_ja(), ast_say_date_ka(), ast_say_date_nl(), ast_say_date_th(), ast_say_date_with_format_gr(), ast_say_datetime_en(), ast_say_datetime_fr(), ast_say_datetime_from_now_en(), ast_say_datetime_from_now_fr(), ast_say_datetime_from_now_he(), ast_say_datetime_from_now_ka(), ast_say_datetime_gr(), ast_say_datetime_he(), ast_say_datetime_ja(), ast_say_datetime_nl(), ast_say_datetime_pt(), ast_say_datetime_th(), ast_say_datetime_zh(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_enumeration_full_he(), ast_say_enumeration_full_is(), ast_say_enumeration_full_vi(), ast_say_number_full_cs(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_gr(), ast_say_number_full_he(), ast_say_number_full_hu(), ast_say_number_full_is(), ast_say_number_full_it(), ast_say_number_full_ja(), ast_say_number_full_ka(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_th(), ast_say_number_full_ur(), ast_say_number_full_vi(), ast_say_number_full_zh(), ast_say_time_de(), ast_say_time_en(), ast_say_time_fr(), ast_say_time_gr(), ast_say_time_he(), ast_say_time_hu(), ast_say_time_ja(), ast_say_time_ka(), ast_say_time_nl(), ast_say_time_zh(), ast_stream_and_wait(), auth_exec(), common_exec(), conf_exec(), conf_get_pin(), conf_run(), directory_exec(), find_conf_realtime(), gr_say_number_female(), handle_recordfile(), invent_message(), leave_voicemail(), meetme_menu_admin(), meetme_menu_admin_extended(), meetme_menu_normal(), minivm_greet_exec(), page_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_and_wait(), play_file(), play_record_review(), playback_exec(), privacy_exec(), record_exec(), retrydial_exec(), s_streamwait3(), say_filenames(), select_item_menu(), setup_privacy_args(), vm_authenticate(), and wait_file().

◆ ast_waitstream_exten()

int ast_waitstream_exten ( struct ast_channel c,
const char *  context 
)

Waits for a stream to stop or digit matching a valid one digit exten to be pressed.

Parameters
cchannel to waitstream on
contextstring of context to match digits to break upon Begins playback of a stream... Wait for a stream to stop or for any one of a valid extension digit to arrive,
Return values
0if the stream finishes.
characterif it was interrupted.
-1on error.

Definition at line 1867 of file file.c.

1868{
1869 int res;
1870
1871 /* Waitstream, with return in the case of a valid 1 digit extension */
1872 /* in the current or specified context being pressed */
1873 if (!context)
1875 res = waitstream_core(c, NULL, NULL, NULL, 0,
1876 -1, -1, context, NULL /* no callback */);
1877
1878 return sanitize_waitstream_return(res);
1879}
const char * ast_channel_context(const struct ast_channel *chan)

References ast_channel_context(), c, voicemailpwcheck::context, NULL, sanitize_waitstream_return(), and waitstream_core().

Referenced by pbx_builtin_background().

◆ ast_waitstream_fr()

int ast_waitstream_fr ( struct ast_channel c,
const char *  breakon,
const char *  forward,
const char *  rewind,
int  ms 
)

Same as waitstream but allows stream to be forwarded or rewound.

Parameters
cchannel to waitstream on
breakonstring of DTMF digits to break upon
forwardDTMF digit to fast forward upon
rewindDTMF digit to rewind upon
msHow many miliseconds to skip forward/back Begins playback of a stream... Wait for a stream to stop or for any one of a given digit to arrive,
Return values
0if the stream finishes.
characterif it was interrupted,
Returns
the value of the control frame if it was interrupted by some other party,
Return values
-1on error.

Definition at line 1817 of file file.c.

1818{
1819 return waitstream_core(c, breakon, forward, reverse, ms,
1820 -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */, NULL /* no callback */);
1821}

References c, NULL, and waitstream_core().

Referenced by control_streamfile().

◆ ast_waitstream_fr_w_cb()

int ast_waitstream_fr_w_cb ( struct ast_channel c,
const char *  breakon,
const char *  forward,
const char *  rewind,
int  ms,
ast_waitstream_fr_cb  cb 
)

Same as waitstream_fr but allows a callback to be alerted when a user fastforwards or rewinds the file.

Parameters
cchannel to waitstream on
breakonstring of DTMF digits to break upon
forwardDTMF digit to fast forward upon
rewindDTMF digit to rewind upon
msHow many milliseconds to skip forward/back
cbto call when rewind or fastforward occurs. Begins playback of a stream... Wait for a stream to stop or for any one of a given digit to arrive,
Return values
0if the stream finishes.
characterif it was interrupted,
Returns
the value of the control frame if it was interrupted by some other party,
Return values
-1on error.

Definition at line 1806 of file file.c.

1812{
1813 return waitstream_core(c, breakon, forward, reverse, ms,
1814 -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */, cb);
1815}

References c, NULL, and waitstream_core().

Referenced by control_streamfile().

◆ ast_waitstream_full()

int ast_waitstream_full ( struct ast_channel c,
const char *  breakon,
int  audiofd,
int  monfd 
)

◆ ast_writefile()

struct ast_filestream * ast_writefile ( const char *  filename,
const char *  type,
const char *  comment,
int  flags,
int  check,
mode_t  mode 
)

Starts writing a file.

Parameters
filenamethe name of the file to write to
typeformat of file you wish to write out to
commentcomment to go with
flagsoutput file flags
check(unimplemented, hence negligible)
modeOpen mode Create an outgoing file stream. oflags are flags for the open() command, and if check is non-zero, then it will not write a file if there are any files that start with that name and have an extension Please note, this is a blocking function. Program execution will not return until ast_waitstream completes it's execution.
Returns
a struct ast_filestream on success.
Return values
NULLon failure.

Definition at line 1431 of file file.c.

1432{
1433 int fd, myflags = 0;
1434 /* compiler claims this variable can be used before initialization... */
1435 FILE *bfile = NULL;
1436 struct ast_format_def *f;
1437 struct ast_filestream *fs = NULL;
1438 char *buf = NULL;
1439 size_t size = 0;
1440 int format_found = 0;
1441
1443
1444 /* set the O_TRUNC flag if and only if there is no O_APPEND specified */
1445 /* We really can't use O_APPEND as it will break WAV header updates */
1446 if (flags & O_APPEND) {
1447 flags &= ~O_APPEND;
1448 } else {
1449 myflags = O_TRUNC;
1450 }
1451
1452 myflags |= O_WRONLY | O_CREAT;
1453
1454 /* XXX need to fix this - we should just do the fopen,
1455 * not open followed by fdopen()
1456 */
1457 AST_RWLIST_TRAVERSE(&formats, f, list) {
1458 char *fn, *orig_fn = NULL;
1459 if (fs)
1460 break;
1461
1462 if (!exts_compare(f->exts, type))
1463 continue;
1464 else
1465 format_found = 1;
1466
1468 if (!fn) {
1469 continue;
1470 }
1471 fd = open(fn, flags | myflags, mode);
1472 if (fd > -1) {
1473 /* fdopen() the resulting file stream */
1474 bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
1475 if (!bfile) {
1476 ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
1477 close(fd);
1478 fd = -1;
1479 }
1480 }
1481
1482 if (ast_opt_cache_record_files && (fd > -1)) {
1483 char *c;
1484
1485 fclose(bfile); /* this also closes fd */
1486 /*
1487 We touch orig_fn just as a place-holder so other things (like vmail) see the file is there.
1488 What we are really doing is writing to record_cache_dir until we are done then we will mv the file into place.
1489 */
1490 orig_fn = ast_strdup(fn);
1491 for (c = fn; *c; c++)
1492 if (*c == '/')
1493 *c = '_';
1494
1495 size = strlen(fn) + strlen(record_cache_dir) + 2;
1496 buf = ast_malloc(size);
1497 strcpy(buf, record_cache_dir);
1498 strcat(buf, "/");
1499 strcat(buf, fn);
1500 ast_free(fn);
1501 fn = buf;
1502 fd = open(fn, flags | myflags, mode);
1503 if (fd > -1) {
1504 /* fdopen() the resulting file stream */
1505 bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
1506 if (!bfile) {
1507 ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
1508 close(fd);
1509 fd = -1;
1510 }
1511 }
1512 }
1513 if (fd > -1) {
1514 errno = 0;
1515 fs = get_filestream(f, bfile);
1516 if (fs) {
1517 if ((fs->write_buffer = ast_malloc(32768))) {
1518 setvbuf(fs->f, fs->write_buffer, _IOFBF, 32768);
1519 }
1520 }
1521 if (!fs || rewrite_wrapper(fs, comment)) {
1522 ast_log(LOG_WARNING, "Unable to rewrite %s\n", fn);
1523 close(fd);
1524 if (orig_fn) {
1525 unlink(fn);
1526 unlink(orig_fn);
1527 ast_free(orig_fn);
1528 }
1529 if (fs) {
1530 ast_closestream(fs);
1531 fs = NULL;
1532 }
1533 /*
1534 * 'fn' was has either been allocated from build_filename, or that was freed
1535 * and now 'fn' points to memory allocated for 'buf'. Either way the memory
1536 * now needs to be released.
1537 */
1538 ast_free(fn);
1539 continue;
1540 }
1541 fs->trans = NULL;
1542 fs->fmt = f;
1543 fs->flags = flags;
1544 fs->mode = mode;
1545 if (orig_fn) {
1546 fs->realfilename = orig_fn;
1547 fs->filename = fn;
1548 /*
1549 * The above now manages the memory allocated for 'orig_fn' and 'fn', so
1550 * set them to NULL, so they don't get released at the end of the loop.
1551 */
1552 orig_fn = NULL;
1553 fn = NULL;
1554 } else {
1555 fs->realfilename = NULL;
1557 }
1558 fs->vfs = NULL;
1559 /* If truncated, we'll be at the beginning; if not truncated, then append */
1560 f->seek(fs, 0, SEEK_END);
1561 } else if (errno != EEXIST) {
1562 ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno));
1563 if (orig_fn)
1564 unlink(orig_fn);
1565 }
1566 /* Free 'fn', or if 'fn' points to 'buf' then free 'buf' */
1567 ast_free(fn);
1568 ast_free(orig_fn);
1569 }
1570
1572
1573 if (!format_found)
1574 ast_log(LOG_WARNING, "No such format '%s'\n", type);
1575
1576 return fs;
1577}
#define comment
Definition: ael_lex.c:965
#define ast_malloc(len)
A wrapper for malloc()
Definition: astmm.h:191
static int rewrite_wrapper(struct ast_filestream *s, const char *comment)
Definition: file.c:520
char record_cache_dir[AST_CACHE_DIR_LEN]
Definition: options.c:96
#define ast_opt_cache_record_files
Definition: options.h:120
char * realfilename
Definition: mod_format.h:108
char * write_buffer
Definition: mod_format.h:126

References ast_closestream(), ast_free, ast_log, ast_malloc, ast_opt_cache_record_files, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strdup, buf, build_filename(), c, comment, errno, exts_compare, ast_filestream::f, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, get_filestream(), LOG_WARNING, ast_filestream::mode, NULL, ast_filestream::realfilename, record_cache_dir, rewrite_wrapper(), ast_filestream::trans, type, ast_filestream::vfs, and ast_filestream::write_buffer.

Referenced by __ast_play_and_record(), ast_writestream(), dictate_exec(), handle_cli_file_convert(), handle_recordfile(), mixmonitor_save_prep(), record_exec(), and recordthread().

◆ ast_writestream()

int ast_writestream ( struct ast_filestream fs,
struct ast_frame f 
)

Writes a frame to a stream.

Parameters
fsfilestream to write to
fframe to write to the filestream Send a frame to a filestream – note: does NOT free the frame, call ast_frfree manually
Return values
0on success.
-1on failure.

Definition at line 244 of file file.c.

245{
246 int res = -1;
247 if (f->frametype == AST_FRAME_VIDEO) {
249 /* This is the audio portion. Call the video one... */
250 if (!fs->vfs && fs->filename) {
251 const char *type = ast_format_get_name(f->subclass.format);
252 fs->vfs = ast_writefile(fs->filename, type, NULL, fs->flags, 0, fs->mode);
253 ast_debug(1, "Opened video output file\n");
254 }
255 if (fs->vfs)
256 return ast_writestream(fs->vfs, f);
257 /* else ignore */
258 return 0;
259 }
260 } else if (f->frametype != AST_FRAME_VOICE) {
261 ast_log(LOG_WARNING, "Tried to write non-voice frame\n");
262 return -1;
263 }
265 res = fs->fmt->write(fs, f);
266 if (res < 0)
267 ast_log(LOG_WARNING, "Natural write failed\n");
268 else if (res > 0)
269 ast_log(LOG_WARNING, "Huh??\n");
270 } else {
271 /* XXX If they try to send us a type of frame that isn't the normal frame, and isn't
272 the one we've setup a translator for, we do the "wrong thing" XXX */
275 fs->trans = NULL;
276 }
277 if (!fs->trans) {
279 }
280 if (!fs->trans) {
281 ast_log(LOG_WARNING, "Unable to translate to format %s, source format %s\n",
283 } else {
284 struct ast_frame *trf;
286 /* Get the translated frame but don't consume the original in case they're using it on another stream */
287 if ((trf = ast_translate(fs->trans, f, 0))) {
288 struct ast_frame *cur;
289
290 /* the translator may have returned multiple frames, so process them */
291 for (cur = trf; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
292 if ((res = fs->fmt->write(fs, trf))) {
293 ast_log(LOG_WARNING, "Translated frame write failed\n");
294 break;
295 }
296 }
297 ast_frfree(trf);
298 } else {
299 res = 0;
300 }
301 }
302 }
303 return res;
304}
#define ao2_replace(dst, src)
Replace one object reference with another cleaning up the original.
Definition: astobj2.h:501
int ast_writestream(struct ast_filestream *fs, struct ast_frame *f)
Writes a frame to a stream.
Definition: file.c:244
struct ast_filestream * ast_writefile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
Starts writing a file.
Definition: file.c:1431
enum ast_format_cmp_res ast_format_cmp(const struct ast_format *format1, const struct ast_format *format2)
Compare two formats.
Definition: format.c:201
@ AST_FORMAT_CMP_EQUAL
Definition: format.h:36
@ AST_FORMAT_CMP_NOT_EQUAL
Definition: format.h:38
#define ast_frfree(fr)
@ AST_FRAME_VIDEO
@ AST_FRAME_VOICE
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:439
struct ast_format * lastwriteformat
Definition: mod_format.h:114
int(* write)(struct ast_filestream *, struct ast_frame *)
Definition: mod_format.h:66
char name[80]
Definition: mod_format.h:44
struct ast_format * format
Data structure associated with a single frame of data.
struct ast_frame_subclass subclass
enum ast_frame_type frametype
struct ast_frame * ast_translate(struct ast_trans_pvt *tr, struct ast_frame *f, int consume)
translates one or more frames Apply an input frame into the translator and receive zero or one output...
Definition: translate.c:566
void ast_translator_free_path(struct ast_trans_pvt *tr)
Frees a translator path Frees the given translator path structure.
Definition: translate.c:476
struct ast_trans_pvt * ast_translator_build_path(struct ast_format *dest, struct ast_format *source)
Builds a translator path Build a path (possibly NULL) from source to dest.
Definition: translate.c:486

References ao2_replace, ast_debug, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_FORMAT_CMP_NOT_EQUAL, ast_format_get_name(), ast_format_get_type(), AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_frfree, AST_LIST_NEXT, ast_log, AST_MEDIA_TYPE_AUDIO, ast_translate(), ast_translator_build_path(), ast_translator_free_path(), ast_writefile(), ast_writestream(), ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, ast_frame_subclass::format, ast_format_def::format, ast_frame::frametype, ast_filestream::lastwriteformat, LOG_WARNING, ast_filestream::mode, ast_format_def::name, NULL, ast_frame::subclass, ast_filestream::trans, type, ast_filestream::vfs, and ast_format_def::write.

Referenced by __ast_play_and_record(), ast_writestream(), dictate_exec(), handle_cli_file_convert(), handle_recordfile(), mixmonitor_thread(), record_exec(), and recordthread().