libctru: Y2R_DitheringWeightParams Struct Reference

From 83661ceb9e8ef3164ea0c036672953c2fa6408a8 Mon Sep 17 00:00:00 2001 From: TravisCI-DocBuilder Date: Thu, 22 Oct 2015 09:27:49 +0000 Subject: [PATCH] Doc generated from commit 94354776994bfa714b121c66b44390a7819a6d14 --- annotated.html | 1 + classes.html | 47 +-- globals_func_y.html | 18 +- globals_y.html | 18 +- structY2R__DitheringWeightParams.html | 162 ++++++++ y2r_8h.html | 83 ++-- y2r_8h_source.html | 575 ++++++++++++++------------ 7 files changed, 591 insertions(+), 313 deletions(-) create mode 100644 structY2R__DitheringWeightParams.html diff --git a/annotated.html b/annotated.html index 1e1b9d9..0a555c9 100644 --- a/annotated.html +++ b/annotated.html @@ -152,6 +152,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); CtouchPositionTouch position CY2R_ColorCoefficientsCoefficients of the YUV->RGB conversion formula CY2R_ConversionParamsStructure used to configure all parameters at once + CY2R_DitheringWeightParamsDithering weights diff --git a/classes.html b/classes.html index 3faed28..bb65b50 100644 --- a/classes.html +++ b/classes.html @@ -90,49 +90,50 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

A | C | D | E | F | G | H | I | L | M | N | O | P | Q | R | S | T | Y

- + - - - + + + + - - + + - + - + - - + + + +

DVLE_s

MemInfo

DVLE_s

MemInfo

Y2R_DitheringWeightParams

DVLE_uniformEntry_s

AM_TitleEntry

DVLP_s

accelVector

mvdstdConfig

AM_TitleEntry

DVLP_s

mvdstdConfig

OutputStringEvent

angularRate

OutputStringEvent

accelVector

aptHookCookie

CAMU_ImageQualityCalibrationData

ExceptionEvent

ndspAdpcmData

CAMU_PackageParameterCameraSelect

ExitProcessEvent

PageInfo

tag_ndspWaveBuf

CAMU_PackageParameterContext

ExitThreadEvent

PrintConsole

circlePosition

angularRate

CAMU_ImageQualityCalibrationData

ExceptionEvent

aptHookCookie

ndspAdpcmData

CAMU_PackageParameterCameraSelect

ExitProcessEvent

PageInfo

tag_ndspWaveBuf

CAMU_PackageParameterContext

ExitThreadEvent

PrintConsole

CAMU_PackageParameterContextDetail

ProcessEvent

circlePosition

CAMU_StereoCameraCalibrationData

pollfd

ConsoleFont

FS_archive

float24Uniform_s

CreateThreadEvent

FS_dirent

RecursiveLock

ConsoleFont

FS_archive

CreateThreadEvent

FS_dirent

RecursiveLock

float24Uniform_s

CSND_CapInfo

FS_path

qtmHeadtrackingInfo

CSND_ChnInfo

hostent

qtmHeadtrackingInfoCoord

SchedulerInOutEvent

httpcContext

GSP_CaptureInfo

SyscallInOutEvent

SchedulerInOutEvent

hostent

GSP_CaptureInfo

SyscallInOutEvent

httpcContext

DebugEventInfo

GSP_CaptureInfoEntry

rbtree_node

DVLB_s

GSP_FramebufferInfo

in_addr

rbtree

DVLB_s

GSP_FramebufferInfo

rbtree

DVLE_constEntry_s

Y2R_ColorCoefficients

romfs_dir

DVLE_outEntry_s

Y2R_ConversionParams

romfs_file

MapEvent

linger

Y2R_ColorCoefficients

in_addr

romfs_dir

DVLE_outEntry_s

Y2R_ConversionParams

romfs_file

MapEvent

linger

A | C | D | E | F | G | H | I | L | M | N | O | P | Q | R | S | T | Y

diff --git a/globals_func_y.html b/globals_func_y.html index 4a9b916..87f5f22 100644 --- a/globals_func_y.html +++ b/globals_func_y.html @@ -132,6 +132,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Y2RU_DriverInitialize() : y2r.h

Y2RU_GetDitheringWeightParams() +: y2r.h +

Y2RU_GetStandardCoefficient() +: y2r.h +

Y2RU_GetTransferEndEvent() : y2r.h

@@ -168,6 +174,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Y2RU_SetConversionParams() : y2r.h

Y2RU_SetDitheringWeightParams() +: y2r.h +

Y2RU_SetInputFormat() : y2r.h

@@ -198,15 +207,18 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Y2RU_SetSendingYUYV() : y2r.h

Y2RU_SetSpacialDithering() +: y2r.h +

Y2RU_SetStandardCoefficient() : y2r.h

Y2RU_SetTemporalDithering() +: y2r.h +

Y2RU_SetTransferEndInterrupt() : y2r.h

