hP`SrSSKJr SSKrSSKrSSKJrJr SSKJ r SSK J r J r SSK rSSKrSSKJrJr SSKJrJrJr SS KJr SS KJr SS KJrJr SS KJr "S S\\R@RB5r""SS\RFR:\R@RB5r$g)z>File for rendering and recording of vector-based environments.) annotationsN)CallableSequence)deepcopy)Any SupportsFloat)errorlogger)ActTypeObsType RenderFrame)DependencyNotInstalled)warn) VectorEnv VectorWrapper) ArrayTypec^\rSrSrSr/SQrS SSjjr\SSj5rSU4Sjjr SSS.SU4S jjjr S r U4S jr S r U=r$)HumanRenderingzEAdds support for Human-based Rendering for Vector-based environments.) rgb_arrayrgb_array_list depth_arraydepth_array_listNcJ[R"X5 [RRRXS9 X lSuUlUlUlSUl SUl URRUR;d"SURSURS35eSURR;dS5eS URS ;aC[URR5UlURS R!S 5 gg) zConstructor for Human Rendering of Vector-based environments. Args: env: The vector environment screen_size: The rendering screen size otherwise the environment sub-env render size is used ) screen_size)NNNNz&Expected env.render_mode to be one of z but got '' render_fpszYThe base environment must specify 'render_fps' to be used with the HumanRendering wrapperhuman render_modes)r__init__gymutilsRecordConstructorArgsrscaled_subenv_sizenum_rowsnum_colswindowclockenv render_modeACCEPTED_RENDER_MODESmetadatarappend)selfr)rs ]/home/james-whalen/.local/lib/python3.13/site-packages/gymnasium/wrappers/vector/rendering.pyr HumanRendering.__init__ s  t) ''000O&@P=    HH D$>$> > m 3D4N4N3OzZ]ZiZiYjjk l m > DHH-- - g f g - $--7 7$TXX%6%67DM MM. ) 0 0 9 8cg)zAlways returns ``'human'``.rr.s r/r*HumanRendering.render_mode:sr1cF>[TU]U5nUR5 U$)zHPerform a step in the base environment and render a frame to the screen.)superstep _render_frame)r.actionsresult __class__s r/r8HumanRendering.step?s$g&  r1seedoptionscB>[TU]XS9nUR5 U$)z)r7resetr9)r.r?r@r;r<s r/rBHumanRendering.resetGs&D:  r1cb SSKnURRceURRR S5(a7URR 5n[U[5(deUSnOURR 5nUce[U5UR:Xde[SU55(d$SUVs/sHn[U5PM sn35e[R"U[RS9n[R "US S 9nUR"cUR$S S UlUR&GcUR$S S nUSUR"S- nUS UR"S - nS upxXx-UR:a;Xv-n X-n X:Xa US -US -pOX:aUS - nOUS - nXx-UR:aM;[)UR"SXS-- UR"S XtS -- 5n XS-U -UR"S:XdXtS -U -UR"S :XdeXplXl[/USU -5[/US U -54UlUR*UR,-UR:deUR&SUR,-UR"S::deUR&S UR*-UR"S ::deSSKn [R2"UR"S-[RS9n[R4"[R6"UR,5[R6"UR*55unn[9[;UR5UR=5UR=55H{unnnU R?UUUR&SSS25nUUR&S-nUUR&S -nUUUUUR&S-2UUUR&S -24'M} UR@cTURC5 URDRC5 URDRGUR"5Ul URHcURJRM5Ul$URNRQU5nUR@RSUS5 URTRW5 URHRYURZS5 URDR]5 g![a [S5ef=fs snf![an [S5U eSn A ff=f)zKFetch the last frame from the base environment and render it to the screen.rNzEpygame is not installed, run `pip install gymnasium[classic-control]`_lastc3V# UHn[U[R5v M! g7fN) isinstancenpndarray).0renders r/ /HumanRendering._render_frame..es! 9GvJvrzz * *s')zCExpected `env.render()` to return a numpy array, actually returned dtype)r)axesrSrTrSrSzCopencv (cv2) is not installed, run `pip install "gymnasium[other]"`)rT)rrr)/pygame ImportErrorrr)r*endswithrMrIlistlennum_envsalltyperJarrayuint8 transposershaper$minr%r&intcv2zerosmeshgridarangeziprangeflattenresizer'initdisplayset_moder(timeClock surfarray make_surfacebliteventpumptickr,flip)r.rWsubenv_rendersrM subenv_size width_ratio height_ratior%r& row_ratio col_ratioscaling_factorreemerged_rgb_arraycolsrowsicolrow scaled_renderxysurfs r/r9HumanRendering._render_frameRsZ   xx##/// 88   ( ( 1 1!XX__.Nnd33 33+B/N!XX__.N)))>"dmm333 9G     Pm{Q|m{ciRVW]R^m{Q|P} ~  .An<H    #-33Aa8D   " " *(..q3K%a.4+;+;A+>>K&q>D,<,)N:d>N>Nq>QQ^+n<@P@PQR@SS UU%M$MKN^34KN^34'D # ==4==0DMMA AA**1- =AQAQRSATT TT**1- =AQAQRSATT TT   88D$4$4t$;288L[[4==!9299T]];ST duT]]3T\\^T\\^TKAsCJJ~a'8$:Q:QRVTVRV:WXMd--a00Ad--a00A  A//222A//2224  U ;;  KKM NN   ! ..11$2B2BCDK :: **,DJ,,-=> v&   l34A (W  "R}b (U  s)U5VV5V  V. V))V.c>URb.SSKnURR5 UR5 [TU]5 g)zClose the rendering window.Nr)r'rWrnquitr7close)r.rWr<s r/rHumanRendering.closes2 ;; "  NN   ! KKM  r1)r(r,r&r%r$rr'rH)r)rrztuple[int, int] | None)returnstr)r:r rz?tuple[ObsType, ArrayType, ArrayType, ArrayType, dict[str, Any]])r?zint | list[int] | Noner@dict[str, Any] | Nonertuple[ObsType, dict[str, Any]])__name__ __module__ __qualname____firstlineno____doc__r+r propertyr*r8rBr9r__static_attributes__ __classcell__r<s@r/rrs}O:4 H(,)- % '  (  dLr1rc ^\rSrSrSrSSSSSSSSS 4 SS jjrS rS rS rSSS.SU4Sjjjr SSjr SU4Sjjr U4Sjr SSjr SrSrSrU=r$) RecordVideoaAdds support for video recording for Vector-based environments. The class is the same as gymnasium.wrappers.rendering.RecordVideo, but expects multiple frames when rendering the environment (one for each environment of the VectorEnv). Frames are concatenated into one frame such that its aspect ratio is as close as possible to the desired one. Examples - Run 5 environments for 200 timesteps, and save the video every 5 episodes: >>> import os >>> import gymnasium as gym >>> from gymnasium.wrappers.vector import RecordVideo >>> envs = gym.make_vec("CartPole-v1", num_envs=5, render_mode="rgb_array") >>> envs = RecordVideo( ... envs, ... video_folder="save_videos_5envs", ... video_aspect_ratio=(1,1), ... episode_trigger=lambda t: t % 5 == 0, ... ) >>> _ = envs.reset(seed=123) >>> _ = envs.action_space.seed(123) >>> for i in range(200): ... actions = envs.action_space.sample() ... _ = envs.step(actions) >>> envs.close() >>> len(os.listdir("save_videos_5envs")) 2 rVFNrzrl-videoTcg)NTr3)episodes r/RecordVideo.s4r1c 2[R"X5 [RRRUUUUUUU S9 UR S;a[ SUR S3S5eUc UcSSKJn U nURRS S5n U bXl OE[US UR<S 35 [RRRUl UR[RRR :Xa["R"S 5 S UlXPlX`lXlXlX@lX0lSUlSUl[6R8R;U5Ul[6R8R?UR<5(a$["R"SUR<S35 [6R@"UR<SS9 U cURRSS5n Xl!Xl"SUl#US:waUO [IS5Ul%S Ul&/Ul'/Ul(SUl)SUl*SSK+ng![Xan[ZR\"S5UeSnAff=f)a Wrapper records videos of environment rollouts. Args: env: The environment that will be wrapped video_folder (str): The folder where the recordings will be stored video_aspect_ratio (tuple): the desired aspect ratio of the video concatenating all environments. For example, (1, 1) means an aspect ratio of 1:1, while (16, 9) means 16:9. record_first_only (bool): if True, only the first environment is recorded. episode_trigger: Function that accepts an integer and returns ``True`` iff a recording should be started at this episode step_trigger: Function that accepts an integer and returns ``True`` iff a recording should be started at this step video_length (int): The length of recorded episodes. If 0, entire episodes are recorded. Otherwise, snippets of the specified length are captured name_prefix (str): Will be prepended to the filename of the recordings fps (int): The frame per second in the video. Provides a custom video fps for environment, if ``None`` then the environment metadata ``render_fps`` key is used if it exists, otherwise a default value of 30 is used. disable_logger (bool): Whether to disable moviepy logger or not, default it is disabled gc_trigger: Function that accepts an integer and returns ``True`` iff garbage collection should be performed after this episode Note: For vector environments that use same-step autoreset (see https://farama.org/Vector-Autoreset-Mode for more details) then the final frame of the episode will not be included in the video. ) video_folderepisode_trigger step_trigger video_length name_prefixdisable_logger>NansirzRender mode is z), which is incompatible with RecordVideo.zXInitialize your environment with a render_mode that returns an image, such as rgb_array.Nr)capped_cubic_video_scheduleautoreset_modez. metadata doesn't specify its autoreset mode (z&), therefore, defaulting to next step.zVector environment's autoreset mode is same-step (https://farama.org/Vector-Autoreset-Mode). Recorded episodes will not contain the last frame of the episode.FrFzOverwriting existing videos at zh folder (try specifying a different `video_folder` for the `RecordVideo` wrapper if this is not desired)T)exist_okrinf>MoviePy is not installed, run `pip install "gymnasium[other]"`)/rr r!r"r#r* ValueErrorgymnasium.utils.save_videorr,getrrvector AutoresetMode NEXT_STEP SAME_STEPr has_autoresetrrr gc_triggerrecord_first_onlyvideo_aspect_ratio frame_cols frame_rowsospathabspathrisdirmakedirsframes_per_secr _video_namefloatr recordingrecorded_framesrender_historystep_id episode_idmoviepyrXr r)r.r)rrrrrrrfpsrrrrrrs r/r RecordVideo.__init__sWH t) ''00 %+%%#) 1  ??5 5!#//!22[\j   "|'; N9O))*:DA  %"0  %EcllEUU{| #&**":":"D"DD    #**":":"D"D D KKq #.(,$!2"4GGOOL9 77==** + + KK1$2C2C1DEst  D%%5 ;--##L"5C#& +'+1=1Be $1302    ..P  s+I00 J:JJc(URSURS- nSUpe[Rn[S[ US-5S-5H5nX-S:XdM X-n X-n X-n X- n [ X- 5n X:dM1U nXpeM7 XPlX`lg)zQFinds the right shape to concatenate frames from all environments into one frame.rrSg?N)rrJrrjrdabsrr)r.n_frameshwtarget_video_aspect_ratio best_rows best_colsmin_diffrr total_height total_widthaspectdiffs r/_get_concat_frame_shape#RecordVideo._get_concat_frame_shapePs  # #A &)@)@)C C " !(966!S3/!34D!#'#x "h $36=>?#H+/y5$#r1c^[R"U5nURup#pE[R"URU-UR U-U4UR S9n[U5H<nXpR -nXpR -n XXhU-US-U-2X-U S-U-24'M> U$)z3Concatenates a list of frames into one large frame.rPrS)rJr_rbrfrrrQrj) r.framesrrrcgrididxrc_s r/_concat_framesRecordVideo._concat_framesds&!"LLQxx __q $//A"5q 9 ?C&A&B?E{DQ!a%1$bfQ!|&;; <# r1c UR(dS5eURR5n[U[5(d[ U55e[ U5UR:XdeUR(aUS/nURS:XdURS:Xa/[ U5nUSRup4nURX#U5 URU5nURRU5 g)Nz1Cannot capture a frame, recording wasn't started.rrF)rr)rMrIrr^r[r\rrrrbrrrr-)r. envs_framerrrrconcatenated_envs_frames r/_capture_frameRecordVideo._capture_frameqs~~RRR~XX__& *h//Aj1AA/:$--///  ! !$Q-J ??b DOOr$9:H m))GA!  ( (a 8"&"5"5j"A ##$;c^>UbSU;d USS(aU=RS- slUR(a)UR[S5:XaUR 5 UR (aJUR UR5(a*UR URSUR35 [TU]%XS9up4UR(aCUR5 [UR5UR:aUR 5 SUl X44$)zF)rrrrstop_recordingrstart_recordingrr7rBrr[rr)r.r?r@obsinfor<s r/rBRecordVideo.resets ?l'9W\=RST=U OOq O~~$"3"3uU|"C##%##(<(>    !4''(4+<+<<##%"yr1cURRU5up#pEnU=RS- slUR[R R R:XaUR(aU=RS- sl UR(a)UR[S5:XaUR5 UR(aJURUR5(a*URUR SUR35 US=(d USUlOUR[R R R":XaUS(d US(aU=RS- sl UR(a)UR[S5:XaUR5 UR(aJURUR5(a*URUR SUR35 UR$(aJUR%UR5(a*URUR SUR35 UR(aCUR'5 [)UR*5UR:aUR5 X#XEU4$)z]Steps through the environment using action, recording observations if :attr:`self.recording`.rSrrrz-step-)r)r8rrr!rrrrrrrrrrrrrrrr[r)r.r:rrewards terminations truncationsrs r/r8RecordVideo.steps9= g8N5l    #**":":"D"D D!!1$>>d&7&75<&G'')''D,@,@,Q,Q((++,Idoo5FG".a!BKND   CJJ$<$<$F$F F O{1~ OOq O~~$"3"3uU|"C##%##(<(!J K >>    !4''(4+<+<<##%\<[TU]5nUR(a*[U[5(aU=R U- sl[ UR5S:aURn/UlX!-$U$)ziCompute the render frames as specified by render_mode attribute during initialization of the environment.r)r7rMrrIrZrr[r)r. render_out tmp_historyr<s r/rMRecordVideo.rendershW^% >>jT::  J . t"" #a '--K"$D + + r1cf>[TU]5 UR(aUR5 gg)z+Closes the wrapper then the video recorder.N)r7rrr)r.r<s r/rRecordVideo.closes$   >>    ! r1c`UR(aUR5 SUlXlg)zkStart a new recording. If it is already recording, stops the current recording before starting the new one.TN)rrr)r. video_names r/rRecordVideo.start_recordings" >>    !%r1cUR(dS5e[UR5S:Xa[R"S5 O}SSKJn U"URURS9nUR(aSOSn[RRURUR S 35nUR#XTS 9 /UlS UlSUlUR$(a7UR%UR&5(a[(R*"5 ggg![an[R"S5UeSnAff=f) z+Stop current recording and saves the video.z7stop_recording was called, but no recording was startedrz9Ignored saving a video as there were zero frames to save.)ImageSequenceCliprN)rbarz.mp4)r F)rr[rr r"moviepy.video.io.ImageSequenceCliprrXr rrrrrjoinrrwrite_videofilerrgccollect)r.rrclipmoviepy_loggerrs r/rRecordVideo.stop_recordings ~~XXX~ t## $ ) KKS T P %T%9%9t?R?RSD%)%8%8TeN77<< 1 1d6F6F5Gt3LMD   =! ??tt?? JJL @? 22T s D$$ E .EE cd[UR5S:a[R"S5 gg)z.Warn the user in case last video wasn't saved.rz0Unable to save last video! Did you call close()?N)r[rr rr4s r/__del__RecordVideo.__del__s' t## $q ( KKJ K )r1)rrrrrrrrrrrrrrrrrrrr)r)zgym.vector.VectorEnvrrrztuple[int, int]rboolrCallable[[int], bool] | Nonerrrrdrrr int | Nonerrrr)r?rr@rrr)r:r rz9tuple[ObsType, SupportsFloat, bool, bool, dict[str, Any]])rzRenderFrame | list[RenderFrame])rr)rrrrrr rrrrBr8rMrrrrrrrs@r/rrs@/5"'8<59%#3Gl !ll, l  l 6 l3lllll1l\$( =&%)4!3H '0%=%= B%=N " &2LLr1r)%r __future__rrrcollections.abcrrcopyrtypingrrnumpyrJ gymnasiumr!r r gymnasium.corer r r gymnasium.errorrgymnasium.loggerrgymnasium.vectorrrgymnasium.vector.vector_envrr"r#rrrr3r1r/rsxD" .%#882!51i]CII$C$CiXwLJJII##wLr1