diff options
author | andrew-elder <aelder@audioscience.com> | 2018-10-08 08:21:06 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-10-08 08:21:06 -0400 |
commit | 8fa80d1de59fbef14c8d0e80d8d9a62679a6182a (patch) | |
tree | 92465da04c1c044d051cab976e972b912970b585 /examples/alsa_timed_audio/thread_signal.h | |
parent | df587b7509a4dee7fa79a40eec5d6327310c472b (diff) | |
parent | f9991ab6b9e9448fce61751b4483d7eebbf03804 (diff) | |
download | Open-AVB-8fa80d1de59fbef14c8d0e80d8d9a62679a6182a.tar.gz |
Merge pull request #836 from AVnu/open-avb-next
Open avb next
Diffstat (limited to 'examples/alsa_timed_audio/thread_signal.h')
-rw-r--r-- | examples/alsa_timed_audio/thread_signal.h | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/examples/alsa_timed_audio/thread_signal.h b/examples/alsa_timed_audio/thread_signal.h new file mode 100644 index 00000000..50c37d0d --- /dev/null +++ b/examples/alsa_timed_audio/thread_signal.h @@ -0,0 +1,87 @@ +/****************************************************************************** + + Copyright (c) 2018, Intel Corporation + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + + 1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + 3. Neither the name of the Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE. + +******************************************************************************/ + +#ifndef THREAD_SIGNAL_H +#define THREAD_SIGNAL_H + +//! \typedef isaudk_signal_t +//! \brief Signal object handle +typedef struct isaudk_signal* isaudk_signal_t; + +//! \enum isaudk_signal_error_t +//! \brief Signal API return code +typedef enum { + ISAUDK_SIGNAL_OK, //!< No error + ISAUDK_SIGNAL_SYSERROR, //!< Internal error + ISAUDK_SIGNAL_TIMEDOUT, //!< Wait timeout +} isaudk_signal_error_t; + +// Signal is created in an unsignaled state +// Auto-reset on wait + +//! \brief Allocate signal object. +//! \details Created in unsignalled state +//! +//! \param signal[out] Reference to signal object +//! +//! \return Return code +isaudk_signal_error_t +isaudk_create_signal( isaudk_signal_t *signal ); + +//! \brief Free signal object. +//! +//! \param signal[in] Reference to signal object +//! +//! \return Return code +isaudk_signal_error_t +isaudk_free_signal( isaudk_signal_t signal ); + +//! \brief Wait for signal. +//! \details Set to unsignalled state after successful wait operation +//! +//! \param signal[in] Reference to signal object +//! \param wait[in] Number of milliseconds to wait (0 = forever) +//! +//! \return Return code +isaudk_signal_error_t +isaudk_signal_wait( isaudk_signal_t signal, unsigned wait ); + +//! \brief Send/set signal. +//! +//! \param signal[in] Reference to signal object +//! +//! \return Return code +isaudk_signal_error_t +isaudk_signal_send( isaudk_signal_t signal ); + +#endif/*THREAD_SIGNAL_H*/ |