[MD settings] moving attached() code
[chromium-blink-merge.git] / media / video / video_decode_accelerator.h
blob2b71d65ab075926a56d690856d7de1b95a595406
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.
5 #ifndef MEDIA_VIDEO_VIDEO_DECODE_ACCELERATOR_H_
6 #define MEDIA_VIDEO_VIDEO_DECODE_ACCELERATOR_H_
8 #include <vector>
10 #include "base/basictypes.h"
11 #include "media/base/bitstream_buffer.h"
12 #include "media/base/video_decoder_config.h"
13 #include "media/video/picture.h"
14 #include "ui/gfx/geometry/size.h"
16 typedef unsigned int GLenum;
18 namespace media {
20 // Video decoder interface.
21 // This interface is extended by the various components that ultimately
22 // implement the backend of PPB_VideoDecoder_Dev.
23 class MEDIA_EXPORT VideoDecodeAccelerator {
24 public:
25 // Specification of a decoding profile supported by an decoder.
26 // |max_resolution| and |min_resolution| are inclusive.
27 struct MEDIA_EXPORT SupportedProfile {
28 SupportedProfile();
29 ~SupportedProfile();
30 VideoCodecProfile profile;
31 gfx::Size max_resolution;
32 gfx::Size min_resolution;
34 using SupportedProfiles = std::vector<SupportedProfile>;
36 // Enumeration of potential errors generated by the API.
37 // Note: Keep these in sync with PP_VideoDecodeError_Dev. Also do not
38 // rearrange, reuse or remove values as they are used for gathering UMA
39 // statistics.
40 enum Error {
41 // An operation was attempted during an incompatible decoder state.
42 ILLEGAL_STATE = 1,
43 // Invalid argument was passed to an API method.
44 INVALID_ARGUMENT,
45 // Encoded input is unreadable.
46 UNREADABLE_INPUT,
47 // A failure occurred at the browser layer or one of its dependencies.
48 // Examples of such failures include GPU hardware failures, GPU driver
49 // failures, GPU library failures, browser programming errors, and so on.
50 PLATFORM_FAILURE,
51 // Largest used enum. This should be adjusted when new errors are added.
52 LARGEST_ERROR_ENUM,
55 // Interface for collaborating with picture interface to provide memory for
56 // output picture and blitting them. These callbacks will not be made unless
57 // Initialize() has returned successfully.
58 // This interface is extended by the various layers that relay messages back
59 // to the plugin, through the PPP_VideoDecoder_Dev interface the plugin
60 // implements.
61 class MEDIA_EXPORT Client {
62 public:
63 // Callback to tell client how many and what size of buffers to provide.
64 // Note that the actual count provided through AssignPictureBuffers() can be
65 // larger than the value requested.
66 virtual void ProvidePictureBuffers(uint32 requested_num_of_buffers,
67 const gfx::Size& dimensions,
68 uint32 texture_target) = 0;
70 // Callback to dismiss picture buffer that was assigned earlier.
71 virtual void DismissPictureBuffer(int32 picture_buffer_id) = 0;
73 // Callback to deliver decoded pictures ready to be displayed.
74 virtual void PictureReady(const Picture& picture) = 0;
76 // Callback to notify that decoded has decoded the end of the current
77 // bitstream buffer.
78 virtual void NotifyEndOfBitstreamBuffer(int32 bitstream_buffer_id) = 0;
80 // Flush completion callback.
81 virtual void NotifyFlushDone() = 0;
83 // Reset completion callback.
84 virtual void NotifyResetDone() = 0;
86 // Callback to notify about decoding errors. Note that errors in
87 // Initialize() will not be reported here, but will instead be indicated by
88 // a false return value there.
89 virtual void NotifyError(Error error) = 0;
91 protected:
92 virtual ~Client() {}
95 // Video decoder functions.
97 // Initializes the video decoder with specific configuration. Called once per
98 // decoder construction. This call is synchronous and returns true iff
99 // initialization is successful.
100 // Parameters:
101 // |profile| is the video stream's format profile.
102 // |client| is the client of this video decoder. The provided pointer must
103 // be valid until Destroy() is called.
104 virtual bool Initialize(VideoCodecProfile profile, Client* client) = 0;
106 // Decodes given bitstream buffer that contains at most one frame. Once
107 // decoder is done with processing |bitstream_buffer| it will call
108 // NotifyEndOfBitstreamBuffer() with the bitstream buffer id.
109 // Parameters:
110 // |bitstream_buffer| is the input bitstream that is sent for decoding.
111 virtual void Decode(const BitstreamBuffer& bitstream_buffer) = 0;
113 // Assigns a set of texture-backed picture buffers to the video decoder.
115 // Ownership of each picture buffer remains with the client, but the client
116 // is not allowed to deallocate the buffer before the DismissPictureBuffer
117 // callback has been initiated for a given buffer.
119 // Parameters:
120 // |buffers| contains the allocated picture buffers for the output. Note
121 // that the count of buffers may be larger than the count requested through
122 // the call to Client::ProvidePictureBuffers().
123 virtual void AssignPictureBuffers(
124 const std::vector<PictureBuffer>& buffers) = 0;
126 // Sends picture buffers to be reused by the decoder. This needs to be called
127 // for each buffer that has been processed so that decoder may know onto which
128 // picture buffers it can write the output to.
130 // Parameters:
131 // |picture_buffer_id| id of the picture buffer that is to be reused.
132 virtual void ReusePictureBuffer(int32 picture_buffer_id) = 0;
134 // Flushes the decoder: all pending inputs will be decoded and pictures handed
135 // back to the client, followed by NotifyFlushDone() being called on the
136 // client. Can be used to implement "end of stream" notification.
137 virtual void Flush() = 0;
139 // Resets the decoder: all pending inputs are dropped immediately and the
140 // decoder returned to a state ready for further Decode()s, followed by
141 // NotifyResetDone() being called on the client. Can be used to implement
142 // "seek".
143 virtual void Reset() = 0;
145 // Destroys the decoder: all pending inputs are dropped immediately and the
146 // component is freed. This call may asynchornously free system resources,
147 // but its client-visible effects are synchronous. After this method returns
148 // no more callbacks will be made on the client. Deletes |this|
149 // unconditionally, so make sure to drop all pointers to it!
150 virtual void Destroy() = 0;
152 // GPU PROCESS ONLY. Implementations of this interface in the
153 // content/common/gpu/media should implement this, and implementations in
154 // other processes should not override the default implementation.
155 // Returns true if VDA::Decode and VDA::Client callbacks can run on the IO
156 // thread. Otherwise they will run on the GPU child thread. The purpose of
157 // running Decode on the IO thread is to reduce decode latency. Note Decode
158 // should return as soon as possible and not block on the IO thread. Also,
159 // PictureReady should be run on the child thread if a picture is delivered
160 // the first time so it can be cleared.
161 virtual bool CanDecodeOnIOThread();
163 // Windows creates a BGRA texture.
164 // TODO(dshwang): after moving to D3D11, remove this. crbug.com/438691
165 virtual GLenum GetSurfaceInternalFormat() const;
167 protected:
168 // Do not delete directly; use Destroy() or own it with a scoped_ptr, which
169 // will Destroy() it properly by default.
170 virtual ~VideoDecodeAccelerator();
173 } // namespace media
175 namespace base {
177 template <class T>
178 struct DefaultDeleter;
180 // Specialize DefaultDeleter so that scoped_ptr<VideoDecodeAccelerator> always
181 // uses "Destroy()" instead of trying to use the destructor.
182 template <>
183 struct MEDIA_EXPORT DefaultDeleter<media::VideoDecodeAccelerator> {
184 public:
185 void operator()(void* video_decode_accelerator) const;
188 } // namespace base
190 #endif // MEDIA_VIDEO_VIDEO_DECODE_ACCELERATOR_H_