Skip to contents

Formats name these properties differently and keep them in different places (Platform, system, palFlag, isPal, fps, frameRate, rerecordCount, rerecords); movie$header holds them under the names of the format. This function reports them under one name each.

Usage

recording_info(movie, fallback_rate = NA)

Arguments

movie

A replayr_movie or replayr_poll_stream returned by read_movie() or a format-specific reader.

fallback_rate

Frame rate, in frames per second, to use where neither the recording nor its platform gives one, such as 60 or 50 for a Nintendo 64 recording. The default NA assumes none.

Value

A data frame with one row: format, platform, video_standard ("NTSC", "PAL" or NA), unit (see observation_unit()), observations, frame_rate, frame_rate_source, duration in seconds (from the first observation to the end of the last; NA where observation_time() is) and rerecords.

Details

platform is BizHawk's code for the system (NES, SNES, GB, GBC, GBA, N64, PSX, SAT, GEN, SMS, GG, PCE, NDS, 3DS, A26 and so on), also for recordings of other emulators, with GC and Wii for Dolphin and PC for recordings of computer programs. A format that serves one console implies its platform.

frame_rate is in video frames per second, and frame_rate_source says where it comes from: "recording" for a rate the file states, "format" for the 35 tics per second of Doom engines and the 60 frames per second of the Atari Grand Challenge data set, and "platform" for the nominal rate of the console and video standard, as BizHawk uses it to time recordings. The nominal rate is that of the original hardware. No rate is assumed where the platform or, for a console sold in both standards, the video standard is not known, unless fallback_rate names one; the source is then "fallback".

Examples

movie <- read_movie(system.file("extdata", "sample.fm2", package = "replayr"))
recording_info(movie)
#>   format platform video_standard  unit observations frame_rate
#> 1    fm2      NES           NTSC frame         3600   60.09881
#>   frame_rate_source duration rerecords
#> 1          platform 59.90135         0
# A Nintendo 64 recording in BizHawk's older format names no rate.
n64 <- read_movie(system.file("extdata", "expanded", "legacy-n64.bkm", package = "replayr"))
recording_info(n64)[c("frame_rate", "frame_rate_source", "duration")]
#>   frame_rate frame_rate_source duration
#> 1         NA              <NA>       NA
recording_info(n64, fallback_rate = 60)[c("frame_rate", "frame_rate_source", "duration")]
#>   frame_rate frame_rate_source   duration
#> 1         60          fallback 0.03333333