Home | History | Annotate | Download | only in media 
      1 /*
      2  * libjingle
      3  * Copyright 2004 Google Inc.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions are met:
      7  *
      8  *  1. Redistributions of source code must retain the above copyright notice,
      9  *     this list of conditions and the following disclaimer.
     10  *  2. Redistributions in binary form must reproduce the above copyright notice,
     11  *     this list of conditions and the following disclaimer in the documentation
     12  *     and/or other materials provided with the distribution.
     13  *  3. The name of the author may not be used to endorse or promote products
     14  *     derived from this software without specific prior written permission.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
     17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
     19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
     22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
     24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
     25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     26  */
     27 
     28 #ifndef TALK_SESSION_MEDIA_TYPINGMONITOR_H_
     29 #define TALK_SESSION_MEDIA_TYPINGMONITOR_H_
     30 
     31 #include "talk/base/messagehandler.h"
     32 #include "talk/media/base/mediachannel.h"
     33 
     34 namespace talk_base {
     35 class Thread;
     36 }
     37 
     38 namespace cricket {
     39 
     40 class VoiceChannel;
     41 class BaseChannel;
     42 
     43 struct TypingMonitorOptions {
     44   int cost_per_typing;
     45   int mute_period;
     46   int penalty_decay;
     47   int reporting_threshold;
     48   int time_window;
     49   int type_event_delay;
     50   size_t min_participants;
     51 };
     52 
     53 /**
     54  * An object that observes a channel and listens for typing detection warnings,
     55  * which can be configured to mute audio capture of that channel for some period
     56  * of time.  The purpose is to automatically mute someone if they are disturbing
     57  * a conference with loud keystroke audio signals.
     58  */
     59 class TypingMonitor
     60     : public talk_base::MessageHandler, public sigslot::has_slots<> {
     61  public:
     62   TypingMonitor(VoiceChannel* channel, talk_base::Thread* worker_thread,
     63                 const TypingMonitorOptions& params);
     64   ~TypingMonitor();
     65 
     66   sigslot::signal2<BaseChannel*, bool> SignalMuted;
     67 
     68   void OnChannelMuted();
     69 
     70  private:
     71   void OnVoiceChannelError(uint32 ssrc, VoiceMediaChannel::Error error);
     72   void OnMessage(talk_base::Message* msg);
     73 
     74   VoiceChannel* channel_;
     75   talk_base::Thread* worker_thread_;
     76   int mute_period_;
     77   int muted_at_;
     78   bool has_pending_unmute_;
     79 };
     80 
     81 }  // namespace cricket
     82 
     83 #endif  // TALK_SESSION_MEDIA_TYPINGMONITOR_H_
     84 
     85