// Copyright 2015 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #ifndef MEDIA_GPU_VP9_DECODER_H_ #define MEDIA_GPU_VP9_DECODER_H_ #include #include #include #include #include "base/callback_forward.h" #include "base/memory/ref_counted.h" #include "media/base/video_types.h" #include "media/filters/vp9_parser.h" #include "media/gpu/accelerated_video_decoder.h" #include "media/gpu/vp9_picture.h" #include "media/gpu/vp9_reference_frame_vector.h" #include "ui/gfx/geometry/size.h" namespace media { // This class implements an AcceleratedVideoDecoder for VP9 decoding. // Clients of this class are expected to pass raw VP9 stream and are expected // to provide an implementation of VP9Accelerator for offloading final steps // of the decoding process. // // This class must be created, called and destroyed on a single thread, and // does nothing internally on any other thread. class MEDIA_GPU_EXPORT VP9Decoder : public AcceleratedVideoDecoder { public: class MEDIA_GPU_EXPORT VP9Accelerator { public: // Methods may return kTryAgain if they need additional data (provided // independently) in order to proceed. Examples are things like not having // an appropriate key to decode encrypted content. This is not considered an // unrecoverable error, but rather a pause to allow an application to // independently provide the required data. When VP9Decoder::Decode() // is called again, it will attempt to resume processing of the stream // by calling the same method again. enum class Status { // Operation completed successfully. kOk, // Operation failed. kFail, // Operation failed because some external data is missing. Retry the same // operation later, once the data has been provided. kTryAgain, }; VP9Accelerator(); VP9Accelerator(const VP9Accelerator&) = delete; VP9Accelerator& operator=(const VP9Accelerator&) = delete; virtual ~VP9Accelerator(); // Create a new VP9Picture that the decoder client can use for initial // stages of the decoding process and pass back to this accelerator for // final, accelerated stages of it, or for reference when decoding other // pictures. // // When a picture is no longer needed by the decoder, it will just drop // its reference to it, and it may do so at any time. // // Note that this may return nullptr if the accelerator is not able to // provide any new pictures at the given time. The decoder must handle this // case and treat it as normal, returning kRanOutOfSurfaces from Decode(). virtual scoped_refptr CreateVP9Picture() = 0; // Submit decode for |pic| to be run in accelerator, taking as arguments // information contained in it, as well as current segmentation and loop // filter state in |segm_params| and |lf_params|, respectively, and using // pictures in |ref_pictures| for reference. // If done_cb_ is not null, it will be run once decode is done in hardware. // // Note that returning from this method does not mean that the decode // process is finished, but the caller may drop its references to |pic| // and |ref_pictures| immediately, and the data in |segm_params| and // |lf_params| does not need to remain valid after this method returns. // // Return true when successful, false otherwise. virtual Status SubmitDecode(scoped_refptr pic, const Vp9SegmentationParams& segm_params, const Vp9LoopFilterParams& lf_params, const Vp9ReferenceFrameVector& reference_frames, const base::OnceClosure done_cb) = 0; // Schedule output (display) of |pic|. // // Note that returning from this method does not mean that |pic| has already // been outputted (displayed), but guarantees that all pictures will be // outputted in the same order as this method was called for them, and that // they are decoded before outputting (assuming SubmitDecode() has been // called for them beforehand). Decoder may drop its references to |pic| // immediately after calling this method. // // Return true when successful, false otherwise. virtual bool OutputPicture(scoped_refptr pic) = 0; // Return true if the accelerator requires us to provide the compressed // header fully parsed. virtual bool NeedsCompressedHeaderParsed() const = 0; // Set |frame_ctx| to the state after decoding |pic|, returning true on // success, false otherwise. virtual bool GetFrameContext(scoped_refptr pic, Vp9FrameContext* frame_ctx) = 0; // VP9Parser can update the context probabilities or can query the driver // to get the updated numbers. By default drivers don't support it, and in // particular it's true for legacy (unstable) V4L2 API versions. virtual bool SupportsContextProbabilityReadback() const; }; explicit VP9Decoder( std::unique_ptr accelerator, VideoCodecProfile profile, const VideoColorSpace& container_color_space = VideoColorSpace()); VP9Decoder(const VP9Decoder&) = delete; VP9Decoder& operator=(const VP9Decoder&) = delete; ~VP9Decoder() override; // AcceleratedVideoDecoder implementation. void SetStream(int32_t id, const DecoderBuffer& decoder_buffer) override; [[nodiscard]] bool Flush() override; void Reset() override; [[nodiscard]] DecodeResult Decode() override; gfx::Size GetPicSize() const override; gfx::Rect GetVisibleRect() const override; VideoCodecProfile GetProfile() const override; uint8_t GetBitDepth() const override; VideoChromaSampling GetChromaSampling() const override; size_t GetRequiredNumOfPictures() const override; size_t GetNumReferenceFrames() const override; private: // Decode and possibly output |pic| (if the picture is to be shown). // Return kOk on success, kTryAgain if this should be attempted again on the // next Decode call, and kFail otherwise. VP9Accelerator::Status DecodeAndOutputPicture(scoped_refptr pic); // Get frame context state after decoding |pic| from the accelerator, and call // |context_refresh_cb| with the acquired state. void UpdateFrameContext(scoped_refptr pic, Vp9Parser::ContextRefreshCallback context_refresh_cb); // Called on error, when decoding cannot continue. Sets state_ to kError and // releases current state. void SetError(); enum State { kNeedStreamMetadata, // After initialization, need a keyframe. kDecoding, // Ready to decode from any point. kAfterReset, // After Reset(), need a resume point. kError, // Error in decode, can't continue. }; // Current decoder state. State state_; // Current stream buffer id; to be assigned to pictures decoded from it. int32_t stream_id_ = -1; // Current frame header and decrypt config to be used in decoding the next // picture. std::unique_ptr curr_frame_hdr_; std::unique_ptr decrypt_config_; // Current frame size that is necessary to decode |curr_frame_hdr_|. gfx::Size curr_frame_size_; // Color space provided by the container. const VideoColorSpace container_color_space_; // Reference frames currently in use. Vp9ReferenceFrameVector ref_frames_; // Current coded resolution. gfx::Size pic_size_; // Visible rectangle on the most recent allocation. gfx::Rect visible_rect_; // Profile of input bitstream. VideoCodecProfile profile_; // Bit depth of input bitstream. uint8_t bit_depth_ = 0; // Chroma subsampling format of input bitstream. VideoChromaSampling chroma_sampling_ = VideoChromaSampling::kUnknown; // Pending picture for decode when accelerator returns kTryAgain. scoped_refptr pending_pic_; size_t size_change_failure_counter_ = 0; const std::unique_ptr accelerator_; Vp9Parser parser_; }; } // namespace media #endif // MEDIA_GPU_VP9_DECODER_H_