app_controlplayback.c

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 1999 - 2005, Digium, Inc.
 *
 * Mark Spencer <[email protected]>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

/*! \file
 *
 * \brief Trivial application to control playback of a sound file
 *
 * \author Mark Spencer <[email protected]>
 *
 * \ingroup applications
 */

/*** MODULEINFO
   <support_level>core</support_level>
 ***/

#include "asterisk.h"

#include "asterisk/pbx.h"
#include "asterisk/app.h"
#include "asterisk/module.h"
#include "asterisk/manager.h"
#include "asterisk/utils.h"
#include "asterisk/astobj2.h"

/*** DOCUMENTATION
   <application name="ControlPlayback" language="en_US">
      <synopsis>
         Play a file with fast forward and rewind.
      </synopsis>
      <syntax>
         <parameter name="filename" required="true" />
         <parameter name="skipms">
            <para>This is number of milliseconds to skip when rewinding or
            fast-forwarding.</para>
         </parameter>
         <parameter name="ff">
            <para>Fast-forward when this DTMF digit is received. (defaults to <literal>#</literal>)</para>
         </parameter>
         <parameter name="rew">
            <para>Rewind when this DTMF digit is received. (defaults to <literal>*</literal>)</para>
         </parameter>
         <parameter name="stop">
            <para>Stop playback when this DTMF digit is received.</para>
         </parameter>
         <parameter name="pause">
            <para>Pause playback when this DTMF digit is received.</para>
         </parameter>
         <parameter name="restart">
            <para>Restart playback when this DTMF digit is received.</para>
         </parameter>
         <parameter name="options">
            <optionlist>
               <option name="o">
                  <argument name="time" required="true">
                     <para>Start at <replaceable>time</replaceable> ms from the
                     beginning of the file.</para>
                  </argument>
               </option>
            </optionlist>
         </parameter>
      </syntax>
      <description>
         <para>This application will play back the given <replaceable>filename</replaceable>.</para>
         <para>It sets the following channel variables upon completion:</para>
         <variablelist>
            <variable name="CPLAYBACKSTATUS">
               <para>Contains the status of the attempt as a text string</para>
               <value name="SUCCESS" />
               <value name="USERSTOPPED" />
               <value name="REMOTESTOPPED" />
               <value name="ERROR" />
            </variable>
            <variable name="CPLAYBACKOFFSET">
               <para>Contains the offset in ms into the file where playback
               was at when it stopped. <literal>-1</literal> is end of file.</para>
            </variable>
            <variable name="CPLAYBACKSTOPKEY">
               <para>If the playback is stopped by the user this variable contains
               the key that was pressed.</para>
            </variable>
         </variablelist>
      </description>
   </application>
   <manager name="ControlPlayback" language="en_US">
      <synopsis>
         Control the playback of a file being played to a channel.
      </synopsis>
      <syntax>
         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
         <parameter name="Channel" required="true">
            <para>The name of the channel that currently has a file being played back to it.</para>
         </parameter>
         <parameter name="Control" required="true">
            <enumlist>
               <enum  name="stop">
                  <para>Stop the playback operation.</para>
               </enum>
               <enum name="forward">
                  <para>Move the current position in the media forward. The amount
                  of time that the stream moves forward is determined by the
                  <replaceable>skipms</replaceable> value passed to the application
                  that initiated the playback.</para>
                  <note>
                     <para>The default skipms value is <literal>3000</literal> ms.</para>
                  </note>
               </enum>
               <enum name="reverse">
                  <para>Move the current position in the media backward. The amount
                  of time that the stream moves backward is determined by the
                  <replaceable>skipms</replaceable> value passed to the application
                  that initiated the playback.</para>
                  <note>
                     <para>The default skipms value is <literal>3000</literal> ms.</para>
                  </note>
               </enum>
               <enum name="pause">
                  <para>Pause/unpause the playback operation, if supported.
                  If not supported, stop the playback.</para>
               </enum>
               <enum name="restart">
                  <para>Restart the playback operation, if supported.
                  If not supported, stop the playback.</para>
               </enum>
            </enumlist>
         </parameter>
      </syntax>
      <description>
         <para>Control the operation of a media file being played back to a channel.
         Note that this AMI action does not initiate playback of media to channel, but
         rather controls the operation of a media operation that was already initiated
         on the channel.</para>
         <note>
            <para>The <literal>pause</literal> and <literal>restart</literal>
            <replaceable>Control</replaceable> options will stop a playback
            operation if that operation was not initiated from the
            <replaceable>ControlPlayback</replaceable> application or the
            <replaceable>control stream file</replaceable> AGI command.</para>
         </note>
      </description>
      <see-also>
         <ref type="application">Playback</ref>
         <ref type="application">ControlPlayback</ref>
         <ref type="agi">stream file</ref>
         <ref type="agi">control stream file</ref>
      </see-also>
   </manager>
 ***/
static const char app[] = "ControlPlayback";

enum {
   OPT_OFFSET = (1 << 1),
};

enum {
   OPT_ARG_OFFSET = 0,
   /* must stay as the last entry ... */
   OPT_ARG_ARRAY_LEN,
};

AST_APP_OPTIONS(cpb_opts, BEGIN_OPTIONS
   AST_APP_OPTION_ARG('o', OPT_OFFSET, OPT_ARG_OFFSET),
   END_OPTIONS
);

static int is_on_phonepad(char key)
{
   return key == 35 || key == 42 || (key >= 48 && key <= 57);
}

