x265-1.8版本-common/piclist.h注释

/*****************************************************************************
* Copyright (C) 2013 x265 project
*
* Authors: Gopu Govindaswamy <gopu@multicorewareinc.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
*
* This program is also available under a commercial proprietary license.
* For more information, contact us at license @ x265.com.
*****************************************************************************/

#ifndef X265_PICLIST_H
#define X265_PICLIST_H

#include "common.h"

namespace X265_NS {
class Frame;
//DPB 中有两个列表 m_picList; m_freeList; 用于存储解码帧和??？？
//Lookahead 中两个列表  m_inputQueue; m_outputQueue; 用于帧类型决策的输入输出
class PicList
{
protected:

Frame*   m_start;//队列的第一帧
Frame*   m_end;//队列最后一帧
int      m_count;//队列中总共有多少帧

public:

PicList()//初始化
{
m_start = NULL;
m_end   = NULL;
m_count = 0;
}

/** Push picture to end of the list */
/** 函数功能       ： 将帧加入到队列尾位置
* \参数 curFrame   ： 视频帧
*   返回值         ： null
**/
void pushBack(Frame& pic);

/** Push picture to beginning of the list */
/** 函数功能       ： 将帧加入到队列首位置
* \参数 curFrame   ： 视频帧
*   返回值         ： null
**/
void pushFront(Frame& pic);

/** Pop picture from end of the list */
/** 函数功能       ： 返回队列中的最后一帧并在列表中删除
*   返回值         ： 返回队列中的最后一帧
**/
Frame* popBack();

/** Pop picture from beginning of the list */
/** 函数功能       ： 返回队列中的第一帧并在列表中删除
*   返回值         ： 返回队列中的第一帧
**/
Frame* popFront();

/** Find frame with specified POC */
/** 函数功能       ： 返回队列中对应poc的帧 不在列表中删除
* \参数 poc        ： 视频帧poc
*   返回值         ： 返回队列中对应poc的帧
**/
Frame* getPOC(int poc);

/** Remove picture from list */
/** 函数功能       ： 从列表中删除对应视频帧
* \参数 curFrame   ： 视频帧
*   返回值         ： null
**/
void remove(Frame& pic);

Frame* first()        { return m_start;   }//获取列表中的第一帧

Frame* last()         { return m_end;     }//获取列表中的最后一帧

int size()            { return m_count;   }//获取列表长度

bool empty() const    { return !m_count;  }//判断是否为空，空返回true

operator bool() const { return !!m_count; }//重载运算符 bool强制类型转换
};
}

#endif // ifndef X265_PICLIST_H