使い終えたjavax.sound.sampled.Clipを自動でcloseしたい。

Question

前提・実現したいこと

javax.sound.sampled.Clipを用いて、2秒程度の音を0.2秒間隔程度で連続して鳴らしたいと考えています。
今までは、音を再生する度に異なるClipを用意していたのですが、Clipは自動でメモリ解放されないことを知り、現在は、音を再生し終えたClipを自動でメモリ解放close()する方法を模索中です。

発生している問題・エラーメッセージ

下記のソースコードのコンストラクタにあるように、2つのデバッグ用コメント

• System.out.println("timer stopped and clip closed");
• System.out.println("timer and clip started");

を用意し、プログラムの動作を確認しました。期待していた結果は

• 音を再生した直後にtimer and clip startedと出力され
• およそ2秒後にtimer stopped and clip closedと出力される

でしたが、実際に実行すると、

• 8回ほど連続してtimer and clip startedが出力され
• その後5秒ほどアプリがフリーズした後
• 8つのtimer stopped and clip closedがまとめて出力される

となりました。

使い終えたClipのメモリ解放は自動で行われているようでしたが、アプリが時折フリーズしてしまうことに悩まされています。

該当のソースコード

MusicPlayer.java

import java.util.Timer;
import java.util.TimerTask;
import java.io.File;
import javax.sound.sampled.AudioFormat;
import javax.sound.sampled.AudioInputStream;
import javax.sound.sampled.AudioSystem;
import javax.sound.sampled.DataLine;
import javax.sound.sampled.Clip;

// Exceptions
import java.io.IOException;
import javax.sound.sampled.LineUnavailableException;
import javax.sound.sampled.UnsupportedAudioFileException;

public class MusicPlayer
{
    private Clip p;
    private Timer timer;

    public MusicPlayer(String filePath)
    {
        p = LoadClipPlayer(filePath);
        p.start();

        timer = new Timer(true);
        TimerTask timerTask = new TimerTask()
        {
            public void run()
            {
                p.stop();
                p.close();
                System.out.println("timer stopped and clip closed");
                timer.cancel();
            }
        };
        timer.schedule(timerTask, (int)(p.getMicrosecondLength() / 1000));

        System.out.println("timer and clip started");
    }

    private static Clip LoadClipPlayer(String filePath) {

        Clip clip = null;

        try {
            AudioInputStream stream = AudioSystem.getAudioInputStream(new File(filePath));
            AudioFormat format = stream.getFormat();
            DataLine.Info dataLine = new DataLine.Info(Clip.class, format);
            clip = (Clip)AudioSystem.getLine(dataLine);
            clip.open(stream);
        }
        catch(UnsupportedAudioFileException e) {
            e.printStackTrace();
        }
        catch(LineUnavailableException e) {
            e.printStackTrace();
        }
        catch(IOException e) {
            e.printStackTrace();
        }

        return clip;
    }
}

MusicPlayerのインスタンスはMusicPlayerManagerクラスで生成され、このクラスのArrayListに格納・保持されています。

MusicPlayerManager.java

import java.util.ArrayList;
import java.util.Queue;
import java.util.ArrayDeque;
import javax.sound.sampled.Clip;

public class MusicPlayerManager {

    private static ArrayList<String> filePathList;
    private static ArrayList<MusicPlayer> musicPlayers;
    private static RhythmManager rhythmManager;

    // 何番にPlay指示が出たかを一時保管し、リズムに合わせて処理するためのバッファ
    private static Queue<Integer> orderBuffer;

    public MusicPlayerManager() {
        
        filePathList = new ArrayList<String>();
        musicPlayers = new ArrayList<MusicPlayer>();
        rhythmManager = new RhythmManager(150);
        orderBuffer = new ArrayDeque<>();
    }

    public MusicPlayerManager(String[] filePath) {

        this();
        for(String filePath_ : filePath) {
            filePathList.add(filePath_);
        }
    }

    public MusicPlayerManager(ArrayList<String> filePath) {

        this();
        for(String filePath_ : filePath) {
            filePathList.add(filePath_);
        }
    }

    public void Play(int fileNum) {

        // 処理待機バッファ内のfileNumの重複を避ける
        if(!orderBuffer.contains(fileNum))
            orderBuffer.add(fileNum);
    }