Y2RU_SetUnknownParams() -: y2r.h -

Y2RU_StartConversion() : y2r.h

diff --git a/globals_y.html b/globals_y.html index 60cda6b..2ea3a25 100644 --- a/globals_y.html +++ b/globals_y.html @@ -151,6 +151,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Y2RU_DriverInitialize() : y2r.h

Y2RU_GetDitheringWeightParams() +: y2r.h +

Y2RU_GetStandardCoefficient() +: y2r.h +

Y2RU_GetTransferEndEvent() : y2r.h

@@ -187,6 +193,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Y2RU_SetConversionParams() : y2r.h

Y2RU_SetDitheringWeightParams() +: y2r.h +

Y2RU_SetInputFormat() : y2r.h

@@ -217,15 +226,18 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Y2RU_SetSendingYUYV() : y2r.h

Y2RU_SetSpacialDithering() +: y2r.h +

Y2RU_SetStandardCoefficient() : y2r.h

Y2RU_SetTemporalDithering() +: y2r.h +

Y2RU_SetTransferEndInterrupt() : y2r.h

Y2RU_SetUnknownParams() -: y2r.h -

Y2RU_StartConversion() : y2r.h

diff --git a/structY2R__DitheringWeightParams.html b/structY2R__DitheringWeightParams.html new file mode 100644 index 0000000..f2ea049 --- /dev/null +++ b/structY2R__DitheringWeightParams.html @@ -0,0 +1,162 @@ + + + + + + +libctru: Y2R_DitheringWeightParams Struct Reference + + + + + + + + + + +

+ + + + + + +

libctru +

+ + + +

+ +

+ + +

+ +

Dithering weights. + More...

+ +

#include <y2r.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Data Fields
+u16	w0_xEven_yEven

+u16	w0_xOdd_yEven

+u16	w0_xEven_yOdd

+u16	w0_xOdd_yOdd

+u16	w1_xEven_yEven

+u16	w1_xOdd_yEven

+u16	w1_xEven_yOdd

+u16	w1_xOdd_yOdd

+u16	w2_xEven_yEven

+u16	w2_xOdd_yEven

+u16	w2_xEven_yOdd

+u16	w2_xOdd_yOdd

+u16	w3_xEven_yEven

+u16	w3_xOdd_yEven

+u16	w3_xEven_yOdd

+u16	w3_xOdd_yOdd

Detailed Description

Dithering weights.

The documentation for this struct was generated from the following file:

include/3ds/services/y2r.h

+ + + + diff --git a/y2r_8h.html b/y2r_8h.html index 524daea..274c14e 100644 --- a/y2r_8h.html +++ b/y2r_8h.html @@ -109,6 +109,9 @@ Data Structures struct Y2R_ConversionParams Structure used to configure all parameters at once. More...
+struct Y2R_DitheringWeightParams + Dithering weights. More...
+ @@ -182,33 +185,78 @@ Functions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -242,9 +290,14 @@ Functions - - - + + + + + + @@ -1118,30 +1171,6 @@ Setting a transfer_unit of 4 or 8 lines seems to bring the best results in terms

Note: It seems that the event can be fired too soon in some cases, depending the transfer_unit size.
Please see the note at Y2RU_SetReceiving

- - - -

Enumerations
Result	Y2RU_SetInputFormat (Y2R_InputFormat format)
	Used to configure the input format. More...

+Result	Y2RU_GetInputFormat (Y2R_InputFormat *format)

Result	Y2RU_SetOutputFormat (Y2R_OutputFormat format)
	Used to configure the output format. More...

+Result	Y2RU_GetOutputFormat (Y2R_OutputFormat *format)

Result	Y2RU_SetRotation (Y2R_Rotation rotation)
	Used to configure the rotation of the output. More...

+Result	Y2RU_GetRotation (Y2R_Rotation *rotation)

Result	Y2RU_SetBlockAlignment (Y2R_BlockAlignment alignment)
	Used to configure the alignment of the output buffer. More...

+Result	Y2RU_GetBlockAlignment (Y2R_BlockAlignment *alignment)

+Result	Y2RU_SetSpacialDithering (bool enable)
	Sets the usage of spacial dithering.

+Result	Y2RU_GetSpacialDithering (bool *enabled)

+Result	Y2RU_SetTemporalDithering (bool enable)
	Sets the usage of temporal dithering.

+Result	Y2RU_GetTemporalDithering (bool *enabled)

Result	Y2RU_SetInputLineWidth (u16 line_width)
	Used to configure the width of the image. More...

+Result	Y2RU_GetInputLineWidth (u16 *line_width)

Result	Y2RU_SetInputLines (u16 num_lines)
	Used to configure the height of the image. More...

+Result	Y2RU_GetInputLines (u16 *num_lines)

Result	Y2RU_SetCoefficients (const Y2R_ColorCoefficients *coefficients)
	Used to configure the color conversion formula. More...

