Aegisub/aegisub/src/video_frame.h
Amar Takhar 774fb0f674 Fix all the headers in *., this includes:
* Wrapping all headers that are in agi_pre.h with AGI_PRE.
  * Sorting alphabetically.
  * Same operation as r3515.

Note: This is broken when precompiled headers are not in use, I'll fix that after this commit so the two changes don't get jumbled up.

Originally committed to SVN as r3525.
2009-09-11 02:36:34 +00:00

126 lines
3.3 KiB
C++

// Copyright (c) 2007, Rodrigo Braz Monteiro
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$
/// @file video_frame.h
/// @see video_frame.cpp
/// @ingroup video
///
#pragma once
#ifndef AGI_PRE
#include <wx/image.h>
#endif
/// DOCME
enum VideoFrameFormat {
/// DOCME
FORMAT_NONE = 0x0000,
/// DOCME
FORMAT_RGB24 = 0x0001, // RGB, interleaved
/// DOCME
FORMAT_RGB32 = 0x0002, // RGBA, interleaved
/// DOCME
FORMAT_YUY2 = 0x0004, // YCbCr 4:2:2, planar
/// DOCME
FORMAT_YV12 = 0x0008, // YCbCr 4:2:0, planar
/// DOCME
FORMAT_YUV444 = 0x0010, // YCbCr 4:4:4, planar
/// DOCME
FORMAT_YUV444A = 0x0020, // YCbCr 4:4:4 plus alpha, planar
/// DOCME
FORMAT_YUVMONO = 0x0040, // Y only (greyscale)
};
/// DOCME
/// @class AegiVideoFrame
/// @brief DOCME
///
/// DOCME
class AegiVideoFrame {
private:
/// DOCME
unsigned int memSize;
void Reset();
public:
/// DOCME
unsigned char *data[4]; // Pointers to the data planes. Interleaved formats only use data[0]
/// DOCME
VideoFrameFormat format; // Data format
/// DOCME
unsigned int w; // Width in pixels
/// DOCME
unsigned int h; // Height in pixels
/// DOCME
unsigned int pitch[4]; // Pitch, that is, the number of bytes used by each row.
/// DOCME
bool flipped; // First row is actually the bottom one
/// DOCME
bool invertChannels; // Swap Red and Blue channels or U and V planes (controls RGB versus BGR ordering etc)
/// DOCME
bool cppAlloc; // Allocated with C++'s "new" operator, instead of "malloc"
AegiVideoFrame();
AegiVideoFrame(int width,int height,VideoFrameFormat format=FORMAT_RGB32);
void Allocate();
void Clear();
void CopyFrom(const AegiVideoFrame &source);
void ConvertFrom(const AegiVideoFrame &source);
wxImage GetImage() const;
void GetFloat(float *buffer) const;
int GetBpp(int plane=0) const;
};