File Functions

Collaboration diagram for File Functions:

Macros
#define	switch_core_file_open(_fh, _file_path, _channels, _rate, _flags, _pool)   switch_core_perform_file_open(__FILE__, __SWITCH_FUNC__, __LINE__, _fh, _file_path, _channels, _rate, _flags, _pool)
	Open a media file using file format modules. More...

Functions
switch_status_t	switch_core_perform_file_open (const char *file, const char *func, int line, _In_ switch_file_handle_t *fh, _In_opt_z_ const char *file_path, _In_ uint32_t channels, _In_ uint32_t rate, _In_ unsigned int flags, _In_opt_ switch_memory_pool_t *pool)
switch_status_t	switch_core_file_read (_In_ switch_file_handle_t *fh, void *data, switch_size_t *len)
	Read media from a file handle. More...
switch_status_t	switch_core_file_write (_In_ switch_file_handle_t *fh, void *data, switch_size_t *len)
	Write media to a file handle. More...
switch_status_t	switch_core_file_write_video (_In_ switch_file_handle_t *fh, switch_frame_t *frame)
	Write media to a file handle. More...
switch_status_t	switch_core_file_read_video (switch_file_handle_t *fh, switch_frame_t *frame, switch_video_read_flag_t flags)
switch_status_t	switch_core_file_seek (_In_ switch_file_handle_t *fh, unsigned int *cur_pos, int64_t samples, int whence)
	Seek a position in a file. More...
switch_status_t	switch_core_file_set_string (_In_ switch_file_handle_t *fh, switch_audio_col_t col, const char *string)
	Set metadata to the desired string. More...
switch_status_t	switch_core_file_get_string (_In_ switch_file_handle_t *fh, switch_audio_col_t col, const char **string)
	get metadata of the desired string More...
switch_status_t	switch_core_file_pre_close (_In_ switch_file_handle_t *fh)
	Pre close an open file handle, then can get file size etc., no more wirte to the file. More...
switch_status_t	switch_core_file_handle_dup (switch_file_handle_t *oldfh, switch_file_handle_t **newfh, switch_memory_pool_t *pool)
	Duplicates a file handle using another pool. More...
switch_status_t	switch_core_file_close (_In_ switch_file_handle_t *fh)
	Close an open file handle. More...
switch_status_t	switch_core_file_command (switch_file_handle_t *fh, switch_file_command_t command)
switch_status_t	switch_core_file_truncate (switch_file_handle_t *fh, int64_t offset)
switch_bool_t	switch_core_file_has_video (switch_file_handle_t *fh, switch_bool_t CHECK_OPEN)

Detailed Description

Macro Definition Documentation

switch_core_file_open

#define switch_core_file_open	(		_fh,
			_file_path,
			_channels,
			_rate,
			_flags,
			_pool
	)		switch_core_perform_file_open(__FILE__, __SWITCH_FUNC__, __LINE__, _fh, _file_path, _channels, _rate, _flags, _pool)

Open a media file using file format modules.

Parameters

_fh	a file handle to use
_file_path	the path to the file
_channels	the number of channels
_rate	the sample rate
_flags	read/write flags
_pool	the pool to use (NULL for new pool)

Returns

SWITCH_STATUS_SUCCESS if the file is opened

Note

the loadable module used is chosen based on the file extension

Definition at line 1963 of file switch_core.h.