    public void AddFile(String filePath) {

        filePathList.add(filePath);
    }

    public int GetFileTotalNum() {

        return filePathList.size();
    }

    // RhythmManagerに呼び出されるメソッド
    // リズムに合わせて一定間隔で呼び出される
    public static void PlayAllInOrderBuffer()
    {
        // キューの先頭を取得し削除しながらループする
        while(orderBuffer.peek() != null)
        {
            int buf = orderBuffer.poll();
            musicPlayers.add(new MusicPlayer(filePathList.get(buf)));
        }
    }
}

試したこと

• timer.schedule(timerTask, (int)(p.getMicrosecondLength() / 1000))の部分をtimer.scheduleAtFixedRate(timerTask, (int)(p.getMicrosecondLength() / 1000), 1000)（第3引数の1000は適当）としてみましたが、動作は大差ありませんでした。
• javax.swing.TimerとActionListenerを用いて同様のプログラムを作成しましたが、動作は大差ありませんでした。
• m-oguraさんの助言を受け、try-with-resourcesを用いてMusicPlayer.javaを下のように修正しましたが、タスクマネージャーでOpenJDK Platform binaryアプリ（起動中のアプリ）のメモリを監視したところ、音が鳴るたびにメモリ量は増え続けており、ストリームはclose出来ていないようでした。

import java.io.File;
import javax.sound.sampled.AudioFormat;
import javax.sound.sampled.AudioInputStream;
import javax.sound.sampled.AudioSystem;
import javax.sound.sampled.DataLine;
import javax.sound.sampled.Clip;

// Exceptions
import java.io.IOException;
import javax.sound.sampled.LineUnavailableException;
import javax.sound.sampled.UnsupportedAudioFileException;

public class MusicPlayer
{
    public MusicPlayer(String filePath)
    {
        LoadClipPlayer(filePath);
    }

    private static void LoadClipPlayer(String filePath) {

        try(AudioInputStream stream = AudioSystem.getAudioInputStream(new File(filePath));)
        {
            AudioFormat format = stream.getFormat();
            DataLine.Info dataLine = new DataLine.Info(Clip.class, format);
            Clip clip = (Clip)AudioSystem.getLine(dataLine);
            clip.open(stream);
            clip.start();
        }
        catch(UnsupportedAudioFileException e) {
            e.printStackTrace();
        }
        catch(LineUnavailableException e) {
            e.printStackTrace();
        }
        catch(IOException e) {
            e.printStackTrace();
        }
    }
}

補足情報（FW/ツールのバージョンなど）

バージョンは以下の通りです。

>javac --version
javac 15

>java --version
openjdk 15 2020-09-15
OpenJDK Runtime Environment (build 15+36-1562)
OpenJDK 64-Bit Server VM (build 15+36-1562, mixed mode, sharing)

どうぞよろしくお願いいたします。

Comments

[TN8001]

pamiさん

呼び出し側のコードもないと確認できません。

>今までは、音を再生する度に異なるClipを用意していた

同じ音なら巻き戻して再生できます。それとも音の種類が多いですか？

>音を再生し終えたClipを自動でメモリ解放close()する方法

LineListenerで終了を検知するのが、ポピュラーなようです。