static int is_argument(const char *haystack, int needle)
{
   if (ast_strlen_zero(haystack))
      return 0;

   if (strchr(haystack, needle))
      return -1;

   return 0;
}

static int controlplayback_exec(struct ast_channel *chan, const char *data)
{
   int res = 0;
   int skipms = 0;
   long offsetms = 0;
   char offsetbuf[20];
   char stopkeybuf[2];
   char *tmp;
   struct ast_flags opts = { 0, };
   char *opt_args[OPT_ARG_ARRAY_LEN];
   AST_DECLARE_APP_ARGS(args,
      AST_APP_ARG(filename);
      AST_APP_ARG(skip);
      AST_APP_ARG(fwd);
      AST_APP_ARG(rev);
      AST_APP_ARG(stop);
      AST_APP_ARG(pause);
      AST_APP_ARG(restart);
      AST_APP_ARG(options);
   );

   if (ast_strlen_zero(data)) {
      ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
      return -1;
   }

   tmp = ast_strdupa(data);
   AST_STANDARD_APP_ARGS(args, tmp);

   if (args.argc < 1) {
      ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
      return -1;
   }

   skipms = args.skip ? (atoi(args.skip) ? atoi(args.skip) : 3000) : 3000;

   if (!args.fwd || !is_on_phonepad(*args.fwd)) {
      char *digit = "#";
      if (!is_argument(args.rev, *digit) && !is_argument(args.stop, *digit) && !is_argument(args.pause, *digit) && !is_argument(args.restart, *digit))
         args.fwd = digit;
      else
         args.fwd = NULL;
   }
   if (!args.rev || !is_on_phonepad(*args.rev)) {
      char *digit = "*";
      if (!is_argument(args.fwd, *digit) && !is_argument(args.stop, *digit) && !is_argument(args.pause, *digit) && !is_argument(args.restart, *digit))
         args.rev = digit;
      else
         args.rev = NULL;
   }
   ast_debug(1, "Forward key = %s, Rewind key = %s\n", args.fwd, args.rev);
   if (args.stop && !is_on_phonepad(*args.stop))
      args.stop = NULL;
   if (args.pause && !is_on_phonepad(*args.pause))
      args.pause = NULL;
   if (args.restart && !is_on_phonepad(*args.restart))
      args.restart = NULL;

   if (args.options) {
      ast_app_parse_options(cpb_opts, &opts, opt_args, args.options);
      if (ast_test_flag(&opts, OPT_OFFSET))
         offsetms = atol(opt_args[OPT_ARG_OFFSET]);
   }

   res = ast_control_streamfile(chan, args.filename, args.fwd, args.rev, args.stop, args.pause, args.restart, skipms, &offsetms);

   /* If we stopped on one of our stop keys, return 0  */
   if (res > 0 && args.stop && strchr(args.stop, res)) {
      pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "USERSTOPPED");
      snprintf(stopkeybuf, sizeof(stopkeybuf), "%c", res);
      pbx_builtin_setvar_helper(chan, "CPLAYBACKSTOPKEY", stopkeybuf);
      res = 0;
   } else if (res > 0 && res == AST_CONTROL_STREAM_STOP) {
      pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "REMOTESTOPPED");
      res = 0;
   } else {
      if (res < 0) {
         res = 0;
         pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "ERROR");
      } else
         pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "SUCCESS");
   }

   snprintf(offsetbuf, sizeof(offsetbuf), "%ld", offsetms);
   pbx_builtin_setvar_helper(chan, "CPLAYBACKOFFSET", offsetbuf);

   return res;
}

static int controlplayback_manager(struct mansession *s, const struct message *m)
{
   const char *channel_name = astman_get_header(m, "Channel");
   const char *control_type = astman_get_header(m, "Control");
   struct ast_channel *chan;

   if (ast_strlen_zero(channel_name)) {
      astman_send_error(s, m, "Channel not specified");
      return 0;
   }

   if (ast_strlen_zero(control_type)) {
      astman_send_error(s, m, "Control not specified");
      return 0;
   }

   chan = ast_channel_get_by_name(channel_name);
   if (!chan) {
      astman_send_error(s, m, "No such channel");
      return 0;
   }

   if (!strcasecmp(control_type, "stop")) {
      ast_queue_control(chan, AST_CONTROL_STREAM_STOP);
   } else if (!strcasecmp(control_type, "forward")) {
      ast_queue_control(chan, AST_CONTROL_STREAM_FORWARD);
   } else if (!strcasecmp(control_type, "reverse")) {
      ast_queue_control(chan, AST_CONTROL_STREAM_REVERSE);
   } else if (!strcasecmp(control_type, "pause")) {
      ast_queue_control(chan, AST_CONTROL_STREAM_SUSPEND);
   } else if (!strcasecmp(control_type, "restart")) {
      ast_queue_control(chan, AST_CONTROL_STREAM_RESTART);
   } else {
      astman_send_error(s, m, "Unknown control type");
      chan = ast_channel_unref(chan);
      return 0;
   }

   chan = ast_channel_unref(chan);
   astman_send_ack(s, m, NULL);
   return 0;
}

static int unload_module(void)
{
   int res = 0;

   res |= ast_unregister_application(app);
   res |= ast_manager_unregister("ControlPlayback");

   return res;
}

static int load_module(void)
{
   int res = 0;

   res |= ast_register_application_xml(app, controlplayback_exec);
   res |= ast_manager_register_xml("ControlPlayback", EVENT_FLAG_CALL, controlplayback_manager);

   return res;
}

AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Control Playback Application");