diff --git a/.gitignore b/.gitignore index 273af7a..5252240 100644 --- a/.gitignore +++ b/.gitignore @@ -23,7 +23,23 @@ missing *.la *.lo *.o -stamp-h1 +stamp-* +*-stamp tools/gst-perf *~ \#* +*.swp + +# dpkg-buildpackage output and other release files +*.debhelper.log +.debhelper/ +debian/autoreconf.* +debian/gst-perf.debhelper.log +debian/gst-perf/ +debian/files +debian/tmp +/gst-perf-* +*.deb +*.substvars +*.changes +*.buildinfo diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5bc8fb2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,481 @@ + GNU LIBRARY GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1991 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the library GPL. It is + numbered 2 because it goes with version 2 of the ordinary GPL.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Library General Public License, applies to some +specially designated Free Software Foundation software, and to any +other libraries whose authors decide to use it. You can use it for +your libraries, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if +you distribute copies of the library, or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link a program with the library, you must provide +complete object files to the recipients so that they can relink them +with the library, after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + Our method of protecting your rights has two steps: (1) copyright +the library, and (2) offer you this license which gives you legal +permission to copy, distribute and/or modify the library. + + Also, for each distributor's protection, we want to make certain +that everyone understands that there is no warranty for this free +library. If the library is modified by someone else and passed on, we +want its recipients to know that what they have is not the original +version, so that any problems introduced by others will not reflect on +the original authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that companies distributing free +software will individually obtain patent licenses, thus in effect +transforming the program into proprietary software. To prevent this, +we have made it clear that any patent must be licensed for everyone's +free use or not licensed at all. + + Most GNU software, including some libraries, is covered by the ordinary +GNU General Public License, which was designed for utility programs. This +license, the GNU Library General Public License, applies to certain +designated libraries. This license is quite different from the ordinary +one; be sure to read it in full, and don't assume that anything in it is +the same as in the ordinary license. + + The reason we have a separate public license for some libraries is that +they blur the distinction we usually make between modifying or adding to a +program and simply using it. Linking a program with a library, without +changing the library, is in some sense simply using the library, and is +analogous to running a utility program or application program. However, in +a textual and legal sense, the linked executable is a combined work, a +derivative of the original library, and the ordinary General Public License +treats it as such. + + Because of this blurred distinction, using the ordinary General +Public License for libraries did not effectively promote software +sharing, because most developers did not use the libraries. We +concluded that weaker conditions might promote sharing better. + + However, unrestricted linking of non-free programs would deprive the +users of those programs of all benefit from the free status of the +libraries themselves. This Library General Public License is intended to +permit developers of non-free programs to use free libraries, while +preserving your freedom as a user of such programs to change the free +libraries that are incorporated in them. (We have not seen how to achieve +this as regards changes in header files, but we have achieved it as regards +changes in the actual functions of the Library.) The hope is that this +will lead to faster development of free libraries. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, while the latter only +works together with the library. + + Note that it is possible for a library to be covered by the ordinary +General Public License rather than by this special one. + + GNU LIBRARY GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library which +contains a notice placed by the copyright holder or other authorized +party saying it may be distributed under the terms of this Library +General Public License (also called "this License"). Each licensee is +addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also compile or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + c) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + d) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the source code distributed need not include anything that is normally +distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Library General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/README.md b/README.md index cc64e76..135cd4e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GstPerf -> A GStreamer element to measure framerate, bitrate and CPU usage +A GStreamer element to measure framerate, bitrate and CPU usage ## Build Instructions @@ -24,3 +24,18 @@ encoder: ```bash gst-launch-1.0 -e videotestsrc ! x264enc ! perf ! qtmux print-arm-load=true ! filesink location=test.mp4 ``` + +## Building a Debian package + +1. Install build dependencies (one-time step): + `sudo apt install -y debhelper devscripts` +2. After cloning, run `dpkg-buildpackage -us -uc` in the source directory. + The package will be left in the parent directory. + +## Legal + +Copyright (c) 2019 RidgeRun, LLC. + +Portions copyright (c) 2020 D3 Engineering, LLC. + +Licensed LGPL2+ (LGPL-2.0-or-later); see file [LICENSE](LICENSE) for details. diff --git a/configure.ac b/configure.ac index 8e86d73..8d31269 100644 --- a/configure.ac +++ b/configure.ac @@ -1,8 +1,10 @@ dnl required version of autoconf AC_PREREQ([2.53]) -dnl TODO: fill in your package name and package version here -AC_INIT([gst-perf],[0.2.4]) +dnl package name and package version +dnl NOTE: whenever you change this, also update debian/changelog +dnl (e.g., run `dch -i`). +AC_INIT([gst-perf],[0.3.0]) dnl required versions of gstreamer and plugins-base GST_REQUIRED=1.0.0 @@ -61,6 +63,21 @@ PKG_CHECK_MODULES(GST, [ ]) ]) +dnl check for host OS +AC_CANONICAL_HOST + +case "${host_os}" in + linux*) + AC_DEFINE([IS_LINUX], [1], [Host OS is Linux]) + ;; + cygwin*|mingw*) + AC_DEFINE([IS_WINDOWS], [1], [Host OS is Windows]) + ;; + darwin*) + AC_DEFINE([IS_MACOSX], [1], [Host OS is Mac OSX]) + ;; +esac + dnl check if compiler understands -Wall (if yes, add -Wall to GST_CFLAGS) AC_MSG_CHECKING([to see if compiler understands -Wall]) save_CFLAGS="$CFLAGS" diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..facdd38 --- /dev/null +++ b/debian/changelog @@ -0,0 +1,5 @@ +gst-perf (0.3.0-1) UNRELEASED; urgency=medium + + * Initial .deb release + + -- Christopher White Mon, 19 Oct 2020 12:18:19 -0400 diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..ec63514 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +9 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..bb27860 --- /dev/null +++ b/debian/control @@ -0,0 +1,13 @@ +Source: gst-perf +Priority: optional +Maintainer: RidgeRun Developers +Build-Depends: debhelper (>= 8.0.0), devscripts +Standards-Version: 4.1.0 +Section: utils + +Package: gst-perf +Priority: optional +Architecture: any +Depends: ${shlibs:Depends}, ${misc:Depends} +Description: Measure GStreamer pipeline performance + A GStreamer element to measure framerate, bitrate and CPU usage diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..5e292a7 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,100 @@ +Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: gst-perf +Source: + +Files: .gitignore + Makefile.am + README.md + autogen.sh + config.h + config.h.in + configure.ac + plugins/Makefile.am +Copyright: __NO_COPYRIGHT_NOR_LICENSE__ +License: __NO_COPYRIGHT_NOR_LICENSE__ + +Files: Makefile.in + aclocal.m4 + compile + config.guess + config.sub + configure + depcomp + install-sh + libtool + ltmain.sh + m4/libtool.m4 + m4/ltoptions.m4 + m4/ltsugar.m4 + m4/ltversion.m4 + m4/lt~obsolete.m4 + missing + plugins/Makefile.in +Copyright: 1992-2018 Free Software Foundation, Inc. + 1994 X Consortium +License: __AUTO_PERMISSIVE__ + Autogenerated files with permissive licenses. + +Files: autom4te.cache/output.0 + autom4te.cache/output.1 + autom4te.cache/output.2 +Copyright: 1992-2012 Free Software Foundation, Inc. +License: PERMISSIVE + This configure script is free software; the Free Software Foundation + gives unlimited permission to copy, distribute and modify it. + +Files: Makefile + plugins/Makefile +Copyright: 1994-2017 Free Software Foundation, Inc. +License: PERMISSIVE + This Makefile.in is free software; the Free Software Foundation + gives unlimited permission to copy and/or distribute it, + with or without modifications, as long as this notice is preserved. + . + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY, to the extent permitted by law; without + even the implied warranty of MERCHANTABILITY or FITNESS FOR A + PARTICULAR PURPOSE. + +Files: plugins/gstperf.h + plugins/gstperf.c +Copyright: 2019 RidgeRun, LLC (http://www.ridgerun.com) +License: LGPL-2.0+ + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + . + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + . + You should have received a copy of the GNU Library General Public + License along with this library; if not, write to the + Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, + Boston, MA 02110-1301, USA. + . + On Debian systems, the complete text of the GNU Library General Public License + Version 2 can be found in `/usr/share/common-licenses/LGPL-2'. + +Files: debian/rules +Copyright: 2020 D3 Engineering, LLC (http://www.d3engineering.com) +License: LGPL-2.0+ + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + . + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + . + You should have received a copy of the GNU Library General Public + License along with this library; if not, write to the + Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, + Boston, MA 02110-1301, USA. + . + On Debian systems, the complete text of the GNU Library General Public License + Version 2 can be found in `/usr/share/common-licenses/LGPL-2'. diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..4c2254c --- /dev/null +++ b/debian/rules @@ -0,0 +1,9 @@ +#!/usr/bin/make -f +# Copyright (c) 2020 D3 Engineering, LLC +# By Christopher White +# SPDX-License-Identifier: LGPL-2.0-or-later + +export DH_ALWAYS_EXCLUDE=*.a:*.la + +%: + dh $@ diff --git a/debian/source/format b/debian/source/format new file mode 100644 index 0000000..d3827e7 --- /dev/null +++ b/debian/source/format @@ -0,0 +1 @@ +1.0 diff --git a/plugins/gstperf.c b/plugins/gstperf.c index 88070d6..9c36029 100644 --- a/plugins/gstperf.c +++ b/plugins/gstperf.c @@ -1,5 +1,5 @@ /* GStreamer - * Copyright (C) 2019 RidgeRun, LLC (http://www.ridgerun.com) + * Copyright (C) 2013-2020 RidgeRun, LLC (http://www.ridgerun.com) * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public @@ -30,6 +30,13 @@ #include "gstperf.h" +#ifdef IS_MACOSX +# include +# include +# include +# include +#endif + #include #include @@ -50,12 +57,24 @@ GST_STATIC_PAD_TEMPLATE ("sink", GST_DEBUG_CATEGORY_STATIC (gst_perf_debug); #define GST_CAT_DEFAULT gst_perf_debug -#define DEFAULT_PRINT_ARM_LOAD FALSE +#define DEFAULT_PRINT_CPU_LOAD FALSE +#define DEFAULT_BITRATE_WINDOW_SIZE 0 +#define DEFAULT_BITRATE_INTERVAL 1000 enum { PROP_0, - PROP_PRINT_ARM_LOAD + PROP_PRINT_ARM_LOAD, + PROP_PRINT_CPU_LOAD, + PROP_BITRATE_WINDOW_SIZE, + PROP_BITRATE_INTERVAL +}; + +/* GstPerf signals and args */ +enum +{ + SIGNAL_ON_BITRATE, + LAST_SIGNAL }; struct _GstPerf @@ -72,14 +91,24 @@ struct _GstPerf guint64 frame_count_total; gdouble bps; + gdouble mean_bps; + gdouble *bps_window_buffer; + guint32 bps_window_size; + guint32 bps_window_buffer_current; guint64 byte_count; guint64 byte_count_total; + guint bps_interval; + guint bps_running_interval; + GMutex byte_count_mutex; + GMutex bps_mutex; + GMutex mean_bps_mutex; + guint bps_source_id; guint32 prev_cpu_total; guint32 prev_cpu_idle; /* Properties */ - gboolean print_arm_load; + gboolean print_cpu_load; }; struct _GstPerfClass @@ -96,6 +125,8 @@ G_DEFINE_TYPE (GstPerf, gst_perf, GST_TYPE_BASE_TRANSFORM); #define GST_PERF_BITS_PER_BYTE 8 +#define GST_PERF_MS_PER_S 1000.0 + /* prototypes */ static void gst_perf_set_property (GObject * object, guint property_id, const GValue * value, GParamSpec * pspec); @@ -111,6 +142,15 @@ static void gst_perf_reset (GstPerf * perf); static void gst_perf_clear (GstPerf * perf); static gdouble gst_perf_update_average (guint64 count, gdouble current, gdouble old); +static double +gst_perf_update_moving_average (guint64 window_size, gdouble old_average, + gdouble new_sample, gdouble old_sample); +static gboolean gst_perf_update_bps (void *data); +static gboolean gst_perf_cpu_get_load (GstPerf * perf, guint32 * cpu_load); +static guint32 gst_perf_compute_cpu (GstPerf * perf, guint32 idle, + guint32 total); + +static guint gst_perf_signals[LAST_SIGNAL] = { 0 }; static void gst_perf_class_init (GstPerfClass * klass) @@ -124,8 +164,30 @@ gst_perf_class_init (GstPerfClass * klass) gobject_class->get_property = gst_perf_get_property; g_object_class_install_property (gobject_class, PROP_PRINT_ARM_LOAD, - g_param_spec_boolean ("print-arm-load", "Print arm load", - "Print the CPU load info", DEFAULT_PRINT_ARM_LOAD, G_PARAM_WRITABLE)); + g_param_spec_boolean ("print-arm-load", "Print arm load (deprecated)", + "(deprecated) Print the CPU load info. Use print-cpu-load instead.", + DEFAULT_PRINT_CPU_LOAD, G_PARAM_WRITABLE)); + + g_object_class_install_property (gobject_class, PROP_PRINT_CPU_LOAD, + g_param_spec_boolean ("print-cpu-load", "Print CPU load", + "Print the CPU load info.", DEFAULT_PRINT_CPU_LOAD, + G_PARAM_WRITABLE)); + + g_object_class_install_property (gobject_class, PROP_BITRATE_WINDOW_SIZE, + g_param_spec_uint ("bitrate-window-size", + "Bitrate moving average window size", + "Number of samples used for bitrate moving average window size, 0 is all samples", + 0, G_MAXINT, DEFAULT_BITRATE_WINDOW_SIZE, G_PARAM_WRITABLE)); + + g_object_class_install_property (gobject_class, PROP_BITRATE_INTERVAL, + g_param_spec_uint ("bitrate-interval", + "Interval between bitrate calculation in ms", + "Interval between two calculations in ms, this will run even when no buffers are received", + 0, G_MAXINT, DEFAULT_BITRATE_INTERVAL, G_PARAM_WRITABLE)); + + gst_perf_signals[SIGNAL_ON_BITRATE] = + g_signal_new ("on-bitrate", G_TYPE_FROM_CLASS (klass), + G_SIGNAL_RUN_LAST, 0, NULL, NULL, NULL, G_TYPE_NONE, 1, G_TYPE_DOUBLE); base_transform_class->start = GST_DEBUG_FUNCPTR (gst_perf_start); base_transform_class->stop = GST_DEBUG_FUNCPTR (gst_perf_stop); @@ -148,7 +210,15 @@ gst_perf_init (GstPerf * perf) { gst_perf_clear (perf); - perf->print_arm_load = DEFAULT_PRINT_ARM_LOAD; + perf->print_cpu_load = DEFAULT_PRINT_CPU_LOAD; + perf->bps_window_size = DEFAULT_BITRATE_WINDOW_SIZE; + perf->bps_interval = DEFAULT_BITRATE_INTERVAL; + perf->bps_running_interval = DEFAULT_BITRATE_INTERVAL; + perf->bps_window_buffer_current = 0; + + g_mutex_init (&perf->byte_count_mutex); + g_mutex_init (&perf->bps_mutex); + g_mutex_init (&perf->mean_bps_mutex); gst_base_transform_set_gap_aware (GST_BASE_TRANSFORM_CAST (perf), TRUE); gst_base_transform_set_passthrough (GST_BASE_TRANSFORM_CAST (perf), TRUE); @@ -162,8 +232,21 @@ gst_perf_set_property (GObject * object, guint property_id, switch (property_id) { case PROP_PRINT_ARM_LOAD: + GST_WARNING_OBJECT (object, + "print-arm-load is deprecated, use print-cpu-load instead!"); + case PROP_PRINT_CPU_LOAD: GST_OBJECT_LOCK (perf); - perf->print_arm_load = g_value_get_boolean (value); + perf->print_cpu_load = g_value_get_boolean (value); + GST_OBJECT_UNLOCK (perf); + break; + case PROP_BITRATE_WINDOW_SIZE: + GST_OBJECT_LOCK (perf); + perf->bps_window_size = g_value_get_uint (value); + GST_OBJECT_UNLOCK (perf); + break; + case PROP_BITRATE_INTERVAL: + GST_OBJECT_LOCK (perf); + perf->bps_interval = g_value_get_uint (value); GST_OBJECT_UNLOCK (perf); break; default: @@ -176,15 +259,91 @@ void gst_perf_get_property (GObject * object, guint property_id, GValue * value, GParamSpec * pspec) { - /* GstPerf *perf = GST_PERF (object); */ + GstPerf *perf = GST_PERF (object); switch (property_id) { + case PROP_PRINT_ARM_LOAD: + GST_WARNING_OBJECT (object, + "print-arm-load is deprecated, use print-cpu-load instead!"); + case PROP_PRINT_CPU_LOAD: + GST_OBJECT_LOCK (perf); + g_value_set_boolean (value, perf->print_cpu_load); + GST_OBJECT_UNLOCK (perf); + break; + case PROP_BITRATE_WINDOW_SIZE: + GST_OBJECT_LOCK (perf); + g_value_set_uint (value, perf->bps_window_size); + GST_OBJECT_UNLOCK (perf); + break; + case PROP_BITRATE_INTERVAL: + GST_OBJECT_LOCK (perf); + g_value_set_uint (value, perf->bps_interval); + GST_OBJECT_UNLOCK (perf); + break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); break; } } +static gboolean +gst_perf_update_bps (void *data) +{ + guint buffer_current_idx; + GstPerf *perf; + guint byte_count; + gdouble bps, mean_bps; + + g_return_val_if_fail (data, FALSE); + + perf = GST_PERF (data); + + g_mutex_lock (&perf->byte_count_mutex); + byte_count = perf->byte_count; + perf->byte_count = G_GUINT64_CONSTANT (0); + g_mutex_unlock (&perf->byte_count_mutex); + + g_mutex_lock (&perf->mean_bps_mutex); + mean_bps = perf->mean_bps; + g_mutex_unlock (&perf->mean_bps_mutex); + + /* Calculate bits per second */ + bps = + byte_count * GST_PERF_BITS_PER_BYTE / (perf->bps_running_interval / + GST_PERF_MS_PER_S); + + /* Update bps average */ + if (!perf->bps_window_size) { + mean_bps = gst_perf_update_average (perf->byte_count_total, bps, mean_bps); + } else { + /* + * Moving average uses a circular buffer, get index for next value which + * is the oldest sample, this is the same as the value were the new sample + * is to be stored + */ + buffer_current_idx = (perf->byte_count_total) % perf->bps_window_size; + + mean_bps = + gst_perf_update_moving_average (perf->bps_window_size, mean_bps, + bps, perf->bps_window_buffer[buffer_current_idx]); + + perf->bps_window_buffer[buffer_current_idx] = bps; + } + g_mutex_lock (&perf->mean_bps_mutex); + perf->mean_bps = mean_bps; + g_mutex_unlock (&perf->mean_bps_mutex); + + g_mutex_lock (&perf->bps_mutex); + perf->bps = bps; + g_mutex_unlock (&perf->bps_mutex); + + perf->byte_count_total++; + + g_signal_emit_by_name (perf, "on-bitrate", mean_bps); + + return TRUE; +} + static gboolean gst_perf_start (GstBaseTransform * trans) { @@ -192,6 +351,22 @@ gst_perf_start (GstBaseTransform * trans) gst_perf_clear (perf); + /* If window size is different from all samples allocate the needed memory */ + if (perf->bps_window_size) { + perf->bps_window_buffer = + g_malloc0 ((perf->bps_window_size) * sizeof (gdouble)); + + if (!perf->bps_window_buffer) { + GST_ERROR_OBJECT (perf, "Unable to allocate memory"); + return FALSE; + } + } + + perf->bps_running_interval = perf->bps_interval; + + perf->bps_source_id = + g_timeout_add (perf->bps_interval, gst_perf_update_bps, perf); + perf->error = g_error_new (GST_CORE_ERROR, GST_CORE_ERROR_TAG, "Performance Information"); return TRUE; @@ -204,22 +379,69 @@ gst_perf_stop (GstBaseTransform * trans) gst_perf_clear (perf); + g_free (perf->bps_window_buffer); + + g_source_remove (perf->bps_source_id); + if (perf->error) g_error_free (perf->error); return TRUE; } +static guint32 +gst_perf_compute_cpu (GstPerf * self, guint32 current_idle, + guint32 current_total) +{ + guint32 busy = 0; + guint32 idle = 0; + guint32 total = 0; + + g_return_val_if_fail (self, -1); + + /* Calculate the CPU usage since last time we checked */ + idle = current_idle - self->prev_cpu_idle; + total = current_total - self->prev_cpu_total; + + /* Update the total and idle CPU for the next check */ + self->prev_cpu_total = current_total; + self->prev_cpu_idle = current_idle; + + /* Avoid a divison by zero */ + if (0 == total) { + return 0; + } + + /* - CPU usage is the fraction of time the processor spent busy: + * [0.0, 1.0]. + * + * - We want to express this as a percentage [0% - 100%]. + * + * - We want to avoid, when possible, using floating + * point operations (some SoC still don't have a FP unit). + * + * - Scaling to 1000 allows us round (nearest interger) by summing + * 5 and then scaling down back to 100 by dividing by + * 10. Othersise we would've lost the decimals due to integer + * truncating. + */ + busy = total - idle; + return (1000 * busy / total + 5) / 10; +} + +#ifdef IS_LINUX static gboolean gst_perf_cpu_get_load (GstPerf * perf, guint32 * cpu_load) { gboolean cpu_load_found = FALSE; guint32 user, nice, sys, idle, iowait, irq, softirq, steal; guint32 total = 0; - guint32 diff_total, diff_idle; gchar name[4]; FILE *fp; + g_return_val_if_fail (perf, FALSE); + g_return_val_if_fail (cpu_load, FALSE); + /* Default value in case of failure */ *cpu_load = -1; @@ -250,18 +472,43 @@ gst_perf_cpu_get_load (GstPerf * perf, guint32 * cpu_load) /*Calculate the total CPU time */ total = user + nice + sys + idle + iowait + irq + softirq + steal; - /*Calculate the CPU usage since last time we checked */ - diff_idle = idle - perf->prev_cpu_idle; - diff_total = total - perf->prev_cpu_total; - if (diff_total) { - /*Get a rounded result */ - *cpu_load = (1000 * (diff_total - diff_idle) / diff_total + 5) / 10; + + *cpu_load = gst_perf_compute_cpu (perf, idle, total); + + return TRUE; + +cpu_failed: + GST_ERROR_OBJECT (perf, "Failed to get the CPU load"); + return FALSE; +} + +#elif IS_MACOSX +static gboolean +gst_perf_cpu_get_load (GstPerf * perf, guint32 * cpu_load) +{ + guint32 idle = 0; + guint32 total = 0; + host_cpu_load_info_data_t cpuinfo = { 0 }; + mach_msg_type_number_t count = HOST_CPU_LOAD_INFO_COUNT; + + g_return_val_if_fail (perf, FALSE); + g_return_val_if_fail (cpu_load, FALSE); + + /* Default value in case of failure */ + *cpu_load = -1; + + if (host_statistics (mach_host_self (), HOST_CPU_LOAD_INFO, + (host_info_t) & cpuinfo, &count) == KERN_SUCCESS) { + for (int i = 0; i < CPU_STATE_MAX; i++) { + total += cpuinfo.cpu_ticks[i]; + } + idle = cpuinfo.cpu_ticks[CPU_STATE_IDLE]; } else { - *cpu_load = 0; + goto cpu_failed; } - /*Remember the total and idle CPU for the next check */ - perf->prev_cpu_total = total; - perf->prev_cpu_idle = idle; + + *cpu_load = gst_perf_compute_cpu (perf, idle, total); + return TRUE; cpu_failed: @@ -269,6 +516,20 @@ gst_perf_cpu_get_load (GstPerf * perf, guint32 * cpu_load) return FALSE; } +#else /* Unknown OS */ +static gboolean +gst_perf_cpu_get_load (GstPerf * perf, guint32 * cpu_load) +{ + g_return_val_if_fail (perf, FALSE); + g_return_val_if_fail (cpu_load, FALSE); + + *cpu_load = -1; + + /* Not really an error, we just don't know how to measure CPU on this OS */ + return TRUE; +} +#endif + static GstFlowReturn gst_perf_transform_ip (GstBaseTransform * trans, GstBuffer * buf) { @@ -278,10 +539,11 @@ gst_perf_transform_ip (GstBaseTransform * trans, GstBuffer * buf) if (!GST_CLOCK_TIME_IS_VALID (perf->prev_timestamp) || (GST_CLOCK_TIME_IS_VALID (time) && diff >= GST_SECOND)) { - gdouble time_factor, fps, bps; + gdouble time_factor, fps; guint idx; gchar info[GST_PERF_MSG_MAX_SIZE]; - gboolean print_arm_load; + gboolean print_cpu_load; + gdouble bps, mean_bps; time_factor = 1.0 * diff / GST_SECOND; @@ -293,29 +555,29 @@ gst_perf_transform_ip (GstBaseTransform * trans, GstBuffer * buf) gst_perf_update_average (perf->frame_count_total, fps, perf->fps); perf->frame_count_total++; - /*Calculate bits per second */ - bps = perf->byte_count * GST_PERF_BITS_PER_BYTE / time_factor; + g_mutex_lock (&perf->bps_mutex); + bps = perf->bps; + g_mutex_unlock (&perf->bps_mutex); - /*Update bps average */ - perf->bps = - gst_perf_update_average (perf->byte_count_total, bps, perf->bps); - perf->byte_count_total++; + g_mutex_lock (&perf->mean_bps_mutex); + mean_bps = perf->mean_bps; + g_mutex_unlock (&perf->mean_bps_mutex); idx = g_snprintf (info, GST_PERF_MSG_MAX_SIZE, "perf: %s; timestamp: %" GST_TIME_FORMAT "; " "bps: %0.03f; mean_bps: %0.03f; " "fps: %0.03f; mean_fps: %0.03f", - GST_OBJECT_NAME (perf), GST_TIME_ARGS (time), bps, perf->bps, fps, - perf->fps); + GST_OBJECT_NAME (perf), GST_TIME_ARGS (time), bps, mean_bps, + fps, perf->fps); gst_perf_reset (perf); perf->prev_timestamp = time; GST_OBJECT_LOCK (perf); - print_arm_load = perf->print_arm_load; + print_cpu_load = perf->print_cpu_load; GST_OBJECT_UNLOCK (perf); - if (print_arm_load) { + if (print_cpu_load) { guint32 cpu_load; gst_perf_cpu_get_load (perf, &cpu_load); idx = g_snprintf (&info[idx], GST_PERF_MSG_MAX_SIZE - idx, @@ -326,10 +588,14 @@ gst_perf_transform_ip (GstBaseTransform * trans, GstBuffer * buf) (GstElement *) perf, gst_message_new_info ((GstObject *) perf, perf->error, (const gchar *) info)); + + GST_INFO_OBJECT (perf, "%s", info); } perf->frame_count++; + g_mutex_lock (&perf->byte_count_mutex); perf->byte_count += gst_buffer_get_size (buf); + g_mutex_unlock (&perf->byte_count_mutex); return GST_FLOW_OK; } @@ -346,13 +612,25 @@ gst_perf_update_average (guint64 count, gdouble current, gdouble old) return ret; } +static gdouble +gst_perf_update_moving_average (guint64 window_size, gdouble old_average, + gdouble new_sample, gdouble old_sample) +{ + gdouble ret = 0; + + if (window_size != 0) { + ret = (old_average * window_size - old_sample + new_sample) / window_size; + } + + return ret; +} + static void gst_perf_reset (GstPerf * perf) { g_return_if_fail (perf); perf->frame_count = 0; - perf->byte_count = G_GUINT64_CONSTANT (0); } static void @@ -365,8 +643,9 @@ gst_perf_clear (GstPerf * perf) perf->fps = 0.0; perf->frame_count_total = G_GUINT64_CONSTANT (0); - perf->bps = 0.0; + perf->mean_bps = 0.0; perf->byte_count_total = G_GUINT64_CONSTANT (0); + perf->byte_count = G_GUINT64_CONSTANT (0); perf->prev_timestamp = GST_CLOCK_TIME_NONE; perf->prev_cpu_total = 0; diff --git a/plugins/gstperf.h b/plugins/gstperf.h index a99f3e7..096b01b 100644 --- a/plugins/gstperf.h +++ b/plugins/gstperf.h @@ -1,5 +1,5 @@ /* GStreamer - * Copyright (C) 2019 RidgeRun, LLC (http://www.ridgerun.com) + * Copyright (C) 2013-2020 RidgeRun, LLC (http://www.ridgerun.com) * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public