[java - do I need to close an audio Clip? - Stack Overflow](https://stackoverflow.com/questions/2792977/do-i-need-to-close-an-audio-clip/6707971#6707971

[pami]

呼び出し側のコードを追記いたしました。ご指摘ありがとうございます。

音の種類は今のところ少ないですが、多くなる予定です。
実現したいことは、音声ファイルAが再生し終える前に再度Aを鳴らすことであり、A専用のClipを1つ用意し巻き戻して再生してしまうと、Aが最後まで再生されないうえ、音声が急に止まることによるパルスノイズが発生してしまうと考え、巻き戻しは採用しておりません。

LineListenerによる終了検知は存じておりませんでした。頂いた記事を拝読し、修正に取り掛かろうと思います。ありがとうございます。

Answer 1

TN8001さんから頂いたリンクにあるプログラム（下記）を用いると、clipのcloseは時折後回しになるものの、clipの自動close、およびclipによる音の再生は実現できているようなので、ひとまずこれをもって解決と致します。

皆様の貴重なご回答とご意見に感謝申し上げます。

class MusicPlayer {
    public static final Vector<Clip> vector = new Vector<Clip>();
    static final int vector_size = 5;

    // typically called before calling play()
    static synchronized void consolidate() {
        while (vector_size < vector.size()) {
            Clip myClip = vector.get(0);
            if (myClip.isRunning())
                break;
            myClip.close();
            vector.remove(0);
            System.out.println("close");
        }
        if (vector_size * 2 < vector.size())
            System.out.println("warning: audio consolidation lagging");
    }

    public static void play(final File myFile) {
        try {
            AudioInputStream myAudioInputStream = AudioSystem.getAudioInputStream(myFile);
            final Clip myClip = AudioSystem.getClip();
            vector.add(myClip);
            myClip.open(myAudioInputStream);
            myClip.start();
            System.out.println("start");
        } catch (Exception myException) {
            myException.printStackTrace();
        }
    }
}

引用：java - do I need to close an audio Clip? - Stack Overflow

Answer 2

呼び出し側とはおおもとの呼び出し方のことを言ったのですが、どうやら大がかりそうなので最低限のプログラムをこちらで作成しました。

Windows Background.wavに、特に意味はありません（2秒程度の音というだけです）

0.2秒間隔程度というのがこういう意味なのか分かりませんが、同じ音を再生する可能性があるということですので恐らくそうなのだと思いました。

UIスレッドでThread.sleepしてるので、当然UIは固まります（1.6秒ほど）

ボタンを連打すると連打回数分*8は鳴っているようですが、明らかに変な挙動（途中で止まったよう）になりました（UIの固まりも伸びる）

---

timer stopped and clip closedがまとめて出るのは、こちらも同様でした。
おそらくこれに該当するものと思われます。

各Timerオブジェクトと対応するのは、タイマーのタスクをすべて連続して実行するために使用される、単一のバックグラウンド・スレッドです。タイマー・タスクは迅速に実行される必要があります。タイマー・タスクの完了に時間がかかりすぎると、タイマーのタスク実行スレッドが「占有」されます。これにより後続のタスクの実行が遅れ、違反したタスクの完了時(完了した場合)に、立て続けに「まとめて」実行されることになります。

Timer (Java Platform SE 8 )

Clipのcloseは、想像以上に高コストなんではないでしょうか。

---

メモリに関しては上下しつつ上昇トレンドですが、GCをかければ50MB程度に戻りました。

特に回答にはなっていないのですが^^;
ミニマルなサンプルで、巻き戻しも含めて再検討したらどうでしょうか。

import java.io.File;
import java.io.IOException;
import java.time.Instant;
import java.util.Arrays;
import java.util.List;
import java.util.Timer;
import java.util.TimerTask;
import javax.sound.sampled.AudioFormat;
import javax.sound.sampled.AudioInputStream;
import javax.sound.sampled.AudioSystem;
import javax.sound.sampled.Clip;
import javax.sound.sampled.DataLine;
import javax.sound.sampled.LineUnavailableException;
import javax.sound.sampled.UnsupportedAudioFileException;
import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JPanel;

public class Main extends JFrame {
    public static void main(String[] args) {
        new Main().setVisible(true);
    }

    public Main() {
        setSize(300, 100);
        setLocationRelativeTo(null);
        setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

        List<String> sounds = Arrays.asList(
                "C:\Windows\Media\Windows Background.wav",
                "C:\Windows\Media\Windows Background.wav",
                "C:\Windows\Media\Windows Background.wav",
                "C:\Windows\Media\Windows Background.wav",
                "C:\Windows\Media\Windows Background.wav",
                "C:\Windows\Media\Windows Background.wav",
                "C:\Windows\Media\Windows Background.wav",
                "C:\Windows\Media\Windows Background.wav");

        JPanel panel = new JPanel();
        add(panel);

        JButton button1 = new JButton("play");
        button1.addActionListener(ae -> {
            for (String path : sounds) {
                new MusicPlayer(path);
                try {
                    Thread.sleep(200);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        });
        panel.add(button1);

        JButton button2 = new JButton("gc");
        button2.addActionListener(ae -> System.gc());
        panel.add(button2);
    }
}

class MusicPlayer {
    private Clip p;
    private Timer timer;

    public MusicPlayer(String filePath) {
        p = LoadClipPlayer(filePath);
        p.start();

        timer = new Timer(true);
        TimerTask timerTask = new TimerTask() {
            public void run() {
                p.stop();
                p.close();
                System.out.println(Instant.now() + " timer stopped and clip closed");
                timer.cancel();
            }
        };
        timer.schedule(timerTask, (int) (p.getMicrosecondLength() / 1000));

        System.out.println(Instant.now() + " timer and clip started");
    }

    private static Clip LoadClipPlayer(String filePath) {
        Clip clip = null;
        try (AudioInputStream stream = AudioSystem.getAudioInputStream(new File(filePath))) {
            AudioFormat format = stream.getFormat();
            DataLine.Info dataLine = new DataLine.Info(Clip.class, format);
            clip = (Clip) AudioSystem.getLine(dataLine);
            clip.open(stream);
        } catch (UnsupportedAudioFileException e) {
            e.printStackTrace();
        } catch (LineUnavailableException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }

        return clip;
    }
}

Comments

[pami]

言葉足らずの説明から趣旨をくみ取ってくださり、ありがとうございます。まさに仰ったようなプログラムを作成しています。

clipのcloseが高コストであることは存じ上げませんでした。確かに、頂いたプログラムを実行しても、時折closeのためにプログラムが固まるようでした。

プログラム含め、大変参考になりました。ご回答ありがとうございます。

Answer 3

finallyで常にclose()してもダメでしょうか。

	private static void LoadClipPlayer(String filePath) {
		AudioInputStream stream = null;
		try {
			stream = AudioSystem.getAudioInputStream(new File(filePath));
			AudioFormat format = stream.getFormat();
			DataLine.Info dataLine = new DataLine.Info(Clip.class, format);
			Clip clip = (Clip) AudioSystem.getLine(dataLine);
			clip.open(stream);
			clip.start();
		} catch (UnsupportedAudioFileException e) {
			e.printStackTrace();
		} catch (LineUnavailableException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		} finally {
			try {
				stream.close();
			} catch (Exception e) {
				e.printStackTrace();
			}
		}
	}

Comments

[退会済みユーザー]

あ・・・いま気付いたのですが、Clipを自動Closeするのなら、Clipをtry-with-resourcesしないとダメかもです。

[pami]

finallyで常にcloseすると、今度は音が一切鳴らなくなってしまったようです。clipをtry-with-resourcesしてみたのですが、こちらも音が一切鳴りませんでした。

私の推察ですが、
・finallyで常にcloseすると、tryブロックでclipがstartした直後にcloseすることになり、音が鳴らないのではないか
・clipをtry-with-resourcesすると、確かにclipは自動的にcloseできるが、そのtryブロックを抜けるとすぐにcloseしてしまうため、結果として音が全くならないのではないか
と考えました。

try-with-resourcesをうまく使えれば、clipの自動closeを実現できそうな気がしました。
ご回答ありがとうございます。

Answer 4

やりたいのは↓でしょうか。
try-finallyよりもtry-with-resourcesを使おう

Comments

[pami]

頂いた記事を拝読し修正してみたのですが、「試したこと」の項目に追記した通り、うまくいかなかったようです。（もしかしたら私が修正したソースコードに誤りがあるかもしれません）
また記事にあるように、Clipではなくストリーム再生で実装しようとすると、どうもwriteする際のwhileループによりアプリ全体にラグが発生するようだったため、ストリーム再生による実装は断念したという経緯があります。言葉足らずで申し訳ございません。
再度修正方法を模索してみます。ご回答ありがとうございます。

Answer 5

10年以上Javaしてませんが、GCが動くタイミングは制御できなかったような・・・。
ちなみにGCについては、下記の記事が参考になるかもです。
JavaのGCの仕組みを整理する

Comments

[pami]

ご回答ありがとうございます！
タイトルの書き方が悪くて申し訳なかったのですが、実現したいことはGCの制御ではなく、Clipのcloseを勝手に実行してくれる機構でした…
頂いた記事は拝読します。ありがとうございます。