IVR groundwork (move playback into the core and add timing option)

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@448 d0543943-73ff-0310-b7d9-9358b9ac24b2

src/include/switch_ivr.h

+/* 
+ * FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
+ * Copyright (C) 2005/2006, Anthony Minessale II <anthmct@yahoo.com>
+ *
+ * Version: MPL 1.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
+ *
+ * The Initial Developer of the Original Code is
+ * Anthony Minessale II <anthmct@yahoo.com>
+ * Portions created by the Initial Developer are Copyright (C)
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ * 
+ * Anthony Minessale II <anthmct@yahoo.com>
+ *
+ *
+ * switch_ivr.h -- IVR Library
+ *
+ */
+/** 
+ * @file switch_ivr.h
+ * @brief IVR Library
+ * @see switch_ivr
+ */
+
+#ifndef SWITCH_IVR_H
+#define SWITCH_IVR_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <switch.h>
+
+/**
+ * @defgroup switch_ivr IVR Library
+ * @ingroup FREESWITCH
+ *	A group of core functions to do IVR related functions designed to be 
+ *	building blocks for a higher level IVR interface.
+ * @{
+ */
+
+/*!
+  \brief play a file from the disk to the session
+  \param session the session to play the file too
+  \param file the path to the file
+  \param timer_name the name of a timer to use input will be absorbed (NULL to time off the session input).
+  \param dtmf_callback code to execute if any dtmf is dialed during the playback
+  \return SWITCH_STATUS_SUCCESS if all is well
+*/
+SWITCH_DECLARE(switch_status) switch_ivr_play_file(switch_core_session *session,
+												   char *file,
+												   char *timer_name,
+												   switch_dtmf_callback_function dtmf_callback);
+	
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+
+

src/switch_ivr.c

