Asterisk - The Open Source Telephony Project  GIT-master-a24979a
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, 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 201 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 439 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 178 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 1055 of file file.c.

1056 {
1057  s->owner = chan;
1058  return 0;
1059 }
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 1109 of file file.c.

1110 {
1111  /* This used to destroy the filestream, but it now just decrements a refcount.
1112  * We close the stream in order to quit queuing frames now, because we might
1113  * change the writeformat, which could result in a subsequent write error, if
1114  * the format is different. */
1115  if (f == NULL) {
1116  return 0;
1117  }
1118  filestream_close(f);
1119  ao2_ref(f, -1);
1120  return 0;
1121 }
#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_monitor_start(), ast_monitor_stop(), ast_readfile(), ast_stopstream(), ast_writefile(), dictate_exec(), filehelper(), filestream_destructor(), gen_closestream(), handle_recordfile(), local_ast_moh_stop(), meetmestate(), mixmonitor_ds_close_fs(), moh_files_release(), msg_create_from_file(), and record_exec().

◆ 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: main/utils.c:2377

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 2024 of file file.c.

2025 {
2030  return 0;
2031 }
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:2017
static struct ast_cli_entry cli_file[]
Definition: file.c:2013
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:661

◆ ast_file_mkftemp()

FILE* ast_file_mkftemp ( char *  template,
mode_t  mode 
)

same as mkstemp, but return a FILE

Parameters
templateThe 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);
191  chmod(template, 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 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 1272 of file file.c.

1273 {
1274  int res;
1275 
1276  errno = 0;
1277 
1278 #if !defined(__GLIBC__)
1280 #endif
1281 
1282  res = __ast_file_read_dirs(dir_name, on_file, obj, max_depth);
1283 
1284 #if !defined(__GLIBC__)
1286 #endif
1287 
1288  return res;
1289 }
static ast_mutex_t read_dirs_lock
Lock to hold when iterating over directories.
Definition: file.c:1269
static int __ast_file_read_dirs(const char *path, ast_file_on_file on_file, void *obj, int max_depth)
Definition: file.c:1154
#define ast_mutex_unlock(a)
Definition: lock.h:188
#define ast_mutex_lock(a)
Definition: lock.h:187
int errno

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

Referenced by ast_media_index_update_for_file(), AST_TEST_DEFINE(), 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 1149 of file file.c.

1150 {
1151  return filehelper(filename, filename2, fmt, ACTION_COPY);
1152 }
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 1139 of file file.c.

1140 {
1141  return filehelper(filename, NULL, fmt, ACTION_DELETE);
1142 }
@ 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(), ast_monitor_start(), ast_monitor_stop(), async_delete_name_rec_task(), conf_free(), conf_rec_name(), conf_run(), confbridge_exec(), dial_exec_full(), leave_voicemail(), 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 1127 of file file.c.

1128 {
1129  char *buf;
1130  int buflen;
1131 
1132  if (preflang == NULL)
1133  preflang = "";
1134  buflen = strlen(preflang) + strlen(filename) + 4; /* room for everything */
1135  buf = ast_alloca(buflen);
1136  return fileexists_core(filename, fmt, preflang, buf, buflen, NULL) ? 1 : 0;
1137 }
#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(), ast_monitor_start(), ast_monitor_stop(), 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_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 1144 of file file.c.

1145 {
1146  return filehelper(filename, filename2, fmt, ACTION_RENAME);
1147 }
@ ACTION_RENAME
Definition: file.c:533

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

Referenced by __ast_play_and_record(), ast_monitor_stop(), 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 1867 of file file.c.

1868 {
1869  struct ast_format_def *f;
1870  struct ast_format_def *fmts_ptr[AST_MAX_FORMATS];
1871  char *fmts_str[AST_MAX_FORMATS];
1872  char *stringp, *type;
1873  char *orig = fmts;
1874  int i, j, x, first, found = 0;
1875  int len = strlen(fmts) + 1;
1876  int res;
1877 
1878  if (AST_RWLIST_RDLOCK(&formats)) {
1879  ast_log(LOG_WARNING, "Unable to lock format list\n");
1880  return NULL;
1881  }
1882 
1883  stringp = ast_strdupa(fmts);
1884 
1885  for (x = 0; (type = strsep(&stringp, "|")) && x < AST_MAX_FORMATS; x++) {
1887  if (exts_compare(f->exts, type)) {
1888  found = 1;
1889  break;
1890  }
1891  }
1892 
1893  fmts_str[x] = type;
1894  if (found) {
1895  fmts_ptr[x] = f;
1896  } else {
1897  fmts_ptr[x] = NULL;
1898  }
1899  }
1901 
1902  first = 1;
1903  for (i = 0; i < x; i++) {
1904  /* ignore invalid entries */
1905  if (!fmts_ptr[i]) {
1906  ast_log(LOG_WARNING, "ignoring unknown format '%s'\n", fmts_str[i]);
1907  continue;
1908  }
1909 
1910  /* special handling for the first entry */
1911  if (first) {
1912  res = snprintf(fmts, len, "%s", fmts_str[i]);
1913  fmts += res;
1914  len -= res;
1915  first = 0;
1916  continue;
1917  }
1918 
1919  found = 0;
1920  for (j = 0; j < i; j++) {
1921  /* this is a duplicate */
1922  if (fmts_ptr[j] == fmts_ptr[i]) {
1923  found = 1;
1924  break;
1925  }
1926  }
1927 
1928  if (!found) {
1929  res = snprintf(fmts, len, "|%s", fmts_str[i]);
1930  fmts += res;
1931  len -= res;
1932  }
1933  }
1934 
1935  if (first) {
1936  ast_log(LOG_WARNING, "no known formats found in format list (%s)\n", orig);
1937  return NULL;
1938  }
1939 
1940  return orig;
1941 }
struct sla_ringing_trunk * first
Definition: app_meetme.c:1094
#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)
char * strsep(char **str, const char *delims)
#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
struct ast_format_def::@267 list
char exts[80]
Definition: mod_format.h:45
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 1992 of file file.c.