+Result	Y2RU_GetCoefficients (Y2R_ColorCoefficients *coefficients)

Result	Y2RU_SetStandardCoefficient (Y2R_StandardCoefficient coefficient)
	Used to configure the color conversion formula with ITU stantards coefficients. More...

+Result	Y2RU_GetStandardCoefficient (Y2R_ColorCoefficients *coefficients, Y2R_StandardCoefficient standardCoeff)
	Retrieves the coeeficients associated to the given standard.

Result	Y2RU_SetAlpha (u16 alpha)
	Used to configure the alpha value of the output. More...

+Result	Y2RU_GetAlpha (u16 *alpha)

Result	Y2RU_SetTransferEndInterrupt (bool should_interrupt)
	Used to enable the end of conversion interrupt. More...

+Result	Y2RU_GetTransferEndInterrupt (bool *should_interrupt)

Result	Y2RU_GetTransferEndEvent (Handle *end_event)
	Gets an handle to the end of conversion event. More...

Result	Y2RU_IsDoneReceiving (bool *is_done)
	Checks if the DMA has finished sending the converted result. More...

Result	Y2RU_SetUnknownParams (const u16 params[16])
	Sets currently unknown parameters. More...

+Result	Y2RU_SetDitheringWeightParams (const Y2R_DitheringWeightParams *params)
	Sets the dithering weights.

+Result	Y2RU_GetDitheringWeightParams (Y2R_DitheringWeightParams *params)
	Retrieves the dithering weights.

Result	Y2RU_SetConversionParams (const Y2R_ConversionParams *params)
	Sets all the parameters of Y2R_ConversionParams at once. More...

- - - - - - - -

Result Y2RU_SetUnknownParams ( const u16 params[16] )

- -

Sets currently unknown parameters.

Parameters

- - -

params Unknown parameters.

diff --git a/y2r_8h_source.html b/y2r_8h_source.html index 06d27bf..417d1fb 100644 --- a/y2r_8h_source.html +++ b/y2r_8h_source.html @@ -203,281 +203,336 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

111 u8 unused;

112 u16 alpha; ///< Value passed to @ref Y2RU_SetAlpha

113 } Y2R_ConversionParams;

114

115

116 /**

117 * @brief Initializes the y2r service.

118 *

119 * This will internally get the handle of the service, and on success call Y2RU_DriverInitialize.

120 */

121 Result y2rInit(void);

122

123

124 /**

125 * @brief Closes the y2r service.

126 *

127 * This will internally call Y2RU_DriverFinalize and close the handle of the service.

128 */

129 Result y2rExit(void);

130

131

132 /**

133 * @brief Used to configure the input format.

134 *

135 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

136 */

137 Result Y2RU_SetInputFormat(Y2R_InputFormat format);

114

115 /**

116 * @brief Dithering weights

117 *

118 */

119 typedef struct

120 {

121 u16 w0_xEven_yEven;

122 u16 w0_xOdd_yEven;

123 u16 w0_xEven_yOdd;

124 u16 w0_xOdd_yOdd;

125 u16 w1_xEven_yEven;

126 u16 w1_xOdd_yEven;

127 u16 w1_xEven_yOdd;

128 u16 w1_xOdd_yOdd;

129 u16 w2_xEven_yEven;

130 u16 w2_xOdd_yEven;

131 u16 w2_xEven_yOdd;

132 u16 w2_xOdd_yOdd;

133 u16 w3_xEven_yEven;

134 u16 w3_xOdd_yEven;

135 u16 w3_xEven_yOdd;

136 u16 w3_xOdd_yOdd;

137 } Y2R_DitheringWeightParams;

138

139

140 /**

141 * @brief Used to configure the output format.

142 *

143 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

144 */

145 Result Y2RU_SetOutputFormat(Y2R_OutputFormat format);

146

147 /**

148 * @brief Used to configure the rotation of the output.

149 *

150 * It seems to apply the rotation per batch of 8 lines, so the output will be (height/8) images of size 8 x width.

139

140

141 /**

142 * @brief Initializes the y2r service.

143 *

144 * This will internally get the handle of the service, and on success call Y2RU_DriverInitialize.

145 */

146 Result y2rInit(void);

147

148

149 /**

150 * @brief Closes the y2r service.

151 *

152 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

152 * This will internally call Y2RU_DriverFinalize and close the handle of the service.

153 */

154 Result Y2RU_SetRotation(Y2R_Rotation rotation);

155

156 /**

157 * @brief Used to configure the alignment of the output buffer.

158 *

159 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

160 */

161 Result Y2RU_SetBlockAlignment(Y2R_BlockAlignment alignment);

162

163 /**

164 * @brief Used to configure the width of the image.

165 * @param line_width Width of the image in pixels. Must be a multiple of 8, up to 1024.

166 *

167 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

168 */

169 Result Y2RU_SetInputLineWidth(u16 line_width);

170

