From dbde7907bf3637823e27cded49f0d61ba4de7c87 Mon Sep 17 00:00:00 2001 From: Andrea Gabriellini Date: Mon, 21 Jul 2008 11:53:00 +0100 Subject: [PATCH] Version 1.1 Further clean up and change of version to 1.1 Removed tracking of INSTALL. --- .gitignore | 10 ++ INSTALL | 237 --------------------------- Makefile.am | 2 +- configure.ac | 6 +- dirac_parser-1.0.pc.in => dirac_parser.pc.in | 0 src/parser/parser.h | 54 +++--- src/parser/version.h | 2 +- 7 files changed, 42 insertions(+), 269 deletions(-) create mode 100644 .gitignore delete mode 100644 INSTALL rename dirac_parser-1.0.pc.in => dirac_parser.pc.in (100%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..feba674 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +INSTALL +aclocal.m4 +autom4te.cache +config.guess +config.sub +configure +depcomp +install-sh +ltmain.sh +missing diff --git a/INSTALL b/INSTALL deleted file mode 100644 index d3c5b40..0000000 --- a/INSTALL +++ /dev/null @@ -1,237 +0,0 @@ -Installation Instructions -************************* - -Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, -2006, 2007 Free Software Foundation, Inc. - -This file is free documentation; the Free Software Foundation gives -unlimited permission to copy, distribute and modify it. - -Basic Installation -================== - -Briefly, the shell commands `./configure; make; make install' should -configure, build, and install this package. The following -more-detailed instructions are generic; see the `README' file for -instructions specific to this package. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, and a -file `config.log' containing compiler output (useful mainly for -debugging `configure'). - - It can also use an optional file (typically called `config.cache' -and enabled with `--cache-file=config.cache' or simply `-C') that saves -the results of its tests to speed up reconfiguring. Caching is -disabled by default to prevent problems with accidental use of stale -cache files. - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If you are using the cache, and at -some point `config.cache' contains results you don't want to keep, you -may remove or edit it. - - The file `configure.ac' (or `configure.in') is used to create -`configure' by a program called `autoconf'. You need `configure.ac' if -you want to change it or regenerate `configure' using a newer version -of `autoconf'. - -The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. - - Running `configure' might take a while. While running, it prints - some messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Optionally, type `make check' to run any self-tests that come with - the package. - - 4. Type `make install' to install the programs and any data files and - documentation. - - 5. You can remove the program binaries and object files from the - source code directory by typing `make clean'. To also remove the - files that `configure' created (so you can compile the package for - a different kind of computer), type `make distclean'. There is - also a `make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - - 6. Often, you can also type `make uninstall' to remove the installed - files again. - -Compilers and Options -===================== - -Some systems require unusual options for compilation or linking that the -`configure' script does not know about. Run `./configure --help' for -details on some of the pertinent environment variables. - - You can give `configure' initial values for configuration parameters -by setting variables in the command line or in the environment. Here -is an example: - - ./configure CC=c99 CFLAGS=-g LIBS=-lposix - - *Note Defining Variables::, for more details. - -Compiling For Multiple Architectures -==================================== - -You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you can use GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. - - With a non-GNU `make', it is safer to compile the package for one -architecture at a time in the source code directory. After you have -installed the package for one architecture, use `make distclean' before -reconfiguring for another architecture. - -Installation Names -================== - -By default, `make install' installs the package's commands under -`/usr/local/bin', include files under `/usr/local/include', etc. You -can specify an installation prefix other than `/usr/local' by giving -`configure' the option `--prefix=PREFIX'. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -pass the option `--exec-prefix=PREFIX' to `configure', the package uses -PREFIX as the prefix for installing programs and libraries. -Documentation and other data files still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like `--bindir=DIR' to specify different values for particular -kinds of files. Run `configure --help' for a list of the directories -you can set and what kinds of files go in them. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. - -Optional Features -================= - -Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - -Specifying the System Type -========================== - -There may be some features `configure' cannot figure out automatically, -but needs to determine by the type of machine the package will run on. -Usually, assuming the package is built to be run on the _same_ -architectures, `configure' can figure that out, but if it prints a -message saying it cannot guess the machine type, give it the -`--build=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name which has the form: - - CPU-COMPANY-SYSTEM - -where SYSTEM can have one of these forms: - - OS KERNEL-OS - - See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the machine type. - - If you are _building_ compiler tools for cross-compiling, you should -use the option `--target=TYPE' to select the type of system they will -produce code for. - - If you want to _use_ a cross compiler, that generates code for a -platform different from the build platform, you should specify the -"host" platform (i.e., that on which the generated programs will -eventually be run) with `--host=TYPE'. - -Sharing Defaults -================ - -If you want to set default values for `configure' scripts to share, you -can create a site shell script called `config.site' that gives default -values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. - -Defining Variables -================== - -Variables not defined in a site shell script can be set in the -environment passed to `configure'. However, some packages may run -configure again during the build, and the customized values of these -variables may be lost. In order to avoid this problem, you should set -them in the `configure' command line, using `VAR=value'. For example: - - ./configure CC=/usr/local2/bin/gcc - -causes the specified `gcc' to be used as the C compiler (unless it is -overridden in the site shell script). - -Unfortunately, this technique does not work for `CONFIG_SHELL' due to -an Autoconf bug. Until the bug is fixed you can use this workaround: - - CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash - -`configure' Invocation -====================== - -`configure' recognizes the following options to control how it operates. - -`--help' -`-h' - Print a summary of the options to `configure', and exit. - -`--version' -`-V' - Print the version of Autoconf used to generate the `configure' - script, and exit. - -`--cache-file=FILE' - Enable the cache: use and save the results of the tests in FILE, - traditionally `config.cache'. FILE defaults to `/dev/null' to - disable caching. - -`--config-cache' -`-C' - Alias for `--cache-file=config.cache'. - -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to `/dev/null' (any error - messages will still be shown). - -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. - -`configure' also accepts some other, not widely useful, options. Run -`configure --help' for more details. - diff --git a/Makefile.am b/Makefile.am index 1dfbc14..732cd15 100644 --- a/Makefile.am +++ b/Makefile.am @@ -6,4 +6,4 @@ if HAVE_CPPUNIT endif pkgconfigdir = $(libdir)/pkgconfig -pkgconfig_DATA = dirac_parser-$(DIRAC_PARSER_MAJORMINOR).pc +pkgconfig_DATA = dirac_parser.pc diff --git a/configure.ac b/configure.ac index 6eac008..17552c6 100644 --- a/configure.ac +++ b/configure.ac @@ -1,12 +1,12 @@ AC_PREREQ(2.61) -AC_INIT(dirac_parser,1.0) +AC_INIT(dirac_parser,1.1) AM_INIT_AUTOMAKE(1.6) dnl ----------------------------------------------- dnl Package name and version number (user defined) dnl ----------------------------------------------- -DIRAC_PARSER_MAJORMINOR=1.0 +DIRAC_PARSER_MAJORMINOR=1.1 AC_SUBST(DIRAC_PARSER_MAJORMINOR) AC_CONFIG_HEADERS(config.h) @@ -44,7 +44,7 @@ AC_SUBST(CPPUNIT_LIBS) dnl When updating this don't forget the SUBDIRS= list in each Makefile.am down AC_CONFIG_FILES([ Makefile \ - dirac_parser-1.0.pc \ + dirac_parser.pc \ bitstreams/Makefile \ src/Makefile \ src/common/Makefile \ diff --git a/dirac_parser-1.0.pc.in b/dirac_parser.pc.in similarity index 100% rename from dirac_parser-1.0.pc.in rename to dirac_parser.pc.in diff --git a/src/parser/parser.h b/src/parser/parser.h index d09f7d1..9460777 100644 --- a/src/parser/parser.h +++ b/src/parser/parser.h @@ -50,13 +50,13 @@ namespace dirac namespace parser_project { extern "C" { - + #endif - - /*! The parser interface expects the user to manage the buffer containing + + /*! The parser interface expects the user to manage the buffer containing the bitstream to parse. The API accepts a reference to a cursor into the buffer, pointing to the current parsing position in the stream. - The parser API will move the cursor along the buffer, looking for + The parser API will move the cursor along the buffer, looking for the required type of access unit. If the cursor is already pointing to the start of the desired access unit the API will not move the cursor forward. @@ -67,7 +67,7 @@ extern "C" { In case of failure the cursor will be moved as far forward as possible. Non-zero is only returned if the entire access unit is contained in the passed buffer. - + While parsing the stream backwards the cursor will be moved to the start of the first access unit which occurs entirely before the current position of the cursor. @@ -88,31 +88,31 @@ extern "C" { dirac_parser_get_sequence_header ( uint8 const** cursor_reference , size_t buffer_size_fwd , size_t* seq_hdr_size_reference ); - + /*! same as above but for the pictures */ int dirac_parser_get_next_picture ( uint8 const** cursor_reference , size_t buffer_size_fwd , size_t* pic_size_reference ); - + /*! same as above but for any type of access unit */ int dirac_parser_get_next_access_unit ( uint8 const** cursor_reference , size_t buffer_size_fwd , size_t* acc_unit_size_reference ); - + /*! same as above but only for i pictures */ - int + int dirac_parser_get_next_i_picture ( uint8 const** cursor_reference , size_t buffer_size_fwd , size_t* pic_size_reference ); - + /*! scans the passed buffer forward or backward looking for a picture. The size of the available buffer is given by the sum of buffer_size_fwd and buffer_size_bwd. If scanning forward, n==0 means get the next pic, n==1 means the next + 1, etc. Negative values equates to scanning the buffer backward, so n==-1 means fetching the first picture entirely - contained in the buffer and ending before the current position of the + contained in the buffer and ending before the current position of the cursor. The function will move the cursor while trying to find the required pic. It returns non-zero upon success, when the cursor will be moved @@ -128,7 +128,7 @@ extern "C" { , size_t buffer_size_bwd , int* n , size_t* pic_size_reference ); - + /*! same as above but for intra pictures only */ int dirac_parser_get_i_picture_skip_n ( uint8 const** cursor_reference @@ -136,7 +136,7 @@ extern "C" { , size_t buffer_size_bwd , int* n , size_t* pic_size_reference ); - + /*! cursor_reference is a reference to the current position of the cursor in the client-provided buffer. buffer_size_fwd is the available data in the buffer past the cursor, buffer_size_bwd is the available data @@ -148,32 +148,32 @@ extern "C" { , size_t buffer_size_fwd , size_t buffer_size_bwd , size_t* pic_size_reference ); - + /*! move the cursor by one access unit - this function should be used once the stream is in sync, ie we have already parsed at least one access unit. The function expects the cursor to point to the start of an access unit and that the entire access unit is contained in the passed buffer. - It returns 0 if it cannot move the cursor to the start of the next access - unit (this includes if it is on the last access unit in the buffer), + It returns 0 if it cannot move the cursor to the start of the next access + unit (this includes if it is on the last access unit in the buffer), non zero upon success. Note that you don't need to move the cursor if you're scanning the stream backwards, since it is assumed that the user is looking for the previous - access unit, which should end one byte before the position pointed by the + access unit, which should end one byte before the position pointed by the passed cursor. - The cursor cannot be null (same applies to its reference) - buffer_size_fwd carries the number of available bytes in the buffer + The cursor cannot be null (same applies to its reference) + buffer_size_fwd carries the number of available bytes in the buffer from the cursor's position (scanning forward). */ int dirac_parser_move_cursor_fwd ( uint8 const** cursor_reference , size_t buffer_size_fwd ); - + /*! the following group of functions are self-explanatory: the functions return 0 if the passed buffer doesn't contain the expected type of dirac access unit, and non zero otherwise. Note that cursor must point to the start of the access unit; - the entire access unit must be contained in the passed buffer for - this function to return non-zero. + the entire access unit must be contained in the passed buffer for + this function to return non-zero. The cursor cannot be null. */ int dirac_parser_is_access_unit ( uint8 const* cursor @@ -209,15 +209,15 @@ extern "C" { the buffer doesn't contain an access unit or because the buffer is not long enough or doesn't start with an access unit) and pic_number will not be changed. - It will return non zero if successful and will set *pic_number to - the picture number. + It will return non zero if successful and will set *pic_number to + the picture number. cursor cannot be null, cursor must point to start of picture access unit or else undefined behaviour */ int dirac_parser_get_picture_number ( uint8 const* cursor , size_t size , uint32* pic_number_reference ); - + /*! current version of this API */ int dirac_parser_get_version_major(); @@ -225,11 +225,11 @@ extern "C" { dirac_parser_get_version_minor(); int dirac_parser_get_revision(); - + #ifdef __cplusplus } /* extern "C" */ - + } /* parser_project */ } /* dirac */ diff --git a/src/parser/version.h b/src/parser/version.h index 3f9d0b4..fe27bc1 100644 --- a/src/parser/version.h +++ b/src/parser/version.h @@ -39,7 +39,7 @@ #define _VERSION_H_ #define DIRAC_PARSER_VERSION_MAJOR 1 -#define DIRAC_PARSER_VERSION_MINOR 0 +#define DIRAC_PARSER_VERSION_MINOR 1 #define DIRAC_PARSER_REVISION 66 #endif /* _VERSION_H_ */ -- 2.11.4.GIT