Referenced by main(), setup_ringback(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_displace_session(), switch_ivr_insert_file(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_record_session_event(), switch_ivr_wait_for_answer(), and switch_ivr_wait_for_silence().

Function Documentation

switch_core_file_close()

switch_status_t switch_core_file_close

(

_In_ switch_file_handle_t *

fh

)

Close an open file handle.

Parameters

fh	the file handle to close

Returns

SWITCH_STATUS_SUCCESS if the file handle was closed

Referenced by main(), read_displace_callback(), record_callback(), record_helper_destroy(), setup_ringback(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_displace_session(), switch_ivr_insert_file(), switch_ivr_originate(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_record_session_event(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), and write_displace_callback().

switch_core_file_command()

switch_status_t switch_core_file_command	(	switch_file_handle_t *	fh,
		switch_file_command_t	command
	)

Definition at line 906 of file switch_core_file.c.

References switch_file_interface::file_command, switch_file_handle::file_interface, switch_file_handle::flag_mutex, switch_file_handle::pre_buffer, SCFC_FLUSH_AUDIO, switch_assert, switch_buffer_zero(), SWITCH_FILE_OPEN, switch_mutex_lock(), switch_mutex_unlock(), SWITCH_STATUS_FALSE, and switch_test_flag.

Referenced by switch_ivr_process_fh(), and switch_ivr_record_file_event().

{
        switch_status_t status = SWITCH_STATUS_FALSE;

        switch_assert(fh != NULL);
        switch_assert(fh->file_interface != NULL);

        if (!switch_test_flag(fh, SWITCH_FILE_OPEN)) {
                return SWITCH_STATUS_FALSE;
        }

        switch(command) {
        case SCFC_FLUSH_AUDIO:
                if (fh->pre_buffer) {
                        switch_buffer_zero(fh->pre_buffer);
                }
                break;
        default:
                break;
        }

        if (fh->file_interface->file_command) {
                switch_mutex_lock(fh->flag_mutex);
                status = fh->file_interface->file_command(fh, command);
                switch_mutex_unlock(fh->flag_mutex);
        }

        return status;
}

switch_core_file_get_string()

switch_status_t switch_core_file_get_string	(	_In_ switch_file_handle_t *	fh,
		switch_audio_col_t	col,
		const char **	string
	)

get metadata of the desired string

Parameters

fh	the file handle to get data from
col	the enum of the col name
string	pointer to the string to fetch

Returns

SWITCH_STATUS_SUCCESS with cur_pos adjusted to new position

Referenced by record_callback(), switch_ivr_play_file(), and switch_ivr_record_file_event().

switch_core_file_handle_dup()

switch_status_t switch_core_file_handle_dup	(	switch_file_handle_t *	oldfh,
		switch_file_handle_t **	newfh,
		switch_memory_pool_t *	pool
	)

Duplicates a file handle using another pool.

Parameters

oldfh	the file handle to duplicate
newfh	pointer to assign new file handle to
pool	the pool to use (NULL for new pool)

Returns

SWITCH_STATUS_SUCCESS if the file handle was duplicated

Definition at line 982 of file switch_core_file.c.

References switch_file_handle::channels, DUP_CHECK, switch_file_handle::flag_mutex, switch_file_handle::memory_pool, pool, switch_file_handle::pre_buffer_data, switch_file_handle::pre_buffer_datalen, switch_assert, switch_clear_flag, switch_core_alloc, switch_core_destroy_memory_pool, switch_core_new_memory_pool, SWITCH_FILE_FLAG_FREE_POOL, switch_goto_status, switch_mutex_init(), SWITCH_MUTEX_NESTED, switch_set_flag, SWITCH_STATUS_MEMERR, and SWITCH_STATUS_SUCCESS.

Referenced by switch_ivr_record_session_event().

{
        switch_status_t status;
        switch_file_handle_t *fh;
        uint8_t destroy_pool = 0;

        switch_assert(oldfh != NULL);
        switch_assert(newfh != NULL);

        if (!pool) {
                if ((status = switch_core_new_memory_pool(&pool)) != SWITCH_STATUS_SUCCESS) {
                        return status;
                }

                destroy_pool = 1;
        }

        if (!(fh = switch_core_alloc(pool, sizeof(switch_file_handle_t)))) {
                switch_goto_status(SWITCH_STATUS_MEMERR, err);
        }

        memcpy(fh, oldfh, sizeof(switch_file_handle_t));

        if (!destroy_pool) {
                switch_clear_flag(fh, SWITCH_FILE_FLAG_FREE_POOL);
        } else {
                fh->memory_pool = pool;
                switch_set_flag(fh, SWITCH_FILE_FLAG_FREE_POOL);
        }

        if ((status = switch_mutex_init(&fh->flag_mutex, SWITCH_MUTEX_NESTED, pool)) != SWITCH_STATUS_SUCCESS) {
                switch_goto_status(status, err);
        }

#define DUP_CHECK(dup) if (oldfh->dup && !(fh->dup = switch_core_strdup(pool, oldfh->dup))) {switch_goto_status(SWITCH_STATUS_MEMERR, err);}

        DUP_CHECK(prefix);
        DUP_CHECK(modname);
        DUP_CHECK(mm.auth_username);
        DUP_CHECK(mm.auth_password);
        DUP_CHECK(stream_name);
        DUP_CHECK(file_path);
        DUP_CHECK(handler);
        DUP_CHECK(spool_path);
        
        fh->pre_buffer_data = NULL;
        if (oldfh->pre_buffer_data) {
                switch_size_t pre_buffer_data_size = oldfh->pre_buffer_datalen * oldfh->channels;
                if (pre_buffer_data_size) {
                        if (!(fh->pre_buffer_data = switch_core_alloc(pool, pre_buffer_data_size))) {
                                switch_goto_status(SWITCH_STATUS_MEMERR, err);
                        }

                        memcpy(fh->pre_buffer_data, oldfh->pre_buffer_data, pre_buffer_data_size);
                }
        }

        *newfh = fh;

        return SWITCH_STATUS_SUCCESS;

err:
        if (destroy_pool) {
                switch_core_destroy_memory_pool(&pool);
        }

        return status;
}

switch_core_file_has_video()

switch_bool_t switch_core_file_has_video	(	switch_file_handle_t *	fh,
		switch_bool_t	CHECK_OPEN
	)

Definition at line 619 of file switch_core_file.c.

References SWITCH_FALSE, SWITCH_FILE_FLAG_VIDEO, SWITCH_FILE_OPEN, switch_test_flag, and SWITCH_TRUE.

Referenced by record_callback(), recording_thread(), switch_core_media_set_video_file(), switch_ivr_play_file(), switch_ivr_record_file_event(), and switch_ivr_record_session_event().

{
        return ((!check_open || switch_test_flag(fh, SWITCH_FILE_OPEN)) && switch_test_flag(fh, SWITCH_FILE_FLAG_VIDEO)) ? SWITCH_TRUE : SWITCH_FALSE;
}

switch_core_file_pre_close()

switch_status_t switch_core_file_pre_close

(

_In_ switch_file_handle_t *

fh

)

Pre close an open file handle, then can get file size etc., no more wirte to the file.

Parameters

fh	the file handle to close

Returns

SWITCH_STATUS_SUCCESS if the file handle was pre closed

Referenced by record_callback(), and switch_ivr_record_file_event().

switch_core_file_read()

switch_status_t switch_core_file_read	(	_In_ switch_file_handle_t *	fh,
		void *	data,
		switch_size_t *	len
	)

Read media from a file handle.

Parameters

fh	the file handle to read from (must be initilized by you memset all 0 for read, fill in channels and rate for write)
data	the buffer to read the data to
len	the max size of the buffer

Returns

SWITCH_STATUS_SUCCESS with len adjusted to the bytes read if successful

Referenced by main(), read_displace_callback(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_insert_file(), switch_ivr_originate(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), and write_displace_callback().

switch_core_file_read_video()

switch_status_t switch_core_file_read_video	(	switch_file_handle_t *	fh,
		switch_frame_t *	frame,
		switch_video_read_flag_t	flags
	)

Definition at line 755 of file switch_core_file.c.

References switch_file_handle::file_interface, switch_file_interface::file_read_video, switch_assert, switch_cond_next(), SWITCH_FILE_OPEN, SWITCH_STATUS_FALSE, SWITCH_STATUS_GENERR, and switch_test_flag.

Referenced by video_write_thread().

{
        switch_status_t status;

        switch_assert(fh != NULL);
        switch_assert(fh->file_interface != NULL);

        if (!switch_test_flag(fh, SWITCH_FILE_OPEN)) {
                return SWITCH_STATUS_GENERR;
        }

        if (!fh->file_interface->file_read_video) {
                return SWITCH_STATUS_FALSE;
        }

        status = fh->file_interface->file_read_video(fh, frame, flags);

        if (status == SWITCH_STATUS_FALSE) {
                switch_cond_next();
        }

        return status;
}

switch_core_file_seek()

switch_status_t switch_core_file_seek	(	_In_ switch_file_handle_t *	fh,
		unsigned int *	cur_pos,
		int64_t	samples,
		int	whence
	)

Seek a position in a file.

Parameters

fh	the file handle to seek
cur_pos	the current position in the file
samples	the amount of samples to seek from the beginning of the file
whence	the indicator (see traditional seek)

Returns

SWITCH_STATUS_SUCCESS with cur_pos adjusted to new position

Referenced by read_displace_callback(), switch_ivr_insert_file(), switch_ivr_originate(), switch_ivr_play_file(), switch_ivr_process_fh(), switch_ivr_record_file_event(), switch_ivr_wait_for_answer(), and write_displace_callback().

switch_core_file_set_string()

switch_status_t switch_core_file_set_string	(	_In_ switch_file_handle_t *	fh,
		switch_audio_col_t	col,
		const char *	string
	)

Set metadata to the desired string.

Parameters

fh	the file handle to set data to
col	the enum of the col name
string	the string to add

Returns

SWITCH_STATUS_SUCCESS with cur_pos adjusted to new position

Referenced by switch_ivr_record_file_event(), and switch_ivr_record_session_event().

switch_core_file_truncate()

switch_status_t switch_core_file_truncate	(	switch_file_handle_t *	fh,
		int64_t	offset
	)

Definition at line 876 of file switch_core_file.c.

References switch_file_handle::buffer, switch_file_handle::file_interface, switch_file_interface::file_truncate, switch_file_handle::pos, switch_file_handle::pre_buffer, switch_file_handle::samples_out, switch_assert, switch_buffer_zero(), SWITCH_FILE_FLAG_WRITE, SWITCH_FILE_OPEN, SWITCH_STATUS_FALSE, SWITCH_STATUS_SUCCESS, and switch_test_flag.

Referenced by switch_ivr_process_fh().

{
        switch_status_t status;

        switch_assert(fh != NULL);
        switch_assert(fh->file_interface != NULL);

        if (!(switch_test_flag(fh, SWITCH_FILE_OPEN) && switch_test_flag(fh, SWITCH_FILE_FLAG_WRITE))) {
                return SWITCH_STATUS_FALSE;
        }

        if (!fh->file_interface->file_truncate) {
                return SWITCH_STATUS_FALSE;
        }

        if ((status = fh->file_interface->file_truncate(fh, offset)) == SWITCH_STATUS_SUCCESS) {
                if (fh->buffer) {
                        switch_buffer_zero(fh->buffer);
                }
                if (fh->pre_buffer) {
                        switch_buffer_zero(fh->pre_buffer);
                }
                fh->samples_out = 0;
                fh->pos = 0;
        }

        return status;

}

switch_core_file_write()

switch_status_t switch_core_file_write	(	_In_ switch_file_handle_t *	fh,
		void *	data,
		switch_size_t *	len
	)

Write media to a file handle.

Parameters

fh	the file handle to write to
data	the buffer to write
len	the amount of data to write from the buffer

Returns

SWITCH_STATUS_SUCCESS with len adjusted to the bytes written if successful

Referenced by main(), record_callback(), recording_thread(), switch_ivr_insert_file(), switch_ivr_record_file_event(), and teletone_handler().

switch_core_file_write_video()

switch_status_t switch_core_file_write_video	(	_In_ switch_file_handle_t *	fh,
		switch_frame_t *	frame
	)

Write media to a file handle.

Parameters

fh	the file handle to write to
data	the buffer to write
len	the amount of data to write from the buffer

Returns

SWITCH_STATUS_SUCCESS with len adjusted to the bytes written if successful

Referenced by record_callback(), and video_helper_thread().

switch_core_perform_file_open()

switch_status_t switch_core_perform_file_open	(	const char *	file,
		const char *	func,
		int	line,
		_In_ switch_file_handle_t *	fh,
		_In_opt_z_ const char *	file_path,
		_In_ uint32_t	channels,
		_In_ uint32_t	rate,
		_In_ unsigned int	flags,
		_In_opt_ switch_memory_pool_t *	pool
	)