171 /**

172 * @brief Used to configure the height of the image.

173 * @param num_lines Number of lines to be converted.

174 *

175 * A multiple of 8 seems to be preferred.

176 * If using the @ref BLOCK_8_BY_8 mode, it must be a multiple of 8.

154 Result y2rExit(void);

155

156

157 /**

158 * @brief Used to configure the input format.

159 *

160 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

161 */

162 Result Y2RU_SetInputFormat(Y2R_InputFormat format);

163

164 Result Y2RU_GetInputFormat(Y2R_InputFormat* format);

165

166 /**

167 * @brief Used to configure the output format.

168 *

169 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

170 */

171 Result Y2RU_SetOutputFormat(Y2R_OutputFormat format);

172

173 Result Y2RU_GetOutputFormat(Y2R_OutputFormat* format);

174

175 /**

176 * @brief Used to configure the rotation of the output.

177 *

178 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

179 */

180 Result Y2RU_SetInputLines(u16 num_lines);

181

182 /**

183 * @brief Used to configure the color conversion formula.

184 *

185 * See @ref Y2R_ColorCoefficients for more information about the coefficients.

186 *

187 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

188 */

189 Result Y2RU_SetCoefficients(const Y2R_ColorCoefficients* coefficients);

190

191 /**

192 * @brief Used to configure the color conversion formula with ITU stantards coefficients.

193 *

194 * See @ref Y2R_ColorCoefficients for more information about the coefficients.

195 *

196 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

197 */

198 Result Y2RU_SetStandardCoefficient(Y2R_StandardCoefficient coefficient);

178 * It seems to apply the rotation per batch of 8 lines, so the output will be (height/8) images of size 8 x width.

179 *

180 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

181 */

182 Result Y2RU_SetRotation(Y2R_Rotation rotation);

183

184 Result Y2RU_GetRotation(Y2R_Rotation* rotation);

185

186 /**

187 * @brief Used to configure the alignment of the output buffer.

188 *

189 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

190 */

191 Result Y2RU_SetBlockAlignment(Y2R_BlockAlignment alignment);

192

193 Result Y2RU_GetBlockAlignment(Y2R_BlockAlignment* alignment);

194

195 ///Sets the usage of spacial dithering

196 Result Y2RU_SetSpacialDithering(bool enable);

197

198 Result Y2RU_GetSpacialDithering(bool* enabled);

199

200 /**

201 * @brief Used to configure the alpha value of the output.

202 * @param alpha 8-bit value to be used for the output when the format requires it.

203 *

204 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

205 */

206 Result Y2RU_SetAlpha(u16 alpha);

207

208 /**

209 * @brief Used to enable the end of conversion interrupt.

210 * @param should_interrupt Enables the interrupt if true, disable it if false.

211 *

212 * It is possible to fire an interrupt when the conversion is finished, and that the DMA is done copying the data.

213 * This interrupt will then be used to fire an event. See @ref Y2RU_GetTransferEndEvent.

214 * By default the interrupt is enabled.

215 *

216 * @note It seems that the event can be fired too soon in some cases, depending the transfer_unit size.\n Please see the note at @ref Y2RU_SetReceiving

217 */

218 Result Y2RU_SetTransferEndInterrupt(bool should_interrupt);

219

220 /**

221 * @brief Gets an handle to the end of conversion event.

222 * @param end_event Pointer to the event handle to be set to the end of conversion event. It isn't necessary to create or close this handle.

223 *

224 * To enable this event you have to use @code{C} Y2RU_SetTransferEndInterrupt(true);@endcode

225 * The event will be triggered when the corresponding interrupt is fired.

226 *

227 * @note It is recommended to use a timeout when waiting on this event, as it sometimes (but rarely) isn't triggered.

228 */

229 Result Y2RU_GetTransferEndEvent(Handle* end_event);

230

231 /**

232 * @brief Configures the Y plane buffer.

233 * @param src_buf A pointer to the beginning of your Y data buffer.

234 * @param image_size The total size of the data buffer.

235 * @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size.

236 * @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it.

237 *

238 * @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)

239 *

240 * This specifies the Y data buffer for the planar input formats (INPUT_YUV42*_INDIV_*).

241 * The actual transfer will only happen after calling @ref Y2RU_StartConversion.

242 */

243 Result Y2RU_SetSendingY(const void* src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap);

244

245 /**

246 * @brief Configures the U plane buffer.

247 * @param src_buf A pointer to the beginning of your Y data buffer.

248 * @param image_size The total size of the data buffer.

249 * @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size.

250 * @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it.

251 *

252 * @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)

253 *

254 * This specifies the U data buffer for the planar input formats (INPUT_YUV42*_INDIV_*).

255 * The actual transfer will only happen after calling @ref Y2RU_StartConversion.

256 */

257 Result Y2RU_SetSendingU(const void* src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap);

258

