Refactor webrtc specific Event implementation to an EventFactory.

Review URL: https://webrtc-codereview.appspot.com/1187005

git-svn-id: http://webrtc.googlecode.com/svn/trunk@3664 4adac7df-926f-26a2-2b94-8c16560cd09d
This commit is contained in:
stefan@webrtc.org
2013-03-13 08:46:25 +00:00
parent b7edd06530
commit 2baf5f5fa0
26 changed files with 248 additions and 289 deletions

View File

@ -1,63 +0,0 @@
/*
* Copyright (c) 2011 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef WEBRTC_MODULES_VIDEO_CODING_EVENT_H_
#define WEBRTC_MODULES_VIDEO_CODING_EVENT_H_
#include "event_wrapper.h"
namespace webrtc
{
//#define EVENT_DEBUG
class VCMEvent : public EventWrapper
{
public:
VCMEvent() : _event(*EventWrapper::Create()) {};
virtual ~VCMEvent() { delete &_event; };
/**
* Release waiting threads
*/
bool Set() { return _event.Set(); };
bool Reset() { return _event.Reset(); };
/**
* Wait for this event
*/
EventTypeWrapper Wait(unsigned long maxTime)
{
#ifdef EVENT_DEBUG
return kEventTimeout;
#else
return _event.Wait(maxTime);
#endif
};
/**
* Start a timer
*/
bool StartTimer(bool periodic, unsigned long time)
{ return _event.StartTimer(periodic, time); };
/**
* Stop the timer
*/
bool StopTimer() { return _event.StopTimer(); };
private:
EventWrapper& _event;
};
} // namespace webrtc
#endif // WEBRTC_MODULES_VIDEO_CODING_EVENT_H_

View File

