Asterisk - The Open Source Telephony Project  GIT-master-9ed6387
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...

#include <fcntl.h>
#include <sys/mman.h>

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 fastfowarding 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)
 Applys a open stream to a channel. More...
 
int ast_closestream (struct ast_filestream *f)
 Closes a stream. More...
 
int ast_file_init (void)
 
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"

◆ AST_DIGIT_ANYNUM

#define AST_DIGIT_ANYNUM   "0123456789"

Definition at line 49 of file file.h.

Referenced by ast_sip_add_usereqphone(), and initreqprep().

◆ AST_DIGIT_NONE

#define AST_DIGIT_NONE   ""

◆ 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 or errno on failure, otherwise 0

Definition at line 171 of file file.h.

Referenced by find_recording().

◆ AST_MAX_FORMATS

#define AST_MAX_FORMATS   10

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

Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 44 of file file.h.

Referenced by ast_format_str_reduce().

◆ AST_RESERVED_POINTERS

#define AST_RESERVED_POINTERS   20

Definition at line 409 of file file.h.

◆ SEEK_FORCECUR

#define SEEK_FORCECUR   10

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
Returns
non-zero to 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 152 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 fastfowarding a file.

Examples:
/tmp/asterisk-shallow/main/app.c.

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.

Function Documentation

◆ ast_applystream()

int ast_applystream ( struct ast_channel chan,
struct ast_filestream s 
)

Applys a open stream to a channel.

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

Definition at line 1020 of file file.c.

References ast_filestream::owner.

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

1021 {
1022  s->owner = chan;
1023  return 0;
1024 }
struct ast_channel * owner
Definition: mod_format.h:116

◆ 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.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1068 of file file.c.

References ao2_ref, 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_cli_file_convert(), handle_recordfile(), local_ast_moh_stop(), mixmonitor_ds_close_fs(), moh_files_release(), msg_create_from_file(), record_exec(), and recordthread().

1069 {
1070  /* This used to destroy the filestream, but it now just decrements a refcount.
1071  * We close the stream in order to quit queuing frames now, because we might
1072  * change the writeformat, which could result in a subsequent write error, if
1073  * the format is different. */
1074  if (f == NULL) {
1075  return 0;
1076  }
1077  filestream_close(f);
1078  ao2_ref(f, -1);
1079  return 0;
1080 }
static void filestream_close(struct ast_filestream *f)
Definition: file.c:357
#define NULL
Definition: resample.c:96
#define ao2_ref(o, delta)
Definition: astobj2.h:464

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

References ARRAY_LEN, ast_cli_register_multiple, ast_format_register_type(), ast_format_unregister_type(), ast_register_cleanup(), file_shutdown(), and STASIS_MESSAGE_TYPE_INIT.

1983 {
1988  return 0;
1989 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
static struct ast_cli_entry cli_file[]
Definition: file.c:1971
#define STASIS_MESSAGE_TYPE_INIT(name)
Boiler-plate messaging macro for initializing message types.
Definition: stasis.h:1501
#define ast_cli_register_multiple(e, len)
Register multiple commands.
Definition: cli.h:265
static void file_shutdown(void)
Definition: file.c:1975
int ast_register_cleanup(void(*func)(void))
Register a function to be executed before Asterisk gracefully exits.
Definition: clicompat.c:19
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.

◆ 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)
Returns
-1 or errno on failure, otherwise 0

Definition at line 1231 of file file.c.

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().

1232 {
1233  int res;
1234 
1235  errno = 0;
1236 
1237 #if !defined(__GLIBC__)
1239 #endif
1240 
1241  res = __ast_file_read_dirs(dir_name, on_file, obj, max_depth);
1242 
1243 #if !defined(__GLIBC__)
1245 #endif
1246 
1247  return res;
1248 }
static ast_mutex_t read_dirs_lock
Lock to hold when iterating over directories.
Definition: file.c:1228
#define ast_mutex_lock(a)
Definition: lock.h:187
int errno
static int __ast_file_read_dirs(const char *path, ast_file_on_file on_file, void *obj, int max_depth)
Definition: file.c:1113
#define ast_mutex_unlock(a)
Definition: lock.h:188

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

References ACTION_COPY, and filehelper().

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

1109 {
1110  return filehelper(filename, filename2, fmt, ACTION_COPY);
1111 }
static int filehelper(const char *filename, const void *arg2, const char *fmt, const enum file_action action)
Definition: file.c:514

◆ 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
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1098 of file file.c.

References ACTION_DELETE, filehelper(), 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(), handle_cli_file_convert(), leave_voicemail(), msg_create_from_file(), play_message(), play_record_review(), record_exec(), recording_cancel(), setup_privacy_args(), valid_priv_reply(), vm_allocate_dh(), and vm_delete().

1099 {
1100  return filehelper(filename, NULL, fmt, ACTION_DELETE);
1101 }
#define NULL
Definition: resample.c:96
static int filehelper(const char *filename, const void *arg2, const char *fmt, const enum file_action action)
Definition: file.c:514

◆ 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
0,false.The file does not exist
1,true.The file does exist.

Definition at line 1086 of file file.c.

References ast_alloca, buf, fileexists_core(), and NULL.

Referenced by announce_thread(), app_exec(), 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(), play_file(), play_message(), play_message_by_id_helper(), play_message_callerid(), readexten_exec(), record_exec(), retrydial_exec(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), sayname(), setup_privacy_args(), sound_file_exists(), stasis_app_control_record(), valid_priv_reply(), vm_allocate_dh(), vm_intro(), vm_msg_play(), vm_newuser_setup(), vm_options(), vm_tempgreeting(), and vmsayname_exec().

