package com.serenegiant.media;
/*
 * libcommon
 * utility/helper classes for myself
 *
 * Copyright (c) 2014-2023 saki t_saki@serenegiant.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
*/

import java.util.concurrent.TimeUnit;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

/**
 * バッファリング用のFIFOバッファインターフェース
 */
public interface IMediaQueue<T extends IRecycleBuffer> extends IRecycleParent<T> {
	/**
	 * キューを初期化
	 * @param args
	 */
	public void init(@Nullable final Object... args);

	/**
	 * キューをクリア
	 */
	public void clear();

	/**
	 * キュー内のデータを全てリサイクルして空にする
	 */
	public void drainAll();

	/**
	 * バッファプールからIRecycleBufferを取得
	 * @return
	 */
	@Nullable
	public T obtain(@Nullable final Object... args);

	/**
	 * キューに追加
	 * @param buffer
	 * @return
	 */
	public boolean queueFrame(@NonNull final T buffer);
	
	/**
	 * キューの先頭を取得
	 * キューが空の時はnullを返す
	 * @return
	 */
	@Nullable
	public T peek();
	
	/**
	 * キューの先頭を除去して返す
	 * キューが空の時はnullを返す
	 * @return
	 */
	@Nullable
	public T poll();
	
	/**
	 * キューの先頭を除去して返す
	 * キューが空の時は指定時間待機する
	 * @param timeout
	 * @param unit
	 * @return
	 * @throws InterruptedException
	 */
	@Nullable
	public T poll(final long timeout, final TimeUnit unit)
		throws InterruptedException;

	/**
	 * キュー内の個数を取得
	 */
	public int count();
}
