From 1f7f9683d34aa005c55c4f2d72b84cfee82bfcef Mon Sep 17 00:00:00 2001 From: revisionfx Date: Sun, 6 Oct 2019 13:14:37 -0700 Subject: [PATCH 1/4] MultiTread V2 suite Added V2 proposal --- include/ofxMultiThread.h | 226 ++++++++++++++++++++++++++++----------- 1 file changed, 166 insertions(+), 60 deletions(-) diff --git a/include/ofxMultiThread.h b/include/ofxMultiThread.h index 88a7bd97a..b5f1fa525 100644 --- a/include/ofxMultiThread.h +++ b/include/ofxMultiThread.h @@ -4,7 +4,7 @@ /* Software License : -Copyright (c) 2003-2009, The Open Effects Association Ltd. All rights reserved. +Copyright (c) 2003-2019, The Open Effects Association Ltd. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -31,6 +31,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ + #include "ofxCore.h" #ifdef __cplusplus @@ -44,9 +45,6 @@ extern "C" { #define kOfxMultiThreadSuite "OfxMultiThreadSuite" -/** @brief Mutex blind data handle - */ -typedef struct OfxMutex *OfxMutexHandle; /** @brief The function type to passed to the multi threading routines @@ -54,30 +52,33 @@ typedef struct OfxMutex *OfxMutexHandle; \arg \e threadMax to total number of threads executing this function \arg \e customArg the argument passed into multiThread -A function of this type is passed to OfxMultiThreadSuiteV1::multiThread to be launched in multiple threads. +A function of this type is passed to OfxMultiThreadSuiteV2::multiThread to be launched in multiple threads. +V2 removes all the mutex related calls present in V1, if needed the plugin can do that by themself with system calls. +For plug-ins that currently use V1 without the mutex call, no expected behavior change, the multiThread* functions are the same. */ -typedef void (OfxThreadFunctionV1)(unsigned int threadIndex, +typedef void (OfxThreadFunctionV2)(unsigned int threadIndex, unsigned int threadMax, void *customArg); /** @brief OFX suite that provides simple SMP style multi-processing */ -typedef struct OfxMultiThreadSuiteV1 { +typedef struct OfxMultiThreadSuiteV2 { /**@brief Function to spawn SMP threads \arg func The function to call in each thread. \arg nThreads The number of threads to launch \arg customArg The paramter to pass to customArg of func in each thread. - This function will spawn nThreads separate threads of computation (typically one per CPU) + This function will spawn N separate threads of computation (nThreads, typically one per hyper-thread) to allow something to perform symmetric multi processing. Each thread will call 'func' passing in the index of the thread and the number of threads actually launched. multiThread will not return until all the spawned threads have returned. It is up to the host how it waits for all the threads to return (busy wait, blocking, whatever). - \e nThreads can be more than the value returned by multiThreadNumCPUs, however the threads will - be limitted to the number of CPUs returned by multiThreadNumCPUs. + \e The number of threads reporting by OS calls can be more than the value returned by multiThreadNumCPUs (number of threads returned by host), + however the threads will be limitted to the number of CPUs returned by multiThreadNumCPUs. This way the host can prevent over-threading, for + example for a background process while the foreground application is still running. This function cannot be called recursively. @@ -87,27 +88,34 @@ typedef struct OfxMultiThreadSuiteV1 { - ::kOfxStatErrExists, failed in an attempt to call multiThread recursively, */ - OfxStatus (*multiThread)(OfxThreadFunctionV1 func, + OfxStatus (*multiThread)(OfxThreadFunctionV2 func, unsigned int nThreads, void *customArg); /**@brief Function which indicates the number of CPUs available for SMP processing - \arg nCPUs pointer to an integer where the result is returned + \arg nThreads pointer to an integer where the result is returned - This value may be less than the actual number of CPUs on a machine, as the host may reserve other CPUs for itself. + This value may be less than the actual number of Threads on a machine, as the host may reserve other CPU ressources for itself. + The host might want to say how many threads the plugin can use to do whatever it is it is doing. In that way you can stop a plugin over-subscribing the number of cores available. + A computer can have a number of CPU (e.g. 1-4), each CPU can have a number of CORES (e.g. 2-8) and each core can have a number of HYPER-THREADS (often 2, i.e. hyper-threading), + thus nThreads max allocated by host will refers to the number of hyperthreads: nThreads = CPU X CORES X HYPER-THREADS. + And the host who allocates a Pool Thread will return to you a value of 1 to nThreads. + + Note, it should really be called multiThreadNumCPUs but naming kept for backward compatibility simplicity @returns - ::kOfxStatOK, all was OK and the maximum number of threads is in nThreads. - - ::kOfxStatFailed, the function failed to get the number of CPUs + - ::kOfxStatFailed, the function failed to get the number of Threads */ - OfxStatus (*multiThreadNumCPUs)(unsigned int *nCPUs); + OfxStatus (*multiThreadNumCPUs)(unsigned int *nCPUs); + /**@brief Function which indicates the index of the current thread \arg threadIndex pointer to an integer where the result is returned - This function returns the thread index, which is the same as the \e threadIndex argument passed to the ::OfxThreadFunctionV1. + This function returns the thread index, which is the same as the \e threadIndex argument passed to the ::OfxThreadFunctionV2. If there are no threads currently spawned, then this function will set threadIndex to 0 @@ -125,64 +133,162 @@ typedef struct OfxMultiThreadSuiteV1 { */ int (*multiThreadIsSpawnedThread)(void); - /** @brief Create a mutex + + } OfxMultiThreadSuiteV2; - \arg mutex - where the new handle is returned - \arg count - initial lock count on the mutex. This can be negative. - Creates a new mutex with lockCount locks on the mutex intially set. - @returns - - kOfxStatOK - mutex is now valid and ready to go - */ - OfxStatus (*mutexCreate)(OfxMutexHandle *mutex, int lockCount); +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +/////////////////////// V1 ////////////////////////////////////////////////////////////////////////////////////////////////////////// +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// - /** @brief Destroy a mutex - - Destroys a mutex intially created by mutexCreate. - - @returns - - kOfxStatOK - if it destroyed the mutex - - kOfxStatErrBadHandle - if the handle was bad - */ - OfxStatus (*mutexDestroy)(const OfxMutexHandle mutex); - /** @brief Blocking lock on the mutex - This trys to lock a mutex and blocks the thread it is in until the lock suceeds. +/** @brief Mutex blind data handle +*/ +typedef struct OfxMutex *OfxMutexHandle; - A sucessful lock causes the mutex's lock count to be increased by one and to block any other calls to lock the mutex until it is unlocked. - - @returns - - kOfxStatOK - if it got the lock - - kOfxStatErrBadHandle - if the handle was bad - */ - OfxStatus (*mutexLock)(const OfxMutexHandle mutex); +/** @brief The function type to passed to the multi threading routines - /** @brief Unlock the mutex +\arg \e threadIndex unique index of this thread, will be between 0 and threadMax +\arg \e threadMax to total number of threads executing this function +\arg \e customArg the argument passed into multiThread - This unlocks a mutex. Unlocking a mutex decreases its lock count by one. - - @returns - - kOfxStatOK if it released the lock - - kOfxStatErrBadHandle if the handle was bad - */ - OfxStatus (*mutexUnLock)(const OfxMutexHandle mutex); +A function of this type is passed to OfxMultiThreadSuiteV1::multiThread to be launched in multiple threads. +*/ +typedef void (OfxThreadFunctionV1)(unsigned int threadIndex, + unsigned int threadMax, + void *customArg); + +/** @brief OFX suite that provides simple SMP style multi-processing +*/ +typedef struct OfxMultiThreadSuiteV1 { + /**@brief Function to spawn SMP threads - /** @brief Non blocking attempt to lock the mutex + \arg func The function to call in each thread. + \arg nThreads The number of threads to launch + \arg customArg The paramter to pass to customArg of func in each thread. - This attempts to lock a mutex, if it cannot, it returns and says so, rather than blocking. + This function will spawn nThreads separate threads of computation (typically one per CPU) + to allow something to perform symmetric multi processing. Each thread will call 'func' passing + in the index of the thread and the number of threads actually launched. - A sucessful lock causes the mutex's lock count to be increased by one, if the lock did not suceed, the call returns immediately and the lock count remains unchanged. + multiThread will not return until all the spawned threads have returned. It is up to the host + how it waits for all the threads to return (busy wait, blocking, whatever). + + \e nThreads can be more than the value returned by multiThreadNumCPUs, however the threads will + be limitted to the number of CPUs returned by multiThreadNumCPUs. + + This function cannot be called recursively. + + @returns + - ::kOfxStatOK, the function func has executed and returned sucessfully + - ::kOfxStatFailed, the threading function failed to launch + - ::kOfxStatErrExists, failed in an attempt to call multiThread recursively, + + */ + OfxStatus(*multiThread)(OfxThreadFunctionV1 func, + unsigned int nThreads, + void *customArg); + + /**@brief Function which indicates the number of CPUs available for SMP processing + + \arg nCPUs pointer to an integer where the result is returned + + This value may be less than the actual number of CPUs on a machine, as the host may reserve other CPUs for itself. + + @returns + - ::kOfxStatOK, all was OK and the maximum number of threads is in nThreads. + - ::kOfxStatFailed, the function failed to get the number of CPUs + */ + OfxStatus(*multiThreadNumCPUs)(unsigned int *nCPUs); + + /**@brief Function which indicates the index of the current thread + + \arg threadIndex pointer to an integer where the result is returned + + This function returns the thread index, which is the same as the \e threadIndex argument passed to the ::OfxThreadFunctionV1. + + If there are no threads currently spawned, then this function will set threadIndex to 0 + + @returns + - ::kOfxStatOK, all was OK and the maximum number of threads is in nThreads. + - ::kOfxStatFailed, the function failed to return an index + */ + OfxStatus(*multiThreadIndex)(unsigned int *threadIndex); + + /**@brief Function to enquire if the calling thread was spawned by multiThread + + @returns + - 0 if the thread is not one spawned by multiThread + - 1 if the thread was spawned by multiThread + */ + int(*multiThreadIsSpawnedThread)(void); + + /** @brief Create a mutex + + \arg mutex - where the new handle is returned + \arg count - initial lock count on the mutex. This can be negative. + + Creates a new mutex with lockCount locks on the mutex intially set. + + @returns + - kOfxStatOK - mutex is now valid and ready to go + */ + OfxStatus(*mutexCreate)(OfxMutexHandle *mutex, int lockCount); + + /** @brief Destroy a mutex + + Destroys a mutex intially created by mutexCreate. + + @returns + - kOfxStatOK - if it destroyed the mutex + - kOfxStatErrBadHandle - if the handle was bad + */ + OfxStatus(*mutexDestroy)(const OfxMutexHandle mutex); + + /** @brief Blocking lock on the mutex + + This trys to lock a mutex and blocks the thread it is in until the lock suceeds. + + A sucessful lock causes the mutex's lock count to be increased by one and to block any other calls to lock the mutex until it is unlocked. + + @returns + - kOfxStatOK - if it got the lock + - kOfxStatErrBadHandle - if the handle was bad + */ + OfxStatus(*mutexLock)(const OfxMutexHandle mutex); + + /** @brief Unlock the mutex + + This unlocks a mutex. Unlocking a mutex decreases its lock count by one. + + @returns + - kOfxStatOK if it released the lock + - kOfxStatErrBadHandle if the handle was bad + */ + OfxStatus(*mutexUnLock)(const OfxMutexHandle mutex); + + /** @brief Non blocking attempt to lock the mutex + + This attempts to lock a mutex, if it cannot, it returns and says so, rather than blocking. + + A sucessful lock causes the mutex's lock count to be increased by one, if the lock did not suceed, the call returns immediately and the lock count remains unchanged. + + @returns + - kOfxStatOK - if it got the lock + - kOfxStatFailed - if it did not get the lock + - kOfxStatErrBadHandle - if the handle was bad + */ + OfxStatus(*mutexTryLock)(const OfxMutexHandle mutex); + +} OfxMultiThreadSuiteV1; - @returns - - kOfxStatOK - if it got the lock - - kOfxStatFailed - if it did not get the lock - - kOfxStatErrBadHandle - if the handle was bad - */ - OfxStatus (*mutexTryLock)(const OfxMutexHandle mutex); - } OfxMultiThreadSuiteV1; #ifdef __cplusplus } From 65a8b2ed45ef5aab9525d7a88f922c0385fc456c Mon Sep 17 00:00:00 2001 From: revisionfx Date: Mon, 7 Oct 2019 14:04:11 -0700 Subject: [PATCH 2/4] Adds OfxParamTypeClip The purpose of this parameter is to logically locate in the effects controls the layer param indexer. This is particularly for hosts without other means to connect additional clips (e.g. no nodal interface). --- include/ofxParam.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/ofxParam.h b/include/ofxParam.h index 901cc72cf..02960a332 100644 --- a/include/ofxParam.h +++ b/include/ofxParam.h @@ -94,6 +94,10 @@ These strings are used to identify the type of the parameter when it is defined, #define kOfxParamTypePage "OfxParamTypePage" /** @brief String to identify a param as a PushButton parameter */ #define kOfxParamTypePushButton "OfxParamTypePushButton" +/** @brief String to identify a param as a layer indexer. This parameter did not exist in previous version of the API. +The purpose of this parameter is to logically locate in the effects controls the layer param indexer and is particularly useful for hosts that don't have other means to connect additional input clips to effects. +The "name" string value must match "name" string value of the optional input clip */ +#define kOfxParamTypeClip "OfxParamTypeClip" /*@}*/ /** From 812bca520af8dad2576c43afab56e55aeff072cf Mon Sep 17 00:00:00 2001 From: revisionfx Date: Mon, 7 Oct 2019 14:06:16 -0700 Subject: [PATCH 3/4] updated copyright --- include/ofxParam.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/ofxParam.h b/include/ofxParam.h index 02960a332..767476d2a 100644 --- a/include/ofxParam.h +++ b/include/ofxParam.h @@ -4,7 +4,7 @@ /* Software License : -Copyright (c) 2003-2015, The Open Effects Association Ltd. All rights reserved. +Copyright (c) 2003-2019, The Open Effects Association Ltd. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: From 200816bb908f056c2201dcba08d0c5b438afdeb9 Mon Sep 17 00:00:00 2001 From: revisionfx Date: Mon, 7 Oct 2019 15:27:54 -0700 Subject: [PATCH 4/4] revert back --- include/ofxMultiThread.h | 226 +++++++++++---------------------------- 1 file changed, 60 insertions(+), 166 deletions(-) diff --git a/include/ofxMultiThread.h b/include/ofxMultiThread.h index b5f1fa525..88a7bd97a 100644 --- a/include/ofxMultiThread.h +++ b/include/ofxMultiThread.h @@ -4,7 +4,7 @@ /* Software License : -Copyright (c) 2003-2019, The Open Effects Association Ltd. All rights reserved. +Copyright (c) 2003-2009, The Open Effects Association Ltd. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -31,7 +31,6 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ - #include "ofxCore.h" #ifdef __cplusplus @@ -45,6 +44,9 @@ extern "C" { #define kOfxMultiThreadSuite "OfxMultiThreadSuite" +/** @brief Mutex blind data handle + */ +typedef struct OfxMutex *OfxMutexHandle; /** @brief The function type to passed to the multi threading routines @@ -52,33 +54,30 @@ extern "C" { \arg \e threadMax to total number of threads executing this function \arg \e customArg the argument passed into multiThread -A function of this type is passed to OfxMultiThreadSuiteV2::multiThread to be launched in multiple threads. -V2 removes all the mutex related calls present in V1, if needed the plugin can do that by themself with system calls. -For plug-ins that currently use V1 without the mutex call, no expected behavior change, the multiThread* functions are the same. +A function of this type is passed to OfxMultiThreadSuiteV1::multiThread to be launched in multiple threads. */ -typedef void (OfxThreadFunctionV2)(unsigned int threadIndex, +typedef void (OfxThreadFunctionV1)(unsigned int threadIndex, unsigned int threadMax, void *customArg); /** @brief OFX suite that provides simple SMP style multi-processing */ -typedef struct OfxMultiThreadSuiteV2 { +typedef struct OfxMultiThreadSuiteV1 { /**@brief Function to spawn SMP threads \arg func The function to call in each thread. \arg nThreads The number of threads to launch \arg customArg The paramter to pass to customArg of func in each thread. - This function will spawn N separate threads of computation (nThreads, typically one per hyper-thread) + This function will spawn nThreads separate threads of computation (typically one per CPU) to allow something to perform symmetric multi processing. Each thread will call 'func' passing in the index of the thread and the number of threads actually launched. multiThread will not return until all the spawned threads have returned. It is up to the host how it waits for all the threads to return (busy wait, blocking, whatever). - \e The number of threads reporting by OS calls can be more than the value returned by multiThreadNumCPUs (number of threads returned by host), - however the threads will be limitted to the number of CPUs returned by multiThreadNumCPUs. This way the host can prevent over-threading, for - example for a background process while the foreground application is still running. + \e nThreads can be more than the value returned by multiThreadNumCPUs, however the threads will + be limitted to the number of CPUs returned by multiThreadNumCPUs. This function cannot be called recursively. @@ -88,34 +87,27 @@ typedef struct OfxMultiThreadSuiteV2 { - ::kOfxStatErrExists, failed in an attempt to call multiThread recursively, */ - OfxStatus (*multiThread)(OfxThreadFunctionV2 func, + OfxStatus (*multiThread)(OfxThreadFunctionV1 func, unsigned int nThreads, void *customArg); /**@brief Function which indicates the number of CPUs available for SMP processing - \arg nThreads pointer to an integer where the result is returned + \arg nCPUs pointer to an integer where the result is returned - This value may be less than the actual number of Threads on a machine, as the host may reserve other CPU ressources for itself. - The host might want to say how many threads the plugin can use to do whatever it is it is doing. In that way you can stop a plugin over-subscribing the number of cores available. - A computer can have a number of CPU (e.g. 1-4), each CPU can have a number of CORES (e.g. 2-8) and each core can have a number of HYPER-THREADS (often 2, i.e. hyper-threading), - thus nThreads max allocated by host will refers to the number of hyperthreads: nThreads = CPU X CORES X HYPER-THREADS. - And the host who allocates a Pool Thread will return to you a value of 1 to nThreads. - - Note, it should really be called multiThreadNumCPUs but naming kept for backward compatibility simplicity + This value may be less than the actual number of CPUs on a machine, as the host may reserve other CPUs for itself. @returns - ::kOfxStatOK, all was OK and the maximum number of threads is in nThreads. - - ::kOfxStatFailed, the function failed to get the number of Threads + - ::kOfxStatFailed, the function failed to get the number of CPUs */ - OfxStatus (*multiThreadNumCPUs)(unsigned int *nCPUs); - + OfxStatus (*multiThreadNumCPUs)(unsigned int *nCPUs); /**@brief Function which indicates the index of the current thread \arg threadIndex pointer to an integer where the result is returned - This function returns the thread index, which is the same as the \e threadIndex argument passed to the ::OfxThreadFunctionV2. + This function returns the thread index, which is the same as the \e threadIndex argument passed to the ::OfxThreadFunctionV1. If there are no threads currently spawned, then this function will set threadIndex to 0 @@ -133,162 +125,64 @@ typedef struct OfxMultiThreadSuiteV2 { */ int (*multiThreadIsSpawnedThread)(void); - - } OfxMultiThreadSuiteV2; - - - -////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -/////////////////////// V1 ////////////////////////////////////////////////////////////////////////////////////////////////////////// -////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// - - - -/** @brief Mutex blind data handle -*/ -typedef struct OfxMutex *OfxMutexHandle; - -/** @brief The function type to passed to the multi threading routines - -\arg \e threadIndex unique index of this thread, will be between 0 and threadMax -\arg \e threadMax to total number of threads executing this function -\arg \e customArg the argument passed into multiThread - -A function of this type is passed to OfxMultiThreadSuiteV1::multiThread to be launched in multiple threads. -*/ -typedef void (OfxThreadFunctionV1)(unsigned int threadIndex, - unsigned int threadMax, - void *customArg); - -/** @brief OFX suite that provides simple SMP style multi-processing -*/ -typedef struct OfxMultiThreadSuiteV1 { - /**@brief Function to spawn SMP threads - - \arg func The function to call in each thread. - \arg nThreads The number of threads to launch - \arg customArg The paramter to pass to customArg of func in each thread. - - This function will spawn nThreads separate threads of computation (typically one per CPU) - to allow something to perform symmetric multi processing. Each thread will call 'func' passing - in the index of the thread and the number of threads actually launched. - - multiThread will not return until all the spawned threads have returned. It is up to the host - how it waits for all the threads to return (busy wait, blocking, whatever). - - \e nThreads can be more than the value returned by multiThreadNumCPUs, however the threads will - be limitted to the number of CPUs returned by multiThreadNumCPUs. - - This function cannot be called recursively. + /** @brief Create a mutex - @returns - - ::kOfxStatOK, the function func has executed and returned sucessfully - - ::kOfxStatFailed, the threading function failed to launch - - ::kOfxStatErrExists, failed in an attempt to call multiThread recursively, + \arg mutex - where the new handle is returned + \arg count - initial lock count on the mutex. This can be negative. - */ - OfxStatus(*multiThread)(OfxThreadFunctionV1 func, - unsigned int nThreads, - void *customArg); + Creates a new mutex with lockCount locks on the mutex intially set. - /**@brief Function which indicates the number of CPUs available for SMP processing - - \arg nCPUs pointer to an integer where the result is returned - - This value may be less than the actual number of CPUs on a machine, as the host may reserve other CPUs for itself. - - @returns - - ::kOfxStatOK, all was OK and the maximum number of threads is in nThreads. - - ::kOfxStatFailed, the function failed to get the number of CPUs - */ - OfxStatus(*multiThreadNumCPUs)(unsigned int *nCPUs); - - /**@brief Function which indicates the index of the current thread - - \arg threadIndex pointer to an integer where the result is returned - - This function returns the thread index, which is the same as the \e threadIndex argument passed to the ::OfxThreadFunctionV1. - - If there are no threads currently spawned, then this function will set threadIndex to 0 - - @returns - - ::kOfxStatOK, all was OK and the maximum number of threads is in nThreads. - - ::kOfxStatFailed, the function failed to return an index - */ - OfxStatus(*multiThreadIndex)(unsigned int *threadIndex); - - /**@brief Function to enquire if the calling thread was spawned by multiThread - - @returns - - 0 if the thread is not one spawned by multiThread - - 1 if the thread was spawned by multiThread - */ - int(*multiThreadIsSpawnedThread)(void); - - /** @brief Create a mutex - - \arg mutex - where the new handle is returned - \arg count - initial lock count on the mutex. This can be negative. - - Creates a new mutex with lockCount locks on the mutex intially set. - - @returns - - kOfxStatOK - mutex is now valid and ready to go - */ - OfxStatus(*mutexCreate)(OfxMutexHandle *mutex, int lockCount); - - /** @brief Destroy a mutex - - Destroys a mutex intially created by mutexCreate. - - @returns - - kOfxStatOK - if it destroyed the mutex - - kOfxStatErrBadHandle - if the handle was bad - */ - OfxStatus(*mutexDestroy)(const OfxMutexHandle mutex); - - /** @brief Blocking lock on the mutex - - This trys to lock a mutex and blocks the thread it is in until the lock suceeds. - - A sucessful lock causes the mutex's lock count to be increased by one and to block any other calls to lock the mutex until it is unlocked. + @returns + - kOfxStatOK - mutex is now valid and ready to go + */ + OfxStatus (*mutexCreate)(OfxMutexHandle *mutex, int lockCount); - @returns - - kOfxStatOK - if it got the lock - - kOfxStatErrBadHandle - if the handle was bad - */ - OfxStatus(*mutexLock)(const OfxMutexHandle mutex); + /** @brief Destroy a mutex + + Destroys a mutex intially created by mutexCreate. + + @returns + - kOfxStatOK - if it destroyed the mutex + - kOfxStatErrBadHandle - if the handle was bad + */ + OfxStatus (*mutexDestroy)(const OfxMutexHandle mutex); - /** @brief Unlock the mutex + /** @brief Blocking lock on the mutex - This unlocks a mutex. Unlocking a mutex decreases its lock count by one. + This trys to lock a mutex and blocks the thread it is in until the lock suceeds. - @returns - - kOfxStatOK if it released the lock - - kOfxStatErrBadHandle if the handle was bad - */ - OfxStatus(*mutexUnLock)(const OfxMutexHandle mutex); + A sucessful lock causes the mutex's lock count to be increased by one and to block any other calls to lock the mutex until it is unlocked. + + @returns + - kOfxStatOK - if it got the lock + - kOfxStatErrBadHandle - if the handle was bad + */ + OfxStatus (*mutexLock)(const OfxMutexHandle mutex); - /** @brief Non blocking attempt to lock the mutex + /** @brief Unlock the mutex - This attempts to lock a mutex, if it cannot, it returns and says so, rather than blocking. + This unlocks a mutex. Unlocking a mutex decreases its lock count by one. + + @returns + - kOfxStatOK if it released the lock + - kOfxStatErrBadHandle if the handle was bad + */ + OfxStatus (*mutexUnLock)(const OfxMutexHandle mutex); - A sucessful lock causes the mutex's lock count to be increased by one, if the lock did not suceed, the call returns immediately and the lock count remains unchanged. + /** @brief Non blocking attempt to lock the mutex - @returns - - kOfxStatOK - if it got the lock - - kOfxStatFailed - if it did not get the lock - - kOfxStatErrBadHandle - if the handle was bad - */ - OfxStatus(*mutexTryLock)(const OfxMutexHandle mutex); + This attempts to lock a mutex, if it cannot, it returns and says so, rather than blocking. -} OfxMultiThreadSuiteV1; + A sucessful lock causes the mutex's lock count to be increased by one, if the lock did not suceed, the call returns immediately and the lock count remains unchanged. + @returns + - kOfxStatOK - if it got the lock + - kOfxStatFailed - if it did not get the lock + - kOfxStatErrBadHandle - if the handle was bad + */ + OfxStatus (*mutexTryLock)(const OfxMutexHandle mutex); + } OfxMultiThreadSuiteV1; #ifdef __cplusplus }