summaryrefslogtreecommitdiff
path: root/lib/avtp_pipeline/shaper/openavb_shaper.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/avtp_pipeline/shaper/openavb_shaper.h')
-rw-r--r--lib/avtp_pipeline/shaper/openavb_shaper.h49
1 files changed, 49 insertions, 0 deletions
diff --git a/lib/avtp_pipeline/shaper/openavb_shaper.h b/lib/avtp_pipeline/shaper/openavb_shaper.h
new file mode 100644
index 00000000..2639aab0
--- /dev/null
+++ b/lib/avtp_pipeline/shaper/openavb_shaper.h
@@ -0,0 +1,49 @@
+/*************************************************************************************************************
+Copyright (c) 2012-2015, Symphony Teleca Corporation, a Harman International Industries, Incorporated company
+Copyright (c) 2016-2017, Harman International Industries, Incorporated
+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.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS LISTED "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 LISTED 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.
+
+Attributions: The inih library portion of the source code is licensed from
+Brush Technology and Ben Hoyt - Copyright (c) 2009, Brush Technology and Copyright (c) 2009, Ben Hoyt.
+Complete license and copyright information can be found at
+https://github.com/benhoyt/inih/commit/74d2ca064fb293bc60a77b0bd068075b293cf175.
+*************************************************************************************************************/
+
+#ifndef OPENAVB_SHAPER_H
+#define OPENAVB_SHAPER_H 1
+#include "openavb_types.h"
+
+// Shaper library lifecycle
+bool openavbShaperInitialize(const char *ifname, unsigned int shaperPort);
+void openavbShaperFinalize();
+
+bool openavbShaperDaemonAvailable(void);
+
+// Tell the Shaper to shape outgoing packets.
+// Use the returned value for the call to openavbShapingRelease().
+void* openavbShaperHandle(SRClassIdx_t sr_class, int measurement_interval_usec, int max_frame_size_bytes, int max_frames_per_interval, const unsigned char * stream_da);
+
+// Have the Shaper stop shaping outgoing packets.
+void openavbShaperRelease(void* handle);
+
+#endif // OPENAVB_SHAPER_H