VLCThumbnailer.cpp 8.97 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/*****************************************************************************
 * Media Library
 *****************************************************************************
 * Copyright (C) 2015 Hugo Beauzée-Luyssen, Videolabs
 *
 * Authors: Hugo Beauzée-Luyssen<hugo@beauzee.fr>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

23
24
25
#include "VLCThumbnailer.h"

#include <cstring>
26
#include <jpeglib.h>
27
#include <setjmp.h>
28

29
#include "IMedia.h"
30
#include "logging/Logger.h"
31
#include "MediaLibrary.h"
32
33
34

VLCThumbnailer::VLCThumbnailer(const VLC::Instance &vlc)
    : m_instance( vlc )
35
36
    , m_snapshotRequired( false )
    , m_height( 0 )
37
38
39
{
}

40
bool VLCThumbnailer::initialize(IMetadataServiceCb *callback, MediaLibrary* ml)
41
42
43
44
45
46
47
48
49
50
51
52
{
    m_cb = callback;
    m_ml = ml;
    return true;
}

unsigned int VLCThumbnailer::priority() const
{
    // This needs to be lower than the VLCMetadataService, since we want to know the file type.
    return 50;
}

53
void VLCThumbnailer::run(std::shared_ptr<Media> file, void *data )
54
{
55
    if ( file->type() == IMedia::Type::UnknownType )
56
57
58
59
    {
        // If we don't know the file type yet, it actually looks more like a bug
        // since this should run after file type deduction, and not run in case
        // that step fails.
60
        m_cb->done( file, Status::Fatal, data );
61
        return;
62
    }
63
    else if ( file->type() != IMedia::Type::VideoType )
64
65
    {
        // There's no point in generating a thumbnail for a non-video file.
66
        m_cb->done( file, Status::Success, data );
67
        return;
68
    }
69
70
71
72
73
74
    else if ( file->snapshot().empty() == false )
    {
        LOG_INFO(file->snapshot(), " already has a snapshot" );
        m_cb->done( file, Status::Success, data );
        return;
    }
75
76
77
78
79
80
81
82

    VLC::Media media( m_instance, file->mrl(), VLC::Media::FromPath );
    media.addOption( ":no-audio" );
    VLC::MediaPlayer mp( media );

    setupVout( mp );

    if ( startPlayback( file, mp, data ) == false )
83
        return;
84
85
86

    // Seek ahead to have a significant preview
    if ( seekAhead( file, mp, data ) == false )
87
        return;
88

89
    takeSnapshot( file, mp, data );
90
91
}

92
bool VLCThumbnailer::startPlayback(std::shared_ptr<Media> file, VLC::MediaPlayer &mp, void* data )
93
94
95
96
97
{
    bool failed = true;

    std::unique_lock<std::mutex> lock( m_mutex );

98
    mp.eventManager().onPlaying([this, &failed]() {
99
100
101
102
103
104
105
106
107
        std::unique_lock<std::mutex> lock( m_mutex );
        failed = false;
        m_cond.notify_all();
    });
    mp.eventManager().onEncounteredError([this]() {
        std::unique_lock<std::mutex> lock( m_mutex );
        m_cond.notify_all();
    });
    mp.play();
108
109
    bool success = m_cond.wait_for( lock, std::chrono::seconds( 3 ), [&mp]() {
        return mp.state() == libvlc_Playing || mp.state() == libvlc_Error;
110
111
112
113
    });
    if ( success == false || failed == true )
    {
        // In case of timeout or error, don't go any further
114
        m_cb->done( file, Status::Error, data );
115
116
117
118
119
        return false;
    }
    return true;
}

120
bool VLCThumbnailer::seekAhead(std::shared_ptr<Media> file, VLC::MediaPlayer& mp, void* data )
121
122
123
124
125
126
127
128
{
    std::unique_lock<std::mutex> lock( m_mutex );
    float pos = .0f;
    auto event = mp.eventManager().onPositionChanged([this, &pos](float p) {
        std::unique_lock<std::mutex> lock( m_mutex );
        pos = p;
        m_cond.notify_all();
    });
129
    mp.setPosition( .4f );
130
131
132
133
134
135
136
    bool success = m_cond.wait_for( lock, std::chrono::seconds( 3 ), [&pos]() {
        return pos >= .1f;
    });
    // Since we're locking a mutex for each position changed, let's unregister ASAP
    event->unregister();
    if ( success == false )
    {
137
        m_cb->done( file, Status::Error, data );
138
139
140
141
142
        return false;
    }
    return true;
}

143
144
145
146
147
void VLCThumbnailer::setupVout( VLC::MediaPlayer& mp )
{
    mp.setVideoFormatCallbacks(
        // Setup
        [this, &mp](char* chroma, unsigned int* width, unsigned int *height, unsigned int *pitches, unsigned int *lines) {
148
            strcpy( chroma, "RV24" );
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

            const float inputAR = (float)*width / *height;

            *width = Width;
            auto prevHeight = m_height;
            m_height = (float)Width / inputAR + 1;
            // If our buffer isn't enough anymore, reallocate a new one.
            if ( m_height > prevHeight )
                m_buff.reset( new uint8_t[Width * m_height * Bpp] );
            *height = m_height;
            *pitches = Width * Bpp;
            *lines = m_height;
            return 1;
        },
        // Cleanup
        nullptr);
    mp.setVideoCallbacks(
        // Lock
        [this](void** pp_buff) {
            *pp_buff = m_buff.get();
            return nullptr;
        },
        //unlock
        [this](void*, void*const*) {
            std::unique_lock<std::mutex> lock(m_mutex);
            if ( m_snapshotRequired == true )
            {
                m_snapshotRequired = false;
                m_cond.notify_all();
            }
        }
        ,
        //display
        nullptr
    );
}

186
bool VLCThumbnailer::takeSnapshot(std::shared_ptr<Media> file, VLC::MediaPlayer &mp, void *data)
187
{
188
189
190
191
192
193
194
195
196
197
198
    std::unique_ptr<uint8_t[]> buff;
    // lock, signal that we want a snapshot, and wait.
    {
        std::unique_lock<std::mutex> lock( m_mutex );
        m_snapshotRequired = true;
        bool success = m_cond.wait_for( lock, std::chrono::seconds( 3 ), [this]() {
            // Keep waiting if the vmem thread hasn't restored m_snapshotRequired to false
            return m_snapshotRequired == true;
        });
        if ( success == false )
        {
199
            m_cb->done( file, Status::Error, data );
200
201
202
203
204
205
206
207
208
209
210
            return false;
        }
        // Prevent the vmem from screwing our snapshot over.
        buff = std::move( m_buff );
        // set a new buffer for next snapshot, and to avoid crashing while we stop the media player
        m_buff.reset( new uint8_t[Width * m_height * Bpp] );
    }
    mp.stop();
    return compress( buff.get(), file, data );
}

211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
#ifdef WITH_JPEG

struct jpegError : public jpeg_error_mgr
{
    jmp_buf buff;
    char message[JMSG_LENGTH_MAX];

    static void jpegErrorHandler(j_common_ptr common)
    {
        auto error = reinterpret_cast<jpegError*>(common->err);
        (*error->format_message)( common, error->message );
        longjmp(error->buff, 1);
    }
};

#endif

228
bool VLCThumbnailer::compress(uint8_t* buff, std::shared_ptr<Media> file, void *data)
229
230
231
232
233
234
235
236
237
238
239
240
{
    auto path = m_ml->snapshotPath();
    path += "/";
    path += std::to_string( file->id() ) + ".jpg";

    //FIXME: Abstract this away, though libjpeg requires a FILE*...
    auto fOut = fopen(path.c_str(), "wb");
    // ensure we always close the file.
    auto fOutPtr = std::unique_ptr<FILE, int(*)(FILE*)>( fOut, &fclose );
    if ( fOut == nullptr )
    {
        LOG_ERROR("Failed to open snapshot file ", path);
241
        m_cb->done( file, Status::Error, data );
242
243
        return false;
    }
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

#ifdef WITH_JPEG
    jpeg_compress_struct compInfo;
    JSAMPROW row_pointer[1];

    //libjpeg's default error handling is to call exit(), which would
    //be slightly problematic...
    jpegError err;
    compInfo.err = jpeg_std_error(&err);
    err.error_exit = jpegError::jpegErrorHandler;

    if ( setjmp( err.buff ) )
    {
        LOG_ERROR("JPEG failure: ", err.message);
        jpeg_destroy_compress(&compInfo);
259
        m_cb->done( file, Status::Error, data );
260
261
262
        return false;
    }

263
    jpeg_create_compress(&compInfo);
264
265
266
267
268
    jpeg_stdio_dest(&compInfo, fOut);

    compInfo.image_width = Width;
    compInfo.image_height = m_height;
    compInfo.input_components = Bpp;
269
270
271
#if ( !defined(JPEG_LIB_VERSION_MAJOR) && !defined(JPEG_LIB_VERSION_MINOR) ) || \
    ( JPEG_LIB_VERSION_MAJOR <= 8 && JPEG_LIB_VERSION_MINOR < 4 )
    compInfo.in_color_space = JCS_EXT_BGR;
272
273
274
#else
    compInfo.in_color_space = JCS_RGB;
#endif
275
276
277
278
279
280
281
282
283
284
285
286
287
    jpeg_set_defaults( &compInfo );
    jpeg_set_quality( &compInfo, 85, TRUE );

    jpeg_start_compress( &compInfo, TRUE );

    auto stride = compInfo.image_width * Bpp;

    while (compInfo.next_scanline < compInfo.image_height) {
      row_pointer[0] = &buff[compInfo.next_scanline * stride];
      jpeg_write_scanlines(&compInfo, row_pointer, 1);
    }
    jpeg_finish_compress(&compInfo);
    jpeg_destroy_compress(&compInfo);
288
289
290
#else
#error FIXME
#endif
291
292

    file->setSnapshot( path );
293
    m_cb->done( file, Status::Success, data );
294
    return true;
295
}