1 // Copyright (c) 2014 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 // This file contains an implementation of VideoDecoderAccelerator
6 // that utilizes hardware video decoder present on Intel CPUs.
8 #ifndef OZONE_MEDIA_VAAPI_VIDEO_DECODE_ACCELERATOR_H_
9 #define OZONE_MEDIA_VAAPI_VIDEO_DECODE_ACCELERATOR_H_
17 #include "base/logging.h"
18 #include "base/memory/linked_ptr.h"
19 #include "base/memory/shared_memory.h"
20 #include "base/memory/weak_ptr.h"
21 #include "base/message_loop/message_loop.h"
22 #include "base/synchronization/condition_variable.h"
23 #include "base/synchronization/lock.h"
24 #include "base/threading/non_thread_safe.h"
25 #include "base/threading/thread.h"
26 #include "content/common/content_export.h"
27 #include "media/base/bitstream_buffer.h"
28 #include "media/video/picture.h"
29 #include "media/video/video_decode_accelerator.h"
30 #include "ui/gl/gl_bindings.h"
31 #include "vaapi_h264_decoder.h"
32 #include "vaapi_wrapper.h"
36 // Class to provide video decode acceleration for Intel systems with hardware
37 // support for it, and on which libva is available.
38 // Decoding tasks are performed in a separate decoding thread.
40 // Threading/life-cycle: this object is created & destroyed on the GPU
41 // ChildThread. A few methods on it are called on the decoder thread which is
42 // stopped during |this->Destroy()|, so any tasks posted to the decoder thread
43 // can assume |*this| is still alive. See |weak_this_| below for more details.
44 class VaapiVideoDecodeAccelerator
45 : public media::VideoDecodeAccelerator {
47 VaapiVideoDecodeAccelerator(
48 const base::Callback<bool(void)>& make_context_current); //NOLINT
49 virtual ~VaapiVideoDecodeAccelerator();
51 // media::VideoDecodeAccelerator implementation.
52 virtual bool Initialize(media::VideoCodecProfile profile,
53 Client* client) OVERRIDE;
54 virtual void Decode(const media::BitstreamBuffer& bitstream_buffer) OVERRIDE;
55 virtual void AssignPictureBuffers(
56 const std::vector<media::PictureBuffer>& buffers) OVERRIDE;
57 virtual void ReusePictureBuffer(int32 picture_buffer_id) OVERRIDE;
58 virtual void Flush() OVERRIDE;
59 virtual void Reset() OVERRIDE;
60 virtual void Destroy() OVERRIDE;
61 virtual bool CanDecodeOnIOThread() OVERRIDE;
64 // Notify the client that an error has occurred and decoding cannot continue.
65 void NotifyError(Error error);
67 // Map the received input buffer into this process' address space and
68 // queue it for decode.
69 void MapAndQueueNewInputBuffer(
70 const media::BitstreamBuffer& bitstream_buffer);
72 // Get a new input buffer from the queue and set it up in decoder. This will
73 // sleep if no input buffers are available. Return true if a new buffer has
74 // been set up, false if an early exit has been requested (due to initiated
75 // reset/flush/destroy).
76 bool GetInputBuffer_Locked();
78 // Signal the client that the current buffer has been read and can be
79 // returned. Will also release the mapping.
80 void ReturnCurrInputBuffer_Locked();
82 // Pass one or more output buffers to the decoder. This will sleep
83 // if no buffers are available. Return true if buffers have been set up or
84 // false if an early exit has been requested (due to initiated
85 // reset/flush/destroy).
86 bool FeedDecoderWithOutputSurfaces_Locked();
88 // Continue decoding given input buffers and sleep waiting for input/output
89 // as needed. Will exit if a new set of surfaces or reset/flush/destroy
93 // Scheduled after receiving a flush request and executed after the current
94 // decoding task finishes decoding pending inputs. Makes the decoder return
95 // all remaining output pictures and puts it in an idle state, ready
96 // to resume if needed and schedules a FinishFlush.
99 // Scheduled by the FlushTask after decoder is flushed to put VAVDA into idle
100 // state and notify the client that flushing has been finished.
103 // Scheduled after receiving a reset request and executed after the current
104 // decoding task finishes decoding the current frame. Puts the decoder into
105 // an idle state, ready to resume if needed, discarding decoded but not yet
106 // outputted pictures (decoder keeps ownership of their associated picture
107 // buffers). Schedules a FinishReset afterwards.
110 // Scheduled by ResetTask after it's done putting VAVDA into an idle state.
111 // Drops remaining input buffers and notifies the client that reset has been
115 // Helper for Destroy(), doing all the actual work except for deleting self.
118 // Get a usable framebuffer configuration for use in binding textures
119 // or return false on failure.
120 bool InitializeFBConfig();
122 // Callback for the decoder to execute when it wants us to output given
124 void SurfaceReady(int32 input_id, const scoped_refptr<VASurface>& va_surface);
126 // Represents a texture bound to an X Pixmap for output purposes.
129 // Callback to be executed once we have a |va_surface| to be output and
130 // an available |tfp_picture| to use for output.
131 // Puts contents of |va_surface| into given |tfp_picture|, releases the
132 // surface and passes the resulting picture to client for output.
133 void OutputPicture(const scoped_refptr<VASurface>& va_surface,
135 TFPPicture* tfp_picture);
137 // Try to OutputPicture() if we have both a ready surface and picture.
138 void TryOutputSurface();
140 // Called when a VASurface is no longer in use by the decoder or is not being
141 // synced/waiting to be synced to a picture. Returns it to available surfaces
143 void RecycleVASurfaceID(VASurfaceID va_surface_id);
145 // Initiate wait cycle for surfaces to be released before we release them
146 // and allocate new ones, as requested by the decoder.
147 void InitiateSurfaceSetChange(size_t num_pics, gfx::Size size);
148 // Check if the surfaces have been released or post ourselves for later.
149 void TryFinishSurfaceSetChange();
151 base::Callback<bool(void)> make_context_current_; //NOLINT
155 // Initialize() not called yet or failed.
157 // DecodeTask running.
159 // Resetting, waiting for decoder to finish current task and cleanup.
161 // Flushing, waiting for decoder to finish current task and cleanup.
163 // Idle, decoder in state ready to start/resume decoding.
165 // Destroying, waiting for the decoder to finish current task.
169 // Protects input buffer and surface queues and state_.
173 // An input buffer awaiting consumption, provided by the client.
180 scoped_ptr<base::SharedMemory> shm;
183 // Queue for incoming input buffers.
184 typedef std::queue<linked_ptr<InputBuffer> > InputBuffers;
185 InputBuffers input_buffers_;
186 // Signalled when input buffers are queued onto the input_buffers_ queue.
187 base::ConditionVariable input_ready_;
189 // Current input buffer at decoder.
190 linked_ptr<InputBuffer> curr_input_buffer_;
192 // Queue for incoming output buffers (texture ids).
193 typedef std::queue<int32> OutputBuffers;
194 OutputBuffers output_buffers_;
196 typedef std::map<int32, linked_ptr<TFPPicture> > TFPPictures;
197 // All allocated TFPPictures, regardless of their current state. TFPPictures
198 // are allocated once and destroyed at the end of decode.
199 TFPPictures tfp_pictures_;
201 // Return a TFPPicture associated with given client-provided id.
202 TFPPicture* TFPPictureById(int32 picture_buffer_id);
204 // VA Surfaces no longer in use that can be passed back to the decoder for
205 // reuse, once it requests them.
206 std::list<VASurfaceID> available_va_surfaces_;
207 // Signalled when output surfaces are queued onto the available_va_surfaces_
209 base::ConditionVariable surfaces_available_;
211 // Pending output requests from the decoder. When it indicates that we should
212 // output a surface and we have an available TFPPicture (i.e. texture) ready
213 // to use, we'll execute the callback passing the TFPPicture. The callback
214 // will put the contents of the surface into the picture and return it to
215 // the client, releasing the surface as well.
216 // If we don't have any available TFPPictures at the time when the decoder
217 // requests output, we'll store the request on pending_output_cbs_ queue for
218 // later and run it once the client gives us more textures
219 // via ReusePictureBuffer().
220 typedef base::Callback<void(TFPPicture*)> OutputCB;
221 std::queue<OutputCB> pending_output_cbs_;
223 // ChildThread's message loop
224 base::MessageLoop* message_loop_;
226 // WeakPtr<> pointing to |this| for use in posting tasks from the decoder
227 // thread back to the ChildThread. Because the decoder thread is a member of
228 // this class, any task running on the decoder thread is guaranteed that this
229 // object is still alive. As a result, tasks posted from ChildThread to
230 // decoder thread should use base::Unretained(this), and tasks posted from the
231 // decoder thread to the ChildThread should use |weak_this_|.
232 base::WeakPtr<VaapiVideoDecodeAccelerator> weak_this_;
234 // Callback used when creating VASurface objects.
235 VASurface::ReleaseCB va_surface_release_cb_;
237 // To expose client callbacks from VideoDecodeAccelerator.
238 // NOTE: all calls to these objects *MUST* be executed on message_loop_.
239 scoped_ptr<base::WeakPtrFactory<Client> > client_ptr_factory_;
240 base::WeakPtr<Client> client_;
242 scoped_ptr<VaapiWrapper> vaapi_wrapper_;
244 // Comes after vaapi_wrapper_ to ensure its destructor is executed before
245 // vaapi_wrapper_ is destroyed.
246 scoped_ptr<VaapiH264Decoder> decoder_;
247 base::Thread decoder_thread_;
248 // Use this to post tasks to |decoder_thread_| instead of
249 // |decoder_thread_.message_loop()| because the latter will be NULL once
250 // |decoder_thread_.Stop()| returns.
251 scoped_refptr<base::MessageLoopProxy> decoder_thread_proxy_;
253 int num_frames_at_client_;
254 int num_stream_bufs_at_decoder_;
256 // Whether we are waiting for any pending_output_cbs_ to be run before
257 // NotifyingFlushDone.
258 bool finish_flush_pending_;
260 // Decoder requested a new surface set and we are waiting for all the surfaces
261 // to be returned before we can free them.
262 bool awaiting_va_surfaces_recycle_;
264 // Last requested number/resolution of output picture buffers.
265 size_t requested_num_pics_;
266 gfx::Size requested_pic_size_;
268 // The WeakPtrFactory for |weak_this_|.
269 base::WeakPtrFactory<VaapiVideoDecodeAccelerator> weak_this_factory_;
271 DISALLOW_COPY_AND_ASSIGN(VaapiVideoDecodeAccelerator);
276 #endif // OZONE_MEDIA_VAAPI_VIDEO_DECODE_ACCELERATOR_H_