259 /**

260 * @brief Configures the V plane buffer.

261 * @param src_buf A pointer to the beginning of your Y data buffer.

262 * @param image_size The total size of the data buffer.

263 * @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size.

264 * @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it.

200 ///Sets the usage of temporal dithering

201 Result Y2RU_SetTemporalDithering(bool enable);

202

203 Result Y2RU_GetTemporalDithering(bool* enabled);

204

205

206 /**

207 * @brief Used to configure the width of the image.

208 * @param line_width Width of the image in pixels. Must be a multiple of 8, up to 1024.

209 *

210 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

211 */

212 Result Y2RU_SetInputLineWidth(u16 line_width);

213

214 Result Y2RU_GetInputLineWidth(u16* line_width);

215

216 /**

217 * @brief Used to configure the height of the image.

218 * @param num_lines Number of lines to be converted.

219 *

220 * A multiple of 8 seems to be preferred.

221 * If using the @ref BLOCK_8_BY_8 mode, it must be a multiple of 8.

222 *

223 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

224 */

225 Result Y2RU_SetInputLines(u16 num_lines);

226

227 Result Y2RU_GetInputLines(u16* num_lines);

228

229 /**

230 * @brief Used to configure the color conversion formula.

231 *

232 * See @ref Y2R_ColorCoefficients for more information about the coefficients.

233 *

234 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

235 */

236 Result Y2RU_SetCoefficients(const Y2R_ColorCoefficients* coefficients);

237

238 Result Y2RU_GetCoefficients(Y2R_ColorCoefficients* coefficients);

239

240 /**

241 * @brief Used to configure the color conversion formula with ITU stantards coefficients.

242 *

243 * See @ref Y2R_ColorCoefficients for more information about the coefficients.

244 *

245 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

246 */

247 Result Y2RU_SetStandardCoefficient(Y2R_StandardCoefficient coefficient);

248

249 ///Retrieves the coeeficients associated to the given standard

250 Result Y2RU_GetStandardCoefficient(Y2R_ColorCoefficients* coefficients, Y2R_StandardCoefficient standardCoeff);

251

252 /**

253 * @brief Used to configure the alpha value of the output.

254 * @param alpha 8-bit value to be used for the output when the format requires it.

255 *

256 * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.

257 */

258 Result Y2RU_SetAlpha(u16 alpha);

259

260 Result Y2RU_GetAlpha(u16* alpha);

261

262 /**

263 * @brief Used to enable the end of conversion interrupt.

264 * @param should_interrupt Enables the interrupt if true, disable it if false.

265 *

266 * @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)

267 *

268 * This specifies the V data buffer for the planar input formats (INPUT_YUV42*_INDIV_*).

269 * The actual transfer will only happen after calling @ref Y2RU_StartConversion.

270 */

271 Result Y2RU_SetSendingV(const void* src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap);

272

273 /**

274 * @brief Configures the YUYV source buffer.

275 * @param src_buf A pointer to the beginning of your Y data buffer.

276 * @param image_size The total size of the data buffer.

277 * @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size.

278 * @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it.

266 * It is possible to fire an interrupt when the conversion is finished, and that the DMA is done copying the data.

267 * This interrupt will then be used to fire an event. See @ref Y2RU_GetTransferEndEvent.

268 * By default the interrupt is enabled.

269 *

270 * @note It seems that the event can be fired too soon in some cases, depending the transfer_unit size.\n Please see the note at @ref Y2RU_SetReceiving

271 */

272 Result Y2RU_SetTransferEndInterrupt(bool should_interrupt);

273

274 Result Y2RU_GetTransferEndInterrupt(bool* should_interrupt);

275

276 /**

277 * @brief Gets an handle to the end of conversion event.

278 * @param end_event Pointer to the event handle to be set to the end of conversion event. It isn't necessary to create or close this handle.

279 *

280 * @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)

281 *

282 * This specifies the YUYV data buffer for the packed input format @ref INPUT_YUV422_BATCH.

283 * The actual transfer will only happen after calling @ref Y2RU_StartConversion.

280 * To enable this event you have to use @code{C} Y2RU_SetTransferEndInterrupt(true);@endcode

281 * The event will be triggered when the corresponding interrupt is fired.

282 *

283 * @note It is recommended to use a timeout when waiting on this event, as it sometimes (but rarely) isn't triggered.

284 */

285 Result Y2RU_SetSendingYUYV(const void* src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap);

285 Result Y2RU_GetTransferEndEvent(Handle* end_event);

286

