1b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org/* 2b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved. 3b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * 4b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * Use of this source code is governed by a BSD-style license 5b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * that can be found in the LICENSE file in the root of the source 6b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * tree. An additional intellectual property rights grant can be found 7b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * in the file PATENTS. All contributing project authors may 8b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * be found in the AUTHORS file in the root of the source tree. 9b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org */ 10b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 11b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#ifndef MODULES_INTERFACE_MODULE_H_ 12b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#define MODULES_INTERFACE_MODULE_H_ 13b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 14b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#include <assert.h> 15b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 169965e3a3af371325c85c3f740dd9b3547f67a4eapbos@webrtc.org#include "webrtc/typedefs.h" 17b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 18b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.orgnamespace webrtc { 19b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 20b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.orgclass Module { 21b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org public: 22b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // TODO(henrika): Remove this when chrome is updated. 23b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // DEPRICATED Change the unique identifier of this object. 24b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org virtual int32_t ChangeUniqueId(const int32_t id) { return 0; } 25b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 26b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // Returns the number of milliseconds until the module want a worker 27b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // thread to call Process. 28b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org virtual int32_t TimeUntilNextProcess() = 0; 29b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 30b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // Process any pending tasks such as timeouts. 31b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org virtual int32_t Process() = 0; 32b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 33b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org protected: 34b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org virtual ~Module() {} 35b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org}; 36b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 37b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org// Reference counted version of the module interface. 38b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.orgclass RefCountedModule : public Module { 39b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org public: 40b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // Increase the reference count by one. 41b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // Returns the incremented reference count. 42b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // TODO(perkj): Make this pure virtual when Chromium have implemented 43b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // reference counting ADM and Video capture module. 44b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org virtual int32_t AddRef() { 45b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org assert(false && "Not implemented."); 46b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org return 1; 47b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org } 48b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 49b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // Decrease the reference count by one. 50b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // Returns the decreased reference count. 51b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // Returns 0 if the last reference was just released. 52b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // When the reference count reach 0 the object will self-destruct. 53b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // TODO(perkj): Make this pure virtual when Chromium have implemented 54b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org // reference counting ADM and Video capture module. 55b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org virtual int32_t Release() { 56b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org assert(false && "Not implemented."); 57b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org return 1; 58b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org } 59b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 60b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org protected: 61b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org virtual ~RefCountedModule() {} 62b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org}; 63b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 64b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org} // namespace webrtc 65b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 66b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#endif // MODULES_INTERFACE_MODULE_H_ 67