GPU workaround to simulate Out of Memory errors with large textures
[chromium-blink-merge.git] / content / common / gpu / media / h264_dpb.h
bloba46e681371d216ca72f79a0a63d8fccdaa668a00
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 //
5 // This file contains an implementation of an H.264 Decoded Picture Buffer
6 // used in H264 decoders.
8 #ifndef CONTENT_COMMON_GPU_MEDIA_H264_DPB_H_
9 #define CONTENT_COMMON_GPU_MEDIA_H264_DPB_H_
11 #include <vector>
13 #include "base/basictypes.h"
14 #include "base/memory/ref_counted.h"
15 #include "media/filters/h264_parser.h"
17 namespace content {
19 class V4L2H264Picture;
21 // A picture (a frame or a field) in the H.264 spec sense.
22 // See spec at http://www.itu.int/rec/T-REC-H.264
23 struct H264PictureBase {
24 enum Field {
25 FIELD_NONE,
26 FIELD_TOP,
27 FIELD_BOTTOM,
30 H264PictureBase();
32 // Values calculated per H.264 specification or taken from slice header.
33 // See spec for more details on each (some names have been converted from
34 // CamelCase in spec to Chromium-style names).
35 int top_field_order_cnt;
36 int bottom_field_order_cnt;
37 int pic_order_cnt;
38 int pic_order_cnt_msb;
39 int pic_order_cnt_lsb;
41 int pic_num;
42 int long_term_pic_num;
43 int frame_num; // from slice header
44 int frame_num_offset;
45 int frame_num_wrap;
46 int long_term_frame_idx;
48 media::H264SliceHeader::Type type;
49 bool idr; // IDR picture?
50 bool ref; // reference picture?
51 bool long_term; // long term reference picture?
52 bool outputted;
53 // Does memory management op 5 needs to be executed after this
54 // picture has finished decoding?
55 bool mem_mgmt_5;
57 Field field;
59 // Values from slice_hdr to be used during reference marking and
60 // memory management after finishing this picture.
61 bool long_term_reference_flag;
62 bool adaptive_ref_pic_marking_mode_flag;
63 media::H264DecRefPicMarking
64 ref_pic_marking[media::H264SliceHeader::kRefListSize];
66 // Position in DPB (i.e. index in DPB).
67 int dpb_position;
70 class H264Picture : public H264PictureBase,
71 public base::RefCounted<H264Picture> {
72 public:
73 H264Picture();
75 virtual V4L2H264Picture* AsV4L2H264Picture();
77 using Vector = std::vector<scoped_refptr<H264Picture>>;
79 protected:
80 friend class base::RefCounted<H264Picture>;
81 virtual ~H264Picture();
83 DISALLOW_COPY_AND_ASSIGN(H264Picture);
86 // DPB - Decoded Picture Buffer.
87 // Stores decoded pictures that will be used for future display
88 // and/or reference.
89 class H264DPB {
90 public:
91 H264DPB();
92 ~H264DPB();
94 void set_max_num_pics(size_t max_num_pics);
95 size_t max_num_pics() const { return max_num_pics_; }
97 // Remove unused (not reference and already outputted) pictures from DPB
98 // and free it.
99 void DeleteUnused();
101 // Remove a picture by its pic_order_cnt and free it.
102 void DeleteByPOC(int poc);
104 // Clear DPB.
105 void Clear();
107 // Store picture in DPB. DPB takes ownership of its resources.
108 void StorePic(const scoped_refptr<H264Picture>& pic);
110 // Return the number of reference pictures in DPB.
111 int CountRefPics();
113 // Mark all pictures in DPB as unused for reference.
114 void MarkAllUnusedForRef();
116 // Return a short-term reference picture by its pic_num.
117 scoped_refptr<H264Picture> GetShortRefPicByPicNum(int pic_num);
119 // Return a long-term reference picture by its long_term_pic_num.
120 scoped_refptr<H264Picture> GetLongRefPicByLongTermPicNum(int pic_num);
122 // Return the short reference picture with lowest frame_num. Used for sliding
123 // window memory management.
124 scoped_refptr<H264Picture> GetLowestFrameNumWrapShortRefPic();
126 // Append all pictures that have not been outputted yet to the passed |out|
127 // vector, sorted by lowest pic_order_cnt (in output order).
128 void GetNotOutputtedPicsAppending(H264Picture::Vector* out);
130 // Append all short term reference pictures to the passed |out| vector.
131 void GetShortTermRefPicsAppending(H264Picture::Vector* out);
133 // Append all long term reference pictures to the passed |out| vector.
134 void GetLongTermRefPicsAppending(H264Picture::Vector* out);
136 // Iterators for direct access to DPB contents.
137 // Will be invalidated after any of Remove* calls.
138 H264Picture::Vector::iterator begin() { return pics_.begin(); }
139 H264Picture::Vector::iterator end() { return pics_.end(); }
140 H264Picture::Vector::const_iterator begin() const { return pics_.begin(); }
141 H264Picture::Vector::const_iterator end() const { return pics_.end(); }
142 H264Picture::Vector::reverse_iterator rbegin() { return pics_.rbegin(); }
143 H264Picture::Vector::reverse_iterator rend() { return pics_.rend(); }
145 size_t size() const { return pics_.size(); }
146 bool IsFull() const { return pics_.size() == max_num_pics_; }
148 // Per H264 spec, increase to 32 if interlaced video is supported.
149 enum { kDPBMaxSize = 16, };
151 private:
152 void UpdatePicPositions();
154 H264Picture::Vector pics_;
155 size_t max_num_pics_;
157 DISALLOW_COPY_AND_ASSIGN(H264DPB);
160 } // namespace content
162 #endif // CONTENT_COMMON_GPU_MEDIA_H264_DPB_H_