287 /**

288 * @brief Configures the destination buffer.

289 * @param src_buf A pointer to the beginning of your destination buffer in FCRAM

288 * @brief Configures the Y plane buffer.

289 * @param src_buf A pointer to the beginning of your Y data buffer.

290 * @param image_size The total size of the data buffer.

291 * @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size.

292 * @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it.

293 *

294 * This specifies the destination buffer of the conversion.

295 * The actual transfer will only happen after calling @ref Y2RU_StartConversion.

296 * The buffer does NOT need to be allocated in the linear heap.

297 *

298 * @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)

299 *

300 * @note

301 * It seems that depending on the size of the image and of the transfer unit,\n

302 * it is possible for the end of conversion interrupt to be triggered right after the conversion began.\n

303 * One line as transfer_unit seems to trigger this issue for 400x240, setting to 2/4/8 lines fixes it.

304 *

305 * @note Setting a transfer_unit of 4 or 8 lines seems to bring the best results in terms of speed for a 400x240 image.

306 */

307 Result Y2RU_SetReceiving(void* dst_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap);

308

309 /**

310 * @brief Checks if the DMA has finished sending the Y buffer.

311 * @param is_done pointer to the boolean that will hold the result

312 *

313 * True if the DMA has finished transferring the Y plane, false otherwise. To be used with @ref Y2RU_SetSendingY.

314 */

315 Result Y2RU_IsDoneSendingY(bool* is_done);

316

317 /**

318 * @brief Checks if the DMA has finished sending the U buffer.

319 * @param is_done pointer to the boolean that will hold the result

320 *

321 * True if the DMA has finished transferring the U plane, false otherwise. To be used with @ref Y2RU_SetSendingU.

322 */

323 Result Y2RU_IsDoneSendingU(bool* is_done);

324

325 /**

326 * @brief Checks if the DMA has finished sending the V buffer.

327 * @param is_done pointer to the boolean that will hold the result

328 *

329 * True if the DMA has finished transferring the V plane, false otherwise. To be used with @ref Y2RU_SetSendingV.

330 */

331 Result Y2RU_IsDoneSendingV(bool* is_done);

332

333 /**

334 * @brief Checks if the DMA has finished sending the YUYV buffer.

335 * @param is_done pointer to the boolean that will hold the result

336 *

337 * True if the DMA has finished transferring the YUYV buffer, false otherwise. To be used with @ref Y2RU_SetSendingYUYV.

338 */

339 Result Y2RU_IsDoneSendingYUYV(bool* is_done);

340

341 /**

342 * @brief Checks if the DMA has finished sending the converted result.

343 * @param is_done pointer to the boolean that will hold the result

344 *

345 * True if the DMA has finished transferring data to your destination buffer, false otherwise.

346 */

347 Result Y2RU_IsDoneReceiving(bool* is_done);

348

349 /**

350 * @brief Sets currently unknown parameters.

351 * @param params Unknown parameters.

352 */

353 Result Y2RU_SetUnknownParams(const u16 params[16]);

354

355 /**

356 * @brief Sets all the parameters of Y2R_ConversionParams at once.

357 *

358 * Faster than calling the individual value through Y2R_Set* because only one system call is made.

359 */

360 Result Y2RU_SetConversionParams(const Y2R_ConversionParams* params);

361

362 /// Starts the conversion process

363 Result Y2RU_StartConversion(void);

294 * @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)

295 *

296 * This specifies the Y data buffer for the planar input formats (INPUT_YUV42*_INDIV_*).

297 * The actual transfer will only happen after calling @ref Y2RU_StartConversion.

298 */

299 Result Y2RU_SetSendingY(const void* src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap);

300

301 /**

302 * @brief Configures the U plane buffer.

303 * @param src_buf A pointer to the beginning of your Y data buffer.

304 * @param image_size The total size of the data buffer.

305 * @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size.

306 * @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it.

307 *

308 * @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)

309 *

310 * This specifies the U data buffer for the planar input formats (INPUT_YUV42*_INDIV_*).

311 * The actual transfer will only happen after calling @ref Y2RU_StartConversion.

312 */

313 Result Y2RU_SetSendingU(const void* src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap);

314

315 /**

316 * @brief Configures the V plane buffer.

317 * @param src_buf A pointer to the beginning of your Y data buffer.

318 * @param image_size The total size of the data buffer.

319 * @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size.

320 * @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it.

321 *

322 * @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)

323 *

324 * This specifies the V data buffer for the planar input formats (INPUT_YUV42*_INDIV_*).

325 * The actual transfer will only happen after calling @ref Y2RU_StartConversion.

326 */

327 Result Y2RU_SetSendingV(const void* src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap);

328

329 /**

330 * @brief Configures the YUYV source buffer.

331 * @param src_buf A pointer to the beginning of your Y data buffer.

332 * @param image_size The total size of the data buffer.

333 * @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size.

334 * @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it.

335 *

336 * @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)

337 *

338 * This specifies the YUYV data buffer for the packed input format @ref INPUT_YUV422_BATCH.

339 * The actual transfer will only happen after calling @ref Y2RU_StartConversion.

340 */

341 Result Y2RU_SetSendingYUYV(const void* src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap);

342

