Attachment 57456 Details for Bug 46443 – Reduce Chan.I.DTMF1 to just the bits needed for Call1

[patch] Reduce Chan.I.DTMF1 to just the bits needed for Call1

0001-Reduce-Chan.I.DTMF1-to-just-the-bits-needed-for-Call.patch (text/plain), 13.46 KB, created by Simon McVittie on 2012-02-22 05:18:11 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Simon McVittie

Created: 2012-02-22 05:18:11 UTC

Size: 13.46 KB

patch

obsolete

>From b38c75062bfb9a8c560639a78f2ec64860f3ae01 Mon Sep 17 00:00:00 2001
>From: Simon McVittie <simon.mcvittie@collabora.co.uk>
>Date: Wed, 22 Feb 2012 13:15:25 +0000
>Subject: [PATCH] Reduce Chan.I.DTMF1 to just the bits needed for Call1
>
>In Call1, everything except InitialTones has moved to the audio Content.
>
>Also rewrite the introduction to explain its reduced scope.
>---
> spec/Channel_Interface_DTMF1.xml | 262 ++------------------------------------
> 1 files changed, 12 insertions(+), 250 deletions(-)
>
>diff --git a/spec/Channel_Interface_DTMF1.xml b/spec/Channel_Interface_DTMF1.xml
>index 0222dd7..c55be38 100644
>--- a/spec/Channel_Interface_DTMF1.xml
>+++ b/spec/Channel_Interface_DTMF1.xml
>@@ -21,193 +21,23 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
> <interface name="im.telepathy1.Channel.Interface.DTMF1">
> <tp:requires interface="im.telepathy1.Channel.Type.Call1"/>
> 
>- <tp:changed version="0.25.2">The only part of this spec that should
>- be used with a Call1 channel is the "InitialTones" property.
>- </tp:changed>
>-
>- <tp:changed version="0.19.6">The Stream_IDs in this
>- interface can now be ignored by CMs.
>+ <tp:changed version="0.UNRELEASED">
>+ Removed everything not applicable to Call1.
> </tp:changed>
> 
> <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
>- An interface that gives a Channel the ability to send DTMF
>- events over audio streams which have been established using the
>- <tp:dbus-ref namespace="imt1.Channel.Type">Call1</tp:dbus-ref>
>- channel type. The event codes used are in common with those
>- defined in <a
>- href="http://www.rfc-editor.org/rfc/rfc4733.txt">RFC4733</a>,
>- and are listed in the <tp:type>DTMF_Event</tp:type> enumeration.
>+ An interface that gives
>+ <tp:dbus-ref namespace="imt1.Channel.Type">Call1</tp:dbus-ref>
>+ channels the ability to send a sequence of DTMF events as soon
>+ as the call is established. For instance, this could be used
>+ to dial an extension number automatically.
>+
>+ To send DTMF events later in the call, including interactively
>+ via a dial-pad, use the
>+ <tp:dbus-ref namespace="imt1.Call1.Content.Interface">DTMF1</tp:dbus-ref>
>+ interface on an audio Content.
> </tp:docstring>
> 
>- <method name="StartTone" tp:name-for-bindings="Start_Tone">
>- <tp:changed version="0.19.6">The <var>Stream_ID</var> parameter became
>- vestigial.</tp:changed>
>- <arg direction="in" name="Stream_ID" type="u">
>- <tp:docstring>This argument is included for backwards
>- compatibility and MUST be ignored by the implementations - the
>- tone SHOULD be sent to all eligible streams in the
>- channel.</tp:docstring>
>- </arg>
>- <arg direction="in" name="Event" type="y" tp:type="DTMF_Event">
>- <tp:docstring>A numeric event code from the DTMF_Event enum.</tp:docstring>
>- </arg>
>-
>- <tp:docstring>
>- Start sending a DTMF tone to all eligible streams in the channel.
>- Where possible, the tone will continue until
>- <tp:member-ref>StopTone</tp:member-ref> is called. On certain protocols,
>- it may only be possible to send events with a predetermined length. In
>- this case, the implementation MAY emit a fixed-length tone, and the
>- StopTone method call SHOULD return NotAvailable.
>- <tp:rationale>
>- The client may wish to control the exact duration and timing of the
>- tones sent as a result of user's interaction with the dialpad, thus
>- starting and stopping the tone sending explicitly.
>- </tp:rationale>
>-
>- Tone overlaping or queueing is not supported, so this method can only
>- be called if no DTMF tones are already being played.
>- </tp:docstring>
>- <tp:possible-errors>
>- <tp:error name="im.telepathy1.Error.NetworkError" />
>- <tp:error name="im.telepathy1.Error.InvalidArgument">
>- <tp:docstring>
>- The given stream ID was invalid. Deprecated, since stream IDs
>- are ignored.
>- </tp:docstring>
>- </tp:error>
>- <tp:error name="im.telepathy1.Error.NotAvailable">
>- <tp:docstring>
>- There are no eligible audio streams.
>- </tp:docstring>
>- </tp:error>
>- <tp:error name="im.telepathy1.Error.ServiceBusy">
>- <tp:docstring>
>- DTMF tones are already being played.
>- </tp:docstring>
>- </tp:error>
>- </tp:possible-errors>
>- </method>
>-
>- <method name="StopTone" tp:name-for-bindings="Stop_Tone">
>- <tp:changed version="0.19.6">The <var>Stream_ID</var> parameter became
>- vestigial.</tp:changed>
>- <arg direction="in" name="Stream_ID" type="u">
>- <tp:docstring>This argument is included for backwards
>- compatibility and MUST be ignored by the implementations - the
>- sending SHOULD be stoped in all eligible streams in the
>- channel.</tp:docstring>
>- </arg>
>-
>- <tp:docstring>
>- Stop sending any DTMF tones which have been started using the
>- <tp:member-ref>StartTone</tp:member-ref> or
>- <tp:member-ref>MultipleTones</tp:member-ref> methods.
>- If there is no current tone, this method will do nothing.
>- If MultipleTones was used, the client should not assume the
>- sending has stopped immediately; instead, the client should wait
>- for the StoppedTones signal.
>- <tp:rationale>
>- On some protocols it might be impossible to cancel queued tones
>- immediately.
>- </tp:rationale>
>- </tp:docstring>
>- <tp:possible-errors>
>- <tp:error name="im.telepathy1.Error.NetworkError" />
>- <tp:error name="im.telepathy1.Error.InvalidArgument">
>- <tp:docstring>
>- The given stream ID was invalid. Deprecated, since stream IDs
>- are ignored.
>- </tp:docstring>
>- </tp:error>
>- <tp:error name="im.telepathy1.Error.NotAvailable">
>- <tp:docstring>
>- Continuous tones are not supported by this stream. Deprecated,
>- since stream IDs are ignored.
>- </tp:docstring>
>- </tp:error>
>- </tp:possible-errors>
>- </method>
>-
>- <method name="MultipleTones" tp:name-for-bindings="Multiple_Tones">
>- <tp:added version="0.19.6" />
>- <tp:changed version="0.21.3">The characters [pPxXwW,] must
>- also be supported.</tp:changed>
>- <arg direction="in" name="Tones" type="s">
>- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
>- A string representation of one or more DTMF
>- events. Implementations of this method MUST support all of the
>- following characters in this string:
>-
>- <ul>
>- <li>the digits 0-9, letters A-D and a-d, and symbols '*' and '#'
>- correspond to the members of <tp:type>DTMF_Event</tp:type></li>
>-
>- <li>any of 'p', 'P', 'x', 'X' or ',' (comma) results in an
>- implementation-defined pause, typically for 3 seconds</li>
>-
>- <li>'w' or 'W' waits for the user to continue, by stopping
>- interpretation of the string, and if there is more to be played,
>- emitting the <tp:member-ref>TonesDeferred</tp:member-ref> signal
>- with the rest of the string as its argument: see that signal
>- for details</li>
>- </ul>
>- </tp:docstring>
>- </arg>
>- <tp:docstring>
>- Send multiple DTMF events to all eligible streams in the channel.
>- Each tone will be played for an implementation-defined number of
>- milliseconds (typically 250ms), followed by a gap before the next tone
>- is played (typically 100ms). The
>- duration and gap are defined by the protocol or connection manager.
>-
>- <tp:rationale>
>- In cases where the client knows in advance the tone sequence it
>- wants to send, it's easier to use this method than manually start
>- and stop each tone in the sequence.
>-
>- The tone and gap lengths may need to vary for interoperability,
>- according to the protocol and other implementations' ability to
>- recognise tones. At the time of writing, GStreamer uses a
>- minimum of 250ms tones and 100ms gaps when playing in-band DTMF
>- in the normal audio stream, or 70ms tones and 50ms gaps when
>- encoding DTMF as <code>audio/telephone-event</code>.
>- </tp:rationale>
>-
>- Tone overlaping or queueing is not supported, so this method can only
>- be called if no DTMF tones are already being played.
>- </tp:docstring>
>- <tp:possible-errors>
>- <tp:error name="im.telepathy1.Error.NetworkError" />
>- <tp:error name="im.telepathy1.Error.InvalidArgument">
>- <tp:docstring>
>- The supplied Tones string was invalid.
>- </tp:docstring>
>- </tp:error>
>- <tp:error name="im.telepathy1.Error.NotAvailable">
>- <tp:docstring>
>- There are no eligible audio streams.
>- </tp:docstring>
>- </tp:error>
>- <tp:error name="im.telepathy1.Error.ServiceBusy">
>- <tp:docstring>
>- DTMF tones are already being played.
>- </tp:docstring>
>- </tp:error>
>- </tp:possible-errors>
>- </method>
>-
>- <property name="CurrentlySendingTones"
>- tp:name-for-bindings="Currently_Sending_Tones" type="b" access="read">
>- <tp:added version="0.19.6" />
>- <tp:docstring>
>- Indicates whether there are DTMF tones currently being sent in the
>- channel. If so, the client should wait for
>- <tp:member-ref>StoppedTones</tp:member-ref> signal before trying to
>- send more tones.
>- </tp:docstring>
>- </property>
>-
> <property name="InitialTones" tp:name-for-bindings="Initial_Tones"
> type="s" access="read" tp:immutable="yes" tp:requestable="yes">
> <tp:added version="0.19.6" />
>@@ -223,74 +53,6 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
> </tp:docstring>
> </property>
> 
>- <property name="DeferredTones" tp:name-for-bindings="Deferred_Tones"
>- type="s" access="read">
>- <tp:added version="0.21.3" />
>- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
>- The tones waiting for the user to continue, if any.
>-
>- When this property is set to a non-empty value,
>- <tp:member-ref>TonesDeferred</tp:member-ref> is emitted.
>- When any tones are played (i.e. whenever
>- <tp:member-ref>SendingTones</tp:member-ref> is emitted),
>- this property is reset to the empty string.
>- </tp:docstring>
>- </property>
>-
>- <signal name="TonesDeferred" tp:name-for-bindings="Tones_Deferred">
>- <tp:added version="0.21.3" />
>- <arg name="Tones" type="s">
>- <tp:docstring>The new non-empty value of
>- <tp:member-ref>DeferredTones</tp:member-ref>.</tp:docstring>
>- </arg>
>- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
>- Emitted when 'w' or 'W', indicating "wait for the user to continue",
>- is encountered while playing a DTMF string queued by
>- <tp:member-ref>MultipleTones</tp:member-ref> or
>- <tp:member-ref>InitialTones</tp:member-ref>. Any queued DTMF events
>- after the 'w', which have not yet been played, are placed in the
>- <tp:member-ref>DeferredTones</tp:member-ref> property and copied
>- into this signal's argument.
>-
>- When the channel handler is ready to continue, it MAY pass the
>- value of <tp:member-ref>DeferredTones</tp:member-ref> to
>- <tp:member-ref>MultipleTones</tp:member-ref>, to resume sending.
>- Alternatively, it MAY ignore the deferred tones, or even play
>- different tones instead. Any deferred tones are discarded the next
>- time a tone is played.
>-
>- This signal SHOULD NOT be emitted if there is nothing left to play,
>- i.e. if the 'w' was the last character in the DTMF string.
>- </tp:docstring>
>- </signal>
>-
>- <signal name="SendingTones" tp:name-for-bindings="Sending_Tones">
>- <tp:added version="0.19.6" />
>- <arg name="Tones" type="s">
>- <tp:docstring>DTMF string (one or more events) that is to be played.
>- </tp:docstring>
>- </arg>
>- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
>- DTMF tone(s)are being sent to all eligible streams in the channel.
>- The signal is provided to indicating the fact that the streams are
>- currently being used to send one or more DTMF tones, so any other
>- media input is not getting through to the audio stream. It also
>- serves as a cue for the
>- <tp:member-ref>StopTone</tp:member-ref> method.
>- </tp:docstring>
>- </signal>
>-
>- <signal name="StoppedTones" tp:name-for-bindings="Stopped_Tones">
>- <tp:added version="0.19.6" />
>- <arg name="Cancelled" type="b">
>- <tp:docstring>True if the DTMF tones were actively cancelled via
>- <tp:member-ref>StopTone</tp:member-ref>.</tp:docstring>
>- </arg>
>- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
>- DTMF tones have finished playing on streams in this channel.
>- </tp:docstring>
>- </signal>
>-
> <tp:enum name="DTMF_Event" type="y">
> <tp:enumvalue suffix="Digit_0" value="0">
> <tp:docstring>0</tp:docstring>
>-- 
>1.7.9.1
>

Actions: View | Splinter Review

Attachments on bug 46443: 57456

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.