@ -7,12 +7,12 @@
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#include "modules/video_coding/main/source/jitter_buffer.h"
#include "webrtc/modules/video_coding/main/source/jitter_buffer.h"
#include <algorithm>
#include <cassert>
#include "webrtc/modules/video_coding/main/source/event.h"
#include "webrtc/modules/video_coding/main/interface/video_coding.h"
#include "webrtc/modules/video_coding/main/source/frame_buffer.h"
#include "webrtc/modules/video_coding/main/source/inter_frame_delay.h"
#include "webrtc/modules/video_coding/main/source/internal_defines.h"
@ -21,6 +21,7 @@
#include "webrtc/modules/video_coding/main/source/packet.h"
#include "webrtc/system_wrappers/interface/clock.h"
#include "webrtc/system_wrappers/interface/critical_section_wrapper.h"
#include "webrtc/system_wrappers/interface/event_wrapper.h"
#include "webrtc/system_wrappers/interface/logging.h"
#include "webrtc/system_wrappers/interface/trace.h"
@ -67,6 +68,7 @@ bool HasNonEmptyState(VCMFrameBuffer* frame) {
}
VCMJitterBuffer::VCMJitterBuffer(Clock* clock,
EventFactory* event_factory,
int vcm_id,
int receiver_id,
bool master)
@ -76,8 +78,8 @@ VCMJitterBuffer::VCMJitterBuffer(Clock* clock,
running_(false),
crit_sect_(CriticalSectionWrapper::CreateCriticalSection()),
master_(master),
frame_event_(),
packet_event_(),
frame_event_(event_factory->CreateEvent()),
packet_event_(event_factory->CreateEvent()),
max_number_of_frames_(kStartNumberOfFrames),
frame_buffers_(),
frame_list_(),
@ -192,8 +194,8 @@ void VCMJitterBuffer::Start() {
num_discarded_packets_ = 0;
// Start in a non-signaled state.
frame_event_.Reset();
packet_event_.Reset();
frame_event_->Reset();
packet_event_->Reset();
waiting_for_completion_.frame_size = 0;
waiting_for_completion_.timestamp = 0;
waiting_for_completion_.latest_packet_time = -1;
@ -220,8 +222,8 @@ void VCMJitterBuffer::Stop() {
crit_sect_->Leave();
// Make sure we wake up any threads waiting on these events.
frame_event_.Set();
packet_event_.Set();
frame_event_->Set();
packet_event_->Set();
WEBRTC_TRACE(webrtc::kTraceDebug, webrtc::kTraceVideoCoding,
VCMId(vcm_id_, receiver_id_), "JB(0x%x): Jitter buffer: stop",
this);
@ -241,8 +243,8 @@ void VCMJitterBuffer::Flush() {
}
last_decoded_state_.Reset(); // TODO(mikhal): sync reset.
num_not_decodable_packets_ = 0;
frame_event_.Reset();
packet_event_.Reset();
frame_event_->Reset();
packet_event_->Reset();
num_consecutive_old_frames_ = 0;
num_consecutive_old_packets_ = 0;
// Also reset the jitter and delay estimates
@ -354,10 +356,10 @@ int64_t VCMJitterBuffer::NextTimestamp(uint32_t max_wait_time_ms,
FrameList::iterator it = frame_list_.begin();
if (it == frame_list_.end()) {
packet_event_.Reset();
packet_event_->Reset();
crit_sect_->Leave();
if (packet_event_.Wait(max_wait_time_ms) == kEventSignaled) {
if (packet_event_->Wait(max_wait_time_ms) == kEventSignaled) {
// are we closing down the Jitter buffer
if (!running_) {
return -1;
@ -449,7 +451,7 @@ VCMEncodedFrame* VCMJitterBuffer::GetCompleteFrameForDecoding(
while (wait_time_ms > 0) {
crit_sect_->Leave();
const EventTypeWrapper ret =
frame_event_.Wait(static_cast<uint32_t>(wait_time_ms));
frame_event_->Wait(static_cast<uint32_t>(wait_time_ms));
crit_sect_->Enter();
if (ret == kEventSignaled) {
// are we closing down the Jitter buffer
@ -475,7 +477,7 @@ VCMEncodedFrame* VCMJitterBuffer::GetCompleteFrameForDecoding(
// Inside |crit_sect_|.
} else {
// We already have a frame reset the event.
frame_event_.Reset();
frame_event_->Reset();
}
if (it == frame_list_.end()) {
@ -763,13 +765,13 @@ VCMFrameBufferEnum VCMJitterBuffer::InsertPacket(VCMEncodedFrame* encoded_frame,
if (UpdateFrameState(frame) == kFlushIndicator)
ret = kFlushIndicator;
// Signal that we have a received packet.
packet_event_.Set();
packet_event_->Set();
break;
}
case kDecodableSession:
case kIncomplete: {
// Signal that we have a received packet.
packet_event_.Set();
packet_event_->Set();
break;
}
case kNoError:
@ -1178,7 +1180,7 @@ VCMFrameBufferEnum VCMJitterBuffer::UpdateFrameState(VCMFrameBuffer* frame) {
// Only signal if this is the oldest frame.
// Not necessarily the case due to packet reordering or NACK.
if (!WaitForRetransmissions() || (old_frame != NULL && old_frame == frame)) {
frame_event_.Set();
frame_event_->Set();
}
return kNoError;
}

View File

@ -18,7 +18,6 @@
#include "webrtc/modules/interface/module_common_types.h"
#include "webrtc/modules/video_coding/main/interface/video_coding_defines.h"
#include "webrtc/modules/video_coding/main/source/decoding_state.h"
#include "webrtc/modules/video_coding/main/source/event.h"
#include "webrtc/modules/video_coding/main/source/inter_frame_delay.h"
#include "webrtc/modules/video_coding/main/source/jitter_buffer_common.h"
#include "webrtc/modules/video_coding/main/source/jitter_estimator.h"
@ -40,6 +39,8 @@ typedef std::list<VCMFrameBuffer*> FrameList;
// forward declarations
class Clock;
class EventFactory;
class EventWrapper;
class VCMFrameBuffer;
class VCMPacket;
class VCMEncodedFrame;
@ -54,6 +55,7 @@ struct VCMJitterSample {
class VCMJitterBuffer {
public:
VCMJitterBuffer(Clock* clock,
EventFactory* event_factory,
int vcm_id,
int receiver_id,
bool master);
@ -248,9 +250,9 @@ class VCMJitterBuffer {
CriticalSectionWrapper* crit_sect_;
bool master_;
// Event to signal when we have a frame ready for decoder.
VCMEvent frame_event_;
scoped_ptr<EventWrapper> frame_event_;
// Event to signal when we have received a packet.
VCMEvent packet_event_;
scoped_ptr<EventWrapper> packet_event_;
// Number of allocated frames.
int max_number_of_frames_;
// Array of pointers to the frames in jitter buffer.

View File

@ -12,10 +12,11 @@
#include <list>
#include "gtest/gtest.h"
#include "modules/video_coding/main/source/jitter_buffer.h"
#include "modules/video_coding/main/source/media_opt_util.h"
#include "modules/video_coding/main/source/packet.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "webrtc/modules/video_coding/main/source/jitter_buffer.h"
#include "webrtc/modules/video_coding/main/source/media_opt_util.h"
#include "webrtc/modules/video_coding/main/source/packet.h"
#include "webrtc/modules/video_coding/main/test/test_util.h"
#include "webrtc/system_wrappers/interface/clock.h"
namespace webrtc {
@ -163,7 +164,8 @@ class TestRunningJitterBuffer : public ::testing::Test {
clock_.reset(new SimulatedClock(0));
max_nack_list_size_ = 150;
oldest_packet_to_nack_ = 250;
jitter_buffer_ = new VCMJitterBuffer(clock_.get(), -1, -1, true);
jitter_buffer_ = new VCMJitterBuffer(clock_.get(), &event_factory_, -1, -1,
true);
stream_generator = new StreamGenerator(0, 0, clock_->TimeInMilliseconds());
jitter_buffer_->Start();
jitter_buffer_->SetNackSettings(max_nack_list_size_,
@ -249,6 +251,7 @@ class TestRunningJitterBuffer : public ::testing::Test {
VCMJitterBuffer* jitter_buffer_;
StreamGenerator* stream_generator;
scoped_ptr<SimulatedClock> clock_;
NullEventFactory event_factory_;
size_t max_nack_list_size_;
int oldest_packet_to_nack_;
uint8_t data_buffer_[kDataBufferSize];

View File

@ -25,6 +25,7 @@ enum { kMaxReceiverDelayMs = 10000 };
VCMReceiver::VCMReceiver(VCMTiming* timing,
Clock* clock,
EventFactory* event_factory,
int32_t vcm_id,
int32_t receiver_id,
bool master)
@ -33,14 +34,14 @@ VCMReceiver::VCMReceiver(VCMTiming* timing,
clock_(clock),
receiver_id_(receiver_id),
master_(master),
jitter_buffer_(clock_, vcm_id, receiver_id, master),
jitter_buffer_(clock_, event_factory, vcm_id, receiver_id, master),
timing_(timing),
render_wait_event_(),
render_wait_event_(event_factory->CreateEvent()),
state_(kPassive),
max_video_delay_ms_(kMaxVideoDelayMs) {}
VCMReceiver::~VCMReceiver() {
render_wait_event_.Set();
render_wait_event_->Set();
delete crit_sect_;
}
@ -51,7 +52,7 @@ void VCMReceiver::Reset() {
} else {
jitter_buffer_.Flush();
}
render_wait_event_.Reset();
render_wait_event_->Reset();
if (master_) {
state_ = kReceiving;
} else {
@ -298,7 +299,7 @@ VCMEncodedFrame* VCMReceiver::FrameForRendering(uint16_t max_wait_time_ms,
return NULL;
}
// Wait until it's time to render.
render_wait_event_.Wait(wait_time_ms);
render_wait_event_->Wait(wait_time_ms);
// Get a complete frame if possible.
VCMEncodedFrame* frame = jitter_buffer_.GetCompleteFrameForDecoding(0);

View File

@ -37,9 +37,10 @@ class VCMReceiver {
public:
VCMReceiver(VCMTiming* timing,
Clock* clock,
int32_t vcm_id = -1,
int32_t receiver_id = -1,
bool master = true);
EventFactory* event_factory,
int32_t vcm_id,
int32_t receiver_id,
bool master);
~VCMReceiver();
void Reset();
@ -94,7 +95,7 @@ class VCMReceiver {
bool master_;
VCMJitterBuffer jitter_buffer_;
VCMTiming* timing_;
VCMEvent render_wait_event_;
scoped_ptr<EventWrapper> render_wait_event_;
VCMReceiverState state_;
int max_video_delay_ms_;

View File

@ -42,7 +42,6 @@
'decoding_state.h',
'encoded_frame.h',
'er_tables_xor.h',
'event.h',
'fec_tables_xor.h',
'frame_buffer.h',
'generic_decoder.h',

View File

@ -44,7 +44,9 @@ VCMProcessTimer::Processed()
}
VideoCodingModuleImpl::VideoCodingModuleImpl(const WebRtc_Word32 id,
Clock* clock)
Clock* clock,
EventFactory* event_factory,
bool owns_event_factory)
:
_id(id),
clock_(clock),
@ -52,8 +54,8 @@ _receiveCritSect(CriticalSectionWrapper::CreateCriticalSection()),
_receiverInited(false),
_timing(clock_, id, 1),
_dualTiming(clock_, id, 2, &_timing),
_receiver(&_timing, clock_, id, 1),
_dualReceiver(&_dualTiming, clock_, id, 2, false),
_receiver(&_timing, clock_, event_factory, id, 1, true),
_dualReceiver(&_dualTiming, clock_, event_factory, id, 2, false),
_decodedFrameCallback(_timing, clock_),
_dualDecodedFrameCallback(_dualTiming, clock_),
_frameTypeCallback(NULL),
@ -82,7 +84,9 @@ _codecDataBase(id),
_receiveStatsTimer(1000, clock_),
_sendStatsTimer(1000, clock_),
_retransmissionTimer(10, clock_),
_keyRequestTimer(500, clock_)
_keyRequestTimer(500, clock_),
event_factory_(event_factory),
owns_event_factory_(owns_event_factory)
{
assert(clock_);
#ifdef DEBUG_DECODER_BIT_STREAM
@ -98,6 +102,9 @@ VideoCodingModuleImpl::~VideoCodingModuleImpl()
}
delete _receiveCritSect;
delete _sendCritSect;
if (owns_event_factory_) {
delete event_factory_;
}
#ifdef DEBUG_DECODER_BIT_STREAM
fclose(_bitStreamBeforeDecoder);
#endif
@ -110,14 +117,17 @@ VideoCodingModuleImpl::~VideoCodingModuleImpl()
VideoCodingModule*
VideoCodingModule::Create(const WebRtc_Word32 id)
{
return new VideoCodingModuleImpl(id, Clock::GetRealTimeClock());
return new VideoCodingModuleImpl(id, Clock::GetRealTimeClock(),
new EventFactoryImpl, true);
}
VideoCodingModule*
VideoCodingModule::Create(const WebRtc_Word32 id, Clock* clock)
VideoCodingModule::Create(const WebRtc_Word32 id, Clock* clock,
EventFactory* event_factory)
{
assert(clock);
return new VideoCodingModuleImpl(id, clock);
assert(event_factory);
return new VideoCodingModuleImpl(id, clock, event_factory, false);
}
void

View File

@ -58,7 +58,8 @@ enum VCMKeyRequestMode
class VideoCodingModuleImpl : public VideoCodingModule
{
public:
VideoCodingModuleImpl(const WebRtc_Word32 id, Clock* clock);
VideoCodingModuleImpl(const WebRtc_Word32 id, Clock* clock,
EventFactory* event_factory, bool owns_event_factory);
virtual ~VideoCodingModuleImpl();
@ -316,6 +317,8 @@ private:
VCMProcessTimer _sendStatsTimer;
VCMProcessTimer _retransmissionTimer;
VCMProcessTimer _keyRequestTimer;
EventFactory* event_factory_;
bool owns_event_factory_;
};
} // namespace webrtc
#endif // WEBRTC_MODULES_VIDEO_CODING_VIDEO_CODING_IMPL_H_

View File

@ -10,14 +10,14 @@
#include <vector>
#include "testing/gtest/include/gtest/gtest.h"
#include "webrtc/modules/video_coding/codecs/interface/mock/mock_video_codec_interface.h"
#include "webrtc/modules/video_coding/main/interface/mock/mock_vcm_callbacks.h"
#include "webrtc/modules/video_coding/main/interface/video_coding.h"
#include "webrtc/modules/video_coding/main/test/test_util.h"
#include "webrtc/system_wrappers/interface/clock.h"
#include "webrtc/system_wrappers/interface/scoped_ptr.h"
#include "gtest/gtest.h"
using ::testing::_;
using ::testing::AllOf;
using ::testing::ElementsAre;
@ -39,7 +39,7 @@ class TestVideoCodingModule : public ::testing::Test {
virtual void SetUp() {
clock_.reset(new SimulatedClock(0));
vcm_ = VideoCodingModule::Create(0, clock_.get());
vcm_ = VideoCodingModule::Create(0, clock_.get(), &event_factory_);
EXPECT_EQ(0, vcm_->InitializeReceiver());
EXPECT_EQ(0, vcm_->InitializeSender());
EXPECT_EQ(0, vcm_->RegisterExternalEncoder(&encoder_, kUnusedPayloadType,
@ -125,6 +125,7 @@ class TestVideoCodingModule : public ::testing::Test {
VideoCodingModule* vcm_;
scoped_ptr<SimulatedClock> clock_;
NullEventFactory event_factory_;
NiceMock<MockVideoDecoder> decoder_;
NiceMock<MockVideoEncoder> encoder_;
I420VideoFrame input_frame_;

View File

@ -8,11 +8,12 @@
* be found in the AUTHORS file in the root of the source tree.
*/
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include "modules/video_coding/codecs/interface/mock/mock_video_codec_interface.h"
#include "modules/video_coding/main/interface/video_coding.h"
#include "modules/video_coding/main/interface/mock/mock_vcm_callbacks.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "webrtc/modules/video_coding/codecs/interface/mock/mock_video_codec_interface.h"
#include "webrtc/modules/video_coding/main/interface/video_coding.h"
#include "webrtc/modules/video_coding/main/interface/mock/mock_vcm_callbacks.h"
#include "webrtc/modules/video_coding/main/test/test_util.h"
#include "webrtc/system_wrappers/interface/clock.h"
namespace webrtc {
@ -34,7 +35,7 @@ class VCMRobustnessTest : public ::testing::Test {
virtual void SetUp() {
clock_.reset(new SimulatedClock(0));
ASSERT_TRUE(clock_.get() != NULL);
vcm_ = VideoCodingModule::Create(0, clock_.get());
vcm_ = VideoCodingModule::Create(0, clock_.get(), &event_factory_);
ASSERT_TRUE(vcm_ != NULL);
ASSERT_EQ(0, vcm_->InitializeReceiver());
const size_t kMaxNackListSize = 250;
@ -80,6 +81,7 @@ class VCMRobustnessTest : public ::testing::Test {
NiceMock<MockVideoDecoder> decoder_;
NiceMock<MockVideoDecoder> decoderCopy_;
scoped_ptr<SimulatedClock> clock_;
NullEventFactory event_factory_;
};
TEST_F(VCMRobustnessTest, TestHardNack) {