blob: be31b153c690fa90eea4f653a1b17f90f8225f48 [file] [log] [blame]
// 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_CAST_SENDER_SENDER_ENCODED_FRAME_H_
#define MEDIA_CAST_SENDER_SENDER_ENCODED_FRAME_H_
#include "base/time/time.h"
#include "media/cast/net/cast_transport_config.h"
namespace media {
namespace cast {
// Extends EncodedFrame with additional fields used within the sender-side of
// the library.
struct SenderEncodedFrame final : public EncodedFrame {
SenderEncodedFrame();
~SenderEncodedFrame() final;
// The amount the encoder was utilized for this frame. Example: For the
// software VP8 encoder, this would be the elapsed encode time (according to
// the base::TimeTicks clock) divided by the VideoFrame's duration.
//
// Meaningful values are non-negative, with 0.0 [impossibly] representing 0%
// utilization, 1.0 representing 100% utilization, and values greater than 1.0
// indicating the encoder utilized more resources than a maximum sustainable
// rate, based on the data volume of the input. Negative values indicate the
// field was not computed.
double encoder_utilization;
// The amount of "lossiness" needed to encode the frame within the targeted
// bandwidth. More-complex frame content and/or lower target encode bitrates
// will cause this value to rise.
//
// Meaningful values are non-negative, with 0.0 indicating the frame is very
// simple and/or the target encode bitrate is very large, 1.0 indicating the
// frame contains very complex content and/or the target encode bitrate is
// very small, and values greater than 1.0 indicating the encoder cannot
// encode the frame within the target bitrate (even at its lowest quality
// setting). Negative values indicate the field was not computed.
//
// TODO(miu): Rename to idealized_bitrate_utilization.
double lossy_utilization;
// The time at which the encode of the frame completed.
base::TimeTicks encode_completion_time;
};
} // namespace cast
} // namespace media
#endif // MEDIA_CAST_SENDER_SENDER_ENCODED_FRAME_H_