1087 {
1088  char *buf;
1089  int buflen;
1090 
1091  if (preflang == NULL)
1092  preflang = "";
1093  buflen = strlen(preflang) + strlen(filename) + 4; /* room for everything */
1094  buf = ast_alloca(buflen);
1095  return fileexists_core(filename, fmt, preflang, buf, buflen, NULL) ? 1 : 0;
1096 }
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:706
#define NULL
Definition: resample.c:96
#define ast_alloca(size)
call __builtin_alloca to ensure we get gcc builtin semantics
Definition: astmm.h:290

◆ 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
Returns
-1 on failure
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1103 of file file.c.

References ACTION_RENAME, and filehelper().

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().

1104 {
1105  return filehelper(filename, filename2, fmt, ACTION_RENAME);
1106 }
static int filehelper(const char *filename, const void *arg2, const char *fmt, const enum file_action action)
Definition: file.c:514

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

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(), LOG_WARNING, NULL, strsep(), and type.

Referenced by actual_load_config(), and AST_TEST_DEFINE().

1826 {
1827  struct ast_format_def *f;
1828  struct ast_format_def *fmts_ptr[AST_MAX_FORMATS];
1829  char *fmts_str[AST_MAX_FORMATS];
1830  char *stringp, *type;
1831  char *orig = fmts;
1832  int i, j, x, first, found = 0;
1833  int len = strlen(fmts) + 1;
1834  int res;
1835 
1836  if (AST_RWLIST_RDLOCK(&formats)) {
1837  ast_log(LOG_WARNING, "Unable to lock format list\n");
1838  return NULL;
1839  }
1840 
1841  stringp = ast_strdupa(fmts);
1842 
1843  for (x = 0; (type = strsep(&stringp, "|")) && x < AST_MAX_FORMATS; x++) {
1845  if (exts_compare(f->exts, type)) {
1846  found = 1;
1847  break;
1848  }
1849  }
1850 
1851  fmts_str[x] = type;
1852  if (found) {
1853  fmts_ptr[x] = f;
1854  } else {
1855  fmts_ptr[x] = NULL;
1856  }
1857  }
1859 
1860  first = 1;
1861  for (i = 0; i < x; i++) {
1862  /* ignore invalid entries */
1863  if (!fmts_ptr[i]) {
1864  ast_log(LOG_WARNING, "ignoring unknown format '%s'\n", fmts_str[i]);
1865  continue;
1866  }
1867 
1868  /* special handling for the first entry */
1869  if (first) {
1870  res = snprintf(fmts, len, "%s", fmts_str[i]);
1871  fmts += res;
1872  len -= res;
1873  first = 0;
1874  continue;
1875  }
1876 
1877  found = 0;
1878  for (j = 0; j < i; j++) {
1879  /* this is a duplicate */
1880  if (fmts_ptr[j] == fmts_ptr[i]) {
1881  found = 1;
1882  break;
1883  }
1884  }
1885 
1886  if (!found) {
1887  res = snprintf(fmts, len, "|%s", fmts_str[i]);
1888  fmts += res;
1889  len -= res;
1890  }
1891  }
1892 
1893  if (first) {
1894  ast_log(LOG_WARNING, "no known formats found in format list (%s)\n", orig);
1895  return NULL;
1896  }
1897 
1898  return orig;
1899 }
char exts[80]
Definition: mod_format.h:45
static const char type[]
Definition: chan_ooh323.c:109
#define exts_compare(list, type)
Definition: file.c:351
#define LOG_WARNING
Definition: logger.h:274
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:150
#define NULL
Definition: resample.c:96
Each supported file format is described by the following structure.
Definition: mod_format.h:43
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:77
#define ast_log
Definition: astobj2.c:42
#define AST_RWLIST_TRAVERSE
Definition: linkedlists.h:493
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:300
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
Definition: file.c:69
struct sla_ringing_trunk * first
Definition: app_meetme.c:1092
char * strsep(char **str, const char *delims)
struct ast_format_def::@268 list
#define AST_MAX_FORMATS
Definition: file.h:44

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

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

Referenced by bucket_file_update_path().

1951 {
1952  struct ast_format_def *f;
1954 
1955  ast_assert(buffer && capacity);
1956 
1958  if (type_in_list(f->mime_types, mime_type, strcasecmp)) {
1959  size_t item_len = strcspn(f->exts, "|");
1960  size_t bytes_written = snprintf(buffer, capacity, ".%.*s", (int) item_len, f->exts);
1961  if (bytes_written < capacity) {
1962  /* Only return success if we didn't truncate */
1963  return 1;
1964  }
1965  }
1966  }
1967 
1968  return 0;
1969 }
char exts[80]
Definition: mod_format.h:45
#define ast_assert(a)
Definition: utils.h:650
ast_rwlock_t lock
Definition: file.c:69
Each supported file format is described by the following structure.
Definition: mod_format.h:43
#define SCOPED_RDLOCK(varname, lock)
scoped lock specialization for read locks
Definition: lock.h:592
ast_mutex_t lock
Definition: app_meetme.c:1091
#define AST_RWLIST_TRAVERSE
Definition: linkedlists.h:493
Definition: file.c:69
char mime_types[80]
Definition: mod_format.h:47
struct ast_format_def::@268 list
static int type_in_list(const char *list, const char *type, int(*cmp)(const char *s1, const char *s2))
Definition: file.c:338

◆ 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
Apointer to the ast_format associated with this file extension

Definition at line 1937 of file file.c.

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

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

