Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.xiph.org/xiph/opus.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-04-21docs: replace fgrep with grep -FClaudio Saavedra
It's been deprecated for decades and in Debian system it's starting to print warnings. Just use grep -F instead. Signed-off-by: Ralph Giles <giles@thaumas.net>
2020-11-26Meson: Fix doc build when opus is a subprojectXavier Claessens
meson.source_root() and meson.build_root() have been deprecated in latest Meson release because they are a trap. They point to the root of parent project instead of root of current subproject. Meson 0.56.0 added meson.project_source/build_root() but it is just as easy to use meson.current_source/build_dir() in the root meson.build file and avoids bumping required meson version. Signed-off-by: Ralph Giles <giles@thaumas.net>
2020-10-28Add support for Meson build systemTim-Philipp Müller
Tested on: - Linux/x86* with gcc - Android armv7 arm64 x86 x86_64 with clang - Windows x86 x86_64 with Visual Studio 2017 - Windows x86 x86_64 with MinGW - macOS x86_64 with clang - iOS arm64 x86_64 with clang Co-authored by: Nirbheek Chauhan <nirbheek@centricular.com> https://gitlab.xiph.org/xiph/opus/-/merge_requests/13
2020-06-13fix doc/build_draft.sh run errorwillson-chen
Add newer source directories to the destdir file tree so we can include all sources referenced from opus_sources.mk. Signed-off-by: Ralph Giles <giles@thaumas.net>
2020-06-13opus draft: fix run failed under dashwillson-chen
[[ ]], the compound command is not supported by all shell interpreter. [ ], the buildin command is more common. Signed-off-by: Ralph Giles <giles@thaumas.net>
2020-06-09Update Doxygen config file, header and footer to Doxygen 1.8.18Marcus Asteborg
Signed-off-by: Ralph Giles <giles@thaumas.net>
2020-06-01trivial_example: Check the return value of fread().Ralph Giles
Silence a gcc warning by checking the return value of the fread() call instead of the feof() guard. This prevents an infinite loop in the case of a read error. Otherwise, when end-of-file is reached fread() will certainly return a smaller number of elements read than requested, so both cases are handled now. Add a comment to clarify that we're dropping a partial frame on purpose to keep the code simple. Also add more braces around conditional bodies for less error-prone style. Signed-off-by: Mark Harris <mark.hsj@gmail.com>
2020-06-01trivial_example: open raw pcm files in binary mode.Ralph Giles
The simple codec round-trip example file in the doc directory opens an input and output pcm file. It was working fine on POSIX systems, but not on Windows, which treats text files differently. This is confusing in a example, so it's better to add an explicit binary flag to the fopen() calls. This does nothing on unix-like systems, but should make the example work for developers on Windows. Thanks to Wavesonics who reported this on irc. Signed-off-by: Mark Harris <mark.hsj@gmail.com>
2020-05-11Repository moved to gitlab.xiph.orgMark Harris
2018-09-13Update ISO Base Media Format draft to version 0.8.1.Ralph Giles
- Switch to 'Opus' file type identification. - Revise channel mapping to better support ambisonics.
2017-09-19update draft version -10Jean-Marc Valin
2017-08-20More fixes for IESGJean-Marc Valin
2017-08-17update draft: addressing IETF LC commentsJean-Marc Valin
2017-07-26Update draft: addressing AD commentsJean-Marc Valin
2017-07-16Update links, fix bits, add security considerationsJean-Marc Valin
2017-06-20Prevent update draft from expiringJean-Marc Valin
2017-06-16Update release checklist for website move to git.Ralph Giles
2016-12-20update draft: oops, fixes use of "above"Jean-Marc Valin
2016-12-19Update draft: addressing WGLC commentsJean-Marc Valin
2016-11-18genversion.bat: generate same version as update_versionRicardo Constantino
Remove version.mk and references to it in the repo. genversion.bat will now generate the same version strings as update_version script, i.e. without 'v' prefix and without a fallback if git archive is used. If run from a release tarball it'll use package_version, like configure. If run from a git repo, it will use the same 'git describe' with '-dirty' as update_version. Signed-off-by: Ralph Giles <giles@thaumas.net>
2016-10-27Make use of dot optional in generating documentation.Ralph Giles
Different distributions of doxygen have different default values of HAVE_DOT setting, so we need to pick a specific setting to avoid 'missing dot' warnings on some platforms. Doxygen uses it to generate inclusion graphs for our various header files, which is somewhat useful, but not essential. We therefore enable dot if it's present (usually through the parent graphviz package) but disable it if it's not available, silencing the warning, but not giving uniform results.
2016-10-21updating update draftJean-Marc Valin
2016-09-02misc fixes to update draftJean-Marc Valin
2016-09-01minor fix to update draftJean-Marc Valin
2016-09-01Adds two integer wrap-around issues to the update draftJean-Marc Valin
2016-07-07Update URLsMark Harris
2016-07-06Fix typo.Ralph Giles
Thanks to RiCON for reporting this.
2016-07-06Update links in release checklist.Ralph Giles
2016-07-04Fix folding bug in draft tooJean-Marc Valin
2016-07-04update draft fixesJean-Marc Valin
2016-07-01minor update draft updateJean-Marc Valin
2016-07-01Adding hybrid folding section and new testvectors to the update draftJean-Marc Valin
2016-06-03Update ISO Base Media Format draft to version 0.6.8.Ralph Giles
2016-05-18Clean doxygen_sqlite3.dbRicardo Constantino (:RiCON)
Generated by newer versions of Doxygen when built with sqlite3.
2016-02-23oggopus: Update version and date for -14Timothy B. Terriberry
2016-02-18oggopus: Address Barry Leiba's IESG comments.Timothy B. Terriberry
Thanks to Barry for proposing specific text for the changes.
2016-02-18oggopus: Fix page numbers in example diagram.Timothy B. Terriberry
Ralph Giles correctly points out that the sequence number field in Ogg pages starts couting at 0, so counting from 1 in the diagram might be confusing.
2016-02-18oggopus: Update Wikipedia URLs.Timothy B. Terriberry
For RFC 6716, the RFC Editor converted our Wikipedia URLs into stable ones that would always point at the same version of the page. We're close enough to the end that we can go ahead and do that in advance (and also update the dates to reflect the most recent version).
2016-02-17oggopus: Fix typo.Ralph Giles
2016-02-17oggopus: Address Stephen Farrell's IESG comments.Timothy B. Terriberry
- Clarify that 125,829,120 is just 120 MB. - Add a figure to Section 3 of an example logical stream. - Add a reference for Q notation. - Refer to the downmixing figures in the text. - Clarify that user comments are UTF-8. - Clarify that the -573 and 111 gain values are examples. - Add specific advice to implementors on areas that have security implications.
2016-02-13oggopus: Update version and date for -13Timothy B. Terriberry
Apparently the IETF does not like having the BSD copyright in the .xml source (despite the CODEC WG's IPR advisor saying this was okay), so we need a new version.
2016-02-09Remove unused patch file.Ralph Giles
It looks like this was included accidentally. Thanks to mark4o for pointing out I'd missed this in the previous removal.
2016-02-03Remove unused patch file.Ralph Giles
It looks like this was included accidentally.
2016-02-03Remove generation date from docs.Ralph Giles
The improves the reproducibilit of the build. The date was nice to have, but there's a version string at the top which should identify the release correctly. The copyright date could actually be incorrect, since it is based on the build date and not the last-changed date.
2016-02-03Clean up footer.html.Ralph Giles
Use https urls. Indent nesting levels and add missing </td>.
2016-02-03oggopus: Additional minor rewording.Timothy B. Terriberry
Hopefully this is even clearer. Thanks again to Mark Harris for the suggestion.
2016-02-03oggopus: Update version and date for -12Timothy B. Terriberry
2016-02-03oggopus: Minor rewording.Timothy B. Terriberry
This avoids the claim that all possible Opus implementations would run at rates that divide 48 kHz. Thanks to Mark Harris for raising the issue.
2016-02-03oggopus: Update the acknowledgements.Timothy B. Terriberry
2016-02-03oggopus: Add a BSD license header.Timothy B. Terriberry
This also removes the request for an additional grant from the IETF Trust on the final RFC. I believe this is sufficient to exercise our ability to allow downstream modifications as proposed in RFC 5377 Section 4.4. See the discussion at <https://www.ietf.org/mail-archive/web/codec/current/msg03169.html> for details.