15976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org/* 25976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * libjingle 35976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * Copyright 2004--2010, Google Inc. 45976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 55976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * Redistribution and use in source and binary forms, with or without 65976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * modification, are permitted provided that the following conditions are met: 75976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 85976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 1. Redistributions of source code must retain the above copyright notice, 95976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * this list of conditions and the following disclaimer. 105976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 2. Redistributions in binary form must reproduce the above copyright notice, 115976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * this list of conditions and the following disclaimer in the documentation 125976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * and/or other materials provided with the distribution. 135976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 3. The name of the author may not be used to endorse or promote products 145976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * derived from this software without specific prior written permission. 155976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 165976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 175976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 185976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 195976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 205976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 215976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 225976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 235976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 245976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 255976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 265976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org */ 275976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 285976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#ifndef TALK_SOUND_SOUNDINPUTSTREAMINTERFACE_H_ 295976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#define TALK_SOUND_SOUNDINPUTSTREAMINTERFACE_H_ 305976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 315976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#include "talk/base/constructormagic.h" 325976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#include "talk/base/sigslot.h" 335976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 345976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orgnamespace cricket { 355976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 365976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// Interface for consuming an input stream from a recording device. 375976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// Semantics and thread-safety of StartReading()/StopReading() are the same as 385976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// for talk_base::Worker. 395976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orgclass SoundInputStreamInterface { 405976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org public: 415976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org virtual ~SoundInputStreamInterface() {} 425976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 435976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Starts the reading of samples on the current thread. 445976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org virtual bool StartReading() = 0; 455976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Stops the reading of samples. 465976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org virtual bool StopReading() = 0; 475976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 485976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Retrieves the current input volume for this stream. Nominal range is 495976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // defined by SoundSystemInterface::k(Max|Min)Volume, but values exceeding the 505976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // max may be possible in some implementations. This call retrieves the actual 515976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // volume currently in use by the OS, not a cached value from a previous 525976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // (Get|Set)Volume() call. 535976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org virtual bool GetVolume(int *volume) = 0; 545976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 555976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Changes the input volume for this stream. Nominal range is defined by 565976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // SoundSystemInterface::k(Max|Min)Volume. The effect of exceeding kMaxVolume 575976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // is implementation-defined. 585976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org virtual bool SetVolume(int volume) = 0; 595976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 605976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Closes this stream object. If currently reading then this may only be 615976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // called from the reading thread. 625976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org virtual bool Close() = 0; 635976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 645976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Get the latency of the stream. 655976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org virtual int LatencyUsecs() = 0; 665976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 675976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Notifies the consumer of new data read from the device. 685976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // The first parameter is a pointer to the data read, and is only valid for 695976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // the duration of the call. 705976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // The second parameter is the amount of data read in bytes (i.e., the valid 715976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // length of the memory pointed to). 725976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // The 3rd parameter is the stream that is issuing the callback. 735976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org sigslot::signal3<const void *, size_t, 745976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org SoundInputStreamInterface *> SignalSamplesRead; 755976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 765976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org protected: 775976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org SoundInputStreamInterface() {} 785976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 795976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org private: 805976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org DISALLOW_COPY_AND_ASSIGN(SoundInputStreamInterface); 815976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org}; 825976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 835976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} // namespace cricket 845976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 855976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#endif // TALK_SOUND_SOUNDOUTPUTSTREAMINTERFACE_H_ 86