1938 {
1939  struct ast_format_def *f;
1942  if (exts_compare(f->exts, file_ext)) {
1943  return f->format;
1944  }
1945  }
1946 
1947  return NULL;
1948 }
char exts[80]
Definition: mod_format.h:45
#define exts_compare(list, type)
Definition: file.c:351
#define NULL
Definition: resample.c:96
ast_rwlock_t lock
Definition: file.c:69
Each supported file format is described by the following structure.
Definition: mod_format.h:43
#define SCOPED_RDLOCK(varname, lock)
scoped lock specialization for read locks
Definition: lock.h:592
ast_mutex_t lock
Definition: app_meetme.c:1091
#define AST_RWLIST_TRAVERSE
Definition: linkedlists.h:493
struct ast_format * format
Definition: mod_format.h:48
Definition: file.c:69
struct ast_format_def::@268 list

◆ 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
Return values
aast_filestream pointer if it opens the file.
NULLon error.

Definition at line 755 of file file.c.

References ast_openstream_full().

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

756 {
757  return ast_openstream_full(chan, filename, preflang, 0);
758 }
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:760

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

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().

761 {
762  /*
763  * Use fileexists_core() to find a file in a compatible
764  * language and format, set up a suitable translator,
765  * and open the stream.
766  */
767  struct ast_format_cap *file_fmt_cap;
768  int res;
769  int buflen;
770  char *buf;
771 
772  if (!asis) {
773  /* do this first, otherwise we detect the wrong writeformat */
774  ast_stopstream(chan);
775  if (ast_channel_generator(chan))
777  }
778  if (preflang == NULL)
779  preflang = "";
780  buflen = strlen(preflang) + strlen(filename) + 4;
781  buf = ast_alloca(buflen);
782 
783  if (!(file_fmt_cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
784  return NULL;
785  }
786  if (!fileexists_core(filename, NULL, preflang, buf, buflen, file_fmt_cap) ||
788 
789  ast_log(LOG_WARNING, "File %s does not exist in any format\n", filename);
790  ao2_ref(file_fmt_cap, -1);
791  return NULL;
792  }
793 
794  /* Set the channel to a format we can work with and save off the previous format. */
795  ast_channel_lock(chan);
797  /* Set the channel to the best format that exists for the file. */
798  res = ast_set_write_format_from_cap(chan, file_fmt_cap);
799  ast_channel_unlock(chan);
800  /* don't need this anymore now that the channel's write format is set. */
801  ao2_ref(file_fmt_cap, -1);
802 
803  if (res == -1) { /* No format available that works with this channel */
804  return NULL;
805  }
806  res = filehelper(buf, chan, NULL, ACTION_OPEN);
807  if (res >= 0)
808  return ast_channel_stream(chan);
809  return NULL;
810 }
#define ast_channel_lock(chan)
Definition: channel.h:2837
void ast_channel_set_oldwriteformat(struct ast_channel *chan, struct ast_format *format)
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
#define LOG_WARNING
Definition: logger.h:274
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:706
#define NULL
Definition: resample.c:96
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:5783
#define ast_log
Definition: astobj2.c:42
#define ao2_ref(o, delta)
Definition: astobj2.h:464
#define ast_format_cap_alloc(flags)
Definition: format_cap.h:52
#define ast_alloca(size)
call __builtin_alloca to ensure we get gcc builtin semantics
Definition: astmm.h:290
struct ast_generator * ast_channel_generator(const struct ast_channel *chan)
static int filehelper(const char *filename, const void *arg2, const char *fmt, const enum file_action action)
Definition: file.c:514
Format capabilities structure, holds formats + preference order + etc.
Definition: format_cap.c:54
int ast_stopstream(struct ast_channel *tmp)
Stops a stream.
Definition: file.c:187
#define ast_channel_unlock(chan)
Definition: channel.h:2838
struct ast_filestream * ast_channel_stream(const struct ast_channel *chan)
void ast_deactivate_generator(struct ast_channel *chan)
Definition: channel.c:2868
struct ast_format * ast_channel_writeformat(struct ast_channel *chan)
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:615

◆ 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
Return values
aast_filestream pointer if it opens the file.
NULLon error.

Definition at line 812 of file file.c.

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().

813 {
814  /* As above, but for video. But here we don't have translators
815  * so we must enforce a format.
816  */
817  struct ast_format_cap *nativeformats, *tmp_cap;
818  char *buf;
819  int buflen;
820  int i, fd;
821 
822  if (preflang == NULL) {
823  preflang = "";
824  }
825  buflen = strlen(preflang) + strlen(filename) + 4;
826  buf = ast_alloca(buflen);
827 
828  ast_channel_lock(chan);
829  nativeformats = ao2_bump(ast_channel_nativeformats(chan));
830  ast_channel_unlock(chan);
831 
832  /* is the channel capable of video without translation ?*/
833  if (!ast_format_cap_has_type(nativeformats, AST_MEDIA_TYPE_VIDEO)) {
834  ao2_cleanup(nativeformats);
835  return NULL;
836  }
838  ao2_cleanup(nativeformats);
839  return NULL;
840  }
841  /* Video is supported, so see what video formats exist for this file */
842  if (!fileexists_core(filename, NULL, preflang, buf, buflen, tmp_cap)) {
843  ao2_ref(tmp_cap, -1);
844  ao2_cleanup(nativeformats);
845  return NULL;
846  }
847 
848  /* iterate over file formats and pick the first one compatible with the channel's native formats */
849  for (i = 0; i < ast_format_cap_count(tmp_cap); ++i) {
850  struct ast_format *format = ast_format_cap_get_format(tmp_cap, i);
851 
852  if ((ast_format_get_type(format) != AST_MEDIA_TYPE_VIDEO) ||
853  !ast_format_cap_iscompatible(nativeformats, tmp_cap)) {
854  ao2_ref(format, -1);
855  continue;
856  }
857 
858  fd = filehelper(buf, chan, ast_format_get_name(format), ACTION_OPEN);
859  if (fd >= 0) {
860  ao2_ref(format, -1);
861  ao2_ref(tmp_cap, -1);
862  ao2_cleanup(nativeformats);
863  return ast_channel_vstream(chan);
864  }
865  ast_log(LOG_WARNING, "File %s has video but couldn't be opened\n", filename);
866  ao2_ref(format, -1);
867  }
868  ao2_ref(tmp_cap, -1);
869  ao2_cleanup(nativeformats);
870 
871  return NULL;
872 }
#define ast_channel_lock(chan)
Definition: channel.h:2837
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_filestream * ast_channel_vstream(const struct ast_channel *chan)
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
#define LOG_WARNING
Definition: logger.h:274
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:706
Definition of a media format.
Definition: format.c:43
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
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition: format.c:334
#define NULL
Definition: resample.c:96
#define ao2_bump(obj)
Definition: astobj2.h:491
#define ast_log
Definition: astobj2.c:42
#define ao2_ref(o, delta)
Definition: astobj2.h:464
#define ast_format_cap_alloc(flags)
Definition: format_cap.h:52
#define ast_alloca(size)
call __builtin_alloca to ensure we get gcc builtin semantics
Definition: astmm.h:290
static int filehelper(const char *filename, const void *arg2, const char *fmt, const enum file_action action)
Definition: file.c:514
Format capabilities structure, holds formats + preference order + etc.
Definition: format_cap.c:54
#define ast_channel_unlock(chan)
Definition: channel.h:2838
struct ast_format_cap * ast_channel_nativeformats(const struct ast_channel *chan)
#define ao2_cleanup(obj)
Definition: astobj2.h:1958
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
static snd_pcm_format_t format
Definition: chan_alsa.c:102
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:615
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:655

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

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().

