xref: /aosp_15_r20/external/libdav1d/tools/output/muxer.h (revision c09093415860a1c2373dacd84c4fde00c507cdfd)
1 /*
2  * Copyright © 2018, VideoLAN and dav1d authors
3  * Copyright © 2018, Two Orioles, LLC
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice, this
10  *    list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  *    this list of conditions and the following disclaimer in the documentation
14  *    and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef DAV1D_OUTPUT_MUXER_H
29 #define DAV1D_OUTPUT_MUXER_H
30 
31 #include "picture.h"
32 
33 typedef struct MuxerPriv MuxerPriv;
34 typedef struct Muxer {
35     int priv_data_size;
36     const char *name;
37     const char *extension;
38     int (*write_header)(MuxerPriv *ctx, const char *filename,
39                         const Dav1dPictureParameters *p, const unsigned fps[2]);
40     int (*write_picture)(MuxerPriv *ctx, Dav1dPicture *p);
41     void (*write_trailer)(MuxerPriv *ctx);
42     /**
43      * Verifies the muxed data (for example in the md5 muxer). Replaces write_trailer.
44      *
45      * @param  hash_string Muxer specific reference value.
46      *
47      * @return 0 on success.
48      */
49     int (*verify)(MuxerPriv *ctx, const char *hash_string);
50 } Muxer;
51 
52 #endif /* DAV1D_OUTPUT_MUXER_H */
53