343 /**

344 * @brief Configures the destination buffer.

345 * @param src_buf A pointer to the beginning of your destination buffer in FCRAM

346 * @param image_size The total size of the data buffer.

347 * @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size.

348 * @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it.

349 *

350 * This specifies the destination buffer of the conversion.

351 * The actual transfer will only happen after calling @ref Y2RU_StartConversion.

352 * The buffer does NOT need to be allocated in the linear heap.

353 *

354 * @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)

355 *

356 * @note

357 * It seems that depending on the size of the image and of the transfer unit,\n

358 * it is possible for the end of conversion interrupt to be triggered right after the conversion began.\n

359 * One line as transfer_unit seems to trigger this issue for 400x240, setting to 2/4/8 lines fixes it.

360 *

361 * @note Setting a transfer_unit of 4 or 8 lines seems to bring the best results in terms of speed for a 400x240 image.

362 */

363 Result Y2RU_SetReceiving(void* dst_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap);

364

365 /// Cancels the conversion

366 Result Y2RU_StopConversion(void);

367

368 /**

369 * @brief Check if the conversion and DMA transfer are finished

370 *

371 * This can have the same problems as the event and interrupt. See @ref Y2RU_SetTransferEndInterrupt.

372 */

373 Result Y2RU_IsBusyConversion(bool* is_busy);

374

375 /**

376 * @brief Checks whether y2r is ready to be used.

377 * @param ping Pointer to output y2r's status to.

365 /**

366 * @brief Checks if the DMA has finished sending the Y buffer.

367 * @param is_done pointer to the boolean that will hold the result

368 *

369 * True if the DMA has finished transferring the Y plane, false otherwise. To be used with @ref Y2RU_SetSendingY.

370 */

371 Result Y2RU_IsDoneSendingY(bool* is_done);

372

373 /**

374 * @brief Checks if the DMA has finished sending the U buffer.

375 * @param is_done pointer to the boolean that will hold the result

376 *

377 * True if the DMA has finished transferring the U plane, false otherwise. To be used with @ref Y2RU_SetSendingU.

378 */

379 Result Y2RU_PingProcess(u8* ping);

379 Result Y2RU_IsDoneSendingU(bool* is_done);

380

381 /// Initializes the y2r driver.

382 Result Y2RU_DriverInitialize(void);

383

384 /// Terminates the y2r driver.

385 Result Y2RU_DriverFinalize(void);

386

381 /**

382 * @brief Checks if the DMA has finished sending the V buffer.

383 * @param is_done pointer to the boolean that will hold the result

384 *

385 * True if the DMA has finished transferring the V plane, false otherwise. To be used with @ref Y2RU_SetSendingV.

386 */

387 Result Y2RU_IsDoneSendingV(bool* is_done);

388

389 /**

390 * @brief Checks if the DMA has finished sending the YUYV buffer.

391 * @param is_done pointer to the boolean that will hold the result

392 *

393 * True if the DMA has finished transferring the YUYV buffer, false otherwise. To be used with @ref Y2RU_SetSendingYUYV.

394 */

395 Result Y2RU_IsDoneSendingYUYV(bool* is_done);

396

397 /**

398 * @brief Checks if the DMA has finished sending the converted result.

399 * @param is_done pointer to the boolean that will hold the result

400 *

401 * True if the DMA has finished transferring data to your destination buffer, false otherwise.

402 */

403 Result Y2RU_IsDoneReceiving(bool* is_done);

404

405 /// Sets the dithering weights

406 Result Y2RU_SetDitheringWeightParams(const Y2R_DitheringWeightParams* params);

407

408 /// Retrieves the dithering weights

409 Result Y2RU_GetDitheringWeightParams(Y2R_DitheringWeightParams* params);

410

411 /**

412 * @brief Sets all the parameters of Y2R_ConversionParams at once.

413 *

414 * Faster than calling the individual value through Y2R_Set* because only one system call is made.

415 */

416 Result Y2RU_SetConversionParams(const Y2R_ConversionParams* params);

417

418 /// Starts the conversion process

419 Result Y2RU_StartConversion(void);

420

421 /// Cancels the conversion

422 Result Y2RU_StopConversion(void);

423

424 /**

425 * @brief Check if the conversion and DMA transfer are finished

426 *

427 * This can have the same problems as the event and interrupt. See @ref Y2RU_SetTransferEndInterrupt.

428 */

429 Result Y2RU_IsBusyConversion(bool* is_busy);

430

431 /**

432 * @brief Checks whether y2r is ready to be used.

433 * @param ping Pointer to output y2r's status to.

434 */

435 Result Y2RU_PingProcess(u8* ping);

436

437 /// Initializes the y2r driver.

438 Result Y2RU_DriverInitialize(void);

439

440 /// Terminates the y2r driver.

441 Result Y2RU_DriverFinalize(void);

442

Y2RU_IsDoneSendingU

Result Y2RU_IsDoneSendingU(bool *is_done)

Checks if the DMA has finished sending the U buffer.

Y2RU_SetUnknownParams