1027 {
1028  enum fsread_res res;
1029 
1031  res = ast_readaudio_callback(s);
1032  else
1033  res = ast_readvideo_callback(s);
1034 
1035  return (res == FSREAD_FAILURE) ? -1 : 0;
1036 }
static enum fsread_res ast_readvideo_callback(struct ast_filestream *s)
Definition: file.c:977
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_def * fmt
Definition: mod_format.h:103
struct ast_format * format
Definition: mod_format.h:48
fsread_res
Definition: file.c:906
static enum fsread_res ast_readaudio_callback(struct ast_filestream *s)
Definition: file.c:914

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

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

Referenced by msg_create_from_file().

1054 {
1055  return ast_format_get_sample_rate(fs->fmt->format);
1056 }
struct ast_format_def * fmt
Definition: mod_format.h:103
struct ast_format * format
Definition: mod_format.h:48
unsigned int ast_format_get_sample_rate(const struct ast_format *format)
Get the sample rate of a media format.
Definition: format.c:379

◆ 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.
Return values
astruct ast_filestream on success.
NULLon failure.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1309 of file file.c.

References ast_closestream(), ast_free, ast_log, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strdup, build_filename(), errno, ast_format_def::exts, 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, and ast_filestream::vfs.

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

1310 {
1311  FILE *bfile;
1312  struct ast_format_def *f;
1313  struct ast_filestream *fs = NULL;
1314  char *fn;
1315  int format_found = 0;
1316 
1318 
1319  AST_RWLIST_TRAVERSE(&formats, f, list) {
1320  fs = NULL;
1321  if (!exts_compare(f->exts, type))
1322  continue;
1323  else
1324  format_found = 1;
1325 
1326  fn = build_filename(filename, type);
1327  if (!fn) {
1328  continue;
1329  }
1330  errno = 0;
1331  bfile = fopen(fn, "r");
1332 
1333  if (!bfile || (fs = get_filestream(f, bfile)) == NULL || open_wrapper(fs) ) {
1334  ast_log(LOG_WARNING, "Unable to open %s\n", fn);
1335  if (fs) {
1336  ast_closestream(fs);
1337  }
1338  fs = NULL;
1339  bfile = NULL;
1340  ast_free(fn);
1341  break;
1342  }
1343  /* found it */
1344  fs->trans = NULL;
1345  fs->fmt = f;
1346  fs->flags = flags;
1347  fs->mode = mode;
1348  fs->filename = ast_strdup(filename);
1349  fs->vfs = NULL;
1350  ast_free(fn);
1351  break;
1352  }
1353 
1355  if (!format_found)
1356  ast_log(LOG_WARNING, "No such format '%s'\n", type);
1357 
1358  return fs;
1359 }
char exts[80]
Definition: mod_format.h:45
static const char type[]
Definition: chan_ooh323.c:109
#define exts_compare(list, type)
Definition: file.c:351
#define LOG_WARNING
Definition: logger.h:274
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:150
static struct ast_filestream * get_filestream(struct ast_format_def *fmt, FILE *bfile)
Definition: file.c:428
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:243
int ast_closestream(struct ast_filestream *f)
Closes a stream.
Definition: file.c:1068
#define NULL
Definition: resample.c:96
Each supported file format is described by the following structure.
Definition: mod_format.h:43
static int open_wrapper(struct ast_filestream *s)
Definition: file.c:490
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:77
#define ast_log
Definition: astobj2.c:42
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:314
#define AST_RWLIST_TRAVERSE
Definition: linkedlists.h:493
struct ast_format_def * fmt
Definition: mod_format.h:103
int errno
Definition: file.c:69
struct ast_trans_pvt * trans
Definition: mod_format.h:112
#define ast_free(a)
Definition: astmm.h:182
char * filename
Definition: mod_format.h:107
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

