record_driver.h

Go to the documentation of this file.

/* RetroArch - A frontend for libretro.
 * Copyright (C) 2010-2014 - Hans-Kristian Arntzen
 * Copyright (C) 2011-2017 - Daniel De Matteis
 *
 * RetroArch is free software: you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Found-
 * ation, either version 3 of the License, or (at your option) any later version.
 *
 * RetroArch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with RetroArch.
 * If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef __RECORD_DRIVER_H
#define __RECORD_DRIVER_H

#include <stdint.h>
#include <stddef.h>

#include <boolean.h>
#include <retro_common_api.h>

RETRO_BEGIN_DECLS

enum ffemu_pix_format
{
 FFEMU_PIX_RGB565 = 0,
 FFEMU_PIX_BGR24,
 FFEMU_PIX_ARGB8888
};

enum streaming_mode
{
 STREAMING_MODE_TWITCH = 0,
 STREAMING_MODE_YOUTUBE,
 STREAMING_MODE_LOCAL,
 STREAMING_MODE_CUSTOM
};

enum record_config_type
{
 RECORD_CONFIG_TYPE_RECORDING_CUSTOM = 0,
 RECORD_CONFIG_TYPE_RECORDING_LOW_QUALITY,
 RECORD_CONFIG_TYPE_RECORDING_MED_QUALITY,
 RECORD_CONFIG_TYPE_RECORDING_HIGH_QUALITY,
 RECORD_CONFIG_TYPE_RECORDING_LOSSLESS_QUALITY,
 RECORD_CONFIG_TYPE_RECORDING_WEBM_FAST,
 RECORD_CONFIG_TYPE_RECORDING_WEBM_HIGH_QUALITY,
 RECORD_CONFIG_TYPE_RECORDING_GIF,
 RECORD_CONFIG_TYPE_STREAMING_CUSTOM,
 RECORD_CONFIG_TYPE_STREAMING_LOW_QUALITY,
 RECORD_CONFIG_TYPE_STREAMING_MED_QUALITY,
 RECORD_CONFIG_TYPE_STREAMING_HIGH_QUALITY,
 RECORD_CONFIG_TYPE_STREAMING_NETPLAY

};

/* Parameters passed to ffemu_new() */
struct record_params
{
 /* Framerate per second of input video. */
 double fps;
 /* Sample rate of input audio. */
 double samplerate;

 /* Desired output resolution. */
 unsigned out_width;
 unsigned out_height;

 /* Total size of framebuffer used in input. */
 unsigned fb_width;
 unsigned fb_height;

 /* Aspect ratio of input video. Parameters are passed to the muxer,
 * the video itself is not scaled.
 */
 float aspect_ratio;

 /* Audio channels. */
 unsigned channels;

 enum record_config_type preset;

 /* Input pixel format. */
 enum ffemu_pix_format pix_fmt;

 /* Filename to dump to. */
 const char *filename;

 /* Path to config. Optional. */
 const char *config;
};

struct record_video_data
{
 const void *data;
 unsigned width;
 unsigned height;
 int pitch;
 bool is_dupe;
};

struct record_audio_data
{
 const void *data;
 size_t frames;
};

typedef struct record_driver
{
 void *(*init)(const struct record_params *params);
 void (*free)(void *data);
 bool (*push_video)(void *data, const struct record_video_data *video_data);
 bool (*push_audio)(void *data, const struct record_audio_data *audio_data);
 bool (*finalize)(void *data);
 const char *ident;
} record_driver_t;

extern const record_driver_t record_ffmpeg;
extern const record_driver_t record_null;

const char* config_get_record_driver_options(void);

const record_driver_t *ffemu_find_backend(const char *ident);

const void *record_driver_find_handle(int idx);

const char *record_driver_find_ident(int idx);

bool record_driver_init_first(const record_driver_t **backend, void **data,
 const struct record_params *params);

void recording_dump_frame(const void *data, unsigned width,
 unsigned height, size_t pitch, bool is_idle);

bool recording_deinit(void);

void find_record_driver(void);

bool recording_init(void);

bool recording_is_enabled(void);

void recording_set_state(bool state);

void streaming_set_state(bool state);

void recording_push_audio(const int16_t *data, size_t samples);

void *recording_driver_get_data_ptr(void);

void recording_driver_clear_data_ptr(void);

void recording_driver_set_data_ptr(void *data);

unsigned *recording_driver_get_width(void);

unsigned *recording_driver_get_height(void);

void recording_driver_free_state(void);

bool recording_is_enabled(void);

bool streaming_is_enabled(void);

void recording_driver_update_streaming_url(void);

extern void *recording_data;

RETRO_END_DECLS

#endif