diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/build-gst-python.sh b/build-gst-python.sh index d019e51..5b03d5c 100755 --- a/build-gst-python.sh +++ b/build-gst-python.sh @@ -28,10 +28,13 @@ cd gst-python export PYTHON=$PYTHON git checkout $GST_VERSION -./autogen.sh --disable-gtk-doc --noconfigure -./configure --with-libpython-dir=$LIBPYTHONPATH --prefix $GST_PREFIX -make -make install +#./autogen.sh --disable-gtk-doc --noconfigure +#./configure --with-libpython-dir=$LIBPYTHONPATH --prefix $GST_PREFIX +#make +#make install +meson --prefix=/usr -Dbuildtype=release build +#ninja -C build +ninja -C build install cd ../.. diff --git a/gstreamer/3rd_party/build.sh b/gstreamer/3rd_party/build.sh index d3ac13c..3a1ac06 100755 --- a/gstreamer/3rd_party/build.sh +++ b/gstreamer/3rd_party/build.sh @@ -1,7 +1,19 @@ ROOT=$PWD echo "PWD: $PWD" - +rm -rf ./build # Gstreamer -cd gstreamer -./build.sh \ No newline at end of file +#cd gstreamer +#./build.sh +#--prefix=~/myinstalls/ +if [ -z ${PREFIX+x} ]; then + echo "PREFIX is unset"; + meson -Dbuildtype=debug build + +else + echo "PREFIX is set to '$PREFIX'"; + meson --prefix=$PREFIX -Dbuildtype=debug build + +fi +# compile and install +ninja -C build install diff --git a/gstreamer/3rd_party/gstreamer/CMakeLists.txt b/gstreamer/3rd_party/gstreamer/CMakeLists.txt index 8132cd9..c8498c8 100644 --- a/gstreamer/3rd_party/gstreamer/CMakeLists.txt +++ b/gstreamer/3rd_party/gstreamer/CMakeLists.txt @@ -24,4 +24,6 @@ message("CMAKE_EXE_LINKER_FLAGS: ${CMAKE_EXE_LINKER_FLAGS}") set_target_properties(gst_objects_info_meta PROPERTIES COMPILE_FLAGS ${CMAKE_C_FLAGS} - LINKER_FLAGS ${CMAKE_EXE_LINKER_FLAGS}) \ No newline at end of file + LINKER_FLAGS ${CMAKE_EXE_LINKER_FLAGS}) + +install(TARGETS gst_objects_info_meta DESTINATION lib) \ No newline at end of file diff --git a/gstreamer/3rd_party/gstreamer/meson.build b/gstreamer/3rd_party/gstreamer/meson.build new file mode 100644 index 0000000..803ac92 --- /dev/null +++ b/gstreamer/3rd_party/gstreamer/meson.build @@ -0,0 +1,33 @@ +plugin_c_args = ['-DHAVE_CONFIG_H'] + +cdata = configuration_data() +cdata.set_quoted('PACKAGE_VERSION', gst_version) +cdata.set_quoted('PACKAGE', 'gst-itt4rt-plugin') +# Gstreamer license list: https://gitlab.freedesktop.org/gstreamer/gstreamer/blob/1.16.0/gst/gstplugin.c +# BSD or MIT/X11 +cdata.set_quoted('GST_LICENSE', 'Proprietary') +cdata.set_quoted('GST_API_VERSION', api_version) +cdata.set_quoted('GST_PACKAGE_NAME', 'GStreamer template Plug-ins') +cdata.set_quoted('GST_PACKAGE_ORIGIN', 'https://gstreamer.freedesktop.org') +configure_file(output : 'config.h', configuration : cdata) + +#gstaudio_dep = dependency('gstreamer-audio-1.0', +# fallback: ['gst-plugins-base', 'audio_dep']) + +#gstrtp_dep = dependency('gstreamer-rtp-1.0') + + +# Viewport Glib metadata dynamic library +viewport_meta_sources = [ + 'gst_objects_info_meta.c' + ] + +# viewport meta +# create gst_viewport_meta.dll or libgst_viewport_meta.so +gst_objects_info_meta = library('gst_objects_info_meta', + viewport_meta_sources, + c_args: plugin_c_args, + dependencies : [gst_dep], + install : true, + install_dir : get_option('libdir'), +) diff --git a/gstreamer/3rd_party/meson.build b/gstreamer/3rd_party/meson.build new file mode 100644 index 0000000..6bfb0a7 --- /dev/null +++ b/gstreamer/3rd_party/meson.build @@ -0,0 +1,14 @@ +project('gst-rtp-viewport-metadata', 'c', version : '1.0.0.1', license : 'Proprietary') + +plugins_install_dir = join_paths(get_option('libdir'), 'gstreamer-1.0') + +cc = meson.get_compiler('c') + +gst_version = meson.project_version() + +api_version = '1.0' + +gst_dep = dependency('gstreamer-1.0', + fallback : ['gstreamer', 'gst_dep']) + +subdir('gstreamer') diff --git a/gstreamer/gst_hacks.py b/gstreamer/gst_hacks.py index 5041312..fad7e3f 100644 --- a/gstreamer/gst_hacks.py +++ b/gstreamer/gst_hacks.py @@ -5,7 +5,7 @@ from ctypes import * from typing import Tuple from contextlib import contextmanager - +import platform import gi gi.require_version('Gst', '1.0') from gi.repository import Gst # noqa:F401,F402 @@ -24,8 +24,13 @@ class _GstMapInfo(Structure): _GST_MAP_INFO_POINTER = POINTER(_GstMapInfo) - -_libgst = CDLL(os.getenv("LIB_GSTREAMER_PATH", "libgstreamer-1.0.so.0")) +# we need to check the OS +# "libgstreamer-1.0.dylib" +if platform.system() == 'Darwin': + _libgst = CDLL(os.getenv("LIB_GSTREAMER_PATH", "libgstreamer-1.0.dylib")) +else: + _libgst = CDLL(os.getenv("LIB_GSTREAMER_PATH", "libgstreamer-1.0.so.0")) + _libgst.gst_buffer_map.argtypes = [c_void_p, _GST_MAP_INFO_POINTER, c_int] _libgst.gst_buffer_map.restype = c_int diff --git a/gstreamer/gst_objects_info_meta.py b/gstreamer/gst_objects_info_meta.py index 5de5cb7..78064c4 100644 --- a/gstreamer/gst_objects_info_meta.py +++ b/gstreamer/gst_objects_info_meta.py @@ -24,8 +24,9 @@ class GstObjectInfoArray(Structure): GstObjectInfoArrayPtr = POINTER(GstObjectInfoArray) -cwd = os.path.dirname(os.path.abspath(__file__)) -libc = CDLL(os.path.join(cwd, "3rd_party/gstreamer/build/libgst_objects_info_meta.so")) +#cwd = os.path.dirname(os.path.abspath(__file__)) +#libc = CDLL(os.path.join(cwd, "3rd_party/gstreamer/build/libgst_objects_info_meta.so")) +libc = CDLL("libgst_objects_info_meta.so") libc.gst_buffer_add_objects_info_meta.argtypes = [c_void_p, GstObjectInfoArrayPtr] libc.gst_buffer_add_objects_info_meta.restype = c_void_p diff --git a/gstreamer/gst_tools.py b/gstreamer/gst_tools.py index 05c870f..e9cb29c 100644 --- a/gstreamer/gst_tools.py +++ b/gstreamer/gst_tools.py @@ -18,8 +18,8 @@ """ import sys -import os import time +from datetime import datetime, timedelta import queue import logging import threading @@ -27,7 +27,6 @@ from enum import Enum from functools import partial from fractions import Fraction - import attr import numpy as np @@ -119,16 +118,19 @@ def shutdown(self, timeout: int = 2): class GstPipeline: """Base class to initialize any Gstreamer Pipeline from string""" - def __init__(self, command: str): + def __init__(self, command: str, eos_auto_shutdown: bool=True, shutdown_on_error:bool=True): """ :param command: gst-launch string """ self._command = command - self._pipeline = None # Gst.Pipeline - self._bus = None # Gst.Bus + self._eos_auto_shutdown = eos_auto_shutdown + self._eos = False + self._shutdown_on_error = shutdown_on_error + self._pipeline: typ.Optional[Gst.Pipeline] = None + self._bus: typ.Optional[Gst.Bus] = None self._log = logging.getLogger("pygst.{}".format(self.__class__.__name__)) - self._log.info("%s \n gst-launch-1.0 %s", self, command) + self._log.debug("%s \n gst-launch-1.0 %s", self, command) self._end_stream_event = threading.Event() @@ -136,6 +138,10 @@ def __init__(self, command: str): def log(self) -> logging.Logger: return self._log + @property + def eos(self) -> bool: + return self._eos + def __str__(self) -> str: return self.__class__.__name__ @@ -190,7 +196,7 @@ def startup(self): self._on_pipeline_init() self._pipeline.set_state(Gst.State.READY) - self.log.info("Starting %s", self) + self.log.debug("Starting %s", self) self._end_stream_event.clear() @@ -221,31 +227,34 @@ def _shutdown_pipeline(self, timeout: int = 1, eos: bool = False) -> None: :param eos: if True -> send EOS event - EOS event necessary for FILESINK finishes properly - Use when pipeline crushes + :param wait_eos: if True -> wait the EOS from the bus """ if self._end_stream_event.is_set(): - return - - self._end_stream_event.set() + self.log.warning("self._end_stream_event.is_set()") + else: + self._end_stream_event.set() if not self.pipeline: + self.log.warning("self.pipeline is None") return self.log.debug("%s Stopping pipeline ...", self) - + + # EOS should be sent to a src element # https://lazka.github.io/pgi-docs/Gst-1.0/classes/Element.html#Gst.Element.get_state - if self._pipeline.get_state(timeout=1)[1] == Gst.State.PLAYING: - self.log.debug("%s Sending EOS event ...", self) - try: - thread = threading.Thread( - target=self._pipeline.send_event, args=(Gst.Event.new_eos(),) - ) - thread.start() - thread.join(timeout=timeout) - except Exception: - pass - - self.log.debug("%s Reseting pipeline state ....", self) + # if self._pipeline.get_state(timeout=1)[1] == Gst.State.PLAYING: + # self.log.debug("%s Sending EOS event ...", self) + # try: + # thread = threading.Thread( + # target=self._pipeline.send_event, args=(Gst.Event.new_eos(),) + # ) + # thread.start() + # thread.join(timeout=timeout) + # except Exception: + # pass + + # self.log.debug("%s Reseting pipeline state ....", self) try: self._pipeline.set_state(Gst.State.NULL) self._pipeline = None @@ -254,18 +263,43 @@ def _shutdown_pipeline(self, timeout: int = 1, eos: bool = False) -> None: self.log.debug("%s Gst.Pipeline successfully destroyed", self) - def shutdown(self, timeout: int = 1, eos: bool = False) -> None: + def shutdown(self, timeout: int = 1, eos: bool = False, wait_eos:bool = False) -> None: """Shutdown pipeline :param timeout: time to wait when pipeline fully stops :param eos: if True -> send EOS event - EOS event necessary for FILESINK finishes properly - Use when pipeline crushes + :param wait_eos: if True -> wait the EOS from the bus """ - self.log.info("%s Shutdown requested ...", self) - self._shutdown_pipeline(timeout=timeout, eos=eos) + def _delayed_shutdown_till_eos(): + self.log.debug("========== _delayed_shutdown_till_eos ============ ") + wait_until = datetime.now() + timedelta(seconds=timeout) + while True: + if self.eos: + self.log.debug("== EOS has arrived already") + break + if wait_until < datetime.now(): + self.log.debug("== EOS wait timeout") + break + time.sleep(0.1) + self.log.debug("== now we do real pipeline shutdown by EOS or Timeout ==") + self._shutdown_pipeline(timeout=timeout, eos=eos) - self.log.info("%s successfully destroyed", self) + self.log.debug("%s Shutdown requested ...", self) + if wait_eos: + try: + thread = threading.Thread(target=_delayed_shutdown_till_eos) + thread.start() + thread.join(timeout=timeout) + except Exception: + self.log.debug("delayed shutdown timeouted") + + else: + self.log.debug("No need to wait EOS, start to shutdown the pipeline") + self._shutdown_pipeline(timeout=timeout, eos=eos) + + self.log.debug("%s successfully destroyed", self) @property def is_active(self) -> bool: @@ -277,18 +311,25 @@ def is_done(self) -> bool: def on_error(self, bus: Gst.Bus, message: Gst.Message): err, debug = message.parse_error() - self.log.error("Gstreamer.%s: Error %s: %s. ", self, err, debug) - self._shutdown_pipeline() + self.log.error("[on_error] Gstreamer.%s: Error %s: %s\nCommand on_error: %s", self, err, debug, self._command) + + if self._shutdown_on_error: + self.log.warn("[on_error] shutdown pipeline on error") + self._shutdown_pipeline() + else: + self.log.warn("[on_error] error ignored") def on_eos(self, bus: Gst.Bus, message: Gst.Message): - self.log.debug("Gstreamer.%s: Received stream EOS event", self) - self._shutdown_pipeline() + self.log.debug("[on_eos] Gstreamer.%s: Received stream EOS event", self) + self._eos = True + if self._eos_auto_shutdown: + self.log.debug("=== received EOS, try to shutdown the pipeline === ") + self._shutdown_pipeline() def on_warning(self, bus: Gst.Bus, message: Gst.Message): warn, debug = message.parse_warning() self.log.warning("Gstreamer.%s: %s. %s", self, warn, debug) - def gst_video_format_plugin( *, width: int = None, diff --git a/gstreamer/utils.py b/gstreamer/utils.py index 24c30e9..b0904db 100644 --- a/gstreamer/utils.py +++ b/gstreamer/utils.py @@ -41,6 +41,9 @@ def _get_num_channels(fmt: GstVideo.VideoFormat) -> int: if has_flag(frmt_info.flags, GstVideo.VideoFormatFlags.RGB): return 3 + if has_flag(frmt_info.flags, GstVideo.VideoFormatFlags.YUV): + return 3 + if has_flag(frmt_info.flags, GstVideo.VideoFormatFlags.GRAY): return 1 diff --git a/setup.py b/setup.py index 0c4b59c..26769ef 100644 --- a/setup.py +++ b/setup.py @@ -42,8 +42,8 @@ def _run_bash_file(bash_file: str): print("Not found ", bash_file) cwd = os.path.dirname(os.path.abspath(__file__)) - if not bool(self.skip_gst_python): - _run_bash_file(os.path.join(cwd, 'build-gst-python.sh')) + #if not bool(self.skip_gst_python): + # _run_bash_file(os.path.join(cwd, 'build-gst-python.sh')) _run_bash_file(os.path.join(cwd, 'build-3rd-party.sh')) _build_py.run(self)