◆ 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.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 899 of file file.c.

References read_frame().

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

900 {
901  int whennext = 0;
902 
903  return read_frame(s, &whennext);
904 }
static struct ast_frame * read_frame(struct ast_filestream *s, int *whennext)
Definition: file.c:874

◆ 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.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1038 of file file.c.

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().

1039 {
1040  return fs->fmt->seek(fs, sample_offset, whence);
1041 }
int(* seek)(struct ast_filestream *, off_t, int)
Definition: mod_format.h:68
struct ast_format_def * fmt
Definition: mod_format.h:103

◆ 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:
/tmp/asterisk-shallow/main/app.c.

Definition at line 187 of file file.c.

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_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(), 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_speechrecognize(), handle_streamfile(), ices_exec(), ivr_dispatch(), leave_voicemail(), meetme_menu_admin(), meetme_menu_admin_extended(), minivm_greet_exec(), mp3_exec(), NBScat_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(), recordthread(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), select_item_seq(), send_waveform_to_channel(), speech_background(), vm_authenticate(), vm_execmain(), wait_for_winner(), waitstream_core(), and zapateller_exec().

188 {
190 
191  /* Stop a running stream if there is one */
192  if (ast_channel_stream(tmp)) {
196  ast_log(LOG_WARNING, "Unable to restore format back to %s\n", ast_format_get_name(ast_channel_oldwriteformat(tmp)));
197  }
198  /* Stop the video stream too */
199  if (ast_channel_vstream(tmp) != NULL) {
202  }
203 
205 
206  return 0;
207 }
#define ast_channel_lock(chan)
Definition: channel.h:2837
struct ast_filestream * ast_channel_vstream(const struct ast_channel *chan)
#define LOG_WARNING
Definition: logger.h:274
static int tmp()
Definition: bt_open.c:389
struct ast_format * ast_channel_oldwriteformat(struct ast_channel *chan)
void ast_channel_vstream_set(struct ast_channel *chan, struct ast_filestream *value)
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition: format.c:334
int ast_closestream(struct ast_filestream *f)
Closes a stream.
Definition: file.c:1068
#define NULL
Definition: resample.c:96
void ast_channel_stream_set(struct ast_channel *chan, struct ast_filestream *value)
#define ast_log
Definition: astobj2.c:42
int ast_set_write_format(struct ast_channel *chan, struct ast_format *format)
Sets write format on channel chan.
Definition: channel.c:5765
#define ast_channel_unlock(chan)
Definition: channel.h:2838
struct ast_filestream * ast_channel_stream(const struct ast_channel *chan)

◆ 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.
Returns
0 if success.
Return values
-1if error.
digitif interrupted by a digit.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1813 of file file.c.

References ast_channel_language(), ast_streamfile(), ast_strlen_zero, and ast_waitstream().

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().

1814 {
1815  int res = 0;
1816  if (!ast_strlen_zero(file)) {
1817  res = ast_streamfile(chan, file, ast_channel_language(chan));
1818  if (!res) {
1819  res = ast_waitstream(chan, digits);
1820  }
1821  }
1822  return res;
1823 }
int ast_waitstream(struct ast_channel *c, const char *breakon)
Waits for a stream to stop or digit to be pressed.
Definition: file.c:1775
int ast_streamfile(struct ast_channel *chan, const char *filename, const char *preflang)
Streams a file.
Definition: file.c:1250
#define ast_strlen_zero(a)
Definition: muted.c:73
const char * ast_channel_language(const struct ast_channel *chan)

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

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

Referenced by waitstream_control().

1059 {
1060  return ast_seekstream(fs, ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
1061 }
int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence)
Seeks into stream.
Definition: file.c:1038
#define DEFAULT_SAMPLES_PER_MS
Definition: asterisk.h:47

◆ 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.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1063 of file file.c.

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

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

1064 {
1065  return ast_seekstream(fs, -ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
1066 }
int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence)
Seeks into stream.
Definition: file.c:1038
#define DEFAULT_SAMPLES_PER_MS
Definition: asterisk.h:47

◆ 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.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1250 of file file.c.

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::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(), 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(), 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_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), select_item_menu(), setup_privacy_args(), vm_authenticate(), wait_file(), and wait_for_winner().

