Alexander Traud authored 3 years ago and Ralph Giles committed 3 years ago

HREF based links work in the PDF documentation but not in the HTML
documentation because the callback routines are on a different HTML
page.

Signed-off-by: Ralph Giles <giles@thaumas.net>

Alexander Traud authored 3 years ago and Ralph Giles committed 3 years ago

Since doxygen 1.8.16, opening and closing a group must not be done as
C comment but as doxygen command. In other words, not one but two
asterisk characters are required so that doxygen finds a group.

Fixes #2332

Signed-off-by: Ralph Giles <giles@thaumas.net>

Alexander Traud authored 3 years ago and Ralph Giles committed 3 years ago

It is OK to say, those are not used, yet.

Signed-off-by: Ralph Giles <giles@thaumas.net>

This avoids redundancy and conforms to more recent style.

Add checksums for the first two source releases for completeness.
These are copied from and verified against downloads.xiph.org.

We keep checksums of the release packages in the repo as a
redundant and trustworthy reference. I found these in an
old working repo; it looks like they weren't committed
after the 0.12 release last year.

Checked against the files on downloads.xiph.org.

The channel as moved to the new network.

When we were checking the current file offset to see if we should
 use it as the starting bisection point, we assumed that offset was
 larger than the start of the data range for that link (and
 consequently, inside the bisection range).
If there is a random page earlier in the file that happens to use
 the same serial number as a link we identified later in the file
 at file open time, and we had stopped reading there before the
 seek, then this assumption might not be true.

Ironically, it was not the case that contained the assertion that
 had trouble with such an offset.
It would fail the check that we were cutting off more than half the
 range, since we were actually cutting off a negative amount, and
 fall back to the midpoint of the link as the first bisection
 point.
However, the case below that (where the target comes after the
 current timestamp), we might have erroneously cut off the entire
 range (setting end to offset, which was less than begin), causing
 the seek to immediately fail.

Instead, validate the curent offset against both ends of the link
 before attempting to use it as the initial bisection point.
Thanks to Felicia Lim for the report.

Fixes #2331

Although link enumeration ensures the return value is in range, the
 order of operations allows the intermediate value pcm_total+diff
 to overflow the range of a 64-bit int.
Add parentheses to ensure this does not happen.
Thanks to Felcia Lim for the report.

Fixes #2330

When a file is very, very short (i.e., only one packet) and uses
 end-trimming, the apparent granule position preceding the first
 sample in the first packet can underflow.
We were computing this value by subtracting the packet duration
 from the computed per-packet granule position and expecting this
 computation to always succeed.
Because it could fail in the presence of end-trimming on the first
 packet (ironically, exactly the situation where the short-circuit
 is helpful), it would leave the value uninitialized, and then use
 it in a comparison, which is undefined behavior.
The correct solution is to check for failure and force the previous
 page's granule position to 0 in this case.

We were attempting to ensure a minimum spacing between granule
 positions when guessing the start of a link location.
However, we took a strictly-positive granule position, added a
 fixed increment with op_granpos_add(), and checked if
 op_granpos_add() failed.
op_granpos_add() only fails if the sum would have overflowed past
 zero, which can never happen when adding two strictly positive
 granule positions.
Instead, we need to check if the result becomes negative (which is
 a legal granule position, but violates our assumptions in the
 search).

Thanks to Felicia Lim for the report.

Prefer the secure protocol by default. We do not update schema
links since they're often standardized with protocol included.

Note that the link to the Windows certificate store patch
in the openssl.org bug tracker requires a login now.

Use a secure link by default. Drop the redundant www subdomain
to keep within the 70-column width of the header.

Replace broken link to jenkins build of the opus api docs
with the current release on the website.

Fix broken links into the vorbis spec.

Update other links to use https.

No interface changes.

Not harder to read in a editor, and looks better in the web
interface.

These make for a nicer landing page for people coming from
the gitlab repo interface on the web. They parallel github
in that we can't override the git snapshots labelled as
'source' but we can link to packages.

We keep checksums of the release packages in the repo as a
redundant and trustworthy reference.

Update the build environment container to use the gitlab.xiph.org
url instead of the no-longer-available git.xiph.org.

This is faster. We still don't have good dependency tracking
among the components, but roughly:

    make
    make opusfile-0.dll
    make package

Should automate the basics of putting together a win32 binary
package. It still doesn't include documentation. See the
mingw/README for additional steps there.

Also, don't copy dll.a files. They don't seem to be necessary.

Invoking ../configure from the mingw directory would clobber
the mingw-specific Makefile, which is confusing. Instead
have the `make opusfile` target invoke the autotools build
within a subdirectory.

Download the most recent working release of openssl.
- Enable asm, since it seems to work now.
- Link ssl and crypto libraries statically, since the
  dll target seems to be broken.

The 1.0.2 series of openssl releases is no longer supported.
However, 1.1.1 and later broke the hooks we were using to
reference the Windows certificate store, so this is also
the newest release where opusurl works.

As such, this shouldn't be used in production (unless you have a
support contract for openssl!) but it's a useful reference
configuration to have in the repository.

Hopefully a replacement api will be available in openssl 3 or 4
and we can port to that for future releases.

This seems to have changed to be more like the unix build.
We'll probably need libcrypto-1_1.dll too, but I haven't
gotten to the link step yet. This fails because of api
changes between (no longer supported) 1.0.x versions
and the current stable 1.1.

This was a reference from an older build script and it no longer
necessary. Having in the Makefile just confuses things.

We had a request for 64-bit Windows binaries at some point, but
win32 is more broadly compatible. Since everything's broken,
let's concentrate on that and add rules to generate a separate
opusfile-${version}-win64 package later.

Latest release versions and checksums.

This is the current release.

The gcc runtime dll filename has changed, so the package script
is also updated.

In theory `mingw/Makefile` can build a binary release, but
it doensn't quite works and omits some niceties, so we still
need the detailed build instructions to compare with.

However, the details aren't relevent to the general release
checklist, so pretend `make -C ming package` works at that
level.

Also convert the mingw README to markdown for better
display on hosting sites.

Documentation should be copied to the website as part of the
source release process, not building win32 binaries.

https://github.com/doxygen/doxygen/issues/6456 is fixed in
Doxygen 1.8.15. Update teh release checklist to reflect this

Thanks to derf for checking this.

Specify an explicit version of the base container image for more
repeatable results. Note that this will need to be bumped periodically.

Signed-off-by: Marvin Scholz <epirat07@gmail.com>

Verify the stand-along Makefile for formatting the API documentation.

We ship a default Makefile which can be used to invoke doxygen
to format the API documentation outside of the autotools build,
which requires implementing subsitition of the appropriate
variables in Doxyfile.in.

This commit adds a missing substitution, telling doxygen to
expect `dot` from the graphviz package to be available.

Ensure test coverage for the non-autotools makefile. This is
much faster than the autotools build, but doesn't currently
support tests or a `dist` target.

The syntax of the travis-ci.org build description file makes
it tedious to add alternate build types. It's much easier with
gitlab, so it's nice to have testing outside of jenkins.

Set up a basic autotools job to run on gitlab's continuous
integration runner, so we get some feedback on commits to
that repository.