blob: 6653a0359b0761dfd25223bf68c0b0cb6b52a20c [file] [log] [blame]
// Copyright 2017 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.
#include <stdint.h>
#include "media/base/bitstream_buffer.h"
#include "media/base/media_export.h"
#include "media/base/video_frame.h"
namespace media {
// JPEG encoder interface.
class MEDIA_EXPORT JpegEncodeAccelerator {
static constexpr int32_t kInvalidBitstreamBufferId = -1;
enum Status {
// Eg. creation of encoder thread failed.
// Invalid argument was passed to an API method, e.g. the format of
// VideoFrame is not supported.
// Output buffer is inaccessible, e.g. failed to map on another process.
// Failed to parse the incoming YUV image.
// A fatal failure occurred in the GPU process layer or one of its
// dependencies. Examples of such failures include hardware failures,
// driver failures, library failures, and so on. Client is responsible for
// destroying JEA after receiving this.
// Largest used enum. This should be adjusted when new errors are added.
class MEDIA_EXPORT Client {
// Callback called after each successful Encode().
// Parameters:
// |buffer_id| is || of the corresponding Encode() call.
// |encoded_picture_size| is the actual size of encoded JPEG image in
// the BitstreamBuffer provided through encode().
virtual void VideoFrameReady(int32_t buffer_id,
size_t encoded_picture_size) = 0;
// Callback to notify errors. Client is responsible for destroying JEA when
// receiving a fatal error, i.e. PLATFORM_FAILURE. For other errors, client
// is informed about the buffer that failed to encode and may continue
// using the same instance of JEA.
// Parameters:
// |buffer_id| is || of the corresponding Encode() call
// that resulted in the error.
// |status| would be one of the values of Status except ENCODE_OK.
virtual void NotifyError(int32_t buffer_id, Status status) = 0;
virtual ~Client() {}
// Destroys the encoder: all pending inputs are dropped immediately. This
// call may asynchronously free system resources, but its client-visible
// effects are synchronous. After destructor returns, no more callbacks
// will be made on the client.
virtual ~JpegEncodeAccelerator() = 0;
// Initializes the JPEG encoder. Should be called once per encoder
// construction. This call is synchronous and returns ENCODE_OK iff
// initialization is successful.
// Parameters:
// |client| is the Client interface for encode callback. The provided
// pointer must be valid until destructor is called.
virtual Status Initialize(Client* client) = 0;
// Gets the maximum possible encoded result size.
virtual size_t GetMaxCodedBufferSize(const gfx::Size& picture_size) = 0;
// Encodes the given |video_frame| that contains a YUV image. Client will
// receive the encoded result in Client::VideoFrameReady() callback with the
// corresponding ||, or receive
// Client::NotifyError() callback.
// Parameters:
// |video_frame| contains the YUV image to be encoded.
// |quality| of JPEG image. The range is from 1~100. High value means high
// quality.
// |exif_buffer| contains Exif data to be inserted into JPEG image. If it's
// nullptr, the JFIF APP0 segment will be inserted.
// |output_buffer| that contains output buffer for encoded result. Clients
// should call GetMaxCodedBufferSize() and allocate the buffer accordingly.
// The buffer needs to be valid until VideoFrameReady() or NotifyError() is
// called.
virtual void Encode(scoped_refptr<media::VideoFrame> video_frame,
int quality,
const BitstreamBuffer* exif_buffer,
const BitstreamBuffer& output_buffer) = 0;
} // namespace media