1251 {
1252  struct ast_filestream *fs;
1253  struct ast_filestream *vfs=NULL;
1254  off_t pos;
1255  int seekattempt;
1256  int res;
1257 
1258  fs = ast_openstream(chan, filename, preflang);
1259  if (!fs) {
1260  struct ast_str *codec_buf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
1261  ast_channel_lock(chan);
1262  ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n",
1263  filename, ast_format_cap_get_names(ast_channel_nativeformats(chan), &codec_buf), strerror(errno));
1264  ast_channel_unlock(chan);
1265  return -1;
1266  }
1267 
1268  /* check to see if there is any data present (not a zero length file),
1269  * done this way because there is no where for ast_openstream_full to
1270  * return the file had no data. */
1271  pos = ftello(fs->f);
1272  seekattempt = fseeko(fs->f, -1, SEEK_END);
1273  if (seekattempt) {
1274  if (errno == EINVAL) {
1275  /* Zero-length file, as opposed to a pipe */
1276  return 0;
1277  } else {
1278  ast_seekstream(fs, 0, SEEK_SET);
1279  }
1280  } else {
1281  fseeko(fs->f, pos, SEEK_SET);
1282  }
1283 
1284  vfs = ast_openvstream(chan, filename, preflang);
1285  if (vfs) {
1286  ast_debug(1, "Ooh, found a video stream, too, format %s\n", ast_format_get_name(vfs->fmt->format));
1287  }
1288 
1291  if (ast_applystream(chan, fs))
1292  return -1;
1293  if (vfs && ast_applystream(chan, vfs))
1294  return -1;
1295  ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", filename, ast_channel_name(chan));
1296  res = ast_playstream(fs);
1297  if (!res && vfs)
1298  res = ast_playstream(vfs);
1299 
1300  if (VERBOSITY_ATLEAST(3)) {
1301  ast_channel_lock(chan);
1302  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");
1303  ast_channel_unlock(chan);
1304  }
1305 
1306  return res;
1307 }
#define ast_channel_lock(chan)
Definition: channel.h:2837
int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence)
Seeks into stream.
Definition: file.c:1038
#define ast_test_flag(p, flag)
Definition: utils.h:63
#define LOG_WARNING
Definition: logger.h:274
#define AST_FORMAT_CAP_NAMES_LEN
Definition: format_cap.h:326
#define VERBOSITY_ATLEAST(level)
Definition: logger.h:453
#define ast_str_alloca(init_len)
Definition: strings.h:800
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition: format.c:334
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:243
int ast_playstream(struct ast_filestream *s)
Play a open stream on a channel.
Definition: file.c:1026
#define NULL
Definition: resample.c:96
#define ast_verb(level,...)
Definition: logger.h:455
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:755
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:444
#define ast_log
Definition: astobj2.c:42
struct ast_format_def * fmt
Definition: mod_format.h:103
const char * orig_chan_name
Definition: mod_format.h:125
struct ast_format * format
Definition: mod_format.h:48
int ast_applystream(struct ast_channel *chan, struct ast_filestream *s)
Applys a open stream to a channel.
Definition: file.c:1020
#define ast_test_suite_event_notify(s, f,...)
Definition: test.h:196
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:812
The descriptor of a dynamic string XXX storage will be optimized later if needed We use the ts field ...
Definition: strings.h:584
int errno
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:736
#define ast_channel_unlock(chan)
Definition: channel.h:2838
struct ast_format_cap * ast_channel_nativeformats(const struct ast_channel *chan)
char * filename
Definition: mod_format.h:107
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
const char * ast_channel_name(const struct ast_channel *chan)
struct ast_filestream * vfs
Definition: mod_format.h:110
struct ast_flags * ast_channel_flags(struct ast_channel *chan)
struct ast_format * ast_channel_writeformat(struct ast_channel *chan)

◆ 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
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1048 of file file.c.

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

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

1049 {
1050  return fs->fmt->tell(fs);
1051 }
struct ast_format_def * fmt
Definition: mod_format.h:103
off_t(* tell)(struct ast_filestream *fs)
Definition: mod_format.h:70

◆ 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.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1043 of file file.c.

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

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

1044 {
1045  return fs->fmt->trunc(fs);
1046 }
struct ast_format_def * fmt
Definition: mod_format.h:103
int(* trunc)(struct ast_filestream *fs)
Definition: mod_format.h:69

◆ 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
thecharacter if it was interrupted by the channel.
-1on error
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1775 of file file.c.

References 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(), 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_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), select_item_menu(), setup_privacy_args(), vm_authenticate(), and wait_file().

1776 {
1777  int res;
1778 
1779  res = waitstream_core(c, breakon, NULL, NULL, 0, -1, -1, NULL, NULL /* no callback */);
1780 
1781  return sanitize_waitstream_return(res);
1782 }
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:1551
#define NULL
Definition: resample.c:96
static int sanitize_waitstream_return(int return_value)
Definition: file.c:1758

◆ 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.
thecharacter if it was interrupted.
-1on error.

Definition at line 1794 of file file.c.

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

Referenced by pbx_builtin_background().

1795 {
1796  int res;
1797 
1798  /* Waitstream, with return in the case of a valid 1 digit extension */
1799  /* in the current or specified context being pressed */
1800  if (!context)
1802  res = waitstream_core(c, NULL, NULL, NULL, 0,
1803  -1, -1, context, NULL /* no callback */);
1804 
1805  return sanitize_waitstream_return(res);
1806 }
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:1551
#define NULL
Definition: resample.c:96
static int sanitize_waitstream_return(int return_value)
Definition: file.c:1758
const char * ast_channel_context(const struct ast_channel *chan)
static char context[AST_MAX_CONTEXT]
Definition: chan_alsa.c:116

◆ 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.
thecharacter if it was interrupted,
thevalue of the control frame if it was interrupted by some other party,
-1on error.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1744 of file file.c.

References NULL, and waitstream_core().

Referenced by control_streamfile().

1745 {
1746  return waitstream_core(c, breakon, forward, reverse, ms,
1747  -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */, NULL /* no callback */);
1748 }
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:1551
#define NULL
Definition: resample.c:96

◆ 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 fastfoward 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.
thecharacter if it was interrupted,
thevalue of the control frame if it was interrupted by some other party,
-1on error.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1733 of file file.c.

References NULL, and waitstream_core().

Referenced by control_streamfile().

1739 {
1740  return waitstream_core(c, breakon, forward, reverse, ms,
1741  -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */, cb);
1742 }
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:1551
#define NULL
Definition: resample.c:96

◆ ast_waitstream_full()

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

