videoframefactory.h revision 20e8f227664a6747cea11e1fc1de4c018ebcc8e9 
1/*
2 * libjingle
3 * Copyright 2014 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_VIDEOFRAMEFACTORY_H_
29#define TALK_MEDIA_BASE_VIDEOFRAMEFACTORY_H_
30
31#include "talk/media/base/videoframe.h"
32#include "webrtc/base/scoped_ptr.h"
33
34namespace cricket {
35
36struct CapturedFrame;
37class VideoFrame;
38
39// Creates cricket::VideoFrames, or a subclass of cricket::VideoFrame
40// depending on the subclass of VideoFrameFactory.
41class VideoFrameFactory {
42 public:
43  VideoFrameFactory() : apply_rotation_(true) {}
44  virtual ~VideoFrameFactory() {}
45
46  // The returned frame aliases the aliased_frame if the input color
47  // space allows for aliasing, otherwise a color conversion will
48  // occur.  For safety, |input_frame| must outlive the returned
49  // frame.  Returns NULL if conversion fails.
50
51  // The returned frame will be a center crop of |input_frame| with
52  // size |cropped_width| x |cropped_height|.
53  virtual VideoFrame* CreateAliasedFrame(const CapturedFrame* input_frame,
54                                         int cropped_width,
55                                         int cropped_height) const = 0;
56
57  // The returned frame will be a center crop of |input_frame| with size
58  // |cropped_width| x |cropped_height|, scaled to |output_width| x
59  // |output_height|. If scaling has taken place, i.e. cropped input
60  // resolution != output resolution, the returned frame will remain valid
61  // until this function is called again.
62  virtual VideoFrame* CreateAliasedFrame(const CapturedFrame* input_frame,
63                                         int cropped_input_width,
64                                         int cropped_input_height,
65                                         int output_width,
66                                         int output_height) const;
67
68  void SetApplyRotation(bool enable) { apply_rotation_ = enable; }
69
70 protected:
71  bool apply_rotation_;
72
73 private:
74  // An internal frame buffer to avoid reallocations. It is mutable because it
75  // does not affect behaviour, only performance.
76  mutable rtc::scoped_ptr<VideoFrame> output_frame_;
77};
78
79}  // namespace cricket
80
81#endif  // TALK_MEDIA_BASE_VIDEOFRAMEFACTORY_H_
82