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_MEDIA_BASE_VIDEORENDERER_H_
29 #define TALK_MEDIA_BASE_VIDEORENDERER_H_
30 
31 #if !defined(NDEBUG)
32 #include <string>
33 #endif
34 
35 #include "webrtc/base/sigslot.h"
36 
37 namespace cricket {
38 
39 class VideoFrame;
40 
41 // Abstract interface for rendering VideoFrames.
42 class VideoRenderer {
43  public:
~VideoRenderer()44   virtual ~VideoRenderer() {}
45   // Called when the video has changed size.
46   // TODO(nisse): This method is not really used, and should be
47   // deleted. Provide a default do-nothing implementation, to easy the
48   // transition as the method is deleted in subclasses, in particular,
49   // chrome's MockVideoRenderer class.
SetSize(int width,int height,int reserved)50   virtual bool SetSize(int width, int height, int reserved) { return true; };
51   // Called when a new frame is available for display.
52   virtual bool RenderFrame(const VideoFrame *frame) = 0;
53 
54 #if !defined(NDEBUG)
55   // Allow renderer dumping out rendered frames.
SetDumpPath(const std::string & path)56   virtual bool SetDumpPath(const std::string &path) { return true; }
57 #endif
58 };
59 
60 }  // namespace cricket
61 
62 #endif  // TALK_MEDIA_BASE_VIDEORENDERER_H_
63