1993 {
1994  struct ast_format_def *f;
1996 
1997  ast_assert(buffer && capacity);
1998 
2000  if (type_in_list(f->mime_types, mime_type, strcasecmp)) {
2001  size_t item_len = strcspn(f->exts, "|");
2002  size_t bytes_written = snprintf(buffer, capacity, ".%.*s", (int) item_len, f->exts);
2003  if (bytes_written < capacity) {
2004  /* Only return success if we didn't truncate */
2005  return 1;
2006  }
2007  }
2008  }
2009 
2010  return 0;
2011 }
ast_mutex_t lock
Definition: app_meetme.c:1093
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:592
char mime_types[80]
Definition: mod_format.h:47
ast_rwlock_t lock
Definition: file.c:69
#define ast_assert(a)
Definition: utils.h:734

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 1979 of file file.c.

1980 {
1981  struct ast_format_def *f;
1984  if (exts_compare(f->exts, file_ext)) {
1985  return f->format;
1986  }
1987  }
1988 
1989  return NULL;
1990 }
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 790 of file file.c.

791 {
792  return ast_openstream_full(chan, filename, preflang, 0);
793 }
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.
Definition: file.c:795

References ast_openstream_full(), and ast_filestream::filename.

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 795 of file file.c.

796 {
797  /*
798  * Use fileexists_core() to find a file in a compatible
799  * language and format, set up a suitable translator,
800  * and open the stream.
801  */
802  struct ast_format_cap *file_fmt_cap;
803  int res;
804  int buflen;
805  char *buf;
806 
807  if (!asis) {
808  /* do this first, otherwise we detect the wrong writeformat */
809  ast_stopstream(chan);
810  if (ast_channel_generator(chan))
812  }
813  if (preflang == NULL)
814  preflang = "";
815  buflen = strlen(preflang) + strlen(filename) + 4;
816  buf = ast_alloca(buflen);
817 
818  if (!(file_fmt_cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
819  return NULL;
820  }
821  if (!fileexists_core(filename, NULL, preflang, buf, buflen, file_fmt_cap) ||
823 
824  ast_log(LOG_WARNING, "File %s does not exist in any format\n", filename);
825  ao2_ref(file_fmt_cap, -1);
826  return NULL;
827  }
828 
829  /* Set the channel to a format we can work with and save off the previous format. */
830  ast_channel_lock(chan);
832  /* Set the channel to the best format that exists for the file. */
833  res = ast_set_write_format_from_cap(chan, file_fmt_cap);
834  ast_channel_unlock(chan);
835  /* don't need this anymore now that the channel's write format is set. */
836  ao2_ref(file_fmt_cap, -1);
837 
838  if (res == -1) { /* No format available that works with this channel */
839  return NULL;
840  }
841  res = filehelper(buf, chan, NULL, ACTION_OPEN);
842  if (res >= 0)
843  return ast_channel_stream(chan);
844  return NULL;
845 }
struct ast_filestream * ast_channel_stream(const struct ast_channel *chan)
struct ast_format * ast_channel_writeformat(struct ast_channel *chan)
void ast_channel_set_oldwriteformat(struct ast_channel *chan, struct ast_format *format)
#define ast_channel_lock(chan)
Definition: channel.h:2922
struct ast_generator * ast_channel_generator(const struct ast_channel *chan)
void ast_deactivate_generator(struct ast_channel *chan)
Definition: channel.c:2894
#define ast_channel_unlock(chan)
Definition: channel.h:2923
int ast_set_write_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats)
Sets write format on channel chan Set write format for channel to whichever component of "format" is ...
Definition: channel.c:5898
@ AST_MEDIA_TYPE_AUDIO
Definition: codec.h:32
int ast_stopstream(struct ast_channel *tmp)
Stops a stream.
Definition: file.c:222
@ ACTION_OPEN
Definition: file.c:534
@ 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
#define ast_format_cap_alloc(flags)
Allocate a new ast_format_cap structure.
Definition: format_cap.h:49
Format capabilities structure, holds formats + preference order + etc.
Definition: format_cap.c:54

