blob: 638ee04294b939c58d6ba0881ddb78a9485c5373 [file] [log] [blame]
// Copyright 2013 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.
//
// This is the main interface for the cast receiver. All configuration are done
// at creation.
#ifndef MEDIA_CAST_CAST_RECEIVER_H_
#define MEDIA_CAST_CAST_RECEIVER_H_
#include <memory>
#include "base/callback.h"
#include "base/memory/ref_counted.h"
#include "base/time/time.h"
#include "media/base/audio_bus.h"
#include "media/cast/cast_config.h"
#include "media/cast/cast_environment.h"
#include "media/cast/net/cast_transport.h"
namespace media {
class VideoFrame;
namespace cast {
// The following callbacks are used to deliver decoded audio/video frame data,
// the frame's corresponding play-out time, and a continuity flag.
// |is_continuous| will be false to indicate the loss of data due to a loss of
// frames (or decoding errors). This allows the client to take steps to smooth
// discontinuities for playback. Note: A NULL pointer can be returned when data
// is not available (e.g., bad/missing packet).
typedef base::Callback<void(std::unique_ptr<AudioBus> audio_bus,
const base::TimeTicks& playout_time,
bool is_continuous)>
AudioFrameDecodedCallback;
// TODO(miu): |video_frame| includes a timestamp, so use that instead.
typedef base::Callback<void(const scoped_refptr<media::VideoFrame>& video_frame,
const base::TimeTicks& playout_time,
bool is_continuous)> VideoFrameDecodedCallback;
// The following callback delivers encoded frame data and metadata. The client
// should examine the |frame_id| field to determine whether any frames have been
// dropped (i.e., frame_id should be incrementing by one each time). Note: A
// NULL pointer can be returned on error.
typedef base::Callback<void(std::unique_ptr<EncodedFrame>)>
ReceiveEncodedFrameCallback;
class CastReceiver {
public:
static std::unique_ptr<CastReceiver> Create(
scoped_refptr<CastEnvironment> cast_environment,
const FrameReceiverConfig& audio_config,
const FrameReceiverConfig& video_config,
CastTransport* const transport);
// All received RTP and RTCP packets for the call should be sent to this
// PacketReceiver. Can be called from any thread.
virtual void ReceivePacket(std::unique_ptr<Packet> packet) = 0;
// Polling interface to get audio and video frames from the CastReceiver. The
// the RequestDecodedXXXXXFrame() methods utilize internal software-based
// decoding, while the RequestEncodedXXXXXFrame() methods provides
// still-encoded frames for use with external/hardware decoders.
//
// In all cases, the given |callback| is guaranteed to be run at some point in
// the future, except for those requests still enqueued at destruction time.
//
// These methods should all be called on the CastEnvironment's MAIN thread.
virtual void RequestDecodedAudioFrame(
const AudioFrameDecodedCallback& callback) = 0;
virtual void RequestEncodedAudioFrame(
const ReceiveEncodedFrameCallback& callback) = 0;
virtual void RequestDecodedVideoFrame(
const VideoFrameDecodedCallback& callback) = 0;
virtual void RequestEncodedVideoFrame(
const ReceiveEncodedFrameCallback& callback) = 0;
virtual ~CastReceiver() {}
};
} // namespace cast
} // namespace media
#endif // MEDIA_CAST_CAST_RECEIVER_H_