scrcpy/app/src/recorder.h

#ifndef SC_RECORDER_H
#define SC_RECORDER_H

#include "common.h"

#include <stdbool.h>
#include <libavformat/avformat.h>

#include "coords.h"
#include "options.h"
#include "trait/packet_sink.h"
#include "util/queue.h"
#include "util/thread.h"

struct sc_record_packet {
    AVPacket *packet;
    struct sc_record_packet *next;
};

struct sc_recorder_queue SC_QUEUE(struct sc_record_packet);

struct sc_recorder {
    struct sc_packet_sink packet_sink; // packet sink trait

    char *filename;
    enum sc_record_format format;
    AVFormatContext *ctx;
    struct sc_size declared_frame_size;
    bool header_written;

    sc_thread thread;
    sc_mutex mutex;
    sc_cond queue_cond;
    bool stopped; // set on recorder_close()
    bool failed; // set on packet write failure
    struct sc_recorder_queue queue;
};

bool
sc_recorder_init(struct sc_recorder *recorder, const char *filename,
                 enum sc_record_format format,
                 struct sc_size declared_frame_size);

void
sc_recorder_destroy(struct sc_recorder *recorder);

#endif
Use sc_ prefix for recorder 2022-02-03 02:37:28 +08:00			`#ifndef SC_RECORDER_H`
			`#define SC_RECORDER_H`
Add recorder Implement recording in a separate "class". 2018-11-09 19:21:17 +08:00
Define feature test macros in common.h This enables necessary functions once for all. As a consequence, define common.h before any other header. 2021-01-09 02:24:51 +08:00			`#include "common.h"`

Replace SDL types by C99 standard types Scrcpy is a C11 project. Use the C99 standard types instead of the SDL-specific types: SDL_bool -> bool SintXX -> intXX_t UintXX -> uintXX_t 2019-03-03 06:52:22 +08:00			`#include <stdbool.h>`
Add recorder Implement recording in a separate "class". 2018-11-09 19:21:17 +08:00			`#include <libavformat/avformat.h>`

Move common structs to coords.h The size, point and position structs were defined in common.h. Move them to coords.h so that common.h could be used for generic code to be included in all source files. 2021-01-09 02:15:29 +08:00			`#include "coords.h"`
Move scrcpy option structs to options.h This will allow to define symbols in options.c without all the dependencies of scrcpy.c. 2021-10-28 00:43:47 +08:00			`#include "options.h"`
Expose recorder as packet sink Make recorder implement the packet sink trait. This will allow the stream to push packets without depending on the concrete sink type. 2021-04-11 21:01:05 +08:00			`#include "trait/packet_sink.h"`
Move utilities to util/ 2019-11-24 18:53:00 +08:00			`#include "util/queue.h"`
Wrap SDL thread functions into scrcpy-specific API The goal is to expose a consistent API for system tools, and paves the way to make the "core" independant of SDL in the future. 2021-02-01 01:24:35 +08:00			`#include "util/thread.h"`
Add recorder Implement recording in a separate "class". 2018-11-09 19:21:17 +08:00
Use sc_ prefix for recorder 2022-02-03 02:37:28 +08:00			`struct sc_record_packet {`
Allocate AVPacket for recorder From FFmpeg/doc/APIchanges: 2021-03-17 - f7db77bd87 - lavc 58.133.100 - codec.h Deprecated av_init_packet(). Once removed, sizeof(AVPacket) will no longer be a part of the public ABI. Refs #2302 <https://github.com/Genymobile/scrcpy/issues/2302> 2021-06-14 15:07:49 +08:00			`AVPacket *packet;`
Use sc_ prefix for recorder 2022-02-03 02:37:28 +08:00			`struct sc_record_packet *next;`
Record asynchronously The record file was written from the stream thread. As a consequence, any blocking I/O to write the file delayed the decoder. For maximum performance even when recording is enabled, send (refcounted) packets to a separate recording thread. 2019-07-31 07:55:40 +08:00			`};`

