diff options
author | Bob Ham <bob.ham@collabora.com> | 2015-01-21 09:41:42 (GMT) |
---|---|---|
committer | Bob Ham <bob.ham@collabora.com> | 2015-01-21 09:41:42 (GMT) |
commit | 66884583d01a5cce0c3e94b40289d3eef8bb2b7d (patch) | |
tree | 236129c5e185c31fcd241e1438b890fe02158258 | |
download | gst-sdr-j-fm-66884583d01a5cce0c3e94b40289d3eef8bb2b7d.tar.gz gst-sdr-j-fm-66884583d01a5cce0c3e94b40289d3eef8bb2b7d.tar.xz |
Initial check-in of gst-sdr-j-fm boilerplate code
-rw-r--r-- | AUTHORS | 2 | ||||
-rw-r--r-- | COPYING | 339 | ||||
-rw-r--r-- | ChangeLog | 0 | ||||
-rw-r--r-- | Makefile.am | 3 | ||||
-rw-r--r-- | NEWS | 1 | ||||
-rw-r--r-- | README | 23 | ||||
-rw-r--r-- | REQUIREMENTS | 10 | ||||
-rwxr-xr-x | autogen.sh | 18 | ||||
-rw-r--r-- | configure.ac | 93 | ||||
-rw-r--r-- | src/Makefile.am | 12 | ||||
-rw-r--r-- | src/gstsdrjfm.c | 44 | ||||
-rw-r--r-- | src/gstsdrjfmsrc.c | 235 | ||||
-rw-r--r-- | src/gstsdrjfmsrc.h | 55 | ||||
-rw-r--r-- | tests/Makefile.am | 9 | ||||
-rw-r--r-- | tests/tune.c | 204 | ||||
-rwxr-xr-x | tests/tune.sh | 4 |
16 files changed, 1052 insertions, 0 deletions
@@ -0,0 +1,2 @@ +Original SDR-J software by Jan van Katwijk <j.vankatwijk@gmail.com> +GST element by Bob Ham <bob.ham@collabora.com> @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 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. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, 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 software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, 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 redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +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 give any other recipients of the Program a copy of this License +along with the Program. + +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 Program or any portion +of it, thus forming a work based on the Program, 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) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +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 Program, 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 Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) 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; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, 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 executable. 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. + +If distribution of executable or 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 counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program 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. + + 5. 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 Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program 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. + + 7. 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 Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program 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 Program. + +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. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program 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. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 Program +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 Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, 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 + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. 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 PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), 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 Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; 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. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/ChangeLog diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..bb736fc --- /dev/null +++ b/Makefile.am @@ -0,0 +1,3 @@ +SUBDIRS = src tests + +EXTRA_DIST = autogen.sh @@ -0,0 +1 @@ +Initial release - working FM radio @@ -0,0 +1,23 @@ +gst-sdr-j-fm is a GStreamer wrapper/fork around the SDR-J FM receiver. +It provides ability to playback FM radio from signal acquires from devices +supported by the RTL SDR projects. Demodulation is done in software re-using +code initially found in the SDR-J software. + +To use it, you need GStreamer 1.0. + +Install the GStreamer 1.0 dev packages, then just build and install this module. + +For example, again on Raspbian: + +./autogen --prefix=/usr +make +sudo make install + +Then, you can try out the playing fm radio: + +gst-launch-1.0 playbin uri=fm:///99.9 + +gst-inspect-1.0 sdrjfmsrc to get an idea of the properties that have been +implemented. + +See the REQUIREMENTS file for the full list of build requirements. diff --git a/REQUIREMENTS b/REQUIREMENTS new file mode 100644 index 0000000..4ddfa52 --- /dev/null +++ b/REQUIREMENTS @@ -0,0 +1,10 @@ +gst-sdr-j-fm requires: + + - autoconf + - automake + - libtool + - libgstreamer1.0-dev + - libgstreamer-plugins-base1.0-dev + - librtlsdr-dev + +Packge names may vary between distros. diff --git a/autogen.sh b/autogen.sh new file mode 100755 index 0000000..9df38d3 --- /dev/null +++ b/autogen.sh @@ -0,0 +1,18 @@ +#!/bin/sh +# you can either set the environment variables AUTOCONF, AUTOHEADER, AUTOMAKE, +# ACLOCAL, AUTOPOINT and/or LIBTOOLIZE to the right versions, or leave them +# unset and get the defaults + +autoreconf --verbose --force --install --make || { + echo 'autogen.sh failed'; + exit 1; +} + +./configure || { + echo 'configure failed'; + exit 1; +} + +echo +echo "Now type 'make' to compile this module." +echo diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..6ab1546 --- /dev/null +++ b/configure.ac @@ -0,0 +1,93 @@ +dnl required version of autoconf +AC_PREREQ([2.53]) + +AC_INIT([gstsdrjfm],[1.0.0]) + +dnl required versions of gstreamer and plugins-base +GST_REQUIRED=1.0.0 +GSTPB_REQUIRED=1.0.0 + +AC_CONFIG_SRCDIR([src/gstsdrjfm.c]) +AC_CONFIG_HEADERS([config.h]) + +dnl required version of automake +AM_INIT_AUTOMAKE([-Wno-portability 1.11 no-dist-gzip dist-xz tar-ustar subdir-objects]) + +dnl enable mainainer mode by default +AM_MAINTAINER_MODE([enable]) + +dnl Pretty Printing +m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])], + [AM_DEFAULT_VERBOSITY=1 + AC_SUBST(AM_DEFAULT_VERBOSITY)]) + +dnl check for tools (compiler etc.) +AC_PROG_CC +AC_PROG_CXX + +dnl required version of libtool +LT_PREREQ([2.2.6]) +LT_INIT + +dnl give error and exit if we don't have pkgconfig +AC_CHECK_PROG(HAVE_PKGCONFIG, pkg-config, [ ], [ + AC_MSG_ERROR([You need to have pkg-config installed!]) +]) +AC_PATH_PROG(GLIB_MKENUMS, glib-mkenums) + +dnl gstreamer deps +PKG_CHECK_MODULES(GST, [ + gstreamer-1.0 >= $GST_REQUIRED + gstreamer-base-1.0 >= $GST_REQUIRED + gstreamer-audio-1.0 >= $GSTPB_REQUIRED +], [ + AC_SUBST(GST_CFLAGS) + AC_SUBST(GST_LIBS) +], [ + AC_MSG_ERROR([ + You need to install or upgrade the GStreamer development + packages on your system. On debian-based systems these are + libgstreamer1.0-dev and libgstreamer-plugins-base1.0-dev. + on RPM-based systems gstreamer1.0-devel, libgstreamer1.0-devel + or similar. The minimum version required is $GST_REQUIRED. + ]) +]) + +dnl need libstlsdr to capture +PKG_CHECK_MODULES(RS, [ + librtlsdr +], [ + AC_SUBST(RS_CFLAGS) + AC_SUBST(RS_LIBS) +], [ + AC_MSG_ERROR([ + You need to install development package of RTL SDR library. + ]) +]) + +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" +CFLAGS="$CFLAGS -Wall" +AC_COMPILE_IFELSE([AC_LANG_PROGRAM([ ], [ ])], [ + GST_CFLAGS="$GST_CFLAGS -Wall" + AC_MSG_RESULT([yes]) +], [ + AC_MSG_RESULT([no]) +]) + +dnl set the plugindir where plugins should be installed (for src/Makefile.am) +if test "x${prefix}" = "x$HOME"; then + plugindir="$HOME/.gstreamer-1.0/plugins" +else + plugindir="`pkg-config gstreamer-1.0 --variable pluginsdir`" +fi +AC_SUBST(plugindir) + +dnl set proper LDFLAGS for plugins +GST_PLUGIN_LDFLAGS='-module -avoid-version -export-symbols-regex [_]*\(gst_\|Gst\|GST_\).*' +AC_SUBST(GST_PLUGIN_LDFLAGS) + +AC_CONFIG_FILES([Makefile src/Makefile tests/Makefile]) +AC_OUTPUT + diff --git a/src/Makefile.am b/src/Makefile.am new file mode 100644 index 0000000..0d5d938 --- /dev/null +++ b/src/Makefile.am @@ -0,0 +1,12 @@ +plugin_LTLIBRARIES = libgstsdrjfm.la + +libgstsdrjfm_la_SOURCES = gstsdrjfm.c \ + gstsdrjfmsrc.c + +libgstsdrjfm_la_CFLAGS = $(GST_CFLAGS) $(RS_CFLAGS) +libgstsdrjfm_la_LIBADD = $(GST_LIBS) $(RS_LIBS) +libgstsdrjfm_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS) +libgstsdrjfm_la_LIBTOOLFLAGS = $(GST_PLUGIN_LIBTOOLFLAGS) + +noinst_HEADERS = gstsdrjfmsrc.h + diff --git a/src/gstsdrjfm.c b/src/gstsdrjfm.c new file mode 100644 index 0000000..3fa6f3e --- /dev/null +++ b/src/gstsdrjfm.c @@ -0,0 +1,44 @@ +/* GStreamer + * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu> + * + * 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. + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include "gstsdrjfmsrc.h" + +GST_DEBUG_CATEGORY (sdrjfm_debug); + +static gboolean +plugin_init (GstPlugin * plugin) +{ + if (!gst_element_register (plugin, "sdrjfmsrc", GST_RANK_SECONDARY, + GST_TYPE_SDRJFM_SRC)) + return FALSE; + + GST_DEBUG_CATEGORY_INIT (sdrjfm_debug, "sdrjfm", 0, "SDR-J FM plugin"); + + return TRUE; +} + +GST_PLUGIN_DEFINE (GST_VERSION_MAJOR, + GST_VERSION_MINOR, + sdrjfm, + "SDR-J FM support for GStreamer", + plugin_init, VERSION, "GPL", "sdrjfm", "http://www.collabora.com"); diff --git a/src/gstsdrjfmsrc.c b/src/gstsdrjfmsrc.c new file mode 100644 index 0000000..6a76b6d --- /dev/null +++ b/src/gstsdrjfmsrc.c @@ -0,0 +1,235 @@ + /* GStreamer + * Copyright (C) 2014, Collabora Ltd. <info@collabora.com> + * + * gstsdrjfmsrc.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 St, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + +/* Note, the plugin code is left LPGLv2, so this code can be copy pasted to + * form other FM sources later if it makes sense. But the plugin will remain + * GPLv2 since the backend is from GPLv2 program. + */ + +/** + * SECTION:element-sdrjfmsrc + * + * This element lets capture from RTL SDR supported radio card. + * + * <refsect2> + * <title>Example pipelines</title> + * |[ + * gst-launch-1.0 -v sdrjfmsrc frequency=97700000 ! pulsesink + * ]| will playback live FM radio channel 97.7. + * </refsect2> + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <string.h> + +#include "gstsdrjfmsrc.h" + +GST_DEBUG_CATEGORY_EXTERN (sdrjfm_debug); +#define GST_CAT_DEFAULT sdrjfm_debug + +#define DEFAULT_FREQUENCY 96700 + +enum +{ + PROP_0, + PROP_FREQUENCY +}; + +/* signals and args */ +enum +{ +}; + +#define gst_sdrjfm_src_parent_class parent_class +G_DEFINE_TYPE (GstSdrjfmSrc, gst_sdrjfm_src, GST_TYPE_AUDIO_SRC); + +static GstStaticPadTemplate sdrjfmsrc_src_factory = GST_STATIC_PAD_TEMPLATE ("src", + GST_PAD_SRC, + GST_PAD_ALWAYS, + GST_STATIC_CAPS ("audio/x-raw, " + "format = (string) " GST_AUDIO_NE(S16) ", " + "layout = (string) interleaved, " + "rate = (int) 44100, " + "channels = (int) 2; ") + ); + +static guint signals[LAST_SIGNAL] = { 0 }; + +static void +gst_sdrjfm_src_set_frequency (GstSdrjfmSrc *self, gint frequency) +{ +} + +static gint +gst_sdrjfm_src_get_frequency (GstSdrjfmSrc *self) +{ +} + +static void + gst_sdrjfm_src_set_property (GObject * object, guint prop_id, + const GValue * value, GParamSpec * pspec) +{ + GstSdrjfmSrc *self = GST_SDRJFM_SRC (object); + + GST_OBJECT_LOCK (self); + + switch (prop_id) { + case PROP_FREQUENCY: + gst_sdrjfm_src_set_frequency (self, g_value_get_int (value)); + break; + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + break; + } + + GST_OBJECT_UNLOCK (self); +} + +static void +gst_sdrjfm_src_get_property (GObject * object, guint prop_id, + GValue * value, GParamSpec * pspec) +{ + GstSdrjfmSrc *self = GST_SDRJFM_SRC (object); + + GST_OBJECT_LOCK (self); + + switch (prop_id) { + case PROP_FREQUENCY: + g_value_set_int (value, gst_sdrjfm_src_get_frequency (self)); + break; + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + break; + } + + GST_OBJECT_UNLOCK (self); +} + +static gboolean +gst_sdrjfm_src_open (GstAudioSrc * asrc) +{ + GstSdrjfmSrc *self = GST_SDRJFM_SRC (asrc); +} + +static gboolean +gst_sdrjfm_src_close (GstAudioSrc * asrc) +{ + GstSdrjfmSrc *self = GST_SDRJFM_SRC (asrc); +} + +static gboolean +gst_sdrjfm_src_prepare (GstAudioSrc * asrc, GstAudioRingBufferSpec * spec) +{ + GstSdrjfmSrc *self = GST_SDRJFM_SRC (asrc); +} + +static gboolean +gst_sdrjfm_src_unprepare (GstAudioSrc * asrc) +{ + GstSdrjfmSrc *self = GST_SDRJFM_SRC (asrc); +} + +static guint +gst_sdrjfm_src_read (GstAudioSrc * asrc, gpointer data, guint length, + GstClockTime * timestamp) +{ + GstSdrjfmSrc *self = GST_SDRJFM_SRC (asrc); +} + +static guint +gst_sdrjfm_src_delay (GstAudioSrc * asrc) +{ + GstSdrjfmSrc *self = GST_SDRJFM_SRC (asrc); +} + +static void +gst_sdrjfm_src_reset (GstAudioSrc * asrc) +{ + GST_FIXME_OBJECT (asrc, "not implemented"); +} + +static void +gst_sdrjfm_src_dispose (GObject * object) +{ + G_OBJECT_CLASS (parent_class)->dispose (object); +} + +static void +gst_sdrjfm_src_finalize (GstSdrjfmSrc * self) +{ + G_OBJECT_CLASS (parent_class)->finalize (G_OBJECT (self)); +} + +static void +gst_sdrjfm_src_init (GstSdrjfmSrc * self) +{ + GstAudioBaseSrc *basrc = GST_AUDIO_BASE_SRC (self); + + self->frequency = DEFAULT_FREQUENCY; + + basrc->latency_time = 132000; /* base on buffer size */ + basrc->buffer_time = 8 * basrc->latency_time; + + gst_audio_base_src_set_provide_clock (basrc, FALSE); +} + +static void +gst_sdrjfm_src_class_init (GstSdrjfmSrcClass * klass) +{ + GObjectClass *gobject_class; + GstElementClass *gstelement_class; + GstAudioSrcClass *gstaudiosrc_class; + + gobject_class = (GObjectClass *) klass; + gstelement_class = (GstElementClass *) klass; + gstaudiosrc_class = (GstAudioSrcClass *) klass; + + gobject_class->dispose = gst_sdrjfm_src_dispose; + gobject_class->finalize = (GObjectFinalizeFunc) gst_sdrjfm_src_finalize; + gobject_class->get_property = gst_sdrjfm_src_get_property; + gobject_class->set_property = gst_sdrjfm_src_set_property; + + + gstaudiosrc_class->open = GST_DEBUG_FUNCPTR (gst_sdrjfm_src_open); + gstaudiosrc_class->prepare = GST_DEBUG_FUNCPTR (gst_sdrjfm_src_prepare); + gstaudiosrc_class->unprepare = GST_DEBUG_FUNCPTR (gst_sdrjfm_src_unprepare); + gstaudiosrc_class->close = GST_DEBUG_FUNCPTR (gst_sdrjfm_src_close); + gstaudiosrc_class->read = GST_DEBUG_FUNCPTR (gst_sdrjfm_src_read); + gstaudiosrc_class->delay = GST_DEBUG_FUNCPTR (gst_sdrjfm_src_delay); + gstaudiosrc_class->reset = GST_DEBUG_FUNCPTR (gst_sdrjfm_src_reset); + + g_object_class_install_property (gobject_class, PROP_FREQUENCY, + g_param_spec_int ("frequency", "Frequency", + "Frequency to receive", 0, G_MAXINT, DEFAULT_FREQUENCY, + G_PARAM_READWRITE | GST_PARAM_MUTABLE_PLAYING | G_PARAM_STATIC_STRINGS)); + + gst_element_class_set_static_metadata (gstelement_class, "FM Radio Source (SDR-J)", + "Source/Audio", + "Capture and demodulate FM radio", + "Collabora <info@collabora.com>"); + + gst_element_class_add_pad_template (gstelement_class, + gst_static_pad_template_get (&sdrjfmsrc_src_factory)); +} + diff --git a/src/gstsdrjfmsrc.h b/src/gstsdrjfmsrc.h new file mode 100644 index 0000000..83340ad --- /dev/null +++ b/src/gstsdrjfmsrc.h @@ -0,0 +1,55 @@ +/* GStreamer + * Copyright (C) Collabora Ltd. <info@collabora.com> + * + * gstsdrjfmsrc.h: + * + * 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. + */ + +#ifndef __GST_SDRJFM_SRC_H__ +#define __GST_SDRJFM_SRC_H__ + +#include <gst/gst.h> +#include <gst/audio/gstaudiosrc.h> + +G_BEGIN_DECLS + +#define GST_TYPE_SDRJFM_SRC (gst_sdrjfm_src_get_type()) +#define GST_SDRJFM_SRC(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_SDRJFM_SRC,GstSdrjfmSrc)) +#define GST_SDRJFM_SRC_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_SDRJFM_SRC,GstSdrjfmSrcClass)) +#define GST_IS_SDRJFM_SRC(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_SDRJFM_SRC)) +#define GST_IS_SDRJFM_SRC_CLASS(klas) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_SDRJFM_SRC)) + +typedef struct _GstSdrjfmSrc GstSdrjfmSrc; +typedef struct _GstSdrjfmSrcClass GstSdrjfmSrcClass; + +struct _GstSdrjfmSrc { + GstAudioSrc src; + +}; + +struct _GstSdrjfmSrcClass { + GstAudioSrcClass parent_class; + + gint frequency; + +}; + +GType gst_sdrjfm_src_get_type(void); + +G_END_DECLS + +#endif /* __GST_SDRJFM_SRC_H__ */ diff --git a/tests/Makefile.am b/tests/Makefile.am new file mode 100644 index 0000000..c6fca44 --- /dev/null +++ b/tests/Makefile.am @@ -0,0 +1,9 @@ +TESTS = tune.sh +TESTS_ENVIRONMENT = GST_PLUGIN_PATH="$(top_builddir)/src/.libs" + +noinst_PROGRAMS = tune + +tune_SOURCES = tune.c +tune_CFLAGS= $(GST_CFLAGS) +tune_LDADD= $(GST_LIBS) + diff --git a/tests/tune.c b/tests/tune.c new file mode 100644 index 0000000..93b8687 --- /dev/null +++ b/tests/tune.c @@ -0,0 +1,204 @@ +#include <glib.h> +#include <gst/gst.h> + +GST_DEBUG_CATEGORY (srdjrm_debug); +#define GST_CAT_DEFAULT srdjrm_debug + +#define MIN_FREQ 88100000 +#define MAX_FREQ 108100000 + +typedef struct _TestData TestData; +struct _TestData +{ + GstElement *pipeline; + GstElement *fmsrc; + void (*playing_cb) (TestData*); + void (*freq_changed_cb) (TestData*,gint); + gint timeout; + GMainLoop *loop; + gint freqs[10]; + gint idx; + gint target_freq; +}; + +static gboolean +bus_cb (GstBus *bus, GstMessage *message, gpointer user_data) +{ + TestData *data = user_data; + GError *error = NULL; + + switch (message->type) { + case GST_MESSAGE_STATE_CHANGED: + if (GST_MESSAGE_SRC (message) == GST_OBJECT (data->pipeline)) { + GstState state; + gst_message_parse_state_changed (message, NULL, &state, NULL); + if (state == GST_STATE_PLAYING && data->playing_cb) + data->playing_cb (data); + } + break; + + case GST_MESSAGE_ELEMENT: + if (GST_MESSAGE_SRC (message) == GST_OBJECT (data->fmsrc)) { + const GstStructure *s = gst_message_get_structure (message); + + g_assert (gst_structure_has_name (s, "srdjrmsrc-frequency-changed")); + g_assert (gst_structure_has_field_typed (s, "frequency", G_TYPE_INT)); + + if (data->freq_changed_cb) { + gint freq; + gst_structure_get_int (s, "frequency", &freq); + + g_assert_cmpint (freq, >=, MIN_FREQ); + g_assert_cmpint (freq, <=, MAX_FREQ); + + data->freq_changed_cb (data, freq); + } + } + break; + + case GST_MESSAGE_ERROR: + gst_message_parse_error (message, &error, NULL); + g_assert_no_error (error); + break; + + case GST_MESSAGE_WARNING: + gst_message_parse_warning (message, &error, NULL); + g_assert_no_error (error); + break; + + default: + break; + } + + return TRUE; +} + +static TestData * +tearup (gint freq, void (*playing_cb) (TestData*), + void (*freq_changed_cb) (TestData*,gint)) +{ + GError *error = NULL; + TestData *data = g_slice_new0 (TestData); + GstBus *bus; + + data->pipeline = + gst_parse_launch ("srdjrmsrc name=fmsrc ! audioresample ! alsasink", + &error); + g_assert_no_error (error); + g_assert_nonnull (data->pipeline); + + data->fmsrc = gst_bin_get_by_name (GST_BIN (data->pipeline), "fmsrc"); + g_assert_nonnull (data->fmsrc); + + g_object_set (data->fmsrc, + "frequency", freq, + NULL); + + data->timeout = 20; + data->playing_cb = playing_cb; + data->freq_changed_cb = freq_changed_cb; + + bus = gst_pipeline_get_bus (GST_PIPELINE (data->pipeline)); + gst_bus_add_watch (bus, bus_cb, data); + g_object_unref (bus); + + data->loop = g_main_loop_new (NULL, FALSE); + + gst_element_set_state (data->pipeline, GST_STATE_PLAYING); + + return data; +} + +static void +teardown (TestData *data) +{ + gst_element_set_state (data->pipeline, GST_STATE_NULL); + g_object_unref (data->fmsrc); + g_object_unref (data->pipeline); + g_main_loop_unref (data->loop); + g_slice_free (TestData, data); +} + +static gboolean +test_timed_out_cb (gpointer user_data) +{ + g_assert_false ("Test timed out"); + return FALSE; +} + +static void +test_run (TestData *data) +{ + guint timeout; + + timeout = g_timeout_add_seconds (data->timeout, test_timed_out_cb, data); + g_main_loop_run (data->loop); + g_source_remove (timeout); + + teardown (data); +} + +static void +test_done (TestData *data) +{ + g_main_loop_quit (data->loop); +} + +static void +test_tune_playing_cb (TestData *data) +{ + data->freqs[0] = 96700000; + data->freqs[1] = 93300000; + data->freqs[2] = 105900000; + data->freqs[3] = 88900000; + data->freqs[4] = 0; + //data->freqs[1] = 107600000; + //data->freqs[5] = 107600000; + //data->freqs[6] = 0; + + data->idx = 0; + data->target_freq = data->freqs[0]; + g_object_set (data->fmsrc, "frequency", data->target_freq, NULL); + + GST_DEBUG_OBJECT (data->fmsrc, "Set frequency to %d", data->target_freq); +} + +static void +test_tune_freq_changed_cb (TestData *data, gint frequency) +{ + g_assert_cmpint (frequency, ==, data->target_freq); + + data->target_freq = data->freqs[++(data->idx)]; + + if (data->target_freq == 0) + { + GST_DEBUG_OBJECT (data->fmsrc, "Tune test completed"); + test_done (data); + } + else + g_object_set (data->fmsrc, "frequency", data->target_freq, NULL); +} + +static void +test_tune () +{ + GST_DEBUG ("Starting tune test"); + TestData *data = tearup (96700000, + test_tune_playing_cb, + test_tune_freq_changed_cb); + test_run (data); +} + +gint +main (gint argc, gchar **argv) +{ + gst_init (&argc, &argv); + + GST_DEBUG_CATEGORY_INIT (srdjrm_debug, "srdjrm", 0, "SDR-J FM plugin"); + GST_DEBUG ("Running test"); + + g_test_init (&argc, &argv, NULL); + g_test_add_func ("/tune/live", test_tune); + g_test_run (); + return 0; +} diff --git a/tests/tune.sh b/tests/tune.sh new file mode 100755 index 0000000..4f14315 --- /dev/null +++ b/tests/tune.sh @@ -0,0 +1,4 @@ +#!/bin/sh + +#exec ./tune --gst-debug=srdjrm:5 --gst-debug-level=5 --gst-debug-no-color +exec ./tune --gst-debug=srdjrm:8 --gst-debug-no-color |