changeset 11920:06979c042350

doc: Cleanup api.rst, x265cli.h, update comments in x265.h
author Pradeep Ramachandran <pradeep@multicorewareinc.com>
date Thu, 16 Nov 2017 20:23:14 +0530
parents 5b0d7c668968
children c001df275b94
files doc/reST/api.rst source/x265.h source/x265cli.h
diffstat 3 files changed, 13 insertions(+-), 12 deletions(-) [+]
line wrap: on
line diff
--- a/doc/reST/api.rst	Mon Nov 13 12:20:50 2017 +0530
+++ b/doc/reST/api.rst	Thu Nov 16 20:23:14 2017 +0530
@@ -208,18 +208,19 @@ changes made to the parameters for auto-
      *     This API must be called after(poc >= lookaheadDepth + bframes + 2) condition check */
      int x265_get_ref_frame_list(x265_encoder *encoder, x265_picyuv**, x265_picyuv**, int, int);
  
-**x265_encoder_ctu_info**
-       /* x265_encoder_ctu_info:
-        *    Copy CTU information such as ctu address and ctu partition structure of all
-        *    CTUs in each frame. The function is invoked only if "--ctu-info" is enabled and
-        *    the encoder will wait for this copy to complete if enabled.
-        */
+**x265_encoder_ctu_info** may be used to provide additional CTU-specific information to the encoder::
+
+    /* x265_encoder_ctu_info:
+     *    Copy CTU information such as ctu address and ctu partition structure of all
+     *    CTUs in each frame. The function is invoked only if "--ctu-info" is enabled and
+     *    the encoder will wait for this copy to complete if enabled.*/
+    int x265_encoder_ctu_info(x265_encoder *encoder, int poc, x265_ctu_info_t** ctu);
 
 **x265_set_analysis_data()** may be used to recive analysis information from external application::
 
     /* x265_set_analysis_data:
-     *     set the analysis data,
-     *     returns negative on error, 0 access unit were output. */
+     *     set the analysis data. The incoming analysis_data structure is assumed to be AVC-sized blocks.
+     *     returns negative on error, 0 access unit were output.*/
      int x265_set_analysis_data(x265_encoder *encoder, x265_analysis_data *analysis_data, int poc, uint32_t cuBytes);
 
 Pictures
--- a/source/x265.h	Mon Nov 13 12:20:50 2017 +0530
+++ b/source/x265.h	Thu Nov 16 20:23:14 2017 +0530
@@ -1732,8 +1732,6 @@ int x265_encoder_intra_refresh(x265_enco
  *    the encoder will wait for this copy to complete if enabled.
  */
 int x265_encoder_ctu_info(x265_encoder *, int poc, x265_ctu_info_t** ctu);
-/* x265_cleanup:
- *       release library static allocations, reset configured CTU size */
 
 /* x265_get_slicetype_poc_and_scenecut:
  *     get the slice type, poc and scene cut information for the current frame,
@@ -1747,10 +1745,12 @@ int x265_get_slicetype_poc_and_scenecut(
 int x265_get_ref_frame_list(x265_encoder *encoder, x265_picyuv**, x265_picyuv**, int, int);
 
 /* x265_set_analysis_data:
- *     set the analysis data,
+ *     set the analysis data. The incoming analysis_data structure is assumed to be AVC-sized blocks.
  *     returns negative on error, 0 access unit were output. */
 int x265_set_analysis_data(x265_encoder *encoder, x265_analysis_data *analysis_data, int poc, uint32_t cuBytes);
 
+/* x265_cleanup:
+ *       release library static allocations, reset configured CTU size */
 void x265_cleanup(void);
 
 /* Open a CSV log file. On success it returns a file handle which must be passed
--- a/source/x265cli.h	Mon Nov 13 12:20:50 2017 +0530
+++ b/source/x265cli.h	Thu Nov 16 20:23:14 2017 +0530
@@ -474,7 +474,7 @@ static void showHelp(x265_param *param)
         "                                Default:%d\n", param->intraRefine);
     H0("   --refine-inter <0..3>         Enable inter refinement for encode that uses analysis-reuse-mode=load.\n"
         "                                    - 0 : Forces both mode and depth from the save encode.\n"
-        "                                    - 1 : Functionality of (0) + evaluate all inter modes at min-cu-size's depth when current depth is one smaller than "
+        "                                    - 1 : Functionality of (0) + evaluate all inter modes at min-cu-size's depth when current depth is one smaller than\n"
         "                                          min-cu-size's depth. When save encode decides the current block as skip(for all sizes) evaluate skip/merge.\n"
         "                                    - 2 : Functionality of (1) + irrespective of size restrict the modes evaluated when specific modes are decided as the best mode by the save encode.\n"
         "                                    - 3 : Functionality of (1) + irrespective of size evaluate all inter modes.\n"