Skip to content

Require movie canvas dimensions in integer pixels when using modifiers +c|i #8297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PaulWessel merged 3 commits into from
Jan 16, 2024
Merged

Require movie canvas dimensions in integer pixels when using modifiers +c|i #8297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
847ad87
Allow dimensions in pixels via movie modifiers +c|i
PaulWessel Jan 15, 2024
c4451fc
Update movie.c
PaulWessel Jan 16, 2024
e82d1fd
Check dimensions are integers
PaulWessel Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/rst/source/movie.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Synopsis
.. include:: common_SYN_OPTs.rst_

**gmt movie** *mainscript*
|-C|\ *canvas*
|-C|\ *canvassize*
|-N|\ *prefix*
|-T|\ *nframes*\|\ *min*/*max*/*inc*\ [**+n**]\|\ *timefile*\ [**+p**\ *width*]\ [**+s**\ *first*]\ [**+w**\ [*str*]\|\ **W**]
[ |-A|\ *audiofile*\ [**+e**] ]
Expand Down Expand Up @@ -73,6 +73,8 @@ Required Arguments
you up to work with the SI or US canvas dimensions. Instead of a named format you can
request a custom format directly by giving *width*\ **x**\ *height*\ **x**\ *dpu*,
where *dpu* is the dots-per-unit pixel density (pixel density is set automatically for the named formats).
Alternatively, give dimensions in pixels and append modifiers **+c** or **+i** to indicate that *dpu* is
per cm or per inches.

.. _tbl-presets:

