Ogg 和 Vorbis Java 工具库技术文档

1. 安装指南

依赖环境

• Java 8 或更高版本
• Maven 或 Gradle（用于构建和依赖管理）

安装步骤

1. 通过 Maven 安装： 在项目的 pom.xml 文件中添加以下依赖：

   <dependency>
       <groupId>org.gagravarr</groupId>
       <artifactId>vorbis-java-tools</artifactId>
       <version>最新版本</version>
   </dependency>
   

2. 通过 Gradle 安装： 在 build.gradle 文件中添加以下依赖：

   implementation 'org.gagravarr:vorbis-java-tools:最新版本'
   

3. 手动下载 JAR 文件： 可以从项目的 GitHub 仓库或 Maven 中央仓库下载 vorbis-java-tools.jar 或 vorbis-java-tools-jar-with-dependencies.jar。

2. 项目使用说明

项目概述

该项目是一个纯 Java 库，用于处理 Ogg、Vorbis、FLAC、Opus、Speex 和 Theora 文件。它提供了对 Ogg 容器的完整支持，包括读取、写入、添加和更改流。此外，还支持 Vorbis、Opus、Speex、FLAC 和 Theora 的元数据操作。

主要功能

• Ogg 容器支持：读取、写入、添加和更改 Ogg 文件中的流。
• Vorbis 支持：支持元数据（如采样率、用户评论等）的检索和更改。
• Opus 和 Speex 支持：支持元数据的检索。
• FLAC 支持：支持 FLAC 评论（用户元数据）的提取。
• Theora 支持：提供对元数据的基本访问。

工具包

项目提供了一些纯 Java 工具，帮助用户处理 Ogg 和 Vorbis 文件：

• OggInfoTool：打印文件中流的详细信息。
• VorbisInfoTool：打印 Vorbis 文件的详细信息。
• OpusInfoTool：打印 Opus 文件的摘要信息。
• FlacInfoTool：打印 FLAC 文件的详细信息。
• SkeletonInfoTool：打印 Skeleton 描述的 Ogg 文件信息。
• VorbisCommentTool：允许列出和编辑 Vorbis 文件的评论。
• OpusCommentTool：允许列出和编辑 Opus 文件的评论。
• FlacCommentTool：允许列出 FLAC 文件的评论。

3. 项目 API 使用文档

主要类

• org.gagravarr.ogg.OggFile：提供对 Ogg 文件的读写支持。
• org.gagravarr.vorbis.VorbisFile：提供对 Ogg Vorbis 音频文件的读写支持。
• org.gagravarr.opus.OpusFile：提供对 Ogg Opus 音频文件的读取支持。
• org.gagravarr.speex.SpeexFile：提供对 Ogg Speex 音频文件的读取支持。
• org.gagravarr.flac.FlacOggFile：提供对存储在 Ogg 容器中的 FLAC 文件的读取支持。
• org.gagravarr.flac.FlacFile：提供对常规 FLAC 文件的读取支持。
• org.gagravarr.skeleton.SkeletonStream：提供对 Skeleton 元数据流的读取支持。

API 示例

以下是一个简单的示例，展示如何使用 VorbisFile 类读取 Vorbis 文件的元数据：

import org.gagravarr.vorbis.VorbisFile;

public class VorbisExample {
    public static void main(String[] args) {
        try (VorbisFile vorbisFile = new VorbisFile(new File("example.ogg"))) {
            System.out.println("采样率: " + vorbisFile.getInfo().getSamplingRate());
            System.out.println("通道数: " + vorbisFile.getInfo().getChannels());
            System.out.println("用户评论: " + vorbisFile.getComments().getComments());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

4. 项目安装方式

Maven 安装

在 pom.xml 中添加依赖：

<dependency>
    <groupId>org.gagravarr</groupId>
    <artifactId>vorbis-java-tools</artifactId>
    <version>最新版本</version>
</dependency>

Gradle 安装

在 build.gradle 中添加依赖：

implementation 'org.gagravarr:vorbis-java-tools:最新版本'

手动安装

下载 vorbis-java-tools.jar 或 vorbis-java-tools-jar-with-dependencies.jar，并将其添加到项目的类路径中。

通过以上步骤，您可以成功安装并使用该库来处理 Ogg 和 Vorbis 文件。