References ACTION_OPEN, ao2_ref, ast_alloca, ast_channel_generator(), ast_channel_lock, ast_channel_set_oldwriteformat(), ast_channel_stream(), ast_channel_unlock, ast_channel_writeformat(), ast_deactivate_generator(), ast_format_cap_alloc, AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_has_type(), ast_log, AST_MEDIA_TYPE_AUDIO, ast_set_write_format_from_cap(), ast_stopstream(), buf, fileexists_core(), filehelper(), LOG_WARNING, and NULL.

Referenced by ast_moh_files_next(), ast_openstream(), 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 847 of file file.c.

848 {
849  /* As above, but for video. But here we don't have translators
850  * so we must enforce a format.
851  */
852  struct ast_format_cap *nativeformats, *tmp_cap;
853  char *buf;
854  int buflen;
855  int i, fd;
856 
857  if (preflang == NULL) {
858  preflang = "";
859  }
860  buflen = strlen(preflang) + strlen(filename) + 4;
861  buf = ast_alloca(buflen);
862 
863  ast_channel_lock(chan);
864  nativeformats = ao2_bump(ast_channel_nativeformats(chan));
865  ast_channel_unlock(chan);
866 
867  /* is the channel capable of video without translation ?*/
868  if (!ast_format_cap_has_type(nativeformats, AST_MEDIA_TYPE_VIDEO)) {
869  ao2_cleanup(nativeformats);
870  return NULL;
871  }
873  ao2_cleanup(nativeformats);
874  return NULL;
875  }
876  /* Video is supported, so see what video formats exist for this file */
877  if (!fileexists_core(filename, NULL, preflang, buf, buflen, tmp_cap)) {
878  ao2_ref(tmp_cap, -1);
879  ao2_cleanup(nativeformats);
880  return NULL;
881  }
882 
883  /* iterate over file formats and pick the first one compatible with the channel's native formats */
884  for (i = 0; i < ast_format_cap_count(tmp_cap); ++i) {
885  struct ast_format *format = ast_format_cap_get_format(tmp_cap, i);
886 
888  !ast_format_cap_iscompatible(nativeformats, tmp_cap)) {
889  ao2_ref(format, -1);
890  continue;
891  }
892 
894  if (fd >= 0) {
895  ao2_ref(format, -1);
896  ao2_ref(tmp_cap, -1);
897  ao2_cleanup(nativeformats);
898  return ast_channel_vstream(chan);
899  }
900  ast_log(LOG_WARNING, "File %s has video but couldn't be opened\n", filename);
901  ao2_ref(format, -1);
902  }
903  ao2_ref(tmp_cap, -1);
904  ao2_cleanup(nativeformats);
905 
906  return NULL;
907 }
#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
static snd_pcm_format_t format
Definition: chan_alsa.c:106
struct ast_format_cap * ast_channel_nativeformats(const struct ast_channel *chan)
struct ast_filestream * ast_channel_vstream(const struct ast_channel *chan)
@ AST_MEDIA_TYPE_VIDEO
Definition: codec.h:33
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition: format.c:334
enum ast_media_type ast_format_get_type(const struct ast_format *format)
Get the media type of a format.
Definition: format.c:354
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
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
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
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(), format, 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 1061 of file file.c.

