RDK Documentation (Open Sourced RDK Components)
videoDFC.hpp
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2016 RDK Management
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18 */
19 
20 
21 /**
22  * @file videoDFC.hpp
23  * @brief This file defines VideoDFC class for managing video decoder format conversion types.
24  */
25 
26 
27 
28 /**
29 * @defgroup devicesettings
30 * @{
31 * @defgroup ds
32 * @{
33 **/
34 
35 
36 #ifndef _DS_VIDEODFC_HPP_
37 #define _DS_VIDEODFC_HPP_
38 
39 #include "dsConstant.hpp"
40 #include <string>
41 
42 namespace device {
43 
44 
45 /**
46  * @class VideoDFC
47  * @brief This class extends DSConstant to manage the video Decoder Format Conversion.
48  * @ingroup devicesettingsclass
49  */
50 class VideoDFC : public DSConstant {
51 
52 public:
53  static const int kUnknown; //!< Indicates decoder format of type unknown.
54  static const int kNone; //!< Indicates decoder format of type none.
55  static const int kFull; //!< Indicates decoder format of type full.
56 
57  static const int kLetterBox_16x9; //!< Indicates decoder format of type letter box with 16:9 aspect ratio.
58  static const int kLetterBox_14x9; //!< Indicates decoder format of type letter box with 14:9 aspect ratio.
59 
60  static const int kCCO; //!< Indicates center cut out decoder format.
61 
62  static const int kPanScan; //!< Indicates decoder format of type pan and scan.
63 
64  static const int kLetterBox_221x1ON4x3; //!< Indicates decoder format of type letter box 2:21:1 in a 4:3 video frame.
65 
66  static const int kLetterBox_221x1ON16x9; //!< Indicates decoder format of type letter box 2:21:1 in a 16:9 video frame.
67 
68  static const int kPlatform; //!< Indicates decoding format conversion will be managed by the platform.
69 
70  static const int kZoom_16x9; //!< Indicates decoder format of type 16:9 zoom.
71 
72  static const int kPillarBox_4x3; //!< Indicates decoder format of type pillar box 4:3.
73 
74  static const int kWideScreen_4x3; //!< Indicates decoder format of type 4:3 wide.
75 
76  static const VideoDFC & getInstance(int id);
77  static const VideoDFC & getInstance(const std::string &name);
78 
79  VideoDFC(int id);
80  virtual ~VideoDFC();
81 };
82 
83 }
84 
85 #endif /* _DS_VIDEODFC_HPP_ */
86 
87 
88 /** @} */
89 /** @} */
device::VideoDFC::~VideoDFC
virtual ~VideoDFC()
This function is the default destructor for VideoDFC.
Definition: videoDFC.cpp:157
device::VideoDFC::kLetterBox_221x1ON4x3
static const int kLetterBox_221x1ON4x3
Indicates decoder format of type letter box 2:21:1 in a 4:3 video frame.
Definition: videoDFC.hpp:64
device::VideoDFC::VideoDFC
VideoDFC(int id)
This function is a parameterised constructor. It initializes the instance with the id provided and th...
Definition: videoDFC.cpp:139
dsConstant.hpp
This file defines DSConstant class which is inherited by most of the device settings classes.
device::VideoDFC::kZoom_16x9
static const int kZoom_16x9
Indicates decoder format of type 16:9 zoom.
Definition: videoDFC.hpp:70
device::VideoDFC::kWideScreen_4x3
static const int kWideScreen_4x3
Indicates decoder format of type 4:3 wide.
Definition: videoDFC.hpp:74
device::DSConstant
This class is used to store and manage the names and id's. It is derived by many classes like VideoRe...
Definition: dsConstant.hpp:52
device::VideoDFC::kPanScan
static const int kPanScan
Indicates decoder format of type pan and scan.
Definition: videoDFC.hpp:62
device::VideoDFC::kPlatform
static const int kPlatform
Indicates decoding format conversion will be managed by the platform.
Definition: videoDFC.hpp:68
device::VideoDFC::getInstance
static const VideoDFC & getInstance(int id)
This function gets an instance of VideoDFC against the id specified, only if the id passed is valid.
Definition: videoDFC.cpp:95
device::VideoDFC
This class extends DSConstant to manage the video Decoder Format Conversion.
Definition: videoDFC.hpp:50
device::VideoDFC::kPillarBox_4x3
static const int kPillarBox_4x3
Indicates decoder format of type pillar box 4:3.
Definition: videoDFC.hpp:72
device::VideoDFC::kLetterBox_221x1ON16x9
static const int kLetterBox_221x1ON16x9
Indicates decoder format of type letter box 2:21:1 in a 16:9 video frame.
Definition: videoDFC.hpp:66
device::VideoDFC::kUnknown
static const int kUnknown
Indicates decoder format of type unknown.
Definition: videoDFC.hpp:53
device::VideoDFC::kLetterBox_16x9
static const int kLetterBox_16x9
Indicates decoder format of type letter box with 16:9 aspect ratio.
Definition: videoDFC.hpp:57
device::VideoDFC::kFull
static const int kFull
Indicates decoder format of type full.
Definition: videoDFC.hpp:55
device::VideoDFC::kCCO
static const int kCCO
Indicates center cut out decoder format.
Definition: videoDFC.hpp:60
device::VideoDFC::kNone
static const int kNone
Indicates decoder format of type none.
Definition: videoDFC.hpp:54
device::VideoDFC::kLetterBox_14x9
static const int kLetterBox_14x9
Indicates decoder format of type letter box with 14:9 aspect ratio.
Definition: videoDFC.hpp:58