Same as waitstream, but with audio output to fd and monitored fd checking.

Returns
1 if monfd is ready for reading

Definition at line 1784 of file file.c.

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

Referenced by 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(), 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(), handle_getoption(), handle_streamfile(), pl_odtworz_plik(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), and say_phonetic_str_full().

1785 {
1786  int res;
1787 
1788  res = waitstream_core(c, breakon, NULL, NULL, 0,
1789  audiofd, cmdfd, NULL /* no context */, NULL /* no callback */);
1790 
1791  return sanitize_waitstream_return(res);
1792 }
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:1551
#define NULL
Definition: resample.c:96
static int sanitize_waitstream_return(int return_value)
Definition: file.c:1758

◆ 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.
Return values
astruct ast_filestream on success.
NULLon failure.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 1361 of file file.c.

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, errno, ast_format_def::exts, 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_format_def::seek, ast_filestream::trans, ast_filestream::vfs, and ast_filestream::write_buffer.

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

1362 {
1363  int fd, myflags = 0;
1364  /* compiler claims this variable can be used before initialization... */
1365  FILE *bfile = NULL;
1366  struct ast_format_def *f;
1367  struct ast_filestream *fs = NULL;
1368  char *buf = NULL;
1369  size_t size = 0;
1370  int format_found = 0;
1371 
1373 
1374  /* set the O_TRUNC flag if and only if there is no O_APPEND specified */
1375  /* We really can't use O_APPEND as it will break WAV header updates */
1376  if (flags & O_APPEND) {
1377  flags &= ~O_APPEND;
1378  } else {
1379  myflags = O_TRUNC;
1380  }
1381 
1382  myflags |= O_WRONLY | O_CREAT;
1383 
1384  /* XXX need to fix this - we should just do the fopen,
1385  * not open followed by fdopen()
1386  */
1387  AST_RWLIST_TRAVERSE(&formats, f, list) {
1388  char *fn, *orig_fn = NULL;
1389  if (fs)
1390  break;
1391 
1392  if (!exts_compare(f->exts, type))
1393  continue;
1394  else
1395  format_found = 1;
1396 
1397  fn = build_filename(filename, type);
1398  if (!fn) {
1399  continue;
1400  }
1401  fd = open(fn, flags | myflags, mode);
1402  if (fd > -1) {
1403  /* fdopen() the resulting file stream */
1404  bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
1405  if (!bfile) {
1406  ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
1407  close(fd);
1408  fd = -1;
1409  }
1410  }
1411 
1412  if (ast_opt_cache_record_files && (fd > -1)) {
1413  char *c;
1414 
1415  fclose(bfile); /* this also closes fd */
1416  /*
1417  We touch orig_fn just as a place-holder so other things (like vmail) see the file is there.
1418  What we are really doing is writing to record_cache_dir until we are done then we will mv the file into place.
1419  */
1420  orig_fn = ast_strdup(fn);
1421  for (c = fn; *c; c++)
1422  if (*c == '/')
1423  *c = '_';
1424 
1425  size = strlen(fn) + strlen(record_cache_dir) + 2;
1426  buf = ast_malloc(size);
1427  strcpy(buf, record_cache_dir);
1428  strcat(buf, "/");
1429  strcat(buf, fn);
1430  ast_free(fn);
1431  fn = buf;
1432  fd = open(fn, flags | myflags, mode);
1433  if (fd > -1) {
1434  /* fdopen() the resulting file stream */
1435  bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
1436  if (!bfile) {
1437  ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
1438  close(fd);
1439  fd = -1;
1440  }
1441  }
1442  }
1443  if (fd > -1) {
1444  errno = 0;
1445  fs = get_filestream(f, bfile);
1446  if (fs) {
1447  if ((fs->write_buffer = ast_malloc(32768))) {
1448  setvbuf(fs->f, fs->write_buffer, _IOFBF, 32768);
1449  }
1450  }
1451  if (!fs || rewrite_wrapper(fs, comment)) {
1452  ast_log(LOG_WARNING, "Unable to rewrite %s\n", fn);
1453  close(fd);
1454  if (orig_fn) {
1455  unlink(fn);
1456  unlink(orig_fn);
1457  ast_free(orig_fn);
1458  }
1459  if (fs) {
1460  ast_closestream(fs);
1461  fs = NULL;
1462  }
1463  /*
1464  * 'fn' was has either been allocated from build_filename, or that was freed
1465  * and now 'fn' points to memory allocated for 'buf'. Either way the memory
1466  * now needs to be released.
1467  */
1468  ast_free(fn);
1469  continue;
1470  }
1471  fs->trans = NULL;
1472  fs->fmt = f;
1473  fs->flags = flags;
1474  fs->mode = mode;
1475  if (orig_fn) {
1476  fs->realfilename = orig_fn;
1477  fs->filename = fn;
1478  /*
1479  * The above now manages the memory allocated for 'orig_fn' and 'fn', so
1480  * set them to NULL, so they don't get released at the end of the loop.
1481  */
1482  orig_fn = NULL;
1483  fn = NULL;
1484  } else {
1485  fs->realfilename = NULL;
1486  fs->filename = ast_strdup(filename);
1487  }
1488  fs->vfs = NULL;
1489  /* If truncated, we'll be at the beginning; if not truncated, then append */
1490  f->seek(fs, 0, SEEK_END);
1491  } else if (errno != EEXIST) {
1492  ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno));
1493  if (orig_fn)
1494  unlink(orig_fn);
1495  }
1496  /* Free 'fn', or if 'fn' points to 'buf' then free 'buf' */
1497  ast_free(fn);
1498  ast_free(orig_fn);
1499  }
1500 
1502 
1503  if (!format_found)
1504  ast_log(LOG_WARNING, "No such format '%s'\n", type);
1505 
1506  return fs;
1507 }
char exts[80]
Definition: mod_format.h:45
static const char type[]
Definition: chan_ooh323.c:109
#define exts_compare(list, type)
Definition: file.c:351
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
#define LOG_WARNING
Definition: logger.h:274
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:150
static struct ast_filestream * get_filestream(struct ast_format_def *fmt, FILE *bfile)
Definition: file.c:428
static int rewrite_wrapper(struct ast_filestream *s, const char *comment)
Definition: file.c:485
char * realfilename
Definition: mod_format.h:108
static struct test_val c
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:243
int ast_closestream(struct ast_filestream *f)
Closes a stream.
Definition: file.c:1068
#define NULL
Definition: resample.c:96
Each supported file format is described by the following structure.
Definition: mod_format.h:43
int(* seek)(struct ast_filestream *, off_t, int)
Definition: mod_format.h:68
char * write_buffer
Definition: mod_format.h:126
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:77
#define ast_log
Definition: astobj2.c:42
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:314
#define AST_RWLIST_TRAVERSE
Definition: linkedlists.h:493
struct ast_format_def * fmt
Definition: mod_format.h:103
#define ast_malloc(len)
A wrapper for malloc()
Definition: astmm.h:193
int errno
#define comment
Definition: ael_lex.c:976
Definition: file.c:69
struct ast_trans_pvt * trans
Definition: mod_format.h:112
#define ast_opt_cache_record_files
Definition: options.h:120
#define ast_free(a)
Definition: astmm.h:182
char record_cache_dir[AST_CACHE_DIR_LEN]
Definition: options.c:96
char * filename
Definition: mod_format.h:107
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

