Start bringing doxygen documentation into a new level
This commit is contained in:
1 parent
b9c67de13b
commit
ea05c49858
19 files changed
+491
-269
No files matched your search
+31
-14
@@ -1,24 +1,40 @@
|
||||
/** @mainpage plaYUVer Application
|
||||
/** @mainpage PlaYUVer Project
|
||||
|
||||
Description
|
||||
----------------------------------------------------------------
|
||||
|
||||
plaYUVer is an open-source video player with the following features:
|
||||
- support for libavformat and libavcodec;
|
||||
- support for wide range of raw video formats;
|
||||
- advanced frame zoom with easy to use pan function
|
||||
- usefull information in status bar, *e.g.*, pixel information
|
||||
- API for frame processing algorithms
|
||||
- Support for libavformat and libavcodec;
|
||||
- Support for wide range of raw video formats;
|
||||
- Support for OpenCV imag/video processing library
|
||||
- Advanced frame zoom with easy to use pan function
|
||||
- Usefull information in status bar, *e.g.*, pixel information
|
||||
- Usefull sidebars with stream and frame information, *e.g.*, frame histogram
|
||||
- Constant growing libs for stream and frame processing (PlaYUVerStream PlaYUVerFrame)
|
||||
- Advanced API for frame/video processing algorithms
|
||||
- Frame level quality measurement API based on the PlaYUVerFrame class
|
||||
|
||||
Modules
|
||||
----------------------------------------------------------------
|
||||
- PlaYUVerLib: Low level library
|
||||
- PlaYUVerModules: Abstract interface for frame processing modules
|
||||
- PlaYUVerApp: High level graphical interface
|
||||
- PlaYUVerTools: High level command line interface
|
||||
|
||||
|
||||
Developers
|
||||
----------------------------------------------------------------
|
||||
|
||||
- Joao Carreira (jfmcarreira@gmail.com)
|
||||
- Luis Lucas (luisfrlucas@gmail.com)
|
||||
- Luis Lucas (luisfrlucas@gmail.com)
|
||||
|
||||
|
||||
Install using cmake
|
||||
Builds
|
||||
----------------------------------------------------------------
|
||||
Download update build for windows and linux from our <a href="https://sourceforge.net/projects/playuver/">SourceForge project page</a>
|
||||
|
||||
|
||||
Build/Install using cmake
|
||||
----------------------------------------------------------------
|
||||
|
||||
1. The following are required for compilation:
|
||||
@@ -26,17 +42,18 @@ Install using cmake
|
||||
- cmake
|
||||
- a Qt development environment (libraries, headers, qmake, ...): only QtCore, QtGui and QtWidgets are required, at least in version 4
|
||||
|
||||
2. Dependencies:
|
||||
- QT
|
||||
- FFmpeg (optional)
|
||||
- OpenCv (optional)
|
||||
2. Optional Dependencies:
|
||||
- QtDBus
|
||||
- OpenCv
|
||||
- FFmpeg
|
||||
|
||||
3. Run the following commands: (this will create an executable named playuver)
|
||||
3. Run the following commands: (this will create an executable named playuver)
|
||||
```
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ../
|
||||
cmake -DUSE_QT4=OFF -DUSE_FFMPEG=ON -DUSE_OPENCV=ON .. (for FFmpeg and OpenCV support)
|
||||
make
|
||||
make install
|
||||
```
|
||||
|
||||
|
||||
|
||||
+13
-1
@@ -19,7 +19,19 @@
|
||||
|
||||
/**
|
||||
* \file SubWindowHandle.h
|
||||
* \ingroup PlaYUVerApp PlaYUVerApp_Subwindow
|
||||
* \brief Sub windows handling
|
||||
*
|
||||
* @defgroup PlaYUVerApp_Subwindow SubWindow definition
|
||||
* @{
|
||||
* \ingroup PlaYUVerApp
|
||||
*
|
||||
* Different SubWindow may be found in the PlaYUVerApp
|
||||
* Each one provide different functionality and serve
|
||||
* different purposes, ( e.g., displaying a video stream
|
||||
* or displaying a quality plot)
|
||||
*
|
||||
* @}
|
||||
*/
|
||||
|
||||
#ifndef __SUBWINDOWHANDLE_H__
|
||||
@@ -105,7 +117,7 @@ public:
|
||||
return m_uiCategory;
|
||||
}
|
||||
|
||||
Void setSubWindow(PlaYUVerMdiSubWindow* subWindow )
|
||||
Void setSubWindow( PlaYUVerMdiSubWindow* subWindow )
|
||||
{
|
||||
m_cSubWindow = subWindow;
|
||||
}
|
||||
|
||||
+11
-1
@@ -19,7 +19,18 @@
|
||||
|
||||
/**
|
||||
* \file plaYUVerApp.h
|
||||
* \ingroup PlaYUVerApp
|
||||
* \brief Main definition of the plaYUVerApp app
|
||||
*
|
||||
* @defgroup PlaYUVerApp PlaYUVer App (GUI)
|
||||
* @{
|
||||
*
|
||||
* PlaYUVerApp is an high level interface providing a GUI
|
||||
* based on the Qt libs in order to display provide important
|
||||
* information about video streams.
|
||||
*
|
||||
* @}
|
||||
*
|
||||
*/
|
||||
|
||||
#ifndef __PLAYUVERAPP_H__
|
||||
@@ -90,7 +101,6 @@ private Q_SLOTS:
|
||||
void zoomToFit();
|
||||
void zoomToFitAll();
|
||||
|
||||
|
||||
void setTool( int idxTool );
|
||||
|
||||
void dragEnterEvent( QDragEnterEvent *event );
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file LibAvContextHandle.cpp
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Interface with libav libs
|
||||
*/
|
||||
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file LibAvContextHandle.h
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Interface with libav libs
|
||||
*/
|
||||
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file LibMemory.cpp
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Memory allocation functions
|
||||
*/
|
||||
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file LibOpenCVHandler.cpp
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Interface with opencv lib
|
||||
*/
|
||||
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file LibOpenCVHandler.h
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Interface with opencv lib
|
||||
*/
|
||||
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file TypeDef.h
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Define basic types, new types and enumerations
|
||||
*/
|
||||
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file PlaYUVerFrame.cpp
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Video Frame handling
|
||||
*/
|
||||
|
||||
@@ -361,7 +362,7 @@ Void PlaYUVerFrame::fromCvMat( Void* voidFrame )
|
||||
m_iPixelFormat = GRAY;
|
||||
break;
|
||||
case 4:
|
||||
m_iPixelFormat = RGB8;
|
||||
m_iPixelFormat = RGB24;
|
||||
break;
|
||||
default:
|
||||
return;
|
||||
|
||||
+98
-58
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file PlaYUVerFrame.h
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Video Frame handling
|
||||
*/
|
||||
|
||||
@@ -37,7 +38,13 @@ class PixFcSSE;
|
||||
namespace plaYUVer
|
||||
{
|
||||
|
||||
class PlaYUVerFrame : public PlaYUVerFrameStats
|
||||
struct PlaYUVerFramePelFormat;
|
||||
|
||||
/**
|
||||
* \class PlaYUVerFrame
|
||||
* \ingroup PlaYUVerLib
|
||||
*/
|
||||
class PlaYUVerFrame: public PlaYUVerFrameStats
|
||||
{
|
||||
public:
|
||||
class Pixel
|
||||
@@ -60,19 +67,43 @@ public:
|
||||
PixelComponents[1] = c1;
|
||||
PixelComponents[2] = c2;
|
||||
}
|
||||
Int ColorSpace() { return m_iColorSpace; }
|
||||
Pel* Components() { return PixelComponents; }
|
||||
Pel& Y() { return PixelComponents[0]; }
|
||||
Pel& Cb() { return PixelComponents[1]; }
|
||||
Pel& Cr() { return PixelComponents[2]; }
|
||||
Pel& R() { return PixelComponents[0]; }
|
||||
Pel& G() { return PixelComponents[1]; }
|
||||
Pel& B() { return PixelComponents[2]; }
|
||||
Int ColorSpace()
|
||||
{
|
||||
return m_iColorSpace;
|
||||
}
|
||||
Pel* Components()
|
||||
{
|
||||
return PixelComponents;
|
||||
}
|
||||
Pel& Y()
|
||||
{
|
||||
return PixelComponents[0];
|
||||
}
|
||||
Pel& Cb()
|
||||
{
|
||||
return PixelComponents[1];
|
||||
}
|
||||
Pel& Cr()
|
||||
{
|
||||
return PixelComponents[2];
|
||||
}
|
||||
Pel& R()
|
||||
{
|
||||
return PixelComponents[0];
|
||||
}
|
||||
Pel& G()
|
||||
{
|
||||
return PixelComponents[1];
|
||||
}
|
||||
Pel& B()
|
||||
{
|
||||
return PixelComponents[2];
|
||||
}
|
||||
};
|
||||
|
||||
/** ColorSpace Enum
|
||||
* List of supported color spaces
|
||||
*/
|
||||
* List of supported color spaces
|
||||
*/
|
||||
enum ColorSpace
|
||||
{
|
||||
COLOR_INVALID = -1,
|
||||
@@ -83,8 +114,8 @@ public:
|
||||
};
|
||||
|
||||
/** ColorSpace Enum
|
||||
* List of supported pixel formats (old)
|
||||
*/
|
||||
* List of supported pixel formats (old)
|
||||
*/
|
||||
enum PixelFormats
|
||||
{
|
||||
NO_FMT = -1,
|
||||
@@ -99,52 +130,59 @@ public:
|
||||
};
|
||||
|
||||
/**
|
||||
* Function that handles the supported pixel formats
|
||||
* of PlaYUVerFrame
|
||||
* @@return vector of strings with pixel formats names
|
||||
*
|
||||
*/
|
||||
* Function that handles the supported pixel formats
|
||||
* of PlaYUVerFrame
|
||||
* @@return vector of strings with pixel formats names
|
||||
*/
|
||||
static std::vector<std::string> supportedPixelFormatListNames();
|
||||
|
||||
/**
|
||||
* Creates a new frame using the following configuration
|
||||
*
|
||||
* @param width width of the frame
|
||||
* @param height height of the frame
|
||||
* @param pel_format pixel format index (always use PixelFormats enum)
|
||||
*
|
||||
* @note this function might misbehave if the pixel format enum is not correct
|
||||
*
|
||||
*/
|
||||
* Creates a new frame using the following configuration
|
||||
*
|
||||
* @param width width of the frame
|
||||
* @param height height of the frame
|
||||
* @param pel_format pixel format index (always use PixelFormats enum)
|
||||
*
|
||||
* @note this function might misbehave if the pixel format enum is not correct
|
||||
*/
|
||||
PlaYUVerFrame( UInt width = 0, UInt height = 0, Int pel_format = 0 );
|
||||
|
||||
|
||||
/**
|
||||
* Creates and new frame with the configuration of an
|
||||
* existing one and copy its contents
|
||||
*
|
||||
* @param other existing frame to copy from
|
||||
*
|
||||
*/
|
||||
* Creates and new frame with the configuration of an
|
||||
* existing one and copy its contents
|
||||
*
|
||||
* @param other existing frame to copy from
|
||||
*/
|
||||
PlaYUVerFrame( PlaYUVerFrame * );
|
||||
|
||||
|
||||
/**
|
||||
* Creates and new frame with the configuration of an
|
||||
* existing one and copy its contents.
|
||||
* This function only copies a specific region from the existing frame
|
||||
*
|
||||
* @param other existing frame to copy from
|
||||
* @param posX position X to crop from
|
||||
* @param posY position Y to crop from
|
||||
* @param areaWidth crop width
|
||||
* @param areaHeight crop height
|
||||
*
|
||||
*/
|
||||
* Creates and new frame with the configuration of an
|
||||
* existing one and copy its contents.
|
||||
* This function only copies a specific region from the existing frame
|
||||
*
|
||||
* @param other existing frame to copy from
|
||||
* @param posX position X to crop from
|
||||
* @param posY position Y to crop from
|
||||
* @param areaWidth crop width
|
||||
* @param areaHeight crop height
|
||||
*/
|
||||
PlaYUVerFrame( PlaYUVerFrame *other, UInt posX, UInt posY, UInt areaWidth, UInt areaHeight );
|
||||
|
||||
~PlaYUVerFrame();
|
||||
|
||||
UInt64 getBytesPerFrame();
|
||||
/**
|
||||
* Get number of bytes per frame of a specific
|
||||
* pixel format
|
||||
* @@return number of bytes per frame
|
||||
*/
|
||||
static UInt64 getBytesPerFrame( UInt, UInt, Int );
|
||||
|
||||
/**
|
||||
* Get number of bytes per frame of an existing frame
|
||||
* @@return number of bytes per frame
|
||||
*/
|
||||
UInt64 getBytesPerFrame();
|
||||
|
||||
Int getColorSpace() const;
|
||||
UInt getNumberChannels() const;
|
||||
UInt getChromaWidth() const;
|
||||
@@ -229,7 +267,7 @@ public:
|
||||
NUMBER_METRICS,
|
||||
};
|
||||
|
||||
static std::vector<std::string> supportedQualityMetricsList()
|
||||
static std::vector<std::string> supportedQualityMetricsList()
|
||||
{
|
||||
std::vector<std::string> metrics;
|
||||
metrics.push_back( "PSNR" );
|
||||
@@ -245,20 +283,22 @@ public:
|
||||
|
||||
private:
|
||||
|
||||
struct structPlaYUVerFramePelFormat* m_pcPelFormat;
|
||||
//! Strcut with the pixel format description.
|
||||
PlaYUVerFramePelFormat* m_pcPelFormat;
|
||||
|
||||
UInt m_uiWidth; //!< Width of the frame
|
||||
UInt m_uiHeight; //!< Height of the frame
|
||||
Int m_iPixelFormat; //!< Pixel format number (it follows the list of supported pixel formats)
|
||||
Int m_iNumberChannels;
|
||||
Int m_iBitsChannels;
|
||||
UInt m_uiWidth; //!< Width of the frame
|
||||
UInt m_uiHeight; //!< Height of the frame
|
||||
Int m_iPixelFormat; //!< Pixel format number (it follows the list of supported pixel formats)
|
||||
Int m_iNumberChannels; //!< Number of channels
|
||||
Int m_iBitsChannels; //!< Bits per pixel/channel
|
||||
|
||||
Pel*** m_pppcInputPel;
|
||||
|
||||
Bool m_bHasRGBPel; //!< Flag indicating that the ARGB buffer was computed
|
||||
UChar* m_pcRGB32; //!< Buffer with the ARGB pixels used in Qt libs
|
||||
Pel*** m_pppcInputPel;
|
||||
|
||||
Bool m_bHasRGBPel; //!< Flag indicating that the ARGB buffer was computed
|
||||
UChar* m_pcRGB32; //!< Buffer with the ARGB pixels used in Qt libs
|
||||
|
||||
Void init( UInt width, UInt height, Int pel_format );
|
||||
|
||||
Void openPixfc();
|
||||
Void closePixfc();
|
||||
PixFcSSE* m_pcPixfc;
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file PlaYUVerFramePixelFormats.cpp
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Handling the pixel formats definition
|
||||
*/
|
||||
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file PlaYUVerFramePixelFormats.h
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Handling the pixel formats definition
|
||||
*/
|
||||
|
||||
@@ -69,7 +70,7 @@ inline Int pelAlpha( UInt rgb ) // get alpha part of RGBA
|
||||
#define PEL_RGB( r, g, b ) \
|
||||
( 0xffu << 24 ) | ( ( r & 0xff ) << 16 ) | ( ( g & 0xff ) << 8 ) | ( b & 0xff )
|
||||
|
||||
struct structPlaYUVerFramePelFormat
|
||||
typedef struct PlaYUVerFramePelFormat
|
||||
{
|
||||
const Char* name;
|
||||
Int colorSpace;
|
||||
@@ -80,9 +81,7 @@ struct structPlaYUVerFramePelFormat
|
||||
Void (*bufferFromFrame)( Pel ***in, Pel* out, UInt width, UInt height );
|
||||
Void (*fillRGBbuffer)( Pel*** in, UChar* out, UInt width, UInt height );
|
||||
Int ffmpegPelFormat;
|
||||
};
|
||||
|
||||
typedef struct structPlaYUVerFramePelFormat PlaYUVerFramePelFormat;
|
||||
}PlaYUVerFramePelFormat;
|
||||
|
||||
#define PLAYUVER_NUMBER_FORMATS 7
|
||||
extern PlaYUVerFramePelFormat g_PlaYUVerFramePelFormatsList[PLAYUVER_NUMBER_FORMATS];
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file PlaYUVerFrameStats.cpp
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Measure PlaYUVerFrame statistics
|
||||
* Based on the work of Ricardo N. Rocha Sardo in SCode project
|
||||
*/
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file PlaYUVerFrameStats.h
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Measure PlaYUVerFrame statistics
|
||||
* Based on the work of Ricardo N. Rocha Sardo in SCode project
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
/* This file is a part of plaYUVer project
|
||||
* Copyright (C) 2014-2015 by Luis Lucas (luisfrlucas@gmail.com)
|
||||
* Joao Carreira (jfmcarreira@gmail.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 02110-1301 USA.
|
||||
*/
|
||||
|
||||
/**
|
||||
* \file PlaYUVerLib.h
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Inlcude all modules of PlaYUVer Lib
|
||||
*/
|
||||
|
||||
#ifndef __PLAYUVERLIB_H_
|
||||
#define __PLAYUVERLIB_H_
|
||||
|
||||
/**
|
||||
* @defgroup PlaYUVerLib PlaYUVer Lib
|
||||
* @{
|
||||
*
|
||||
* PlaYUVerLib is an independent module that provide the low level interface
|
||||
* for dealing with streams and frames.
|
||||
*
|
||||
* Two main interfaces are defining PlaYUVerFrame and PlaYUVerStream.
|
||||
* Moreover handler for external libs, as FFmpeg and OpenCv are provided
|
||||
* which enables PlaYUVer to boost its functionality using external libs.
|
||||
*
|
||||
* This guaratees that the top-level applications does not need to worry
|
||||
* about dealig with different stream formats as well as different pixel formats
|
||||
*
|
||||
* @defgroup PlaYUVerLib_Stream PlaYUVerStream
|
||||
* @{
|
||||
* Describe PlaYUVerStream
|
||||
* @}
|
||||
*
|
||||
* @defgroup PlaYUVerLib_Frame PlaYUVerFrame
|
||||
* @{
|
||||
* Describe PlaYUVerFrame
|
||||
* @}
|
||||
*
|
||||
* @}
|
||||
*
|
||||
*/
|
||||
|
||||
#include "PlaYUVerFrame.h"
|
||||
#include "PlaYUVerStream.h"
|
||||
|
||||
#endif // __PLAYUVERLIB_H_
|
||||
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file PlaYUVerStream.cpp
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Input stream handling
|
||||
*/
|
||||
|
||||
|
||||
+5
-14
@@ -19,6 +19,7 @@
|
||||
|
||||
/**
|
||||
* \file PlaYUVerStream.h
|
||||
* \ingroup PlaYUVerLib
|
||||
* \brief Input stream handling
|
||||
*/
|
||||
|
||||
@@ -44,6 +45,10 @@ typedef struct
|
||||
UInt uiHeight;
|
||||
} PlaYUVerStdResolution;
|
||||
|
||||
/**
|
||||
* \class PlaYUVerStream
|
||||
* \ingroup PlaYUVerLib
|
||||
*/
|
||||
class PlaYUVerStream
|
||||
{
|
||||
private:
|
||||
@@ -185,20 +190,6 @@ public:
|
||||
}
|
||||
Void getDuration( Int* duration_array );
|
||||
|
||||
Void setWidth( UInt new_width )
|
||||
{
|
||||
if( new_width > 0 && new_width % 2 == 0 )
|
||||
{
|
||||
m_uiWidth = new_width;
|
||||
}
|
||||
}
|
||||
Void setHeight( UInt new_height )
|
||||
{
|
||||
if( new_height > 0 && new_height % 2 == 0 )
|
||||
{
|
||||
m_uiHeight = new_height;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
} // NAMESPACE
|
||||
|
||||
Reference in new issue
Block a user