1062 {
1063  enum fsread_res res;
1064 
1066  res = ast_readaudio_callback(s);
1067  else
1068  res = ast_readvideo_callback(s);
1069 
1070  return (res == FSREAD_FAILURE) ? -1 : 0;
1071 }
fsread_res
Definition: file.c:941
@ FSREAD_FAILURE
Definition: file.c:942
static enum fsread_res ast_readaudio_callback(struct ast_filestream *s)
Definition: file.c:949
static enum fsread_res ast_readvideo_callback(struct ast_filestream *s)
Definition: file.c:1012
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 1088 of file file.c.

1089 {
1090  return ast_format_get_sample_rate(fs->fmt->format);
1091 }
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 1350 of file file.c.

1351 {
1352  FILE *bfile;
1353  struct ast_format_def *f;
1354  struct ast_filestream *fs = NULL;
1355  char *fn;
1356  int format_found = 0;
1357 
1359 
1360  AST_RWLIST_TRAVERSE(&formats, f, list) {
1361  fs = NULL;
1362  if (!exts_compare(f->exts, type))
1363  continue;
1364  else
1365  format_found = 1;
1366 
1367  fn = build_filename(filename, type);
1368  if (!fn) {
1369  continue;
1370  }
1371  errno = 0;
1372  bfile = fopen(fn, "r");
1373 
1374  if (!bfile || (fs = get_filestream(f, bfile)) == NULL || open_wrapper(fs) ) {
1375  ast_log(LOG_WARNING, "Unable to open %s\n", fn);
1376  if (fs) {
1377  ast_closestream(fs);
1378  }
1379  fs = NULL;
1380  bfile = NULL;
1381  ast_free(fn);
1382  break;
1383  }
1384  /* found it */
1385  fs->trans = NULL;
1386  fs->fmt = f;
1387  fs->flags = flags;
1388  fs->mode = mode;
1389  fs->filename = ast_strdup(filename);
1390  fs->vfs = NULL;
1391  ast_free(fn);
1392  break;
1393  }
1394 
1396  if (!format_found)
1397  ast_log(LOG_WARNING, "No such format '%s'\n", type);
1398 
1399  return fs;
1400 }
#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
static struct ast_filestream * get_filestream(struct ast_format_def *fmt, FILE *bfile)
Definition: file.c:463
int ast_closestream(struct ast_filestream *f)
Closes a stream.
Definition: file.c:1109
static int open_wrapper(struct ast_filestream *s)
Definition: file.c:525
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(), 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 934 of file file.c.

935 {
936  int whennext = 0;
937 
938  return read_frame(s, &whennext);
939 }
static struct ast_frame * read_frame(struct ast_filestream *s, int *whennext)
Definition: file.c:909

References read_frame().

Referenced by __ast_play_and_record(), dictate_exec(), gen_readframe(), 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 1073 of file file.c.