◆ 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.
Examples:
/tmp/asterisk-shallow/main/app.c.

Definition at line 209 of file file.c.

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_filestream::filename, ast_filestream::flags, ast_filestream::fmt, ast_format_def::format, ast_frame_subclass::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(), dictate_exec(), handle_cli_file_convert(), handle_recordfile(), mixmonitor_thread(), record_exec(), and recordthread().

210 {
211  int res = -1;
212  if (f->frametype == AST_FRAME_VIDEO) {
214  /* This is the audio portion. Call the video one... */
215  if (!fs->vfs && fs->filename) {
216  const char *type = ast_format_get_name(f->subclass.format);
217  fs->vfs = ast_writefile(fs->filename, type, NULL, fs->flags, 0, fs->mode);
218  ast_debug(1, "Opened video output file\n");
219  }
220  if (fs->vfs)
221  return ast_writestream(fs->vfs, f);
222  /* else ignore */
223  return 0;
224  }
225  } else if (f->frametype != AST_FRAME_VOICE) {
226  ast_log(LOG_WARNING, "Tried to write non-voice frame\n");
227  return -1;
228  }
230  res = fs->fmt->write(fs, f);
231  if (res < 0)
232  ast_log(LOG_WARNING, "Natural write failed\n");
233  else if (res > 0)
234  ast_log(LOG_WARNING, "Huh??\n");
235  } else {
236  /* XXX If they try to send us a type of frame that isn't the normal frame, and isn't
237  the one we've setup a translator for, we do the "wrong thing" XXX */
240  fs->trans = NULL;
241  }
242  if (!fs->trans) {
244  }
245  if (!fs->trans) {
246  ast_log(LOG_WARNING, "Unable to translate to format %s, source format %s\n",
248  } else {
249  struct ast_frame *trf;
251  /* Get the translated frame but don't consume the original in case they're using it on another stream */
252  if ((trf = ast_translate(fs->trans, f, 0))) {
253  struct ast_frame *cur;
254 
255  /* the translator may have returned multiple frames, so process them */
256  for (cur = trf; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
257  if ((res = fs->fmt->write(fs, trf))) {
258  ast_log(LOG_WARNING, "Translated frame write failed\n");
259  break;
260  }
261  }
262  ast_frfree(trf);
263  } else {
264  res = 0;
265  }
266  }
267  }
268  return res;
269 }
static const char type[]
Definition: chan_ooh323.c:109
enum ast_media_type ast_format_get_type(const struct ast_format *format)
Get the media type of a format.
Definition: format.c:354
#define LOG_WARNING
Definition: logger.h:274
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:438
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:559
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition: format.c:334
#define NULL
Definition: resample.c:96
struct ast_frame_subclass subclass
int ast_writestream(struct ast_filestream *fs, struct ast_frame *f)
Writes a frame to a stream.
Definition: file.c:209
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:1361
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:444
#define ast_log
Definition: astobj2.c:42
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
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:479
struct ast_format_def * fmt
Definition: mod_format.h:103
struct ast_format * format
Definition: mod_format.h:48
char name[80]
Definition: mod_format.h:44
struct ast_trans_pvt * trans
Definition: mod_format.h:112
struct ast_format * lastwriteformat
Definition: mod_format.h:114
char * filename
Definition: mod_format.h:107
#define ao2_replace(dst, src)
Definition: astobj2.h:517
#define ast_frfree(fr)
Data structure associated with a single frame of data.
enum ast_frame_type frametype
struct ast_filestream * vfs
Definition: mod_format.h:110
struct ast_format * format
int(* write)(struct ast_filestream *, struct ast_frame *)
Definition: mod_format.h:66
void ast_translator_free_path(struct ast_trans_pvt *tr)
Frees a translator path Frees the given translator path structure.
Definition: translate.c:469