1 // Copyright 2013 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 VaapiWrapper, used by
6 // VaapiVideoDecodeAccelerator and VaapiH264Decoder to interface
7 // with libva (VA-API library for hardware video decode).
9 #ifndef CONTENT_COMMON_GPU_MEDIA_VAAPI_WRAPPER_H_
10 #define CONTENT_COMMON_GPU_MEDIA_VAAPI_WRAPPER_H_
12 #include "base/callback.h"
13 #include "base/memory/ref_counted.h"
14 #include "base/synchronization/lock.h"
15 #include "content/common/content_export.h"
16 #include "content/common/gpu/media/va_surface.h"
17 #include "media/base/video_decoder_config.h"
18 #include "media/base/video_frame.h"
19 #include "third_party/libva/va/va_x11.h"
20 #include "ui/gfx/size.h"
24 // This class handles VA-API calls and ensures proper locking of VA-API calls
25 // to libva, the userspace shim to the HW decoder driver. libva is not
26 // thread-safe, so we have to perform locking ourselves. This class is fully
27 // synchronous and its methods can be called from any thread and may wait on
28 // the va_lock_ while other, concurrent calls run.
30 // This class is responsible for managing VAAPI connection, contexts and state.
31 // It is also responsible for managing and freeing VABuffers (not VASurfaces),
32 // which are used to queue decode parameters and slice data to the HW decoder,
33 // as well as underlying memory for VASurfaces themselves.
34 class CONTENT_EXPORT VaapiWrapper {
36 // |report_error_to_uma_cb| will be called independently from reporting
37 // errors to clients via method return values.
38 static scoped_ptr<VaapiWrapper> Create(
39 media::VideoCodecProfile profile,
41 const base::Closure& report_error_to_uma_cb);
45 // Create |num_surfaces| backing surfaces in driver for VASurfaces, each
46 // of size |size|. Returns true when successful, with the created IDs in
47 // |va_surfaces| to be managed and later wrapped in VASurfaces.
48 // The client must DestroySurfaces() each time before calling this method
49 // again to free the allocated surfaces first, but is not required to do so
50 // at destruction time, as this will be done automatically from
52 bool CreateSurfaces(gfx::Size size,
54 std::vector<VASurfaceID>* va_surfaces);
56 // Free all memory allocated in CreateSurfaces.
57 void DestroySurfaces();
59 // Submit parameters or slice data of |va_buffer_type|, copying them from
60 // |buffer| of size |size|, into HW decoder. The data in |buffer| is no
61 // longer needed and can be freed after this method returns.
62 // Data submitted via this method awaits in the HW decoder until
63 // DecodeAndDestroyPendingBuffers is called to execute or
64 // DestroyPendingBuffers is used to cancel a pending decode.
65 bool SubmitBuffer(VABufferType va_buffer_type, size_t size, void* buffer);
67 // Cancel and destroy all buffers queued to the HW decoder via SubmitBuffer.
68 // Useful when a pending decode is to be cancelled (on reset or error).
69 void DestroyPendingBuffers();
71 // Execute decode in hardware into |va_surface_id} and destroy pending
72 // buffers. Return false if SubmitDecode() fails.
73 bool DecodeAndDestroyPendingBuffers(VASurfaceID va_surface_id);
75 // Put data from |va_surface_id| into |x_pixmap| of size |size|,
76 // converting/scaling to it.
77 bool PutSurfaceIntoPixmap(VASurfaceID va_surface_id,
81 // Returns true if the VAAPI version is less than the specified version.
82 bool VAAPIVersionLessThan(int major, int minor);
84 // Get a VAImage from a VASurface and map it into memory. The VAImage should
85 // be released using the ReturnVaImage function. Returns true when successful.
86 // This is intended for testing only.
87 bool GetVaImageForTesting(VASurfaceID va_surface_id,
91 // Release the VAImage (and the associated memory mapping) obtained from
92 // GetVaImage(). This is intended for testing only.
93 void ReturnVaImageForTesting(VAImage* image);
98 bool Initialize(media::VideoCodecProfile profile,
100 const base::Closure& report_error__to_uma_cb);
103 // Execute decode in hardware and destroy pending buffers. Return false if
104 // vaapi driver refuses to accept parameter or slice buffers submitted
105 // by client or if decode fails in hardware.
106 bool SubmitDecode(VASurfaceID va_surface_id);
108 // Attempt to set render mode to "render to texture.". Failure is non-fatal.
109 void TryToSetVADisplayAttributeToLocalGPU();
111 // Lazily initialize static data after sandbox is enabled. Return false on
113 static bool PostSandboxInitialization();
115 // Libva is not thread safe, so we have to do locking for it ourselves.
116 // This lock is to be taken for the duration of all VA-API calls and for
117 // the entire decode execution sequence in DecodeAndDestroyPendingBuffers().
120 // Allocated ids for VASurfaces.
121 std::vector<VASurfaceID> va_surface_ids_;
123 // The VAAPI version.
124 int major_version_, minor_version_;
127 // Both valid after successful Initialize() and until Deinitialize().
128 VADisplay va_display_;
129 VAConfigID va_config_id_;
130 // Created for the current set of va_surface_ids_ in CreateSurfaces() and
131 // valid until DestroySurfaces().
132 VAContextID va_context_id_;
134 // Data queued up for HW decoder, to be committed on next HW decode.
135 std::vector<VABufferID> pending_slice_bufs_;
136 std::vector<VABufferID> pending_va_bufs_;
138 // Called to report decoding errors to UMA. Errors to clients are reported via
139 // return values from public methods.
140 base::Closure report_error_to_uma_cb_;
142 DISALLOW_COPY_AND_ASSIGN(VaapiWrapper);
145 } // namespace content
147 #endif // CONTENT_COMMON_GPU_MEDIA_VAAPI_WRAPPER_H_