+/* 
+ * FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
+ * Copyright (C) 2005/2006, Anthony Minessale II <anthmct@yahoo.com>
+ *
+ * Version: MPL 1.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
+ *
+ * The Initial Developer of the Original Code is
+ * Anthony Minessale II <anthmct@yahoo.com>
+ * Portions created by the Initial Developer are Copyright (C)
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ * 
+ * Anthony Minessale II <anthmct@yahoo.com>
+ *
+ *
+ * switch_ivr_api.c -- IVR Library
+ *
+ */
+#include <switch.h>
+#include <switch_ivr.h>
+
+
+/* TBD (Lots! there is only 1 function in here lol) */
+
+SWITCH_DECLARE(switch_status) switch_ivr_play_file(switch_core_session *session, 
+												   char *file,
+												   char *timer_name,
+												   switch_dtmf_callback_function dtmf_callback)
+{
+	switch_channel *channel;
+	short buf[960];
+	char dtmf[128];
+	int interval = 0, samples = 0;
+	size_t len = 0, ilen = 0;
+	switch_frame write_frame;
+	switch_timer timer;
+	switch_core_thread_session thread_session;
+	switch_codec codec;
+	switch_memory_pool *pool = switch_core_session_get_pool(session);
+	switch_file_handle fh;
+	char *codec_name;
+	int x;
+	int stream_id;
+	switch_status status = SWITCH_STATUS_SUCCESS;
+
+
+	channel = switch_core_session_get_channel(session);
+	assert(channel != NULL);
+
+	if (switch_core_file_open(&fh,
+							  file,
+							  SWITCH_FILE_FLAG_READ | SWITCH_FILE_DATA_SHORT,
+							  switch_core_session_get_pool(session)) != SWITCH_STATUS_SUCCESS) {
+		switch_channel_hangup(channel);
+		return SWITCH_STATUS_GENERR;
+	}
+
+	switch_channel_answer(channel);
+
+	write_frame.data = buf;
+	write_frame.buflen = sizeof(buf);
+
+
+	switch_console_printf(SWITCH_CHANNEL_CONSOLE, "OPEN FILE %s %dhz %d channels\n", file, fh.samplerate, fh.channels);
+
+	interval = 20;
+	samples = (fh.samplerate / 50) * fh.channels;
+	len = samples * 2;
+
+	codec_name = "L16";
+
+	if (switch_core_codec_init(&codec,
+							   codec_name,
+							   fh.samplerate,
+							   interval,
+							   fh.channels,
+							   SWITCH_CODEC_FLAG_ENCODE | SWITCH_CODEC_FLAG_DECODE,
+							   NULL, pool) == SWITCH_STATUS_SUCCESS) {
+		switch_console_printf(SWITCH_CHANNEL_CONSOLE, "Raw Codec Activated\n");
+		write_frame.codec = &codec;
+	} else {
+		switch_console_printf(SWITCH_CHANNEL_CONSOLE, "Raw Codec Activation Failed %s@%dhz %d channels %dms\n",
+							  codec_name, fh.samplerate, fh.channels, interval);
+		switch_core_file_close(&fh);
+		return SWITCH_STATUS_GENERR;
+	}
+
+	if (timer_name) {
+		if (switch_core_timer_init(&timer, timer_name, interval, samples, pool) != SWITCH_STATUS_SUCCESS) {
+			switch_console_printf(SWITCH_CHANNEL_CONSOLE, "setup timer failed!\n");
+			switch_core_codec_destroy(&codec);
+			switch_core_file_close(&fh);
+			return SWITCH_STATUS_GENERR;
+		}
+		switch_console_printf(SWITCH_CHANNEL_CONSOLE, "setup timer success %d bytes per %d ms!\n", len, interval);
+	}
+	write_frame.rate = fh.samplerate;
+
+	if (timer_name) {
+		/* start a thread to absorb incoming audio */
+		for (stream_id = 0; stream_id < switch_core_session_get_stream_count(session); stream_id++) {
+			switch_core_service_session(session, &thread_session, stream_id);
+		}
+	}
+
+	ilen = samples;
+	while (switch_channel_get_state(channel) == CS_EXECUTE) {
+		int done = 0;
+
+		if (dtmf_callback) {
+			/*
+			  dtmf handler function you can hook up to be executed when a digit is dialed during playback 
+			  if you return anything but SWITCH_STATUS_SUCCESS the playback will stop.
+			*/
+			if (switch_channel_has_dtmf(channel)) {
+				switch_channel_dequeue_dtmf(channel, dtmf, sizeof(dtmf));
+				status = dtmf_callback(session, dtmf);
+			}
+
+			if (status != SWITCH_STATUS_SUCCESS) {
+				done = 1;
+				break;
+			}
+		}
+		
+		switch_core_file_read(&fh, buf, &ilen);
+
+		if (done || ilen <= 0) {
+			break;
+		}
+
+		write_frame.datalen = ilen * 2;
+		write_frame.samples = (int) ilen;
+#ifdef SWAP_LINEAR
+		switch_swap_linear(write_frame.data, (int) write_frame.datalen / 2);
+#endif
+
+		for (stream_id = 0; stream_id < switch_core_session_get_stream_count(session); stream_id++) {
+			if (switch_core_session_write_frame(session, &write_frame, -1, stream_id) != SWITCH_STATUS_SUCCESS) {
+				switch_console_printf(SWITCH_CHANNEL_CONSOLE, "Bad Write\n");
+				done = 1;
+				break;
+			}
+
+			if (done) {
+				break;
+			}
+		}
+		if (timer_name) {
+			if ((x = switch_core_timer_next(&timer)) < 0) {
+				break;
+			}
+		} else { /* time off the channel (if you must) */
+			switch_frame *read_frame;
+			switch_core_session_read_frame(session, &read_frame, -1, 0);
+		}
+	}
+
+	switch_console_printf(SWITCH_CHANNEL_CONSOLE, "done playing file\n");
+	switch_core_file_close(&fh);
+
+	switch_core_codec_destroy(&codec);
+
+	if (timer_name) {
+		/* End the audio absorbing thread */
+		switch_core_thread_session_end(&thread_session);
+		switch_core_timer_destroy(&timer);
+	}
+
+	return status;
+}