Expand Down
35 changes: 28 additions & 7 deletions src/movie.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ struct MOVIE_CTRL {
double duration; /* Original length of audio track */
char *file;
} A;
struct MOVIE_C { /* -C<namedcanvas>|<canvas_and_dpu> */
struct MOVIE_C { /* -C<namedcanvas>|<canvas_and_dpu>[+c|i] */
bool active;
double dim[3];
char unit;
Expand Down Expand Up @@ -330,7 +330,7 @@ GMT_LOCAL int movie_parse_x_option (struct GMT_CTRL *GMT, struct MOVIE_CTRL *Ctr
static int usage (struct GMTAPI_CTRL *API, int level) {
const char *name = gmt_show_name_and_purpose (API, THIS_MODULE_LIB, THIS_MODULE_CLASSIC_NAME, THIS_MODULE_PURPOSE);
if (level == GMT_MODULE_PURPOSE) return (GMT_NOERROR);
GMT_Usage (API, 0, "usage: %s <mainscript> -C<canvas>|<width>x<height>x<dpu> -N<prefix> -T<nframes>|<min>/<max>/<inc>[+n]|<timefile>[+p<width>][+s<first>][+w[<str>]|W] "
GMT_Usage (API, 0, "usage: %s <mainscript> -C<canvas>|<width>x<height>x<dpu>[+c|i] -N<prefix> -T<nframes>|<min>/<max>/<inc>[+n]|<timefile>[+p<width>][+s<first>][+w[<str>]|W] "
"-A<audiofile>[+e]] [-D<rate>] [-E<titlepage>[+d[<duration>[s]]][+f[i|o][<fade>[s]]][+g<fill>]] [-Fgif|mp4|webm|png[+l[<n>]][+o<opts>][+s<stride>][+t][+v]] "
"[-G[<fill>][+p<pen>]] [-H<scale>] [-I<includefile>] [-K[+f[i|o][<fade>[s]]][+g<fill>][+p[i|o]]] [-L<labelinfo>] [-M[<frame>|f|m|l,][<format>][+r<dpu>][+v]] "
"[-P<progressinfo>] [-Q[s]] [-Sb<background>] [-Sf<foreground>] [%s] [-W[<dir>]] [-Z[s]] [%s] [-x[[-]<n>]] [%s]\n", name, GMT_V_OPT, GMT_f_OPT, GMT_PAR_OPT);
Expand All @@ -341,7 +341,7 @@ static int usage (struct GMTAPI_CTRL *API, int level) {

GMT_Usage (API, 1, "\n<mainscript>");
GMT_Usage (API, -2, "<mainscript> is the main GMT modern script that builds a single frame image.");
GMT_Usage (API, 1, "\n-C<canvas>|<width>x<height>x<dpu>");
GMT_Usage (API, 1, "\n-C<canvas>|<width>x<height>x<dpu>[+c|i]");
GMT_Usage (API, -2, "Specify canvas. Choose either a known named canvas or set custom dimensions.");
GMT_Usage (API, -2, "%s Recognized 16:9-ratio names and associated dimensions:", GMT_LINE_BULLET);
/* Using GMT_Message here for verbatim text and alignment since GMT_Usage will eat repeated spaces */
Expand All @@ -366,7 +366,9 @@ static int usage (struct GMTAPI_CTRL *API, int level) {
GMT_Usage (API, -2, "Note: uhd-2 and 8k can be used for 4320p, uhd and 4k for 2160p, and fhd or hd for 1080p. "
"Current PROJ_LENGTH_UNIT determines if you get SI or US canvas dimensions and dpu. "
"Alternatively, set a custom canvas with dimensions and dots-per-unit manually by "
"providing <width>x<height>x<dpu> (e.g., 15cx10cx50, 6ix6ix100, etc.).");
"providing <width>x<height>x<dpu> (e.g., 15cx10cx50, 6ix6ix100, etc. Alternatively, give pixel dimensions and a modifier:");
GMT_Usage (API, 3, "+c Dimensions are pixels and dpu is pixels per cm.");
GMT_Usage (API, 3, "+i Dimensions are pixels and dpu is pixels per inch.");
GMT_Usage (API, 1, "\n-N<prefix>");
GMT_Usage (API, -2, "Set the <prefix> used for movie files and directory names. "
"The directory cannot already exist; see -Z to remove such directories at the end.");
Expand Down Expand Up @@ -812,8 +814,27 @@ static int parse (struct GMT_CTRL *GMT, struct MOVIE_CTRL *Ctrl, struct GMT_OPTI
else if (!strcmp (arg, "dvd")) { /* 480x640 */
Ctrl->C.dim[GMT_X] = width; Ctrl->C.dim[GMT_Y] = height4x3; Ctrl->C.dim[GMT_Z] = dpu / 6.0;
}
else { /* Custom canvas dimensions */
if ((n = sscanf (arg, "%[^x]x%[^x]x%lg", txt_a, txt_b, &Ctrl->C.dim[GMT_Z])) != 3) {
else { /* Custom canvas dimensions -C<width>[<unit>]x<height>[<unit>]x<dpu>[+c|i] */
if ((c = strstr (arg, "+c"))) /* Got dimensions in dpc units */
c[0] = '\0'; /* Chop off modifier */
else if ((c = strstr (arg, "+i"))) /* Got dimensions in dpi units */
c[0] = '\0'; /* Chop off modifier */
if (c) { /* Got modifier and sides in dpi or dpc -C<width>x<height>x<dpu>[+c|i] */
if ((n = sscanf (arg, "%[^x]x%[^x]x%lg", txt_a, txt_b, &Ctrl->C.dim[GMT_Z])) != 3) {
GMT_Report (API, GMT_MSG_ERROR, "Option -C: Requires dimensions in pixels and either +c or +i for dots per unit\n");
n_errors++;
}
Ctrl->C.dim[GMT_X] = atof (txt_a);
Ctrl->C.dim[GMT_Y] = atof (txt_b);
if (fabs (Ctrl->C.dim[GMT_X] - irint (Ctrl->C.dim[GMT_X])) > 0 || fabs (Ctrl->C.dim[GMT_Y] - irint (Ctrl->C.dim[GMT_Y])) > 0) {
GMT_Report (API, GMT_MSG_ERROR, "Option -C: When either a +c or +i modifier is used, dimensions must be integer pixels\n");
n_errors++;
}
Ctrl->C.dim[GMT_X] = atof (txt_a) / Ctrl->C.dim[GMT_Z];
Ctrl->C.dim[GMT_Y] = atof (txt_b) / Ctrl->C.dim[GMT_Z];
Ctrl->C.unit = c[1]; /* Save inch or cm unit */
}
else if ((n = sscanf (arg, "%[^x]x%[^x]x%lg", txt_a, txt_b, &Ctrl->C.dim[GMT_Z])) != 3) {
GMT_Report (API, GMT_MSG_ERROR, "Option -C: Requires name of a known format or give width x height x dpu string\n");
n_errors++;
}
Expand Down Expand Up @@ -1212,7 +1233,7 @@ static int parse (struct GMT_CTRL *GMT, struct MOVIE_CTRL *Ctrl, struct GMT_OPTI
if (Ctrl->M.active && !Ctrl->F.active[MOVIE_PNG]) Ctrl->M.exit = true; /* Only make the master frame */

n_errors += gmt_M_check_condition (GMT, n_files != 1 || Ctrl->In.file == NULL, "Must specify a main script file\n");
n_errors += gmt_M_check_condition (GMT, !Ctrl->C.active, "Option -C: Must specify a canvas dimension\n");
n_errors += gmt_M_check_condition (GMT, !Ctrl->C.active, "Option -C: Must specify canvas dimensions\n");
n_errors += gmt_M_check_condition (GMT, Ctrl->M.exit && Ctrl->animate, "Option -F: Cannot use none with other selections\n");
n_errors += gmt_M_check_condition (GMT, !Ctrl->Q.active && !Ctrl->M.active && !Ctrl->F.active[MOVIE_PNG], "Must select at least one output product (-F, -M)\n");
n_errors += gmt_M_check_condition (GMT, Ctrl->Q.active && Ctrl->Z.active, "Cannot use -Z if -Q is also set\n");
Expand Down