AddSoundAnnotationTest.java

/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2025 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package com.itextpdf.kernel.pdf.annot;

import com.itextpdf.commons.utils.FileUtil;
import com.itextpdf.kernel.geom.Rectangle;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfName;
import com.itextpdf.kernel.pdf.PdfNumber;
import com.itextpdf.kernel.pdf.PdfStream;
import com.itextpdf.kernel.utils.CompareTool;
import com.itextpdf.test.ExtendedITextTest;
import com.itextpdf.test.TestUtil;

import java.io.IOException;
import java.io.InputStream;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;

@Tag("IntegrationTest")
public class AddSoundAnnotationTest extends ExtendedITextTest {

    public static final String sourceFolder =
            "./src/test/resources/com/itextpdf/kernel/pdf/annot/AddSoundAnnotationTest/";
    public static final String destinationFolder =
            TestUtil.getOutputPath() + "/kernel/pdf/annot/AddSoundAnnotationTest/";

    private static final String RIFF_TAG = "RIFF";

    @BeforeAll
    public static void beforeClass() {
        createOrClearDestinationFolder(destinationFolder);
    }

    @AfterAll
    public static void afterClass() {
        CompareTool.cleanup(destinationFolder);
    }
    
    @Test
    public void soundTestAif() throws IOException, InterruptedException {
        String filename = destinationFolder + "soundAnnotation02.pdf";
        String audioFile = sourceFolder + "sample.aif";
        String cmp = sourceFolder + "cmp_soundAnnotation02.pdf";

        try (InputStream is = prepareAudioFileStream(audioFile)) {
            try (PdfDocument pdfDoc = new PdfDocument(CompareTool.createTestPdfWriter(filename))) {
                PdfStream sound1 = new PdfStream(pdfDoc, is);
                sound1.put(PdfName.R, new PdfNumber(32117));
                sound1.put(PdfName.E, PdfName.Signed);
                sound1.put(PdfName.B, new PdfNumber(16));
                sound1.put(PdfName.C, new PdfNumber(1));

                pdfDoc.addNewPage().addAnnotation(new PdfSoundAnnotation(new Rectangle(100, 100, 100, 100), sound1));
            }
        }

        String errorMessage = new CompareTool().compareByContent(filename, cmp, destinationFolder);
        if (errorMessage != null) {
            Assertions.fail(errorMessage);
        }
    }

    @Test
    public void soundTestAiff() throws IOException, InterruptedException {
        String filename = destinationFolder + "soundAnnotation03.pdf";
        String audioFile = sourceFolder + "sample.aiff";
        String cmpPdf = sourceFolder + "cmp_soundAnnotation03.pdf";

        try (InputStream is = prepareAudioFileStream(audioFile)) {
            try (PdfDocument pdfDoc = new PdfDocument(CompareTool.createTestPdfWriter(filename))) {
                PdfStream sound1 = new PdfStream(pdfDoc, is);
                sound1.put(PdfName.R, new PdfNumber(44100));
                sound1.put(PdfName.E, PdfName.Signed);
                sound1.put(PdfName.B, new PdfNumber(16));
                sound1.put(PdfName.C, new PdfNumber(1));

                pdfDoc.addNewPage().addAnnotation(new PdfSoundAnnotation(new Rectangle(100, 100, 100, 100), sound1));

            }
        }

        String errorMessage = new CompareTool().compareByContent(filename, cmpPdf, destinationFolder);
        if (errorMessage != null) {
            Assertions.fail(errorMessage);
        }
    }

    @Test
    public void soundTestWav01() throws IOException, InterruptedException {
        String filename = destinationFolder + "soundAnnotation05.pdf";
        String audioFile = sourceFolder + "sample.wav";
        String cmpPdf = sourceFolder + "cmp_soundAnnotation05.pdf";

        try (InputStream is = prepareAudioFileStream(audioFile)) {
            try (PdfDocument pdfDoc = new PdfDocument(CompareTool.createTestPdfWriter(filename))) {
                PdfStream soundStream = new PdfStream(pdfDoc, is);

                soundStream.put(PdfName.R, new PdfNumber(48000));
                soundStream.put(PdfName.E, PdfName.Signed);
                soundStream.put(PdfName.B, new PdfNumber(16));
                soundStream.put(PdfName.C, new PdfNumber(2));

                PdfSoundAnnotation sound = new PdfSoundAnnotation(new Rectangle(100, 100, 100, 100), soundStream);

                pdfDoc.addNewPage().addAnnotation(sound);

            }
        }

        String errorMessage = new CompareTool().compareByContent(filename, cmpPdf, destinationFolder);
        if (errorMessage != null) {
            Assertions.fail(errorMessage);
        }
    }

    @Test
    public void soundTestSnd() throws IOException, InterruptedException {
        String filename = destinationFolder + "soundAnnotation04.pdf";
        String audioFile = sourceFolder + "sample.snd";
        String cmpPdf = sourceFolder + "cmp_soundAnnotation04.pdf";


        try (InputStream is = FileUtil.getInputStreamForFile(audioFile)) {
            try (PdfDocument pdfDoc = new PdfDocument(CompareTool.createTestPdfWriter(filename))) {
                Rectangle rect = new Rectangle(100, 100, 100, 100);
                PdfSoundAnnotation sound = new PdfSoundAnnotation(pdfDoc, rect, is, 44100, PdfName.Signed, 2, 16);

                pdfDoc.addNewPage().addAnnotation(sound);
            }
        }

        String errorMessage = new CompareTool().compareByContent(filename, cmpPdf, destinationFolder);
        if (errorMessage != null) {
            Assertions.fail(errorMessage);
        }
    }

    @Test
    public void soundTestWav() throws IOException, InterruptedException {
        String filename = destinationFolder + "soundAnnotation01.pdf";
        String audioFile = sourceFolder + "sample.wav";
        String cmpPdf = sourceFolder + "cmp_soundAnnotation01.pdf";

        try (InputStream is = FileUtil.getInputStreamForFile(audioFile)) {
            try (PdfDocument pdfDoc = new PdfDocument(CompareTool.createTestPdfWriter(filename))) {
                Rectangle rect = new Rectangle(100, 100, 100, 100);
                PdfSoundAnnotation sound = new PdfSoundAnnotation(pdfDoc, rect, is, 48000, PdfName.Signed, 2, 16);

                pdfDoc.addNewPage().addAnnotation(sound);

            }
        }

        String errorMessage = new CompareTool().compareByContent(filename, cmpPdf, destinationFolder);
        if (errorMessage != null) {
            Assertions.fail(errorMessage);
        }
    }

    private InputStream prepareAudioFileStream(String audioFile) throws IOException {
        StringBuilder sb = new StringBuilder();
        try (InputStream is = FileUtil.getInputStreamForFile(audioFile)) {
            for (int i = 0; i < 4; i++) {
                sb.append((char) is.read());
            }
        }
        boolean skipFirstByte = sb.toString().equals(RIFF_TAG);

        InputStream stream = FileUtil.getInputStreamForFile(audioFile);
        if (skipFirstByte) {
            stream.read();
        }
        return stream;
    }
}