1074 {
1075  return fs->fmt->seek(fs, sample_offset, whence);
1076 }
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_read(), ast_moh_files_next(), ast_stream_fastforward(), ast_stream_rewind(), ast_streamfile(), ast_write_stream(), 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 {
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 }
static int tmp()
Definition: bt_open.c:389
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:5880
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, NULL, and tmp().

Referenced by action_playback_and_continue(), adsi_transmit_message_full(), agent_alert(), announce_to_dial(), ast_openstream_full(), 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(), background_detect_exec(), conf_exec(), conf_run(), control_streamfile(), dial_exec_full(), directory_exec(), grab_transfer(), handle_getoption(), handle_streamfile(), ivr_dispatch(), leave_voicemail(), meetme_menu_admin(), meetme_menu_admin_extended(), meetmestate(), minivm_greet_exec(), mp3_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_file(), play_files_helper(), play_mailbox_owner(), playback_exec(), queue_exec(), read_exec(), readexten_exec(), record_exec(), 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.
Return values
0if success.
-1if error.
digitif interrupted by a digit.
Examples
app_skel.c.

Definition at line 1855 of file file.c.

1856 {
1857  int res = 0;
1858  if (!ast_strlen_zero(file)) {
1859  res = ast_streamfile(chan, file, ast_channel_language(chan));
1860  if (!res) {
1861  res = ast_waitstream(chan, digits);
1862  }
1863  }
1864  return res;
1865 }
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:1291
int ast_waitstream(struct ast_channel *c, const char *breakon)
Waits for a stream to stop or digit to be pressed.
Definition: file.c:1817
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65

References ast_channel_language(), 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(), 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 1093 of file file.c.

