From 183b77d5ab2a4966b71be2e36eb171b44a3f2ae9 Mon Sep 17 00:00:00 2001 From: James Zern Date: Tue, 30 Jul 2013 22:46:58 -0700 Subject: vp9/decoder: add thread worker vp9/decoder/vp9_thread.[hc] Original source: http://git.chromium.org/webm/libwebp.git 100644 blob b1615d0fb8d311666b2fa4561076c62d72c2e3ff src/utils/thread.c 100644 blob 13a61a4c84194c3374080cbf03d881d3cd6af40d src/utils/thread.h Local modifications: - s/WebP/VP9/g - camelcase functions -> lower with _'s Change-Id: Ib6932640ee34f8b4782c6fbd15864a59d5d4c5fe --- test/test.mk | 1 + test/vp9_thread_test.cc | 80 +++++++++++++++ vp9/decoder/vp9_thread.c | 248 +++++++++++++++++++++++++++++++++++++++++++++++ vp9/decoder/vp9_thread.h | 93 ++++++++++++++++++ vp9/vp9dx.mk | 2 + 5 files changed, 424 insertions(+) create mode 100644 test/vp9_thread_test.cc create mode 100644 vp9/decoder/vp9_thread.c create mode 100644 vp9/decoder/vp9_thread.h diff --git a/test/test.mk b/test/test.mk index 619533a38..25e05b9fc 100644 --- a/test/test.mk +++ b/test/test.mk @@ -89,6 +89,7 @@ LIBVPX_TEST_SRCS-yes += tile_independence_test.cc endif LIBVPX_TEST_SRCS-$(CONFIG_VP9) += convolve_test.cc +LIBVPX_TEST_SRCS-$(CONFIG_VP9_DECODER) += vp9_thread_test.cc LIBVPX_TEST_SRCS-$(CONFIG_VP9_ENCODER) += fdct4x4_test.cc LIBVPX_TEST_SRCS-$(CONFIG_VP9_ENCODER) += fdct8x8_test.cc diff --git a/test/vp9_thread_test.cc b/test/vp9_thread_test.cc new file mode 100644 index 000000000..308ba9438 --- /dev/null +++ b/test/vp9_thread_test.cc @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2013 The WebM 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. + */ + +#include "vp9/decoder/vp9_thread.h" + +#include "third_party/googletest/src/include/gtest/gtest.h" + +namespace { + +class VP9WorkerThreadTest : public ::testing::Test { + protected: + virtual ~VP9WorkerThreadTest() {} + virtual void SetUp() { + vp9_worker_init(&worker_); + } + + virtual void TearDown() { + vp9_worker_end(&worker_); + } + + VP9Worker worker_; +}; + +int ThreadHook(void* data, void* return_value) { + int* const hook_data = reinterpret_cast(data); + *hook_data = 5; + return *reinterpret_cast(return_value); +} + +TEST_F(VP9WorkerThreadTest, HookSuccess) { + EXPECT_TRUE(vp9_worker_sync(&worker_)); // should be a no-op. + + for (int i = 0; i < 2; ++i) { + EXPECT_TRUE(vp9_worker_reset(&worker_)); + + int hook_data = 0; + int return_value = 1; // return successfully from the hook + worker_.hook = ThreadHook; + worker_.data1 = &hook_data; + worker_.data2 = &return_value; + + vp9_worker_launch(&worker_); + EXPECT_TRUE(vp9_worker_sync(&worker_)); + EXPECT_FALSE(worker_.had_error); + EXPECT_EQ(5, hook_data); + + EXPECT_TRUE(vp9_worker_sync(&worker_)); // should be a no-op. + } +} + +TEST_F(VP9WorkerThreadTest, HookFailure) { + EXPECT_TRUE(vp9_worker_reset(&worker_)); + + int hook_data = 0; + int return_value = 0; // return failure from the hook + worker_.hook = ThreadHook; + worker_.data1 = &hook_data; + worker_.data2 = &return_value; + + vp9_worker_launch(&worker_); + EXPECT_FALSE(vp9_worker_sync(&worker_)); + EXPECT_TRUE(worker_.had_error); + + // Ensure _reset() clears the error and _launch() can be called again. + return_value = 1; + EXPECT_TRUE(vp9_worker_reset(&worker_)); + EXPECT_FALSE(worker_.had_error); + vp9_worker_launch(&worker_); + EXPECT_TRUE(vp9_worker_sync(&worker_)); + EXPECT_FALSE(worker_.had_error); +} + +} // namespace diff --git a/vp9/decoder/vp9_thread.c b/vp9/decoder/vp9_thread.c new file mode 100644 index 000000000..dc3b68196 --- /dev/null +++ b/vp9/decoder/vp9_thread.c @@ -0,0 +1,248 @@ +// Copyright 2013 Google Inc. All Rights Reserved. +// +// Use of this source code is governed by a BSD-style license +// that can be found in the COPYING 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. +// ----------------------------------------------------------------------------- +// +// Multi-threaded worker +// +// Original source: +// http://git.chromium.org/webm/libwebp.git +// 100644 blob eff8f2a8c20095aade3c292b0e9292dac6cb3587 src/utils/thread.c + + +#include +#include // for memset() +#include "./vp9_thread.h" + +#if defined(__cplusplus) || defined(c_plusplus) +extern "C" { +#endif + +#if CONFIG_MULTITHREAD + +#if defined(_WIN32) + +//------------------------------------------------------------------------------ +// simplistic pthread emulation layer + +#include + +// _beginthreadex requires __stdcall +#define THREADFN unsigned int __stdcall +#define THREAD_RETURN(val) (unsigned int)((DWORD_PTR)val) + +static int pthread_create(pthread_t* const thread, const void* attr, + unsigned int (__stdcall *start)(void*), void* arg) { + (void)attr; + *thread = (pthread_t)_beginthreadex(NULL, /* void *security */ + 0, /* unsigned stack_size */ + start, + arg, + 0, /* unsigned initflag */ + NULL); /* unsigned *thrdaddr */ + if (*thread == NULL) return 1; + SetThreadPriority(*thread, THREAD_PRIORITY_ABOVE_NORMAL); + return 0; +} + +static int pthread_join(pthread_t thread, void** value_ptr) { + (void)value_ptr; + return (WaitForSingleObject(thread, INFINITE) != WAIT_OBJECT_0 || + CloseHandle(thread) == 0); +} + +// Mutex +static int pthread_mutex_init(pthread_mutex_t* const mutex, void* mutexattr) { + (void)mutexattr; + InitializeCriticalSection(mutex); + return 0; +} + +static int pthread_mutex_lock(pthread_mutex_t* const mutex) { + EnterCriticalSection(mutex); + return 0; +} + +static int pthread_mutex_unlock(pthread_mutex_t* const mutex) { + LeaveCriticalSection(mutex); + return 0; +} + +static int pthread_mutex_destroy(pthread_mutex_t* const mutex) { + DeleteCriticalSection(mutex); + return 0; +} + +// Condition +static int pthread_cond_destroy(pthread_cond_t* const condition) { + int ok = 1; + ok &= (CloseHandle(condition->waiting_sem_) != 0); + ok &= (CloseHandle(condition->received_sem_) != 0); + ok &= (CloseHandle(condition->signal_event_) != 0); + return !ok; +} + +static int pthread_cond_init(pthread_cond_t* const condition, void* cond_attr) { + (void)cond_attr; + condition->waiting_sem_ = CreateSemaphore(NULL, 0, 1, NULL); + condition->received_sem_ = CreateSemaphore(NULL, 0, 1, NULL); + condition->signal_event_ = CreateEvent(NULL, FALSE, FALSE, NULL); + if (condition->waiting_sem_ == NULL || + condition->received_sem_ == NULL || + condition->signal_event_ == NULL) { + pthread_cond_destroy(condition); + return 1; + } + return 0; +} + +static int pthread_cond_signal(pthread_cond_t* const condition) { + int ok = 1; + if (WaitForSingleObject(condition->waiting_sem_, 0) == WAIT_OBJECT_0) { + // a thread is waiting in pthread_cond_wait: allow it to be notified + ok = SetEvent(condition->signal_event_); + // wait until the event is consumed so the signaler cannot consume + // the event via its own pthread_cond_wait. + ok &= (WaitForSingleObject(condition->received_sem_, INFINITE) != + WAIT_OBJECT_0); + } + return !ok; +} + +static int pthread_cond_wait(pthread_cond_t* const condition, + pthread_mutex_t* const mutex) { + int ok; + // note that there is a consumer available so the signal isn't dropped in + // pthread_cond_signal + if (!ReleaseSemaphore(condition->waiting_sem_, 1, NULL)) + return 1; + // now unlock the mutex so pthread_cond_signal may be issued + pthread_mutex_unlock(mutex); + ok = (WaitForSingleObject(condition->signal_event_, INFINITE) == + WAIT_OBJECT_0); + ok &= ReleaseSemaphore(condition->received_sem_, 1, NULL); + pthread_mutex_lock(mutex); + return !ok; +} + +#else // _WIN32 +# define THREADFN void* +# define THREAD_RETURN(val) val +#endif + +//------------------------------------------------------------------------------ + +static THREADFN thread_loop(void *ptr) { // thread loop + VP9Worker* const worker = (VP9Worker*)ptr; + int done = 0; + while (!done) { + pthread_mutex_lock(&worker->mutex_); + while (worker->status_ == OK) { // wait in idling mode + pthread_cond_wait(&worker->condition_, &worker->mutex_); + } + if (worker->status_ == WORK) { + if (worker->hook) { + worker->had_error |= !worker->hook(worker->data1, worker->data2); + } + worker->status_ = OK; + } else if (worker->status_ == NOT_OK) { // finish the worker + done = 1; + } + // signal to the main thread that we're done (for Sync()) + pthread_cond_signal(&worker->condition_); + pthread_mutex_unlock(&worker->mutex_); + } + return THREAD_RETURN(NULL); // Thread is finished +} + +// main thread state control +static void change_state(VP9Worker* const worker, + VP9WorkerStatus new_status) { + // no-op when attempting to change state on a thread that didn't come up + if (worker->status_ < OK) return; + + pthread_mutex_lock(&worker->mutex_); + // wait for the worker to finish + while (worker->status_ != OK) { + pthread_cond_wait(&worker->condition_, &worker->mutex_); + } + // assign new status and release the working thread if needed + if (new_status != OK) { + worker->status_ = new_status; + pthread_cond_signal(&worker->condition_); + } + pthread_mutex_unlock(&worker->mutex_); +} + +#endif + +//------------------------------------------------------------------------------ + +void vp9_worker_init(VP9Worker* const worker) { + memset(worker, 0, sizeof(*worker)); + worker->status_ = NOT_OK; +} + +int vp9_worker_sync(VP9Worker* const worker) { +#if CONFIG_MULTITHREAD + change_state(worker, OK); +#endif + assert(worker->status_ <= OK); + return !worker->had_error; +} + +int vp9_worker_reset(VP9Worker* const worker) { + int ok = 1; + worker->had_error = 0; + if (worker->status_ < OK) { +#if CONFIG_MULTITHREAD + if (pthread_mutex_init(&worker->mutex_, NULL) || + pthread_cond_init(&worker->condition_, NULL)) { + return 0; + } + pthread_mutex_lock(&worker->mutex_); + ok = !pthread_create(&worker->thread_, NULL, thread_loop, worker); + if (ok) worker->status_ = OK; + pthread_mutex_unlock(&worker->mutex_); +#else + worker->status_ = OK; +#endif + } else if (worker->status_ > OK) { + ok = vp9_worker_sync(worker); + } + assert(!ok || (worker->status_ == OK)); + return ok; +} + +void vp9_worker_launch(VP9Worker* const worker) { +#if CONFIG_MULTITHREAD + change_state(worker, WORK); +#else + if (worker->hook) + worker->had_error |= !worker->hook(worker->data1, worker->data2); +#endif +} + +void vp9_worker_end(VP9Worker* const worker) { + if (worker->status_ >= OK) { +#if CONFIG_MULTITHREAD + change_state(worker, NOT_OK); + pthread_join(worker->thread_, NULL); + pthread_mutex_destroy(&worker->mutex_); + pthread_cond_destroy(&worker->condition_); +#else + worker->status_ = NOT_OK; +#endif + } + assert(worker->status_ == NOT_OK); +} + +//------------------------------------------------------------------------------ + +#if defined(__cplusplus) || defined(c_plusplus) +} // extern "C" +#endif diff --git a/vp9/decoder/vp9_thread.h b/vp9/decoder/vp9_thread.h new file mode 100644 index 000000000..a8f7e046a --- /dev/null +++ b/vp9/decoder/vp9_thread.h @@ -0,0 +1,93 @@ +// Copyright 2013 Google Inc. All Rights Reserved. +// +// Use of this source code is governed by a BSD-style license +// that can be found in the COPYING 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. +// ----------------------------------------------------------------------------- +// +// Multi-threaded worker +// +// Original source: +// http://git.chromium.org/webm/libwebp.git +// 100644 blob 13a61a4c84194c3374080cbf03d881d3cd6af40d src/utils/thread.h + + +#ifndef VP9_DECODER_VP9_THREAD_H_ +#define VP9_DECODER_VP9_THREAD_H_ + +#include "vpx_config.h" + +#if defined(__cplusplus) || defined(c_plusplus) +extern "C" { +#endif + +#if CONFIG_MULTITHREAD + +#if defined(_WIN32) + +#include +typedef HANDLE pthread_t; +typedef CRITICAL_SECTION pthread_mutex_t; +typedef struct { + HANDLE waiting_sem_; + HANDLE received_sem_; + HANDLE signal_event_; +} pthread_cond_t; + +#else + +#include + +#endif /* _WIN32 */ +#endif /* CONFIG_MULTITHREAD */ + +// State of the worker thread object +typedef enum { + NOT_OK = 0, // object is unusable + OK, // ready to work + WORK // busy finishing the current task +} VP9WorkerStatus; + +// Function to be called by the worker thread. Takes two opaque pointers as +// arguments (data1 and data2), and should return false in case of error. +typedef int (*VP9WorkerHook)(void*, void*); + +// Synchronize object used to launch job in the worker thread +typedef struct { +#if CONFIG_MULTITHREAD + pthread_mutex_t mutex_; + pthread_cond_t condition_; + pthread_t thread_; +#endif + VP9WorkerStatus status_; + VP9WorkerHook hook; // hook to call + void* data1; // first argument passed to 'hook' + void* data2; // second argument passed to 'hook' + int had_error; // return value of the last call to 'hook' +} VP9Worker; + +// Must be called first, before any other method. +void vp9_worker_init(VP9Worker* const worker); +// Must be called to initialize the object and spawn the thread. Re-entrant. +// Will potentially launch the thread. Returns false in case of error. +int vp9_worker_reset(VP9Worker* const worker); +// Makes sure the previous work is finished. Returns true if worker->had_error +// was not set and no error condition was triggered by the working thread. +int vp9_worker_sync(VP9Worker* const worker); +// Triggers the thread to call hook() with data1 and data2 argument. These +// hook/data1/data2 can be changed at any time before calling this function, +// but not be changed afterward until the next call to vp9_worker_sync(). +void vp9_worker_launch(VP9Worker* const worker); +// Kill the thread and terminate the object. To use the object again, one +// must call vp9_worker_reset() again. +void vp9_worker_end(VP9Worker* const worker); + +//------------------------------------------------------------------------------ + +#if defined(__cplusplus) || defined(c_plusplus) +} // extern "C" +#endif + +#endif /* VP9_DECODER_VP9_THREAD_H_ */ diff --git a/vp9/vp9dx.mk b/vp9/vp9dx.mk index 6cad29329..be3afe835 100644 --- a/vp9/vp9dx.mk +++ b/vp9/vp9dx.mk @@ -28,6 +28,8 @@ VP9_DX_SRCS-yes += decoder/vp9_decodemv.h VP9_DX_SRCS-yes += decoder/vp9_detokenize.h VP9_DX_SRCS-yes += decoder/vp9_onyxd.h VP9_DX_SRCS-yes += decoder/vp9_onyxd_int.h +VP9_DX_SRCS-yes += decoder/vp9_thread.c +VP9_DX_SRCS-yes += decoder/vp9_thread.h VP9_DX_SRCS-yes += decoder/vp9_treereader.h VP9_DX_SRCS-yes += decoder/vp9_onyxd_if.c VP9_DX_SRCS-yes += decoder/vp9_idct_blk.c -- cgit v1.2.3