summaryrefslogtreecommitdiffstats
path: root/src/JackInput.h
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2016-07-08 11:50:26 +0200
committerMatthias P. Braendli <matthias.braendli@mpb.li>2016-07-08 11:50:26 +0200
commit64b729f3284ead6a71fbeb7f8e0dd22187b21786 (patch)
tree60efb272d174f31bb93cfe561ac1c7ceeb3b412e /src/JackInput.h
parent561b6adce76dd209ebc547fcd98f525501742d97 (diff)
downloadODR-AudioEnc-64b729f3284ead6a71fbeb7f8e0dd22187b21786.tar.gz
ODR-AudioEnc-64b729f3284ead6a71fbeb7f8e0dd22187b21786.tar.bz2
ODR-AudioEnc-64b729f3284ead6a71fbeb7f8e0dd22187b21786.zip
Add doxygen configuration and target
Diffstat (limited to 'src/JackInput.h')
-rw-r--r--src/JackInput.h18
1 files changed, 13 insertions, 5 deletions
diff --git a/src/JackInput.h b/src/JackInput.h
index 36cd34f..ba4834e 100644
--- a/src/JackInput.h
+++ b/src/JackInput.h
@@ -1,6 +1,6 @@
/* ------------------------------------------------------------------
* Copyright (C) 2011 Martin Storsjo
- * Copyright (C) 2013,2014 Matthias P. Braendli
+ * Copyright (C) 2016 Matthias P. Braendli
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -16,6 +16,11 @@
* and limitations under the License.
* -------------------------------------------------------------------
*/
+/*! \section JACK Input
+ *
+ * This input uses JACK to get audio data. This always uses drift
+ * compensation, because there is no blocking way to read from JACK.
+ */
#ifndef __JACK_INPUT_H
#define __JACK_INPUT_H
@@ -53,13 +58,16 @@ class JackInput
}
}
- /* Prepare the audio input */
+ /*! Prepare the audio input
+ *
+ * \return 0 on success
+ */
int prepare();
private:
JackInput(const JackInput& other);
- jack_client_t* m_client;
+ jack_client_t *m_client;
std::vector<jack_port_t*> m_input_ports;
@@ -82,13 +90,13 @@ class JackInput
SampleQueue<uint8_t>& m_queue;
// Static functions for JACK callbacks
- static int process_cb(jack_nframes_t nframes, void* arg)
+ static int process_cb(jack_nframes_t nframes, void *arg)
{
((JackInput*)arg)->jack_process(nframes);
return 0;
}
- static void shutdown_cb(void* arg)
+ static void shutdown_cb(void *arg)
{
((JackInput*)arg)->jack_shutdown();
}