1094 {
1095  return ast_seekstream(fs, ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
1096 }
#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:1073

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 1098 of file file.c.

1099 {
1100  off_t offset = ast_tellstream(fs);
1101  if (ms * DEFAULT_SAMPLES_PER_MS > offset) {
1102  /* Don't even bother asking the file format to seek to a negative offset... */
1103  ast_debug(1, "Restarting, rather than seeking to negative offset %ld\n", (long) (offset - (ms * DEFAULT_SAMPLES_PER_MS)));
1104  return ast_seekstream(fs, 0, SEEK_SET);
1105  }
1106  return ast_seekstream(fs, -ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
1107 }
off_t ast_tellstream(struct ast_filestream *fs)
Tell where we are in a stream.
Definition: file.c:1083
#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 1291 of file file.c.

1292 {
1293  struct ast_filestream *fs;
1294  struct ast_filestream *vfs=NULL;
1295  off_t pos;
1296  int seekattempt;
1297  int res;
1298 
1299  fs = ast_openstream(chan, filename, preflang);
1300  if (!fs) {
1301  struct ast_str *codec_buf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
1302  ast_channel_lock(chan);
1303  ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n",
1304  filename, ast_format_cap_get_names(ast_channel_nativeformats(chan), &codec_buf), strerror(errno));
1305  ast_channel_unlock(chan);
1306  return -1;
1307  }
1308 
1309  /* check to see if there is any data present (not a zero length file),
1310  * done this way because there is no where for ast_openstream_full to
1311  * return the file had no data. */
1312  pos = ftello(fs->f);
1313  seekattempt = fseeko(fs->f, -1, SEEK_END);
1314  if (seekattempt) {
1315  if (errno == EINVAL) {
1316  /* Zero-length file, as opposed to a pipe */
1317  return 0;
1318  } else {
1319  ast_seekstream(fs, 0, SEEK_SET);
1320  }
1321  } else {
1322  fseeko(fs->f, pos, SEEK_SET);
1323  }
1324 
1325  vfs = ast_openvstream(chan, filename, preflang);
1326  if (vfs) {
1327  ast_debug(1, "Ooh, found a video stream, too, format %s\n", ast_format_get_name(vfs->fmt->format));
1328  }
1329 
1332  if (ast_applystream(chan, fs))
1333  return -1;
1334  if (vfs && ast_applystream(chan, vfs))
1335  return -1;
1336  ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", filename, ast_channel_name(chan));
1337  res = ast_playstream(fs);
1338  if (!res && vfs)
1339  res = ast_playstream(vfs);
1340 
1341  if (VERBOSITY_ATLEAST(3)) {
1342  ast_channel_lock(chan);
1343  ast_verb(3, "<%s> Playing '%s.%s' (language '%s')\n", ast_channel_name(chan), filename, ast_format_get_name(ast_channel_writeformat(chan)), preflang ? preflang : "default");
1344  ast_channel_unlock(chan);
1345  }
1346 
1347  return res;
1348 }
const char * ast_channel_name(const struct ast_channel *chan)
@ AST_FLAG_MASQ_NOSTREAM
Definition: channel.h:1014
struct ast_flags * ast_channel_flags(struct ast_channel *chan)
int ast_applystream(struct ast_channel *chan, struct ast_filestream *s)
Applies a open stream to a channel.
Definition: file.c:1055
int ast_playstream(struct ast_filestream *s)
Play a open stream on a channel.
Definition: file.c:1061
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:790
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:847
#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_str_alloca(init_len)
Definition: strings.h:826
const char * orig_chan_name
Definition: mod_format.h:125
Support for dynamic strings.
Definition: strings.h:604
#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_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, LOG_WARNING, NULL, 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_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(), 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 1083 of file file.c.

1084 {
1085  return fs->fmt->tell(fs);
1086 }
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_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 1078 of file file.c.

1079 {
1080  return fs->fmt->trunc(fs);
1081 }
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 1817 of file file.c.

1818 {
1819  int res;
1820 
1821  res = waitstream_core(c, breakon, NULL, NULL, 0, -1, -1, NULL, NULL /* no callback */);
1822 
1823  return sanitize_waitstream_return(res);
1824 }
static int sanitize_waitstream_return(int return_value)
Definition: file.c:1800
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:1592
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_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 1836 of file file.c.

1837 {
1838  int res;
1839 
1840  /* Waitstream, with return in the case of a valid 1 digit extension */
1841  /* in the current or specified context being pressed */
1842  if (!context)
1844  res = waitstream_core(c, NULL, NULL, NULL, 0,
1845  -1, -1, context, NULL /* no callback */);
1846 
1847  return sanitize_waitstream_return(res);
1848 }
static char context[AST_MAX_CONTEXT]
Definition: chan_alsa.c:120
const char * ast_channel_context(const struct ast_channel *chan)

References ast_channel_context(), c, 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 1786 of file file.c.

1787 {
1788  return waitstream_core(c, breakon, forward, reverse, ms,
1789  -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */, NULL /* no callback */);
1790 }

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 1775 of file file.c.

1781 {
1782  return waitstream_core(c, breakon, forward, reverse, ms,
1783  -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */, cb);
1784 }

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 1402 of file file.c.

1403 {
1404  int fd, myflags = 0;
1405  /* compiler claims this variable can be used before initialization... */
1406  FILE *bfile = NULL;
1407  struct ast_format_def *f;
1408  struct ast_filestream *fs = NULL;
1409  char *buf = NULL;
1410  size_t size = 0;
1411  int format_found = 0;
1412 
1414 
1415  /* set the O_TRUNC flag if and only if there is no O_APPEND specified */
1416  /* We really can't use O_APPEND as it will break WAV header updates */
1417  if (flags & O_APPEND) {
1418  flags &= ~O_APPEND;
1419  } else {
1420  myflags = O_TRUNC;
1421  }
1422 
1423  myflags |= O_WRONLY | O_CREAT;
1424 
1425  /* XXX need to fix this - we should just do the fopen,
1426  * not open followed by fdopen()
1427  */
1428  AST_RWLIST_TRAVERSE(&formats, f, list) {
1429  char *fn, *orig_fn = NULL;
1430  if (fs)
1431  break;
1432 
1433  if (!exts_compare(f->exts, type))
1434  continue;
1435  else
1436  format_found = 1;
1437 
1438  fn = build_filename(filename, type);
1439  if (!fn) {
1440  continue;
1441  }
1442  fd = open(fn, flags | myflags, mode);
1443  if (fd > -1) {
1444  /* fdopen() the resulting file stream */
1445  bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
1446  if (!bfile) {
1447  ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
1448  close(fd);
1449  fd = -1;
1450  }
1451  }
1452 
1453  if (ast_opt_cache_record_files && (fd > -1)) {
1454  char *c;
1455 
1456  fclose(bfile); /* this also closes fd */
1457  /*
1458  We touch orig_fn just as a place-holder so other things (like vmail) see the file is there.
1459  What we are really doing is writing to record_cache_dir until we are done then we will mv the file into place.
1460  */
1461  orig_fn = ast_strdup(fn);
1462  for (c = fn; *c; c++)
1463  if (*c == '/')
1464  *c = '_';
1465 
1466  size = strlen(fn) + strlen(record_cache_dir) + 2;
1467  buf = ast_malloc(size);
1468  strcpy(buf, record_cache_dir);
1469  strcat(buf, "/");
1470  strcat(buf, fn);
1471  ast_free(fn);
1472  fn = buf;
1473  fd = open(fn, flags | myflags, mode);
1474  if (fd > -1) {
1475  /* fdopen() the resulting file stream */
1476  bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
1477  if (!bfile) {
1478  ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
1479  close(fd);
1480  fd = -1;
1481  }
1482  }
1483  }
1484  if (fd > -1) {
1485  errno = 0;
1486  fs = get_filestream(f, bfile);
1487  if (fs) {
1488  if ((fs->write_buffer = ast_malloc(32768))) {
1489  setvbuf(fs->f, fs->write_buffer, _IOFBF, 32768);
1490  }
1491  }
1492  if (!fs || rewrite_wrapper(fs, comment)) {
1493  ast_log(LOG_WARNING, "Unable to rewrite %s\n", fn);
1494  close(fd);
1495  if (orig_fn) {
1496  unlink(fn);
1497  unlink(orig_fn);
1498  ast_free(orig_fn);
1499  }
1500  if (fs) {
1501  ast_closestream(fs);
1502  fs = NULL;
1503  }
1504  /*
1505  * 'fn' was has either been allocated from build_filename, or that was freed
1506  * and now 'fn' points to memory allocated for 'buf'. Either way the memory
1507  * now needs to be released.
1508  */
1509  ast_free(fn);
1510  continue;
1511  }
1512  fs->trans = NULL;
1513  fs->fmt = f;
1514  fs->flags = flags;
1515  fs->mode = mode;
1516  if (orig_fn) {
1517  fs->realfilename = orig_fn;
1518  fs->filename = fn;
1519  /*
1520  * The above now manages the memory allocated for 'orig_fn' and 'fn', so
1521  * set them to NULL, so they don't get released at the end of the loop.
1522  */
1523  orig_fn = NULL;
1524  fn = NULL;
1525  } else {
1526  fs->realfilename = NULL;
1527  fs->filename = ast_strdup(filename);
1528  }
1529  fs->vfs = NULL;
1530  /* If truncated, we'll be at the beginning; if not truncated, then append */
1531  f->seek(fs, 0, SEEK_END);
1532  } else if (errno != EEXIST) {
1533  ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno));
1534  if (orig_fn)
1535  unlink(orig_fn);
1536  }
1537  /* Free 'fn', or if 'fn' points to 'buf' then free 'buf' */
1538  ast_free(fn);
1539  ast_free(orig_fn);
1540  }
1541 
1543 
1544  if (!format_found)
1545  ast_log(LOG_WARNING, "No such format '%s'\n", type);
1546 
1547  return fs;
1548 }
#define comment
Definition: ael_lex.c:976
#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_monitor_start(), ast_writestream(), dictate_exec(), handle_recordfile(), meetmestate(), mixmonitor_save_prep(), and record_exec().

◆ 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:1402
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_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:485
void ast_translator_free_path(struct ast_trans_pvt *tr)
Frees a translator path Frees the given translator path structure.
Definition: translate.c:475
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:565

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_read(), ast_write_stream(), ast_writestream(), dictate_exec(), handle_recordfile(), meetmestate(), mixmonitor_thread(), and record_exec().