Use sc_ prefix for recorder 2022-02-03 02:37:28 +08:00			`struct sc_recorder_queue SC_QUEUE(struct sc_record_packet);`
Record asynchronously The record file was written from the stream thread. As a consequence, any blocking I/O to write the file delayed the decoder. For maximum performance even when recording is enabled, send (refcounted) packets to a separate recording thread. 2019-07-31 07:55:40 +08:00
Use sc_ prefix for recorder 2022-02-03 02:37:28 +08:00			`struct sc_recorder {`
Expose recorder as packet sink Make recorder implement the packet sink trait. This will allow the stream to push packets without depending on the concrete sink type. 2021-04-11 21:01:05 +08:00			`struct sc_packet_sink packet_sink; // packet sink trait`

Add recorder Implement recording in a separate "class". 2018-11-09 19:21:17 +08:00			`char *filename;`
Make scrcpy.h independant of other headers The header scrcpy.h is intended to be the "public" API. It should not depend on other internal headers. Therefore, declare all required structs in this header and adapt internal code. 2020-06-20 04:04:06 +08:00			`enum sc_record_format format;`
Add recorder Implement recording in a separate "class". 2018-11-09 19:21:17 +08:00			`AVFormatContext *ctx;`
Use sc_ prefix for size, position and point 2021-10-30 21:20:39 +08:00			`struct sc_size declared_frame_size;`
Replace SDL types by C99 standard types Scrcpy is a C11 project. Use the C99 standard types instead of the SDL-specific types: SDL_bool -> bool SintXX -> intXX_t UintXX -> uintXX_t 2019-03-03 06:52:22 +08:00			`bool header_written;`
Record asynchronously The record file was written from the stream thread. As a consequence, any blocking I/O to write the file delayed the decoder. For maximum performance even when recording is enabled, send (refcounted) packets to a separate recording thread. 2019-07-31 07:55:40 +08:00
Wrap SDL thread functions into scrcpy-specific API The goal is to expose a consistent API for system tools, and paves the way to make the "core" independant of SDL in the future. 2021-02-01 01:24:35 +08:00			`sc_thread thread;`
			`sc_mutex mutex;`
			`sc_cond queue_cond;`
Privatize recorder threading The fact that the recorder uses a separate thread is an internal detail, so the functions _start(), _stop() and _join() should not be exposed. Instead, start the thread on _open() and _stop()+_join() on close(). This paves the way to expose the recorder as a packet sink trait. 2021-04-11 21:01:05 +08:00			`bool stopped; // set on recorder_close()`
Record asynchronously The record file was written from the stream thread. As a consequence, any blocking I/O to write the file delayed the decoder. For maximum performance even when recording is enabled, send (refcounted) packets to a separate recording thread. 2019-07-31 07:55:40 +08:00			`bool failed; // set on packet write failure`
Use sc_ prefix for recorder 2022-02-03 02:37:28 +08:00			`struct sc_recorder_queue queue;`
Add recorder Implement recording in a separate "class". 2018-11-09 19:21:17 +08:00			`};`

Replace SDL types by C99 standard types Scrcpy is a C11 project. Use the C99 standard types instead of the SDL-specific types: SDL_bool -> bool SintXX -> intXX_t UintXX -> uintXX_t 2019-03-03 06:52:22 +08:00			`bool`
Use sc_ prefix for recorder 2022-02-03 02:37:28 +08:00			`sc_recorder_init(struct sc_recorder recorder, const char filename,`
			`enum sc_record_format format,`
			`struct sc_size declared_frame_size);`
Support recording to MKV Implement recording to Matroska files. The format to use is determined by the option -F/--record-format if set, or by the file extension (".mp4" or ".mkv"). 2019-02-09 22:20:07 +08:00
Update code style Limit source code to 80 chars, and declare functions return type and modifiers on a separate line. This allows to avoid very long lines, and all function names are aligned. (We do this on VLC, and I like it.) 2019-03-03 03:09:56 +08:00			`void`
Use sc_ prefix for recorder 2022-02-03 02:37:28 +08:00			`sc_recorder_destroy(struct sc_recorder *recorder);`
Add recorder Implement recording in a separate "class". 2018-11-09 19:21:17 +08:00
			`#endif`