Result Y2RU_SetUnknownParams(const u16 params[16])

Sets currently unknown parameters.

INPUT_YUV420_INDIV_16

16-bit per component, planar YUV 4:2:0, 24bpp, (1 Cr & Cb sample per 2x2 Y samples). Usually named YUV420P16.

Definition: y2r.h:18

Y2RU_IsDoneReceiving

Result Y2RU_IsDoneReceiving(bool *is_done)

Checks if the DMA has finished sending the converted result.

Y2R_ConversionParams::alpha

u16 alpha

Value passed to Y2RU_SetAlpha.

Definition: y2r.h:112

@@ -495,13 +550,17 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Y2RU_SetInputLineWidth

Result Y2RU_SetInputLineWidth(u16 line_width)

Used to configure the width of the image.

Y2RU_SetInputFormat

Result Y2RU_SetInputFormat(Y2R_InputFormat format)

Used to configure the input format.

Handle

u32 Handle

Resource handle.

Definition: types.h:42

Y2RU_GetDitheringWeightParams

Result Y2RU_GetDitheringWeightParams(Y2R_DitheringWeightParams *params)

Retrieves the dithering weights.

uint8_t u8

8-bit unsigned integer

Definition: types.h:22

y2rExit

Result y2rExit(void)

Closes the y2r service.

Y2RU_SetSpacialDithering

Result Y2RU_SetSpacialDithering(bool enable)

Sets the usage of spacial dithering.

Y2RU_SetOutputFormat

Result Y2RU_SetOutputFormat(Y2R_OutputFormat format)

Used to configure the output format.

Y2R_BlockAlignment

Block alignment of output.

Definition: y2r.h:51

Y2RU_SetDitheringWeightParams

Result Y2RU_SetDitheringWeightParams(const Y2R_DitheringWeightParams *params)

Sets the dithering weights.

Y2RU_SetSendingY

Result Y2RU_SetSendingY(const void *src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap)

Configures the Y plane buffer.

Y2RU_SetInputLines

Result Y2RU_SetInputLines(u16 num_lines)

Used to configure the height of the image.

INPUT_YUV422_BATCH

8-bit per component, packed YUV 4:2:2, 16bpp, (Y0 Cb Y1 Cr). Usually named YUYV422.

Definition: y2r.h:19

Y2RU_SetTemporalDithering

Result Y2RU_SetTemporalDithering(bool enable)

Sets the usage of temporal dithering.

INPUT_YUV422_INDIV_8

8-bit per component, planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples). Usually named YUV422P.

Definition: y2r.h:15

Y2R_Rotation

Rotation to be applied to the output.

Definition: y2r.h:38

Y2RU_GetTransferEndEvent

Result Y2RU_GetTransferEndEvent(Handle *end_event)

Gets an handle to the end of conversion event.

@@ -514,6 +573,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Y2R_InputFormat

Input color formats.

Definition: y2r.h:13

COEFFICIENT_ITU_R_BT_601_SCALING

Coefficients from the ITU-R BT.601 standard with TV ranges.

Definition: y2r.h:92

Y2R_OutputFormat

Output color formats.

Definition: y2r.h:27

Y2RU_GetStandardCoefficient

Result Y2RU_GetStandardCoefficient(Y2R_ColorCoefficients *coefficients, Y2R_StandardCoefficient standardCoeff)

Retrieves the coeeficients associated to the given standard.

Y2R_ConversionParams::input_lines

s16 input_lines

Value passed to Y2RU_SetInputLines.

Definition: y2r.h:109

Y2RU_SetSendingV

Result Y2RU_SetSendingV(const void *src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap)

Configures the V plane buffer.

Y2RU_SetSendingU

Result Y2RU_SetSendingU(const void *src_buf, u32 image_size, s16 transfer_unit, s16 transfer_gap)

Configures the U plane buffer.

@@ -530,6 +590,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

OUTPUT_RGB_16_555

The alpha bit is the 7th bit of the alpha value set by Y2RU_SetAlpha.

Definition: y2r.h:31

Y2RU_StopConversion

Result Y2RU_StopConversion(void)

Cancels the conversion.

Y2RU_DriverInitialize

Result Y2RU_DriverInitialize(void)

Initializes the y2r driver.

Y2R_DitheringWeightParams

Dithering weights.

Definition: y2r.h:119

INPUT_YUV422_INDIV_16

16-bit per component, planar YUV 4:2:2, 32bpp, (1 Cr & Cb sample per 2x1 Y samples). Usually named YUV422P16.

Definition: y2r.h:17

Y2RU_DriverFinalize

Result Y2RU_DriverFinalize(void)

Terminates the y2r driver.

COEFFICIENT_ITU_R_BT_709_SCALING

Coefficients from the ITU-R BT.709 standard with TV ranges.

Definition: y2r.h:93

-- 2.39.5

+Data Fields

Detailed Description

Enumerations